USBD HAL

group nrf_usbd_hal

Hardware access layer for managing the Universal Serial Bus Device (USBD) peripheral.

Setup command frame functions.

Functions for setting up command frame part access.

NRF_STATIC_INLINE uint8_t nrf_usbd_setup_bmrequesttype_get(NRF_USBD_Type const *p_reg)

Function for reading BMREQUESTTYPE - part of the SETUP packet.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Value of BREQUESTTYPE on the last received SETUP frame.

NRF_STATIC_INLINE uint8_t nrf_usbd_setup_brequest_get(NRF_USBD_Type const *p_reg)

Function for reading BMREQUEST - part of the SETUP packet.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Value of BREQUEST on the last received SETUP frame.

NRF_STATIC_INLINE uint16_t nrf_usbd_setup_wvalue_get(NRF_USBD_Type const *p_reg)

Function for reading WVALUE - part of the SETUP packet.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Value of WVALUE on the last received SETUP frame.

NRF_STATIC_INLINE uint16_t nrf_usbd_setup_windex_get(NRF_USBD_Type const *p_reg)

Function for reading WINDEX - part of the SETUP packet.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Value of WINDEX on the last received SETUP frame.

NRF_STATIC_INLINE uint16_t nrf_usbd_setup_wlength_get(NRF_USBD_Type const *p_reg)

Function for reading WLENGTH - part of the SETUP packet.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Value of WLENGTH on the last received SETUP frame.

Defines

NRF_USBD_FRAMECNTR_SIZE

Frame counter size.

The number of counts that can be fitted into frame counter.

NRF_USBD_EPISO_FIRST

First isochronous endpoint number.

The number of the first isochronous endpoint.

NRF_USBD_EPIN_CNT

Total number of IN endpoints.

Total number of IN endpoint (including ISOCHRONOUS).

NRF_USBD_EPOUT_CNT

Total number of OUT endpoints.

Total number of OUT endpoint (including ISOCHRONOUS).

NRF_USBD_EP_DIR_Msk

Mask of the direction bit in an endpoint number.

NRF_USBD_EP_DIR_IN

The value of direction bit for the IN endpoint direction.

NRF_USBD_EP_DIR_OUT

The value of direction bit for the OUT endpoint direction.

NRF_USBD_EPIN(epnr)

Macro for making the IN endpoint identifier from endpoint number.

Macro that sets direction bit to make IN endpoint.

Parameters

  • epnr – [in] Endpoint number.

Returns

IN Endpoint identifier.

NRF_USBD_EPOUT(epnr)

Macro for making the OUT endpoint identifier from endpoint number.

Macro that sets direction bit to make OUT endpoint.

Parameters

  • epnr – [in] Endpoint number.

Returns

OUT Endpoint identifier.

NRF_USBD_EP_NR_GET(ep)

Macro for extracting the endpoint number from the specified endpoint identifier.

Macro that strips out the information about endpoint direction.

Parameters

  • ep – [in] Endpoint identifier.

Returns

Endpoint number.

NRF_USBD_EPIN_CHECK(ep)

Macro for checking the endpoint direction.

This macro checks if the specified endpoint has the IN direction.

Parameters

  • ep – [in] Endpoint identifier.

Returns true

The endpoint direction is IN.

Returns false

The endpoint direction is OUT.

NRF_USBD_EPOUT_CHECK(ep)

Macro for checking endpoint direction.

This macro checks if given endpoint has OUT direction.

Parameters

  • ep – [in] Endpoint identifier

Returns true

The endpoint direction is OUT

Returns false

The endpoint direction is IN

NRF_USBD_EPISO_CHECK(ep)

Macro for checking if endpoint is isochronous.

Parameters

  • ep – [in] It can be endpoint identifier or just endpoint number to be checked.

Returns true

The endpoint is isochronous type.

Returns false

The endpoint is bulk of interrupt type.

NRF_USBD_EP_VALIDATE(ep)

Macro for checking if given number is valid endpoint number.

Parameters

  • ep – [in] Endpoint number to be checked.

Returns true

The endpoint is valid.

