Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
ad_summary.c File Reference

Enumerations

enum  ad_basic_interrupt_commands { AD_SUMMARY_INTERRUPT_CMD_CONFIGURE , AD_SUMMARY_INTERRUPT_CMD_STATUS_READ , AD_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR , AD_SUMMARY_INTERRUPT_CMD_COUNT }
 

Functions

static int32_t Run_AD_Summary (int32_t cardIndex, int32_t module, uint32_t modid)
 Run_AD_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_AD_Channel if the card, module, and channel specified are all valid for the AD module.
 
static void Cfg_AD_Channel (int32_t cardIndex, int32_t module, int32_t MaxChannel)
 Cfg_AD_Channel handles calling the Display_AD_ChannelCfg routine to display the A/D channel configuration and calling the routines associated with the user's menu commands.
 
static void Verify_AD_ParamCnt (int32_t paramCnt)
 Verify_AD_ParamCnt verifies parameter count and displays error message if invalid.
 
static nai_status_t Display_AD_Status (int32_t paramCnt, int32_t *p_params)
 Display_AD_Status illustrates the methods to call in the naibrd library to retrieve the status states.
 
static nai_status_t Clear_AD_Status (int32_t paramCnt, int32_t *p_params)
 
static nai_status_t Configure_AD_Interrupt (int32_t paramCnt, int32_t *p_params)
 
static void SampleCallBack (uint32_t vector)
 
int32_t ad_summary (void)
 The purpose of the ad_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with A/D modules for interrupt configuration, 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_AD_Summary.txt"
 
static const int32_t DEF_AD_CARD_INDEX = 0
 
static const int32_t DEF_AD_MODULE = 1
 
static const int32_t DEF_AD_CHANNEL = 1
 
static naiapp_cmdtbl_params_t AD_SummaryMenuCmds []
 

Enumeration Type Documentation

◆ ad_basic_interrupt_commands

Enumerator
AD_SUMMARY_INTERRUPT_CMD_CONFIGURE 
AD_SUMMARY_INTERRUPT_CMD_STATUS_READ 
AD_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR 
AD_SUMMARY_INTERRUPT_CMD_COUNT 

Function Documentation

◆ ad_summary()

int32_t ad_summary ( void )

The purpose of the ad_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with A/D modules for interrupt configuration, 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.

◆ Cfg_AD_Channel()

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

Cfg_AD_Channel handles calling the Display_AD_ChannelCfg routine to display the A/D channel configuration and calling the routines associated with the user's menu commands.

◆ Clear_AD_Status()

static nai_status_t Clear_AD_Status ( int32_t paramCnt,
int32_t * p_params )
static

◆ Configure_AD_Interrupt()

static nai_status_t Configure_AD_Interrupt ( int32_t paramCnt,
int32_t * p_params )
static

◆ Display_AD_Status()

static nai_status_t Display_AD_Status ( int32_t paramCnt,
int32_t * p_params )
static

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

◆ Run_AD_Summary()

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

Run_AD_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_AD_Channel if the card, module, and channel specified are all valid for the AD module.

◆ SampleCallBack()

static void SampleCallBack ( uint32_t vector)
static

◆ Verify_AD_ParamCnt()

static void Verify_AD_ParamCnt ( int32_t paramCnt)
static

Verify_AD_ParamCnt verifies parameter count and displays error message if invalid.

Variable Documentation

◆ AD_SummaryMenuCmds

naiapp_cmdtbl_params_t AD_SummaryMenuCmds[]
static
Initial value:
= {
{"INT", "AD Configure Interrupt", AD_SUMMARY_INTERRUPT_CMD_CONFIGURE, Configure_AD_Interrupt},
}
static nai_status_t Clear_AD_Status(int32_t paramCnt, int32_t *p_params)
Definition ad_summary.c:274
static nai_status_t Configure_AD_Interrupt(int32_t paramCnt, int32_t *p_params)
Definition ad_summary.c:296
@ AD_SUMMARY_INTERRUPT_CMD_STATUS_READ
Definition ad_summary.c:43
@ AD_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR
Definition ad_summary.c:44
@ AD_SUMMARY_INTERRUPT_CMD_CONFIGURE
Definition ad_summary.c:42
static nai_status_t Display_AD_Status(int32_t paramCnt, int32_t *p_params)
Display_AD_Status illustrates the methods to call in the naibrd library to retrieve the status states...
Definition ad_summary.c:232

◆ DEF_AD_CARD_INDEX

const int32_t DEF_AD_CARD_INDEX = 0
static

◆ DEF_AD_CHANNEL

const int32_t DEF_AD_CHANNEL = 1
static

◆ DEF_AD_MODULE

const int32_t DEF_AD_MODULE = 1
static

◆ DEF_CONFIG_FILE

const int8_t* DEF_CONFIG_FILE = (const int8_t *)"default_AD_Summary.txt"
static