Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Configuration Functions
IOCT Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetCommand (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_cmd_t command)
 Sets the IOCT channel's command configuration settings.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetCommand (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_cmd_t *outcommand)
 Retrieves the IOCT channel's command configuration settings.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetPermittedXmitSegMap (int32_t cardIndex, int32_t module, int32_t channel, uint32_t segmap)
 Sets the Transmission Segments Map that are permitted for the IOCT channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetPermittedXmitSegMap (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outsegmap)
 Retrieves the Transmission Segments Map that are permitted for the IOCT channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetInvertCommand (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_invert_cmd_t command)
 Sets the IOCT channel's inverted command configuration settings.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetInvertCommand (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_invert_cmd_t *outcommand)
 Retrieves the IOCT channel's inverted command configuration settings.
 

Detailed Description


Function Documentation

◆ naibrd_IOCT_GetCommand()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetCommand ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ioct_cmd_t * outcommand )

Retrieves the IOCT channel's command configuration settings.

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]).
outcommand: (Output) Configuration commands, refer to nai_ioct_cmd_t definition.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetInvertCommand()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetInvertCommand ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ioct_invert_cmd_t * outcommand )

Retrieves the IOCT channel's inverted command configuration settings.

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]).
outcommand: (Output) Invert Command Configuration, refer to nai_ioct_invert_cmd_t definition.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetPermittedXmitSegMap()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetPermittedXmitSegMap ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outsegmap )

Retrieves the Transmission Segments Map that are permitted for the IOCT channel.

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]).
outsegmap: (Output) Segments map which are permitted for transmission. This value is bitmapped where each bit is associated one segments out of 16 segments map (0xFFFF).
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetCommand()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetCommand ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ioct_cmd_t command )

Sets the IOCT channel's command configuration settings.

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]).
command: (Input) Configuration commands, refer to nai_ioct_cmd_t definition.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetInvertCommand()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetInvertCommand ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ioct_invert_cmd_t command )

Sets the IOCT channel's inverted command configuration settings.

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]).
command: (Input) Invert Command Configuration, refer to nai_ioct_invert_cmd_t definition.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetPermittedXmitSegMap()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetPermittedXmitSegMap ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t segmap )

Sets the Transmission Segments Map that are permitted for the IOCT channel.

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]).
segmap: (Input) Segments map which are permitted for transmission. This value is bitmapped where each bit is associated one segments out of 16 segments map (0xFFFF).
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.