Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Configuration Functions
NAI Board Library - Module Functions » TTL Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables status reporting for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Retrieves the enabled/disabled state of status reporting for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_ioformat_t format)
 Sets the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_ioformat_t *p_outformat)
 Retrieves the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetOutputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_state_t state)
 Sets the Output State for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetOutputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_state_t *p_outstate)
 Retrieves the Output State for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetBankVCCSource (int32_t cardIndex, int32_t module, int32_t bank, naibrd_ttl_vcc_t source)
 Sets the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCSource (int32_t cardIndex, int32_t module, int32_t bank, naibrd_ttl_vcc_t *p_outsource)
 Retrieves the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.
 

Detailed Description

Function Documentation

◆ naibrd_TTL_GetBankVCCSource()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCSource ( int32_t cardIndex,
int32_t module,
int32_t bank,
naibrd_ttl_vcc_t * p_outsource )

Retrieves the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
bank: (Input) Number of the bank set(1 - [max banks for module]).
p_outsource: (Output) Available operation modes: NAIBRD_TTL_VCC_EXTERNAL NAIBRD_TTL_VCC_INTERNAL
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outenable )

Retrieves the enabled/disabled state of status reporting for the specified TTL channel.

Note
channel status enbale is not implemented for TTL modules yet.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outenable: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetIOFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetIOFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_ioformat_t * p_outformat )

Retrieves the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outformat: (Output) NAIBRD_TTL_IOFORMAT_INPUT, NAI_TTL_GEN5_IOFORMAT_OUTPUT or NAIBRD_TTL_GEN3_IOFORMAT_OUTPUT.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_state_t * p_outstate )

Retrieves the Output State for the specified TTL channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outstate: (Output) NAIBRD_TTL_STATE_LO or NAIBRD_TTL_STATE_HI.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetBankVCCSource()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetBankVCCSource ( int32_t cardIndex,
int32_t module,
int32_t bank,
naibrd_ttl_vcc_t source )

Sets the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
bank: (Input) Number of the bank set(1 - [max banks for module]).
source: (Input) Available operation modes: NAIBRD_TTL_VCC_EXTERNAL NAIBRD_TTL_VCC_INTERNAL
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables/disables status reporting for the specified TTL channel.

Note
: channel status enbale is not implemented for TTL modules yet.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) 0 to disable or 1 to enable status reporting for a channel.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetIOFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetIOFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_ioformat_t format )

Sets the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
format: (Input) NAIBRD_TTL_IOFORMAT_INPUT, NAI_TTL_GEN5_IOFORMAT_OUTPUT or NAIBRD_TTL_GEN3_IOFORMAT_OUTPUT.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_state_t state )

Sets the Output State for the specified TTL channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
state: (Input) NAIBRD_TTL_STATE_LO or NAIBRD_TTL_STATE_HI.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.