USB Device high level library variable types definition

nRF5 SDK v12.3.0

nRF52840 only: All types used by USB Device high level library are defined here. This helps to avoid cross referencing into types in different files. More...

Files

file app_usbd_class_base.h
Base instance of a USBD class.

Data Structures

struct app_usbd_evt_t
Specific application event structure. More...
struct app_usbd_setup_evt_t
Specific application event structure with setup structure included. More...
union app_usbd_complex_evt_t
Complex event variable type. More...
struct app_usbd_class_inst_t

Typedefs

typedef ret_code_t (* app_usbd_ep_event_handler_t )( app_usbd_class_inst_t const *const p_inst, app_usbd_complex_evt_t const *const p_event)
Endpoint callback function. More...

Enumerations

enum app_usbd_event_type_t {
APP_USBD_EVT_DRV_SOF = NRF_DRV_USBD_EVT_SOF,
APP_USBD_EVT_DRV_RESET = NRF_DRV_USBD_EVT_RESET,
APP_USBD_EVT_DRV_SUSPEND = NRF_DRV_USBD_EVT_SUSPEND,
APP_USBD_EVT_DRV_RESUME = NRF_DRV_USBD_EVT_RESUME,
APP_USBD_EVT_DRV_SETUP = NRF_DRV_USBD_EVT_SETUP,
APP_USBD_EVT_DRV_EPTRANSFER = NRF_DRV_USBD_EVT_EPTRANSFER,
APP_USBD_EVT_FIRST_APP ,
APP_USBD_EVT_INST_APPEND = APP_USBD_EVT_FIRST_APP,
APP_USBD_EVT_INST_REMOVE ,
APP_USBD_EVT_START ,
APP_USBD_EVT_STOP ,
APP_USBD_EVT_STATE
}
Events codes. More...

Detailed Description

nRF52840 only: All types used by USB Device high level library are defined here. This helps to avoid cross referencing into types in different files.

Typedef Documentation

typedef ret_code_t (* app_usbd_ep_event_handler_t)( app_usbd_class_inst_t const *const p_inst, app_usbd_complex_evt_t const *const p_event)

Endpoint callback function.

The function used by every class instance.

Parameters
[in,out] p_inst Instance of the class
[in] p_event Event to process
Note
If given event is not supported by class, return NRF_ERROR_NOT_SUPPORTED

Enumeration Type Documentation

Events codes.

Redefined application event codes

Enumerator
APP_USBD_EVT_DRV_SOF

See documentation for NRF_DRV_USBD_EVT_SOF

APP_USBD_EVT_DRV_RESET

See documentation for NRF_DRV_USBD_EVT_RESET

APP_USBD_EVT_DRV_SUSPEND

See documentation for NRF_DRV_USBD_EVT_SUSPEND

APP_USBD_EVT_DRV_RESUME

See documentation for NRF_DRV_USBD_EVT_RESUME

APP_USBD_EVT_DRV_SETUP

This event type has special structure. See app_usbd_setup_evt_t

APP_USBD_EVT_DRV_EPTRANSFER

See documentation for NRF_DRV_USBD_EVT_EPTRANSFER

APP_USBD_EVT_FIRST_APP

First application event code - for internal static assert checking

APP_USBD_EVT_INST_APPEND

The instance was attached to the library, any configuration action can be done now

APP_USBD_EVT_INST_REMOVE
      The instance is going to be removed, this event is called just before removing the instance.

This removing cannot be stopped.

APP_USBD_EVT_START

USBD library has just been started and functional - event passed to all instances, before USBD interrupts have been enabled

APP_USBD_EVT_STOP

USBD library has just been stopped and is not functional - event passed to all instances, after USBD interrupts have been disabled

APP_USBD_EVT_STATE

USBD state has been changed