Returns false

The endpoint is not valid.

NRF_USBD_EPISOOUT_NO_DATA

Not isochronous data frame received.

Special value returned by nrf_usbd_episoout_size_get function that means that data frame was not received at all. This allows differentiate between situations when zero size data comes or no data comes at all on isochronous endpoint.

Enums

enum nrf_usbd_task_t

USBD tasks.

Values:

enumerator NRF_USBD_TASK_STARTEPIN0

Captures the EPIN[0].PTR, EPIN[0].MAXCNT, and EPIN[0].CONFIG registers values, and enables control endpoint IN 0 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN1

Captures the EPIN[1].PTR, EPIN[1].MAXCNT, and EPIN[1].CONFIG registers values, and enables data endpoint IN 1 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN2

Captures the EPIN[2].PTR, EPIN[2].MAXCNT, and EPIN[2].CONFIG registers values, and enables data endpoint IN 2 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN3

Captures the EPIN[3].PTR, EPIN[3].MAXCNT, and EPIN[3].CONFIG registers values, and enables data endpoint IN 3 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN4

Captures the EPIN[4].PTR, EPIN[4].MAXCNT, and EPIN[4].CONFIG registers values, and enables data endpoint IN 4 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN5

Captures the EPIN[5].PTR, EPIN[5].MAXCNT, and EPIN[5].CONFIG registers values, and enables data endpoint IN 5 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN6

Captures the EPIN[6].PTR, EPIN[6].MAXCNT, and EPIN[6].CONFIG registers values, and enables data endpoint IN 6 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPIN7

Captures the EPIN[7].PTR, EPIN[7].MAXCNT, and EPIN[7].CONFIG registers values, and enables data endpoint IN 7 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTISOIN

Captures the ISOIN.PTR, ISOIN.MAXCNT, and ISOIN.CONFIG registers values, and enables sending data on ISO endpoint 8.

enumerator NRF_USBD_TASK_STARTEPOUT0

Captures the EPOUT[0].PTR, EPOUT[0].MAXCNT, and EPOUT[0].CONFIG registers values, and enables control endpoint 0 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT1

Captures the EPOUT[1].PTR, EPOUT[1].MAXCNT, and EPOUT[1].CONFIG registers values, and enables data endpoint 1 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT2

Captures the EPOUT[2].PTR, EPOUT[2].MAXCNT, and EPOUT[2].CONFIG registers values, and enables data endpoint 2 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT3

Captures the EPOUT[3].PTR, EPOUT[3].MAXCNT, and EPOUT[3].CONFIG registers values, and enables data endpoint 3 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT4

Captures the EPOUT[4].PTR, EPOUT[4].MAXCNT, and EPOUT[4].CONFIG registers values, and enables data endpoint 4 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT5

Captures the EPOUT[5].PTR, EPOUT[5].MAXCNT, and EPOUT[5].CONFIG registers values, and enables data endpoint 5 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT6

Captures the EPOUT[6].PTR, EPOUT[6].MAXCNT, and EPOUT[6].CONFIG registers values, and enables data endpoint 6 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTEPOUT7

Captures the EPOUT[7].PTR, EPOUT[7].MAXCNT, and EPOUT[7].CONFIG registers values, and enables data endpoint 7 to respond to traffic from host.

enumerator NRF_USBD_TASK_STARTISOOUT

Captures the ISOOUT.PTR, ISOOUT.MAXCNT, and ISOOUT.CONFIG registers values, and enables receiving of data on ISO endpoint 8.

enumerator NRF_USBD_TASK_EP0RCVOUT

Allows OUT data stage on the control endpoint 0.

enumerator NRF_USBD_TASK_EP0STATUS

Allows status stage on the control endpoint 0.

enumerator NRF_USBD_TASK_EP0STALL

STALLs data and status stage on the control endpoint 0.

enumerator NRF_USBD_TASK_DRIVEDPDM

Forces D+ and D-lines to the state defined in the DPDMVALUE register.

enumerator NRF_USBD_TASK_NODRIVEDPDM

Stops forcing D+ and D- lines to any state (USB engine takes control).

