Mihail Stoyanov / USBDevice

Fork of the official USBDevice library

Fork of USBDevice by mbed official

USBHID/USBMouse.cpp@73:8d28a0cb7b43, 2017-04-28 (annotated)

Committer:
screamer
Date:
Fri Apr 28 11:26:51 2017 +0100
Branch:
github-merge
Revision:
73:8d28a0cb7b43
Parent:
11:eeb3cbbaa996 
Merge from mbed-os @ github

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 73:8d28a0cb7b43 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
screamer 73:8d28a0cb7b43 2 *
screamer 73:8d28a0cb7b43 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
screamer 73:8d28a0cb7b43 4 * and associated documentation files (the "Software"), to deal in the Software without
screamer 73:8d28a0cb7b43 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
screamer 73:8d28a0cb7b43 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
screamer 73:8d28a0cb7b43 7 * Software is furnished to do so, subject to the following conditions:
screamer 73:8d28a0cb7b43 8 *
screamer 73:8d28a0cb7b43 9 * The above copyright notice and this permission notice shall be included in all copies or
screamer 73:8d28a0cb7b43 10 * substantial portions of the Software.
screamer 73:8d28a0cb7b43 11 *
screamer 73:8d28a0cb7b43 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
screamer 73:8d28a0cb7b43 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
screamer 73:8d28a0cb7b43 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
screamer 73:8d28a0cb7b43 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
screamer 73:8d28a0cb7b43 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
screamer 73:8d28a0cb7b43 17 */
screamer 73:8d28a0cb7b43 18
screamer 73:8d28a0cb7b43 19 #include "stdint.h"
screamer 73:8d28a0cb7b43 20 #include "USBMouse.h"
screamer 73:8d28a0cb7b43 21
screamer 73:8d28a0cb7b43 22 bool USBMouse::update(int16_t x, int16_t y, uint8_t button, int8_t z) {
screamer 73:8d28a0cb7b43 23 switch (mouse_type) {
screamer 73:8d28a0cb7b43 24 case REL_MOUSE:
screamer 73:8d28a0cb7b43 25 while (x > 127) {
screamer 73:8d28a0cb7b43 26 if (!mouseSend(127, 0, button, z)) return false;
screamer 73:8d28a0cb7b43 27 x = x - 127;
screamer 73:8d28a0cb7b43 28 }
screamer 73:8d28a0cb7b43 29 while (x < -128) {
screamer 73:8d28a0cb7b43 30 if (!mouseSend(-128, 0, button, z)) return false;
screamer 73:8d28a0cb7b43 31 x = x + 128;
screamer 73:8d28a0cb7b43 32 }
screamer 73:8d28a0cb7b43 33 while (y > 127) {
screamer 73:8d28a0cb7b43 34 if (!mouseSend(0, 127, button, z)) return false;
screamer 73:8d28a0cb7b43 35 y = y - 127;
screamer 73:8d28a0cb7b43 36 }
screamer 73:8d28a0cb7b43 37 while (y < -128) {
screamer 73:8d28a0cb7b43 38 if (!mouseSend(0, -128, button, z)) return false;
screamer 73:8d28a0cb7b43 39 y = y + 128;
screamer 73:8d28a0cb7b43 40 }
screamer 73:8d28a0cb7b43 41 return mouseSend(x, y, button, z);
screamer 73:8d28a0cb7b43 42 case ABS_MOUSE:
screamer 73:8d28a0cb7b43 43 HID_REPORT report;
screamer 73:8d28a0cb7b43 44
screamer 73:8d28a0cb7b43 45 report.data[0] = x & 0xff;
screamer 73:8d28a0cb7b43 46 report.data[1] = (x >> 8) & 0xff;
screamer 73:8d28a0cb7b43 47 report.data[2] = y & 0xff;
screamer 73:8d28a0cb7b43 48 report.data[3] = (y >> 8) & 0xff;
screamer 73:8d28a0cb7b43 49 report.data[4] = -z;
screamer 73:8d28a0cb7b43 50 report.data[5] = button & 0x07;
screamer 73:8d28a0cb7b43 51
screamer 73:8d28a0cb7b43 52 report.length = 6;
screamer 73:8d28a0cb7b43 53
screamer 73:8d28a0cb7b43 54 return send(&report);
screamer 73:8d28a0cb7b43 55 default:
screamer 73:8d28a0cb7b43 56 return false;
screamer 73:8d28a0cb7b43 57 }
screamer 73:8d28a0cb7b43 58 }
screamer 73:8d28a0cb7b43 59
screamer 73:8d28a0cb7b43 60 bool USBMouse::mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z) {
screamer 73:8d28a0cb7b43 61 HID_REPORT report;
screamer 73:8d28a0cb7b43 62 report.data[0] = buttons & 0x07;
screamer 73:8d28a0cb7b43 63 report.data[1] = x;
screamer 73:8d28a0cb7b43 64 report.data[2] = y;
screamer 73:8d28a0cb7b43 65 report.data[3] = -z; // >0 to scroll down, <0 to scroll up
screamer 73:8d28a0cb7b43 66
screamer 73:8d28a0cb7b43 67 report.length = 4;
screamer 73:8d28a0cb7b43 68
screamer 73:8d28a0cb7b43 69 return send(&report);
screamer 73:8d28a0cb7b43 70 }
screamer 73:8d28a0cb7b43 71
screamer 73:8d28a0cb7b43 72 bool USBMouse::move(int16_t x, int16_t y) {
screamer 73:8d28a0cb7b43 73 return update(x, y, button, 0);
screamer 73:8d28a0cb7b43 74 }
screamer 73:8d28a0cb7b43 75
screamer 73:8d28a0cb7b43 76 bool USBMouse::scroll(int8_t z) {
screamer 73:8d28a0cb7b43 77 return update(0, 0, button, z);
screamer 73:8d28a0cb7b43 78 }
screamer 73:8d28a0cb7b43 79
screamer 73:8d28a0cb7b43 80
screamer 73:8d28a0cb7b43 81 bool USBMouse::doubleClick() {
screamer 73:8d28a0cb7b43 82 if (!click(MOUSE_LEFT))
screamer 73:8d28a0cb7b43 83 return false;
screamer 73:8d28a0cb7b43 84 wait(0.1);
screamer 73:8d28a0cb7b43 85 return click(MOUSE_LEFT);
screamer 73:8d28a0cb7b43 86 }
screamer 73:8d28a0cb7b43 87
screamer 73:8d28a0cb7b43 88 bool USBMouse::click(uint8_t button) {
screamer 73:8d28a0cb7b43 89 if (!update(0, 0, button, 0))
screamer 73:8d28a0cb7b43 90 return false;
screamer 73:8d28a0cb7b43 91 wait(0.01);
screamer 73:8d28a0cb7b43 92 return update(0, 0, 0, 0);
screamer 73:8d28a0cb7b43 93 }
screamer 73:8d28a0cb7b43 94
screamer 73:8d28a0cb7b43 95 bool USBMouse::press(uint8_t button_) {
screamer 73:8d28a0cb7b43 96 button = button_ & 0x07;
screamer 73:8d28a0cb7b43 97 return update(0, 0, button, 0);
screamer 73:8d28a0cb7b43 98 }
screamer 73:8d28a0cb7b43 99
screamer 73:8d28a0cb7b43 100 bool USBMouse::release(uint8_t button_) {
screamer 73:8d28a0cb7b43 101 button = (button & (~button_)) & 0x07;
screamer 73:8d28a0cb7b43 102 return update(0, 0, button, 0);
screamer 73:8d28a0cb7b43 103 }
screamer 73:8d28a0cb7b43 104
screamer 73:8d28a0cb7b43 105
screamer 73:8d28a0cb7b43 106 uint8_t * USBMouse::reportDesc() {
screamer 73:8d28a0cb7b43 107
screamer 73:8d28a0cb7b43 108 if (mouse_type == REL_MOUSE) {
screamer 73:8d28a0cb7b43 109 static uint8_t reportDescriptor[] = {
screamer 73:8d28a0cb7b43 110 USAGE_PAGE(1), 0x01, // Genric Desktop
screamer 73:8d28a0cb7b43 111 USAGE(1), 0x02, // Mouse
screamer 73:8d28a0cb7b43 112 COLLECTION(1), 0x01, // Application
screamer 73:8d28a0cb7b43 113 USAGE(1), 0x01, // Pointer
screamer 73:8d28a0cb7b43 114 COLLECTION(1), 0x00, // Physical
screamer 73:8d28a0cb7b43 115
screamer 73:8d28a0cb7b43 116 REPORT_COUNT(1), 0x03,
screamer 73:8d28a0cb7b43 117 REPORT_SIZE(1), 0x01,
screamer 73:8d28a0cb7b43 118 USAGE_PAGE(1), 0x09, // Buttons
screamer 73:8d28a0cb7b43 119 USAGE_MINIMUM(1), 0x1,
screamer 73:8d28a0cb7b43 120 USAGE_MAXIMUM(1), 0x3,
screamer 73:8d28a0cb7b43 121 LOGICAL_MINIMUM(1), 0x00,
screamer 73:8d28a0cb7b43 122 LOGICAL_MAXIMUM(1), 0x01,
screamer 73:8d28a0cb7b43 123 INPUT(1), 0x02,
screamer 73:8d28a0cb7b43 124 REPORT_COUNT(1), 0x01,
screamer 73:8d28a0cb7b43 125 REPORT_SIZE(1), 0x05,
screamer 73:8d28a0cb7b43 126 INPUT(1), 0x01,
screamer 73:8d28a0cb7b43 127
screamer 73:8d28a0cb7b43 128 REPORT_COUNT(1), 0x03,
screamer 73:8d28a0cb7b43 129 REPORT_SIZE(1), 0x08,
screamer 73:8d28a0cb7b43 130 USAGE_PAGE(1), 0x01,
screamer 73:8d28a0cb7b43 131 USAGE(1), 0x30, // X
screamer 73:8d28a0cb7b43 132 USAGE(1), 0x31, // Y
screamer 73:8d28a0cb7b43 133 USAGE(1), 0x38, // scroll
screamer 73:8d28a0cb7b43 134 LOGICAL_MINIMUM(1), 0x81,
screamer 73:8d28a0cb7b43 135 LOGICAL_MAXIMUM(1), 0x7f,
screamer 73:8d28a0cb7b43 136 INPUT(1), 0x06, // Relative data
screamer 73:8d28a0cb7b43 137
screamer 73:8d28a0cb7b43 138 END_COLLECTION(0),
screamer 73:8d28a0cb7b43 139 END_COLLECTION(0),
screamer 73:8d28a0cb7b43 140 };
screamer 73:8d28a0cb7b43 141 reportLength = sizeof(reportDescriptor);
screamer 73:8d28a0cb7b43 142 return reportDescriptor;
screamer 73:8d28a0cb7b43 143 } else if (mouse_type == ABS_MOUSE) {
screamer 73:8d28a0cb7b43 144 static uint8_t reportDescriptor[] = {
screamer 73:8d28a0cb7b43 145 USAGE_PAGE(1), 0x01, // Generic Desktop
screamer 73:8d28a0cb7b43 146 USAGE(1), 0x02, // Mouse
screamer 73:8d28a0cb7b43 147 COLLECTION(1), 0x01, // Application
screamer 73:8d28a0cb7b43 148 USAGE(1), 0x01, // Pointer
screamer 73:8d28a0cb7b43 149 COLLECTION(1), 0x00, // Physical
screamer 73:8d28a0cb7b43 150
screamer 73:8d28a0cb7b43 151 USAGE_PAGE(1), 0x01, // Generic Desktop
screamer 73:8d28a0cb7b43 152 USAGE(1), 0x30, // X
screamer 73:8d28a0cb7b43 153 USAGE(1), 0x31, // Y
screamer 73:8d28a0cb7b43 154 LOGICAL_MINIMUM(1), 0x00, // 0
screamer 73:8d28a0cb7b43 155 LOGICAL_MAXIMUM(2), 0xff, 0x7f, // 32767
screamer 73:8d28a0cb7b43 156 REPORT_SIZE(1), 0x10,
screamer 73:8d28a0cb7b43 157 REPORT_COUNT(1), 0x02,
screamer 73:8d28a0cb7b43 158 INPUT(1), 0x02, // Data, Variable, Absolute
screamer 73:8d28a0cb7b43 159
screamer 73:8d28a0cb7b43 160 USAGE_PAGE(1), 0x01, // Generic Desktop
screamer 73:8d28a0cb7b43 161 USAGE(1), 0x38, // scroll
screamer 73:8d28a0cb7b43 162 LOGICAL_MINIMUM(1), 0x81, // -127
screamer 73:8d28a0cb7b43 163 LOGICAL_MAXIMUM(1), 0x7f, // 127
screamer 73:8d28a0cb7b43 164 REPORT_SIZE(1), 0x08,
screamer 73:8d28a0cb7b43 165 REPORT_COUNT(1), 0x01,
screamer 73:8d28a0cb7b43 166 INPUT(1), 0x06, // Data, Variable, Relative
screamer 73:8d28a0cb7b43 167
screamer 73:8d28a0cb7b43 168 USAGE_PAGE(1), 0x09, // Buttons
screamer 73:8d28a0cb7b43 169 USAGE_MINIMUM(1), 0x01,
screamer 73:8d28a0cb7b43 170 USAGE_MAXIMUM(1), 0x03,
screamer 73:8d28a0cb7b43 171 LOGICAL_MINIMUM(1), 0x00, // 0
screamer 73:8d28a0cb7b43 172 LOGICAL_MAXIMUM(1), 0x01, // 1
screamer 73:8d28a0cb7b43 173 REPORT_COUNT(1), 0x03,
screamer 73:8d28a0cb7b43 174 REPORT_SIZE(1), 0x01,
screamer 73:8d28a0cb7b43 175 INPUT(1), 0x02, // Data, Variable, Absolute
screamer 73:8d28a0cb7b43 176 REPORT_COUNT(1), 0x01,
screamer 73:8d28a0cb7b43 177 REPORT_SIZE(1), 0x05,
screamer 73:8d28a0cb7b43 178 INPUT(1), 0x01, // Constant
screamer 73:8d28a0cb7b43 179
screamer 73:8d28a0cb7b43 180 END_COLLECTION(0),
screamer 73:8d28a0cb7b43 181 END_COLLECTION(0)
screamer 73:8d28a0cb7b43 182 };
screamer 73:8d28a0cb7b43 183 reportLength = sizeof(reportDescriptor);
screamer 73:8d28a0cb7b43 184 return reportDescriptor;
screamer 73:8d28a0cb7b43 185 }
screamer 73:8d28a0cb7b43 186 return NULL;
screamer 73:8d28a0cb7b43 187 }
screamer 73:8d28a0cb7b43 188
screamer 73:8d28a0cb7b43 189 #define DEFAULT_CONFIGURATION (1)
screamer 73:8d28a0cb7b43 190 #define TOTAL_DESCRIPTOR_LENGTH ((1 * CONFIGURATION_DESCRIPTOR_LENGTH) \
screamer 73:8d28a0cb7b43 191 + (1 * INTERFACE_DESCRIPTOR_LENGTH) \
screamer 73:8d28a0cb7b43 192 + (1 * HID_DESCRIPTOR_LENGTH) \
screamer 73:8d28a0cb7b43 193 + (2 * ENDPOINT_DESCRIPTOR_LENGTH))
screamer 73:8d28a0cb7b43 194
screamer 73:8d28a0cb7b43 195 uint8_t * USBMouse::configurationDesc() {
screamer 73:8d28a0cb7b43 196 static uint8_t configurationDescriptor[] = {
screamer 73:8d28a0cb7b43 197 CONFIGURATION_DESCRIPTOR_LENGTH, // bLength
screamer 73:8d28a0cb7b43 198 CONFIGURATION_DESCRIPTOR, // bDescriptorType
screamer 73:8d28a0cb7b43 199 LSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (LSB)
screamer 73:8d28a0cb7b43 200 MSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (MSB)
screamer 73:8d28a0cb7b43 201 0x01, // bNumInterfaces
screamer 73:8d28a0cb7b43 202 DEFAULT_CONFIGURATION, // bConfigurationValue
screamer 73:8d28a0cb7b43 203 0x00, // iConfiguration
screamer 73:8d28a0cb7b43 204 C_RESERVED | C_SELF_POWERED, // bmAttributes
screamer 73:8d28a0cb7b43 205 C_POWER(0), // bMaxPower
screamer 73:8d28a0cb7b43 206
screamer 73:8d28a0cb7b43 207 INTERFACE_DESCRIPTOR_LENGTH, // bLength
screamer 73:8d28a0cb7b43 208 INTERFACE_DESCRIPTOR, // bDescriptorType
screamer 73:8d28a0cb7b43 209 0x00, // bInterfaceNumber
screamer 73:8d28a0cb7b43 210 0x00, // bAlternateSetting
screamer 73:8d28a0cb7b43 211 0x02, // bNumEndpoints
screamer 73:8d28a0cb7b43 212 HID_CLASS, // bInterfaceClass
screamer 73:8d28a0cb7b43 213 HID_SUBCLASS_BOOT, // bInterfaceSubClass
screamer 73:8d28a0cb7b43 214 HID_PROTOCOL_MOUSE, // bInterfaceProtocol
screamer 73:8d28a0cb7b43 215 0x00, // iInterface
screamer 73:8d28a0cb7b43 216
screamer 73:8d28a0cb7b43 217 HID_DESCRIPTOR_LENGTH, // bLength
screamer 73:8d28a0cb7b43 218 HID_DESCRIPTOR, // bDescriptorType
screamer 73:8d28a0cb7b43 219 LSB(HID_VERSION_1_11), // bcdHID (LSB)
screamer 73:8d28a0cb7b43 220 MSB(HID_VERSION_1_11), // bcdHID (MSB)
screamer 73:8d28a0cb7b43 221 0x00, // bCountryCode
screamer 73:8d28a0cb7b43 222 0x01, // bNumDescriptors
screamer 73:8d28a0cb7b43 223 REPORT_DESCRIPTOR, // bDescriptorType
screamer 73:8d28a0cb7b43 224 (uint8_t)(LSB(reportDescLength())), // wDescriptorLength (LSB)
screamer 73:8d28a0cb7b43 225 (uint8_t)(MSB(reportDescLength())), // wDescriptorLength (MSB)
screamer 73:8d28a0cb7b43 226
screamer 73:8d28a0cb7b43 227 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
screamer 73:8d28a0cb7b43 228 ENDPOINT_DESCRIPTOR, // bDescriptorType
screamer 73:8d28a0cb7b43 229 PHY_TO_DESC(EPINT_IN), // bEndpointAddress
screamer 73:8d28a0cb7b43 230 E_INTERRUPT, // bmAttributes
screamer 73:8d28a0cb7b43 231 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
screamer 73:8d28a0cb7b43 232 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
screamer 73:8d28a0cb7b43 233 1, // bInterval (milliseconds)
screamer 73:8d28a0cb7b43 234
screamer 73:8d28a0cb7b43 235 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
screamer 73:8d28a0cb7b43 236 ENDPOINT_DESCRIPTOR, // bDescriptorType
screamer 73:8d28a0cb7b43 237 PHY_TO_DESC(EPINT_OUT), // bEndpointAddress
screamer 73:8d28a0cb7b43 238 E_INTERRUPT, // bmAttributes
screamer 73:8d28a0cb7b43 239 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
screamer 73:8d28a0cb7b43 240 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
screamer 73:8d28a0cb7b43 241 1, // bInterval (milliseconds)
screamer 73:8d28a0cb7b43 242 };
screamer 73:8d28a0cb7b43 243 return configurationDescriptor;
screamer 73:8d28a0cb7b43 244 }