ttl_basic_ops.c File Reference

Enumerations
enum	ttl_basicops_commands {   TTL_BASICOP_CMD_IOFORMAT , TTL_BASICOP_CMD_OUTPUTSTATE , TTL_BASICOP_CMD_DEBOUNCE , TTL_BASICOP_CMD_RESET_OC ,   TTL_BASICOP_CMD_STATUS , TTL_BASICOP_CMD_FLOAT , TTL_BASICOP_CMD_BIT_THRESHOLD , TTL_BASICOP_CMD_CHANNEL_STATUS_ENABLE ,   TTL_BASICOP_CMD_CHECK_POWER_ON_BIT_COMPLETE , TTL_BASICOP_CMD_CLEAR_MODULE_BIT_LOGIC , TTL_BASICOP_CMD_MODULE_POWER_RESET , TTL_BASICOP_CMD_WD_MENU ,   TTL_BASICOP_CMD_COUNT }
enum	ttl_gen5_ttl_watchdog_commands {   TTL_COMMON_CMD_WD_QUIETTIME , TTL_COMMON_CMD_WD_WINDOWTIME , TTL_COMMON_CMD_WD_DISPLAY , TTL_COMMON_CMD_WD_STROBE ,   TTL_COMMON_CMD_WD_KILL , TTL_COMMON_CMD_WD_BACK , TTL_COMMON_CMD_WD_COUNT }
enum	ttl_module_power_reset_commands { TTL_MODULE_POWER_RESET_CMD_BACK , TTL_MODULE_POWER_RESET_CMD_CLEAR_MODULE_POWER_RESET_STATUS , TTL_MODULE_POWER_RESET_CMD_SET_MODULE_POWER_RESET , TTL_MODULE_POWER_RESET_CMD_COUNT }

Functions
static int32_t	Run_TTL_BasicOps (int32_t cardIndex, int32_t module, uint32_t modid)
	Run_TTL_BasicOps prompts the user for the card, module and channel to use for the application and calls Cfg_TTL_Channel if the card, module, channel is valid for as a discrete module.
static void	Verify_TTL_ParamCnt (int32_t paramCnt)
	Verify_TTL_ParamCnt verifies parameter count and displays error message if invalid.
static void	Cfg_TTL_Channel (int32_t cardIndex, int32_t module, uint32_t ModuleID, int32_t MaxChannel)
	Cfg_TTL_Channel handles calling the Display_TTL_ChannelCfg routine to display the discrete channel configuration and calling the routines associated with the user's menu commands.
static void	Display_TTL_ChannelCfg (int32_t cardIndex, int32_t module, int32_t chan, uint32_t ModuleID)
	Display_TTL_ChannelCfg illustrate the methods to call in the naibrd library to retrieve the configuration states for basic operation.
static nai_status_t	Display_TTL_Status (int32_t paramCnt, int32_t *p_params)
	Display_TTL_Status illustrate the methods to call in the naibrd library to retrieve the status states.
static nai_status_t	Configure_TTL_IOFormat (int32_t paramCnt, int32_t *p_params)
	Configure_TTL_IOFormat handles the user request to configure the Input/Output configuration for the selected channel and calls the method in the naibrd library to set the Input/Output mode.
static nai_status_t	Configure_TTL_OutputState (int32_t paramCnt, int32_t *p_params)
	Configure_TTL_OutputState handles the user request to set the Output state for the selected channel and calls the method in the naibrd library to set the Output state.
static nai_status_t	Configure_TTL_Debounce (int32_t paramCnt, int32_t *p_params)
	Configure_TTL_Threshold handles the user request to configure the selected threshold configuration and channel and calls the method in the naibrd library to set the threshold voltage.
static nai_status_t	Configure_TTL_Floating (int32_t paramCnt, int32_t *p_params)
	Configure_TTL_Floating handles the user request to set the floating point enable and calls the method in the naibrd library to set the floating point state.
static nai_status_t	Configure_TTL_BITThresholds (int32_t paramCnt, int32_t *p_params)
	Configure_TTL_BITThresholds() allows the user to set and get the BIT error thresholds. This is an advanced feature.
static nai_status_t	Configure_TTL_ChannelStatusEnable (int32_t paramCount, int32_t *params)
	This function Enables\Disables the reporting of the Channel Status. When enabled, the user will get status updates. When disabled, the statuses will not report and status-based interrupts will not assert.
static nai_status_t	Configure_TTL_CheckPBITComplete (int32_t paramCount, int32_t *p_params)
	Configure_TTL_CheckPBITComplete handles the user request to check the module power-on BIT completed state and calls the method in the naibrd library to check the power-on BIT completed state. If the power-on BIT completed state is set, meaning that power-on BIT has completed, the Latched BIT Status of each channel is checked by calling the method in the naibrd library to read the BIT Status.