enum nrf_usbd_event_t

USBD events.

Values:

enumerator NRF_USBD_EVENT_USBRESET

Signals that a USB reset condition is detected on the USB lines.

enumerator NRF_USBD_EVENT_STARTED

Confirms that the EPIN[n].PTR, EPIN[n].MAXCNT, EPIN[n].CONFIG, or EPOUT[n].PTR, EPOUT[n].MAXCNT, and EPOUT[n].CONFIG registers have been captured on all endpoints reported in the EPSTATUS register.

enumerator NRF_USBD_EVENT_ENDEPIN0

The whole EPIN[0] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN1

The whole EPIN[1] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN2

The whole EPIN[2] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN3

The whole EPIN[3] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN4

The whole EPIN[4] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN5

The whole EPIN[5] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN6

The whole EPIN[6] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPIN7

The whole EPIN[7] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_EP0DATADONE

An acknowledged data transfer has taken place on the control endpoint.

enumerator NRF_USBD_EVENT_ENDISOIN0

The whole ISOIN buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT0

The whole EPOUT[0] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT1

The whole EPOUT[1] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT2

The whole EPOUT[2] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT3

The whole EPOUT[3] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT4

The whole EPOUT[4] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT5

The whole EPOUT[5] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT6

The whole EPOUT[6] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDEPOUT7

The whole EPOUT[7] buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_ENDISOOUT0

The whole ISOOUT buffer has been consumed. The RAM buffer can be accessed safely by software.

enumerator NRF_USBD_EVENT_SOF

Signals that a SOF (start of frame) condition has been detected on the USB lines.

enumerator NRF_USBD_EVENT_USBEVENT

An event or an error not covered by the specified events has occurred, check EVENTCAUSE register to find the cause.

enumerator NRF_USBD_EVENT_EP0SETUP

A valid SETUP token has been received (and acknowledged) on the control endpoint.

enumerator NRF_USBD_EVENT_DATAEP

A data transfer has occurred on a data endpoint, indicated by the EPDATASTATUS register.

enum nrf_usbd_short_mask_t

USBD shorts.

Values:

enumerator NRF_USBD_SHORT_EP0DATADONE_STARTEPIN0_MASK

Shortcut between EP0DATADONE event and STARTEPIN0 task.

enumerator NRF_USBD_SHORT_EP0DATADONE_STARTEPOUT0_MASK

Shortcut between EP0DATADONE event and STARTEPOUT0 task.

enumerator NRF_USBD_SHORT_EP0DATADONE_EP0STATUS_MASK

Shortcut between EP0DATADONE event and EP0STATUS task.

enumerator NRF_USBD_SHORT_ENDEPOUT0_EP0STATUS_MASK

Shortcut between ENDEPOUT[0] event and EP0STATUS task.

enumerator NRF_USBD_SHORT_ENDEPOUT0_EP0RCVOUT_MASK

Shortcut between ENDEPOUT[0] event and EP0RCVOUT task.

enum nrf_usbd_int_mask_t

USBD interrupts.

Values:

enumerator NRF_USBD_INT_USBRESET_MASK

Enable or disable interrupt for USBRESET event.

enumerator NRF_USBD_INT_STARTED_MASK

Enable or disable interrupt for STARTED event.

enumerator NRF_USBD_INT_ENDEPIN0_MASK

Enable or disable interrupt for ENDEPIN[0] event.

enumerator NRF_USBD_INT_ENDEPIN1_MASK

Enable or disable interrupt for ENDEPIN[1] event.

enumerator NRF_USBD_INT_ENDEPIN2_MASK

Enable or disable interrupt for ENDEPIN[2] event.

enumerator NRF_USBD_INT_ENDEPIN3_MASK

Enable or disable interrupt for ENDEPIN[3] event.

enumerator NRF_USBD_INT_ENDEPIN4_MASK

Enable or disable interrupt for ENDEPIN[4] event.

enumerator NRF_USBD_INT_ENDEPIN5_MASK

Enable or disable interrupt for ENDEPIN[5] event.

