1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * HID driver for Logitech receivers 4 * 5 * Copyright (c) 2011 Logitech 6 */ 7 8 9 10 #include <linux/device.h> 11 #include <linux/hid.h> 12 #include <linux/module.h> 13 #include <linux/kfifo.h> 14 #include <linux/delay.h> 15 #include <linux/usb.h> /* For to_usb_interface for kvm extra intf check */ 16 #include <asm/unaligned.h> 17 #include "hid-ids.h" 18 19 #define DJ_MAX_PAIRED_DEVICES 7 20 #define DJ_MAX_NUMBER_NOTIFS 8 21 #define DJ_RECEIVER_INDEX 0 22 #define DJ_DEVICE_INDEX_MIN 1 23 #define DJ_DEVICE_INDEX_MAX 7 24 25 #define DJREPORT_SHORT_LENGTH 15 26 #define DJREPORT_LONG_LENGTH 32 27 28 #define REPORT_ID_DJ_SHORT 0x20 29 #define REPORT_ID_DJ_LONG 0x21 30 31 #define REPORT_ID_HIDPP_SHORT 0x10 32 #define REPORT_ID_HIDPP_LONG 0x11 33 #define REPORT_ID_HIDPP_VERY_LONG 0x12 34 35 #define HIDPP_REPORT_SHORT_LENGTH 7 36 #define HIDPP_REPORT_LONG_LENGTH 20 37 38 #define HIDPP_RECEIVER_INDEX 0xff 39 40 #define REPORT_TYPE_RFREPORT_FIRST 0x01 41 #define REPORT_TYPE_RFREPORT_LAST 0x1F 42 43 /* Command Switch to DJ mode */ 44 #define REPORT_TYPE_CMD_SWITCH 0x80 45 #define CMD_SWITCH_PARAM_DEVBITFIELD 0x00 46 #define CMD_SWITCH_PARAM_TIMEOUT_SECONDS 0x01 47 #define TIMEOUT_NO_KEEPALIVE 0x00 48 49 /* Command to Get the list of Paired devices */ 50 #define REPORT_TYPE_CMD_GET_PAIRED_DEVICES 0x81 51 52 /* Device Paired Notification */ 53 #define REPORT_TYPE_NOTIF_DEVICE_PAIRED 0x41 54 #define SPFUNCTION_MORE_NOTIF_EXPECTED 0x01 55 #define SPFUNCTION_DEVICE_LIST_EMPTY 0x02 56 #define DEVICE_PAIRED_PARAM_SPFUNCTION 0x00 57 #define DEVICE_PAIRED_PARAM_EQUAD_ID_LSB 0x01 58 #define DEVICE_PAIRED_PARAM_EQUAD_ID_MSB 0x02 59 #define DEVICE_PAIRED_RF_REPORT_TYPE 0x03 60 61 /* Device Un-Paired Notification */ 62 #define REPORT_TYPE_NOTIF_DEVICE_UNPAIRED 0x40 63 64 /* Connection Status Notification */ 65 #define REPORT_TYPE_NOTIF_CONNECTION_STATUS 0x42 66 #define CONNECTION_STATUS_PARAM_STATUS 0x00 67 #define STATUS_LINKLOSS 0x01 68 69 /* Error Notification */ 70 #define REPORT_TYPE_NOTIF_ERROR 0x7F 71 #define NOTIF_ERROR_PARAM_ETYPE 0x00 72 #define ETYPE_KEEPALIVE_TIMEOUT 0x01 73 74 /* supported DJ HID && RF report types */ 75 #define REPORT_TYPE_KEYBOARD 0x01 76 #define REPORT_TYPE_MOUSE 0x02 77 #define REPORT_TYPE_CONSUMER_CONTROL 0x03 78 #define REPORT_TYPE_SYSTEM_CONTROL 0x04 79 #define REPORT_TYPE_MEDIA_CENTER 0x08 80 #define REPORT_TYPE_LEDS 0x0E 81 82 /* RF Report types bitfield */ 83 #define STD_KEYBOARD BIT(1) 84 #define STD_MOUSE BIT(2) 85 #define MULTIMEDIA BIT(3) 86 #define POWER_KEYS BIT(4) 87 #define KBD_MOUSE BIT(5) 88 #define MEDIA_CENTER BIT(8) 89 #define KBD_LEDS BIT(14) 90 /* Fake (bitnr > NUMBER_OF_HID_REPORTS) bit to track HID++ capability */ 91 #define HIDPP BIT_ULL(63) 92 93 /* HID++ Device Connected Notification */ 94 #define REPORT_TYPE_NOTIF_DEVICE_CONNECTED 0x41 95 #define HIDPP_PARAM_PROTO_TYPE 0x00 96 #define HIDPP_PARAM_DEVICE_INFO 0x01 97 #define HIDPP_PARAM_EQUAD_LSB 0x02 98 #define HIDPP_PARAM_EQUAD_MSB 0x03 99 #define HIDPP_PARAM_27MHZ_DEVID 0x03 100 #define HIDPP_DEVICE_TYPE_MASK GENMASK(3, 0) 101 #define HIDPP_LINK_STATUS_MASK BIT(6) 102 #define HIDPP_MANUFACTURER_MASK BIT(7) 103 104 #define HIDPP_DEVICE_TYPE_KEYBOARD 1 105 #define HIDPP_DEVICE_TYPE_MOUSE 2 106 107 #define HIDPP_SET_REGISTER 0x80 108 #define HIDPP_GET_LONG_REGISTER 0x83 109 #define HIDPP_REG_CONNECTION_STATE 0x02 110 #define HIDPP_REG_PAIRING_INFORMATION 0xB5 111 #define HIDPP_PAIRING_INFORMATION 0x20 112 #define HIDPP_FAKE_DEVICE_ARRIVAL 0x02 113 114 enum recvr_type { 115 recvr_type_dj, 116 recvr_type_hidpp, 117 recvr_type_gaming_hidpp, 118 recvr_type_mouse_only, 119 recvr_type_27mhz, 120 recvr_type_bluetooth, 121 recvr_type_dinovo, 122 }; 123 124 struct dj_report { 125 u8 report_id; 126 u8 device_index; 127 u8 report_type; 128 u8 report_params[DJREPORT_SHORT_LENGTH - 3]; 129 }; 130 131 struct hidpp_event { 132 u8 report_id; 133 u8 device_index; 134 u8 sub_id; 135 u8 params[HIDPP_REPORT_LONG_LENGTH - 3U]; 136 } __packed; 137 138 struct dj_receiver_dev { 139 struct hid_device *mouse; 140 struct hid_device *keyboard; 141 struct hid_device *hidpp; 142 struct dj_device *paired_dj_devices[DJ_MAX_PAIRED_DEVICES + 143 DJ_DEVICE_INDEX_MIN]; 144 struct list_head list; 145 struct kref kref; 146 struct work_struct work; 147 struct kfifo notif_fifo; 148 unsigned long last_query; /* in jiffies */ 149 bool ready; 150 enum recvr_type type; 151 unsigned int unnumbered_application; 152 spinlock_t lock; 153 }; 154 155 struct dj_device { 156 struct hid_device *hdev; 157 struct dj_receiver_dev *dj_receiver_dev; 158 u64 reports_supported; 159 u8 device_index; 160 }; 161 162 #define WORKITEM_TYPE_EMPTY 0 163 #define WORKITEM_TYPE_PAIRED 1 164 #define WORKITEM_TYPE_UNPAIRED 2 165 #define WORKITEM_TYPE_UNKNOWN 255 166 167 struct dj_workitem { 168 u8 type; /* WORKITEM_TYPE_* */ 169 u8 device_index; 170 u8 device_type; 171 u8 quad_id_msb; 172 u8 quad_id_lsb; 173 u64 reports_supported; 174 }; 175 176 /* Keyboard descriptor (1) */ 177 static const char kbd_descriptor[] = { 178 0x05, 0x01, /* USAGE_PAGE (generic Desktop) */ 179 0x09, 0x06, /* USAGE (Keyboard) */ 180 0xA1, 0x01, /* COLLECTION (Application) */ 181 0x85, 0x01, /* REPORT_ID (1) */ 182 0x95, 0x08, /* REPORT_COUNT (8) */ 183 0x75, 0x01, /* REPORT_SIZE (1) */ 184 0x15, 0x00, /* LOGICAL_MINIMUM (0) */ 185 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ 186 0x05, 0x07, /* USAGE_PAGE (Keyboard) */ 187 0x19, 0xE0, /* USAGE_MINIMUM (Left Control) */ 188 0x29, 0xE7, /* USAGE_MAXIMUM (Right GUI) */ 189 0x81, 0x02, /* INPUT (Data,Var,Abs) */ 190 0x95, 0x06, /* REPORT_COUNT (6) */ 191 0x75, 0x08, /* REPORT_SIZE (8) */ 192 0x15, 0x00, /* LOGICAL_MINIMUM (0) */ 193 0x26, 0xFF, 0x00, /* LOGICAL_MAXIMUM (255) */ 194 0x05, 0x07, /* USAGE_PAGE (Keyboard) */ 195 0x19, 0x00, /* USAGE_MINIMUM (no event) */ 196 0x2A, 0xFF, 0x00, /* USAGE_MAXIMUM (reserved) */ 197 0x81, 0x00, /* INPUT (Data,Ary,Abs) */ 198 0x85, 0x0e, /* REPORT_ID (14) */ 199 0x05, 0x08, /* USAGE PAGE (LED page) */ 200 0x95, 0x05, /* REPORT COUNT (5) */ 201 0x75, 0x01, /* REPORT SIZE (1) */ 202 0x15, 0x00, /* LOGICAL_MINIMUM (0) */ 203 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ 204 0x19, 0x01, /* USAGE MINIMUM (1) */ 205 0x29, 0x05, /* USAGE MAXIMUM (5) */ 206 0x91, 0x02, /* OUTPUT (Data, Variable, Absolute) */ 207 0x95, 0x01, /* REPORT COUNT (1) */ 208 0x75, 0x03, /* REPORT SIZE (3) */ 209 0x91, 0x01, /* OUTPUT (Constant) */ 210 0xC0 211 }; 212 213 /* Mouse descriptor (2) */ 214 static const char mse_descriptor[] = { 215 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ 216 0x09, 0x02, /* USAGE (Mouse) */ 217 0xA1, 0x01, /* COLLECTION (Application) */ 218 0x85, 0x02, /* REPORT_ID = 2 */ 219 0x09, 0x01, /* USAGE (pointer) */ 220 0xA1, 0x00, /* COLLECTION (physical) */ 221 0x05, 0x09, /* USAGE_PAGE (buttons) */ 222 0x19, 0x01, /* USAGE_MIN (1) */ 223 0x29, 0x10, /* USAGE_MAX (16) */ 224 0x15, 0x00, /* LOGICAL_MIN (0) */ 225 0x25, 0x01, /* LOGICAL_MAX (1) */ 226 0x95, 0x10, /* REPORT_COUNT (16) */ 227 0x75, 0x01, /* REPORT_SIZE (1) */ 228 0x81, 0x02, /* INPUT (data var abs) */ 229 0x05, 0x01, /* USAGE_PAGE (generic desktop) */ 230 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */ 231 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */ 232 0x75, 0x0C, /* REPORT_SIZE (12) */ 233 0x95, 0x02, /* REPORT_COUNT (2) */ 234 0x09, 0x30, /* USAGE (X) */ 235 0x09, 0x31, /* USAGE (Y) */ 236 0x81, 0x06, /* INPUT */ 237 0x15, 0x81, /* LOGICAL_MIN (-127) */ 238 0x25, 0x7F, /* LOGICAL_MAX (127) */ 239 0x75, 0x08, /* REPORT_SIZE (8) */ 240 0x95, 0x01, /* REPORT_COUNT (1) */ 241 0x09, 0x38, /* USAGE (wheel) */ 242 0x81, 0x06, /* INPUT */ 243 0x05, 0x0C, /* USAGE_PAGE(consumer) */ 244 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */ 245 0x95, 0x01, /* REPORT_COUNT (1) */ 246 0x81, 0x06, /* INPUT */ 247 0xC0, /* END_COLLECTION */ 248 0xC0, /* END_COLLECTION */ 249 }; 250 251 /* Mouse descriptor (2) for 27 MHz receiver, only 8 buttons */ 252 static const char mse_27mhz_descriptor[] = { 253 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ 254 0x09, 0x02, /* USAGE (Mouse) */ 255 0xA1, 0x01, /* COLLECTION (Application) */ 256 0x85, 0x02, /* REPORT_ID = 2 */ 257 0x09, 0x01, /* USAGE (pointer) */ 258 0xA1, 0x00, /* COLLECTION (physical) */ 259 0x05, 0x09, /* USAGE_PAGE (buttons) */ 260 0x19, 0x01, /* USAGE_MIN (1) */ 261 0x29, 0x08, /* USAGE_MAX (8) */ 262 0x15, 0x00, /* LOGICAL_MIN (0) */ 263 0x25, 0x01, /* LOGICAL_MAX (1) */ 264 0x95, 0x08, /* REPORT_COUNT (8) */ 265 0x75, 0x01, /* REPORT_SIZE (1) */ 266 0x81, 0x02, /* INPUT (data var abs) */ 267 0x05, 0x01, /* USAGE_PAGE (generic desktop) */ 268 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */ 269 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */ 270 0x75, 0x0C, /* REPORT_SIZE (12) */ 271 0x95, 0x02, /* REPORT_COUNT (2) */ 272 0x09, 0x30, /* USAGE (X) */ 273 0x09, 0x31, /* USAGE (Y) */ 274 0x81, 0x06, /* INPUT */ 275 0x15, 0x81, /* LOGICAL_MIN (-127) */ 276 0x25, 0x7F, /* LOGICAL_MAX (127) */ 277 0x75, 0x08, /* REPORT_SIZE (8) */ 278 0x95, 0x01, /* REPORT_COUNT (1) */ 279 0x09, 0x38, /* USAGE (wheel) */ 280 0x81, 0x06, /* INPUT */ 281 0x05, 0x0C, /* USAGE_PAGE(consumer) */ 282 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */ 283 0x95, 0x01, /* REPORT_COUNT (1) */ 284 0x81, 0x06, /* INPUT */ 285 0xC0, /* END_COLLECTION */ 286 0xC0, /* END_COLLECTION */ 287 }; 288 289 /* Mouse descriptor (2) for Bluetooth receiver, low-res hwheel, 12 buttons */ 290 static const char mse_bluetooth_descriptor[] = { 291 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ 292 0x09, 0x02, /* USAGE (Mouse) */ 293 0xA1, 0x01, /* COLLECTION (Application) */ 294 0x85, 0x02, /* REPORT_ID = 2 */ 295 0x09, 0x01, /* USAGE (pointer) */ 296 0xA1, 0x00, /* COLLECTION (physical) */ 297 0x05, 0x09, /* USAGE_PAGE (buttons) */ 298 0x19, 0x01, /* USAGE_MIN (1) */ 299 0x29, 0x08, /* USAGE_MAX (8) */ 300 0x15, 0x00, /* LOGICAL_MIN (0) */ 301 0x25, 0x01, /* LOGICAL_MAX (1) */ 302 0x95, 0x08, /* REPORT_COUNT (8) */ 303 0x75, 0x01, /* REPORT_SIZE (1) */ 304 0x81, 0x02, /* INPUT (data var abs) */ 305 0x05, 0x01, /* USAGE_PAGE (generic desktop) */ 306 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */ 307 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */ 308 0x75, 0x0C, /* REPORT_SIZE (12) */ 309 0x95, 0x02, /* REPORT_COUNT (2) */ 310 0x09, 0x30, /* USAGE (X) */ 311 0x09, 0x31, /* USAGE (Y) */ 312 0x81, 0x06, /* INPUT */ 313 0x15, 0x81, /* LOGICAL_MIN (-127) */ 314 0x25, 0x7F, /* LOGICAL_MAX (127) */ 315 0x75, 0x08, /* REPORT_SIZE (8) */ 316 0x95, 0x01, /* REPORT_COUNT (1) */ 317 0x09, 0x38, /* USAGE (wheel) */ 318 0x81, 0x06, /* INPUT */ 319 0x05, 0x0C, /* USAGE_PAGE(consumer) */ 320 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */ 321 0x15, 0xF9, /* LOGICAL_MIN (-7) */ 322 0x25, 0x07, /* LOGICAL_MAX (7) */ 323 0x75, 0x04, /* REPORT_SIZE (4) */ 324 0x95, 0x01, /* REPORT_COUNT (1) */ 325 0x81, 0x06, /* INPUT */ 326 0x05, 0x09, /* USAGE_PAGE (buttons) */ 327 0x19, 0x09, /* USAGE_MIN (9) */ 328 0x29, 0x0C, /* USAGE_MAX (12) */ 329 0x15, 0x00, /* LOGICAL_MIN (0) */ 330 0x25, 0x01, /* LOGICAL_MAX (1) */ 331 0x75, 0x01, /* REPORT_SIZE (1) */ 332 0x95, 0x04, /* REPORT_COUNT (4) */ 333 0x81, 0x02, /* INPUT (Data,Var,Abs) */ 334 0xC0, /* END_COLLECTION */ 335 0xC0, /* END_COLLECTION */ 336 }; 337 338 /* Mouse descriptor (5) for Bluetooth receiver, normal-res hwheel, 8 buttons */ 339 static const char mse5_bluetooth_descriptor[] = { 340 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ 341 0x09, 0x02, /* Usage (Mouse) */ 342 0xa1, 0x01, /* Collection (Application) */ 343 0x85, 0x05, /* Report ID (5) */ 344 0x09, 0x01, /* Usage (Pointer) */ 345 0xa1, 0x00, /* Collection (Physical) */ 346 0x05, 0x09, /* Usage Page (Button) */ 347 0x19, 0x01, /* Usage Minimum (1) */ 348 0x29, 0x08, /* Usage Maximum (8) */ 349 0x15, 0x00, /* Logical Minimum (0) */ 350 0x25, 0x01, /* Logical Maximum (1) */ 351 0x95, 0x08, /* Report Count (8) */ 352 0x75, 0x01, /* Report Size (1) */ 353 0x81, 0x02, /* Input (Data,Var,Abs) */ 354 0x05, 0x01, /* Usage Page (Generic Desktop) */ 355 0x16, 0x01, 0xf8, /* Logical Minimum (-2047) */ 356 0x26, 0xff, 0x07, /* Logical Maximum (2047) */ 357 0x75, 0x0c, /* Report Size (12) */ 358 0x95, 0x02, /* Report Count (2) */ 359 0x09, 0x30, /* Usage (X) */ 360 0x09, 0x31, /* Usage (Y) */ 361 0x81, 0x06, /* Input (Data,Var,Rel) */ 362 0x15, 0x81, /* Logical Minimum (-127) */ 363 0x25, 0x7f, /* Logical Maximum (127) */ 364 0x75, 0x08, /* Report Size (8) */ 365 0x95, 0x01, /* Report Count (1) */ 366 0x09, 0x38, /* Usage (Wheel) */ 367 0x81, 0x06, /* Input (Data,Var,Rel) */ 368 0x05, 0x0c, /* Usage Page (Consumer Devices) */ 369 0x0a, 0x38, 0x02, /* Usage (AC Pan) */ 370 0x15, 0x81, /* Logical Minimum (-127) */ 371 0x25, 0x7f, /* Logical Maximum (127) */ 372 0x75, 0x08, /* Report Size (8) */ 373 0x95, 0x01, /* Report Count (1) */ 374 0x81, 0x06, /* Input (Data,Var,Rel) */ 375 0xc0, /* End Collection */ 376 0xc0, /* End Collection */ 377 }; 378 379 /* Gaming Mouse descriptor (2) */ 380 static const char mse_high_res_descriptor[] = { 381 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ 382 0x09, 0x02, /* USAGE (Mouse) */ 383 0xA1, 0x01, /* COLLECTION (Application) */ 384 0x85, 0x02, /* REPORT_ID = 2 */ 385 0x09, 0x01, /* USAGE (pointer) */ 386 0xA1, 0x00, /* COLLECTION (physical) */ 387 0x05, 0x09, /* USAGE_PAGE (buttons) */ 388 0x19, 0x01, /* USAGE_MIN (1) */ 389 0x29, 0x10, /* USAGE_MAX (16) */ 390 0x15, 0x00, /* LOGICAL_MIN (0) */ 391 0x25, 0x01, /* LOGICAL_MAX (1) */ 392 0x95, 0x10, /* REPORT_COUNT (16) */ 393 0x75, 0x01, /* REPORT_SIZE (1) */ 394 0x81, 0x02, /* INPUT (data var abs) */ 395 0x05, 0x01, /* USAGE_PAGE (generic desktop) */ 396 0x16, 0x01, 0x80, /* LOGICAL_MIN (-32767) */ 397 0x26, 0xFF, 0x7F, /* LOGICAL_MAX (32767) */ 398 0x75, 0x10, /* REPORT_SIZE (16) */ 399 0x95, 0x02, /* REPORT_COUNT (2) */ 400 0x09, 0x30, /* USAGE (X) */ 401 0x09, 0x31, /* USAGE (Y) */ 402 0x81, 0x06, /* INPUT */ 403 0x15, 0x81, /* LOGICAL_MIN (-127) */ 404 0x25, 0x7F, /* LOGICAL_MAX (127) */ 405 0x75, 0x08, /* REPORT_SIZE (8) */ 406 0x95, 0x01, /* REPORT_COUNT (1) */ 407 0x09, 0x38, /* USAGE (wheel) */ 408 0x81, 0x06, /* INPUT */ 409 0x05, 0x0C, /* USAGE_PAGE(consumer) */ 410 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */ 411 0x95, 0x01, /* REPORT_COUNT (1) */ 412 0x81, 0x06, /* INPUT */ 413 0xC0, /* END_COLLECTION */ 414 0xC0, /* END_COLLECTION */ 415 }; 416 417 /* Consumer Control descriptor (3) */ 418 static const char consumer_descriptor[] = { 419 0x05, 0x0C, /* USAGE_PAGE (Consumer Devices) */ 420 0x09, 0x01, /* USAGE (Consumer Control) */ 421 0xA1, 0x01, /* COLLECTION (Application) */ 422 0x85, 0x03, /* REPORT_ID = 3 */ 423 0x75, 0x10, /* REPORT_SIZE (16) */ 424 0x95, 0x02, /* REPORT_COUNT (2) */ 425 0x15, 0x01, /* LOGICAL_MIN (1) */ 426 0x26, 0xFF, 0x02, /* LOGICAL_MAX (767) */ 427 0x19, 0x01, /* USAGE_MIN (1) */ 428 0x2A, 0xFF, 0x02, /* USAGE_MAX (767) */ 429 0x81, 0x00, /* INPUT (Data Ary Abs) */ 430 0xC0, /* END_COLLECTION */ 431 }; /* */ 432 433 /* System control descriptor (4) */ 434 static const char syscontrol_descriptor[] = { 435 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ 436 0x09, 0x80, /* USAGE (System Control) */ 437 0xA1, 0x01, /* COLLECTION (Application) */ 438 0x85, 0x04, /* REPORT_ID = 4 */ 439 0x75, 0x02, /* REPORT_SIZE (2) */ 440 0x95, 0x01, /* REPORT_COUNT (1) */ 441 0x15, 0x01, /* LOGICAL_MIN (1) */ 442 0x25, 0x03, /* LOGICAL_MAX (3) */ 443 0x09, 0x82, /* USAGE (System Sleep) */ 444 0x09, 0x81, /* USAGE (System Power Down) */ 445 0x09, 0x83, /* USAGE (System Wake Up) */ 446 0x81, 0x60, /* INPUT (Data Ary Abs NPrf Null) */ 447 0x75, 0x06, /* REPORT_SIZE (6) */ 448 0x81, 0x03, /* INPUT (Cnst Var Abs) */ 449 0xC0, /* END_COLLECTION */ 450 }; 451 452 /* Media descriptor (8) */ 453 static const char media_descriptor[] = { 454 0x06, 0xbc, 0xff, /* Usage Page 0xffbc */ 455 0x09, 0x88, /* Usage 0x0088 */ 456 0xa1, 0x01, /* BeginCollection */ 457 0x85, 0x08, /* Report ID 8 */ 458 0x19, 0x01, /* Usage Min 0x0001 */ 459 0x29, 0xff, /* Usage Max 0x00ff */ 460 0x15, 0x01, /* Logical Min 1 */ 461 0x26, 0xff, 0x00, /* Logical Max 255 */ 462 0x75, 0x08, /* Report Size 8 */ 463 0x95, 0x01, /* Report Count 1 */ 464 0x81, 0x00, /* Input */ 465 0xc0, /* EndCollection */ 466 }; /* */ 467 468 /* HIDPP descriptor */ 469 static const char hidpp_descriptor[] = { 470 0x06, 0x00, 0xff, /* Usage Page (Vendor Defined Page 1) */ 471 0x09, 0x01, /* Usage (Vendor Usage 1) */ 472 0xa1, 0x01, /* Collection (Application) */ 473 0x85, 0x10, /* Report ID (16) */ 474 0x75, 0x08, /* Report Size (8) */ 475 0x95, 0x06, /* Report Count (6) */ 476 0x15, 0x00, /* Logical Minimum (0) */ 477 0x26, 0xff, 0x00, /* Logical Maximum (255) */ 478 0x09, 0x01, /* Usage (Vendor Usage 1) */ 479 0x81, 0x00, /* Input (Data,Arr,Abs) */ 480 0x09, 0x01, /* Usage (Vendor Usage 1) */ 481 0x91, 0x00, /* Output (Data,Arr,Abs) */ 482 0xc0, /* End Collection */ 483 0x06, 0x00, 0xff, /* Usage Page (Vendor Defined Page 1) */ 484 0x09, 0x02, /* Usage (Vendor Usage 2) */ 485 0xa1, 0x01, /* Collection (Application) */ 486 0x85, 0x11, /* Report ID (17) */ 487 0x75, 0x08, /* Report Size (8) */ 488 0x95, 0x13, /* Report Count (19) */ 489 0x15, 0x00, /* Logical Minimum (0) */ 490 0x26, 0xff, 0x00, /* Logical Maximum (255) */ 491 0x09, 0x02, /* Usage (Vendor Usage 2) */ 492 0x81, 0x00, /* Input (Data,Arr,Abs) */ 493 0x09, 0x02, /* Usage (Vendor Usage 2) */ 494 0x91, 0x00, /* Output (Data,Arr,Abs) */ 495 0xc0, /* End Collection */ 496 0x06, 0x00, 0xff, /* Usage Page (Vendor Defined Page 1) */ 497 0x09, 0x04, /* Usage (Vendor Usage 0x04) */ 498 0xa1, 0x01, /* Collection (Application) */ 499 0x85, 0x20, /* Report ID (32) */ 500 0x75, 0x08, /* Report Size (8) */ 501 0x95, 0x0e, /* Report Count (14) */ 502 0x15, 0x00, /* Logical Minimum (0) */ 503 0x26, 0xff, 0x00, /* Logical Maximum (255) */ 504 0x09, 0x41, /* Usage (Vendor Usage 0x41) */ 505 0x81, 0x00, /* Input (Data,Arr,Abs) */ 506 0x09, 0x41, /* Usage (Vendor Usage 0x41) */ 507 0x91, 0x00, /* Output (Data,Arr,Abs) */ 508 0x85, 0x21, /* Report ID (33) */ 509 0x95, 0x1f, /* Report Count (31) */ 510 0x15, 0x00, /* Logical Minimum (0) */ 511 0x26, 0xff, 0x00, /* Logical Maximum (255) */ 512 0x09, 0x42, /* Usage (Vendor Usage 0x42) */ 513 0x81, 0x00, /* Input (Data,Arr,Abs) */ 514 0x09, 0x42, /* Usage (Vendor Usage 0x42) */ 515 0x91, 0x00, /* Output (Data,Arr,Abs) */ 516 0xc0, /* End Collection */ 517 }; 518 519 /* Maximum size of all defined hid reports in bytes (including report id) */ 520 #define MAX_REPORT_SIZE 8 521 522 /* Make sure all descriptors are present here */ 523 #define MAX_RDESC_SIZE \ 524 (sizeof(kbd_descriptor) + \ 525 sizeof(mse_bluetooth_descriptor) + \ 526 sizeof(mse5_bluetooth_descriptor) + \ 527 sizeof(consumer_descriptor) + \ 528 sizeof(syscontrol_descriptor) + \ 529 sizeof(media_descriptor) + \ 530 sizeof(hidpp_descriptor)) 531 532 /* Number of possible hid report types that can be created by this driver. 533 * 534 * Right now, RF report types have the same report types (or report id's) 535 * than the hid report created from those RF reports. In the future 536 * this doesnt have to be true. 537 * 538 * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds 539 * to hid report id 0x01, this is standard keyboard. Same thing applies to mice 540 * reports and consumer control, etc. If a new RF report is created, it doesn't 541 * has to have the same report id as its corresponding hid report, so an 542 * translation may have to take place for future report types. 543 */ 544 #define NUMBER_OF_HID_REPORTS 32 545 static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = { 546 [1] = 8, /* Standard keyboard */ 547 [2] = 8, /* Standard mouse */ 548 [3] = 5, /* Consumer control */ 549 [4] = 2, /* System control */ 550 [8] = 2, /* Media Center */ 551 }; 552 553 554 #define LOGITECH_DJ_INTERFACE_NUMBER 0x02 555 556 static struct hid_ll_driver logi_dj_ll_driver; 557 558 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev); 559 static void delayedwork_callback(struct work_struct *work); 560 561 static LIST_HEAD(dj_hdev_list); 562 static DEFINE_MUTEX(dj_hdev_list_lock); 563 564 static bool recvr_type_is_bluetooth(enum recvr_type type) 565 { 566 return type == recvr_type_bluetooth || type == recvr_type_dinovo; 567 } 568 569 /* 570 * dj/HID++ receivers are really a single logical entity, but for BIOS/Windows 571 * compatibility they have multiple USB interfaces. On HID++ receivers we need 572 * to listen for input reports on both interfaces. The functions below are used 573 * to create a single struct dj_receiver_dev for all interfaces belonging to 574 * a single USB-device / receiver. 575 */ 576 static struct dj_receiver_dev *dj_find_receiver_dev(struct hid_device *hdev, 577 enum recvr_type type) 578 { 579 struct dj_receiver_dev *djrcv_dev; 580 char sep; 581 582 /* 583 * The bluetooth receiver contains a built-in hub and has separate 584 * USB-devices for the keyboard and mouse interfaces. 585 */ 586 sep = recvr_type_is_bluetooth(type) ? '.' : '/'; 587 588 /* Try to find an already-probed interface from the same device */ 589 list_for_each_entry(djrcv_dev, &dj_hdev_list, list) { 590 if (djrcv_dev->mouse && 591 hid_compare_device_paths(hdev, djrcv_dev->mouse, sep)) { 592 kref_get(&djrcv_dev->kref); 593 return djrcv_dev; 594 } 595 if (djrcv_dev->keyboard && 596 hid_compare_device_paths(hdev, djrcv_dev->keyboard, sep)) { 597 kref_get(&djrcv_dev->kref); 598 return djrcv_dev; 599 } 600 if (djrcv_dev->hidpp && 601 hid_compare_device_paths(hdev, djrcv_dev->hidpp, sep)) { 602 kref_get(&djrcv_dev->kref); 603 return djrcv_dev; 604 } 605 } 606 607 return NULL; 608 } 609 610 static void dj_release_receiver_dev(struct kref *kref) 611 { 612 struct dj_receiver_dev *djrcv_dev = container_of(kref, struct dj_receiver_dev, kref); 613 614 list_del(&djrcv_dev->list); 615 kfifo_free(&djrcv_dev->notif_fifo); 616 kfree(djrcv_dev); 617 } 618 619 static void dj_put_receiver_dev(struct hid_device *hdev) 620 { 621 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 622 623 mutex_lock(&dj_hdev_list_lock); 624 625 if (djrcv_dev->mouse == hdev) 626 djrcv_dev->mouse = NULL; 627 if (djrcv_dev->keyboard == hdev) 628 djrcv_dev->keyboard = NULL; 629 if (djrcv_dev->hidpp == hdev) 630 djrcv_dev->hidpp = NULL; 631 632 kref_put(&djrcv_dev->kref, dj_release_receiver_dev); 633 634 mutex_unlock(&dj_hdev_list_lock); 635 } 636 637 static struct dj_receiver_dev *dj_get_receiver_dev(struct hid_device *hdev, 638 enum recvr_type type, 639 unsigned int application, 640 bool is_hidpp) 641 { 642 struct dj_receiver_dev *djrcv_dev; 643 644 mutex_lock(&dj_hdev_list_lock); 645 646 djrcv_dev = dj_find_receiver_dev(hdev, type); 647 if (!djrcv_dev) { 648 djrcv_dev = kzalloc(sizeof(*djrcv_dev), GFP_KERNEL); 649 if (!djrcv_dev) 650 goto out; 651 652 INIT_WORK(&djrcv_dev->work, delayedwork_callback); 653 spin_lock_init(&djrcv_dev->lock); 654 if (kfifo_alloc(&djrcv_dev->notif_fifo, 655 DJ_MAX_NUMBER_NOTIFS * sizeof(struct dj_workitem), 656 GFP_KERNEL)) { 657 kfree(djrcv_dev); 658 djrcv_dev = NULL; 659 goto out; 660 } 661 kref_init(&djrcv_dev->kref); 662 list_add_tail(&djrcv_dev->list, &dj_hdev_list); 663 djrcv_dev->last_query = jiffies; 664 djrcv_dev->type = type; 665 } 666 667 if (application == HID_GD_KEYBOARD) 668 djrcv_dev->keyboard = hdev; 669 if (application == HID_GD_MOUSE) 670 djrcv_dev->mouse = hdev; 671 if (is_hidpp) 672 djrcv_dev->hidpp = hdev; 673 674 hid_set_drvdata(hdev, djrcv_dev); 675 out: 676 mutex_unlock(&dj_hdev_list_lock); 677 return djrcv_dev; 678 } 679 680 static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev, 681 struct dj_workitem *workitem) 682 { 683 /* Called in delayed work context */ 684 struct dj_device *dj_dev; 685 unsigned long flags; 686 687 spin_lock_irqsave(&djrcv_dev->lock, flags); 688 dj_dev = djrcv_dev->paired_dj_devices[workitem->device_index]; 689 djrcv_dev->paired_dj_devices[workitem->device_index] = NULL; 690 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 691 692 if (dj_dev != NULL) { 693 hid_destroy_device(dj_dev->hdev); 694 kfree(dj_dev); 695 } else { 696 hid_err(djrcv_dev->hidpp, "%s: can't destroy a NULL device\n", 697 __func__); 698 } 699 } 700 701 static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev, 702 struct dj_workitem *workitem) 703 { 704 /* Called in delayed work context */ 705 struct hid_device *djrcv_hdev = djrcv_dev->hidpp; 706 struct hid_device *dj_hiddev; 707 struct dj_device *dj_dev; 708 u8 device_index = workitem->device_index; 709 unsigned long flags; 710 711 /* Device index goes from 1 to 6, we need 3 bytes to store the 712 * semicolon, the index, and a null terminator 713 */ 714 unsigned char tmpstr[3]; 715 716 /* We are the only one ever adding a device, no need to lock */ 717 if (djrcv_dev->paired_dj_devices[device_index]) { 718 /* The device is already known. No need to reallocate it. */ 719 dbg_hid("%s: device is already known\n", __func__); 720 return; 721 } 722 723 dj_hiddev = hid_allocate_device(); 724 if (IS_ERR(dj_hiddev)) { 725 hid_err(djrcv_hdev, "%s: hid_allocate_dev failed\n", __func__); 726 return; 727 } 728 729 dj_hiddev->ll_driver = &logi_dj_ll_driver; 730 731 dj_hiddev->dev.parent = &djrcv_hdev->dev; 732 dj_hiddev->bus = BUS_USB; 733 dj_hiddev->vendor = djrcv_hdev->vendor; 734 dj_hiddev->product = (workitem->quad_id_msb << 8) | 735 workitem->quad_id_lsb; 736 if (workitem->device_type) { 737 const char *type_str = "Device"; 738 739 switch (workitem->device_type) { 740 case 0x01: type_str = "Keyboard"; break; 741 case 0x02: type_str = "Mouse"; break; 742 case 0x03: type_str = "Numpad"; break; 743 case 0x04: type_str = "Presenter"; break; 744 case 0x07: type_str = "Remote Control"; break; 745 case 0x08: type_str = "Trackball"; break; 746 case 0x09: type_str = "Touchpad"; break; 747 } 748 snprintf(dj_hiddev->name, sizeof(dj_hiddev->name), 749 "Logitech Wireless %s PID:%04x", 750 type_str, dj_hiddev->product); 751 } else { 752 snprintf(dj_hiddev->name, sizeof(dj_hiddev->name), 753 "Logitech Wireless Device PID:%04x", 754 dj_hiddev->product); 755 } 756 757 if (djrcv_dev->type == recvr_type_27mhz) 758 dj_hiddev->group = HID_GROUP_LOGITECH_27MHZ_DEVICE; 759 else 760 dj_hiddev->group = HID_GROUP_LOGITECH_DJ_DEVICE; 761 762 memcpy(dj_hiddev->phys, djrcv_hdev->phys, sizeof(djrcv_hdev->phys)); 763 snprintf(tmpstr, sizeof(tmpstr), ":%d", device_index); 764 strlcat(dj_hiddev->phys, tmpstr, sizeof(dj_hiddev->phys)); 765 766 dj_dev = kzalloc(sizeof(struct dj_device), GFP_KERNEL); 767 768 if (!dj_dev) { 769 hid_err(djrcv_hdev, "%s: failed allocating dj_dev\n", __func__); 770 goto dj_device_allocate_fail; 771 } 772 773 dj_dev->reports_supported = workitem->reports_supported; 774 dj_dev->hdev = dj_hiddev; 775 dj_dev->dj_receiver_dev = djrcv_dev; 776 dj_dev->device_index = device_index; 777 dj_hiddev->driver_data = dj_dev; 778 779 spin_lock_irqsave(&djrcv_dev->lock, flags); 780 djrcv_dev->paired_dj_devices[device_index] = dj_dev; 781 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 782 783 if (hid_add_device(dj_hiddev)) { 784 hid_err(djrcv_hdev, "%s: failed adding dj_device\n", __func__); 785 goto hid_add_device_fail; 786 } 787 788 return; 789 790 hid_add_device_fail: 791 spin_lock_irqsave(&djrcv_dev->lock, flags); 792 djrcv_dev->paired_dj_devices[device_index] = NULL; 793 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 794 kfree(dj_dev); 795 dj_device_allocate_fail: 796 hid_destroy_device(dj_hiddev); 797 } 798 799 static void delayedwork_callback(struct work_struct *work) 800 { 801 struct dj_receiver_dev *djrcv_dev = 802 container_of(work, struct dj_receiver_dev, work); 803 804 struct dj_workitem workitem; 805 unsigned long flags; 806 int count; 807 int retval; 808 809 dbg_hid("%s\n", __func__); 810 811 spin_lock_irqsave(&djrcv_dev->lock, flags); 812 813 /* 814 * Since we attach to multiple interfaces, we may get scheduled before 815 * we are bound to the HID++ interface, catch this. 816 */ 817 if (!djrcv_dev->ready) { 818 pr_warn("%s: delayedwork queued before hidpp interface was enumerated\n", 819 __func__); 820 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 821 return; 822 } 823 824 count = kfifo_out(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem)); 825 826 if (count != sizeof(workitem)) { 827 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 828 return; 829 } 830 831 if (!kfifo_is_empty(&djrcv_dev->notif_fifo)) 832 schedule_work(&djrcv_dev->work); 833 834 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 835 836 switch (workitem.type) { 837 case WORKITEM_TYPE_PAIRED: 838 logi_dj_recv_add_djhid_device(djrcv_dev, &workitem); 839 break; 840 case WORKITEM_TYPE_UNPAIRED: 841 logi_dj_recv_destroy_djhid_device(djrcv_dev, &workitem); 842 break; 843 case WORKITEM_TYPE_UNKNOWN: 844 retval = logi_dj_recv_query_paired_devices(djrcv_dev); 845 if (retval) { 846 hid_err(djrcv_dev->hidpp, "%s: logi_dj_recv_query_paired_devices error: %d\n", 847 __func__, retval); 848 } 849 break; 850 case WORKITEM_TYPE_EMPTY: 851 dbg_hid("%s: device list is empty\n", __func__); 852 break; 853 } 854 } 855 856 /* 857 * Sometimes we receive reports for which we do not have a paired dj_device 858 * associated with the device_index or report-type to forward the report to. 859 * This means that the original "device paired" notification corresponding 860 * to the dj_device never arrived to this driver. Possible reasons for this are: 861 * 1) hid-core discards all packets coming from a device during probe(). 862 * 2) if the receiver is plugged into a KVM switch then the pairing reports 863 * are only forwarded to it if the focus is on this PC. 864 * This function deals with this by re-asking the receiver for the list of 865 * connected devices in the delayed work callback. 866 * This function MUST be called with djrcv->lock held. 867 */ 868 static void logi_dj_recv_queue_unknown_work(struct dj_receiver_dev *djrcv_dev) 869 { 870 struct dj_workitem workitem = { .type = WORKITEM_TYPE_UNKNOWN }; 871 872 /* Rate limit queries done because of unhandled reports to 2/sec */ 873 if (time_before(jiffies, djrcv_dev->last_query + HZ / 2)) 874 return; 875 876 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem)); 877 schedule_work(&djrcv_dev->work); 878 } 879 880 static void logi_dj_recv_queue_notification(struct dj_receiver_dev *djrcv_dev, 881 struct dj_report *dj_report) 882 { 883 /* We are called from atomic context (tasklet && djrcv->lock held) */ 884 struct dj_workitem workitem = { 885 .device_index = dj_report->device_index, 886 }; 887 888 switch (dj_report->report_type) { 889 case REPORT_TYPE_NOTIF_DEVICE_PAIRED: 890 workitem.type = WORKITEM_TYPE_PAIRED; 891 if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] & 892 SPFUNCTION_DEVICE_LIST_EMPTY) { 893 workitem.type = WORKITEM_TYPE_EMPTY; 894 break; 895 } 896 fallthrough; 897 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED: 898 workitem.quad_id_msb = 899 dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_MSB]; 900 workitem.quad_id_lsb = 901 dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_LSB]; 902 workitem.reports_supported = get_unaligned_le32( 903 dj_report->report_params + 904 DEVICE_PAIRED_RF_REPORT_TYPE); 905 workitem.reports_supported |= HIDPP; 906 if (dj_report->report_type == REPORT_TYPE_NOTIF_DEVICE_UNPAIRED) 907 workitem.type = WORKITEM_TYPE_UNPAIRED; 908 break; 909 default: 910 logi_dj_recv_queue_unknown_work(djrcv_dev); 911 return; 912 } 913 914 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem)); 915 schedule_work(&djrcv_dev->work); 916 } 917 918 /* 919 * Some quad/bluetooth keyboards have a builtin touchpad in this case we see 920 * only 1 paired device with a device_type of REPORT_TYPE_KEYBOARD. For the 921 * touchpad to work we must also forward mouse input reports to the dj_hiddev 922 * created for the keyboard (instead of forwarding them to a second paired 923 * device with a device_type of REPORT_TYPE_MOUSE as we normally would). 924 * 925 * On Dinovo receivers the keyboard's touchpad and an optional paired actual 926 * mouse send separate input reports, INPUT(2) aka STD_MOUSE for the mouse 927 * and INPUT(5) aka KBD_MOUSE for the keyboard's touchpad. 928 * 929 * On MX5x00 receivers (which can also be paired with a Dinovo keyboard) 930 * INPUT(2) is used for both an optional paired actual mouse and for the 931 * keyboard's touchpad. 932 */ 933 static const u16 kbd_builtin_touchpad_ids[] = { 934 0xb309, /* Dinovo Edge */ 935 0xb30c, /* Dinovo Mini */ 936 }; 937 938 static void logi_hidpp_dev_conn_notif_equad(struct hid_device *hdev, 939 struct hidpp_event *hidpp_report, 940 struct dj_workitem *workitem) 941 { 942 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 943 int i, id; 944 945 workitem->type = WORKITEM_TYPE_PAIRED; 946 workitem->device_type = hidpp_report->params[HIDPP_PARAM_DEVICE_INFO] & 947 HIDPP_DEVICE_TYPE_MASK; 948 workitem->quad_id_msb = hidpp_report->params[HIDPP_PARAM_EQUAD_MSB]; 949 workitem->quad_id_lsb = hidpp_report->params[HIDPP_PARAM_EQUAD_LSB]; 950 switch (workitem->device_type) { 951 case REPORT_TYPE_KEYBOARD: 952 workitem->reports_supported |= STD_KEYBOARD | MULTIMEDIA | 953 POWER_KEYS | MEDIA_CENTER | 954 HIDPP; 955 id = (workitem->quad_id_msb << 8) | workitem->quad_id_lsb; 956 for (i = 0; i < ARRAY_SIZE(kbd_builtin_touchpad_ids); i++) { 957 if (id == kbd_builtin_touchpad_ids[i]) { 958 if (djrcv_dev->type == recvr_type_dinovo) 959 workitem->reports_supported |= KBD_MOUSE; 960 else 961 workitem->reports_supported |= STD_MOUSE; 962 break; 963 } 964 } 965 break; 966 case REPORT_TYPE_MOUSE: 967 workitem->reports_supported |= STD_MOUSE | HIDPP; 968 if (djrcv_dev->type == recvr_type_mouse_only) 969 workitem->reports_supported |= MULTIMEDIA; 970 break; 971 } 972 } 973 974 static void logi_hidpp_dev_conn_notif_27mhz(struct hid_device *hdev, 975 struct hidpp_event *hidpp_report, 976 struct dj_workitem *workitem) 977 { 978 workitem->type = WORKITEM_TYPE_PAIRED; 979 workitem->quad_id_lsb = hidpp_report->params[HIDPP_PARAM_27MHZ_DEVID]; 980 switch (hidpp_report->device_index) { 981 case 1: /* Index 1 is always a mouse */ 982 case 2: /* Index 2 is always a mouse */ 983 workitem->device_type = HIDPP_DEVICE_TYPE_MOUSE; 984 workitem->reports_supported |= STD_MOUSE | HIDPP; 985 break; 986 case 3: /* Index 3 is always the keyboard */ 987 case 4: /* Index 4 is used for an optional separate numpad */ 988 workitem->device_type = HIDPP_DEVICE_TYPE_KEYBOARD; 989 workitem->reports_supported |= STD_KEYBOARD | MULTIMEDIA | 990 POWER_KEYS | HIDPP; 991 break; 992 default: 993 hid_warn(hdev, "%s: unexpected device-index %d", __func__, 994 hidpp_report->device_index); 995 } 996 } 997 998 static void logi_hidpp_recv_queue_notif(struct hid_device *hdev, 999 struct hidpp_event *hidpp_report) 1000 { 1001 /* We are called from atomic context (tasklet && djrcv->lock held) */ 1002 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1003 const char *device_type = "UNKNOWN"; 1004 struct dj_workitem workitem = { 1005 .type = WORKITEM_TYPE_EMPTY, 1006 .device_index = hidpp_report->device_index, 1007 }; 1008 1009 switch (hidpp_report->params[HIDPP_PARAM_PROTO_TYPE]) { 1010 case 0x01: 1011 device_type = "Bluetooth"; 1012 /* Bluetooth connect packet contents is the same as (e)QUAD */ 1013 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1014 if (!(hidpp_report->params[HIDPP_PARAM_DEVICE_INFO] & 1015 HIDPP_MANUFACTURER_MASK)) { 1016 hid_info(hdev, "Non Logitech device connected on slot %d\n", 1017 hidpp_report->device_index); 1018 workitem.reports_supported &= ~HIDPP; 1019 } 1020 break; 1021 case 0x02: 1022 device_type = "27 Mhz"; 1023 logi_hidpp_dev_conn_notif_27mhz(hdev, hidpp_report, &workitem); 1024 break; 1025 case 0x03: 1026 device_type = "QUAD or eQUAD"; 1027 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1028 break; 1029 case 0x04: 1030 device_type = "eQUAD step 4 DJ"; 1031 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1032 break; 1033 case 0x05: 1034 device_type = "DFU Lite"; 1035 break; 1036 case 0x06: 1037 device_type = "eQUAD step 4 Lite"; 1038 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1039 break; 1040 case 0x07: 1041 device_type = "eQUAD step 4 Gaming"; 1042 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1043 workitem.reports_supported |= STD_KEYBOARD; 1044 break; 1045 case 0x08: 1046 device_type = "eQUAD step 4 for gamepads"; 1047 break; 1048 case 0x0a: 1049 device_type = "eQUAD nano Lite"; 1050 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1051 break; 1052 case 0x0c: 1053 device_type = "eQUAD Lightspeed 1"; 1054 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1055 workitem.reports_supported |= STD_KEYBOARD; 1056 break; 1057 case 0x0d: 1058 device_type = "eQUAD Lightspeed 1.1"; 1059 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1060 workitem.reports_supported |= STD_KEYBOARD; 1061 break; 1062 case 0x0f: 1063 device_type = "eQUAD Lightspeed 1.2"; 1064 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem); 1065 workitem.reports_supported |= STD_KEYBOARD; 1066 break; 1067 } 1068 1069 /* custom receiver device (eg. powerplay) */ 1070 if (hidpp_report->device_index == 7) { 1071 workitem.reports_supported |= HIDPP; 1072 } 1073 1074 if (workitem.type == WORKITEM_TYPE_EMPTY) { 1075 hid_warn(hdev, 1076 "unusable device of type %s (0x%02x) connected on slot %d", 1077 device_type, 1078 hidpp_report->params[HIDPP_PARAM_PROTO_TYPE], 1079 hidpp_report->device_index); 1080 return; 1081 } 1082 1083 hid_info(hdev, "device of type %s (0x%02x) connected on slot %d", 1084 device_type, hidpp_report->params[HIDPP_PARAM_PROTO_TYPE], 1085 hidpp_report->device_index); 1086 1087 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem)); 1088 schedule_work(&djrcv_dev->work); 1089 } 1090 1091 static void logi_dj_recv_forward_null_report(struct dj_receiver_dev *djrcv_dev, 1092 struct dj_report *dj_report) 1093 { 1094 /* We are called from atomic context (tasklet && djrcv->lock held) */ 1095 unsigned int i; 1096 u8 reportbuffer[MAX_REPORT_SIZE]; 1097 struct dj_device *djdev; 1098 1099 djdev = djrcv_dev->paired_dj_devices[dj_report->device_index]; 1100 1101 memset(reportbuffer, 0, sizeof(reportbuffer)); 1102 1103 for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) { 1104 if (djdev->reports_supported & (1 << i)) { 1105 reportbuffer[0] = i; 1106 if (hid_input_report(djdev->hdev, 1107 HID_INPUT_REPORT, 1108 reportbuffer, 1109 hid_reportid_size_map[i], 1)) { 1110 dbg_hid("hid_input_report error sending null " 1111 "report\n"); 1112 } 1113 } 1114 } 1115 } 1116 1117 static void logi_dj_recv_forward_dj(struct dj_receiver_dev *djrcv_dev, 1118 struct dj_report *dj_report) 1119 { 1120 /* We are called from atomic context (tasklet && djrcv->lock held) */ 1121 struct dj_device *dj_device; 1122 1123 dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index]; 1124 1125 if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) || 1126 (hid_reportid_size_map[dj_report->report_type] == 0)) { 1127 dbg_hid("invalid report type:%x\n", dj_report->report_type); 1128 return; 1129 } 1130 1131 if (hid_input_report(dj_device->hdev, 1132 HID_INPUT_REPORT, &dj_report->report_type, 1133 hid_reportid_size_map[dj_report->report_type], 1)) { 1134 dbg_hid("hid_input_report error\n"); 1135 } 1136 } 1137 1138 static void logi_dj_recv_forward_report(struct dj_device *dj_dev, u8 *data, 1139 int size) 1140 { 1141 /* We are called from atomic context (tasklet && djrcv->lock held) */ 1142 if (hid_input_report(dj_dev->hdev, HID_INPUT_REPORT, data, size, 1)) 1143 dbg_hid("hid_input_report error\n"); 1144 } 1145 1146 static void logi_dj_recv_forward_input_report(struct hid_device *hdev, 1147 u8 *data, int size) 1148 { 1149 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1150 struct dj_device *dj_dev; 1151 unsigned long flags; 1152 u8 report = data[0]; 1153 int i; 1154 1155 if (report > REPORT_TYPE_RFREPORT_LAST) { 1156 hid_err(hdev, "Unexpected input report number %d\n", report); 1157 return; 1158 } 1159 1160 spin_lock_irqsave(&djrcv_dev->lock, flags); 1161 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) { 1162 dj_dev = djrcv_dev->paired_dj_devices[i]; 1163 if (dj_dev && (dj_dev->reports_supported & BIT(report))) { 1164 logi_dj_recv_forward_report(dj_dev, data, size); 1165 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1166 return; 1167 } 1168 } 1169 1170 logi_dj_recv_queue_unknown_work(djrcv_dev); 1171 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1172 1173 dbg_hid("No dj-devs handling input report number %d\n", report); 1174 } 1175 1176 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev, 1177 struct dj_report *dj_report) 1178 { 1179 struct hid_device *hdev = djrcv_dev->hidpp; 1180 struct hid_report *report; 1181 struct hid_report_enum *output_report_enum; 1182 u8 *data = (u8 *)(&dj_report->device_index); 1183 unsigned int i; 1184 1185 output_report_enum = &hdev->report_enum[HID_OUTPUT_REPORT]; 1186 report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT]; 1187 1188 if (!report) { 1189 hid_err(hdev, "%s: unable to find dj report\n", __func__); 1190 return -ENODEV; 1191 } 1192 1193 for (i = 0; i < DJREPORT_SHORT_LENGTH - 1; i++) 1194 report->field[0]->value[i] = data[i]; 1195 1196 hid_hw_request(hdev, report, HID_REQ_SET_REPORT); 1197 1198 return 0; 1199 } 1200 1201 static int logi_dj_recv_query_hidpp_devices(struct dj_receiver_dev *djrcv_dev) 1202 { 1203 static const u8 template[] = { 1204 REPORT_ID_HIDPP_SHORT, 1205 HIDPP_RECEIVER_INDEX, 1206 HIDPP_SET_REGISTER, 1207 HIDPP_REG_CONNECTION_STATE, 1208 HIDPP_FAKE_DEVICE_ARRIVAL, 1209 0x00, 0x00 1210 }; 1211 u8 *hidpp_report; 1212 int retval; 1213 1214 hidpp_report = kmemdup(template, sizeof(template), GFP_KERNEL); 1215 if (!hidpp_report) 1216 return -ENOMEM; 1217 1218 retval = hid_hw_raw_request(djrcv_dev->hidpp, 1219 REPORT_ID_HIDPP_SHORT, 1220 hidpp_report, sizeof(template), 1221 HID_OUTPUT_REPORT, 1222 HID_REQ_SET_REPORT); 1223 1224 kfree(hidpp_report); 1225 return (retval < 0) ? retval : 0; 1226 } 1227 1228 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev) 1229 { 1230 struct dj_report *dj_report; 1231 int retval; 1232 1233 djrcv_dev->last_query = jiffies; 1234 1235 if (djrcv_dev->type != recvr_type_dj) 1236 return logi_dj_recv_query_hidpp_devices(djrcv_dev); 1237 1238 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL); 1239 if (!dj_report) 1240 return -ENOMEM; 1241 dj_report->report_id = REPORT_ID_DJ_SHORT; 1242 dj_report->device_index = HIDPP_RECEIVER_INDEX; 1243 dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES; 1244 retval = logi_dj_recv_send_report(djrcv_dev, dj_report); 1245 kfree(dj_report); 1246 return retval; 1247 } 1248 1249 1250 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev, 1251 unsigned timeout) 1252 { 1253 struct hid_device *hdev = djrcv_dev->hidpp; 1254 struct dj_report *dj_report; 1255 u8 *buf; 1256 int retval = 0; 1257 1258 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL); 1259 if (!dj_report) 1260 return -ENOMEM; 1261 1262 if (djrcv_dev->type == recvr_type_dj) { 1263 dj_report->report_id = REPORT_ID_DJ_SHORT; 1264 dj_report->device_index = HIDPP_RECEIVER_INDEX; 1265 dj_report->report_type = REPORT_TYPE_CMD_SWITCH; 1266 dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F; 1267 dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = 1268 (u8)timeout; 1269 1270 retval = logi_dj_recv_send_report(djrcv_dev, dj_report); 1271 1272 /* 1273 * Ugly sleep to work around a USB 3.0 bug when the receiver is 1274 * still processing the "switch-to-dj" command while we send an 1275 * other command. 1276 * 50 msec should gives enough time to the receiver to be ready. 1277 */ 1278 msleep(50); 1279 } 1280 1281 /* 1282 * Magical bits to set up hidpp notifications when the dj devices 1283 * are connected/disconnected. 1284 * 1285 * We can reuse dj_report because HIDPP_REPORT_SHORT_LENGTH is smaller 1286 * than DJREPORT_SHORT_LENGTH. 1287 */ 1288 buf = (u8 *)dj_report; 1289 1290 memset(buf, 0, HIDPP_REPORT_SHORT_LENGTH); 1291 1292 buf[0] = REPORT_ID_HIDPP_SHORT; 1293 buf[1] = HIDPP_RECEIVER_INDEX; 1294 buf[2] = 0x80; 1295 buf[3] = 0x00; 1296 buf[4] = 0x00; 1297 buf[5] = 0x09; 1298 buf[6] = 0x00; 1299 1300 hid_hw_raw_request(hdev, REPORT_ID_HIDPP_SHORT, buf, 1301 HIDPP_REPORT_SHORT_LENGTH, HID_OUTPUT_REPORT, 1302 HID_REQ_SET_REPORT); 1303 1304 kfree(dj_report); 1305 return retval; 1306 } 1307 1308 1309 static int logi_dj_ll_open(struct hid_device *hid) 1310 { 1311 dbg_hid("%s: %s\n", __func__, hid->phys); 1312 return 0; 1313 1314 } 1315 1316 static void logi_dj_ll_close(struct hid_device *hid) 1317 { 1318 dbg_hid("%s: %s\n", __func__, hid->phys); 1319 } 1320 1321 /* 1322 * Register 0xB5 is "pairing information". It is solely intended for the 1323 * receiver, so do not overwrite the device index. 1324 */ 1325 static u8 unifying_pairing_query[] = { REPORT_ID_HIDPP_SHORT, 1326 HIDPP_RECEIVER_INDEX, 1327 HIDPP_GET_LONG_REGISTER, 1328 HIDPP_REG_PAIRING_INFORMATION }; 1329 static u8 unifying_pairing_answer[] = { REPORT_ID_HIDPP_LONG, 1330 HIDPP_RECEIVER_INDEX, 1331 HIDPP_GET_LONG_REGISTER, 1332 HIDPP_REG_PAIRING_INFORMATION }; 1333 1334 static int logi_dj_ll_raw_request(struct hid_device *hid, 1335 unsigned char reportnum, __u8 *buf, 1336 size_t count, unsigned char report_type, 1337 int reqtype) 1338 { 1339 struct dj_device *djdev = hid->driver_data; 1340 struct dj_receiver_dev *djrcv_dev = djdev->dj_receiver_dev; 1341 u8 *out_buf; 1342 int ret; 1343 1344 if ((buf[0] == REPORT_ID_HIDPP_SHORT) || 1345 (buf[0] == REPORT_ID_HIDPP_LONG) || 1346 (buf[0] == REPORT_ID_HIDPP_VERY_LONG)) { 1347 if (count < 2) 1348 return -EINVAL; 1349 1350 /* special case where we should not overwrite 1351 * the device_index */ 1352 if (count == 7 && !memcmp(buf, unifying_pairing_query, 1353 sizeof(unifying_pairing_query))) 1354 buf[4] = (buf[4] & 0xf0) | (djdev->device_index - 1); 1355 else 1356 buf[1] = djdev->device_index; 1357 return hid_hw_raw_request(djrcv_dev->hidpp, reportnum, buf, 1358 count, report_type, reqtype); 1359 } 1360 1361 if (buf[0] != REPORT_TYPE_LEDS) 1362 return -EINVAL; 1363 1364 if (djrcv_dev->type != recvr_type_dj && count >= 2) { 1365 if (!djrcv_dev->keyboard) { 1366 hid_warn(hid, "Received REPORT_TYPE_LEDS request before the keyboard interface was enumerated\n"); 1367 return 0; 1368 } 1369 /* usbhid overrides the report ID and ignores the first byte */ 1370 return hid_hw_raw_request(djrcv_dev->keyboard, 0, buf, count, 1371 report_type, reqtype); 1372 } 1373 1374 out_buf = kzalloc(DJREPORT_SHORT_LENGTH, GFP_ATOMIC); 1375 if (!out_buf) 1376 return -ENOMEM; 1377 1378 if (count > DJREPORT_SHORT_LENGTH - 2) 1379 count = DJREPORT_SHORT_LENGTH - 2; 1380 1381 out_buf[0] = REPORT_ID_DJ_SHORT; 1382 out_buf[1] = djdev->device_index; 1383 memcpy(out_buf + 2, buf, count); 1384 1385 ret = hid_hw_raw_request(djrcv_dev->hidpp, out_buf[0], out_buf, 1386 DJREPORT_SHORT_LENGTH, report_type, reqtype); 1387 1388 kfree(out_buf); 1389 return ret; 1390 } 1391 1392 static void rdcat(char *rdesc, unsigned int *rsize, const char *data, unsigned int size) 1393 { 1394 memcpy(rdesc + *rsize, data, size); 1395 *rsize += size; 1396 } 1397 1398 static int logi_dj_ll_parse(struct hid_device *hid) 1399 { 1400 struct dj_device *djdev = hid->driver_data; 1401 unsigned int rsize = 0; 1402 char *rdesc; 1403 int retval; 1404 1405 dbg_hid("%s\n", __func__); 1406 1407 djdev->hdev->version = 0x0111; 1408 djdev->hdev->country = 0x00; 1409 1410 rdesc = kmalloc(MAX_RDESC_SIZE, GFP_KERNEL); 1411 if (!rdesc) 1412 return -ENOMEM; 1413 1414 if (djdev->reports_supported & STD_KEYBOARD) { 1415 dbg_hid("%s: sending a kbd descriptor, reports_supported: %llx\n", 1416 __func__, djdev->reports_supported); 1417 rdcat(rdesc, &rsize, kbd_descriptor, sizeof(kbd_descriptor)); 1418 } 1419 1420 if (djdev->reports_supported & STD_MOUSE) { 1421 dbg_hid("%s: sending a mouse descriptor, reports_supported: %llx\n", 1422 __func__, djdev->reports_supported); 1423 if (djdev->dj_receiver_dev->type == recvr_type_gaming_hidpp || 1424 djdev->dj_receiver_dev->type == recvr_type_mouse_only) 1425 rdcat(rdesc, &rsize, mse_high_res_descriptor, 1426 sizeof(mse_high_res_descriptor)); 1427 else if (djdev->dj_receiver_dev->type == recvr_type_27mhz) 1428 rdcat(rdesc, &rsize, mse_27mhz_descriptor, 1429 sizeof(mse_27mhz_descriptor)); 1430 else if (recvr_type_is_bluetooth(djdev->dj_receiver_dev->type)) 1431 rdcat(rdesc, &rsize, mse_bluetooth_descriptor, 1432 sizeof(mse_bluetooth_descriptor)); 1433 else 1434 rdcat(rdesc, &rsize, mse_descriptor, 1435 sizeof(mse_descriptor)); 1436 } 1437 1438 if (djdev->reports_supported & KBD_MOUSE) { 1439 dbg_hid("%s: sending a kbd-mouse descriptor, reports_supported: %llx\n", 1440 __func__, djdev->reports_supported); 1441 rdcat(rdesc, &rsize, mse5_bluetooth_descriptor, 1442 sizeof(mse5_bluetooth_descriptor)); 1443 } 1444 1445 if (djdev->reports_supported & MULTIMEDIA) { 1446 dbg_hid("%s: sending a multimedia report descriptor: %llx\n", 1447 __func__, djdev->reports_supported); 1448 rdcat(rdesc, &rsize, consumer_descriptor, sizeof(consumer_descriptor)); 1449 } 1450 1451 if (djdev->reports_supported & POWER_KEYS) { 1452 dbg_hid("%s: sending a power keys report descriptor: %llx\n", 1453 __func__, djdev->reports_supported); 1454 rdcat(rdesc, &rsize, syscontrol_descriptor, sizeof(syscontrol_descriptor)); 1455 } 1456 1457 if (djdev->reports_supported & MEDIA_CENTER) { 1458 dbg_hid("%s: sending a media center report descriptor: %llx\n", 1459 __func__, djdev->reports_supported); 1460 rdcat(rdesc, &rsize, media_descriptor, sizeof(media_descriptor)); 1461 } 1462 1463 if (djdev->reports_supported & KBD_LEDS) { 1464 dbg_hid("%s: need to send kbd leds report descriptor: %llx\n", 1465 __func__, djdev->reports_supported); 1466 } 1467 1468 if (djdev->reports_supported & HIDPP) { 1469 dbg_hid("%s: sending a HID++ descriptor, reports_supported: %llx\n", 1470 __func__, djdev->reports_supported); 1471 rdcat(rdesc, &rsize, hidpp_descriptor, 1472 sizeof(hidpp_descriptor)); 1473 } 1474 1475 retval = hid_parse_report(hid, rdesc, rsize); 1476 kfree(rdesc); 1477 1478 return retval; 1479 } 1480 1481 static int logi_dj_ll_start(struct hid_device *hid) 1482 { 1483 dbg_hid("%s\n", __func__); 1484 return 0; 1485 } 1486 1487 static void logi_dj_ll_stop(struct hid_device *hid) 1488 { 1489 dbg_hid("%s\n", __func__); 1490 } 1491 1492 1493 static struct hid_ll_driver logi_dj_ll_driver = { 1494 .parse = logi_dj_ll_parse, 1495 .start = logi_dj_ll_start, 1496 .stop = logi_dj_ll_stop, 1497 .open = logi_dj_ll_open, 1498 .close = logi_dj_ll_close, 1499 .raw_request = logi_dj_ll_raw_request, 1500 }; 1501 1502 static int logi_dj_dj_event(struct hid_device *hdev, 1503 struct hid_report *report, u8 *data, 1504 int size) 1505 { 1506 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1507 struct dj_report *dj_report = (struct dj_report *) data; 1508 unsigned long flags; 1509 1510 /* 1511 * Here we receive all data coming from iface 2, there are 3 cases: 1512 * 1513 * 1) Data is intended for this driver i. e. data contains arrival, 1514 * departure, etc notifications, in which case we queue them for delayed 1515 * processing by the work queue. We return 1 to hid-core as no further 1516 * processing is required from it. 1517 * 1518 * 2) Data informs a connection change, if the change means rf link 1519 * loss, then we must send a null report to the upper layer to discard 1520 * potentially pressed keys that may be repeated forever by the input 1521 * layer. Return 1 to hid-core as no further processing is required. 1522 * 1523 * 3) Data is an actual input event from a paired DJ device in which 1524 * case we forward it to the correct hid device (via hid_input_report() 1525 * ) and return 1 so hid-core does not anything else with it. 1526 */ 1527 1528 if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) || 1529 (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) { 1530 /* 1531 * Device index is wrong, bail out. 1532 * This driver can ignore safely the receiver notifications, 1533 * so ignore those reports too. 1534 */ 1535 if (dj_report->device_index != DJ_RECEIVER_INDEX) 1536 hid_err(hdev, "%s: invalid device index:%d\n", 1537 __func__, dj_report->device_index); 1538 return false; 1539 } 1540 1541 spin_lock_irqsave(&djrcv_dev->lock, flags); 1542 1543 if (!djrcv_dev->paired_dj_devices[dj_report->device_index]) { 1544 /* received an event for an unknown device, bail out */ 1545 logi_dj_recv_queue_notification(djrcv_dev, dj_report); 1546 goto out; 1547 } 1548 1549 switch (dj_report->report_type) { 1550 case REPORT_TYPE_NOTIF_DEVICE_PAIRED: 1551 /* pairing notifications are handled above the switch */ 1552 break; 1553 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED: 1554 logi_dj_recv_queue_notification(djrcv_dev, dj_report); 1555 break; 1556 case REPORT_TYPE_NOTIF_CONNECTION_STATUS: 1557 if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] == 1558 STATUS_LINKLOSS) { 1559 logi_dj_recv_forward_null_report(djrcv_dev, dj_report); 1560 } 1561 break; 1562 default: 1563 logi_dj_recv_forward_dj(djrcv_dev, dj_report); 1564 } 1565 1566 out: 1567 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1568 1569 return true; 1570 } 1571 1572 static int logi_dj_hidpp_event(struct hid_device *hdev, 1573 struct hid_report *report, u8 *data, 1574 int size) 1575 { 1576 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1577 struct hidpp_event *hidpp_report = (struct hidpp_event *) data; 1578 struct dj_device *dj_dev; 1579 unsigned long flags; 1580 u8 device_index = hidpp_report->device_index; 1581 1582 if (device_index == HIDPP_RECEIVER_INDEX) { 1583 /* special case were the device wants to know its unifying 1584 * name */ 1585 if (size == HIDPP_REPORT_LONG_LENGTH && 1586 !memcmp(data, unifying_pairing_answer, 1587 sizeof(unifying_pairing_answer))) 1588 device_index = (data[4] & 0x0F) + 1; 1589 else 1590 return false; 1591 } 1592 1593 /* 1594 * Data is from the HID++ collection, in this case, we forward the 1595 * data to the corresponding child dj device and return 0 to hid-core 1596 * so he data also goes to the hidraw device of the receiver. This 1597 * allows a user space application to implement the full HID++ routing 1598 * via the receiver. 1599 */ 1600 1601 if ((device_index < DJ_DEVICE_INDEX_MIN) || 1602 (device_index > DJ_DEVICE_INDEX_MAX)) { 1603 /* 1604 * Device index is wrong, bail out. 1605 * This driver can ignore safely the receiver notifications, 1606 * so ignore those reports too. 1607 */ 1608 hid_err(hdev, "%s: invalid device index:%d\n", __func__, 1609 hidpp_report->device_index); 1610 return false; 1611 } 1612 1613 spin_lock_irqsave(&djrcv_dev->lock, flags); 1614 1615 dj_dev = djrcv_dev->paired_dj_devices[device_index]; 1616 1617 /* 1618 * With 27 MHz receivers, we do not get an explicit unpair event, 1619 * remove the old device if the user has paired a *different* device. 1620 */ 1621 if (djrcv_dev->type == recvr_type_27mhz && dj_dev && 1622 hidpp_report->sub_id == REPORT_TYPE_NOTIF_DEVICE_CONNECTED && 1623 hidpp_report->params[HIDPP_PARAM_PROTO_TYPE] == 0x02 && 1624 hidpp_report->params[HIDPP_PARAM_27MHZ_DEVID] != 1625 dj_dev->hdev->product) { 1626 struct dj_workitem workitem = { 1627 .device_index = hidpp_report->device_index, 1628 .type = WORKITEM_TYPE_UNPAIRED, 1629 }; 1630 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem)); 1631 /* logi_hidpp_recv_queue_notif will queue the work */ 1632 dj_dev = NULL; 1633 } 1634 1635 if (dj_dev) { 1636 logi_dj_recv_forward_report(dj_dev, data, size); 1637 } else { 1638 if (hidpp_report->sub_id == REPORT_TYPE_NOTIF_DEVICE_CONNECTED) 1639 logi_hidpp_recv_queue_notif(hdev, hidpp_report); 1640 else 1641 logi_dj_recv_queue_unknown_work(djrcv_dev); 1642 } 1643 1644 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1645 1646 return false; 1647 } 1648 1649 static int logi_dj_raw_event(struct hid_device *hdev, 1650 struct hid_report *report, u8 *data, 1651 int size) 1652 { 1653 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1654 dbg_hid("%s, size:%d\n", __func__, size); 1655 1656 if (!djrcv_dev) 1657 return 0; 1658 1659 if (!hdev->report_enum[HID_INPUT_REPORT].numbered) { 1660 1661 if (djrcv_dev->unnumbered_application == HID_GD_KEYBOARD) { 1662 /* 1663 * For the keyboard, we can reuse the same report by 1664 * using the second byte which is constant in the USB 1665 * HID report descriptor. 1666 */ 1667 data[1] = data[0]; 1668 data[0] = REPORT_TYPE_KEYBOARD; 1669 1670 logi_dj_recv_forward_input_report(hdev, data, size); 1671 1672 /* restore previous state */ 1673 data[0] = data[1]; 1674 data[1] = 0; 1675 } 1676 /* 1677 * Mouse-only receivers send unnumbered mouse data. The 27 MHz 1678 * receiver uses 6 byte packets, the nano receiver 8 bytes. 1679 */ 1680 if (djrcv_dev->unnumbered_application == HID_GD_MOUSE && 1681 size <= 8) { 1682 u8 mouse_report[9]; 1683 1684 /* Prepend report id */ 1685 mouse_report[0] = REPORT_TYPE_MOUSE; 1686 memcpy(mouse_report + 1, data, size); 1687 logi_dj_recv_forward_input_report(hdev, mouse_report, 1688 size + 1); 1689 } 1690 1691 return false; 1692 } 1693 1694 switch (data[0]) { 1695 case REPORT_ID_DJ_SHORT: 1696 if (size != DJREPORT_SHORT_LENGTH) { 1697 hid_err(hdev, "Short DJ report bad size (%d)", size); 1698 return false; 1699 } 1700 return logi_dj_dj_event(hdev, report, data, size); 1701 case REPORT_ID_DJ_LONG: 1702 if (size != DJREPORT_LONG_LENGTH) { 1703 hid_err(hdev, "Long DJ report bad size (%d)", size); 1704 return false; 1705 } 1706 return logi_dj_dj_event(hdev, report, data, size); 1707 case REPORT_ID_HIDPP_SHORT: 1708 if (size != HIDPP_REPORT_SHORT_LENGTH) { 1709 hid_err(hdev, "Short HID++ report bad size (%d)", size); 1710 return false; 1711 } 1712 return logi_dj_hidpp_event(hdev, report, data, size); 1713 case REPORT_ID_HIDPP_LONG: 1714 if (size != HIDPP_REPORT_LONG_LENGTH) { 1715 hid_err(hdev, "Long HID++ report bad size (%d)", size); 1716 return false; 1717 } 1718 return logi_dj_hidpp_event(hdev, report, data, size); 1719 } 1720 1721 logi_dj_recv_forward_input_report(hdev, data, size); 1722 1723 return false; 1724 } 1725 1726 static int logi_dj_probe(struct hid_device *hdev, 1727 const struct hid_device_id *id) 1728 { 1729 struct hid_report_enum *rep_enum; 1730 struct hid_report *rep; 1731 struct dj_receiver_dev *djrcv_dev; 1732 struct usb_interface *intf; 1733 unsigned int no_dj_interfaces = 0; 1734 bool has_hidpp = false; 1735 unsigned long flags; 1736 int retval; 1737 1738 /* 1739 * Call to usbhid to fetch the HID descriptors of the current 1740 * interface subsequently call to the hid/hid-core to parse the 1741 * fetched descriptors. 1742 */ 1743 retval = hid_parse(hdev); 1744 if (retval) { 1745 hid_err(hdev, "%s: parse failed\n", __func__); 1746 return retval; 1747 } 1748 1749 /* 1750 * Some KVMs add an extra interface for e.g. mouse emulation. If we 1751 * treat these as logitech-dj interfaces then this causes input events 1752 * reported through this extra interface to not be reported correctly. 1753 * To avoid this, we treat these as generic-hid devices. 1754 */ 1755 switch (id->driver_data) { 1756 case recvr_type_dj: no_dj_interfaces = 3; break; 1757 case recvr_type_hidpp: no_dj_interfaces = 2; break; 1758 case recvr_type_gaming_hidpp: no_dj_interfaces = 3; break; 1759 case recvr_type_mouse_only: no_dj_interfaces = 2; break; 1760 case recvr_type_27mhz: no_dj_interfaces = 2; break; 1761 case recvr_type_bluetooth: no_dj_interfaces = 2; break; 1762 case recvr_type_dinovo: no_dj_interfaces = 2; break; 1763 } 1764 if (hid_is_using_ll_driver(hdev, &usb_hid_driver)) { 1765 intf = to_usb_interface(hdev->dev.parent); 1766 if (intf && intf->altsetting->desc.bInterfaceNumber >= 1767 no_dj_interfaces) { 1768 hdev->quirks |= HID_QUIRK_INPUT_PER_APP; 1769 return hid_hw_start(hdev, HID_CONNECT_DEFAULT); 1770 } 1771 } 1772 1773 rep_enum = &hdev->report_enum[HID_INPUT_REPORT]; 1774 1775 /* no input reports, bail out */ 1776 if (list_empty(&rep_enum->report_list)) 1777 return -ENODEV; 1778 1779 /* 1780 * Check for the HID++ application. 1781 * Note: we should theoretically check for HID++ and DJ 1782 * collections, but this will do. 1783 */ 1784 list_for_each_entry(rep, &rep_enum->report_list, list) { 1785 if (rep->application == 0xff000001) 1786 has_hidpp = true; 1787 } 1788 1789 /* 1790 * Ignore interfaces without DJ/HID++ collection, they will not carry 1791 * any data, dont create any hid_device for them. 1792 */ 1793 if (!has_hidpp && id->driver_data == recvr_type_dj) 1794 return -ENODEV; 1795 1796 /* get the current application attached to the node */ 1797 rep = list_first_entry(&rep_enum->report_list, struct hid_report, list); 1798 djrcv_dev = dj_get_receiver_dev(hdev, id->driver_data, 1799 rep->application, has_hidpp); 1800 if (!djrcv_dev) { 1801 hid_err(hdev, "%s: dj_get_receiver_dev failed\n", __func__); 1802 return -ENOMEM; 1803 } 1804 1805 if (!rep_enum->numbered) 1806 djrcv_dev->unnumbered_application = rep->application; 1807 1808 /* Starts the usb device and connects to upper interfaces hiddev and 1809 * hidraw */ 1810 retval = hid_hw_start(hdev, HID_CONNECT_HIDRAW|HID_CONNECT_HIDDEV); 1811 if (retval) { 1812 hid_err(hdev, "%s: hid_hw_start returned error\n", __func__); 1813 goto hid_hw_start_fail; 1814 } 1815 1816 if (has_hidpp) { 1817 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0); 1818 if (retval < 0) { 1819 hid_err(hdev, "%s: logi_dj_recv_switch_to_dj_mode returned error:%d\n", 1820 __func__, retval); 1821 goto switch_to_dj_mode_fail; 1822 } 1823 } 1824 1825 /* This is enabling the polling urb on the IN endpoint */ 1826 retval = hid_hw_open(hdev); 1827 if (retval < 0) { 1828 hid_err(hdev, "%s: hid_hw_open returned error:%d\n", 1829 __func__, retval); 1830 goto llopen_failed; 1831 } 1832 1833 /* Allow incoming packets to arrive: */ 1834 hid_device_io_start(hdev); 1835 1836 if (has_hidpp) { 1837 spin_lock_irqsave(&djrcv_dev->lock, flags); 1838 djrcv_dev->ready = true; 1839 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1840 retval = logi_dj_recv_query_paired_devices(djrcv_dev); 1841 if (retval < 0) { 1842 hid_err(hdev, "%s: logi_dj_recv_query_paired_devices error:%d\n", 1843 __func__, retval); 1844 /* 1845 * This can happen with a KVM, let the probe succeed, 1846 * logi_dj_recv_queue_unknown_work will retry later. 1847 */ 1848 } 1849 } 1850 1851 return 0; 1852 1853 llopen_failed: 1854 switch_to_dj_mode_fail: 1855 hid_hw_stop(hdev); 1856 1857 hid_hw_start_fail: 1858 dj_put_receiver_dev(hdev); 1859 return retval; 1860 } 1861 1862 #ifdef CONFIG_PM 1863 static int logi_dj_reset_resume(struct hid_device *hdev) 1864 { 1865 int retval; 1866 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1867 1868 if (!djrcv_dev || djrcv_dev->hidpp != hdev) 1869 return 0; 1870 1871 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0); 1872 if (retval < 0) { 1873 hid_err(hdev, "%s: logi_dj_recv_switch_to_dj_mode returned error:%d\n", 1874 __func__, retval); 1875 } 1876 1877 return 0; 1878 } 1879 #endif 1880 1881 static void logi_dj_remove(struct hid_device *hdev) 1882 { 1883 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); 1884 struct dj_device *dj_dev; 1885 unsigned long flags; 1886 int i; 1887 1888 dbg_hid("%s\n", __func__); 1889 1890 if (!djrcv_dev) 1891 return hid_hw_stop(hdev); 1892 1893 /* 1894 * This ensures that if the work gets requeued from another 1895 * interface of the same receiver it will be a no-op. 1896 */ 1897 spin_lock_irqsave(&djrcv_dev->lock, flags); 1898 djrcv_dev->ready = false; 1899 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1900 1901 cancel_work_sync(&djrcv_dev->work); 1902 1903 hid_hw_close(hdev); 1904 hid_hw_stop(hdev); 1905 1906 /* 1907 * For proper operation we need access to all interfaces, so we destroy 1908 * the paired devices when we're unbound from any interface. 1909 * 1910 * Note we may still be bound to other interfaces, sharing the same 1911 * djrcv_dev, so we need locking here. 1912 */ 1913 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) { 1914 spin_lock_irqsave(&djrcv_dev->lock, flags); 1915 dj_dev = djrcv_dev->paired_dj_devices[i]; 1916 djrcv_dev->paired_dj_devices[i] = NULL; 1917 spin_unlock_irqrestore(&djrcv_dev->lock, flags); 1918 if (dj_dev != NULL) { 1919 hid_destroy_device(dj_dev->hdev); 1920 kfree(dj_dev); 1921 } 1922 } 1923 1924 dj_put_receiver_dev(hdev); 1925 } 1926 1927 static const struct hid_device_id logi_dj_receivers[] = { 1928 { /* Logitech unifying receiver (0xc52b) */ 1929 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1930 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER), 1931 .driver_data = recvr_type_dj}, 1932 { /* Logitech unifying receiver (0xc532) */ 1933 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1934 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2), 1935 .driver_data = recvr_type_dj}, 1936 1937 { /* Logitech Nano mouse only receiver (0xc52f) */ 1938 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1939 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER), 1940 .driver_data = recvr_type_mouse_only}, 1941 { /* Logitech Nano (non DJ) receiver (0xc534) */ 1942 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1943 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_2), 1944 .driver_data = recvr_type_hidpp}, 1945 1946 { /* Logitech G700(s) receiver (0xc531) */ 1947 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1948 USB_DEVICE_ID_LOGITECH_G700_RECEIVER), 1949 .driver_data = recvr_type_gaming_hidpp}, 1950 { /* Logitech G602 receiver (0xc537) */ 1951 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1952 0xc537), 1953 .driver_data = recvr_type_gaming_hidpp}, 1954 { /* Logitech lightspeed receiver (0xc539) */ 1955 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1956 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_LIGHTSPEED_1), 1957 .driver_data = recvr_type_gaming_hidpp}, 1958 { /* Logitech powerplay receiver (0xc53a) */ 1959 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1960 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_POWERPLAY), 1961 .driver_data = recvr_type_gaming_hidpp}, 1962 { /* Logitech lightspeed receiver (0xc53f) */ 1963 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1964 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_LIGHTSPEED_1_1), 1965 .driver_data = recvr_type_gaming_hidpp}, 1966 1967 { /* Logitech 27 MHz HID++ 1.0 receiver (0xc513) */ 1968 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_MX3000_RECEIVER), 1969 .driver_data = recvr_type_27mhz}, 1970 { /* Logitech 27 MHz HID++ 1.0 receiver (0xc517) */ 1971 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1972 USB_DEVICE_ID_S510_RECEIVER_2), 1973 .driver_data = recvr_type_27mhz}, 1974 { /* Logitech 27 MHz HID++ 1.0 mouse-only receiver (0xc51b) */ 1975 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1976 USB_DEVICE_ID_LOGITECH_27MHZ_MOUSE_RECEIVER), 1977 .driver_data = recvr_type_27mhz}, 1978 1979 { /* Logitech MX5000 HID++ / bluetooth receiver keyboard intf. (0xc70e) */ 1980 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1981 USB_DEVICE_ID_MX5000_RECEIVER_KBD_DEV), 1982 .driver_data = recvr_type_bluetooth}, 1983 { /* Logitech MX5000 HID++ / bluetooth receiver mouse intf. (0xc70a) */ 1984 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1985 USB_DEVICE_ID_MX5000_RECEIVER_MOUSE_DEV), 1986 .driver_data = recvr_type_bluetooth}, 1987 { /* Logitech MX5500 HID++ / bluetooth receiver keyboard intf. (0xc71b) */ 1988 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1989 USB_DEVICE_ID_MX5500_RECEIVER_KBD_DEV), 1990 .driver_data = recvr_type_bluetooth}, 1991 { /* Logitech MX5500 HID++ / bluetooth receiver mouse intf. (0xc71c) */ 1992 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1993 USB_DEVICE_ID_MX5500_RECEIVER_MOUSE_DEV), 1994 .driver_data = recvr_type_bluetooth}, 1995 1996 { /* Logitech Dinovo Edge HID++ / bluetooth receiver keyboard intf. (0xc713) */ 1997 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 1998 USB_DEVICE_ID_DINOVO_EDGE_RECEIVER_KBD_DEV), 1999 .driver_data = recvr_type_dinovo}, 2000 { /* Logitech Dinovo Edge HID++ / bluetooth receiver mouse intf. (0xc714) */ 2001 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 2002 USB_DEVICE_ID_DINOVO_EDGE_RECEIVER_MOUSE_DEV), 2003 .driver_data = recvr_type_dinovo}, 2004 { /* Logitech DiNovo Mini HID++ / bluetooth receiver mouse intf. (0xc71e) */ 2005 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 2006 USB_DEVICE_ID_DINOVO_MINI_RECEIVER_KBD_DEV), 2007 .driver_data = recvr_type_dinovo}, 2008 { /* Logitech DiNovo Mini HID++ / bluetooth receiver keyboard intf. (0xc71f) */ 2009 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 2010 USB_DEVICE_ID_DINOVO_MINI_RECEIVER_MOUSE_DEV), 2011 .driver_data = recvr_type_dinovo}, 2012 {} 2013 }; 2014 2015 MODULE_DEVICE_TABLE(hid, logi_dj_receivers); 2016 2017 static struct hid_driver logi_djreceiver_driver = { 2018 .name = "logitech-djreceiver", 2019 .id_table = logi_dj_receivers, 2020 .probe = logi_dj_probe, 2021 .remove = logi_dj_remove, 2022 .raw_event = logi_dj_raw_event, 2023 #ifdef CONFIG_PM 2024 .reset_resume = logi_dj_reset_resume, 2025 #endif 2026 }; 2027 2028 module_hid_driver(logi_djreceiver_driver); 2029 2030 MODULE_LICENSE("GPL"); 2031 MODULE_AUTHOR("Logitech"); 2032 MODULE_AUTHOR("Nestor Lopez Casado"); 2033 MODULE_AUTHOR("nlopezcasad@logitech.com"); 2034