Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Buffer / FIFO limit Functions
CAN Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetTxBufferAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, int32_t almostEmptyValue)
 Set the Tx Buffer Almost Empty value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetTxBufferAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outAlmostEmptyValue)
 Get the Tx Buffer Almost Empty value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetRxBufferAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, int32_t almostFullValue)
 Set the Rx Buffer Almost Full value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetRxBufferAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outAlmostFullValue)
 Get the Rx Buffer Almost Full value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetRxBufferHighWatermark (int32_t cardIndex, int32_t module, int32_t channel, int32_t highWatermarkValue)
 Set the Rx Buffer High Watermark value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetRxBufferHighWatermark (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outHighWatermarkValue)
 Get the Rx Buffer High Watermark value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetRxBufferLowWatermark (int32_t cardIndex, int32_t module, int32_t channel, int32_t lowWatermarkValue)
 Set the Rx Buffer Low Watermark value for a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetRxBufferLowWatermark (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outLowWatermarkValue)
 Get the Rx Buffer Low Watermark value for a given channel.
 

Detailed Description


Function Documentation

◆ naibrd_CAN_GetRxBufferAlmostFull()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetRxBufferAlmostFull ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outAlmostFullValue )

Get the Rx Buffer Almost Full value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
outAlmostFullValue: (Output) Value specifying at what value the Rx Buffer is considered Almost Full.
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_CAN_GetRxBufferHighWatermark()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetRxBufferHighWatermark ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outHighWatermarkValue )

Get the Rx Buffer High Watermark value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
outHighWatermarkValue: (Output) Value specifying the currently set value for Rx Buffer High Watermark.
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_CAN_GetRxBufferLowWatermark()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetRxBufferLowWatermark ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outLowWatermarkValue )

Get the Rx Buffer Low Watermark value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
outLowWatermarkValue: (Output) Value specifying the currently set value for Rx Buffer Low Watermark.
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_CAN_GetTxBufferAlmostEmpty()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetTxBufferAlmostEmpty ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outAlmostEmptyValue )

Get the Tx Buffer Almost Empty value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
outAlmostEmptyValue: (Output) Value specifying at what value the Tx Buffer is considered Almost Empty.
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_CAN_SetRxBufferAlmostFull()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetRxBufferAlmostFull ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t almostFullValue )

Set the Rx Buffer Almost Full value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
almostFullValue: (Input) Value specifying at what value the Rx Buffer should be considered Almost Full.
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_CAN_SetRxBufferHighWatermark()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetRxBufferHighWatermark ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t highWatermarkValue )

Set the Rx Buffer High Watermark value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
highWatermarkValue: (Input) Value specifying a FIFO buffer level marker that is considered to be a High Level .
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_CAN_SetRxBufferLowWatermark()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetRxBufferLowWatermark ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t lowWatermarkValue )

Set the Rx Buffer Low Watermark value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
lowWatermarkValue: (Input) Value specifying a FIFO buffer level marker that is considered to be a Low Level .
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_CAN_SetTxBufferAlmostEmpty()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_SetTxBufferAlmostEmpty ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t almostEmptyValue )

Set the Tx Buffer Almost Empty value for a given channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
almostEmptyValue: (Input) Value specifying at what value the Tx Buffer should be considered Almost Empty.
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.