enumerator NRF_USBD_INT_ENDEPIN6_MASK

Enable or disable interrupt for ENDEPIN[6] event.

enumerator NRF_USBD_INT_ENDEPIN7_MASK

Enable or disable interrupt for ENDEPIN[7] event.

enumerator NRF_USBD_INT_EP0DATADONE_MASK

Enable or disable interrupt for EP0DATADONE event.

enumerator NRF_USBD_INT_ENDISOIN0_MASK

Enable or disable interrupt for ENDISOIN[0] event.

enumerator NRF_USBD_INT_ENDEPOUT0_MASK

Enable or disable interrupt for ENDEPOUT[0] event.

enumerator NRF_USBD_INT_ENDEPOUT1_MASK

Enable or disable interrupt for ENDEPOUT[1] event.

enumerator NRF_USBD_INT_ENDEPOUT2_MASK

Enable or disable interrupt for ENDEPOUT[2] event.

enumerator NRF_USBD_INT_ENDEPOUT3_MASK

Enable or disable interrupt for ENDEPOUT[3] event.

enumerator NRF_USBD_INT_ENDEPOUT4_MASK

Enable or disable interrupt for ENDEPOUT[4] event.

enumerator NRF_USBD_INT_ENDEPOUT5_MASK

Enable or disable interrupt for ENDEPOUT[5] event.

enumerator NRF_USBD_INT_ENDEPOUT6_MASK

Enable or disable interrupt for ENDEPOUT[6] event.

enumerator NRF_USBD_INT_ENDEPOUT7_MASK

Enable or disable interrupt for ENDEPOUT[7] event.

enumerator NRF_USBD_INT_ENDISOOUT0_MASK

Enable or disable interrupt for ENDISOOUT[0] event.

enumerator NRF_USBD_INT_SOF_MASK

Enable or disable interrupt for SOF event.

enumerator NRF_USBD_INT_USBEVENT_MASK

Enable or disable interrupt for USBEVENT event.

enumerator NRF_USBD_INT_EP0SETUP_MASK

Enable or disable interrupt for EP0SETUP event.

enumerator NRF_USBD_INT_DATAEP_MASK

Enable or disable interrupt for EPDATA event.

enum nrf_usbd_eventcause_mask_t

EVENTCAUSE register bit masks.

Values:

enumerator NRF_USBD_EVENTCAUSE_ISOOUTCRC_MASK

CRC error was detected on isochronous OUT endpoint 8.

enumerator NRF_USBD_EVENTCAUSE_SUSPEND_MASK

Signals that the USB lines have been seen idle long enough for the device to enter suspend.

enumerator NRF_USBD_EVENTCAUSE_RESUME_MASK

Signals that a RESUME condition (K state or activity restart) has been detected on the USB lines.

enumerator NRF_USBD_EVENTCAUSE_WUREQ_MASK

The USBD peripheral has exited Low Power mode.

enumerator NRF_USBD_EVENTCAUSE_READY_MASK

MAC is ready for normal operation, rised few us after USBD enabling.

enum nrf_usbd_dpdmvalue_t

DPDMVALUE register.

Values:

enumerator NRF_USBD_DPDMVALUE_RESUME

Generate RESUME signal. Signal is generated for 50us or 5ms, depending on bus state.

enumerator NRF_USBD_DPDMVALUE_J

D+ Forced high, D- forced low (J state)

enumerator NRF_USBD_DPMVALUE_K

D+ Forced low, D- forced high (K state)

enum nrf_usbd_dtoggle_t

Data toggle value or operation.

Values:

enumerator NRF_USBD_DTOGGLE_NOP

No operation - do not change the current data toggle on the selected endpoint.

enumerator NRF_USBD_DTOGGLE_DATA0

Data toggle is DATA0 on the selected endpoint.

enumerator NRF_USBD_DTOGGLE_DATA1

Data toggle is DATA1 on the selected endpoint.

enum nrf_usbd_epstatus_mask_t

EPSTATUS bit masks.

Values:

