Dwayne Dilbeck / USBDevice

Forked to make modifications to bring the USBHID into USB compliance and add additional features.

Dependents:   HW4_AudioControl

Fork of USBDevice by mbed official

As of Revision 18 everything in the USBHID specification is now implemented, except Multi-reports.

Revision comments for changelist 18

USBHID.cpp

  • Added SET_PROTOCOL support
  • Added GET_PROTOCOL support
  • protocolSate is set to 1 by default to match USB HID specification. This variable should be checked to determine which format theinput report should have. 1 - Use the user specified report format. 0 - Use the BOOT protocol report format.

Revision comments for changelist 16

  • HID_REPORT transformed from structure to class. This was done for several reasons.
  1. When multiple reports are used the 64 byte size for every report becomes a problem.
  2. The length value should always remain the same for a report, Make the constructor set the vale at the same time it allocates memory for the DATA area.
  • By default the data will be an array of MAX_HID_REPORT_SIZE like the structure,
  • When given a length argument, the hid_report.length will be set, and hid_report.data will be an array of the size given.
  • Length zero causes data to be NULL
  • Mostly backwards compatible. The definition of a destructor caused a compiler error in USBMouse::update and USBMousekeyboard::update. This error was caused by instatiation of HID_REPORT in the middle of an IF logic statement. These files have been modified. The error complained that the logic skipped object initialization. The HID_REPORT has been moved to the class definition. Since both ABSOLUTE and RELATIVE modes used the HID_REPORT, this seems to make more sense. Previously the hid_report would be instatiated in <class>::mousesend and <class>::update.

Revision comments for changelist 14

USBdevice.cpp

  • Modified USB device state to change from Configure when disconnect is called.
  • Modified the call back function for when the suspend state changes. This should be used to turn off peripherals to conserve power.

Revision comments for changelist 13

USBdevice.cpp

  • ) Changed DEBUG messages to be more descriptive for string descriptor
  • ) Bug fix: Control Transfers did not actually transfer the data from Buffer to transfer->ptr

USBHIDTypes.h

  • ) Added ALL CLASS request to KEYWORD list
  • ) Added KEYWORDS for report type

USBHID.h

  • ) Added a new constructor to specify size of feature report
  • ) Added HID_REPORT inputReport and featureReport
  • ) Added data structures to support IDLE rate
  • ) Added data structures to support callback functions

USBHID.cpp

  • ) Changed constructor to initialize new feature data structures
  • ) Implemented Set_IDLE/GET_IDLE and the periodic resend of non-changed data
  • ) Implemented HID specification required control transfer GET_REPORT
  • ) Fixed issue where Intreput transfers and control transfers did not access the same data structures.
  • ) Implemented Feature reports
  • ) Implemented Callback Hooks for get_report/set_report actions.
  • ) Added callback hooks for interupt actions in the new functions.
  • ) interupt transfer can now write to outputReport
  • ) Modified SET_REPORT code to function for multiple types.
  • ) Refactored some code in preperation to add multi report support
Test NumberTest DescriptionTest ResultNotes
1Use USBmouse to verify backward compatibility of constructor and methodsPass
2Test SET_REPORT can set a feature reportPass
3Test GET_REPORT can retrieve a feature reportPass
4Test SET_IDLE sets up a reoccuring triggerPassIOCTL_SET_POLL_FREQUENCY_MSEC does not function for the windows HID driver. A Special test program is used to rearm the IDLE rate after windows sets it to zero
5Test SET_IDLE disables a triggerPassWindows automatically sends this command to a HID device when it is inserted.
6Enabled DEBUG in USBDevice.cpp and generated str descriptor requests.Pass
7Test SET_REPORT can set an output reportPass
8Test GET_REPORT can retrieve an output reportPass
9ReadFile, accesses the input_reportPass
10WriteFile accesses the output_report, via interupt transfer when ep1_out is used.Pass
11WriteFile accesses the output_report, via control transfer when ep1_out is NOT used.Not Tested
12Callback hooks trigger independently for each type of set_report/get_reportPass
13New constructor sets feature_report sizePass
14Control transfer SET_REPORT and writeFile access the same data structureBUGThe same data structure is accessed, but the data transfer size is different. The writeFile strips the leading byte which is the report ID, The Control transfer keeps the byte.
15Control transfer GET_REPORT and readFile access the same data structureBUGThe same dtat structure is accessed, but the data transfer size is different. The readFile strips the leading byte which is the report ID, The Control transfer keeps the byte.
16Test GET_IDLE retrieves the IDLE rateUnknownWindows HID driver does not implement IOCTL_HID_GET_POLL_FREQUENCY_MSEC

USBHID/USBHID.h@12:590d5be7b7f4, 2013-07-25 (annotated)

