nrfx 3.3
Enumerations | Functions
USBHS HAL

Hardware access layer for managing the Universal Serial Bus High Speed (USBHS) peripheral. More...

Enumerations

enum  nrf_usbhs_task_t { NRF_USBHS_TASK_START = offsetof(NRF_USBHS_Type, TASKS_START) }
 USBHS tasks. More...
 
enum  nrf_usbhs_event_t { NRF_USBHS_EVENT_CORE = offsetof(NRF_USBHS_Type, EVENTS_CORE) }
 USBHS events. More...
 
enum  nrf_usbhs_int_mask_t { NRF_USBHS_INT_USBCORE_MASK = USBHS_INTENSET_CORE_Msk }
 USBHS interrupts. More...
 

Functions

NRF_STATIC_INLINE void nrf_usbhs_task_trigger (NRF_USBHS_Type *p_reg, nrf_usbhs_task_t task)
 Function for activating the specified USBHS task.
 
NRF_STATIC_INLINE uint32_t nrf_usbhs_task_address_get (NRF_USBHS_Type const *p_reg, nrf_usbhs_task_t task)
 Function for returning the address of the specified USBHS task register.
 
NRF_STATIC_INLINE void nrf_usbhs_event_clear (NRF_USBHS_Type *p_reg, nrf_usbhs_event_t event)
 Function for clearing the specified event.
 
NRF_STATIC_INLINE bool nrf_usbhs_event_check (NRF_USBHS_Type const *p_reg, nrf_usbhs_event_t event)
 Function for retrieving the state of the USBHS event.
 
NRF_STATIC_INLINE bool nrf_usbhs_event_get_and_clear (NRF_USBHS_Type *p_reg, nrf_usbhs_event_t event)
 Function for getting and clearing the state of the specified event.
 
NRF_STATIC_INLINE uint32_t nrf_usbhs_event_address_get (NRF_USBHS_Type const *p_reg, nrf_usbhs_event_t event)
 Function for returning the address of the specified USBHS event register.
 
NRF_STATIC_INLINE void nrf_usbhs_int_enable (NRF_USBHS_Type *p_reg, uint32_t mask)
 Function for enabling the selected interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_usbhs_int_enable_check (NRF_USBHS_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_usbhs_int_enable_get (NRF_USBHS_Type const *p_reg)
 Function for retrieving the information about the enabled interrupts.
 
NRF_STATIC_INLINE void nrf_usbhs_int_disable (NRF_USBHS_Type *p_reg, uint32_t mask)
 Function for disabling the selected interrupts.
 
NRF_STATIC_INLINE void nrf_usbhs_enable (NRF_USBHS_Type *p_reg)
 Function for enabling the USBHS.
 
NRF_STATIC_INLINE void nrf_usbhs_disable (NRF_USBHS_Type *p_reg)
 Function for disabling the USBHS.
 

Detailed Description

Hardware access layer for managing the Universal Serial Bus High Speed (USBHS) peripheral.

Enumeration Type Documentation

◆ nrf_usbhs_event_t

USBHS events.

Enumerator
NRF_USBHS_EVENT_CORE 

Signal that the USB reset condition is detected on the USB lines.

◆ nrf_usbhs_int_mask_t

USBHS interrupts.

Enumerator
NRF_USBHS_INT_USBCORE_MASK 

Interrupt on the USBCORE event.

◆ nrf_usbhs_task_t

USBHS tasks.

Enumerator
NRF_USBHS_TASK_START 

Start the USB peripheral.

Function Documentation

◆ nrf_usbhs_disable()

NRF_STATIC_INLINE void nrf_usbhs_disable ( NRF_USBHS_Type *  p_reg)

Function for disabling the USBHS.

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

◆ nrf_usbhs_enable()

NRF_STATIC_INLINE void nrf_usbhs_enable ( NRF_USBHS_Type *  p_reg)

Function for enabling the USBHS.

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

◆ nrf_usbhs_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_usbhs_event_address_get ( NRF_USBHS_Type const *  p_reg,
nrf_usbhs_event_t  event 
)

Function for returning the address of the specified USBHS event register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventThe specified event.
Returns
Address of the event specified as a function parameter.

◆ nrf_usbhs_event_check()

NRF_STATIC_INLINE bool nrf_usbhs_event_check ( NRF_USBHS_Type const *  p_reg,
nrf_usbhs_event_t  event 
)

Function for retrieving the state of the USBHS 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_usbhs_event_clear()

NRF_STATIC_INLINE void nrf_usbhs_event_clear ( NRF_USBHS_Type *  p_reg,
nrf_usbhs_event_t  event 
)

Function for clearing the specified event.

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

◆ nrf_usbhs_event_get_and_clear()

NRF_STATIC_INLINE bool nrf_usbhs_event_get_and_clear ( NRF_USBHS_Type *  p_reg,
nrf_usbhs_event_t  event 
)

Function for getting and clearing the state of the specified event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be cleared.
Return values
trueThe event was set.
falseThe event was not set.

◆ nrf_usbhs_int_disable()

NRF_STATIC_INLINE void nrf_usbhs_int_disable ( NRF_USBHS_Type *  p_reg,
uint32_t  mask 
)

Function for disabling the selected interrupts.

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

◆ nrf_usbhs_int_enable()

NRF_STATIC_INLINE void nrf_usbhs_int_enable ( NRF_USBHS_Type *  p_reg,
uint32_t  mask 
)

Function for enabling the selected interrupts.

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

◆ nrf_usbhs_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_usbhs_int_enable_check ( NRF_USBHS_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_usbhs_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_usbhs_int_enable_get()

NRF_STATIC_INLINE uint32_t nrf_usbhs_int_enable_get ( NRF_USBHS_Type const *  p_reg)

Function for retrieving the information about the enabled interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The flags of the enabled interrupts.

◆ nrf_usbhs_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_usbhs_task_address_get ( NRF_USBHS_Type const *  p_reg,
nrf_usbhs_task_t  task 
)

Function for returning the address of the specified USBHS task register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskThe specified task.
Returns
Task address.

◆ nrf_usbhs_task_trigger()

NRF_STATIC_INLINE void nrf_usbhs_task_trigger ( NRF_USBHS_Type *  p_reg,
nrf_usbhs_task_t  task 
)

Function for activating the specified USBHS task.

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

Documentation feedback | Developer Zone | Subscribe | Updated