| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
MassStorageClassDevice.h
Go to the documentation of this file.
1 /*
2 * @brief Device mode driver for the library USB Mass Storage Class driver
3 *
4 * @note
5 * Copyright(C) NXP Semiconductors, 2012
6 * Copyright(C) Dean Camera, 2011, 2012
7 * All rights reserved.
8 *
9 * @par
10 * Software that is described herein is for illustrative purposes only
11 * which provides customers with programming information regarding the
12 * LPC products. This software is supplied "AS IS" without any warranties of
13 * any kind, and NXP Semiconductors and its licensor disclaim any and
14 * all warranties, express or implied, including all implied warranties of
15 * merchantability, fitness for a particular purpose and non-infringement of
16 * intellectual property rights. NXP Semiconductors assumes no responsibility
17 * or liability for the use of the software, conveys no license or rights under any
18 * patent, copyright, mask work right, or any other intellectual property rights in
19 * or to any products. NXP Semiconductors reserves the right to make changes
20 * in the software without notification. NXP Semiconductors also makes no
21 * representation or warranty that such application will be suitable for the
22 * specified use without further testing or modification.
23 *
24 * @par
25 * Permission to use, copy, modify, and distribute this software and its
26 * documentation is hereby granted, under NXP Semiconductors' and its
27 * licensor's relevant copyrights in the software, without fee, provided that it
28 * is used in conjunction with NXP Semiconductors microcontrollers. This
29 * copyright, permission, and disclaimer notice must appear in all copies of
30 * this code.
31 */
32
46 #ifndef _MS_CLASS_DEVICE_H_
47 #define _MS_CLASS_DEVICE_H_
48
49 /* Includes: */
50 #include "../../USB.h"
51 #include "../Common/MassStorageClassCommon.h"
52
53 /* Enable C linkage for C++ Compilers: */
54 #if defined(__cplusplus)
55 extern "C" {
56 #endif
57
58 /* Preprocessor Checks: */
59 #if !defined(__INCLUDE_FROM_MS_DRIVER)
60 #error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.
61 #endif
62
63 /* Public Interface - May be used in end-application: */
64 /* Type Defines: */
72 typedef struct {
73 const struct {
74 uint8_t InterfaceNumber;
76 uint8_t DataINEndpointNumber;
77 uint16_t DataINEndpointSize;
78 bool DataINEndpointDoubleBank;
80 uint8_t DataOUTEndpointNumber;
81 uint16_t DataOUTEndpointSize;
82 bool DataOUTEndpointDoubleBank;
84 uint8_t TotalLUNs;
85 uint8_t PortNumber;
86 } Config;
90 struct {
91 MS_CommandBlockWrapper_t CommandBlock;
94 MS_CommandStatusWrapper_t CommandStatus;
97 volatile bool IsMassStoreReset;
100 } State;
104 } USB_ClassInfo_MS_Device_t;
105
106 /* Function Prototypes: */
116 bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
117
125 void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
126
134 void MS_Device_USBTask(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
135
146 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
147
148 /* Private Interface - For use in library only: */
149 #if !defined(__DOXYGEN__)
150 /* Function Prototypes: */
151 #if defined(__INCLUDE_FROM_MASSSTORAGE_DEVICE_C)
152 static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
153
154 static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
155
156 #endif
157
158 #endif
159
160 /* Disable C linkage for C++ Compilers: */
161 #if defined(__cplusplus)
162 }
163 #endif
164
165 #endif
166