internal_utility.c File Reference

This file contains the definitions of the functions that comprise internal utility functions. More...

#include "internal_utility.h"
#include <stddef.h>
#include "adapter_api.h"
#include "adapter_efa_probe.h"
#include "endpoint_manager.h"
#include "cdi_os_api.h"

Functions
static const CdiEnumStringKey *	UtilityKeyGetArray (InternalEnumStringKeyTypes key_type)
	Update InternalEnumStringKeyTypes in internal_utility.h whenever an entry is added to this function's switch statement.
const char *	InternalUtilityKeyEnumToString (InternalEnumStringKeyTypes key_type, int enum_value)

Variables
static const CdiEnumStringKey	probe_state_key_array []
	Enum/String keys for ProbeState. NOTE: Must match ProbeState.
static const CdiEnumStringKey	probe_command_key_array []
	Enum/String keys for ProbeCommand. NOTE: Must match ProbeCommand.
static const CdiEnumStringKey	endpoint_manager_command_key_array []
	Enum/String keys for EndpointState. NOTE: Must match EndpointState.

Detailed Description

This file contains the definitions of the functions that comprise internal utility functions.

Function Documentation

InternalUtilityKeyEnumToString()

const char * InternalUtilityKeyEnumToString	(	InternalEnumStringKeyTypes	key_type,
		int	enum_value )

Function used to convert an internal enum value to a string.

Parameters

key_type	Enum from InternalEnumStringKeyTypes which indicates which key-value array to search for enum_value.
enum_value	Value to convert to a string.

Returns

Pointer to returned string. If no match was found, NULL is returned.

Variable Documentation

endpoint_manager_command_key_array

const CdiEnumStringKey endpoint_manager_command_key_array[]

static

Initial value:

= {
    { kEndpointStateIdle,       "Idle" },
    { kEndpointStateReset,      "Reset" },
    { kEndpointStateStart,      "Start" },
    { kEndpointStateShutdown,   "Shutdown" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/String keys for EndpointState. NOTE: Must match EndpointState.

probe_command_key_array

const CdiEnumStringKey probe_command_key_array[]

static

Initial value:

= {
    { kProbeCommandReset,     "Reset" },
    { kProbeCommandPing,      "Ping" },
    { kProbeCommandConnected, "Connected" },
    { kProbeCommandAck,       "Ack" },
    { kProbeCommandProtocolVersion, "Protocol Version" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/String keys for ProbeCommand. NOTE: Must match ProbeCommand.

probe_state_key_array

const CdiEnumStringKey probe_state_key_array[]

static

Initial value:

= {
    { kProbeStateIdle,                   "Idle" },
    { kProbeStateSendReset,              "SendReset" },
    { kProbeStateSendProtocolVersion,    "SendProtocolVersion" },
    { kProbeStateResetting,              "Resetting" },
    { kProbeStateResetDone,              "ResetDone" },
    { kProbeStateWaitForStart,           "WaitForStart" },
    { kProbeStateEfaStart,               "EfaStart"},
    { kProbeStateEfaProbe,               "EFAProbe" },
    { kProbeStateEfaTxProbeAcks,         "EFAProbeAcks" },
    { kProbeStateEfaConnected,           "EFAConnected" },
    { kProbeStateEfaConnectedPing,       "EFAPing" },
    { kProbeStateEfaReset,               "EfaReset" },
    { kProbeStateDestroy,                "Destroy" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/String keys for ProbeState. NOTE: Must match ProbeState.