cd_basic_ops.c File Reference

Enumerations
enum	cd_gen5_cd_common_commands {   CD_COMMON_CMD_ENABLE_CHANNELS , CD_COMMON_CMD_GET_ENABLED_CHANNELS , CD_COMMON_CMD_INITIATE_MANUAL_BURN_CHANNELS , CD_COMMON_CMD_GET_MANUAL_BURN_CHANNELS ,   CD_COMMON_CMD_SET_AUTO_BURN_MAX_COUNT , CD_COMMON_CMD_GET_AUTO_BURN_MAX_COUNT , CD_COMMON_CMD_INITIATE_AUTO_BURN_CHANNELS , CD_COMMON_CMD_GET_AUTO_BURN_CHANNELS ,   CD_COMMON_CMD_GET_AUTO_BURN_COUNT , CD_COMMON_CMD_SET_CHAN_ENERGY_SETTING , CD_COMMON_CMD_GET_CHAN_ENERGY_SETTING , CD_COMMON_CMD_GET_CHAN_RESISTANCE ,   CD_COMMON_CMD_SET_CHAN_FAULT_RESISTANCE , CD_COMMON_CMD_GET_CHAN_FAULT_RESISTANCE , CD_COMMON_CMD_SET_CHAN_WARNING_RESISTANCE , CD_COMMON_CMD_GET_CHAN_WARNING_RESISTANCE ,   CD_COMMON_CMD_SET_CHAN_OPEN_RESISTANCE , CD_COMMON_CMD_GET_CHAN_OPEN_RESISTANCE , CD_COMMON_CMD_SET_MODULE_BIT_ENABLE , CD_COMMON_CMD_GET_MODULE_BIT_ENABLE ,   CD_COMMON_CMD_CHECK_MODULE_PBIT_COMPLETE , CD_COMMON_CMD_BIT_ERROR_THRESHOLDS , CD_COMMON_CMD_COUNT }

Functions
static bool_t	Run_CD_BasicOps (int32_t cardIndex, int32_t module, uint32_t modId)
	This function runs the basic operations CD program. It controls the top level menu of the CD_BasicOps program and calls Handle_CD_Configuration or Handle_CD_StandardOps, depending on what the user specifies.
static nai_status_t	Handle_CD_EnableChannels (int32_t paramCount, int32_t *params)
	This function is responsible for enabling the desired channels. User is prompted to enter which channels are to be enabled.
static nai_status_t	Handle_CD_GetEnableChannels (int32_t paramCount, int32_t *params)
	This function retrieves a bitmapped 32 bit value of channels that are currently enabled.
static nai_status_t	Handle_CD_InitiateManualBurnChannels (int32_t paramCount, int32_t *params)
	This function initiates a manual burn on the desired channels.
static nai_status_t	Handle_CD_GetManualBurnChannels (int32_t paramCount, int32_t *params)
	This function returns a bitmapped 32 bit value of channels that have been configured for manual-burn.
static nai_status_t	HANDLE_CD_SetAutoBurnMaxCount (int32_t paramCount, int32_t *params)
	This function assigns the Auto Burn Max count value for the given channel.
static nai_status_t	HANDLE_CD_GetAutoBurnMaxCount (int32_t paramCount, int32_t *params)
	This function returns what a given channel's auto burn max count is currently configured to.
static nai_status_t	Handle_CD_InitiateAutoBurnChannels (int32_t paramCount, int32_t *params)
	This function initiates an auto burn on the desired channels.
static nai_status_t	Handle_CD_GetAutoBurnChannels (int32_t paramCount, int32_t *params)
	This function Gets auto burn channels.
static nai_status_t	HANDLE_CD_GetAutoBurnCount (int32_t paramCount, int32_t *params)
	This function returns what a given channel's auto burn count is currently configured to.
static nai_status_t	Handle_CD_SetChanEnergySetting (int32_t paramCount, int32_t *params)
	This function is responsible for assigning what amount of energy (in joules) a channel will be charged.
static nai_status_t	Handle_CD_GetChanEnergySetting (int32_t paramCount, int32_t *params)
	This function returns what a given channel's energy setting is currently configured to.
static nai_status_t	Handle_CD_GetChanResistance (int32_t paramCount, int32_t *params)
	This function retrieves the resistance level for the given channel.
static nai_status_t	Handle_CD_SetChanFaultResistance (int32_t paramCount, int32_t *params)
	This function assigns the fault resistance threshold value for the given channel.
static nai_status_t	Handle_CD_GetChanFaultResistance (int32_t paramCount, int32_t *params)
	This function retrieves the fault resistance threshold for the given channel.
static nai_status_t	Handle_CD_SetChanWarningResistance (int32_t paramCount, int32_t *params)
	This function assigns the warning resistance threshold value for the given channel.
