Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
SSI Standard Operation Functions
Encoder Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Data (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outData)
 Retrieves SSI data from the specified Encoder channel configured as SSI interface controller or listener.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_GreyData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outData)
 Retrieves SSI data in Gray format from the specified Encoder channel configured as SSI interface controller or listener.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SSI_TriggerData (int32_t cardIndex, int32_t module, int32_t channel)
 Initiate SSI data transfer for the specified Encoder channel, only valid for channel configured as an SSI interface controller.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Status (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_status_t type, nai_status_bit_t *outstatusBit)
 Retrieves SSI status bit for the specified Encoder channel and status type. Status bit corresponds to following:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_RcvdParity (int32_t cardIndex, int32_t module, int32_t channel, nai_status_bit_t *outstatusBit)
 Retrieves SSI rcvd parity bit for the specified Encoder channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_RcvdZeroBit (int32_t cardIndex, int32_t module, int32_t channel, nai_status_bit_t *outstatusBit)
 Retrieves SSI rcvd zero bit for the specified Encoder channel.
 

Detailed Description


Function Documentation

◆ naibrd_ENC_GetSSI_Data()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Data ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outData )

Retrieves SSI data from the specified Encoder channel configured as SSI interface controller or listener.

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]).
outData: (Output) SSI received data.
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_ENC_GetSSI_GreyData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_GreyData ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outData )

Retrieves SSI data in Gray format from the specified Encoder channel configured as SSI interface controller or listener.

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]).
outData: (Output) SSI received Grey data.
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_ENC_GetSSI_RcvdParity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_RcvdParity ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_status_bit_t * outstatusBit )

Retrieves SSI rcvd parity bit for the specified Encoder 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]).
outstatusBit: (Output) Rcvd parity bit.
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_ENC_GetSSI_RcvdZeroBit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_RcvdZeroBit ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_status_bit_t * outstatusBit )

Retrieves SSI rcvd zero bit for the specified Encoder 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]).
outstatusBit: (Output) Rcvd parity bit.
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_ENC_GetSSI_Status()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Status ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_status_t type,
nai_status_bit_t * outstatusBit )

Retrieves SSI status bit for the specified Encoder channel and status type. Status bit corresponds to following: 

  NEWDATA            0= No new data, 1= New data available
  OVERFLOW           0= No overflow, 1= Overflow Detected 
  PARITY_ERROR       0= No parity error, 1= Parity Error   
  BUSY               0= Not busy, 1= Transmission in progress
  WATCHDOG_ERROR     0= No error, 1= SSI Qatch Dog Timer Error, timeout
  EXTRA              0= No error, 1= More falling Edges of SSI clock than programmed
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]).
type: (Input) Status Type: refer to nai_enc_ssi_status_t definition.
outstatusBit: (Output) SSI status bit.
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_ENC_SSI_TriggerData()

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

Initiate SSI data transfer for the specified Encoder channel, only valid for channel configured as an SSI interface controller.

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]).
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.