Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
FIFO Operation Functions
Printer Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_ReadRxFIFO (int32_t cardIndex, int32_t module, int32_t channel, int32_t count, uint32_t *p_outcountRemaining, uint32_t *p_outrxFifoData, uint32_t *p_outreadCount)
 Retrieves data elements from the Printer's FIFO buffer for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetRxFIFOCount (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outrxFifoCount)
 Retrieves the FIFO counter register that indicates the number of data elements in the Printer FIFO buffer for the specified module and channel. Each time a read operation is made to the Printer's FIFO Buffer, the corresponding FIFO counter register is decremented by one.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetFIFOStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_status_type_t statusType, nai_prnt_fifo_status_t fifoStatus, nai_status_bit_t *p_outstatusBit)
 Retrieves the printer's FIFO status for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetFIFOStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_status_type_t statusType, nai_prnt_fifo_status_t *p_outfifoStatusRaw)
 Retrieves the printer's FIFO status for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_ClearFIFOStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_fifo_status_t fifoStatus)
 Clears the printer's FIFO status corresponding to the specified status, module and channel.
 

Detailed Description


Function Documentation

◆ naibrd_PRNT_ClearFIFOStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_ClearFIFOStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_fifo_status_t fifoStatus )

Clears the printer's FIFO status corresponding to the specified status, module and 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]).
fifoStatus: (Input) Status Type: refer to nai_prnt_fifo_status_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PRNT_GetFIFOStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetFIFOStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_status_type_t statusType,
nai_prnt_fifo_status_t fifoStatus,
nai_status_bit_t * p_outstatusBit )

Retrieves the printer's FIFO status for the specified module and 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]).
statusType: (Input) Status Type (RealTime or Latched): refer to nai_prnt_status_type_t definition.
fifoStatus: (Input) Status: refer to nai_prnt_fifo_status_t definition.
p_outstatusBit: (Output) 0 for Normal, 1 BIT failure or Open Detected.
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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PRNT_GetFIFOStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetFIFOStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_status_type_t statusType,
nai_prnt_fifo_status_t * p_outfifoStatusRaw )

Retrieves the printer's FIFO status for the specified module and 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]).
statusType: (Input) Status Type (RealTime or Latched): refer to nai_prnt_status_type_t definition.
p_outfifoStatusRaw: (Output) Status: refer to nai_prnt_fifo_status_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PRNT_GetRxFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetRxFIFOCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outrxFifoCount )

Retrieves the FIFO counter register that indicates the number of data elements in the Printer FIFO buffer for the specified module and channel. Each time a read operation is made to the Printer's FIFO Buffer, the corresponding FIFO counter register is decremented by one.

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_outrxFifoCount: (Output) Number of data elements in FIFO Buffer.
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.

◆ naibrd_PRNT_ReadRxFIFO()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_ReadRxFIFO ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t count,
uint32_t * p_outcountRemaining,
uint32_t * p_outrxFifoData,
uint32_t * p_outreadCount )

Retrieves data elements from the Printer's FIFO buffer for the specified module and 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]).
count: (Input) Number of data elements to retrieve.
p_outcountRemaining:(Output) Number of data elements that remain in the FIFO buffer.
p_outrxFifoData: (Output) Array of 32-bit raw data.
p_outreadCount:(Output) Number of data elements read from the FIFO buffer.
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.