LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
USBD_MSC_API_T Struct Reference

MSC class API functions structure.This module exposes functions which interact directly with USB device controller hardware. More...

#include "usbd_mscuser.h"

Data Fields

uint32_t(* GetMemSize )(USBD_MSC_INIT_PARAM_T *param)
 
ErrorCode_t(* init )(USBD_HANDLE_T hUsb, USBD_MSC_INIT_PARAM_T *param)
 

Detailed Description

MSC class API functions structure.

This module exposes functions which interact directly with USB device controller hardware.

Definition at line 185 of file usbd_mscuser.h.

Field Documentation

uint32_t GetMemSize

Function to determine the memory required by the MSC function driver module.

This function is called by application layer before calling pUsbApi->msc->Init(), to allocate memory used by MSC function driver module. The application should allocate the memory which is accessible by USB controller/DMA controller.

Note
Some memory areas are not accessible by all bus masters.
Parameters
paramStructure containing HID function driver module initialization parameters.
Returns
Returns the required memory size in bytes.

Definition at line 198 of file usbd_mscuser.h.

Function to initialize MSC function driver module.

This fuction is called by application layer to initialize MSC function driver module.

Parameters
hUsbHandle to the USB device stack.
paramStructure containing HID function driver module initialization parameters.
Returns
Returns ErrorCode_t type to indicate success or error condition.
Return values
LPC_OKOn success
ERR_USBD_BAD_MEM_BUFMemory buffer passed is not 4-byte aligned or smaller than required.
ERR_API_INVALID_PARAM2Either MSC_Write() or MSC_Read() or MSC_Verify() callbacks are not defined.
ERR_USBD_BAD_INTF_DESCWrong interface descriptor is passed.
ERR_USBD_BAD_EP_DESCWrong endpoint descriptor is passed.

Definition at line 216 of file usbd_mscuser.h.


The documentation for this struct was generated from the following file: