Dwayne Dilbeck
Forked to make modifications to bring the USBHID into USB compliance and add additional features.
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.
- When multiple reports are used the 64 byte size for every report becomes a problem.
- 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 Number | Test Description | Test Result | Notes | ||||||
| 1 | Use USBmouse to verify backward compatibility of constructor and methods | Pass | |||||||
| 2 | Test SET_REPORT can set a feature report | Pass | |||||||
| 3 | Test GET_REPORT can retrieve a feature report | Pass | |||||||
| 4 | Test SET_IDLE sets up a reoccuring trigger | Pass | IOCTL_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 | ||||||
| 5 | Test SET_IDLE disables a trigger | Pass | Windows automatically sends this command to a HID device when it is inserted. | ||||||
| 6 | Enabled DEBUG in USBDevice.cpp and generated str descriptor requests. | Pass | |||||||
| 7 | Test SET_REPORT can set an output report | Pass | |||||||
| 8 | Test GET_REPORT can retrieve an output report | Pass | |||||||
| 9 | ReadFile, accesses the input_report | Pass | |||||||
| 10 | WriteFile accesses the output_report, via interupt transfer when ep1_out is used. | Pass | |||||||
| 11 | WriteFile accesses the output_report, via control transfer when ep1_out is NOT used. | Not Tested | |||||||
| 12 | Callback hooks trigger independently for each type of set_report/get_report | Pass | |||||||
| 13 | New constructor sets feature_report size | Pass | |||||||
| 14 | Control transfer SET_REPORT and writeFile access the same data structure | BUG | The 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. | ||||||
| 15 | Control transfer GET_REPORT and readFile access the same data structure | BUG | The 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. | ||||||
| 16 | Test GET_IDLE retrieves the IDLE rate | Unknown | Windows HID driver does not implement IOCTL_HID_GET_POLL_FREQUENCY_MSEC |
USBHID/USBHID_Types.h@16:49a551d94ad1, 2013-08-01 (annotated)
- Committer:
- jakowisp
- Date:
- Thu Aug 01 20:11:01 2013 +0000
- Revision:
- 16:49a551d94ad1
- Parent:
- 12:590d5be7b7f4
HID_REPORT transformed from a structure to a class. This is in preperation for multi-report support.
Who changed what in which revision?
| User | Revision | Line number | New 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 USBCLASS_HID_TYPES |
| samux | 1:80ab0d068708 | 20 | #define USBCLASS_HID_TYPES |
| samux | 1:80ab0d068708 | 21 | |
| samux | 1:80ab0d068708 | 22 | #include <stdint.h> |
| samux | 1:80ab0d068708 | 23 | |
| samux | 1:80ab0d068708 | 24 | /* */ |
| samux | 1:80ab0d068708 | 25 | #define HID_VERSION_1_11 (0x0111) |
| samux | 1:80ab0d068708 | 26 | |
| samux | 1:80ab0d068708 | 27 | /* HID Class */ |
| samux | 1:80ab0d068708 | 28 | #define HID_CLASS (3) |
| samux | 1:80ab0d068708 | 29 | #define HID_SUBCLASS_NONE (0) |
| samux | 1:80ab0d068708 | 30 | #define HID_PROTOCOL_NONE (0) |
| samux | 1:80ab0d068708 | 31 | |
| samux | 1:80ab0d068708 | 32 | /* Descriptors */ |
| samux | 1:80ab0d068708 | 33 | #define HID_DESCRIPTOR (33) |
| samux | 1:80ab0d068708 | 34 | #define HID_DESCRIPTOR_LENGTH (0x09) |
| samux | 1:80ab0d068708 | 35 | #define REPORT_DESCRIPTOR (34) |
| samux | 1:80ab0d068708 | 36 | |
| samux | 1:80ab0d068708 | 37 | /* Class requests */ |
| jakowisp | 12:590d5be7b7f4 | 38 | #define GET_REPORT (0x1) |
| jakowisp | 12:590d5be7b7f4 | 39 | #define GET_IDLE (0x2) |
| jakowisp | 12:590d5be7b7f4 | 40 | #define GET_PROTOCOL (0x3) |
| jakowisp | 12:590d5be7b7f4 | 41 | #define SET_REPORT (0x9) |
| jakowisp | 12:590d5be7b7f4 | 42 | #define SET_IDLE (0xa) |
| jakowisp | 12:590d5be7b7f4 | 43 | #define SET_PROTOCOL (0xb) |
| samux | 1:80ab0d068708 | 44 | |
| samux | 1:80ab0d068708 | 45 | /* HID Class Report Descriptor */ |
| samux | 1:80ab0d068708 | 46 | /* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */ |
| samux | 1:80ab0d068708 | 47 | /* of data as per HID Class standard */ |
| samux | 1:80ab0d068708 | 48 | |
| samux | 1:80ab0d068708 | 49 | /* Main items */ |
| samux | 1:80ab0d068708 | 50 | #define INPUT(size) (0x80 | size) |
| samux | 1:80ab0d068708 | 51 | #define OUTPUT(size) (0x90 | size) |
| samux | 1:80ab0d068708 | 52 | #define FEATURE(size) (0xb0 | size) |
| samux | 1:80ab0d068708 | 53 | #define COLLECTION(size) (0xa0 | size) |
| samux | 1:80ab0d068708 | 54 | #define END_COLLECTION(size) (0xc0 | size) |
| samux | 1:80ab0d068708 | 55 | |
| samux | 1:80ab0d068708 | 56 | /* Global items */ |
| samux | 1:80ab0d068708 | 57 | #define USAGE_PAGE(size) (0x04 | size) |
| samux | 1:80ab0d068708 | 58 | #define LOGICAL_MINIMUM(size) (0x14 | size) |
| samux | 1:80ab0d068708 | 59 | #define LOGICAL_MAXIMUM(size) (0x24 | size) |
| samux | 1:80ab0d068708 | 60 | #define PHYSICAL_MINIMUM(size) (0x34 | size) |
| samux | 1:80ab0d068708 | 61 | #define PHYSICAL_MAXIMUM(size) (0x44 | size) |
| samux | 1:80ab0d068708 | 62 | #define UNIT_EXPONENT(size) (0x54 | size) |
| samux | 1:80ab0d068708 | 63 | #define UNIT(size) (0x64 | size) |
| samux | 1:80ab0d068708 | 64 | #define REPORT_SIZE(size) (0x74 | size) |
| samux | 1:80ab0d068708 | 65 | #define REPORT_ID(size) (0x84 | size) |
| samux | 1:80ab0d068708 | 66 | #define REPORT_COUNT(size) (0x94 | size) |
| samux | 1:80ab0d068708 | 67 | #define PUSH(size) (0xa4 | size) |
| samux | 1:80ab0d068708 | 68 | #define POP(size) (0xb4 | size) |
| samux | 1:80ab0d068708 | 69 | |
| samux | 1:80ab0d068708 | 70 | /* Local items */ |
| samux | 1:80ab0d068708 | 71 | #define USAGE(size) (0x08 | size) |
| samux | 1:80ab0d068708 | 72 | #define USAGE_MINIMUM(size) (0x18 | size) |
| samux | 1:80ab0d068708 | 73 | #define USAGE_MAXIMUM(size) (0x28 | size) |
| samux | 1:80ab0d068708 | 74 | #define DESIGNATOR_INDEX(size) (0x38 | size) |
| samux | 1:80ab0d068708 | 75 | #define DESIGNATOR_MINIMUM(size) (0x48 | size) |
| samux | 1:80ab0d068708 | 76 | #define DESIGNATOR_MAXIMUM(size) (0x58 | size) |
| samux | 1:80ab0d068708 | 77 | #define STRING_INDEX(size) (0x78 | size) |
| samux | 1:80ab0d068708 | 78 | #define STRING_MINIMUM(size) (0x88 | size) |
| samux | 1:80ab0d068708 | 79 | #define STRING_MAXIMUM(size) (0x98 | size) |
| samux | 1:80ab0d068708 | 80 | #define DELIMITER(size) (0xa8 | size) |
| samux | 1:80ab0d068708 | 81 | |
| samux | 1:80ab0d068708 | 82 | /* HID Report */ |
| jakowisp | 12:590d5be7b7f4 | 83 | /* Each report can have input,output, and feature type thetype codes are defined below*/ |
| jakowisp | 12:590d5be7b7f4 | 84 | #define HID_INPUT_REPORT_TYPE (0x01) |
| jakowisp | 12:590d5be7b7f4 | 85 | #define HID_OUTPUT_REPORT_TYPE (0x02) |
| jakowisp | 12:590d5be7b7f4 | 86 | #define HID_FEATURE_REPORT_TYPE (0x03) |
| jakowisp | 12:590d5be7b7f4 | 87 | |
| jakowisp | 16:49a551d94ad1 | 88 | #include "HID_REPORT.h" |
| samux | 1:80ab0d068708 | 89 | |
| samux | 1:80ab0d068708 | 90 | |
| samux | 1:80ab0d068708 | 91 | #endif |