Patrick Pollet / USBDevice

usb device

USBDevice/USBDevice.h@0:c1e89c49eae5, 2022-05-14 (annotated)

Committer:
ppo
Date:
Sat May 14 17:24:10 2022 +0000
Revision:
0:c1e89c49eae5
commit

Who changed what in which revision?

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