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:
samux
Date:
Tue Jul 17 14:30:29 2012 +0000
Revision:
1:80ab0d068708
Child:
16:49a551d94ad1
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 #include "stdint.h"
samux 1:80ab0d068708 20 #include "USBMouse.h"
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 bool USBMouse::update(int16_t x, int16_t y, uint8_t button, int8_t z) {
samux 1:80ab0d068708 23 switch (mouse_type) {
samux 1:80ab0d068708 24 case REL_MOUSE:
samux 1:80ab0d068708 25 while (x > 127) {
samux 1:80ab0d068708 26 if (!mouseSend(127, 0, button, z)) return false;
samux 1:80ab0d068708 27 x = x - 127;
samux 1:80ab0d068708 28 }
samux 1:80ab0d068708 29 while (x < -128) {
samux 1:80ab0d068708 30 if (!mouseSend(-128, 0, button, z)) return false;
samux 1:80ab0d068708 31 x = x + 128;
samux 1:80ab0d068708 32 }
samux 1:80ab0d068708 33 while (y > 127) {
samux 1:80ab0d068708 34 if (!mouseSend(0, 127, button, z)) return false;
samux 1:80ab0d068708 35 y = y - 127;
samux 1:80ab0d068708 36 }
samux 1:80ab0d068708 37 while (y < -128) {
samux 1:80ab0d068708 38 if (!mouseSend(0, -128, button, z)) return false;
samux 1:80ab0d068708 39 y = y + 128;
samux 1:80ab0d068708 40 }
samux 1:80ab0d068708 41 return mouseSend(x, y, button, z);
samux 1:80ab0d068708 42 case ABS_MOUSE:
samux 1:80ab0d068708 43 HID_REPORT report;
samux 1:80ab0d068708 44
samux 1:80ab0d068708 45 report.data[0] = x & 0xff;
samux 1:80ab0d068708 46 report.data[1] = (x >> 8) & 0xff;
samux 1:80ab0d068708 47 report.data[2] = y & 0xff;
samux 1:80ab0d068708 48 report.data[3] = (y >> 8) & 0xff;
samux 1:80ab0d068708 49 report.data[4] = -z;
samux 1:80ab0d068708 50 report.data[5] = button & 0x07;
samux 1:80ab0d068708 51
samux 1:80ab0d068708 52 report.length = 6;
samux 1:80ab0d068708 53
samux 1:80ab0d068708 54 return send(&report);
samux 1:80ab0d068708 55 default:
samux 1:80ab0d068708 56 return false;
samux 1:80ab0d068708 57 }
samux 1:80ab0d068708 58 }
samux 1:80ab0d068708 59
samux 1:80ab0d068708 60 bool USBMouse::mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z) {
samux 1:80ab0d068708 61 HID_REPORT report;
samux 1:80ab0d068708 62 report.data[0] = buttons & 0x07;
samux 1:80ab0d068708 63 report.data[1] = x;
samux 1:80ab0d068708 64 report.data[2] = y;
samux 1:80ab0d068708 65 report.data[3] = -z; // >0 to scroll down, <0 to scroll up
samux 1:80ab0d068708 66
samux 1:80ab0d068708 67 report.length = 4;
samux 1:80ab0d068708 68
samux 1:80ab0d068708 69 return send(&report);
samux 1:80ab0d068708 70 }
samux 1:80ab0d068708 71
samux 1:80ab0d068708 72 bool USBMouse::move(int16_t x, int16_t y) {
samux 1:80ab0d068708 73 return update(x, y, button, 0);
samux 1:80ab0d068708 74 }
samux 1:80ab0d068708 75
samux 1:80ab0d068708 76 bool USBMouse::scroll(int8_t z) {
samux 1:80ab0d068708 77 return update(0, 0, button, z);
samux 1:80ab0d068708 78 }
samux 1:80ab0d068708 79
samux 1:80ab0d068708 80
samux 1:80ab0d068708 81 bool USBMouse::doubleClick() {
samux 1:80ab0d068708 82 if (!click(MOUSE_LEFT))
samux 1:80ab0d068708 83 return false;
samux 1:80ab0d068708 84 wait(0.1);
samux 1:80ab0d068708 85 return click(MOUSE_LEFT);
samux 1:80ab0d068708 86 }
samux 1:80ab0d068708 87
samux 1:80ab0d068708 88 bool USBMouse::click(uint8_t button) {
samux 1:80ab0d068708 89 if (!update(0, 0, button, 0))
samux 1:80ab0d068708 90 return false;
samux 1:80ab0d068708 91 wait(0.01);
samux 1:80ab0d068708 92 return update(0, 0, 0, 0);
samux 1:80ab0d068708 93 }
samux 1:80ab0d068708 94
samux 1:80ab0d068708 95 bool USBMouse::press(uint8_t button_) {
samux 1:80ab0d068708 96 button = button_ & 0x07;
samux 1:80ab0d068708 97 return update(0, 0, button, 0);
samux 1:80ab0d068708 98 }
samux 1:80ab0d068708 99
samux 1:80ab0d068708 100 bool USBMouse::release(uint8_t button_) {
samux 1:80ab0d068708 101 button = (button & (~button_)) & 0x07;
samux 1:80ab0d068708 102 return update(0, 0, button, 0);
samux 1:80ab0d068708 103 }
samux 1:80ab0d068708 104
samux 1:80ab0d068708 105
samux 1:80ab0d068708 106 uint8_t * USBMouse::reportDesc() {
samux 1:80ab0d068708 107
samux 1:80ab0d068708 108 if (mouse_type == REL_MOUSE) {
samux 1:80ab0d068708 109 static uint8_t reportDescriptor[] = {
samux 1:80ab0d068708 110 USAGE_PAGE(1), 0x01, // Genric Desktop
samux 1:80ab0d068708 111 USAGE(1), 0x02, // Mouse
samux 1:80ab0d068708 112 COLLECTION(1), 0x01, // Application
samux 1:80ab0d068708 113 USAGE(1), 0x01, // Pointer
samux 1:80ab0d068708 114 COLLECTION(1), 0x00, // Physical
samux 1:80ab0d068708 115
samux 1:80ab0d068708 116 REPORT_COUNT(1), 0x03,
samux 1:80ab0d068708 117 REPORT_SIZE(1), 0x01,
samux 1:80ab0d068708 118 USAGE_PAGE(1), 0x09, // Buttons
samux 1:80ab0d068708 119 USAGE_MINIMUM(1), 0x1,
samux 1:80ab0d068708 120 USAGE_MAXIMUM(1), 0x3,
samux 1:80ab0d068708 121 LOGICAL_MINIMUM(1), 0x00,
samux 1:80ab0d068708 122 LOGICAL_MAXIMUM(1), 0x01,
samux 1:80ab0d068708 123 INPUT(1), 0x02,
samux 1:80ab0d068708 124 REPORT_COUNT(1), 0x01,
samux 1:80ab0d068708 125 REPORT_SIZE(1), 0x05,
samux 1:80ab0d068708 126 INPUT(1), 0x01,
samux 1:80ab0d068708 127
samux 1:80ab0d068708 128 REPORT_COUNT(1), 0x03,
samux 1:80ab0d068708 129 REPORT_SIZE(1), 0x08,
samux 1:80ab0d068708 130 USAGE_PAGE(1), 0x01,
samux 1:80ab0d068708 131 USAGE(1), 0x30, // X
samux 1:80ab0d068708 132 USAGE(1), 0x31, // Y
samux 1:80ab0d068708 133 USAGE(1), 0x38, // scroll
samux 1:80ab0d068708 134 LOGICAL_MINIMUM(1), 0x81,
samux 1:80ab0d068708 135 LOGICAL_MAXIMUM(1), 0x7f,
samux 1:80ab0d068708 136 INPUT(1), 0x06, // Relative data
samux 1:80ab0d068708 137
samux 1:80ab0d068708 138 END_COLLECTION(0),
samux 1:80ab0d068708 139 END_COLLECTION(0),
samux 1:80ab0d068708 140 };
samux 1:80ab0d068708 141 reportLength = sizeof(reportDescriptor);
samux 1:80ab0d068708 142 return reportDescriptor;
samux 1:80ab0d068708 143 } else if (mouse_type == ABS_MOUSE) {
samux 1:80ab0d068708 144 static uint8_t reportDescriptor[] = {
samux 1:80ab0d068708 145
samux 1:80ab0d068708 146 USAGE_PAGE(1), 0x01, // Generic Desktop
samux 1:80ab0d068708 147 USAGE(1), 0x02, // Mouse
samux 1:80ab0d068708 148 COLLECTION(1), 0x01, // Application
samux 1:80ab0d068708 149 USAGE(1), 0x01, // Pointer
samux 1:80ab0d068708 150 COLLECTION(1), 0x00, // Physical
samux 1:80ab0d068708 151
samux 1:80ab0d068708 152 USAGE_PAGE(1), 0x01, // Generic Desktop
samux 1:80ab0d068708 153 USAGE(1), 0x30, // X
samux 1:80ab0d068708 154 USAGE(1), 0x31, // Y
samux 1:80ab0d068708 155 LOGICAL_MINIMUM(1), 0x00, // 0
samux 1:80ab0d068708 156 LOGICAL_MAXIMUM(2), 0xff, 0x7f, // 32767
samux 1:80ab0d068708 157 REPORT_SIZE(1), 0x10,
samux 1:80ab0d068708 158 REPORT_COUNT(1), 0x02,
samux 1:80ab0d068708 159 INPUT(1), 0x02, // Data, Variable, Absolute
samux 1:80ab0d068708 160
samux 1:80ab0d068708 161 USAGE_PAGE(1), 0x01, // Generic Desktop
samux 1:80ab0d068708 162 USAGE(1), 0x38, // scroll
samux 1:80ab0d068708 163 LOGICAL_MINIMUM(1), 0x81, // -127
samux 1:80ab0d068708 164 LOGICAL_MAXIMUM(1), 0x7f, // 127
samux 1:80ab0d068708 165 REPORT_SIZE(1), 0x08,
samux 1:80ab0d068708 166 REPORT_COUNT(1), 0x01,
samux 1:80ab0d068708 167 INPUT(1), 0x06, // Data, Variable, Relative
samux 1:80ab0d068708 168
samux 1:80ab0d068708 169 USAGE_PAGE(1), 0x09, // Buttons
samux 1:80ab0d068708 170 USAGE_MINIMUM(1), 0x01,
samux 1:80ab0d068708 171 USAGE_MAXIMUM(1), 0x03,
samux 1:80ab0d068708 172 LOGICAL_MINIMUM(1), 0x00, // 0
samux 1:80ab0d068708 173 LOGICAL_MAXIMUM(1), 0x01, // 1
samux 1:80ab0d068708 174 REPORT_COUNT(1), 0x03,
samux 1:80ab0d068708 175 REPORT_SIZE(1), 0x01,
samux 1:80ab0d068708 176 INPUT(1), 0x02, // Data, Variable, Absolute
samux 1:80ab0d068708 177 REPORT_COUNT(1), 0x01,
samux 1:80ab0d068708 178 REPORT_SIZE(1), 0x05,
samux 1:80ab0d068708 179 INPUT(1), 0x01, // Constant
samux 1:80ab0d068708 180
samux 1:80ab0d068708 181 END_COLLECTION(0),
samux 1:80ab0d068708 182 END_COLLECTION(0)
samux 1:80ab0d068708 183 };
samux 1:80ab0d068708 184 reportLength = sizeof(reportDescriptor);
samux 1:80ab0d068708 185 return reportDescriptor;
samux 1:80ab0d068708 186 }
samux 1:80ab0d068708 187 return NULL;
samux 1:80ab0d068708 188 }
samux 1:80ab0d068708 189
samux 1:80ab0d068708 190 #define DEFAULT_CONFIGURATION (1)
samux 1:80ab0d068708 191 #define TOTAL_DESCRIPTOR_LENGTH ((1 * CONFIGURATION_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 192 + (1 * INTERFACE_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 193 + (1 * HID_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 194 + (2 * ENDPOINT_DESCRIPTOR_LENGTH))
samux 1:80ab0d068708 195
samux 1:80ab0d068708 196 uint8_t * USBMouse::configurationDesc() {
samux 1:80ab0d068708 197 static uint8_t configurationDescriptor[] = {
samux 1:80ab0d068708 198 CONFIGURATION_DESCRIPTOR_LENGTH,// bLength
samux 1:80ab0d068708 199 CONFIGURATION_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 200 LSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (LSB)
samux 1:80ab0d068708 201 MSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (MSB)
samux 1:80ab0d068708 202 0x01, // bNumInterfaces
samux 1:80ab0d068708 203 DEFAULT_CONFIGURATION, // bConfigurationValue
samux 1:80ab0d068708 204 0x00, // iConfiguration
samux 1:80ab0d068708 205 C_RESERVED | C_SELF_POWERED, // bmAttributes
samux 1:80ab0d068708 206 C_POWER(0), // bMaxPowerHello World from Mbed
samux 1:80ab0d068708 207
samux 1:80ab0d068708 208 INTERFACE_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 209 INTERFACE_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 210 0x00, // bInterfaceNumber
samux 1:80ab0d068708 211 0x00, // bAlternateSetting
samux 1:80ab0d068708 212 0x02, // bNumEndpoints
samux 1:80ab0d068708 213 HID_CLASS, // bInterfaceClass
samux 1:80ab0d068708 214 1, // bInterfaceSubClass
samux 1:80ab0d068708 215 2, // bInterfaceProtocol (mouse)
samux 1:80ab0d068708 216 0x00, // iInterface
samux 1:80ab0d068708 217
samux 1:80ab0d068708 218 HID_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 219 HID_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 220 LSB(HID_VERSION_1_11), // bcdHID (LSB)
samux 1:80ab0d068708 221 MSB(HID_VERSION_1_11), // bcdHID (MSB)
samux 1:80ab0d068708 222 0x00, // bCountryCode
samux 1:80ab0d068708 223 0x01, // bNumDescriptors
samux 1:80ab0d068708 224 REPORT_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 225 LSB(reportDescLength()), // wDescriptorLength (LSB)
samux 1:80ab0d068708 226 MSB(reportDescLength()), // wDescriptorLength (MSB)
samux 1:80ab0d068708 227
samux 1:80ab0d068708 228 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 229 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 230 PHY_TO_DESC(EPINT_IN), // bEndpointAddress
samux 1:80ab0d068708 231 E_INTERRUPT, // bmAttributes
samux 1:80ab0d068708 232 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
samux 1:80ab0d068708 233 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
samux 1:80ab0d068708 234 1, // bInterval (milliseconds)
samux 1:80ab0d068708 235
samux 1:80ab0d068708 236 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 237 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 238 PHY_TO_DESC(EPINT_OUT), // bEndpointAddress
samux 1:80ab0d068708 239 E_INTERRUPT, // bmAttributes
samux 1:80ab0d068708 240 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
samux 1:80ab0d068708 241 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
samux 1:80ab0d068708 242 1, // bInterval (milliseconds)
samux 1:80ab0d068708 243 };
samux 1:80ab0d068708 244 return configurationDescriptor;
samux 1:80ab0d068708 245 }