nrfx 3.3
Enumerations | Functions
GPU HAL

Hardware access layer for managing the Graphics Processing Unit (GPU). More...

Enumerations

enum  nrf_gpu_event_t {
  NRF_GPU_EVENT_CORE = offsetof(NRF_GPU_Type, EVENTS_CORE) ,
  NRF_GPU_EVENT_SYS_ERROR = offsetof(NRF_GPU_Type, EVENTS_SYSERROR) ,
  NRF_GPU_EVENT_STARTED = offsetof(NRF_GPU_Type, EVENTS_STARTED) ,
  NRF_GPU_EVENT_FREEZE = offsetof(NRF_GPU_Type, EVENTS_FREEZE)
}
 GPU events. More...
 
enum  nrf_gpu_int_mask_t {
  NRF_GPU_INT_CORE_MASK = GPU_INTEN_CORE_Msk ,
  NRF_GPU_INT_SYS_ERROR_MASK = GPU_INTEN_SYSERROR_Msk ,
  NRF_GPU_INT_STARTED_MASK = GPU_INTEN_STARTED_Msk ,
  NRF_GPU_INT_FREEZE_MASK = GPU_INTEN_FREEZE_Msk
}
 GPU interrupts. More...
 
enum  nrf_gpu_status_mask_t {
  NRF_GPU_STATUS_ACTIVE_MASK = GPU_STATUS_ACTIVE_Msk ,
  NRF_GPU_STATUS_DVFS_MASK = GPU_STATUS_DVFS_Msk
}
 STATUS register bit masks. More...
 

Functions

NRF_STATIC_INLINE void nrf_gpu_event_clear (NRF_GPU_Type *p_reg, nrf_gpu_event_t event)
 Function for clearing the specified GPU event.
 
NRF_STATIC_INLINE bool nrf_gpu_event_check (NRF_GPU_Type const *p_reg, nrf_gpu_event_t event)
 Function for retrieving the state of the GPU event.
 
NRF_STATIC_INLINE uint32_t nrf_gpu_event_address_get (NRF_GPU_Type const *p_reg, nrf_gpu_event_t event)
 Function for getting the address of the specified GPU event register.
 