static nai_status_t	Configure_TTL_ClearModuleBITLogic (int32_t paramCount, int32_t *p_params)
	Configure_TTL_ClearModuleBITLogic handles the user request to clear the module BIT logic, which resets the Continuous BIT internal circuitry and counter, and calls the method in the naibrd library to clear the module BIT logic.
static nai_status_t	Configure_TTL_ModulePowerResetMenu (int32_t paramCount, int32_t *p_params)
	Handle_TTL_ModulePowerResetMenu displays the menu for module power reset commands.
static nai_status_t	Configure_TTL_ClearModulePowerResetStatus (int32_t paramCount, int32_t *p_params)
	Handle_TTL_ClearModulePowerResetStatus handles the user request to clear the module power reset status and calls the method in the naibrd library to clear the module power reset status. The user is prompted for the module power reset status type to clear.
static nai_status_t	Configure_TTL_SetModulePowerReset (int32_t paramCount, int32_t *p_params)
	Handle_TTL_SetModulePowerReset handles the user request to set the module power reset request and calls the method in the naibrd library to set the module power reset request. The user is prompted for the module power reset request type to set, and then the user is prompted to set or reset the request bit.
static nai_status_t	Handle_TTL_WatchdogShowMenu (int32_t paramCount, int32_t *params)
	This function displays the menu for watchdog commands.
static nai_status_t	Handle_TTL_WatchDogQuietTime (int32_t paramCount, int32_t *params)
	This function sets the watchdog quiet time for the module. The user is prompted for the value in ms.
static nai_status_t	Handle_TTL_WatchDogWindowTime (int32_t paramCount, int32_t *params)
	This function sets the watchdog window time for the module. The user is prompted for the value in ms.
static nai_status_t	Handle_TTL_DisplayWatchdog (int32_t paramCount, int32_t *params)
	This function displays the TTL Watchdog Operations data.
static nai_status_t	Handle_TTL_StrobeWatchdog (int32_t paramCount, int32_t *params)
	This function will start a thread to continuously Strobe the watchdog. The user is prompted for the value in ms. NOTE: When this thread/application exits the module will shut off all outputs and will need to be power cycled in order to be operational.
static nai_status_t	Handle_TTL_kill_WDStrobe_Thread (int32_t paramCount, int32_t *params)
	This function will terminate the WD Strobing thread. Module will shut off outputs at this state and will need to be power cycled to be operational.
static void	naiapp_kill_WDStrobe_Thread ()
	This function will terminate the WD strobing thread. Module will shut off outputs at this state and will need to be power cycled to be operational.
DWORD WINAPI	WD_Strobe_ThreadEntryPoint (LPVOID param) void *WD_Strobe_ThreadEntryPoint(void *param) static int WD_Strobe_ThreadEntryPoint(int32_t param)
	This function will continuously loop, strobing the watchdog every QuietTime + Window/2.
void *	WD_Strobe_ThreadEntryPoint (void *arg)
static int	WD_Strobe_ThreadEntryPoint (int32_t nParam)
int32_t	TTL_BasicOps (void)
	The purpose of the TTL_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the discrete modules for configuration setup, controlling the drive outputs, and reading the channels.

Variables
static const int8_t *	DEF_CONFIG_FILE = (const int8_t *)"default_TTL_BasicOps.txt"
static bool_t	terminateThread
static const int8_t *	SAMPLE_WD_PGM_NAME = (const int8_t*)"TTL Watchdog Operations"
static const int32_t	DEF_TTL_CARD_INDEX = 0
static const int32_t	DEF_TTL_MODULE = 1
static const int32_t	DEF_TTL_CHANNEL = 1
static HANDLE	thread = NULL
static naiapp_cmdtbl_params_t	TTL_BasicOpMenuCmds []
naiapp_cmdtbl_params_t	TTL_WatchdogOpMenuCmds [TTL_COMMON_CMD_WD_COUNT]
naiapp_cmdtbl_params_t	TTL_ModulePowerResetMenuCmds [TTL_MODULE_POWER_RESET_CMD_COUNT]

Enumeration Type Documentation

ttl_basicops_commands

enum ttl_basicops_commands

