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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_channel_raw_t type, uint32_t rawdata)
 Sets the "raw" data value for the register type and channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_channel_raw_t type, uint32_t *p_outrawdata)
 Retrieves the "raw" data value for the register type and channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetRaw (int32_t cardIndex, int32_t module, nai_pwm_raw_t type, uint32_t rawdata)
 Sets the "raw" data value for the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetRaw (int32_t cardIndex, int32_t module, nai_pwm_raw_t type, uint32_t *p_outrawdata)
 Retrieves the "raw" data value for the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetDAChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_da_channel_raw_t type, uint32_t rawdata)
 Sets the "raw" data value for the register type and DA channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDAChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_da_channel_raw_t type, uint32_t *p_outrawdata)
 Retrieves the "raw" data value for the register type and DA channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetADChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_ad_channel_raw_t type, uint32_t rawdata)
 Sets the "raw" data value for the register type and AD channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetADChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_ad_channel_raw_t type, uint32_t *p_outrawdata)
 Retrieves the "raw" data value for the register type and AD channel specified.
 

Detailed Description


Function Documentation

◆ naibrd_PWM_GetADChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetADChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_ad_channel_raw_t type,
uint32_t * p_outrawdata )

Retrieves the "raw" data value for the register type and AD channel 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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
type: (Input) Register type (refer to nai_pwm_ad_channel_raw_t).
p_outrawdata: (Output) "Raw" data value to write to the register.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_channel_raw_t type,
uint32_t * p_outrawdata )

Retrieves the "raw" data value for the register type and channel 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 ADC channel to access (1 - [max channels for module]).
type: (Input) Register type (refer to nai_pwm_channel_raw_t).
p_outrawdata: (Input) "Raw" data value read from the register.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetDAChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDAChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_da_channel_raw_t type,
uint32_t * p_outrawdata )

Retrieves the "raw" data value for the register type and DA channel 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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
type: (Input) Register type (refer to nai_pwm_da_ad_channel_raw_t).
p_outrawdata: (Output) "Raw" data value to write to the register.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetRaw ( int32_t cardIndex,
int32_t module,
nai_pwm_raw_t type,
uint32_t * p_outrawdata )

Retrieves the "raw" data value for 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) Register type (refer to nai_pwm_raw_t).
p_outrawdata: (Output) "Raw" data value read from the register.
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_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetADChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetADChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_ad_channel_raw_t type,
uint32_t rawdata )

Sets the "raw" data value for the register type and AD channel 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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
type: (Input) Register type (refer to nai_pwm_ad_channel_raw_t).
rawdata: (Input) "Raw" data value to write to the register.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_channel_raw_t type,
uint32_t rawdata )

Sets the "raw" data value for the register type and channel 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 ADC channel to access (1 - [max channels for module]).
type: (Input) Register type (refer to nai_pwm_channel_raw_t).
rawdata: (Input) "Raw" data value to write to the register.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetDAChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetDAChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_da_channel_raw_t type,
uint32_t rawdata )

Sets the "raw" data value for the register type and DA channel 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 ADC channel to access (1 - MAX_PWM_DAC_CHANNELS).
type: (Input) Register type (refer to nai_pwm_da_channel_raw_t).
rawdata: (Input) "Raw" data value to write to the register.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetRaw ( int32_t cardIndex,
int32_t module,
nai_pwm_raw_t type,
uint32_t rawdata )

Sets the "raw" data value for 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) Register type (refer to nai_pwm_raw_t).
rawdata: (Input) "Raw" data value to write to the register.
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_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.