Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBMSD/USBMSD.h@14:d495202c90f4, 2013-09-12 (annotated)

Committer:
bogdanm
Date:
Thu Sep 12 14:45:27 2013 +0100
Revision:
14:d495202c90f4
Parent:
11:eeb3cbbaa996
Child:
18:78bdbce94509
Synchronized with git revision b9d52bda50a692c05a4587bcc8d3219997444f58

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:80ab0d068708 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 1:80ab0d068708 2 *
samux 1:80ab0d068708 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:80ab0d068708 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 1:80ab0d068708 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 1:80ab0d068708 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 1:80ab0d068708 7 * Software is furnished to do so, subject to the following conditions:
samux 1:80ab0d068708 8 *
samux 1:80ab0d068708 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:80ab0d068708 10 * substantial portions of the Software.
samux 1:80ab0d068708 11 *
samux 1:80ab0d068708 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:80ab0d068708 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:80ab0d068708 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:80ab0d068708 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:80ab0d068708 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:80ab0d068708 17 */
samux 1:80ab0d068708 18
samux 1:80ab0d068708 19
samux 1:80ab0d068708 20 #ifndef USBMSD_H
samux 1:80ab0d068708 21 #define USBMSD_H
samux 1:80ab0d068708 22
samux 1:80ab0d068708 23 /* These headers are included for child class. */
samux 1:80ab0d068708 24 #include "USBEndpoints.h"
samux 1:80ab0d068708 25 #include "USBDescriptor.h"
samux 1:80ab0d068708 26 #include "USBDevice_Types.h"
samux 1:80ab0d068708 27
samux 1:80ab0d068708 28 #include "USBDevice.h"
samux 1:80ab0d068708 29
samux 1:80ab0d068708 30 /**
samux 1:80ab0d068708 31 * USBMSD class: generic class in order to use all kinds of blocks storage chip
samux 1:80ab0d068708 32 *
samux 1:80ab0d068708 33 * Introduction
samux 1:80ab0d068708 34 *
samux 1:80ab0d068708 35 * The USBMSD implements the MSD protocol. It permits to access a memory chip (flash, sdcard,...)
samux 1:80ab0d068708 36 * from a computer over USB. But this class doesn't work standalone, you need to subclass this class
samux 1:80ab0d068708 37 * and define virtual functions which are called in USBMSD.
samux 1:80ab0d068708 38 *
samux 1:80ab0d068708 39 * How to use this class with your chip ?
samux 1:80ab0d068708 40 *
samux 1:80ab0d068708 41 * You have to inherit and define some pure virtual functions (mandatory step):
samux 1:80ab0d068708 42 * - virtual int disk_read(char * data, int block): function to read a block
samux 1:80ab0d068708 43 * - virtual int disk_write(const char * data, int block): function to write a block
samux 1:80ab0d068708 44 * - virtual int disk_initialize(): function to initialize the memory
samux 1:80ab0d068708 45 * - virtual int disk_sectors(): return the number of blocks
samux 1:80ab0d068708 46 * - virtual int disk_size(): return the memory size
samux 1:80ab0d068708 47 * - virtual int disk_status(): return the status of the storage chip (0: OK, 1: not initialized, 2: no medium in the drive, 4: write protection)
samux 1:80ab0d068708 48 *
samux 1:80ab0d068708 49 * All functions names are compatible with the fat filesystem library. So you can imagine using your own class with
samux 1:80ab0d068708 50 * USBMSD and the fat filesystem library in the same program. Just be careful because there are two different parts which
samux 1:80ab0d068708 51 * will access the sd card. You can do a master/slave system using the disk_status method.
samux 1:80ab0d068708 52 *
samux 1:80ab0d068708 53 * Once these functions defined, you can call connect() (at the end of the constructor of your class for instance)
samux 1:80ab0d068708 54 * of USBMSD to connect your mass storage device. connect() will first call disk_status() to test the status of the disk.
samux 1:80ab0d068708 55 * If disk_status() returns 1 (disk not initialized), then disk_initialize() is called. After this step, connect() will collect information
samux 1:80ab0d068708 56 * such as the number of blocks and the memory size.
samux 1:80ab0d068708 57 */
samux 1:80ab0d068708 58 class USBMSD: public USBDevice {
samux 1:80ab0d068708 59 public:
samux 1:80ab0d068708 60
samux 1:80ab0d068708 61 /**
samux 1:80ab0d068708 62 * Constructor
samux 1:80ab0d068708 63 *
samux 1:80ab0d068708 64 * @param vendor_id Your vendor_id
samux 1:80ab0d068708 65 * @param product_id Your product_id
samux 1:80ab0d068708 66 * @param product_release Your preoduct_release
samux 1:80ab0d068708 67 */
samux 1:80ab0d068708 68 USBMSD(uint16_t vendor_id = 0x0703, uint16_t product_id = 0x0104, uint16_t product_release = 0x0001);
samux 1:80ab0d068708 69
samux 1:80ab0d068708 70 /**
samux 1:80ab0d068708 71 * Connect the USB MSD device. Establish disk initialization before really connect the device.
samux 1:80ab0d068708 72 *
samux 1:80ab0d068708 73 * @returns true if successful
samux 1:80ab0d068708 74 */
samux 1:80ab0d068708 75 bool connect();
samux 1:80ab0d068708 76
bogdanm 14:d495202c90f4 77 /**
bogdanm 14:d495202c90f4 78 * Disconnect the USB MSD device.
bogdanm 14:d495202c90f4 79 */
bogdanm 14:d495202c90f4 80 void disconnect();
bogdanm 14:d495202c90f4 81
bogdanm 14:d495202c90f4 82 /**
bogdanm 14:d495202c90f4 83 * Destructor
bogdanm 14:d495202c90f4 84 */
bogdanm 14:d495202c90f4 85 ~USBMSD();
samux 1:80ab0d068708 86
samux 1:80ab0d068708 87 protected:
samux 1:80ab0d068708 88
samux 1:80ab0d068708 89 /*
samux 1:80ab0d068708 90 * read a block on a storage chip
samux 1:80ab0d068708 91 *
samux 1:80ab0d068708 92 * @param data pointer where will be stored read data
samux 1:80ab0d068708 93 * @param block block number
samux 1:80ab0d068708 94 * @returns 0 if successful
samux 1:80ab0d068708 95 */
samux 7:f8f057664123 96 virtual int disk_read(uint8_t * data, uint64_t block) = 0;
samux 1:80ab0d068708 97
samux 1:80ab0d068708 98 /*
samux 1:80ab0d068708 99 * write a block on a storage chip
samux 1:80ab0d068708 100 *
samux 1:80ab0d068708 101 * @param data data to write
samux 1:80ab0d068708 102 * @param block block number
samux 1:80ab0d068708 103 * @returns 0 if successful
samux 1:80ab0d068708 104 */
samux 7:f8f057664123 105 virtual int disk_write(const uint8_t * data, uint64_t block) = 0;
samux 1:80ab0d068708 106
samux 1:80ab0d068708 107 /*
samux 1:80ab0d068708 108 * Disk initilization
samux 1:80ab0d068708 109 */
samux 1:80ab0d068708 110 virtual int disk_initialize() = 0;
samux 1:80ab0d068708 111
samux 1:80ab0d068708 112 /*
samux 1:80ab0d068708 113 * Return the number of blocks
samux 1:80ab0d068708 114 *
samux 1:80ab0d068708 115 * @returns number of blocks
samux 1:80ab0d068708 116 */
samux 7:f8f057664123 117 virtual uint64_t disk_sectors() = 0;
samux 1:80ab0d068708 118
samux 1:80ab0d068708 119 /*
samux 1:80ab0d068708 120 * Return memory size
samux 1:80ab0d068708 121 *
samux 1:80ab0d068708 122 * @returns memory size
samux 1:80ab0d068708 123 */
samux 7:f8f057664123 124 virtual uint64_t disk_size() = 0;
samux 1:80ab0d068708 125
samux 1:80ab0d068708 126
samux 1:80ab0d068708 127 /*
samux 1:80ab0d068708 128 * To check the status of the storage chip
samux 1:80ab0d068708 129 *
samux 1:80ab0d068708 130 * @returns status: 0: OK, 1: disk not initialized, 2: no medium in the drive, 4: write protected
samux 1:80ab0d068708 131 */
samux 1:80ab0d068708 132 virtual int disk_status() = 0;
samux 1:80ab0d068708 133
samux 1:80ab0d068708 134 /*
samux 1:80ab0d068708 135 * Get string product descriptor
samux 1:80ab0d068708 136 *
samux 1:80ab0d068708 137 * @returns pointer to the string product descriptor
samux 1:80ab0d068708 138 */
samux 1:80ab0d068708 139 virtual uint8_t * stringIproductDesc();
samux 1:80ab0d068708 140
samux 1:80ab0d068708 141 /*
samux 1:80ab0d068708 142 * Get string interface descriptor
samux 1:80ab0d068708 143 *
samux 1:80ab0d068708 144 * @returns pointer to the string interface descriptor
samux 1:80ab0d068708 145 */
samux 1:80ab0d068708 146 virtual uint8_t * stringIinterfaceDesc();
samux 1:80ab0d068708 147
samux 1:80ab0d068708 148 /*
samux 1:80ab0d068708 149 * Get configuration descriptor
samux 1:80ab0d068708 150 *
samux 1:80ab0d068708 151 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 152 */
samux 1:80ab0d068708 153 virtual uint8_t * configurationDesc();
samux 1:80ab0d068708 154
samux 1:80ab0d068708 155 /*
samux 1:80ab0d068708 156 * Callback called when a packet is received
samux 1:80ab0d068708 157 */
samux 1:80ab0d068708 158 virtual bool EP2_OUT_callback();
samux 1:80ab0d068708 159
samux 1:80ab0d068708 160 /*
samux 1:80ab0d068708 161 * Callback called when a packet has been sent
samux 1:80ab0d068708 162 */
samux 1:80ab0d068708 163 virtual bool EP2_IN_callback();
samux 1:80ab0d068708 164
samux 1:80ab0d068708 165 /*
samux 1:80ab0d068708 166 * Set configuration of device. Add endpoints
samux 1:80ab0d068708 167 */
samux 1:80ab0d068708 168 virtual bool USBCallback_setConfiguration(uint8_t configuration);
samux 1:80ab0d068708 169
samux 1:80ab0d068708 170 /*
samux 1:80ab0d068708 171 * Callback called to process class specific requests
samux 1:80ab0d068708 172 */
samux 1:80ab0d068708 173 virtual bool USBCallback_request();
samux 1:80ab0d068708 174
samux 1:80ab0d068708 175
samux 1:80ab0d068708 176 private:
samux 1:80ab0d068708 177
samux 1:80ab0d068708 178 // MSC Bulk-only Stage
samux 1:80ab0d068708 179 enum Stage {
samux 1:80ab0d068708 180 READ_CBW, // wait a CBW
samux 1:80ab0d068708 181 ERROR, // error
samux 1:80ab0d068708 182 PROCESS_CBW, // process a CBW request
samux 1:80ab0d068708 183 SEND_CSW, // send a CSW
samux 1:80ab0d068708 184 WAIT_CSW, // wait that a CSW has been effectively sent
samux 1:80ab0d068708 185 };
samux 1:80ab0d068708 186
samux 1:80ab0d068708 187 // Bulk-only CBW
emilmont 10:1e3d126a322b 188 typedef struct {
samux 1:80ab0d068708 189 uint32_t Signature;
samux 1:80ab0d068708 190 uint32_t Tag;
samux 1:80ab0d068708 191 uint32_t DataLength;
samux 1:80ab0d068708 192 uint8_t Flags;
samux 1:80ab0d068708 193 uint8_t LUN;
samux 1:80ab0d068708 194 uint8_t CBLength;
samux 1:80ab0d068708 195 uint8_t CB[16];
bogdanm 11:eeb3cbbaa996 196 } PACKED CBW;
samux 1:80ab0d068708 197
samux 1:80ab0d068708 198 // Bulk-only CSW
emilmont 10:1e3d126a322b 199 typedef struct {
samux 1:80ab0d068708 200 uint32_t Signature;
samux 1:80ab0d068708 201 uint32_t Tag;
samux 1:80ab0d068708 202 uint32_t DataResidue;
samux 1:80ab0d068708 203 uint8_t Status;
bogdanm 11:eeb3cbbaa996 204 } PACKED CSW;
samux 1:80ab0d068708 205
samux 1:80ab0d068708 206 //state of the bulk-only state machine
samux 1:80ab0d068708 207 Stage stage;
samux 1:80ab0d068708 208
samux 1:80ab0d068708 209 // current CBW
samux 1:80ab0d068708 210 CBW cbw;
samux 1:80ab0d068708 211
samux 1:80ab0d068708 212 // CSW which will be sent
samux 1:80ab0d068708 213 CSW csw;
samux 1:80ab0d068708 214
samux 1:80ab0d068708 215 // addr where will be read or written data
samux 1:80ab0d068708 216 uint32_t addr;
samux 1:80ab0d068708 217
samux 1:80ab0d068708 218 // length of a reading or writing
samux 1:80ab0d068708 219 uint32_t length;
samux 1:80ab0d068708 220
samux 1:80ab0d068708 221 // memory OK (after a memoryVerify)
samux 1:80ab0d068708 222 bool memOK;
samux 1:80ab0d068708 223
samux 1:80ab0d068708 224 // cache in RAM before writing in memory. Useful also to read a block.
samux 1:80ab0d068708 225 uint8_t * page;
samux 1:80ab0d068708 226
samux 1:80ab0d068708 227 int BlockSize;
samux 7:f8f057664123 228 uint64_t MemorySize;
samux 7:f8f057664123 229 uint64_t BlockCount;
samux 1:80ab0d068708 230
samux 1:80ab0d068708 231 void CBWDecode(uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 232 void sendCSW (void);
samux 1:80ab0d068708 233 bool inquiryRequest (void);
samux 1:80ab0d068708 234 bool write (uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 235 bool readFormatCapacity();
samux 1:80ab0d068708 236 bool readCapacity (void);
samux 1:80ab0d068708 237 bool infoTransfer (void);
samux 1:80ab0d068708 238 void memoryRead (void);
samux 1:80ab0d068708 239 bool modeSense6 (void);
samux 1:80ab0d068708 240 void testUnitReady (void);
samux 1:80ab0d068708 241 bool requestSense (void);
samux 1:80ab0d068708 242 void memoryVerify (uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 243 void memoryWrite (uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 244 void reset();
samux 1:80ab0d068708 245 void fail();
samux 1:80ab0d068708 246 };
samux 1:80ab0d068708 247
samux 8:335f2506f422 248 #endif