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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInterruptVector (int32_t cardIndex, int32_t module, uint32_t vector)
 Sets the interrupt vector.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInterruptVector (int32_t cardIndex, int32_t module, uint32_t *p_outvector)
 Retrieves the interrupt vector.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInterruptEnableMask (int32_t cardIndex, int32_t module, nai_pwm_status_t mask)
 Sets the interrupt enable mask. The bit fields in this mask correspond to the bits fields in the Status register refer to nai_pwm_status_t. Writing a "1" to a bit will enable an interrupt for that event. This allows any status register condition to cause an interrupt with the exception of the Master Enable switch.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInterruptEnableMask (int32_t cardIndex, int32_t module, nai_pwm_status_t *p_outmask)
 Retrieves the interrupt enable mask. The bit fields in this mask correspond to the bits fields in the Status register refer to nai_pwm_status_t. Writing a "1" to a bit will enable an interrupt for that event. This allows any status register condition to cause an interrupt with the exception of the Master Enable switch.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetVMEInterruptLevel (int32_t cardIndex, int32_t module, uint32_t level)
 Sets the VME interrupt level.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetVMEInterruptLevel (int32_t cardIndex, int32_t module, uint32_t *p_outlevel)
 Retrieves the VME interrupt level.
 

Detailed Description


Function Documentation

◆ naibrd_PWM_GetInterruptEnableMask()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInterruptEnableMask ( int32_t cardIndex,
int32_t module,
nai_pwm_status_t * p_outmask )

Retrieves the interrupt enable mask. The bit fields in this mask correspond to the bits fields in the Status register refer to nai_pwm_status_t. Writing a "1" to a bit will enable an interrupt for that event. This allows any status register condition to cause an interrupt with the exception of the Master Enable switch.

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]).
p_outmask: (Output) Interrupt Enable Mask - refer to nai_pwm_status_t.
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInterruptVector ( int32_t cardIndex,
int32_t module,
uint32_t * p_outvector )

Retrieves the interrupt vector.

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]).
p_outvector: (Output) Interrupt Vector (0 - 255).
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetVMEInterruptLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetVMEInterruptLevel ( int32_t cardIndex,
int32_t module,
uint32_t * p_outlevel )

Retrieves the VME interrupt level.

Note, this is not supported on 68PW1.

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]).
p_outlevel: (Output) VME Interrupt Level (0 - 7).
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetInterruptEnableMask()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInterruptEnableMask ( int32_t cardIndex,
int32_t module,
nai_pwm_status_t mask )

Sets the interrupt enable mask. The bit fields in this mask correspond to the bits fields in the Status register refer to nai_pwm_status_t. Writing a "1" to a bit will enable an interrupt for that event. This allows any status register condition to cause an interrupt with the exception of the Master Enable switch.

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]).
mask: (Input) Interrupt Enable Mask - refer to nai_pwm_status_t.
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInterruptVector ( int32_t cardIndex,
int32_t module,
uint32_t vector )

Sets the interrupt vector.

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]).
vector: (Input) Interrupt Vector (0 - 255).
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetVMEInterruptLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetVMEInterruptLevel ( int32_t cardIndex,
int32_t module,
uint32_t level )

Sets the VME interrupt level.

Note, this is not supported on 68PW1.

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]).
level: (Input) VME Interrupt Level (0 - 7).
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_SUPPORTED when function is not supported.