Software Library API naibrd 2.24.0
See all documentation at naii.docs.com

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_CAN_GetDropCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outdropCountVal)
 Get the Drop Count for specified channel. (How many CAN msgs known to have been dropped)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_CAN_ResetDropCount (int32_t cardIndex, int32_t module, int32_t channel)
 Resets the Drop Count for specified channel back to zero. (Messages will get "dropped" if the Rx FIFO is full)
 

Detailed Description

Function Documentation

◆ naibrd_AR_CAN_GetDropCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_CAN_GetDropCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outdropCountVal )

Get the Drop Count for specified channel. (How many CAN msgs known to have been dropped)

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]).
outdropCountVal: (Output) CAN message drop count.
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_SUPPORTED when function is not supported.

◆ naibrd_AR_CAN_ResetDropCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_CAN_ResetDropCount ( int32_t cardIndex,
int32_t module,
int32_t channel )

Resets the Drop Count for specified channel back to zero. (Messages will get "dropped" if the Rx FIFO is full)

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]).
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_SUPPORTED when function is not supported.