enumerator NRF_USBD_EPSTATUS_EPIN0_MASK
enumerator NRF_USBD_EPSTATUS_EPIN1_MASK
enumerator NRF_USBD_EPSTATUS_EPIN2_MASK
enumerator NRF_USBD_EPSTATUS_EPIN3_MASK
enumerator NRF_USBD_EPSTATUS_EPIN4_MASK
enumerator NRF_USBD_EPSTATUS_EPIN5_MASK
enumerator NRF_USBD_EPSTATUS_EPIN6_MASK
enumerator NRF_USBD_EPSTATUS_EPIN7_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT0_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT1_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT2_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT3_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT4_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT5_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT6_MASK
enumerator NRF_USBD_EPSTATUS_EPOUT7_MASK
enum nrf_usbd_dataepstatus_mask_t

DATAEPSTATUS bit masks.

Values:

enumerator NRF_USBD_EPDATASTATUS_EPIN1_MASK
enumerator NRF_USBD_EPDATASTATUS_EPIN2_MASK
enumerator NRF_USBD_EPDATASTATUS_EPIN3_MASK
enumerator NRF_USBD_EPDATASTATUS_EPIN4_MASK
enumerator NRF_USBD_EPDATASTATUS_EPIN5_MASK
enumerator NRF_USBD_EPDATASTATUS_EPIN6_MASK
enumerator NRF_USBD_EPDATASTATUS_EPIN7_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT1_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT2_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT3_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT4_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT5_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT6_MASK
enumerator NRF_USBD_EPDATASTATUS_EPOUT7_MASK
enum nrf_usbd_isosplit_t

ISOSPLIT configurations.

Values:

enumerator NRF_USBD_ISOSPLIT_ONEDIR

Full buffer dedicated to either ISO IN or OUT.

enumerator NRF_USBD_ISOSPLIT_HALF

Buffer divided in half.

enum nrf_usbd_isoinconfig_t

ISOINCONFIG configurations.

Values:

enumerator NRF_USBD_ISOINCONFIG_NORESP

Endpoint does not respond to an ISO IN token when no data is ready.

enumerator NRF_USBD_ISOINCONFIG_ZERODATA

Endpoint responds with a zero-length data packet to an ISO IN token when no data is ready.

Functions

NRF_STATIC_INLINE void nrf_usbd_task_trigger(NRF_USBD_Type *p_reg, nrf_usbd_task_t task)

Function for activating the specified USBD task.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • task – [in] Task to be activated.

NRF_STATIC_INLINE uint32_t nrf_usbd_task_address_get(NRF_USBD_Type const *p_reg, nrf_usbd_task_t task)

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

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • task – [in] Task.

Returns

Task address.

NRF_STATIC_INLINE void nrf_usbd_event_clear(NRF_USBD_Type *p_reg, nrf_usbd_event_t event)

Function for clearing the specified event.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • event – [in] Event.

NRF_STATIC_INLINE bool nrf_usbd_event_check(NRF_USBD_Type const *p_reg, nrf_usbd_event_t event)

Function for retrieving the state of the USBD event.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • event – [in] Event to be checked.

Returns true

The event has been generated.

Returns false

The event has not been generated.

NRF_STATIC_INLINE bool nrf_usbd_event_get_and_clear(NRF_USBD_Type *p_reg, nrf_usbd_event_t event)

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

This function checks the state of the event and clears it.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • event – [in] Event.

Returns true

The event was set.

Returns false

The event was not set.

NRF_STATIC_INLINE uint32_t nrf_usbd_event_address_get(NRF_USBD_Type const *p_reg, nrf_usbd_event_t event)

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

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • event – [in] Event.

Returns

Address.

NRF_STATIC_INLINE void nrf_usbd_shorts_enable(NRF_USBD_Type *p_reg, uint32_t mask)

Function for setting shortcuts.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • mask – [in] Shortcut mask.

NRF_STATIC_INLINE void nrf_usbd_shorts_disable(NRF_USBD_Type *p_reg, uint32_t mask)

Function for clearing shortcuts.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • mask – [in] Shortcut mask.

NRF_STATIC_INLINE uint32_t nrf_usbd_shorts_get(NRF_USBD_Type const *p_reg)