static nai_status_t	Handle_CD_GetChanWarningResistance (int32_t paramCount, int32_t *params)
	This function retrieves the warning resistance threshold for the given channel.
static nai_status_t	Handle_CD_SetChanOpenResistance (int32_t paramCount, int32_t *params)
	This function assigns the open resistance threshold value for the given channel.
static nai_status_t	Handle_CD_GetChanOpenResistance (int32_t paramCount, int32_t *params)
	This function retrieves the open resistance threshold for the given channel.
static nai_status_t	Handle_CD_SetModuleBITEnable (int32_t paramCount, int32_t *params)
	This function Enables/Disables the BIT test specified by the type parameter.
static nai_status_t	Handle_CD_GetModuleBITEnable (int32_t paramCount, int32_t *params)
	This function retrieves the state(Enabled or Disabled) of the BIT test specified by the type parameter.
static nai_status_t	Handle_CD_CheckModulePBITComplete (int32_t paramCount, int32_t *params)
	This function checks to see if the power-on BIT test has been run on the module. If the PBIT test has run, it checks the result of the test and reports it back.
static nai_status_t	Handle_CD_BITErrorThresholds (int32_t paramCount, int32_t *params)
	This function callows the user to set and get the BIT error thresholds. This is an advanced feature.
int32_t	CD_BasicOps (void)
	The purpose of the CD_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the CD modules for configuration setup and basic chip-detect operation.

Variables
static const int8_t *	SAMPLE_PGM_NAME = (const int8_t*)"CD Basic Operations"
static const int8_t *	DEF_CONFIG_FILE = (const int8_t*)"default_CD_BasicOps.txt"
static const int32_t	DEF_CD_CHANNEL = 1
naiapp_cmdtbl_params_t	CD_StandardOpMenuCmds [CD_COMMON_CMD_COUNT]

Enumeration Type Documentation

cd_gen5_cd_common_commands

enum cd_gen5_cd_common_commands

Enumerator
CD_COMMON_CMD_ENABLE_CHANNELS
CD_COMMON_CMD_GET_ENABLED_CHANNELS
CD_COMMON_CMD_INITIATE_MANUAL_BURN_CHANNELS
CD_COMMON_CMD_GET_MANUAL_BURN_CHANNELS
CD_COMMON_CMD_SET_AUTO_BURN_MAX_COUNT
CD_COMMON_CMD_GET_AUTO_BURN_MAX_COUNT
CD_COMMON_CMD_INITIATE_AUTO_BURN_CHANNELS
CD_COMMON_CMD_GET_AUTO_BURN_CHANNELS
CD_COMMON_CMD_GET_AUTO_BURN_COUNT
CD_COMMON_CMD_SET_CHAN_ENERGY_SETTING
CD_COMMON_CMD_GET_CHAN_ENERGY_SETTING
CD_COMMON_CMD_GET_CHAN_RESISTANCE
CD_COMMON_CMD_SET_CHAN_FAULT_RESISTANCE
CD_COMMON_CMD_GET_CHAN_FAULT_RESISTANCE
CD_COMMON_CMD_SET_CHAN_WARNING_RESISTANCE
CD_COMMON_CMD_GET_CHAN_WARNING_RESISTANCE
CD_COMMON_CMD_SET_CHAN_OPEN_RESISTANCE
CD_COMMON_CMD_GET_CHAN_OPEN_RESISTANCE
CD_COMMON_CMD_SET_MODULE_BIT_ENABLE
CD_COMMON_CMD_GET_MODULE_BIT_ENABLE
CD_COMMON_CMD_CHECK_MODULE_PBIT_COMPLETE
CD_COMMON_CMD_BIT_ERROR_THRESHOLDS
CD_COMMON_CMD_COUNT

Function Documentation

CD_BasicOps()

int32_t CD_BasicOps

(

void

)

The purpose of the CD_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the CD modules for configuration setup and basic chip-detect operation.

The following system configuration routines from the nai_sys_cfg.c file are called to assist with the configuration setup for this program prior to calling the naibrd DA routines.

• ConfigDevice
• DisplayDeviceCfg
• GetBoardSNModCfg
• CheckModule

Handle_CD_BITErrorThresholds()

static nai_status_t Handle_CD_BITErrorThresholds ( int32_t paramCount, int32_t * params )

static

This function callows the user to set and get the BIT error thresholds. This is an advanced feature.

Handle_CD_CheckModulePBITComplete()

static nai_status_t Handle_CD_CheckModulePBITComplete ( int32_t paramCount, int32_t * params )

static

This function checks to see if the power-on BIT test has been run on the module. If the PBIT test has run, it checks the result of the test and reports it back.

