Maxim nexpaq / nexpaq_dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

libraries/USBDevice/USBMSD/USBMSD.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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