Software Library API naibrd 1.62
See all documentation at naii.docs.com
Elapsed Time Counter Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_ETC_Open (int32_t cardIndex, naibrd_comm_t comm)
 Opens access to the Elapsed Time Counter (ETC) in the SIU chassis based on the communication mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ETC_GetElapsedTime (int32_t cardIndex, uint32_t *outyear, uint32_t *outday, uint32_t *outhour, uint32_t *outmin, uint32_t *outsec)
 Retrieves the Elapsed Time Counter (ETC) value in terms of year, day, hour, minutes and seconds.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ETC_GetTotalSeconds (int32_t cardIndex, uint32_t *outtotal_seconds)
 Retrieves the Elapsed Time Counter (ETC) value in terms of total seconds.
 

Detailed Description


Function Documentation

◆ naibrd_ETC_GetElapsedTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ETC_GetElapsedTime ( int32_t cardIndex,
uint32_t * outyear,
uint32_t * outday,
uint32_t * outhour,
uint32_t * outmin,
uint32_t * outsec )

Retrieves the Elapsed Time Counter (ETC) value in terms of year, day, hour, minutes and seconds.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
outyear: (Output) ETC year.
outday: (Output) ETC days within the year.
outhour: (Output) ETC hours within the day.
outmin: (Output) ETC minutes within the hour.
outsec: (Output) ETC seconds within the minute.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.

◆ naibrd_ETC_GetTotalSeconds()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ETC_GetTotalSeconds ( int32_t cardIndex,
uint32_t * outtotal_seconds )

Retrieves the Elapsed Time Counter (ETC) value in terms of total seconds.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
outtotal_seconds: (Output) ETC total seconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.

◆ naibrd_ETC_Open()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ETC_Open ( int32_t cardIndex,
naibrd_comm_t comm )

Opens access to the Elapsed Time Counter (ETC) in the SIU chassis based on the communication mode.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
comm: (Input) Communications mode to use (currently only NAIBRD_COMM_I2C is supported).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_MODE when invalid communication mode parameter is specified.
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_OPEN_FAILED when handle to board is invalid.
  • NAI_NAI_ERROR_WRONG_DEVICE no ETC chip on the backplane.