ref_summary.c File Reference

Enumerations
enum	ref_basic_summary_commands { REF_SUMMARY_SUMMARY_CMD_STATUS_READ , REF_SUMMARY_SUMMARY_CMD_STATUS_CLEAR , REF_SUMMARY_SUMMARY_CMD_COUNT }

Functions
static int32_t	Run_REF_Summary (int32_t cardIndex, int32_t module, uint32_t modid)
	Run_REF_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_REF_Channel if the card, module, and channel specified are all valid for the REF module.
static void	Cfg_REF_Channel (int32_t cardIndex, int32_t module, int32_t MaxChannel)
	Cfg_REF_Channel handles calling the Display_REF_ChannelCfg routine to display the reference channel configuration and calling the routines associated with the user's menu commands.
static void	Verify_REF_ParamCnt (int32_t paramCnt)
	Verify_REF_ParamCnt verifies parameter count and displays error message if invalid.
static nai_status_t	Display_REF_Status (int32_t paramCnt, int32_t *p_params)
	Display_REF_Status illustrates the methods to call in the naibrd library to retrieve the status states.
static nai_status_t	Clear_REF_Status (int32_t paramCnt, int32_t *p_params)
int32_t	ref_summary (void)
	The purpose of the ref_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with Reference modules for reading fault statuses including the summary status register and clearing status bits. The summary register is bit-mapped by channel (bit index zero is channel 1) and reports a '1' if the corresponding channel has detected a fault (including BIT). A latched summary bit can be cleared by writing a '1' to the bit.

Variables
static const int8_t *	DEF_CONFIG_FILE = (const int8_t *)"default_REF_Summary.txt"
static const int32_t	DEF_REF_CARD_INDEX = 0
static const int32_t	DEF_REF_MODULE = 1
static const int32_t	DEF_REF_CHANNEL = 1
static naiapp_cmdtbl_params_t	REF_SummaryMenuCmds []

Enumeration Type Documentation

ref_basic_summary_commands

enum ref_basic_summary_commands

Enumerator
REF_SUMMARY_SUMMARY_CMD_STATUS_READ
REF_SUMMARY_SUMMARY_CMD_STATUS_CLEAR
REF_SUMMARY_SUMMARY_CMD_COUNT

Function Documentation

Cfg_REF_Channel()

static void Cfg_REF_Channel ( int32_t cardIndex, int32_t module, int32_t MaxChannel )

static

Cfg_REF_Channel handles calling the Display_REF_ChannelCfg routine to display the reference channel configuration and calling the routines associated with the user's menu commands.

Clear_REF_Status()

static nai_status_t Clear_REF_Status ( int32_t paramCnt, int32_t * p_params )

static

Display_REF_Status()

static nai_status_t Display_REF_Status ( int32_t paramCnt, int32_t * p_params )

static

Display_REF_Status illustrates the methods to call in the naibrd library to retrieve the status states.

ref_summary()

int32_t ref_summary

(

void

)

The purpose of the ref_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with Reference modules for reading fault statuses including the summary status register and clearing status bits. The summary register is bit-mapped by channel (bit index zero is channel 1) and reports a '1' if the corresponding channel has detected a fault (including BIT). A latched summary bit can be cleared by writing a '1' to the bit.

Run_REF_Summary()

static int32_t Run_REF_Summary ( int32_t cardIndex, int32_t module, uint32_t modid )

static

Run_REF_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_REF_Channel if the card, module, and channel specified are all valid for the REF module.

Verify_REF_ParamCnt()

static void Verify_REF_ParamCnt ( int32_t paramCnt )

static

Verify_REF_ParamCnt verifies parameter count and displays error message if invalid.

Variable Documentation

DEF_CONFIG_FILE

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

static

DEF_REF_CARD_INDEX

const int32_t DEF_REF_CARD_INDEX = 0

static

DEF_REF_CHANNEL

const int32_t DEF_REF_CHANNEL = 1

static

DEF_REF_MODULE

const int32_t DEF_REF_MODULE = 1

static

REF_SummaryMenuCmds

naiapp_cmdtbl_params_t REF_SummaryMenuCmds[]

static

Initial value:

= {
   {"STAT",     "REF Display Status",         REF_SUMMARY_SUMMARY_CMD_STATUS_READ,       Display_REF_Status},
   {"CLEAR",    "REF Clear Status",           REF_SUMMARY_SUMMARY_CMD_STATUS_CLEAR,      Clear_REF_Status}
}