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

Mass Storage class function driver initilization parameter data structure. More...

#include "usbd_mscuser.h"

Data Fields

uint32_t mem_base
 
uint32_t mem_size
 
uint8_t * InquiryStr
 
uint32_t BlockCount
 
uint32_t BlockSize
 
uint32_t MemorySize
 
uint8_t * intf_desc
 
void(* MSC_Write )(uint32_t offset, uint8_t **src, uint32_t length)
 
void(* MSC_Read )(uint32_t offset, uint8_t **dst, uint32_t length)
 
ErrorCode_t(* MSC_Verify )(uint32_t offset, uint8_t buf[], uint32_t length)
 
void(* MSC_GetWriteBuf )(uint32_t offset, uint8_t **buff_adr, uint32_t length)
 
ErrorCode_t(* MSC_Ep0_Hdlr )(USBD_HANDLE_T hUsb, void *data, uint32_t event)
 

Detailed Description

Mass Storage class function driver initilization parameter data structure.

This data structure is used to pass initialization parameters to the Mass Storage class function driver's init function.

Definition at line 59 of file usbd_mscuser.h.

Field Documentation

uint32_t BlockCount

Number of blocks present in the mass storage device

Definition at line 75 of file usbd_mscuser.h.

uint32_t BlockSize

Block size in number of bytes

Definition at line 76 of file usbd_mscuser.h.

uint8_t* InquiryStr

Pointer to the 28 character string. This string is sent in response to the SCSI Inquiry command.

Note
The data pointed by the pointer should be of global scope.

Definition at line 71 of file usbd_mscuser.h.

uint8_t* intf_desc

Pointer to the interface descriptor within the descriptor array (high_speed_desc) passed to Init() through USB_CORE_DESCS_T structure. The stack assumes both HS and FS use same BULK endpoints.

Definition at line 82 of file usbd_mscuser.h.

uint32_t mem_base

Base memory location from where the stack can allocate data and buffers.

Note
The memory address set in this field should be accessible by USB DMA controller. Also this value should be aligned on 4 byte boundary.

Definition at line 62 of file usbd_mscuser.h.

uint32_t mem_size

The size of memory buffer which stack can use.

Note
The mem_size should be greater than the size returned by USBD_MSC_API::GetMemSize() routine.

Definition at line 67 of file usbd_mscuser.h.

uint32_t MemorySize

Memory size in number of bytes

Definition at line 77 of file usbd_mscuser.h.

ErrorCode_t(* MSC_Ep0_Hdlr)(USBD_HANDLE_T hUsb, void *data, uint32_t event)

Optional user overridable function to replace the default MSC class handler.

The application software could override the default EP0 class handler with their own by providing the handler function address as this data member of the parameter structure. Application which like the default handler should set this data member to zero before calling the USBD_MSC_API::Init().

Note
Parameters
hUsbHandle to the USB device stack.
dataPointer to the data which will be passed when callback function is called by the stack.
eventType of endpoint event. See USBD_EVENT_T for more details.
Returns
The call back should returns ErrorCode_t type to indicate success or error condition.
Return values
LPC_OKOn success.
ERR_USBD_UNHANDLEDEvent is not handled hence pass the event to next in line.
ERR_USBD_xxxFor other error conditions.

Definition at line 175 of file usbd_mscuser.h.

void(* MSC_GetWriteBuf)(uint32_t offset, uint8_t **buff_adr, uint32_t length)

Optional callback function to optimize MSC_Write buffer transfer.

This function is provided by the application software. This function gets called when host sends SCSI_WRITE10/SCSI_WRITE12 command. The callback function should update the buff_adr pointer so that the stack transfers the data directly to the target buffer. /note The updated buffer address should be accessable by USB DMA master. If user doesn't want to use zero-copy model, then the user should not update the buffer pointer. See USBD_ZeroCopy for more details on zero-copy concept.

Parameters
offsetDestination start address.
[in,out]bufBuffer containing the data sent by the host.
lengthNumber of bytes to write.
Returns
Nothing.

Definition at line 154 of file usbd_mscuser.h.

void(* MSC_Read)(uint32_t offset, uint8_t **dst, uint32_t length)

MSC Read callback function.

This function is provided by the application software. This function gets called when host sends a read command.

Parameters
offsetSource start address.
dstPointer to a pointer to the source of data. The MSC function drivers implemented in stack are written with zero-copy model. Meaning the stack doesn't make an extra copy of buffer before writing/reading data from USB hardware FIFO. Hence the parameter is pointer to a pointer containing address buffer (uint8_t** dst). So that the user application can update the buffer pointer instead of copying data to address pointed by the parameter. /note The updated buffer address should be accessable by USB DMA master. If user doesn't want to use zero-copy model, then the user should copy data to the address pointed by the passed buffer pointer parameter and shouldn't change the address value. See USBD_ZeroCopy for more details on zero-copy concept.
lengthNumber of bytes to be read.
Returns
Nothing.

Definition at line 120 of file usbd_mscuser.h.

ErrorCode_t(* MSC_Verify)(uint32_t offset, uint8_t buf[], uint32_t length)

MSC Verify callback function.

This function is provided by the application software. This function gets called when host sends a verify command. The callback function should compare the buffer with the destination memory at the requested offset and

Parameters
offsetDestination start address.
bufBuffer containing the data sent by the host.
lengthNumber of bytes to verify.
Returns
Returns ErrorCode_t type to indicate success or error condition.
Return values
LPC_OKIf data in the buffer matches the data at destination
ERR_FAILEDAtleast one byte is different.

Definition at line 136 of file usbd_mscuser.h.

void(* MSC_Write)(uint32_t offset, uint8_t **src, uint32_t length)

MSC Write callback function.

This function is provided by the application software. This function gets called when host sends a write command.

Parameters
offsetDestination start address.
srcPointer to a pointer to the source of data. Pointer-to-pointer is used to implement zero-copy buffers. See USBD_ZeroCopy for more details on zero-copy concept.
lengthNumber of bytes to be written.
Returns
Nothing.

Definition at line 99 of file usbd_mscuser.h.


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