Fred Parker / Mbed 2 deprecated Official_mBot

The preloaded firmware shipped on the mBot.

Dependencies:   mbed

Please use the version of this project/repo found at: http://developer.mbed.org/teams/Outrageous-Circuits/code/Official_mBot/

USBDevice/USBHID/USBHID.h@1:ffd9a51e7d35, 2014-11-25 (annotated)

Committer:
jeffknaggs
Date:
Tue Nov 25 14:49:40 2014 +0000
Revision:
1:ffd9a51e7d35
Parent:
0:865d42c46692 
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jeffknaggs 0:865d42c46692 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
jeffknaggs 0:865d42c46692 2 *
jeffknaggs 0:865d42c46692 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
jeffknaggs 0:865d42c46692 4 * and associated documentation files (the "Software"), to deal in the Software without
jeffknaggs 0:865d42c46692 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
jeffknaggs 0:865d42c46692 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
jeffknaggs 0:865d42c46692 7 * Software is furnished to do so, subject to the following conditions:
jeffknaggs 0:865d42c46692 8 *
jeffknaggs 0:865d42c46692 9 * The above copyright notice and this permission notice shall be included in all copies or
jeffknaggs 0:865d42c46692 10 * substantial portions of the Software.
jeffknaggs 0:865d42c46692 11 *
jeffknaggs 0:865d42c46692 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
jeffknaggs 0:865d42c46692 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
jeffknaggs 0:865d42c46692 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
jeffknaggs 0:865d42c46692 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jeffknaggs 0:865d42c46692 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jeffknaggs 0:865d42c46692 17 */
jeffknaggs 0:865d42c46692 18
jeffknaggs 0:865d42c46692 19 #ifndef USB_HID_H
jeffknaggs 0:865d42c46692 20 #define USB_HID_H
jeffknaggs 0:865d42c46692 21
jeffknaggs 0:865d42c46692 22 /* These headers are included for child class. */
jeffknaggs 0:865d42c46692 23 #include "USBEndpoints.h"
jeffknaggs 0:865d42c46692 24 #include "USBDescriptor.h"
jeffknaggs 0:865d42c46692 25 #include "USBDevice_Types.h"
jeffknaggs 0:865d42c46692 26
jeffknaggs 0:865d42c46692 27 #include "USBHID_Types.h"
jeffknaggs 0:865d42c46692 28 #include "USBDevice.h"
jeffknaggs 0:865d42c46692 29
jeffknaggs 0:865d42c46692 30
jeffknaggs 0:865d42c46692 31 /**
jeffknaggs 0:865d42c46692 32 * USBHID example
jeffknaggs 0:865d42c46692 33 * @code
jeffknaggs 0:865d42c46692 34 * #include "mbed.h"
jeffknaggs 0:865d42c46692 35 * #include "USBHID.h"
jeffknaggs 0:865d42c46692 36 *
jeffknaggs 0:865d42c46692 37 * USBHID hid;
jeffknaggs 0:865d42c46692 38 * HID_REPORT recv;
jeffknaggs 0:865d42c46692 39 * BusOut leds(LED1,LED2,LED3,LED4);
jeffknaggs 0:865d42c46692 40 *
jeffknaggs 0:865d42c46692 41 * int main(void) {
jeffknaggs 0:865d42c46692 42 * while (1) {
jeffknaggs 0:865d42c46692 43 * hid.read(&recv);
jeffknaggs 0:865d42c46692 44 * leds = recv.data[0];
jeffknaggs 0:865d42c46692 45 * }
jeffknaggs 0:865d42c46692 46 * }
jeffknaggs 0:865d42c46692 47 * @endcode
jeffknaggs 0:865d42c46692 48 */
jeffknaggs 0:865d42c46692 49
jeffknaggs 0:865d42c46692 50 class USBHID: public USBDevice {
jeffknaggs 0:865d42c46692 51 public:
jeffknaggs 0:865d42c46692 52
jeffknaggs 0:865d42c46692 53 /**
jeffknaggs 0:865d42c46692 54 * Constructor
jeffknaggs 0:865d42c46692 55 *
jeffknaggs 0:865d42c46692 56 * @param output_report_length Maximum length of a sent report (up to 64 bytes) (default: 64 bytes)
jeffknaggs 0:865d42c46692 57 * @param input_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)
jeffknaggs 0:865d42c46692 58 * @param vendor_id Your vendor_id
jeffknaggs 0:865d42c46692 59 * @param product_id Your product_id
jeffknaggs 0:865d42c46692 60 * @param product_release Your preoduct_release
jeffknaggs 0:865d42c46692 61 * @param connect Connect the device
jeffknaggs 0:865d42c46692 62 */
jeffknaggs 0:865d42c46692 63 USBHID(uint8_t output_report_length = 64, uint8_t input_report_length = 64, uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0006, uint16_t product_release = 0x0001, bool connect = true);
jeffknaggs 0:865d42c46692 64
jeffknaggs 0:865d42c46692 65
jeffknaggs 0:865d42c46692 66 /**
jeffknaggs 0:865d42c46692 67 * Send a Report. warning: blocking
jeffknaggs 0:865d42c46692 68 *
jeffknaggs 0:865d42c46692 69 * @param report Report which will be sent (a report is defined by all data and the length)
jeffknaggs 0:865d42c46692 70 * @returns true if successful
jeffknaggs 0:865d42c46692 71 */
jeffknaggs 0:865d42c46692 72 bool send(HID_REPORT *report);
jeffknaggs 0:865d42c46692 73
jeffknaggs 0:865d42c46692 74
jeffknaggs 0:865d42c46692 75 /**
jeffknaggs 0:865d42c46692 76 * Send a Report. warning: non blocking
jeffknaggs 0:865d42c46692 77 *
jeffknaggs 0:865d42c46692 78 * @param report Report which will be sent (a report is defined by all data and the length)
jeffknaggs 0:865d42c46692 79 * @returns true if successful
jeffknaggs 0:865d42c46692 80 */
jeffknaggs 0:865d42c46692 81 bool sendNB(HID_REPORT *report);
jeffknaggs 0:865d42c46692 82
jeffknaggs 0:865d42c46692 83 /**
jeffknaggs 0:865d42c46692 84 * Read a report: blocking
jeffknaggs 0:865d42c46692 85 *
jeffknaggs 0:865d42c46692 86 * @param report pointer to the report to fill
jeffknaggs 0:865d42c46692 87 * @returns true if successful
jeffknaggs 0:865d42c46692 88 */
jeffknaggs 0:865d42c46692 89 bool read(HID_REPORT * report);
jeffknaggs 0:865d42c46692 90
jeffknaggs 0:865d42c46692 91 /**
jeffknaggs 0:865d42c46692 92 * Read a report: non blocking
jeffknaggs 0:865d42c46692 93 *
jeffknaggs 0:865d42c46692 94 * @param report pointer to the report to fill
jeffknaggs 0:865d42c46692 95 * @returns true if successful
jeffknaggs 0:865d42c46692 96 */
jeffknaggs 0:865d42c46692 97 bool readNB(HID_REPORT * report);
jeffknaggs 0:865d42c46692 98
jeffknaggs 0:865d42c46692 99 protected:
jeffknaggs 0:865d42c46692 100 uint16_t reportLength;
jeffknaggs 0:865d42c46692 101
jeffknaggs 0:865d42c46692 102 /*
jeffknaggs 0:865d42c46692 103 * Get the Report descriptor
jeffknaggs 0:865d42c46692 104 *
jeffknaggs 0:865d42c46692 105 * @returns pointer to the report descriptor
jeffknaggs 0:865d42c46692 106 */
jeffknaggs 0:865d42c46692 107 virtual uint8_t * reportDesc();
jeffknaggs 0:865d42c46692 108
jeffknaggs 0:865d42c46692 109 /*
jeffknaggs 0:865d42c46692 110 * Get the length of the report descriptor
jeffknaggs 0:865d42c46692 111 *
jeffknaggs 0:865d42c46692 112 * @returns the length of the report descriptor
jeffknaggs 0:865d42c46692 113 */
jeffknaggs 0:865d42c46692 114 virtual uint16_t reportDescLength();
jeffknaggs 0:865d42c46692 115
jeffknaggs 0:865d42c46692 116 /*
jeffknaggs 0:865d42c46692 117 * Get string product descriptor
jeffknaggs 0:865d42c46692 118 *
jeffknaggs 0:865d42c46692 119 * @returns pointer to the string product descriptor
jeffknaggs 0:865d42c46692 120 */
jeffknaggs 0:865d42c46692 121 virtual uint8_t * stringIproductDesc();
jeffknaggs 0:865d42c46692 122
jeffknaggs 0:865d42c46692 123 /*
jeffknaggs 0:865d42c46692 124 * Get string interface descriptor
jeffknaggs 0:865d42c46692 125 *
jeffknaggs 0:865d42c46692 126 * @returns pointer to the string interface descriptor
jeffknaggs 0:865d42c46692 127 */
jeffknaggs 0:865d42c46692 128 virtual uint8_t * stringIinterfaceDesc();
jeffknaggs 0:865d42c46692 129
jeffknaggs 0:865d42c46692 130 /*
jeffknaggs 0:865d42c46692 131 * Get configuration descriptor
jeffknaggs 0:865d42c46692 132 *
jeffknaggs 0:865d42c46692 133 * @returns pointer to the configuration descriptor
jeffknaggs 0:865d42c46692 134 */
jeffknaggs 0:865d42c46692 135 virtual uint8_t * configurationDesc();
jeffknaggs 0:865d42c46692 136
jeffknaggs 0:865d42c46692 137
jeffknaggs 0:865d42c46692 138 /*
jeffknaggs 0:865d42c46692 139 * HID Report received by SET_REPORT request. Warning: Called in ISR context
jeffknaggs 0:865d42c46692 140 * First byte of data will be the report ID
jeffknaggs 0:865d42c46692 141 *
jeffknaggs 0:865d42c46692 142 * @param report Data and length received
jeffknaggs 0:865d42c46692 143 */
jeffknaggs 0:865d42c46692 144 virtual void HID_callbackSetReport(HID_REPORT *report){};
jeffknaggs 0:865d42c46692 145
jeffknaggs 0:865d42c46692 146
jeffknaggs 0:865d42c46692 147 /*
jeffknaggs 0:865d42c46692 148 * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context
jeffknaggs 0:865d42c46692 149 * This is used to handle extensions to standard requests
jeffknaggs 0:865d42c46692 150 * and class specific requests
jeffknaggs 0:865d42c46692 151 *
jeffknaggs 0:865d42c46692 152 * @returns true if class handles this request
jeffknaggs 0:865d42c46692 153 */
jeffknaggs 0:865d42c46692 154 virtual bool USBCallback_request();
jeffknaggs 0:865d42c46692 155
jeffknaggs 0:865d42c46692 156
jeffknaggs 0:865d42c46692 157 /*
jeffknaggs 0:865d42c46692 158 * Called by USBDevice layer. Set configuration of the device.
jeffknaggs 0:865d42c46692 159 * For instance, you can add all endpoints that you need on this function.
jeffknaggs 0:865d42c46692 160 *
jeffknaggs 0:865d42c46692 161 * @param configuration Number of the configuration
jeffknaggs 0:865d42c46692 162 * @returns true if class handles this request
jeffknaggs 0:865d42c46692 163 */
jeffknaggs 0:865d42c46692 164 virtual bool USBCallback_setConfiguration(uint8_t configuration);
jeffknaggs 0:865d42c46692 165
jeffknaggs 0:865d42c46692 166 private:
jeffknaggs 0:865d42c46692 167 HID_REPORT outputReport;
jeffknaggs 0:865d42c46692 168 uint8_t output_length;
jeffknaggs 0:865d42c46692 169 uint8_t input_length;
jeffknaggs 0:865d42c46692 170 };
jeffknaggs 0:865d42c46692 171
jeffknaggs 0:865d42c46692 172 #endif