Function for getting the shortcut mask.

Function returns shortcut register.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flags of the currently enabled shortcuts.

NRF_STATIC_INLINE void nrf_usbd_int_enable(NRF_USBD_Type *p_reg, uint32_t mask)

Function for enabling the selected interrupts.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • mask – [in] Mask of interrupts to be enabled.

NRF_STATIC_INLINE uint32_t nrf_usbd_int_enable_check(NRF_USBD_Type const *p_reg, uint32_t mask)

Function for checking if the specified interrupts are enabled.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • mask – [in] Mask of interrupts to be checked.

Returns

Mask of enabled interrupts.

NRF_STATIC_INLINE uint32_t nrf_usbd_int_enable_get(NRF_USBD_Type const *p_reg)

Function for retrieving the information about the enabled interrupts.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

The flags of the enabled interrupts.

NRF_STATIC_INLINE void nrf_usbd_int_disable(NRF_USBD_Type *p_reg, uint32_t mask)

Function for disabling the selected interrupts.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • mask – [in] Mask of interrupts to be disabled.

NRF_STATIC_INLINE void nrf_usbd_enable(NRF_USBD_Type *p_reg)

Function for enabling the USBD.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_usbd_disable(NRF_USBD_Type *p_reg)

Function for disabling the USBD.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE uint32_t nrf_usbd_eventcause_get(NRF_USBD_Type const *p_reg)

Function for getting the EVENTCAUSE register.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flag values defined in nrf_usbd_eventcause_mask_t.

NRF_STATIC_INLINE void nrf_usbd_eventcause_clear(NRF_USBD_Type *p_reg, uint32_t flags)

Function for clearing the EVENTCAUSE flags.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • flags – [in] Flags defined in nrf_usbd_eventcause_mask_t.

NRF_STATIC_INLINE uint32_t nrf_usbd_eventcause_get_and_clear(NRF_USBD_Type *p_reg)

Function for getting the EVENTCAUSE register and clearing flags that are set.

The safest way to return current EVENTCAUSE register. All the flags that are returned would be cleared inside EVENTCAUSE register.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flag values defined in nrf_usbd_eventcause_mask_t

NRF_STATIC_INLINE uint32_t nrf_usbd_halted_get(NRF_USBD_Type const *p_reg, uint8_t ep)

Function for getting the HALTEDEPIN register value.

Note

Use this function for the response for GetStatus() request to endpoint. To check whether the endpoint is stalled in the code, use nrf_usbd_ep_is_stall.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint number with IN or OUT flag.

Returns

The value of the HALTEDEPIN or HALTEDOUT register for the selected endpoint.

NRF_STATIC_INLINE bool nrf_usbd_ep_is_stall(NRF_USBD_Type const *p_reg, uint8_t ep)

Function for checking whether the selected endpoint is stalled.

Function to be used as a syntax sweeter for nrf_usbd_halted_get.

Also as the isochronous endpoint cannot be halted - it returns always false if isochronous endpoint is checked.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint number with IN or OUT flag.

Returns true

The endpoint is halted.

Returns false

The endpoint is not halted.

NRF_STATIC_INLINE uint32_t nrf_usbd_epstatus_get(NRF_USBD_Type const *p_reg)

Function for getting EPSTATUS register value.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flag values defined in nrf_usbd_epstatus_mask_t.

NRF_STATIC_INLINE void nrf_usbd_epstatus_clear(NRF_USBD_Type *p_reg, uint32_t flags)

Function for clearing EPSTATUS register value.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • flags – [in] Flags defined in nrf_usbd_epstatus_mask_t.

NRF_STATIC_INLINE uint32_t nrf_usbd_epstatus_get_and_clear(NRF_USBD_Type *p_reg)

Function for getting and clearing EPSTATUS register value.

Function clears all flags in register set before returning its value.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flag values defined in nrf_usbd_epstatus_mask_t.

NRF_STATIC_INLINE uint32_t nrf_usbd_epdatastatus_get(NRF_USBD_Type const *p_reg)