Enumerator
TTL_BASICOP_CMD_IOFORMAT
TTL_BASICOP_CMD_OUTPUTSTATE
TTL_BASICOP_CMD_DEBOUNCE
TTL_BASICOP_CMD_RESET_OC
TTL_BASICOP_CMD_STATUS
TTL_BASICOP_CMD_FLOAT
TTL_BASICOP_CMD_BIT_THRESHOLD
TTL_BASICOP_CMD_CHANNEL_STATUS_ENABLE
TTL_BASICOP_CMD_CHECK_POWER_ON_BIT_COMPLETE
TTL_BASICOP_CMD_CLEAR_MODULE_BIT_LOGIC
TTL_BASICOP_CMD_MODULE_POWER_RESET
TTL_BASICOP_CMD_WD_MENU
TTL_BASICOP_CMD_COUNT

ttl_gen5_ttl_watchdog_commands

enum ttl_gen5_ttl_watchdog_commands

Enumerator
TTL_COMMON_CMD_WD_QUIETTIME
TTL_COMMON_CMD_WD_WINDOWTIME
TTL_COMMON_CMD_WD_DISPLAY
TTL_COMMON_CMD_WD_STROBE
TTL_COMMON_CMD_WD_KILL
TTL_COMMON_CMD_WD_BACK
TTL_COMMON_CMD_WD_COUNT

ttl_module_power_reset_commands

enum ttl_module_power_reset_commands

Enumerator
TTL_MODULE_POWER_RESET_CMD_BACK
TTL_MODULE_POWER_RESET_CMD_CLEAR_MODULE_POWER_RESET_STATUS
TTL_MODULE_POWER_RESET_CMD_SET_MODULE_POWER_RESET
TTL_MODULE_POWER_RESET_CMD_COUNT

Function Documentation

Cfg_TTL_Channel()

static void Cfg_TTL_Channel ( int32_t cardIndex, int32_t module, uint32_t ModuleID, int32_t MaxChannel )

static

Cfg_TTL_Channel handles calling the Display_TTL_ChannelCfg routine to display the discrete channel configuration and calling the routines associated with the user's menu commands.

Configure_TTL_BITThresholds()

static nai_status_t Configure_TTL_BITThresholds ( int32_t paramCnt, int32_t * p_params )

static

Configure_TTL_BITThresholds() allows the user to set and get the BIT error thresholds. This is an advanced feature.

Configure_TTL_ChannelStatusEnable()

static nai_status_t Configure_TTL_ChannelStatusEnable ( int32_t paramCount, int32_t * params )

static

This function Enables\Disables the reporting of the Channel Status. When enabled, the user will get status updates. When disabled, the statuses will not report and status-based interrupts will not assert.

Configure_TTL_CheckPBITComplete()

static nai_status_t Configure_TTL_CheckPBITComplete ( int32_t paramCount, int32_t * p_params )

static

Configure_TTL_CheckPBITComplete handles the user request to check the module power-on BIT completed state and calls the method in the naibrd library to check the power-on BIT completed state. If the power-on BIT completed state is set, meaning that power-on BIT has completed, the Latched BIT Status of each channel is checked by calling the method in the naibrd library to read the BIT Status.

Configure_TTL_ClearModuleBITLogic()

static nai_status_t Configure_TTL_ClearModuleBITLogic ( int32_t paramCount, int32_t * p_params )

static

Configure_TTL_ClearModuleBITLogic handles the user request to clear the module BIT logic, which resets the Continuous BIT internal circuitry and counter, and calls the method in the naibrd library to clear the module BIT logic.

Configure_TTL_ClearModulePowerResetStatus()

static nai_status_t Configure_TTL_ClearModulePowerResetStatus ( int32_t paramCount, int32_t * p_params )

static

Handle_TTL_ClearModulePowerResetStatus handles the user request to clear the module power reset status and calls the method in the naibrd library to clear the module power reset status. The user is prompted for the module power reset status type to clear.

Configure_TTL_Debounce()

nai_status_t Configure_TTL_Debounce ( int32_t paramCnt, int32_t * p_params )

static

Configure_TTL_Threshold handles the user request to configure the selected threshold configuration and channel and calls the method in the naibrd library to set the threshold voltage.

Configure_TTL_Floating()

static nai_status_t Configure_TTL_Floating ( int32_t paramCnt, int32_t * p_params )

static

Configure_TTL_Floating handles the user request to set the floating point enable and calls the method in the naibrd library to set the floating point state.

Configure_TTL_IOFormat()

nai_status_t Configure_TTL_IOFormat ( int32_t paramCnt, int32_t * p_params )

static

Configure_TTL_IOFormat handles the user request to configure the Input/Output configuration for the selected channel and calls the method in the naibrd library to set the Input/Output mode.

Configure_TTL_ModulePowerResetMenu()

static nai_status_t Configure_TTL_ModulePowerResetMenu ( int32_t paramCount, int32_t * p_params )