Handle_CD_EnableChannels()

static nai_status_t Handle_CD_EnableChannels ( int32_t paramCount, int32_t * params )

static

This function is responsible for enabling the desired channels. User is prompted to enter which channels are to be enabled.

Handle_CD_GetAutoBurnChannels()

static nai_status_t Handle_CD_GetAutoBurnChannels ( int32_t paramCount, int32_t * params )

static

This function Gets auto burn channels.

HANDLE_CD_GetAutoBurnCount()

static nai_status_t HANDLE_CD_GetAutoBurnCount ( int32_t paramCount, int32_t * params )

static

This function returns what a given channel's auto burn count is currently configured to.

HANDLE_CD_GetAutoBurnMaxCount()

static nai_status_t HANDLE_CD_GetAutoBurnMaxCount ( int32_t paramCount, int32_t * params )

static

This function returns what a given channel's auto burn max count is currently configured to.

Handle_CD_GetChanEnergySetting()

static nai_status_t Handle_CD_GetChanEnergySetting ( int32_t paramCount, int32_t * params )

static

This function returns what a given channel's energy setting is currently configured to.

Handle_CD_GetChanFaultResistance()

static nai_status_t Handle_CD_GetChanFaultResistance ( int32_t paramCount, int32_t * params )

static

This function retrieves the fault resistance threshold for the given channel.

Handle_CD_GetChanOpenResistance()

static nai_status_t Handle_CD_GetChanOpenResistance ( int32_t paramCount, int32_t * params )

static

This function retrieves the open resistance threshold for the given channel.

Handle_CD_GetChanResistance()

static nai_status_t Handle_CD_GetChanResistance ( int32_t paramCount, int32_t * params )

static

This function retrieves the resistance level for the given channel.

Handle_CD_GetChanWarningResistance()

static nai_status_t Handle_CD_GetChanWarningResistance ( int32_t paramCount, int32_t * params )

static

This function retrieves the warning resistance threshold for the given channel.

Handle_CD_GetEnableChannels()

static nai_status_t Handle_CD_GetEnableChannels ( int32_t paramCount, int32_t * params )

static

This function retrieves a bitmapped 32 bit value of channels that are currently enabled.

Handle_CD_GetManualBurnChannels()

static nai_status_t Handle_CD_GetManualBurnChannels ( int32_t paramCount, int32_t * params )

static

This function returns a bitmapped 32 bit value of channels that have been configured for manual-burn.

Handle_CD_GetModuleBITEnable()

static nai_status_t Handle_CD_GetModuleBITEnable ( int32_t paramCount, int32_t * params )

static

This function retrieves the state(Enabled or Disabled) of the BIT test specified by the type parameter.

Handle_CD_InitiateAutoBurnChannels()

static nai_status_t Handle_CD_InitiateAutoBurnChannels ( int32_t paramCount, int32_t * params )

static

This function initiates an auto burn on the desired channels.

Handle_CD_InitiateManualBurnChannels()

static nai_status_t Handle_CD_InitiateManualBurnChannels ( int32_t paramCount, int32_t * params )

static

This function initiates a manual burn on the desired channels.

HANDLE_CD_SetAutoBurnMaxCount()

static nai_status_t HANDLE_CD_SetAutoBurnMaxCount ( int32_t paramCount, int32_t * params )

static

This function assigns the Auto Burn Max count value for the given channel.

Handle_CD_SetChanEnergySetting()

static nai_status_t Handle_CD_SetChanEnergySetting ( int32_t paramCount, int32_t * params )

static

This function is responsible for assigning what amount of energy (in joules) a channel will be charged.

Handle_CD_SetChanFaultResistance()

static nai_status_t Handle_CD_SetChanFaultResistance ( int32_t paramCount, int32_t * params )

static

This function assigns the fault resistance threshold value for the given channel.

Handle_CD_SetChanOpenResistance()

static nai_status_t Handle_CD_SetChanOpenResistance ( int32_t paramCount, int32_t * params )

static

This function assigns the open resistance threshold value for the given channel.

Handle_CD_SetChanWarningResistance()

static nai_status_t Handle_CD_SetChanWarningResistance ( int32_t paramCount, int32_t * params )

static

This function assigns the warning resistance threshold value for the given channel.

Handle_CD_SetModuleBITEnable()

static nai_status_t Handle_CD_SetModuleBITEnable ( int32_t paramCount, int32_t * params )

static

This function Enables/Disables the BIT test specified by the type parameter.

Run_CD_BasicOps()

static bool_t Run_CD_BasicOps ( int32_t cardIndex, int32_t module, uint32_t modId )

static

