Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDED

ME11B Sample Code in Maxim Integrated Team

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Fork of Host_Software_MAX32664GWEB_HR_EXTENDED by Seyhmus Cacina

Drivers/USBDevice/USBMSD/USBMSD.h@0:ac4dea3e2894, 2019-03-18 (annotated)

Committer:
seyhmus.cacina
Date:
Mon Mar 18 10:21:53 2019 +0300
Revision:
0:ac4dea3e2894
ME11B Sample Code First Commit

Who changed what in which revision?

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