Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
NAI Board Library - Module Functions » SG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetRaw (int32_t cardIndex, int32_t module, naibrd_sg_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRaw (int32_t cardIndex, int32_t module, naibrd_sg_raw_t type, uint32_t *p_outrawdata)
 Retrieves the raw digital data value from the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sg_raw_channel_t type, uint32_t rawdata)
 Sets the raw data value in the register associated with the channel and register type specified. Note: values written to data output registers will have no effect. This function will return NAI_ERROR_NOT_SUPPORTED if the register type specified corresponds to a data output register. Note: Data format may be in floating point, signed integer, or unsigned integer, depending on the selection of the data type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sg_raw_channel_t type, uint32_t *p_outrawdata)
 Retrieves the raw data value from the register associated with the channel and register type specified. Note: Data format may be in floating point, signed integer, or unsigned integer, depending on the selection of the data type being accessed.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_sg_chan_mapped_status_type_t type, uint32_t *p_outrawdata)
 Retrieves the raw status data value from the register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_sg_chan_mapped_status_type_t type, uint32_t rawdata)
 Clears the bits set in the rawdata parameter in the status register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_sg_chan_mapped_status_type_t type, uint32_t rawdata)
 Sets the raw interrupt enable data value in the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_sg_chan_mapped_status_type_t type, uint32_t *p_outrawdata)
 Retrieves the raw interrupt enable data value from the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStatusRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t *p_outrawdata)
 Retrieves the raw status data value from the register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t rawdata)
 Clears the bits set in the rawdata parameter in the status register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetIntEnableRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t rawdata)
 Sets the raw interrupt enable data value in the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetIntEnableRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t *p_outrawdata)
 Retrieves the raw interrupt enable data value from the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.
 

Detailed Description

Function Documentation

◆ naibrd_SG_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_sg_chan_mapped_status_type_t type,
uint32_t rawdata )

Clears the bits set in the rawdata parameter in the status register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.

Note: The Open Status is currently not supported.

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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearStatusRaw ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
uint32_t rawdata )

Clears the bits set in the rawdata parameter in the status register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG 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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_sg_chan_mapped_status_type_t type,
uint32_t * p_outrawdata )

Retrieves the raw interrupt enable data value from the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.

Note: The Open Status is currently not supported.

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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
p_outrawdata: (Output) Raw Data Code.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_sg_chan_mapped_status_type_t type,
uint32_t * p_outrawdata )

Retrieves the raw status data value from the register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.

Note: The Open Status is currently not supported.

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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
p_outrawdata: (Output) Raw Data Code.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sg_raw_channel_t type,
uint32_t * p_outrawdata )

Retrieves the raw data value from the register associated with the channel and register type specified. Note: Data format may be in floating point, signed integer, or unsigned integer, depending on the selection of the data type being accessed.

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 Register Type: refer to naibrd_sg_raw_channel_t definition.
p_outrawdata: (Output) Raw Data Code.
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_SG_GetIntEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetIntEnableRaw ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
uint32_t * p_outrawdata )

Retrieves the raw interrupt enable data value from the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG 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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
p_outrawdata: (Output) Raw Data Code.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRaw ( int32_t cardIndex,
int32_t module,
naibrd_sg_raw_t type,
uint32_t * p_outrawdata )

Retrieves the raw digital data value from the register associated with the 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]).
type: (Input) Module Register Type: refer to naibrd_sg_raw_t definition.
p_outrawdata: (Output) Raw Data Code.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
uint32_t * p_outrawdata )

Retrieves the raw status data value from the register associated with the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG 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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
p_outrawdata: (Output) Raw Data Code.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_sg_chan_mapped_status_type_t type,
uint32_t rawdata )

Sets the raw interrupt enable data value in the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG Channel.

Note: The Open Status is currently not supported.

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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sg_raw_channel_t type,
uint32_t rawdata )

Sets the raw data value in the register associated with the channel and register type specified. Note: values written to data output registers will have no effect. This function will return NAI_ERROR_NOT_SUPPORTED if the register type specified corresponds to a data output register. Note: Data format may be in floating point, signed integer, or unsigned integer, depending on the selection of the data type.

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 Register Type: refer to naibrd_sg_raw_channel_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 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_SG_SetIntEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetIntEnableRaw ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
uint32_t rawdata )

Sets the raw interrupt enable data value in the register associated with the status type specified. The interrupt enable registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB (of the bits that are used) corresponding to the max SG 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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetRaw ( int32_t cardIndex,
int32_t module,
naibrd_sg_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated with the 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]).
type: (Input) Module Register Type: refer to naibrd_sg_raw_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.