Sankichi / USBDevice

Modified for PS3 Joystick

Dependents:   NiseKabuto

Fork of USBDevice by Samuel Mokrani

USBMSD/USBMSD.h@1:ac5cca60029a, 2013-07-27 (annotated)

Committer:
sankichi
Date:
Sat Jul 27 14:05:26 2013 +0000
Revision:
1:ac5cca60029a
Parent:
0:140cdf8e2d60 
First Release

Who changed what in which revision?

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