nrfx 3.3
Data Structures | Enumerations | Functions
VPR CSR VIO HAL

Hardware access layer for managing the VPR RISC-V CPU Control and Status Registers for VPR IO (VPR CSR VIO). More...

Data Structures

struct  nrf_vpr_csr_vio_mode_out_t
 Output mode structure. More...
 

Enumerations

enum  nrf_vpr_csr_vio_out_shift_t {
  NRF_VPR_CSR_VIO_OUT_SHIFT_1 = VPRCSR_NORDIC_OUTMODE_SHIFSIZE_SHIFT1 ,
  NRF_VPR_CSR_VIO_OUT_SHIFT_2 = VPRCSR_NORDIC_OUTMODE_SHIFSIZE_SHIFT2 ,
  NRF_VPR_CSR_VIO_OUT_SHIFT_4 = VPRCSR_NORDIC_OUTMODE_SHIFSIZE_SHIFT4 ,
  NRF_VPR_CSR_VIO_OUT_SHIFT_8 = VPRCSR_NORDIC_OUTMODE_SHIFSIZE_SHIFT8 ,
  NRF_VPR_CSR_VIO_OUT_SHIFT_16 = VPRCSR_NORDIC_OUTMODE_SHIFSIZE_SHIFT16
}
 Shift sizes for output. More...
 
enum  nrf_vpr_csr_vio_mode_in_t {
  NRF_VPR_CSR_VIO_MODE_IN_CONTINUOUS = VPRCSR_NORDIC_INMODE_MODE_CONTINUOUS ,
  NRF_VPR_CSR_VIO_MODE_IN_EVENT = VPRCSR_NORDIC_INMODE_MODE_EVENT
}
 Input modes. More...
 

Functions

NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_dir_get (void)
 Function for getting the pin directions mask.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_set (uint16_t value)
 Function for setting the pin directions mask.
 
NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_dir_buffered_get (void)
 Function for getting the buffered pin directions mask.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_buffered_set (uint16_t value)
 Function for setting the buffered pin directions mask.
 
NRF_STATIC_INLINE bool nrf_vpr_csr_vio_dir_buffered_dirty_check (void)
 Function for retrieving the dirty status of buffered pin directions mask.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_toggle_set (uint16_t mask)
 Function for setting the pin directions toggle mask.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_buffered_toggle_set (uint16_t mask)
 Function for setting the buffered pin directions toggle mask.
 
NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_in_get (void)
 Function for getting the input values.
 
NRF_STATIC_INLINE nrf_vpr_csr_vio_mode_in_t nrf_vpr_csr_vio_mode_in_get (void)
 Function for getting the input mode.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_mode_in_set (nrf_vpr_csr_vio_mode_in_t mode)
 Function for setting the input mode.
 
NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_out_get (void)
 Function for getting the output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_set (uint16_t value)
 Function for setting the output values.
 
NRF_STATIC_INLINE uint32_t nrf_vpr_csr_vio_out_buffered_get (void)
 Function for getting the buffered output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_buffered_set (uint32_t value)
 Function for setting the buffered output values.
 
NRF_STATIC_INLINE bool nrf_vpr_csr_vio_out_buffered_dirty_check (void)
 Function for retrieving the dirty status of buffered output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_toggle_set (uint16_t mask)
 Function for setting the output toggle mask.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_toggle_buffered_set (uint16_t mask)
 Function for setting the buffered output toggle mask.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_combined_set (uint32_t value)
 Function for setting the combined output and buffered output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_combined_toggle_set (uint32_t mask)
 Function for setting the combined output and buffered output toggle mask.
 
NRF_STATIC_INLINE bool nrf_vpr_csr_vio_out_combined_dirty_check (void)
 Function for retrieving the dirty status of combined output and buffered output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_mode_out_get (nrf_vpr_csr_vio_mode_out_t *p_mode)
 Function for getting the configuration of output mode.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_mode_out_set (nrf_vpr_csr_vio_mode_out_t const *p_mode)
 Function for setting the configuration of output mode.
 
NRF_STATIC_INLINE uint32_t nrf_vpr_csr_vio_dirout_get (void)
 Function for getting the combined pin directions mask and output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_set (uint32_t value)
 Function for setting the combined pin directions mask and output values.
 
NRF_STATIC_INLINE uint32_t nrf_vpr_csr_vio_dirout_buffered_get (void)
 Function for getting the combined buffered pin directions mask and buffered output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_buffered_set (uint32_t value)
 Function for getting the combined buffered pin directions mask and buffered output values.
 
NRF_STATIC_INLINE bool nrf_vpr_csr_vio_dirout_buffered_dirty_check (void)
 Function for retrieving the dirty status of combined buffered pin directions mask and buffered output values.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_toggle_set (uint32_t mask)
 Function for setting the combined pin directions and output toggle masks.
 
NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_toggle_buffered_set (uint32_t mask)
 Function for setting the combined buffered pin directions and buffered output toggle masks.
 

Detailed Description

Hardware access layer for managing the VPR RISC-V CPU Control and Status Registers for VPR IO (VPR CSR VIO).

Enumeration Type Documentation

◆ nrf_vpr_csr_vio_mode_in_t

Input modes.

Enumerator
NRF_VPR_CSR_VIO_MODE_IN_CONTINUOUS 

Continuous sampling (if CPU is not sleeping).

NRF_VPR_CSR_VIO_MODE_IN_EVENT 

Sampling on Counter 1 event.

◆ nrf_vpr_csr_vio_out_shift_t

Shift sizes for output.

Enumerator
NRF_VPR_CSR_VIO_OUT_SHIFT_1 

Shift OUT by 1 bit.

NRF_VPR_CSR_VIO_OUT_SHIFT_2 

Shift OUT by 2 bits.

NRF_VPR_CSR_VIO_OUT_SHIFT_4 

Shift OUT by 4 bits.

NRF_VPR_CSR_VIO_OUT_SHIFT_8 

Shift OUT by 8 bits.

NRF_VPR_CSR_VIO_OUT_SHIFT_16 

Shift OUT by 16 bits.

Function Documentation

◆ nrf_vpr_csr_vio_dir_buffered_dirty_check()

NRF_STATIC_INLINE bool nrf_vpr_csr_vio_dir_buffered_dirty_check ( void  )

Function for retrieving the dirty status of buffered pin directions mask.

Return values
trueBuffer is dirty.
fasleBuffer is clean.

◆ nrf_vpr_csr_vio_dir_buffered_get()

NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_dir_buffered_get ( void  )

Function for getting the buffered pin directions mask.

Returns
Mask of pin directions. 0 is input, 1 is output.

◆ nrf_vpr_csr_vio_dir_buffered_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_buffered_set ( uint16_t  value)

Function for setting the buffered pin directions mask.

Parameters
[in]valueMask of pin directions to be set. 0 is input, 1 is output.

◆ nrf_vpr_csr_vio_dir_buffered_toggle_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_buffered_toggle_set ( uint16_t  mask)

Function for setting the buffered pin directions toggle mask.

Parameters
[in]maskMask of pin directions to be toggled.

◆ nrf_vpr_csr_vio_dir_get()

NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_dir_get ( void  )

Function for getting the pin directions mask.

Returns
Mask of pin directions. 0 is input, 1 is output.

◆ nrf_vpr_csr_vio_dir_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_set ( uint16_t  value)

Function for setting the pin directions mask.

Parameters
[in]valueMask of pin directions to be set. 0 is input, 1 is output.

◆ nrf_vpr_csr_vio_dir_toggle_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dir_toggle_set ( uint16_t  mask)

Function for setting the pin directions toggle mask.

Parameters
[in]maskMask of pin directions to be toggled.

◆ nrf_vpr_csr_vio_dirout_buffered_dirty_check()

NRF_STATIC_INLINE bool nrf_vpr_csr_vio_dirout_buffered_dirty_check ( void  )

Function for retrieving the dirty status of combined buffered pin directions mask and buffered output values.

Return values
trueBuffer is dirty.
fasleBuffer is clean.

◆ nrf_vpr_csr_vio_dirout_buffered_get()

NRF_STATIC_INLINE uint32_t nrf_vpr_csr_vio_dirout_buffered_get ( void  )

Function for getting the combined buffered pin directions mask and buffered output values.

Note
Lower 16 bits determine the buffered output state, while higher 16 bits determine the buffered pin directions.
Returns
Mask of buffered pin directions and buffered output values.

◆ nrf_vpr_csr_vio_dirout_buffered_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_buffered_set ( uint32_t  value)

Function for getting the combined buffered pin directions mask and buffered output values.

Note
Lower 16 bits determine the buffered output state, while higher 16 bits determine the buffered pin directions.
Parameters
[in]valueMask of buffered pin directions and buffered output values.

◆ nrf_vpr_csr_vio_dirout_get()

NRF_STATIC_INLINE uint32_t nrf_vpr_csr_vio_dirout_get ( void  )

Function for getting the combined pin directions mask and output values.

Note
Lower 16 bits determine the output state, while higher 16 bits determine the pin directions.
Returns
Mask of pin directions and output values.

◆ nrf_vpr_csr_vio_dirout_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_set ( uint32_t  value)

Function for setting the combined pin directions mask and output values.