Function for getting DATAEPSTATUS register value.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flag values defined in nrf_usbd_dataepstatus_mask_t.

NRF_STATIC_INLINE void nrf_usbd_epdatastatus_clear(NRF_USBD_Type *p_reg, uint32_t flags)

Function for clearing DATAEPSTATUS register value.

Parameters
NRF_STATIC_INLINE uint32_t nrf_usbd_epdatastatus_get_and_clear(NRF_USBD_Type *p_reg)

Function for getting and clearing DATAEPSTATUS register value.

Function clears all flags in register set before returning its value.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Flag values defined in nrf_usbd_dataepstatus_mask_t.

NRF_STATIC_INLINE size_t nrf_usbd_epout_size_get(NRF_USBD_Type const *p_reg, uint8_t ep)

Function for getting the number of received bytes on the selected endpoint.

Note

This function can be used on bulk, interrupt, and isochronous endpoints.

Note

For the function that returns different value for the ISOOUT zero transfer or no transfer at all, see the nrf_usbd_episoout_size_get function. This function will return 0 for both cases.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier.

Returns

Number of received bytes.

NRF_STATIC_INLINE size_t nrf_usbd_episoout_size_get(NRF_USBD_Type const *p_reg, uint8_t ep)

Function for getting number of the received bytes on isochronous endpoint.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier, must be an isochronous OUT endpoint.

Returns

Number of bytes received or NRF_USBD_EPISOOUT_NO_DATA.

NRF_STATIC_INLINE void nrf_usbd_epout_clear(NRF_USBD_Type *p_reg, uint8_t ep)

Function for clearing OUT endpoint to accept any new incoming traffic.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier. Only OUT interrupt/bulk endpoints are accepted.

NRF_STATIC_INLINE void nrf_usbd_pullup_enable(NRF_USBD_Type *p_reg)

Function for enabling the USB pullup.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_usbd_pullup_disable(NRF_USBD_Type *p_reg)

Function for disabling the USB pullup.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_usbd_pullup_check(NRF_USBD_Type const *p_reg)

Function for returning the current the USB pullup state.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns true

The USB pullup is enabled.

Returns false

The USB pullup is disabled.

NRF_STATIC_INLINE void nrf_usbd_dpdmvalue_set(NRF_USBD_Type *p_reg, nrf_usbd_dpdmvalue_t val)

Function for configuring the value to be forced on the bus on the DRIVEDPDM task.

The selected state will be forced on the bus when NRF_USBD_TASK_DRIVEDPDM is set. The state will be removed from the bus on NRF_USBD_TASK_NODRIVEDPDM and the control will be returned to the USBD peripheral.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • val – [in] State to be set.

NRF_STATIC_INLINE void nrf_usbd_dtoggle_set(NRF_USBD_Type *p_reg, uint8_t ep, nrf_usbd_dtoggle_t op)

Function for setting the data toggle.

Configuration of the current state of data toggling.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint number with the information about its direction.

  • op – [in] Operation to execute.

NRF_STATIC_INLINE nrf_usbd_dtoggle_t nrf_usbd_dtoggle_get(NRF_USBD_Type *p_reg, uint8_t ep)

Function for getting the data toggle.

Get the current state of data toggling.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint number to return the information about current data toggling.

Returns NRF_USBD_DTOGGLE_DATA0

Data toggle is DATA0 on selected endpoint.

Returns NRF_USBD_DTOGGLE_DATA1

Data toggle is DATA1 on selected endpoint.

NRF_STATIC_INLINE bool nrf_usbd_ep_enable_check(NRF_USBD_Type const *p_reg, uint8_t ep)

Function for checking whether the endpoint is enabled.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint ID to be checked.

Returns true

Endpoint is enabled.

Returns false

Endpoint is disabled.

NRF_STATIC_INLINE void nrf_usbd_ep_enable(NRF_USBD_Type *p_reg, uint8_t ep)

Function for enabling the selected endpoint.

The enabled endpoint responds for the tokens on the USB bus.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint ID to be enabled.

NRF_STATIC_INLINE void nrf_usbd_ep_disable(NRF_USBD_Type *p_reg, uint8_t ep)

