USB Nordic DFU Trigger class

nRF5 SDK v15.0.0
Modules | Data Structures | Macros | Typedefs | Enumerations | Functions

nRF52840 only: Module with types, definitions, and API used by the USB Nordic DFU Trigger class. More...

Modules

USB Nordic DFU Trigger internals
nRF52840 only: Internals of the USB Nordic DFU Trigger class.
USB Nordic DFU Trigger types
nRF52840 only: Types used in the USB Nordic DFU Trigger class.
USBD Nordic DFU Trigger class configuration

Data Structures

struct app_usbd_nrf_dfu_trigger_t
Nordic DFU Trigger class instance type. More...

Macros

#define APP_USBD_NRF_DFU_TRIGGER_GLOBAL_DEF (instance_name,interface_number,p_nordic_dfu,sem_ver_str,user_ev_handler)
Global definition of app_usbd_nrf_dfu_trigger_t class. More...

Typedefs

typedef enum
app_usbd_nrf_dfu_trigger_user_event_e 		app_usbd_nrf_dfu_trigger_user_event_t
Events passed to user event handler. More...

Enumerations

enum app_usbd_nrf_dfu_trigger_user_event_e { APP_USBD_NRF_DFU_TRIGGER_USER_EVT_DETACH }
Events passed to user event handler. More...

Functions

static app_usbd_class_inst_t
const * 		app_usbd_nrf_dfu_trigger_class_inst_get ( app_usbd_nrf_dfu_trigger_t const *p_dfu)
static
app_usbd_nrf_dfu_trigger_t
const * 		app_usbd_nrf_dfu_trigger_class_get ( app_usbd_class_inst_t const *p_inst)
Helper function to get DFU from base class instance. More...

Detailed Description

nRF52840 only: Module with types, definitions, and API used by the USB Nordic DFU Trigger class.

Macro Definition Documentation

#define APP_USBD_NRF_DFU_TRIGGER_GLOBAL_DEF ( instance_name,
interface_number,
p_nordic_dfu,
sem_ver_str,
user_ev_handler
)
Value:
APP_USBD_NRF_DFU_TRIGGER_GLOBAL_DEF_INTERNAL (instance_name, \
interface_number, \
0, \
0, \
p_nordic_dfu, \
sem_ver_str, \
user_ev_handler)

Global definition of app_usbd_nrf_dfu_trigger_t class.

Parameters
instance_name Name of global instance
interface_number Unique interface number
p_nordic_dfu Pointer to app_usbd_nrf_dfu_trigger_nordic_info_t structure
sem_ver_str Semantic version string
user_ev_handler User event handler (optional)
Note
This macro is just simplified version of APP_USBD_NRF_DFU_TRIGGER_GLOBAL_DEF_INTERNAL

Typedef Documentation

typedef enum app_usbd_nrf_dfu_trigger_user_event_e app_usbd_nrf_dfu_trigger_user_event_t

Events passed to user event handler.

Note
Example prototype of user event handler:

void dfu_user_ev_handler( app_usbd_class_inst_t const * p_inst, app_usbd_nrf_dfu_trigger_user_event_t event);

Enumeration Type Documentation

enum app_usbd_nrf_dfu_trigger_user_event_e

Events passed to user event handler.

Note
Example prototype of user event handler:

void dfu_user_ev_handler( app_usbd_class_inst_t const * p_inst, app_usbd_nrf_dfu_trigger_user_event_t event);

Function Documentation

static app_usbd_nrf_dfu_trigger_t const* app_usbd_nrf_dfu_trigger_class_get ( app_usbd_class_inst_t const * p_inst )
inline static

Helper function to get DFU from base class instance.

Parameters
[in] p_inst Base class instance
Returns
DFU class handle
static app_usbd_class_inst_t const* app_usbd_nrf_dfu_trigger_class_inst_get ( app_usbd_nrf_dfu_trigger_t const * p_dfu )
inline static

@brief Helper function to get class instance from Nordic DFU Trigger

Parameters
[in] p_dfu Nordic DFU Trigger instance (declared by APP_USBD_NRF_DFU_TRIGGER_GLOBAL_DEF )
Returns
Base class instance