This function runs the basic operations CD program. It controls the top level menu of the CD_BasicOps program and calls Handle_CD_Configuration or Handle_CD_StandardOps, depending on what the user specifies.

Variable Documentation

CD_StandardOpMenuCmds

naiapp_cmdtbl_params_t CD_StandardOpMenuCmds[CD_COMMON_CMD_COUNT]

Initial value:

=
{
   {"1",    "Enable Channels",                     CD_COMMON_CMD_ENABLE_CHANNELS,               Handle_CD_EnableChannels},
   {"2",    "Get Enabled Channels",                CD_COMMON_CMD_GET_ENABLED_CHANNELS,          Handle_CD_GetEnableChannels},
   {"3",    "Initiate Manual Burn on Channels",    CD_COMMON_CMD_INITIATE_MANUAL_BURN_CHANNELS, Handle_CD_InitiateManualBurnChannels},
   {"4",    "Get Manual Burn Channels",            CD_COMMON_CMD_GET_MANUAL_BURN_CHANNELS,      Handle_CD_GetManualBurnChannels},
   {"5",    "Set Auto Burn Max Count",             CD_COMMON_CMD_SET_AUTO_BURN_MAX_COUNT,       HANDLE_CD_SetAutoBurnMaxCount },
   {"6",    "Get Auto Burn Max Count",             CD_COMMON_CMD_GET_AUTO_BURN_MAX_COUNT,       HANDLE_CD_GetAutoBurnMaxCount },
   {"7",    "Initiate Auto Burn Channels",         CD_COMMON_CMD_INITIATE_AUTO_BURN_CHANNELS,   Handle_CD_InitiateAutoBurnChannels },
   {"8",    "Get Auto Burn Channels",              CD_COMMON_CMD_GET_AUTO_BURN_CHANNELS,        Handle_CD_GetAutoBurnChannels },
   {"9",    "Get Auto Burn Count",                 CD_COMMON_CMD_GET_AUTO_BURN_COUNT,           HANDLE_CD_GetAutoBurnCount },
   {"10",   "Set Channel Energy Setting",          CD_COMMON_CMD_SET_CHAN_ENERGY_SETTING,       Handle_CD_SetChanEnergySetting},
   {"11",   "Get Channel Energy Setting",          CD_COMMON_CMD_GET_CHAN_ENERGY_SETTING,       Handle_CD_GetChanEnergySetting},
   {"12",   "Get Channel Resistance",              CD_COMMON_CMD_GET_CHAN_RESISTANCE,           Handle_CD_GetChanResistance},
   {"13",   "Set Channel Fault Resistance",        CD_COMMON_CMD_SET_CHAN_FAULT_RESISTANCE,     Handle_CD_SetChanFaultResistance},
   {"14",   "Get Channel Fault Resistance",        CD_COMMON_CMD_GET_CHAN_FAULT_RESISTANCE,     Handle_CD_GetChanFaultResistance},
   {"15",   "Set Channel Warning Resistance",      CD_COMMON_CMD_SET_CHAN_WARNING_RESISTANCE,   Handle_CD_SetChanWarningResistance},
   {"16",   "Get Channel Warning Resistance",      CD_COMMON_CMD_GET_CHAN_WARNING_RESISTANCE,   Handle_CD_GetChanWarningResistance},
   {"17",   "Set Channel Open Resistance",         CD_COMMON_CMD_SET_CHAN_OPEN_RESISTANCE,      Handle_CD_SetChanOpenResistance},
   {"18",   "Get Channel Open Resistance",         CD_COMMON_CMD_GET_CHAN_OPEN_RESISTANCE,      Handle_CD_GetChanOpenResistance},
   {"19",   "Set Module BIT Enable",               CD_COMMON_CMD_SET_MODULE_BIT_ENABLE,         Handle_CD_SetModuleBITEnable },
   {"20",   "Get Module BIT Enable",               CD_COMMON_CMD_GET_MODULE_BIT_ENABLE,         Handle_CD_GetModuleBITEnable },
   {"21",   "Check Module PBIT Complete",          CD_COMMON_CMD_CHECK_MODULE_PBIT_COMPLETE,    Handle_CD_CheckModulePBITComplete },
   {"22",   "Manipulate BIT Error Thresholds",     CD_COMMON_CMD_BIT_ERROR_THRESHOLDS,          Handle_CD_BITErrorThresholds }
}

DEF_CD_CHANNEL

const int32_t DEF_CD_CHANNEL = 1

static

DEF_CONFIG_FILE

const int8_t* DEF_CONFIG_FILE = (const int8_t*)"default_CD_BasicOps.txt"

static

SAMPLE_PGM_NAME

const int8_t* SAMPLE_PGM_NAME = (const int8_t*)"CD Basic Operations"

static