static

Handle_TTL_ModulePowerResetMenu displays the menu for module power reset commands.

Configure_TTL_OutputState()

static nai_status_t Configure_TTL_OutputState ( int32_t paramCnt, int32_t * p_params )

static

Configure_TTL_OutputState handles the user request to set the Output state for the selected channel and calls the method in the naibrd library to set the Output state.

Configure_TTL_SetModulePowerReset()

static nai_status_t Configure_TTL_SetModulePowerReset ( int32_t paramCount, int32_t * p_params )

static

Handle_TTL_SetModulePowerReset handles the user request to set the module power reset request and calls the method in the naibrd library to set the module power reset request. The user is prompted for the module power reset request type to set, and then the user is prompted to set or reset the request bit.

Display_TTL_ChannelCfg()

static void Display_TTL_ChannelCfg ( int32_t cardIndex, int32_t module, int32_t chan, uint32_t ModuleID )

static

Display_TTL_ChannelCfg illustrate the methods to call in the naibrd library to retrieve the configuration states for basic operation.

Display_TTL_Status()

static nai_status_t Display_TTL_Status ( int32_t paramCnt, int32_t * p_params )

static

Display_TTL_Status illustrate the methods to call in the naibrd library to retrieve the status states.

Handle_TTL_DisplayWatchdog()

static nai_status_t Handle_TTL_DisplayWatchdog ( int32_t paramCount, int32_t * params )

static

This function displays the TTL Watchdog Operations data.

Handle_TTL_kill_WDStrobe_Thread()

static nai_status_t Handle_TTL_kill_WDStrobe_Thread ( int32_t paramCount, int32_t * params )

static

This function will terminate the WD Strobing thread. Module will shut off outputs at this state and will need to be power cycled to be operational.

Handle_TTL_StrobeWatchdog()

static nai_status_t Handle_TTL_StrobeWatchdog ( int32_t paramCount, int32_t * params )

static

This function will start a thread to continuously Strobe the watchdog. The user is prompted for the value in ms. NOTE: When this thread/application exits the module will shut off all outputs and will need to be power cycled in order to be operational.

Handle_TTL_WatchDogQuietTime()

static nai_status_t Handle_TTL_WatchDogQuietTime ( int32_t paramCount, int32_t * params )

static

This function sets the watchdog quiet time for the module. The user is prompted for the value in ms.

Handle_TTL_WatchdogShowMenu()

static nai_status_t Handle_TTL_WatchdogShowMenu ( int32_t paramCount, int32_t * params )

static

This function displays the menu for watchdog commands.

Handle_TTL_WatchDogWindowTime()

static nai_status_t Handle_TTL_WatchDogWindowTime ( int32_t paramCount, int32_t * params )

static

This function sets the watchdog window time for the module. The user is prompted for the value in ms.

naiapp_kill_WDStrobe_Thread()

static void naiapp_kill_WDStrobe_Thread ( )

static

This function will terminate the WD strobing thread. Module will shut off outputs at this state and will need to be power cycled to be operational.

Run_TTL_BasicOps()

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

static

Run_TTL_BasicOps prompts the user for the card, module and channel to use for the application and calls Cfg_TTL_Channel if the card, module, channel is valid for as a discrete module.

TTL_BasicOps()

int32_t TTL_BasicOps

(

void

)

The purpose of the TTL_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the discrete modules for configuration setup, controlling the drive outputs, and reading the channels.

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 TTL routines.

• ClearDeviceCfg
• QuerySystemCfg
• DisplayDeviceCfg
• GetBoardSNModCfg
• SaveDeviceCfg

Verify_TTL_ParamCnt()

static void Verify_TTL_ParamCnt ( int32_t paramCnt )

static

Verify_TTL_ParamCnt verifies parameter count and displays error message if invalid.

WD_Strobe_ThreadEntryPoint() [1/3]

static int WD_Strobe_ThreadEntryPoint ( int32_t nParam )

static

WD_Strobe_ThreadEntryPoint() [2/3]

DWORD WINAPI WD_Strobe_ThreadEntryPoint

(

LPVOID

param

)

This function will continuously loop, strobing the watchdog every QuietTime + Window/2.

WD_Strobe_ThreadEntryPoint() [3/3]

void * WD_Strobe_ThreadEntryPoint

(

void *

arg

)

Variable Documentation

DEF_CONFIG_FILE

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

static

DEF_TTL_CARD_INDEX

const int32_t DEF_TTL_CARD_INDEX = 0

static

DEF_TTL_CHANNEL

const int32_t DEF_TTL_CHANNEL = 1