NRF_STATIC_INLINE void nrf_gpu_int_enable (NRF_GPU_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_gpu_int_disable (NRF_GPU_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE bool nrf_gpu_int_enable_check (NRF_GPU_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE void nrf_gpu_enable (NRF_GPU_Type *p_reg)
 Function for enabling the GPU.
 
NRF_STATIC_INLINE void nrf_gpu_disable (NRF_GPU_Type *p_reg)
 Function for disabling the GPU.
 
NRF_STATIC_INLINE bool nrf_gpu_enable_check (NRF_GPU_Type const *p_reg)
 Function for checking if the GPU peripheral is enabled.
 
NRF_STATIC_INLINE void nrf_gpu_breakpoint_set (NRF_GPU_Type *p_reg)
 Function for setting the GPU breakpoint flag to assert FREEZE event.
 
NRF_STATIC_INLINE void nrf_gpu_breakpoint_resume (NRF_GPU_Type *p_reg)
 Function for resume the GPU breakpoint.
 
NRF_STATIC_INLINE bool nrf_gpu_breakpoint_check (NRF_GPU_Type const *p_reg)
 Function for checking if the the GPU breakpoint active.
 
NRF_STATIC_INLINE uint32_t nrf_gpu_status_get (NRF_GPU_Type const *p_reg)
 Function for getting the GPU current status information.
 

Detailed Description

Hardware access layer for managing the Graphics Processing Unit (GPU).

Enumeration Type Documentation

◆ nrf_gpu_event_t

GPU events.

Enumerator
NRF_GPU_EVENT_CORE 

Event indicating that interrupt triggered at GPU core.

NRF_GPU_EVENT_SYS_ERROR 

Event indicating system error

NRF_GPU_EVENT_STARTED 

Event indicating that the display controller has been enabled.

NRF_GPU_EVENT_FREEZE 

Event indicating that the GPU has hit a breakpoint and all bus transactions are complete.

◆ nrf_gpu_int_mask_t

GPU interrupts.

Enumerator
NRF_GPU_INT_CORE_MASK 

GPU interrupt for CORE event.

NRF_GPU_INT_SYS_ERROR_MASK 

GPU interrupt for SYSERROR event.

NRF_GPU_INT_STARTED_MASK 

GPU interrupt for STARTED event.

NRF_GPU_INT_FREEZE_MASK 

GPU interrupt for FREEZE event.

◆ nrf_gpu_status_mask_t

STATUS register bit masks.

Enumerator
NRF_GPU_STATUS_ACTIVE_MASK 

GPU active indication. 1 - is busy, 0 - idle.

NRF_GPU_STATUS_DVFS_MASK 

Frequency reduction request for GPU core clock.

Function Documentation

◆ nrf_gpu_breakpoint_check()

NRF_STATIC_INLINE bool nrf_gpu_breakpoint_check ( NRF_GPU_Type const *  p_reg)

Function for checking if the the GPU breakpoint active.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueThe GPU breakpoint flag is enabled.
falseThe GPU breakpoint flag is not enabled.

◆ nrf_gpu_breakpoint_resume()

NRF_STATIC_INLINE void nrf_gpu_breakpoint_resume ( NRF_GPU_Type *  p_reg)

Function for resume the GPU breakpoint.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrf_gpu_breakpoint_set()

NRF_STATIC_INLINE void nrf_gpu_breakpoint_set ( NRF_GPU_Type *  p_reg)

Function for setting the GPU breakpoint flag to assert FREEZE event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrf_gpu_disable()

NRF_STATIC_INLINE void nrf_gpu_disable ( NRF_GPU_Type *  p_reg)

Function for disabling the GPU.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrf_gpu_enable()

NRF_STATIC_INLINE void nrf_gpu_enable ( NRF_GPU_Type *  p_reg)

Function for enabling the GPU.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrf_gpu_enable_check()

NRF_STATIC_INLINE bool nrf_gpu_enable_check ( NRF_GPU_Type const *  p_reg)

Function for checking if the GPU peripheral is enabled.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueThe GPU peripheral is enabled.
falseThe GPU peripheral is not enabled.

◆ nrf_gpu_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_gpu_event_address_get ( NRF_GPU_Type const *  p_reg,
nrf_gpu_event_t  event 
)

Function for getting the address of the specified GPU event register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventThe specified event.
Returns
Address of the specified event register.

◆ nrf_gpu_event_check()

NRF_STATIC_INLINE bool nrf_gpu_event_check ( NRF_GPU_Type const *  p_reg,
nrf_gpu_event_t  event 
)

Function for retrieving the state of the GPU event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be checked.
Return values
trueThe event has been generated.
falseThe event has not been generated.

◆ nrf_gpu_event_clear()

NRF_STATIC_INLINE void nrf_gpu_event_clear ( NRF_GPU_Type *  p_reg,
nrf_gpu_event_t  event 
)

Function for clearing the specified GPU event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be cleared.

◆ nrf_gpu_int_disable()

NRF_STATIC_INLINE void nrf_gpu_int_disable ( NRF_GPU_Type *  p_reg,
uint32_t  mask 
)

Function for disabling specified interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be disabled. Use nrf_gpu_int_mask_t values for bit masking.

◆ nrf_gpu_int_enable()

NRF_STATIC_INLINE void nrf_gpu_int_enable ( NRF_GPU_Type *  p_reg,
uint32_t  mask 
)

Function for enabling specified interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be enabled. Use nrf_gpu_int_mask_t values for bit masking.

◆ nrf_gpu_int_enable_check()

NRF_STATIC_INLINE bool nrf_gpu_int_enable_check ( NRF_GPU_Type const *  p_reg,
uint32_t  mask 
)

Function for checking if the specified interrupts are enabled.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be checked. Use nrf_gpu_int_mask_t values for bit masking.
Returns
true requested interrupts are enabled.
false requested interrupts are disabled.

◆ nrf_gpu_status_get()

NRF_STATIC_INLINE uint32_t nrf_gpu_status_get ( NRF_GPU_Type const *  p_reg)

Function for getting the GPU current status information.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The GPU current status bitmask. Use nrf_gpu_status_mask_t values for bit masking.

Documentation feedback | Developer Zone | Subscribe | Updated