Software Library API naibrd 1.62
See all documentation at naii.docs.com
Pin Out Control Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetPinoutControl (int32_t cardIndex, int32_t module, int32_t channel, uint32_t pinoutControl)
 Sets the physical pin-out configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetPinoutControl (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outpinoutControl)
 Retrieves the physical pin-out configuration for the specified Serial channel.
 

Detailed Description


Function Documentation

◆ naibrd_SER_GetPinoutControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetPinoutControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outpinoutControl )

Retrieves the physical pin-out configuration for the specified Serial 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]).
outpinoutControl: (Output) Physical Pin-out Configuration.
    0   -  CLK+/- disabled, CTS/RTS mapped in their place
    1   -  CLK+/- enabled, CTS/RTS mapped into extended area
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_SER_SetPinoutControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetPinoutControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t pinoutControl )

Sets the physical pin-out configuration for the specified Serial 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]).
pinoutControl: (Input) Physical Pin-out Configuration.
    0   -  CLK+/- disabled, CTS/RTS mapped in their place
    1   -  CLK+/- enabled, CTS/RTS mapped into extended area
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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.