Greg Steiert / USBDevice

USB Library for Maxim Targeets

Fork of USBDevice by Maxim Integrated

USBHID/USBHID.h@1:80ab0d068708, 2012-07-17 (annotated)

Committer:
samux
Date:
Tue Jul 17 14:30:29 2012 +0000
Revision:
1:80ab0d068708
Child:
25:7c72828865f3
Update USBDevice lib

Who changed what in which revision?

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