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

Enumerations

enum  lvdt_basic_interrupt_commands { LVDT_SUMMARY_INTERRUPT_CMD_CONFIGURE , LVDT_SUMMARY_INTERRUPT_CMD_STATUS_READ , LVDT_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR , LVDT_SUMMARY_INTERRUPT_CMD_COUNT }
 

Functions

static int32_t Run_LVDT_Summary (int32_t cardIndex, int32_t module, uint32_t modid)
 Run_LVDT_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_LVDT_Channel if the card, module, and channel specified are all valid for the LVDT module.
 
static void Cfg_LVDT_Channel (int32_t cardIndex, int32_t module, int32_t MaxChannel)
 Cfg_LVDT_Channel handles calling the Display_LVDT_ChannelCfg routine to display the LVDT channel configuration and calling the routines associated with the user's menu commands.
 
static void Verify_LVDT_ParamCnt (int32_t paramCnt)
 Verify_LVDT_ParamCnt verifies parameter count and displays error message if invalid.
 
static nai_status_t Display_LVDT_Status (int32_t paramCnt, int32_t *p_params)
 Display_LVDT_Status illustrates the methods to call in the naibrd library to retrieve the status states.
 
static nai_status_t Clear_LVDT_Status (int32_t paramCnt, int32_t *p_params)
 
static nai_status_t Configure_LVDT_Interrupt (int32_t paramCnt, int32_t *p_params)
 
static void SampleCallBack (uint32_t vector)
 
int32_t lvdt_summary (void)
 The purpose of the lvdt_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with LVDT 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_LVDT_Summary.txt"
 
static const int32_t DEF_LVDT_CARD_INDEX = 0
 
static const int32_t DEF_LVDT_MODULE = 1
 
static const int32_t DEF_LVDT_CHANNEL = 1
 
static naiapp_cmdtbl_params_t LVDT_SummaryMenuCmds []
 

Enumeration Type Documentation

◆ lvdt_basic_interrupt_commands

Enumerator
LVDT_SUMMARY_INTERRUPT_CMD_CONFIGURE 
LVDT_SUMMARY_INTERRUPT_CMD_STATUS_READ 
LVDT_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR 
LVDT_SUMMARY_INTERRUPT_CMD_COUNT 

Function Documentation

◆ Cfg_LVDT_Channel()

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

Cfg_LVDT_Channel handles calling the Display_LVDT_ChannelCfg routine to display the LVDT channel configuration and calling the routines associated with the user's menu commands.

◆ Clear_LVDT_Status()

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

◆ Configure_LVDT_Interrupt()

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

◆ Display_LVDT_Status()

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

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

◆ lvdt_summary()

int32_t lvdt_summary ( void )

The purpose of the lvdt_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with LVDT 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.

◆ Run_LVDT_Summary()

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

Run_LVDT_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_LVDT_Channel if the card, module, and channel specified are all valid for the LVDT module.

◆ SampleCallBack()

static void SampleCallBack ( uint32_t vector)
static

◆ Verify_LVDT_ParamCnt()

static void Verify_LVDT_ParamCnt ( int32_t paramCnt)
static

Verify_LVDT_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_LVDT_Summary.txt"
static

◆ DEF_LVDT_CARD_INDEX

const int32_t DEF_LVDT_CARD_INDEX = 0
static

◆ DEF_LVDT_CHANNEL

const int32_t DEF_LVDT_CHANNEL = 1
static

◆ DEF_LVDT_MODULE

const int32_t DEF_LVDT_MODULE = 1
static

◆ LVDT_SummaryMenuCmds

naiapp_cmdtbl_params_t LVDT_SummaryMenuCmds[]
static
Initial value:
= {
{"INT", "LVDT Configure Interrupt", LVDT_SUMMARY_INTERRUPT_CMD_CONFIGURE, Configure_LVDT_Interrupt},
}
static nai_status_t Display_LVDT_Status(int32_t paramCnt, int32_t *p_params)
Display_LVDT_Status illustrates the methods to call in the naibrd library to retrieve the status stat...
Definition lvdt_summary.c:233
@ LVDT_SUMMARY_INTERRUPT_CMD_STATUS_READ
Definition lvdt_summary.c:43
@ LVDT_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR
Definition lvdt_summary.c:44
@ LVDT_SUMMARY_INTERRUPT_CMD_CONFIGURE
Definition lvdt_summary.c:42
static nai_status_t Clear_LVDT_Status(int32_t paramCnt, int32_t *p_params)
Definition lvdt_summary.c:275
static nai_status_t Configure_LVDT_Interrupt(int32_t paramCnt, int32_t *p_params)
Definition lvdt_summary.c:297