Function for disabling the selected endpoint.

The disabled endpoint does not respond for the tokens on the USB bus.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint ID to be disabled.

NRF_STATIC_INLINE void nrf_usbd_ep_all_disable(NRF_USBD_Type *p_reg)

Function for disabling all endpoints.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_usbd_ep_default_config(NRF_USBD_Type *p_reg)

Function for setting the default endpoint configuration.

Note

The default configuration means that all endpoints, except for EP0 IN and EP0 OUT, are disabled. Such configuration is used after the USB device reset.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_usbd_ep_stall(NRF_USBD_Type *p_reg, uint8_t ep)

Function for stalling the selected endpoint.

Note

This function cannot be called on isochronous endpoint.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier.

NRF_STATIC_INLINE void nrf_usbd_ep_unstall(NRF_USBD_Type *p_reg, uint8_t ep)

Function for unstalling the selected endpoint.

Note

This function cannot be called on isochronous endpoint.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier

NRF_STATIC_INLINE void nrf_usbd_isosplit_set(NRF_USBD_Type *p_reg, nrf_usbd_isosplit_t split)

Function for configuring the isochronous buffer splitting.

This function configures isochronous buffer splitting between IN and OUT endpoints.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • split – [in] Required configuration.

NRF_STATIC_INLINE nrf_usbd_isosplit_t nrf_usbd_isosplit_get(NRF_USBD_Type const *p_reg)

Function for getting the isochronous buffer splitting configuration.

This function gets the current isochronous buffer splitting configuration.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Current configuration.

NRF_STATIC_INLINE uint32_t nrf_usbd_framecntr_get(NRF_USBD_Type const *p_reg)

Function for getting current frame counter.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Current frame counter.

NRF_STATIC_INLINE void nrf_usbd_lowpower_enable(NRF_USBD_Type *p_reg)

Function for entering into the USB low power mode.

After this function is called, the clock source from the USBD is disconnected internally. After this function is called, most of the USBD registers cannot be accessed anymore.

See

nrf_usbd_lowpower_disable

See

nrf_usbd_lowpower_check

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_usbd_lowpower_disable(NRF_USBD_Type *p_reg)

Function for exiting from the USB low power mode.

After this function is called, the clock source for the USBD is connected internally. The NRF_USBD_EVENTCAUSE_WUREQ_MASK event will be generated and then the USBD registers can be accessed.

See

nrf_usbd_lowpower_enable

See

nrf_usbd_lowpower_check

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_usbd_lowpower_check(NRF_USBD_Type const *p_reg)

Function for checking the state of the low power mode.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns true

The USBD is in low power mode.

Returns false

The USBD is not in low power mode.

NRF_STATIC_INLINE void nrf_usbd_isoinconfig_set(NRF_USBD_Type *p_reg, nrf_usbd_isoinconfig_t config)

Function for configuring ISO IN endpoint response to an IN token when no data is ready to be sent.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • config – [in] Required configuration.

NRF_STATIC_INLINE nrf_usbd_isoinconfig_t nrf_usbd_isoinconfig_get(NRF_USBD_Type const *p_reg)

Function for getting the cofiguration of ISO IN endpoint response to an IN token when no data is ready to be sent.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns

Current configuration.

NRF_STATIC_INLINE void nrf_usbd_ep_easydma_set(NRF_USBD_Type *p_reg, uint8_t ep, uint32_t ptr, uint32_t maxcnt)

Function for configuring the EasyDMA channel.

Configures EasyDMA for the transfer.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier (with direction).

  • ptr – [in] Pointer to the data.

  • maxcnt – [in] Number of bytes to transfer.

NRF_STATIC_INLINE uint32_t nrf_usbd_ep_amount_get(NRF_USBD_Type const *p_reg, uint8_t ep)

Function for getting number of transferred bytes.

This function gets the number of transferred bytes in the last transaction.

Parameters

  • p_reg – [in] Pointer to the structure of registers of the peripheral.

  • ep – [in] Endpoint identifier.

Returns

The content of the AMOUNT register.