Brandon Yee / Mbed 2 deprecated Slingshot

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ADXL345 DebounceIn USBDevice mbed

USBDevice/USBHID/USBHID.h@0:cf17ea89fd09, 2012-10-14 (annotated)

Committer:
Brandon
Date:
Sun Oct 14 18:58:38 2012 +0000
Revision:
0:cf17ea89fd09
lab3

Who changed what in which revision?

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