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
Committer:
jakowisp
Date:
Thu Aug 08 08:02:46 2013 +0000
Revision:
18:cb3afa532fcd
Parent:
8:335f2506f422
Default ProtocolState was incorrectly being set to 0:Boot when the HID specification states that the default should be 1:Report

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 8:335f2506f422 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 8:335f2506f422 2 *
samux 8:335f2506f422 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 8:335f2506f422 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 8:335f2506f422 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 8:335f2506f422 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 8:335f2506f422 7 * Software is furnished to do so, subject to the following conditions:
samux 8:335f2506f422 8 *
samux 8:335f2506f422 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 8:335f2506f422 10 * substantial portions of the Software.
samux 8:335f2506f422 11 *
samux 8:335f2506f422 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 8:335f2506f422 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 8:335f2506f422 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 8:335f2506f422 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 8:335f2506f422 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 8:335f2506f422 17 */
samux 8:335f2506f422 18
samux 8:335f2506f422 19 #define NUMBER_OF_LOGICAL_ENDPOINTS (16)
samux 8:335f2506f422 20 #define NUMBER_OF_PHYSICAL_ENDPOINTS (NUMBER_OF_LOGICAL_ENDPOINTS * 2)
samux 8:335f2506f422 21
samux 8:335f2506f422 22 /* Define physical endpoint numbers */
samux 8:335f2506f422 23
samux 8:335f2506f422 24 /* Endpoint No. */
samux 8:335f2506f422 25 /* ---------------- */
samux 8:335f2506f422 26 #define EP0OUT (0)
samux 8:335f2506f422 27 #define EP0IN (1)
samux 8:335f2506f422 28 #define EP1OUT (2)
samux 8:335f2506f422 29 #define EP1IN (3)
samux 8:335f2506f422 30 #define EP2OUT (4)
samux 8:335f2506f422 31 #define EP2IN (5)
samux 8:335f2506f422 32 #define EP3OUT (6)
samux 8:335f2506f422 33 #define EP3IN (7)
samux 8:335f2506f422 34 #define EP4OUT (8)
samux 8:335f2506f422 35 #define EP4IN (9)
samux 8:335f2506f422 36 #define EP5OUT (10)
samux 8:335f2506f422 37 #define EP5IN (11)
samux 8:335f2506f422 38 #define EP6OUT (12)
samux 8:335f2506f422 39 #define EP6IN (13)
samux 8:335f2506f422 40 #define EP7OUT (14)
samux 8:335f2506f422 41 #define EP7IN (15)
samux 8:335f2506f422 42 #define EP8OUT (16)
samux 8:335f2506f422 43 #define EP8IN (17)
samux 8:335f2506f422 44 #define EP9OUT (18)
samux 8:335f2506f422 45 #define EP9IN (19)
samux 8:335f2506f422 46 #define EP10OUT (20)
samux 8:335f2506f422 47 #define EP10IN (21)
samux 8:335f2506f422 48 #define EP11OUT (22)
samux 8:335f2506f422 49 #define EP11IN (23)
samux 8:335f2506f422 50 #define EP12OUT (24)
samux 8:335f2506f422 51 #define EP12IN (25)
samux 8:335f2506f422 52 #define EP13OUT (26)
samux 8:335f2506f422 53 #define EP13IN (27)
samux 8:335f2506f422 54 #define EP14OUT (28)
samux 8:335f2506f422 55 #define EP14IN (29)
samux 8:335f2506f422 56 #define EP15OUT (30)
samux 8:335f2506f422 57 #define EP15IN (31)
samux 8:335f2506f422 58
samux 8:335f2506f422 59 /* Maximum Packet sizes */
samux 8:335f2506f422 60
samux 8:335f2506f422 61 #define MAX_PACKET_SIZE_EP0 (64)
samux 8:335f2506f422 62 #define MAX_PACKET_SIZE_EP1 (64)
samux 8:335f2506f422 63 #define MAX_PACKET_SIZE_EP2 (64)
samux 8:335f2506f422 64 #define MAX_PACKET_SIZE_EP3 (1023)
samux 8:335f2506f422 65 #define MAX_PACKET_SIZE_EP4 (64)
samux 8:335f2506f422 66 #define MAX_PACKET_SIZE_EP5 (64)
samux 8:335f2506f422 67 #define MAX_PACKET_SIZE_EP6 (64)
samux 8:335f2506f422 68 #define MAX_PACKET_SIZE_EP7 (64)
samux 8:335f2506f422 69 #define MAX_PACKET_SIZE_EP8 (64)
samux 8:335f2506f422 70 #define MAX_PACKET_SIZE_EP9 (64)
samux 8:335f2506f422 71 #define MAX_PACKET_SIZE_EP10 (64)
samux 8:335f2506f422 72 #define MAX_PACKET_SIZE_EP11 (64)
samux 8:335f2506f422 73 #define MAX_PACKET_SIZE_EP12 (64)
samux 8:335f2506f422 74 #define MAX_PACKET_SIZE_EP13 (64)
samux 8:335f2506f422 75 #define MAX_PACKET_SIZE_EP14 (64)
samux 8:335f2506f422 76 #define MAX_PACKET_SIZE_EP15 (64)
samux 8:335f2506f422 77
samux 8:335f2506f422 78 /* Generic endpoints - intended to be portable accross devices */
samux 8:335f2506f422 79 /* and be suitable for simple USB devices. */
samux 8:335f2506f422 80
samux 8:335f2506f422 81 /* Bulk endpoints */
samux 8:335f2506f422 82 #define EPBULK_OUT (EP2OUT)
samux 8:335f2506f422 83 #define EPBULK_IN (EP2IN)
samux 8:335f2506f422 84 /* Interrupt endpoints */
samux 8:335f2506f422 85 #define EPINT_OUT (EP1OUT)
samux 8:335f2506f422 86 #define EPINT_IN (EP1IN)
samux 8:335f2506f422 87 /* Isochronous endpoints */
samux 8:335f2506f422 88 #define EPISO_OUT (EP3OUT)
samux 8:335f2506f422 89 #define EPISO_IN (EP3IN)
samux 8:335f2506f422 90
samux 8:335f2506f422 91 #define MAX_PACKET_SIZE_EPBULK (MAX_PACKET_SIZE_EP2)
samux 8:335f2506f422 92 #define MAX_PACKET_SIZE_EPINT (MAX_PACKET_SIZE_EP1)
samux 8:335f2506f422 93 #define MAX_PACKET_SIZE_EPISO (MAX_PACKET_SIZE_EP3)