USB MSC class

nRF5 SDK v12.3.0
Modules | Data Structures | Macros | Typedefs | Enumerations | Functions

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

Modules

USB MSC descriptors
nRF52840 only: Descriptors for the USB MSC class.
USB MSC class configuration
USB MSC internals
nRF52840 only: Internals of the USB MSC class.
USB MSC SCSI data structures
nRF52840 only: USB MSC SCSI data structures.
USB MSC types
nRF52840 only: Types used in the USB MSC class.

Data Structures

struct app_usbd_msc_t
Mass storage class instance type. More...

Macros

#define APP_USBD_MSC_ENDPOINT_LIST (in_number, out_number)
Helper macro for defining MSC endpoints. More...
#define APP_USBD_MSC_GLOBAL_DEF (instance_name,interface_number,user_ev_handler,endpoint_list,blockdev_list,workbuffer_size)
Global definition of app_usbd_msc_t class. More...

Typedefs

typedef enum
app_usbd_msc_user_event_e 		app_usbd_msc_user_event_t
Events passed to user event handler. More...

Enumerations

enum app_usbd_msc_user_event_e {
APP_USBD_MSC_USER_EVT_SUSPEND = 0,
APP_USBD_MSC_USER_EVT_RESUME ,
APP_USBD_MSC_USER_EVT_START ,
APP_USBD_MSC_USER_EVT_STOP
}
Events passed to user event handler. More...

Functions

static app_usbd_class_inst_t
const * 		app_usbd_msc_class_inst_get ( app_usbd_msc_t const *p_msc)
static app_usbd_msc_t const * app_usbd_msc_class_get ( app_usbd_class_inst_t const *p_inst)
Helper function to get MSC from base class instance. More...

Detailed Description

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

References:

  • "Universal Serial Bus Mass Storage Class, Specification Overview," Revision 1.2, USB Implementer's Forum, June 23, 2003.
  • "Universal Serial Bus Mass Storage Class, Bulk-Only Transport," Revision 1.0, USB Implementer's Forum, September 31, 1999.

Macro Definition Documentation

#define APP_USBD_MSC_ENDPOINT_LIST ( in_number,
out_number
)
Value:
( \
CONCAT_2 ( NRF_DRV_USBD_EPIN , in_number), \
CONCAT_2 ( NRF_DRV_USBD_EPOUT , out_number) \
)

Helper macro for defining MSC endpoints.

Parameters
in_number Input endpoint number
out_number Output endpoint number
#define APP_USBD_MSC_GLOBAL_DEF ( instance_name,
interface_number,
user_ev_handler,
endpoint_list,
blockdev_list,
workbuffer_size
)
Value:
APP_USBD_MSC_GLOBAL_DEF_INTERNAL (instance_name, \
interface_number, \
user_ev_handler, \
endpoint_list, \
blockdev_list, \
workbuffer_size)

Global definition of app_usbd_msc_t class.

Parameters
instance_name Name of global instance
interface_number Unique interface number
user_ev_handler User event handler (optional)
endpoint_list Input endpoint list ( nrf_drv_usbd_ep_t )
blockdev_list Block device list
workbuffer_size Work buffer size (need to fit into all block devices from block device list)
Note
This macro is just simplified version of APP_USBD_MSC_GLOBAL_DEF_INTERNAL

Typedef Documentation

typedef enum app_usbd_msc_user_event_e app_usbd_msc_user_event_t

Events passed to user event handler.

Note
Example prototype of user event handler:

void msc_user_ev_handler( app_usbd_class_inst_t const * p_inst, app_usbd_msc_user_event_t event);

Enumeration Type Documentation

enum app_usbd_msc_user_event_e

Events passed to user event handler.

Note
Example prototype of user event handler:

void msc_user_ev_handler( app_usbd_class_inst_t const * p_inst, app_usbd_msc_user_event_t event);

Enumerator
APP_USBD_MSC_USER_EVT_SUSPEND

User event SUSPEND (bus state notification)

APP_USBD_MSC_USER_EVT_RESUME

User event RESUME (bus state notification)

APP_USBD_MSC_USER_EVT_START

User event START (cable connect)

APP_USBD_MSC_USER_EVT_STOP

User event STOP (cable disconnect)

Function Documentation

static app_usbd_msc_t const* app_usbd_msc_class_get ( app_usbd_class_inst_t const * p_inst )
inline static

Helper function to get MSC from base class instance.

Parameters
[in] p_inst Base class instance
Returns
MSC class handle
static app_usbd_class_inst_t const* app_usbd_msc_class_inst_get ( app_usbd_msc_t const * p_msc )
inline static

@brief Helper function to get class instance from MSC

Parameters
[in] p_msc MSC instance (declared by APP_USBD_MSC_GLOBAL_DEF )
Returns
Base class instance