Note
Lower 16 bits determine the output state, while higher 16 bits determine the pin directions.
Parameters
[in]valueMask of pin directions and output values.

◆ nrf_vpr_csr_vio_dirout_toggle_buffered_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_toggle_buffered_set ( uint32_t  mask)

Function for setting the combined buffered pin directions and buffered output toggle masks.

Note
Lower 16 bits determine the buffered output toggle, while higher 16 bits determine the buffered pin directions toggle.
Parameters
[in]maskMask of values to be toggled.

◆ nrf_vpr_csr_vio_dirout_toggle_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_dirout_toggle_set ( uint32_t  mask)

Function for setting the combined pin directions and output toggle masks.

Note
Lower 16 bits determine the output toggle, while higher 16 bits determine the pin directions toggle.
Parameters
[in]maskMask of values to be toggled.

◆ nrf_vpr_csr_vio_in_get()

NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_in_get ( void  )

Function for getting the input values.

Returns
Mask of input states. 0 is low, 1 is high.

◆ nrf_vpr_csr_vio_mode_in_get()

NRF_STATIC_INLINE nrf_vpr_csr_vio_mode_in_t nrf_vpr_csr_vio_mode_in_get ( void  )

Function for getting the input mode.

Returns
Input mode.

◆ nrf_vpr_csr_vio_mode_in_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_mode_in_set ( nrf_vpr_csr_vio_mode_in_t  mode)

Function for setting the input mode.

Parameters
[in]modeInput mode to be set.

◆ nrf_vpr_csr_vio_mode_out_get()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_mode_out_get ( nrf_vpr_csr_vio_mode_out_t p_mode)

Function for getting the configuration of output mode.

Parameters
[out]p_modePointer to the structure to be filled with output mode.

◆ nrf_vpr_csr_vio_mode_out_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_mode_out_set ( nrf_vpr_csr_vio_mode_out_t const *  p_mode)

Function for setting the configuration of output mode.

Parameters
[in]p_modePointer to the structure with output mode to be set.

◆ nrf_vpr_csr_vio_out_buffered_dirty_check()

NRF_STATIC_INLINE bool nrf_vpr_csr_vio_out_buffered_dirty_check ( void  )

Function for retrieving the dirty status of buffered output values.

Return values
trueBuffer is dirty.
fasleBuffer is clean.

◆ nrf_vpr_csr_vio_out_buffered_get()

NRF_STATIC_INLINE uint32_t nrf_vpr_csr_vio_out_buffered_get ( void  )

Function for getting the buffered output values.

Returns
Mask of output states. 0 is low, 1 is high.

◆ nrf_vpr_csr_vio_out_buffered_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_buffered_set ( uint32_t  value)

Function for setting the buffered output values.

Parameters
[in]valueMask of output states to be set. 0 is low, 1 is high.

◆ nrf_vpr_csr_vio_out_combined_dirty_check()

NRF_STATIC_INLINE bool nrf_vpr_csr_vio_out_combined_dirty_check ( void  )

Function for retrieving the dirty status of combined output and buffered output values.

Return values
trueBuffer is dirty.
fasleBuffer is clean.

◆ nrf_vpr_csr_vio_out_combined_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_combined_set ( uint32_t  value)

Function for setting the combined output and buffered output values.

Note
Lower 16 bits determine the output state, while higher 16 bits determine the buffered output state.
Parameters
[in]valueMask of output states to be set. 0 is low, 1 is high.

◆ nrf_vpr_csr_vio_out_combined_toggle_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_combined_toggle_set ( uint32_t  mask)

Function for setting the combined output and buffered output toggle mask.

Note
Lower 16 bits determine the output toggle, while higher 16 bits determine the buffered output toggle.
Parameters
[in]maskMask of output to be toggled.

◆ nrf_vpr_csr_vio_out_get()

NRF_STATIC_INLINE uint16_t nrf_vpr_csr_vio_out_get ( void  )

Function for getting the output values.

Returns
Mask of output states. 0 is low, 1 is high.

◆ nrf_vpr_csr_vio_out_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_set ( uint16_t  value)

Function for setting the output values.

Parameters
[in]valueMask of output states to be set. 0 is low, 1 is high.

◆ nrf_vpr_csr_vio_out_toggle_buffered_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_toggle_buffered_set ( uint16_t  mask)

Function for setting the buffered output toggle mask.

Parameters
[in]maskMask of output to be toggled.

◆ nrf_vpr_csr_vio_out_toggle_set()

NRF_STATIC_INLINE void nrf_vpr_csr_vio_out_toggle_set ( uint16_t  mask)

Function for setting the output toggle mask.

Parameters
[in]maskMask of output to be toggled.

Documentation feedback | Developer Zone | Subscribe | Updated