Patrick Pollet / USBDevice

usb device

USBHID/USBMouse.cpp@0:c1e89c49eae5, 2022-05-14 (annotated)

Committer:
ppo
Date:
Sat May 14 17:24:10 2022 +0000
Revision:
0:c1e89c49eae5
commit

Who changed what in which revision?

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