Geir Inge Tellnes / STM32_USBDevice

Fork of https://developer.mbed.org/users/bscott/code/STM32_USBDevice/

Fork of STM32_USBDevice by Bradley Scott

USBDevice/USBDevice.h@76:eef92651f52f, 2018-07-19 (annotated)

Committer:
Troels Nilsson
Date:
Thu Jul 19 12:57:27 2018 +0200
Branch:
feature_WebUSB
Revision:
76:eef92651f52f
Parent:
25:7c72828865f3 
Added USBWebUSBSerial class



The class implements a composite device with CDC and a WebUSB compatible interface



Data is read and written from either the CDC or the WebUSB interface depending on the mode.

Default mode is CDC - it can be changed to WebUSB by sending a control message from the host.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 2:34856a6adb5b 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 2:34856a6adb5b 2 *
samux 2:34856a6adb5b 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 2:34856a6adb5b 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 2:34856a6adb5b 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 2:34856a6adb5b 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 2:34856a6adb5b 7 * Software is furnished to do so, subject to the following conditions:
samux 2:34856a6adb5b 8 *
samux 2:34856a6adb5b 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 2:34856a6adb5b 10 * substantial portions of the Software.
samux 2:34856a6adb5b 11 *
samux 2:34856a6adb5b 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 2:34856a6adb5b 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 2:34856a6adb5b 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 2:34856a6adb5b 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 2:34856a6adb5b 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 2:34856a6adb5b 17 */
samux 2:34856a6adb5b 18
samux 2:34856a6adb5b 19 #ifndef USBDEVICE_H
samux 2:34856a6adb5b 20 #define USBDEVICE_H
samux 2:34856a6adb5b 21
samux 2:34856a6adb5b 22 #include "mbed.h"
samux 2:34856a6adb5b 23 #include "USBDevice_Types.h"
samux 2:34856a6adb5b 24 #include "USBHAL.h"
samux 2:34856a6adb5b 25
samux 2:34856a6adb5b 26 class USBDevice: public USBHAL
samux 2:34856a6adb5b 27 {
samux 2:34856a6adb5b 28 public:
samux 2:34856a6adb5b 29 USBDevice(uint16_t vendor_id, uint16_t product_id, uint16_t product_release);
mbed_official 25:7c72828865f3 30
samux 2:34856a6adb5b 31 /*
samux 2:34856a6adb5b 32 * Check if the device is configured
samux 2:34856a6adb5b 33 *
samux 2:34856a6adb5b 34 * @returns true if configured, false otherwise
samux 2:34856a6adb5b 35 */
samux 2:34856a6adb5b 36 bool configured(void);
mbed_official 25:7c72828865f3 37
samux 2:34856a6adb5b 38 /*
samux 2:34856a6adb5b 39 * Connect a device
mbed_official 25:7c72828865f3 40 *
mbed_official 18:78bdbce94509 41 * @param blocking: block if not configured
samux 2:34856a6adb5b 42 */
mbed_official 18:78bdbce94509 43 void connect(bool blocking = true);
mbed_official 25:7c72828865f3 44
samux 2:34856a6adb5b 45 /*
samux 2:34856a6adb5b 46 * Disconnect a device
samux 2:34856a6adb5b 47 */
samux 2:34856a6adb5b 48 void disconnect(void);
mbed_official 25:7c72828865f3 49
samux 2:34856a6adb5b 50 /*
samux 2:34856a6adb5b 51 * Add an endpoint
samux 2:34856a6adb5b 52 *
samux 2:34856a6adb5b 53 * @param endpoint endpoint which will be added
samux 2:34856a6adb5b 54 * @param maxPacket Maximum size of a packet which can be sent for this endpoint
samux 2:34856a6adb5b 55 * @returns true if successful, false otherwise
samux 2:34856a6adb5b 56 */
samux 2:34856a6adb5b 57 bool addEndpoint(uint8_t endpoint, uint32_t maxPacket);
samux 2:34856a6adb5b 58
samux 2:34856a6adb5b 59 /*
samux 2:34856a6adb5b 60 * Start a reading on a certain endpoint.
samux 2:34856a6adb5b 61 * You can access the result of the reading by USBDevice_read
samux 2:34856a6adb5b 62 *
samux 2:34856a6adb5b 63 * @param endpoint endpoint which will be read
samux 2:34856a6adb5b 64 * @param maxSize the maximum length that can be read
samux 2:34856a6adb5b 65 * @return true if successful
samux 2:34856a6adb5b 66 */
samux 2:34856a6adb5b 67 bool readStart(uint8_t endpoint, uint32_t maxSize);
mbed_official 25:7c72828865f3 68
samux 2:34856a6adb5b 69 /*
samux 2:34856a6adb5b 70 * Read a certain endpoint. Before calling this function, USBUSBDevice_readStart
samux 2:34856a6adb5b 71 * must be called.
samux 2:34856a6adb5b 72 *
samux 2:34856a6adb5b 73 * Warning: blocking
samux 2:34856a6adb5b 74 *
samux 2:34856a6adb5b 75 * @param endpoint endpoint which will be read
samux 2:34856a6adb5b 76 * @param buffer buffer will be filled with the data received
samux 2:34856a6adb5b 77 * @param size the number of bytes read will be stored in *size
samux 2:34856a6adb5b 78 * @param maxSize the maximum length that can be read
samux 2:34856a6adb5b 79 * @returns true if successful
samux 2:34856a6adb5b 80 */
samux 2:34856a6adb5b 81 bool readEP(uint8_t endpoint, uint8_t * buffer, uint32_t * size, uint32_t maxSize);
mbed_official 25:7c72828865f3 82
samux 2:34856a6adb5b 83 /*
samux 2:34856a6adb5b 84 * Read a certain endpoint.
samux 2:34856a6adb5b 85 *
samux 2:34856a6adb5b 86 * Warning: non blocking
samux 2:34856a6adb5b 87 *
samux 2:34856a6adb5b 88 * @param endpoint endpoint which will be read
mbed_official 25:7c72828865f3 89 * @param buffer buffer will be filled with the data received (if data are available)
samux 2:34856a6adb5b 90 * @param size the number of bytes read will be stored in *size
samux 2:34856a6adb5b 91 * @param maxSize the maximum length that can be read
samux 2:34856a6adb5b 92 * @returns true if successful
samux 2:34856a6adb5b 93 */
samux 2:34856a6adb5b 94 bool readEP_NB(uint8_t endpoint, uint8_t * buffer, uint32_t * size, uint32_t maxSize);
mbed_official 25:7c72828865f3 95
samux 2:34856a6adb5b 96 /*
samux 2:34856a6adb5b 97 * Write a certain endpoint.
samux 2:34856a6adb5b 98 *
samux 2:34856a6adb5b 99 * Warning: blocking
samux 2:34856a6adb5b 100 *
samux 2:34856a6adb5b 101 * @param endpoint endpoint to write
samux 2:34856a6adb5b 102 * @param buffer data contained in buffer will be write
samux 2:34856a6adb5b 103 * @param size the number of bytes to write
samux 2:34856a6adb5b 104 * @param maxSize the maximum length that can be written on this endpoint
samux 2:34856a6adb5b 105 */
Troels Nilsson 76:eef92651f52f 106 bool write(uint8_t endpoint, const uint8_t * buffer, uint32_t size, uint32_t maxSize);
mbed_official 25:7c72828865f3 107
mbed_official 25:7c72828865f3 108
samux 2:34856a6adb5b 109 /*
samux 2:34856a6adb5b 110 * Write a certain endpoint.
samux 2:34856a6adb5b 111 *
samux 2:34856a6adb5b 112 * Warning: non blocking
samux 2:34856a6adb5b 113 *
samux 2:34856a6adb5b 114 * @param endpoint endpoint to write
samux 2:34856a6adb5b 115 * @param buffer data contained in buffer will be write
samux 2:34856a6adb5b 116 * @param size the number of bytes to write
samux 2:34856a6adb5b 117 * @param maxSize the maximum length that can be written on this endpoint
samux 2:34856a6adb5b 118 */
Troels Nilsson 76:eef92651f52f 119 bool writeNB(uint8_t endpoint, const uint8_t * buffer, uint32_t size, uint32_t maxSize);
samux 2:34856a6adb5b 120
mbed_official 25:7c72828865f3 121
samux 2:34856a6adb5b 122 /*
samux 2:34856a6adb5b 123 * Called by USBDevice layer on bus reset. Warning: Called in ISR context
samux 2:34856a6adb5b 124 *
samux 2:34856a6adb5b 125 * May be used to reset state
samux 2:34856a6adb5b 126 */
samux 2:34856a6adb5b 127 virtual void USBCallback_busReset(void) {};
mbed_official 25:7c72828865f3 128
samux 2:34856a6adb5b 129 /*
samux 2:34856a6adb5b 130 * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context
samux 2:34856a6adb5b 131 * This is used to handle extensions to standard requests
samux 2:34856a6adb5b 132 * and class specific requests
samux 2:34856a6adb5b 133 *
samux 2:34856a6adb5b 134 * @returns true if class handles this request
samux 2:34856a6adb5b 135 */
mbed_official 25:7c72828865f3 136 virtual bool USBCallback_request() { return false; };
mbed_official 25:7c72828865f3 137
samux 2:34856a6adb5b 138 /*
samux 2:34856a6adb5b 139 * Called by USBDevice on Endpoint0 request completion
samux 2:34856a6adb5b 140 * if the 'notify' flag has been set to true. Warning: Called in ISR context
samux 2:34856a6adb5b 141 *
samux 2:34856a6adb5b 142 * In this case it is used to indicate that a HID report has
samux 2:34856a6adb5b 143 * been received from the host on endpoint 0
samux 2:34856a6adb5b 144 *
samux 2:34856a6adb5b 145 * @param buf buffer received on endpoint 0
samux 2:34856a6adb5b 146 * @param length length of this buffer
samux 2:34856a6adb5b 147 */
samux 2:34856a6adb5b 148 virtual void USBCallback_requestCompleted(uint8_t * buf, uint32_t length) {};
mbed_official 25:7c72828865f3 149
samux 2:34856a6adb5b 150 /*
samux 2:34856a6adb5b 151 * Called by USBDevice layer. Set configuration of the device.
samux 2:34856a6adb5b 152 * For instance, you can add all endpoints that you need on this function.
samux 2:34856a6adb5b 153 *
samux 2:34856a6adb5b 154 * @param configuration Number of the configuration
samux 2:34856a6adb5b 155 */
samux 2:34856a6adb5b 156 virtual bool USBCallback_setConfiguration(uint8_t configuration) { return false; };
mbed_official 25:7c72828865f3 157
samux 2:34856a6adb5b 158 /*
samux 2:34856a6adb5b 159 * Called by USBDevice layer. Set interface/alternate of the device.
samux 2:34856a6adb5b 160 *
samux 2:34856a6adb5b 161 * @param interface Number of the interface to be configured
samux 2:34856a6adb5b 162 * @param alternate Number of the alternate to be configured
samux 2:34856a6adb5b 163 * @returns true if class handles this request
samux 2:34856a6adb5b 164 */
samux 2:34856a6adb5b 165 virtual bool USBCallback_setInterface(uint16_t interface, uint8_t alternate) { return false; };
samux 2:34856a6adb5b 166
samux 2:34856a6adb5b 167 /*
samux 2:34856a6adb5b 168 * Get device descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
samux 2:34856a6adb5b 169 *
samux 2:34856a6adb5b 170 * @returns pointer to the device descriptor
samux 2:34856a6adb5b 171 */
samux 2:34856a6adb5b 172 virtual uint8_t * deviceDesc();
mbed_official 25:7c72828865f3 173
samux 2:34856a6adb5b 174 /*
samux 2:34856a6adb5b 175 * Get configuration descriptor
samux 2:34856a6adb5b 176 *
samux 2:34856a6adb5b 177 * @returns pointer to the configuration descriptor
samux 2:34856a6adb5b 178 */
samux 2:34856a6adb5b 179 virtual uint8_t * configurationDesc(){return NULL;};
mbed_official 25:7c72828865f3 180
samux 2:34856a6adb5b 181 /*
Troels Nilsson 76:eef92651f52f 182 * Get BOS descriptor
Troels Nilsson 76:eef92651f52f 183 *
Troels Nilsson 76:eef92651f52f 184 * @returns pointer to the BOS descriptor
Troels Nilsson 76:eef92651f52f 185 */
Troels Nilsson 76:eef92651f52f 186 virtual uint8_t * bosDesc() { return nullptr; }
Troels Nilsson 76:eef92651f52f 187
Troels Nilsson 76:eef92651f52f 188 /*
samux 2:34856a6adb5b 189 * Get string lang id descriptor
samux 2:34856a6adb5b 190 *
samux 2:34856a6adb5b 191 * @return pointer to the string lang id descriptor
samux 2:34856a6adb5b 192 */
samux 2:34856a6adb5b 193 virtual uint8_t * stringLangidDesc();
mbed_official 25:7c72828865f3 194
samux 2:34856a6adb5b 195 /*
samux 2:34856a6adb5b 196 * Get string manufacturer descriptor
samux 2:34856a6adb5b 197 *
samux 2:34856a6adb5b 198 * @returns pointer to the string manufacturer descriptor
samux 2:34856a6adb5b 199 */
samux 2:34856a6adb5b 200 virtual uint8_t * stringImanufacturerDesc();
mbed_official 25:7c72828865f3 201
samux 2:34856a6adb5b 202 /*
samux 2:34856a6adb5b 203 * Get string product descriptor
samux 2:34856a6adb5b 204 *
samux 2:34856a6adb5b 205 * @returns pointer to the string product descriptor
samux 2:34856a6adb5b 206 */
samux 2:34856a6adb5b 207 virtual uint8_t * stringIproductDesc();
mbed_official 25:7c72828865f3 208
samux 2:34856a6adb5b 209 /*
samux 2:34856a6adb5b 210 * Get string serial descriptor
samux 2:34856a6adb5b 211 *
samux 2:34856a6adb5b 212 * @returns pointer to the string serial descriptor
samux 2:34856a6adb5b 213 */
samux 2:34856a6adb5b 214 virtual uint8_t * stringIserialDesc();
mbed_official 25:7c72828865f3 215
samux 2:34856a6adb5b 216 /*
samux 2:34856a6adb5b 217 * Get string configuration descriptor
samux 2:34856a6adb5b 218 *
samux 2:34856a6adb5b 219 * @returns pointer to the string configuration descriptor
samux 2:34856a6adb5b 220 */
samux 2:34856a6adb5b 221 virtual uint8_t * stringIConfigurationDesc();
mbed_official 25:7c72828865f3 222
samux 2:34856a6adb5b 223 /*
samux 2:34856a6adb5b 224 * Get string interface descriptor
samux 2:34856a6adb5b 225 *
samux 2:34856a6adb5b 226 * @returns pointer to the string interface descriptor
samux 2:34856a6adb5b 227 */
samux 2:34856a6adb5b 228 virtual uint8_t * stringIinterfaceDesc();
mbed_official 25:7c72828865f3 229
samux 2:34856a6adb5b 230 /*
samux 2:34856a6adb5b 231 * Get the length of the report descriptor
samux 2:34856a6adb5b 232 *
samux 2:34856a6adb5b 233 * @returns length of the report descriptor
samux 2:34856a6adb5b 234 */
samux 2:34856a6adb5b 235 virtual uint16_t reportDescLength() { return 0; };
mbed_official 25:7c72828865f3 236
samux 2:34856a6adb5b 237
samux 2:34856a6adb5b 238
samux 2:34856a6adb5b 239 protected:
samux 2:34856a6adb5b 240 virtual void busReset(void);
samux 2:34856a6adb5b 241 virtual void EP0setupCallback(void);
samux 2:34856a6adb5b 242 virtual void EP0out(void);
samux 2:34856a6adb5b 243 virtual void EP0in(void);
samux 2:34856a6adb5b 244 virtual void connectStateChanged(unsigned int connected);
samux 2:34856a6adb5b 245 virtual void suspendStateChanged(unsigned int suspended);
samux 2:34856a6adb5b 246 uint8_t * findDescriptor(uint8_t descriptorType);
samux 2:34856a6adb5b 247 CONTROL_TRANSFER * getTransferPtr(void);
mbed_official 25:7c72828865f3 248
samux 2:34856a6adb5b 249 uint16_t VENDOR_ID;
samux 2:34856a6adb5b 250 uint16_t PRODUCT_ID;
samux 2:34856a6adb5b 251 uint16_t PRODUCT_RELEASE;
samux 2:34856a6adb5b 252
samux 2:34856a6adb5b 253 private:
samux 2:34856a6adb5b 254 bool addRateFeedbackEndpoint(uint8_t endpoint, uint32_t maxPacket);
samux 2:34856a6adb5b 255 bool requestGetDescriptor(void);
samux 2:34856a6adb5b 256 bool controlOut(void);
samux 2:34856a6adb5b 257 bool controlIn(void);
samux 2:34856a6adb5b 258 bool requestSetAddress(void);
samux 2:34856a6adb5b 259 bool requestSetConfiguration(void);
samux 2:34856a6adb5b 260 bool requestSetFeature(void);
samux 2:34856a6adb5b 261 bool requestClearFeature(void);
samux 2:34856a6adb5b 262 bool requestGetStatus(void);
samux 2:34856a6adb5b 263 bool requestSetup(void);
samux 2:34856a6adb5b 264 bool controlSetup(void);
samux 2:34856a6adb5b 265 void decodeSetupPacket(uint8_t *data, SETUP_PACKET *packet);
samux 2:34856a6adb5b 266 bool requestGetConfiguration(void);
samux 2:34856a6adb5b 267 bool requestGetInterface(void);
samux 2:34856a6adb5b 268 bool requestSetInterface(void);
samux 2:34856a6adb5b 269
samux 2:34856a6adb5b 270 CONTROL_TRANSFER transfer;
samux 2:34856a6adb5b 271 USB_DEVICE device;
mbed_official 25:7c72828865f3 272
samux 2:34856a6adb5b 273 uint16_t currentInterface;
samux 2:34856a6adb5b 274 uint8_t currentAlternate;
samux 2:34856a6adb5b 275 };
samux 2:34856a6adb5b 276
samux 2:34856a6adb5b 277
samux 2:34856a6adb5b 278 #endif