Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
Discrete Switch Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dsw_group_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the group and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dsw_group_raw_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the group and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the channel and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_channel_raw_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the channel and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetGroupStatusRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dsw_status_type_t type, uint32_t *outrawdata)
 Retrieves the raw status data value in the register associated to the group and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_ClearGroupStatusRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dsw_status_type_t type, uint32_t rawdata)
 Clears the status data value in the register associated to the group and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetGroupInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dsw_status_type_t type, uint32_t rawdata)
 Sets the raw interrupt enable data value in the register associated to the group and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetGroupInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dsw_status_type_t type, uint32_t *outrawdata)
 Retrieves the raw interrupt enable data value in the register associated to the group and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetPullUpSourceEnableRaw (int32_t cardIndex, int32_t module, int32_t group, uint32_t rawdata)
 Retrieves the raw data value in the pull up source enable register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetPullUpSourceEnableRaw (int32_t cardIndex, int32_t module, int32_t group, uint32_t *outrawdata)
 Retrieves the raw Pull Up enable data value in the register associated to the group specified.
 

Detailed Description


Function Documentation

◆ naibrd_DSW_ClearGroupStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_ClearGroupStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dsw_status_type_t type,
uint32_t rawdata )

Clears the status data value in the register associated to the group and status type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dsw_status_type_t definition.
rawdata: (Input) Raw Data Code.
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_VALUE when invalid status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_channel_raw_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to the channel and register type specified.

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) Register type (NAI_DSW_CHAN_RAW_VOLTAGE, NAI_DSW_CHAN_RAW_CURRENT, NAI_DSW_CHAN_RAW_THRESH_MAX_HI, NAI_DSW_CHAN_RAW_THRESH_UPPER, NAI_DSW_CHAN_RAW_THRESH_LOWER, NAI_DSW_CHAN_RAW_THRESH_MIN_LO or NAI_DSW_CHAN_RAW_DEBOUNCE).
outrawdata: (Output) Raw Data Code.
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.
  • NAI_ERROR_INVALID_VALUE when invalid channel or channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetGroupInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetGroupInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dsw_status_type_t type,
uint32_t * outrawdata )

Retrieves the raw interrupt enable data value in the register associated to the group and status type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Register type (NAI_DSW_STATUS_BIT, NAI_DSW_STATUS_OVER_CURRENT, NAI_DSW_STATUS_MAX_HI, NAI_DSW_STATUS_MIN_LO,NAI_DSW_STATUS_MID_RANGE,NAI_DSW_STATUS_LO_HI_TRANS or NAI_DSW_STATUS_HI_LO_TRANS).
outrawdata: (Output) Raw Data Code.
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_VALUE when invalid status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetGroupRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dsw_group_raw_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to the group and register type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Register type (NAI_DSW_RAW_PULL_UP_DOWN_RES_CFG).
outrawdata: (Output) Raw Data Code.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetGroupStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetGroupStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dsw_status_type_t type,
uint32_t * outrawdata )

Retrieves the raw status data value in the register associated to the group and status type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Register type (NAI_DSW_STATUS_BIT, NAI_DSW_STATUS_OVER_CURRENT, NAI_DSW_STATUS_MAX_HI, NAI_DSW_STATUS_MIN_LO,NAI_DSW_STATUS_MID_RANGE,NAI_DSW_STATUS_LO_HI_TRANS or NAI_DSW_STATUS_HI_LO_TRANS).
outrawdata: (Output) Raw Data Code.
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_VALUE when invalid status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetPullUpSourceEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetPullUpSourceEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
uint32_t * outrawdata )

Retrieves the raw Pull Up enable data value in the register associated to the group specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
outrawdata: (Output) Raw Data Code.
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_VALUE when invalid status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to the channel and register type specified.

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) Channel type (NAI_DSW_CHAN_RAW_VOLTAGE, NAI_DSW_CHAN_RAW_CURRENT, NAI_DSW_CHAN_RAW_THRESH_MAX_HI, NAI_DSW_CHAN_RAW_THRESH_UPPER, NAI_DSW_CHAN_RAW_THRESH_LOWER, NAI_DSW_CHAN_RAW_THRESH_MIN_LO or NAI_DSW_CHAN_RAW_DEBOUNCE).
rawdata: (Input) Raw Data Code.
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.
  • NAI_ERROR_INVALID_VALUE when invalid channel or channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_SetGroupInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetGroupInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dsw_status_type_t type,
uint32_t rawdata )

Sets the raw interrupt enable data value in the register associated to the group and status type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Register type (NAI_DSW_STATUS_BIT, NAI_DSW_STATUS_OVER_CURRENT, NAI_DSW_STATUS_MAX_HI, NAI_DSW_STATUS_MIN_LO,NAI_DSW_STATUS_MID_RANGE,NAI_DSW_STATUS_LO_HI_TRANS or NAI_DSW_STATUS_HI_LO_TRANS).
rawdata: (Input) Raw Data Code.
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_VALUE when invalid status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_SetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetGroupRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dsw_group_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to the group and register type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Register type (NAI_DSW_RAW_PULL_UP_DOWN_RES_CFG).
rawdata: (Input) Raw Data Code.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_SetPullUpSourceEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetPullUpSourceEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
uint32_t rawdata )

Retrieves the raw data value in the pull up source enable register.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
rawdata: (Output) Raw Data Code.
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.
  • NAI_ERROR_INVALID_VALUE when invalid channel or channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.