static

DEF_TTL_MODULE

const int32_t DEF_TTL_MODULE = 1

static

SAMPLE_WD_PGM_NAME

const int8_t* SAMPLE_WD_PGM_NAME = (const int8_t*)"TTL Watchdog Operations"

static

terminateThread

bool_t terminateThread

static

thread

static int thread = NULL

static

TTL_BasicOpMenuCmds

naiapp_cmdtbl_params_t TTL_BasicOpMenuCmds[]

static

Initial value:

= {
   {"IO",         "TTL Set IO Format",                   TTL_BASICOP_CMD_IOFORMAT,                    Configure_TTL_IOFormat},
   {"OUT",        "TTL Set Output State",                TTL_BASICOP_CMD_OUTPUTSTATE,                 Configure_TTL_OutputState},
   
   {"D",          "TTL Set Debounce Time",               TTL_BASICOP_CMD_DEBOUNCE,                    Configure_TTL_Debounce},
   {"OVER",      "TTL Reset Overcurrent",                TTL_BASICOP_CMD_RESET_OC,                    NULL},
   {"STAT",       "TTL Display Status",                  TTL_BASICOP_CMD_STATUS,                      Display_TTL_Status},
   {"Float",      "TTL Enable/Disable Floating Point",   TTL_BASICOP_CMD_FLOAT,                       Configure_TTL_Floating},
   {"THRESH",     "TTL Set BIT Error Threshold",         TTL_BASICOP_CMD_BIT_THRESHOLD,               Configure_TTL_BITThresholds},
   {"CHANSTAT",   "TTL Enable/Disable Channel Status",   TTL_BASICOP_CMD_CHANNEL_STATUS_ENABLE,       Configure_TTL_ChannelStatusEnable},
   {"POWER",      "TTL Check Power-On BIT Completed",    TTL_BASICOP_CMD_CHECK_POWER_ON_BIT_COMPLETE, Configure_TTL_CheckPBITComplete},
   {"BIT",    "TTL Clear Module BIT Logic",              TTL_BASICOP_CMD_CLEAR_MODULE_BIT_LOGIC,      Configure_TTL_ClearModuleBITLogic},
   {"RESET",  "Show Module Power Reset Menu Options",   TTL_BASICOP_CMD_MODULE_POWER_RESET,          Configure_TTL_ModulePowerResetMenu},
#if !defined (NAIBSP_CONFIG_SOFTWARE_OS_DEOS)
   {"WATCHDOG",   "Show Watchdog Menu Options",         TTL_BASICOP_CMD_WD_MENU,                Handle_TTL_WatchdogShowMenu}
#endif
}

TTL_ModulePowerResetMenuCmds

naiapp_cmdtbl_params_t TTL_ModulePowerResetMenuCmds[TTL_MODULE_POWER_RESET_CMD_COUNT]

Initial value:

=
{
   {"BACK",  "Back to Main Menu",               TTL_MODULE_POWER_RESET_CMD_BACK,                            NULL},
   {"CLEAR", "Clear Module Power Reset Status", TTL_MODULE_POWER_RESET_CMD_CLEAR_MODULE_POWER_RESET_STATUS, Configure_TTL_ClearModulePowerResetStatus},
   {"SET",   "Set Module Power Reset Request",  TTL_MODULE_POWER_RESET_CMD_SET_MODULE_POWER_RESET,          Configure_TTL_SetModulePowerReset}
}

TTL_WatchdogOpMenuCmds

naiapp_cmdtbl_params_t TTL_WatchdogOpMenuCmds[TTL_COMMON_CMD_WD_COUNT]

Initial value:

=
{
   {"BACK",           "Back to Main Menu",                             (int32_t)NULL,                                      NULL},
   {"DISPLAY",        "Display Watchdog Settings",                     TTL_COMMON_CMD_WD_DISPLAY,                  Handle_TTL_DisplayWatchdog},
   {"TIME QUIET",     "Set Watchdog Quiet Time",                       TTL_COMMON_CMD_WD_QUIETTIME,                Handle_TTL_WatchDogQuietTime},
   {"WINDOW",         "Set Watchdog Window Time",                      TTL_COMMON_CMD_WD_WINDOWTIME,               Handle_TTL_WatchDogWindowTime},
   {"STROBE",         "Start thread to continuously strobe watchdog",  TTL_COMMON_CMD_WD_STROBE,                   Handle_TTL_StrobeWatchdog},
   {"KILL",           "Kill Watchdog strobing thread",                 TTL_COMMON_CMD_WD_KILL,                     Handle_TTL_kill_WDStrobe_Thread}
}