Committer:
jakowisp
Date:
Thu Jul 25 00:38:09 2013 +0000
Revision:
12:590d5be7b7f4
Parent:
1:80ab0d068708
Child:
13:9f652add7891
New features added and modifications made to make library USB HID compliant.

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 * USBHID example
samux 1:80ab0d068708 32 * @code
samux 1:80ab0d068708 33 * #include "mbed.h"
samux 1:80ab0d068708 34 * #include "USBHID.h"
samux 1:80ab0d068708 35 *
samux 1:80ab0d068708 36 * USBHID hid;
samux 1:80ab0d068708 37 * HID_REPORT recv;
samux 1:80ab0d068708 38 * BusOut leds(LED1,LED2,LED3,LED4);
samux 1:80ab0d068708 39 *
samux 1:80ab0d068708 40 * int main(void) {
samux 1:80ab0d068708 41 * while (1) {
samux 1:80ab0d068708 42 * hid.read(&recv);
samux 1:80ab0d068708 43 * leds = recv.data[0];
samux 1:80ab0d068708 44 * }
samux 1:80ab0d068708 45 * }
samux 1:80ab0d068708 46 * @endcode
samux 1:80ab0d068708 47 */
samux 1:80ab0d068708 48
samux 1:80ab0d068708 49 class USBHID: public USBDevice {
samux 1:80ab0d068708 50 public:
samux 1:80ab0d068708 51
samux 1:80ab0d068708 52 /**
jakowisp 12:590d5be7b7f4 53 * Constructors
samux 1:80ab0d068708 54 *
samux 1:80ab0d068708 55 * @param output_report_length Maximum length of a sent report (up to 64 bytes) (default: 64 bytes)
samux 1:80ab0d068708 56 * @param input_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)
jakowisp 12:590d5be7b7f4 57 * @param report_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 */
jakowisp 12:590d5be7b7f4 63 USBHID(uint8_t output_report_length , uint8_t input_report_length , uint8_t feature_report_length , uint16_t vendor_id , uint16_t product_id , uint16_t product_release , bool connect );
jakowisp 12:590d5be7b7f4 64 /* default constructor to maintain backwards compatibility. */
samux 1:80ab0d068708 65 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 66
samux 1:80ab0d068708 67
samux 1:80ab0d068708 68 /**
samux 1:80ab0d068708 69 * Send a Report. warning: blocking
samux 1:80ab0d068708 70 *
samux 1:80ab0d068708 71 * @param report Report which will be sent (a report is defined by all data and the length)
samux 1:80ab0d068708 72 * @returns true if successful
samux 1:80ab0d068708 73 */
samux 1:80ab0d068708 74 bool send(HID_REPORT *report);
samux 1:80ab0d068708 75
samux 1:80ab0d068708 76
samux 1:80ab0d068708 77 /**
samux 1:80ab0d068708 78 * Send a Report. warning: non blocking
samux 1:80ab0d068708 79 *
samux 1:80ab0d068708 80 * @param report Report which will be sent (a report is defined by all data and the length)
samux 1:80ab0d068708 81 * @returns true if successful
samux 1:80ab0d068708 82 */
samux 1:80ab0d068708 83 bool sendNB(HID_REPORT *report);
samux 1:80ab0d068708 84
samux 1:80ab0d068708 85 /**
samux 1:80ab0d068708 86 * Read a report: blocking
samux 1:80ab0d068708 87 *
samux 1:80ab0d068708 88 * @param report pointer to the report to fill
samux 1:80ab0d068708 89 * @returns true if successful
samux 1:80ab0d068708 90 */
samux 1:80ab0d068708 91 bool read(HID_REPORT * report);
samux 1:80ab0d068708 92
samux 1:80ab0d068708 93 /**
samux 1:80ab0d068708 94 * Read a report: non blocking
samux 1:80ab0d068708 95 *
samux 1:80ab0d068708 96 * @param report pointer to the report to fill
samux 1:80ab0d068708 97 * @returns true if successful
samux 1:80ab0d068708 98 */
samux 1:80ab0d068708 99 bool readNB(HID_REPORT * report);
jakowisp 12:590d5be7b7f4 100
jakowisp 12:590d5be7b7f4 101 /**
jakowisp 12:590d5be7b7f4 102 * Provide function to trigger default report transfer
jakowisp 12:590d5be7b7f4 103 *
jakowisp 12:590d5be7b7f4 104 * @param HID_REPORT
jakowisp 12:590d5be7b7f4 105 * @returns true if succsful
jakowisp 12:590d5be7b7f4 106 * The devloper should always use FillReport, The IDLE logic will send a report if the value has changed, or if the idle period expires.
jakowisp 12:590d5be7b7f4 107 */
jakowisp 12:590d5be7b7f4 108 bool FillInputReport(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 109 bool FillFeatureReport(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 110
jakowisp 12:590d5be7b7f4 111
jakowisp 12:590d5be7b7f4 112 /**
jakowisp 12:590d5be7b7f4 113 * Callback poiters to functions.
jakowisp 12:590d5be7b7f4 114 *
jakowisp 12:590d5be7b7f4 115 * @param report pointer to the report to fill
jakowisp 12:590d5be7b7f4 116 * These allow a user program to hook on get/set report control setup stages.
jakowisp 12:590d5be7b7f4 117 */
jakowisp 12:590d5be7b7f4 118 void (*callbackSetInputReport)(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 119 bool (*callbackGetInputReport)(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 120 void (*callbackSetOutputReport)(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 121 bool (*callbackGetOutputReport)(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 122 void (*callbackSetFeatureReport)(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 123 bool (*callbackGetFeatureReport)(HID_REPORT *report);
jakowisp 12:590d5be7b7f4 124
jakowisp 12:590d5be7b7f4 125 /* This function should be private, but is exposed to allow a developer to reenable IDLE values > zero after windows sets the value to zero.
jakowisp 12:590d5be7b7f4 126 This is due to microsoft windows HID driver not implementing IOCTL_HID_SET_POLL_FREQUENCY_MSEC/IOCTL_HID_GET_POLL_FREQUENCY_MSEC
jakowisp 12:590d5be7b7f4 127 */
jakowisp 12:590d5be7b7f4 128 virtual void SetReportIdle(uint16_t wValue);
jakowisp 12:590d5be7b7f4 129
samux 1:80ab0d068708 130
samux 1:80ab0d068708 131 protected:
samux 1:80ab0d068708 132 uint16_t reportLength;
samux 1:80ab0d068708 133
samux 1:80ab0d068708 134 /*
samux 1:80ab0d068708 135 * Get the Report descriptor
samux 1:80ab0d068708 136 *
samux 1:80ab0d068708 137 * @returns pointer to the report descriptor
samux 1:80ab0d068708 138 */
samux 1:80ab0d068708 139 virtual uint8_t * reportDesc();
samux 1:80ab0d068708 140
samux 1:80ab0d068708 141 /*
samux 1:80ab0d068708 142 * Get the length of the report descriptor
samux 1:80ab0d068708 143 *
samux 1:80ab0d068708 144 * @returns the length of the report descriptor
samux 1:80ab0d068708 145 */
samux 1:80ab0d068708 146 virtual uint16_t reportDescLength();
samux 1:80ab0d068708 147
samux 1:80ab0d068708 148 /*
samux 1:80ab0d068708 149 * Get string product descriptor
samux 1:80ab0d068708 150 *
samux 1:80ab0d068708 151 * @returns pointer to the string product descriptor
samux 1:80ab0d068708 152 */
samux 1:80ab0d068708 153 virtual uint8_t * stringIproductDesc();
samux 1:80ab0d068708 154
samux 1:80ab0d068708 155 /*
samux 1:80ab0d068708 156 * Get string interface descriptor
samux 1:80ab0d068708 157 *
samux 1:80ab0d068708 158 * @returns pointer to the string interface descriptor
samux 1:80ab0d068708 159 */
samux 1:80ab0d068708 160 virtual uint8_t * stringIinterfaceDesc();
samux 1:80ab0d068708 161
samux 1:80ab0d068708 162 /*
samux 1:80ab0d068708 163 * Get configuration descriptor
samux 1:80ab0d068708 164 *
samux 1:80ab0d068708 165 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 166 */
samux 1:80ab0d068708 167 virtual uint8_t * configurationDesc();
samux 1:80ab0d068708 168
samux 1:80ab0d068708 169
samux 1:80ab0d068708 170 /*
samux 1:80ab0d068708 171 * HID Report received by SET_REPORT request. Warning: Called in ISR context
samux 1:80ab0d068708 172 * First byte of data will be the report ID
samux 1:80ab0d068708 173 *
samux 1:80ab0d068708 174 * @param report Data and length received
samux 1:80ab0d068708 175 */
jakowisp 12:590d5be7b7f4 176 static void HID_callbackSetReport(HID_REPORT *report){};
jakowisp 12:590d5be7b7f4 177
jakowisp 12:590d5be7b7f4 178 /*
jakowisp 12:590d5be7b7f4 179 * HID Report received by GET_REPORT request. Warning: Called in ISR context
jakowisp 12:590d5be7b7f4 180 * First byte of data will be the report ID
jakowisp 12:590d5be7b7f4 181 *
jakowisp 12:590d5be7b7f4 182 * @param report Data and length received
jakowisp 12:590d5be7b7f4 183 */
jakowisp 12:590d5be7b7f4 184 static bool HID_callbackGetReport(HID_REPORT *report){return true;};
jakowisp 12:590d5be7b7f4 185
samux 1:80ab0d068708 186 /*
samux 1:80ab0d068708 187 * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context
samux 1:80ab0d068708 188 * This is used to handle extensions to standard requests
samux 1:80ab0d068708 189 * and class specific requests
samux 1:80ab0d068708 190 *
samux 1:80ab0d068708 191 * @returns true if class handles this request
samux 1:80ab0d068708 192 */
samux 1:80ab0d068708 193 virtual bool USBCallback_request();
jakowisp 12:590d5be7b7f4 194 /*
jakowisp 12:590d5be7b7f4 195 * Called by USBDevice on Endpoint0 request completion
jakowisp 12:590d5be7b7f4 196 * if the 'notify' flag has been set to true. Warning: Called in ISR context
jakowisp 12:590d5be7b7f4 197 *
jakowisp 12:590d5be7b7f4 198 * In this case it is used to indicate that a HID report has
jakowisp 12:590d5be7b7f4 199 * been received from the host on endpoint 0
jakowisp 12:590d5be7b7f4 200 *
jakowisp 12:590d5be7b7f4 201 * @param buf buffer received on endpoint 0
jakowisp 12:590d5be7b7f4 202 * @param length length of this buffer
jakowisp 12:590d5be7b7f4 203 */
jakowisp 12:590d5be7b7f4 204 virtual void USBCallback_requestCompleted(uint8_t * buf, uint32_t length);
samux 1:80ab0d068708 205
samux 1:80ab0d068708 206 /*
jakowisp 12:590d5be7b7f4 207 * Called by USBDevice layer. to ensure that control transfers and interupt transfers work on the same reports.
jakowisp 12:590d5be7b7f4 208 */
jakowisp 12:590d5be7b7f4 209 virtual bool EP1_OUT_callback();
jakowisp 12:590d5be7b7f4 210
jakowisp 12:590d5be7b7f4 211 /* Called by FillInputReport when data has changed, and transmits the data. */
jakowisp 12:590d5be7b7f4 212 bool SendReport(void);
jakowisp 12:590d5be7b7f4 213
jakowisp 12:590d5be7b7f4 214 /*
jakowisp 12:590d5be7b7f4 215 * Called by USBDevice layer.to set configuration
samux 1:80ab0d068708 216 */
samux 1:80ab0d068708 217 virtual bool USBCallback_setConfiguration(uint8_t configuration);
jakowisp 12:590d5be7b7f4 218
jakowisp 12:590d5be7b7f4 219 /* tells SET_IDLE/GET_IDLE where the IDE rate value is. */
jakowisp 12:590d5be7b7f4 220
jakowisp 12:590d5be7b7f4 221 virtual uint8_t * getReportIdlePtr(uint8_t reportID){ return &reportIdleRateInt; };
jakowisp 12:590d5be7b7f4 222
jakowisp 12:590d5be7b7f4 223
samux 1:80ab0d068708 224 private:
jakowisp 12:590d5be7b7f4 225 // TODO: HID Reports should be dynamically malloced to save memory and prepare for multi-reports
jakowisp 12:590d5be7b7f4 226 HID_REPORT inputReport;
samux 1:80ab0d068708 227 HID_REPORT outputReport;
jakowisp 12:590d5be7b7f4 228 HID_REPORT featureReport;
samux 1:80ab0d068708 229 uint8_t output_length;
samux 1:80ab0d068708 230 uint8_t input_length;
jakowisp 12:590d5be7b7f4 231 uint8_t feature_length;
jakowisp 12:590d5be7b7f4 232
jakowisp 12:590d5be7b7f4 233 //TODO: REPORT clsss should be created to handle MULTI-report
jakowisp 12:590d5be7b7f4 234 //Implementation items for IDLE rate (TICKER)
jakowisp 12:590d5be7b7f4 235 float reportIdleRate;
jakowisp 12:590d5be7b7f4 236 uint8_t reportIdleRateInt;
jakowisp 12:590d5be7b7f4 237 Ticker countDownToReportTrigger;
jakowisp 12:590d5be7b7f4 238 void ResetIdleTicker(void);
jakowisp 12:590d5be7b7f4 239 void IdlePeriodReSend(void);
jakowisp 12:590d5be7b7f4 240
jakowisp 12:590d5be7b7f4 241 //Report REPORT data pointer retrieval.
jakowisp 12:590d5be7b7f4 242 HID_REPORT * GetReportTargetPointer(uint16_t wValue);
jakowisp 12:590d5be7b7f4 243 //Report Set/GET REPORT callback handlers
jakowisp 12:590d5be7b7f4 244 bool HIDCallback_GetReportHandler(HID_REPORT *targetPtr);
jakowisp 12:590d5be7b7f4 245 bool HIDCallback_SetReportHandler(HID_REPORT *targetPtr);
samux 1:80ab0d068708 246 };
samux 1:80ab0d068708 247
samux 1:80ab0d068708 248 #endif