1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * HID driver for Sony DualSense(TM) controller. 4 * 5 * Copyright (c) 2020-2022 Sony Interactive Entertainment 6 */ 7 8 #include <linux/bits.h> 9 #include <linux/crc32.h> 10 #include <linux/device.h> 11 #include <linux/hid.h> 12 #include <linux/idr.h> 13 #include <linux/input/mt.h> 14 #include <linux/leds.h> 15 #include <linux/led-class-multicolor.h> 16 #include <linux/module.h> 17 18 #include <asm/unaligned.h> 19 20 #include "hid-ids.h" 21 22 /* List of connected playstation devices. */ 23 static DEFINE_MUTEX(ps_devices_lock); 24 static LIST_HEAD(ps_devices_list); 25 26 static DEFINE_IDA(ps_player_id_allocator); 27 28 #define HID_PLAYSTATION_VERSION_PATCH 0x8000 29 30 /* Base class for playstation devices. */ 31 struct ps_device { 32 struct list_head list; 33 struct hid_device *hdev; 34 spinlock_t lock; 35 36 uint32_t player_id; 37 38 struct power_supply_desc battery_desc; 39 struct power_supply *battery; 40 uint8_t battery_capacity; 41 int battery_status; 42 43 const char *input_dev_name; /* Name of primary input device. */ 44 uint8_t mac_address[6]; /* Note: stored in little endian order. */ 45 uint32_t hw_version; 46 uint32_t fw_version; 47 48 int (*parse_report)(struct ps_device *dev, struct hid_report *report, u8 *data, int size); 49 void (*remove)(struct ps_device *dev); 50 }; 51 52 /* Calibration data for playstation motion sensors. */ 53 struct ps_calibration_data { 54 int abs_code; 55 short bias; 56 int sens_numer; 57 int sens_denom; 58 }; 59 60 struct ps_led_info { 61 const char *name; 62 const char *color; 63 int max_brightness; 64 enum led_brightness (*brightness_get)(struct led_classdev *cdev); 65 int (*brightness_set)(struct led_classdev *cdev, enum led_brightness); 66 int (*blink_set)(struct led_classdev *led, unsigned long *on, unsigned long *off); 67 }; 68 69 /* Seed values for DualShock4 / DualSense CRC32 for different report types. */ 70 #define PS_INPUT_CRC32_SEED 0xA1 71 #define PS_OUTPUT_CRC32_SEED 0xA2 72 #define PS_FEATURE_CRC32_SEED 0xA3 73 74 #define DS_INPUT_REPORT_USB 0x01 75 #define DS_INPUT_REPORT_USB_SIZE 64 76 #define DS_INPUT_REPORT_BT 0x31 77 #define DS_INPUT_REPORT_BT_SIZE 78 78 #define DS_OUTPUT_REPORT_USB 0x02 79 #define DS_OUTPUT_REPORT_USB_SIZE 63 80 #define DS_OUTPUT_REPORT_BT 0x31 81 #define DS_OUTPUT_REPORT_BT_SIZE 78 82 83 #define DS_FEATURE_REPORT_CALIBRATION 0x05 84 #define DS_FEATURE_REPORT_CALIBRATION_SIZE 41 85 #define DS_FEATURE_REPORT_PAIRING_INFO 0x09 86 #define DS_FEATURE_REPORT_PAIRING_INFO_SIZE 20 87 #define DS_FEATURE_REPORT_FIRMWARE_INFO 0x20 88 #define DS_FEATURE_REPORT_FIRMWARE_INFO_SIZE 64 89 90 /* Button masks for DualSense input report. */ 91 #define DS_BUTTONS0_HAT_SWITCH GENMASK(3, 0) 92 #define DS_BUTTONS0_SQUARE BIT(4) 93 #define DS_BUTTONS0_CROSS BIT(5) 94 #define DS_BUTTONS0_CIRCLE BIT(6) 95 #define DS_BUTTONS0_TRIANGLE BIT(7) 96 #define DS_BUTTONS1_L1 BIT(0) 97 #define DS_BUTTONS1_R1 BIT(1) 98 #define DS_BUTTONS1_L2 BIT(2) 99 #define DS_BUTTONS1_R2 BIT(3) 100 #define DS_BUTTONS1_CREATE BIT(4) 101 #define DS_BUTTONS1_OPTIONS BIT(5) 102 #define DS_BUTTONS1_L3 BIT(6) 103 #define DS_BUTTONS1_R3 BIT(7) 104 #define DS_BUTTONS2_PS_HOME BIT(0) 105 #define DS_BUTTONS2_TOUCHPAD BIT(1) 106 #define DS_BUTTONS2_MIC_MUTE BIT(2) 107 108 /* Status field of DualSense input report. */ 109 #define DS_STATUS_BATTERY_CAPACITY GENMASK(3, 0) 110 #define DS_STATUS_CHARGING GENMASK(7, 4) 111 #define DS_STATUS_CHARGING_SHIFT 4 112 113 /* Feature version from DualSense Firmware Info report. */ 114 #define DS_FEATURE_VERSION(major, minor) ((major & 0xff) << 8 | (minor & 0xff)) 115 116 /* 117 * Status of a DualSense touch point contact. 118 * Contact IDs, with highest bit set are 'inactive' 119 * and any associated data is then invalid. 120 */ 121 #define DS_TOUCH_POINT_INACTIVE BIT(7) 122 123 /* Magic value required in tag field of Bluetooth output report. */ 124 #define DS_OUTPUT_TAG 0x10 125 /* Flags for DualSense output report. */ 126 #define DS_OUTPUT_VALID_FLAG0_COMPATIBLE_VIBRATION BIT(0) 127 #define DS_OUTPUT_VALID_FLAG0_HAPTICS_SELECT BIT(1) 128 #define DS_OUTPUT_VALID_FLAG1_MIC_MUTE_LED_CONTROL_ENABLE BIT(0) 129 #define DS_OUTPUT_VALID_FLAG1_POWER_SAVE_CONTROL_ENABLE BIT(1) 130 #define DS_OUTPUT_VALID_FLAG1_LIGHTBAR_CONTROL_ENABLE BIT(2) 131 #define DS_OUTPUT_VALID_FLAG1_RELEASE_LEDS BIT(3) 132 #define DS_OUTPUT_VALID_FLAG1_PLAYER_INDICATOR_CONTROL_ENABLE BIT(4) 133 #define DS_OUTPUT_VALID_FLAG2_LIGHTBAR_SETUP_CONTROL_ENABLE BIT(1) 134 #define DS_OUTPUT_VALID_FLAG2_COMPATIBLE_VIBRATION2 BIT(2) 135 #define DS_OUTPUT_POWER_SAVE_CONTROL_MIC_MUTE BIT(4) 136 #define DS_OUTPUT_LIGHTBAR_SETUP_LIGHT_OUT BIT(1) 137 138 /* DualSense hardware limits */ 139 #define DS_ACC_RES_PER_G 8192 140 #define DS_ACC_RANGE (4*DS_ACC_RES_PER_G) 141 #define DS_GYRO_RES_PER_DEG_S 1024 142 #define DS_GYRO_RANGE (2048*DS_GYRO_RES_PER_DEG_S) 143 #define DS_TOUCHPAD_WIDTH 1920 144 #define DS_TOUCHPAD_HEIGHT 1080 145 146 struct dualsense { 147 struct ps_device base; 148 struct input_dev *gamepad; 149 struct input_dev *sensors; 150 struct input_dev *touchpad; 151 152 /* Update version is used as a feature/capability version. */ 153 uint16_t update_version; 154 155 /* Calibration data for accelerometer and gyroscope. */ 156 struct ps_calibration_data accel_calib_data[3]; 157 struct ps_calibration_data gyro_calib_data[3]; 158 159 /* Timestamp for sensor data */ 160 bool sensor_timestamp_initialized; 161 uint32_t prev_sensor_timestamp; 162 uint32_t sensor_timestamp_us; 163 164 /* Compatible rumble state */ 165 bool use_vibration_v2; 166 bool update_rumble; 167 uint8_t motor_left; 168 uint8_t motor_right; 169 170 /* RGB lightbar */ 171 struct led_classdev_mc lightbar; 172 bool update_lightbar; 173 uint8_t lightbar_red; 174 uint8_t lightbar_green; 175 uint8_t lightbar_blue; 176 177 /* Microphone */ 178 bool update_mic_mute; 179 bool mic_muted; 180 bool last_btn_mic_state; 181 182 /* Player leds */ 183 bool update_player_leds; 184 uint8_t player_leds_state; 185 struct led_classdev player_leds[5]; 186 187 struct work_struct output_worker; 188 bool output_worker_initialized; 189 void *output_report_dmabuf; 190 uint8_t output_seq; /* Sequence number for output report. */ 191 }; 192 193 struct dualsense_touch_point { 194 uint8_t contact; 195 uint8_t x_lo; 196 uint8_t x_hi:4, y_lo:4; 197 uint8_t y_hi; 198 } __packed; 199 static_assert(sizeof(struct dualsense_touch_point) == 4); 200 201 /* Main DualSense input report excluding any BT/USB specific headers. */ 202 struct dualsense_input_report { 203 uint8_t x, y; 204 uint8_t rx, ry; 205 uint8_t z, rz; 206 uint8_t seq_number; 207 uint8_t buttons[4]; 208 uint8_t reserved[4]; 209 210 /* Motion sensors */ 211 __le16 gyro[3]; /* x, y, z */ 212 __le16 accel[3]; /* x, y, z */ 213 __le32 sensor_timestamp; 214 uint8_t reserved2; 215 216 /* Touchpad */ 217 struct dualsense_touch_point points[2]; 218 219 uint8_t reserved3[12]; 220 uint8_t status; 221 uint8_t reserved4[10]; 222 } __packed; 223 /* Common input report size shared equals the size of the USB report minus 1 byte for ReportID. */ 224 static_assert(sizeof(struct dualsense_input_report) == DS_INPUT_REPORT_USB_SIZE - 1); 225 226 /* Common data between DualSense BT/USB main output report. */ 227 struct dualsense_output_report_common { 228 uint8_t valid_flag0; 229 uint8_t valid_flag1; 230 231 /* For DualShock 4 compatibility mode. */ 232 uint8_t motor_right; 233 uint8_t motor_left; 234 235 /* Audio controls */ 236 uint8_t reserved[4]; 237 uint8_t mute_button_led; 238 239 uint8_t power_save_control; 240 uint8_t reserved2[28]; 241 242 /* LEDs and lightbar */ 243 uint8_t valid_flag2; 244 uint8_t reserved3[2]; 245 uint8_t lightbar_setup; 246 uint8_t led_brightness; 247 uint8_t player_leds; 248 uint8_t lightbar_red; 249 uint8_t lightbar_green; 250 uint8_t lightbar_blue; 251 } __packed; 252 static_assert(sizeof(struct dualsense_output_report_common) == 47); 253 254 struct dualsense_output_report_bt { 255 uint8_t report_id; /* 0x31 */ 256 uint8_t seq_tag; 257 uint8_t tag; 258 struct dualsense_output_report_common common; 259 uint8_t reserved[24]; 260 __le32 crc32; 261 } __packed; 262 static_assert(sizeof(struct dualsense_output_report_bt) == DS_OUTPUT_REPORT_BT_SIZE); 263 264 struct dualsense_output_report_usb { 265 uint8_t report_id; /* 0x02 */ 266 struct dualsense_output_report_common common; 267 uint8_t reserved[15]; 268 } __packed; 269 static_assert(sizeof(struct dualsense_output_report_usb) == DS_OUTPUT_REPORT_USB_SIZE); 270 271 /* 272 * The DualSense has a main output report used to control most features. It is 273 * largely the same between Bluetooth and USB except for different headers and CRC. 274 * This structure hide the differences between the two to simplify sending output reports. 275 */ 276 struct dualsense_output_report { 277 uint8_t *data; /* Start of data */ 278 uint8_t len; /* Size of output report */ 279 280 /* Points to Bluetooth data payload in case for a Bluetooth report else NULL. */ 281 struct dualsense_output_report_bt *bt; 282 /* Points to USB data payload in case for a USB report else NULL. */ 283 struct dualsense_output_report_usb *usb; 284 /* Points to common section of report, so past any headers. */ 285 struct dualsense_output_report_common *common; 286 }; 287 288 #define DS4_INPUT_REPORT_USB 0x01 289 #define DS4_INPUT_REPORT_USB_SIZE 64 290 #define DS4_INPUT_REPORT_BT 0x11 291 #define DS4_INPUT_REPORT_BT_SIZE 78 292 #define DS4_OUTPUT_REPORT_USB 0x05 293 #define DS4_OUTPUT_REPORT_USB_SIZE 32 294 #define DS4_OUTPUT_REPORT_BT 0x11 295 #define DS4_OUTPUT_REPORT_BT_SIZE 78 296 297 #define DS4_FEATURE_REPORT_CALIBRATION 0x02 298 #define DS4_FEATURE_REPORT_CALIBRATION_SIZE 37 299 #define DS4_FEATURE_REPORT_CALIBRATION_BT 0x05 300 #define DS4_FEATURE_REPORT_CALIBRATION_BT_SIZE 41 301 #define DS4_FEATURE_REPORT_FIRMWARE_INFO 0xa3 302 #define DS4_FEATURE_REPORT_FIRMWARE_INFO_SIZE 49 303 #define DS4_FEATURE_REPORT_PAIRING_INFO 0x12 304 #define DS4_FEATURE_REPORT_PAIRING_INFO_SIZE 16 305 306 /* 307 * Status of a DualShock4 touch point contact. 308 * Contact IDs, with highest bit set are 'inactive' 309 * and any associated data is then invalid. 310 */ 311 #define DS4_TOUCH_POINT_INACTIVE BIT(7) 312 313 /* Status field of DualShock4 input report. */ 314 #define DS4_STATUS0_BATTERY_CAPACITY GENMASK(3, 0) 315 #define DS4_STATUS0_CABLE_STATE BIT(4) 316 /* Battery status within batery_status field. */ 317 #define DS4_BATTERY_STATUS_FULL 11 318 /* Status1 bit2 contains dongle connection state: 319 * 0 = connectd 320 * 1 = disconnected 321 */ 322 #define DS4_STATUS1_DONGLE_STATE BIT(2) 323 324 /* The lower 6 bits of hw_control of the Bluetooth main output report 325 * control the interval at which Dualshock 4 reports data: 326 * 0x00 - 1ms 327 * 0x01 - 1ms 328 * 0x02 - 2ms 329 * 0x3E - 62ms 330 * 0x3F - disabled 331 */ 332 #define DS4_OUTPUT_HWCTL_BT_POLL_MASK 0x3F 333 /* Default to 4ms poll interval, which is same as USB (not adjustable). */ 334 #define DS4_BT_DEFAULT_POLL_INTERVAL_MS 4 335 #define DS4_OUTPUT_HWCTL_CRC32 0x40 336 #define DS4_OUTPUT_HWCTL_HID 0x80 337 338 /* Flags for DualShock4 output report. */ 339 #define DS4_OUTPUT_VALID_FLAG0_MOTOR 0x01 340 #define DS4_OUTPUT_VALID_FLAG0_LED 0x02 341 #define DS4_OUTPUT_VALID_FLAG0_LED_BLINK 0x04 342 343 /* DualShock4 hardware limits */ 344 #define DS4_ACC_RES_PER_G 8192 345 #define DS4_ACC_RANGE (4*DS_ACC_RES_PER_G) 346 #define DS4_GYRO_RES_PER_DEG_S 1024 347 #define DS4_GYRO_RANGE (2048*DS_GYRO_RES_PER_DEG_S) 348 #define DS4_LIGHTBAR_MAX_BLINK 255 /* 255 centiseconds */ 349 #define DS4_TOUCHPAD_WIDTH 1920 350 #define DS4_TOUCHPAD_HEIGHT 942 351 352 enum dualshock4_dongle_state { 353 DONGLE_DISCONNECTED, 354 DONGLE_CALIBRATING, 355 DONGLE_CONNECTED, 356 DONGLE_DISABLED 357 }; 358 359 struct dualshock4 { 360 struct ps_device base; 361 struct input_dev *gamepad; 362 struct input_dev *sensors; 363 struct input_dev *touchpad; 364 365 /* Calibration data for accelerometer and gyroscope. */ 366 struct ps_calibration_data accel_calib_data[3]; 367 struct ps_calibration_data gyro_calib_data[3]; 368 369 /* Only used on dongle to track state transitions. */ 370 enum dualshock4_dongle_state dongle_state; 371 /* Used during calibration. */ 372 struct work_struct dongle_hotplug_worker; 373 374 /* Timestamp for sensor data */ 375 bool sensor_timestamp_initialized; 376 uint32_t prev_sensor_timestamp; 377 uint32_t sensor_timestamp_us; 378 379 /* Bluetooth poll interval */ 380 bool update_bt_poll_interval; 381 uint8_t bt_poll_interval; 382 383 bool update_rumble; 384 uint8_t motor_left; 385 uint8_t motor_right; 386 387 /* Lightbar leds */ 388 bool update_lightbar; 389 bool update_lightbar_blink; 390 bool lightbar_enabled; /* For use by global LED control. */ 391 uint8_t lightbar_red; 392 uint8_t lightbar_green; 393 uint8_t lightbar_blue; 394 uint8_t lightbar_blink_on; /* In increments of 10ms. */ 395 uint8_t lightbar_blink_off; /* In increments of 10ms. */ 396 struct led_classdev lightbar_leds[4]; 397 398 struct work_struct output_worker; 399 bool output_worker_initialized; 400 void *output_report_dmabuf; 401 }; 402 403 struct dualshock4_touch_point { 404 uint8_t contact; 405 uint8_t x_lo; 406 uint8_t x_hi:4, y_lo:4; 407 uint8_t y_hi; 408 } __packed; 409 static_assert(sizeof(struct dualshock4_touch_point) == 4); 410 411 struct dualshock4_touch_report { 412 uint8_t timestamp; 413 struct dualshock4_touch_point points[2]; 414 } __packed; 415 static_assert(sizeof(struct dualshock4_touch_report) == 9); 416 417 /* Main DualShock4 input report excluding any BT/USB specific headers. */ 418 struct dualshock4_input_report_common { 419 uint8_t x, y; 420 uint8_t rx, ry; 421 uint8_t buttons[3]; 422 uint8_t z, rz; 423 424 /* Motion sensors */ 425 __le16 sensor_timestamp; 426 uint8_t sensor_temperature; 427 __le16 gyro[3]; /* x, y, z */ 428 __le16 accel[3]; /* x, y, z */ 429 uint8_t reserved2[5]; 430 431 uint8_t status[2]; 432 uint8_t reserved3; 433 } __packed; 434 static_assert(sizeof(struct dualshock4_input_report_common) == 32); 435 436 struct dualshock4_input_report_usb { 437 uint8_t report_id; /* 0x01 */ 438 struct dualshock4_input_report_common common; 439 uint8_t num_touch_reports; 440 struct dualshock4_touch_report touch_reports[3]; 441 uint8_t reserved[3]; 442 } __packed; 443 static_assert(sizeof(struct dualshock4_input_report_usb) == DS4_INPUT_REPORT_USB_SIZE); 444 445 struct dualshock4_input_report_bt { 446 uint8_t report_id; /* 0x11 */ 447 uint8_t reserved[2]; 448 struct dualshock4_input_report_common common; 449 uint8_t num_touch_reports; 450 struct dualshock4_touch_report touch_reports[4]; /* BT has 4 compared to 3 for USB */ 451 uint8_t reserved2[2]; 452 __le32 crc32; 453 } __packed; 454 static_assert(sizeof(struct dualshock4_input_report_bt) == DS4_INPUT_REPORT_BT_SIZE); 455 456 /* Common data between Bluetooth and USB DualShock4 output reports. */ 457 struct dualshock4_output_report_common { 458 uint8_t valid_flag0; 459 uint8_t valid_flag1; 460 461 uint8_t reserved; 462 463 uint8_t motor_right; 464 uint8_t motor_left; 465 466 uint8_t lightbar_red; 467 uint8_t lightbar_green; 468 uint8_t lightbar_blue; 469 uint8_t lightbar_blink_on; 470 uint8_t lightbar_blink_off; 471 } __packed; 472 473 struct dualshock4_output_report_usb { 474 uint8_t report_id; /* 0x5 */ 475 struct dualshock4_output_report_common common; 476 uint8_t reserved[21]; 477 } __packed; 478 static_assert(sizeof(struct dualshock4_output_report_usb) == DS4_OUTPUT_REPORT_USB_SIZE); 479 480 struct dualshock4_output_report_bt { 481 uint8_t report_id; /* 0x11 */ 482 uint8_t hw_control; 483 uint8_t audio_control; 484 struct dualshock4_output_report_common common; 485 uint8_t reserved[61]; 486 __le32 crc32; 487 } __packed; 488 static_assert(sizeof(struct dualshock4_output_report_bt) == DS4_OUTPUT_REPORT_BT_SIZE); 489 490 /* 491 * The DualShock4 has a main output report used to control most features. It is 492 * largely the same between Bluetooth and USB except for different headers and CRC. 493 * This structure hide the differences between the two to simplify sending output reports. 494 */ 495 struct dualshock4_output_report { 496 uint8_t *data; /* Start of data */ 497 uint8_t len; /* Size of output report */ 498 499 /* Points to Bluetooth data payload in case for a Bluetooth report else NULL. */ 500 struct dualshock4_output_report_bt *bt; 501 /* Points to USB data payload in case for a USB report else NULL. */ 502 struct dualshock4_output_report_usb *usb; 503 /* Points to common section of report, so past any headers. */ 504 struct dualshock4_output_report_common *common; 505 }; 506 507 /* 508 * Common gamepad buttons across DualShock 3 / 4 and DualSense. 509 * Note: for device with a touchpad, touchpad button is not included 510 * as it will be part of the touchpad device. 511 */ 512 static const int ps_gamepad_buttons[] = { 513 BTN_WEST, /* Square */ 514 BTN_NORTH, /* Triangle */ 515 BTN_EAST, /* Circle */ 516 BTN_SOUTH, /* Cross */ 517 BTN_TL, /* L1 */ 518 BTN_TR, /* R1 */ 519 BTN_TL2, /* L2 */ 520 BTN_TR2, /* R2 */ 521 BTN_SELECT, /* Create (PS5) / Share (PS4) */ 522 BTN_START, /* Option */ 523 BTN_THUMBL, /* L3 */ 524 BTN_THUMBR, /* R3 */ 525 BTN_MODE, /* PS Home */ 526 }; 527 528 static const struct {int x; int y; } ps_gamepad_hat_mapping[] = { 529 {0, -1}, {1, -1}, {1, 0}, {1, 1}, {0, 1}, {-1, 1}, {-1, 0}, {-1, -1}, 530 {0, 0}, 531 }; 532 533 static int dualshock4_get_calibration_data(struct dualshock4 *ds4); 534 static inline void dualsense_schedule_work(struct dualsense *ds); 535 static inline void dualshock4_schedule_work(struct dualshock4 *ds4); 536 static void dualsense_set_lightbar(struct dualsense *ds, uint8_t red, uint8_t green, uint8_t blue); 537 static void dualshock4_set_default_lightbar_colors(struct dualshock4 *ds4); 538 539 /* 540 * Add a new ps_device to ps_devices if it doesn't exist. 541 * Return error on duplicate device, which can happen if the same 542 * device is connected using both Bluetooth and USB. 543 */ 544 static int ps_devices_list_add(struct ps_device *dev) 545 { 546 struct ps_device *entry; 547 548 mutex_lock(&ps_devices_lock); 549 list_for_each_entry(entry, &ps_devices_list, list) { 550 if (!memcmp(entry->mac_address, dev->mac_address, sizeof(dev->mac_address))) { 551 hid_err(dev->hdev, "Duplicate device found for MAC address %pMR.\n", 552 dev->mac_address); 553 mutex_unlock(&ps_devices_lock); 554 return -EEXIST; 555 } 556 } 557 558 list_add_tail(&dev->list, &ps_devices_list); 559 mutex_unlock(&ps_devices_lock); 560 return 0; 561 } 562 563 static int ps_devices_list_remove(struct ps_device *dev) 564 { 565 mutex_lock(&ps_devices_lock); 566 list_del(&dev->list); 567 mutex_unlock(&ps_devices_lock); 568 return 0; 569 } 570 571 static int ps_device_set_player_id(struct ps_device *dev) 572 { 573 int ret = ida_alloc(&ps_player_id_allocator, GFP_KERNEL); 574 575 if (ret < 0) 576 return ret; 577 578 dev->player_id = ret; 579 return 0; 580 } 581 582 static void ps_device_release_player_id(struct ps_device *dev) 583 { 584 ida_free(&ps_player_id_allocator, dev->player_id); 585 586 dev->player_id = U32_MAX; 587 } 588 589 static struct input_dev *ps_allocate_input_dev(struct hid_device *hdev, const char *name_suffix) 590 { 591 struct input_dev *input_dev; 592 593 input_dev = devm_input_allocate_device(&hdev->dev); 594 if (!input_dev) 595 return ERR_PTR(-ENOMEM); 596 597 input_dev->id.bustype = hdev->bus; 598 input_dev->id.vendor = hdev->vendor; 599 input_dev->id.product = hdev->product; 600 input_dev->id.version = hdev->version; 601 input_dev->uniq = hdev->uniq; 602 603 if (name_suffix) { 604 input_dev->name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s %s", hdev->name, 605 name_suffix); 606 if (!input_dev->name) 607 return ERR_PTR(-ENOMEM); 608 } else { 609 input_dev->name = hdev->name; 610 } 611 612 input_set_drvdata(input_dev, hdev); 613 614 return input_dev; 615 } 616 617 static enum power_supply_property ps_power_supply_props[] = { 618 POWER_SUPPLY_PROP_STATUS, 619 POWER_SUPPLY_PROP_PRESENT, 620 POWER_SUPPLY_PROP_CAPACITY, 621 POWER_SUPPLY_PROP_SCOPE, 622 }; 623 624 static int ps_battery_get_property(struct power_supply *psy, 625 enum power_supply_property psp, 626 union power_supply_propval *val) 627 { 628 struct ps_device *dev = power_supply_get_drvdata(psy); 629 uint8_t battery_capacity; 630 int battery_status; 631 unsigned long flags; 632 int ret = 0; 633 634 spin_lock_irqsave(&dev->lock, flags); 635 battery_capacity = dev->battery_capacity; 636 battery_status = dev->battery_status; 637 spin_unlock_irqrestore(&dev->lock, flags); 638 639 switch (psp) { 640 case POWER_SUPPLY_PROP_STATUS: 641 val->intval = battery_status; 642 break; 643 case POWER_SUPPLY_PROP_PRESENT: 644 val->intval = 1; 645 break; 646 case POWER_SUPPLY_PROP_CAPACITY: 647 val->intval = battery_capacity; 648 break; 649 case POWER_SUPPLY_PROP_SCOPE: 650 val->intval = POWER_SUPPLY_SCOPE_DEVICE; 651 break; 652 default: 653 ret = -EINVAL; 654 break; 655 } 656 657 return ret; 658 } 659 660 static int ps_device_register_battery(struct ps_device *dev) 661 { 662 struct power_supply *battery; 663 struct power_supply_config battery_cfg = { .drv_data = dev }; 664 int ret; 665 666 dev->battery_desc.type = POWER_SUPPLY_TYPE_BATTERY; 667 dev->battery_desc.properties = ps_power_supply_props; 668 dev->battery_desc.num_properties = ARRAY_SIZE(ps_power_supply_props); 669 dev->battery_desc.get_property = ps_battery_get_property; 670 dev->battery_desc.name = devm_kasprintf(&dev->hdev->dev, GFP_KERNEL, 671 "ps-controller-battery-%pMR", dev->mac_address); 672 if (!dev->battery_desc.name) 673 return -ENOMEM; 674 675 battery = devm_power_supply_register(&dev->hdev->dev, &dev->battery_desc, &battery_cfg); 676 if (IS_ERR(battery)) { 677 ret = PTR_ERR(battery); 678 hid_err(dev->hdev, "Unable to register battery device: %d\n", ret); 679 return ret; 680 } 681 dev->battery = battery; 682 683 ret = power_supply_powers(dev->battery, &dev->hdev->dev); 684 if (ret) { 685 hid_err(dev->hdev, "Unable to activate battery device: %d\n", ret); 686 return ret; 687 } 688 689 return 0; 690 } 691 692 /* Compute crc32 of HID data and compare against expected CRC. */ 693 static bool ps_check_crc32(uint8_t seed, uint8_t *data, size_t len, uint32_t report_crc) 694 { 695 uint32_t crc; 696 697 crc = crc32_le(0xFFFFFFFF, &seed, 1); 698 crc = ~crc32_le(crc, data, len); 699 700 return crc == report_crc; 701 } 702 703 static struct input_dev *ps_gamepad_create(struct hid_device *hdev, 704 int (*play_effect)(struct input_dev *, void *, struct ff_effect *)) 705 { 706 struct input_dev *gamepad; 707 unsigned int i; 708 int ret; 709 710 gamepad = ps_allocate_input_dev(hdev, NULL); 711 if (IS_ERR(gamepad)) 712 return ERR_CAST(gamepad); 713 714 input_set_abs_params(gamepad, ABS_X, 0, 255, 0, 0); 715 input_set_abs_params(gamepad, ABS_Y, 0, 255, 0, 0); 716 input_set_abs_params(gamepad, ABS_Z, 0, 255, 0, 0); 717 input_set_abs_params(gamepad, ABS_RX, 0, 255, 0, 0); 718 input_set_abs_params(gamepad, ABS_RY, 0, 255, 0, 0); 719 input_set_abs_params(gamepad, ABS_RZ, 0, 255, 0, 0); 720 721 input_set_abs_params(gamepad, ABS_HAT0X, -1, 1, 0, 0); 722 input_set_abs_params(gamepad, ABS_HAT0Y, -1, 1, 0, 0); 723 724 for (i = 0; i < ARRAY_SIZE(ps_gamepad_buttons); i++) 725 input_set_capability(gamepad, EV_KEY, ps_gamepad_buttons[i]); 726 727 #if IS_ENABLED(CONFIG_PLAYSTATION_FF) 728 if (play_effect) { 729 input_set_capability(gamepad, EV_FF, FF_RUMBLE); 730 input_ff_create_memless(gamepad, NULL, play_effect); 731 } 732 #endif 733 734 ret = input_register_device(gamepad); 735 if (ret) 736 return ERR_PTR(ret); 737 738 return gamepad; 739 } 740 741 static int ps_get_report(struct hid_device *hdev, uint8_t report_id, uint8_t *buf, size_t size, 742 bool check_crc) 743 { 744 int ret; 745 746 ret = hid_hw_raw_request(hdev, report_id, buf, size, HID_FEATURE_REPORT, 747 HID_REQ_GET_REPORT); 748 if (ret < 0) { 749 hid_err(hdev, "Failed to retrieve feature with reportID %d: %d\n", report_id, ret); 750 return ret; 751 } 752 753 if (ret != size) { 754 hid_err(hdev, "Invalid byte count transferred, expected %zu got %d\n", size, ret); 755 return -EINVAL; 756 } 757 758 if (buf[0] != report_id) { 759 hid_err(hdev, "Invalid reportID received, expected %d got %d\n", report_id, buf[0]); 760 return -EINVAL; 761 } 762 763 if (hdev->bus == BUS_BLUETOOTH && check_crc) { 764 /* Last 4 bytes contains crc32. */ 765 uint8_t crc_offset = size - 4; 766 uint32_t report_crc = get_unaligned_le32(&buf[crc_offset]); 767 768 if (!ps_check_crc32(PS_FEATURE_CRC32_SEED, buf, crc_offset, report_crc)) { 769 hid_err(hdev, "CRC check failed for reportID=%d\n", report_id); 770 return -EILSEQ; 771 } 772 } 773 774 return 0; 775 } 776 777 static int ps_led_register(struct ps_device *ps_dev, struct led_classdev *led, 778 const struct ps_led_info *led_info) 779 { 780 int ret; 781 782 if (led_info->name) { 783 led->name = devm_kasprintf(&ps_dev->hdev->dev, GFP_KERNEL, 784 "%s:%s:%s", ps_dev->input_dev_name, led_info->color, led_info->name); 785 } else { 786 /* Backwards compatible mode for hid-sony, but not compliant with LED class spec. */ 787 led->name = devm_kasprintf(&ps_dev->hdev->dev, GFP_KERNEL, 788 "%s:%s", ps_dev->input_dev_name, led_info->color); 789 } 790 791 if (!led->name) 792 return -ENOMEM; 793 794 led->brightness = 0; 795 led->max_brightness = led_info->max_brightness; 796 led->flags = LED_CORE_SUSPENDRESUME; 797 led->brightness_get = led_info->brightness_get; 798 led->brightness_set_blocking = led_info->brightness_set; 799 led->blink_set = led_info->blink_set; 800 801 ret = devm_led_classdev_register(&ps_dev->hdev->dev, led); 802 if (ret) { 803 hid_err(ps_dev->hdev, "Failed to register LED %s: %d\n", led_info->name, ret); 804 return ret; 805 } 806 807 return 0; 808 } 809 810 /* Register a DualSense/DualShock4 RGB lightbar represented by a multicolor LED. */ 811 static int ps_lightbar_register(struct ps_device *ps_dev, struct led_classdev_mc *lightbar_mc_dev, 812 int (*brightness_set)(struct led_classdev *, enum led_brightness)) 813 { 814 struct hid_device *hdev = ps_dev->hdev; 815 struct mc_subled *mc_led_info; 816 struct led_classdev *led_cdev; 817 int ret; 818 819 mc_led_info = devm_kmalloc_array(&hdev->dev, 3, sizeof(*mc_led_info), 820 GFP_KERNEL | __GFP_ZERO); 821 if (!mc_led_info) 822 return -ENOMEM; 823 824 mc_led_info[0].color_index = LED_COLOR_ID_RED; 825 mc_led_info[1].color_index = LED_COLOR_ID_GREEN; 826 mc_led_info[2].color_index = LED_COLOR_ID_BLUE; 827 828 lightbar_mc_dev->subled_info = mc_led_info; 829 lightbar_mc_dev->num_colors = 3; 830 831 led_cdev = &lightbar_mc_dev->led_cdev; 832 led_cdev->name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s:rgb:indicator", 833 ps_dev->input_dev_name); 834 if (!led_cdev->name) 835 return -ENOMEM; 836 led_cdev->brightness = 255; 837 led_cdev->max_brightness = 255; 838 led_cdev->brightness_set_blocking = brightness_set; 839 840 ret = devm_led_classdev_multicolor_register(&hdev->dev, lightbar_mc_dev); 841 if (ret < 0) { 842 hid_err(hdev, "Cannot register multicolor LED device\n"); 843 return ret; 844 } 845 846 return 0; 847 } 848 849 static struct input_dev *ps_sensors_create(struct hid_device *hdev, int accel_range, int accel_res, 850 int gyro_range, int gyro_res) 851 { 852 struct input_dev *sensors; 853 int ret; 854 855 sensors = ps_allocate_input_dev(hdev, "Motion Sensors"); 856 if (IS_ERR(sensors)) 857 return ERR_CAST(sensors); 858 859 __set_bit(INPUT_PROP_ACCELEROMETER, sensors->propbit); 860 __set_bit(EV_MSC, sensors->evbit); 861 __set_bit(MSC_TIMESTAMP, sensors->mscbit); 862 863 /* Accelerometer */ 864 input_set_abs_params(sensors, ABS_X, -accel_range, accel_range, 16, 0); 865 input_set_abs_params(sensors, ABS_Y, -accel_range, accel_range, 16, 0); 866 input_set_abs_params(sensors, ABS_Z, -accel_range, accel_range, 16, 0); 867 input_abs_set_res(sensors, ABS_X, accel_res); 868 input_abs_set_res(sensors, ABS_Y, accel_res); 869 input_abs_set_res(sensors, ABS_Z, accel_res); 870 871 /* Gyroscope */ 872 input_set_abs_params(sensors, ABS_RX, -gyro_range, gyro_range, 16, 0); 873 input_set_abs_params(sensors, ABS_RY, -gyro_range, gyro_range, 16, 0); 874 input_set_abs_params(sensors, ABS_RZ, -gyro_range, gyro_range, 16, 0); 875 input_abs_set_res(sensors, ABS_RX, gyro_res); 876 input_abs_set_res(sensors, ABS_RY, gyro_res); 877 input_abs_set_res(sensors, ABS_RZ, gyro_res); 878 879 ret = input_register_device(sensors); 880 if (ret) 881 return ERR_PTR(ret); 882 883 return sensors; 884 } 885 886 static struct input_dev *ps_touchpad_create(struct hid_device *hdev, int width, int height, 887 unsigned int num_contacts) 888 { 889 struct input_dev *touchpad; 890 int ret; 891 892 touchpad = ps_allocate_input_dev(hdev, "Touchpad"); 893 if (IS_ERR(touchpad)) 894 return ERR_CAST(touchpad); 895 896 /* Map button underneath touchpad to BTN_LEFT. */ 897 input_set_capability(touchpad, EV_KEY, BTN_LEFT); 898 __set_bit(INPUT_PROP_BUTTONPAD, touchpad->propbit); 899 900 input_set_abs_params(touchpad, ABS_MT_POSITION_X, 0, width - 1, 0, 0); 901 input_set_abs_params(touchpad, ABS_MT_POSITION_Y, 0, height - 1, 0, 0); 902 903 ret = input_mt_init_slots(touchpad, num_contacts, INPUT_MT_POINTER); 904 if (ret) 905 return ERR_PTR(ret); 906 907 ret = input_register_device(touchpad); 908 if (ret) 909 return ERR_PTR(ret); 910 911 return touchpad; 912 } 913 914 static ssize_t firmware_version_show(struct device *dev, 915 struct device_attribute 916 *attr, char *buf) 917 { 918 struct hid_device *hdev = to_hid_device(dev); 919 struct ps_device *ps_dev = hid_get_drvdata(hdev); 920 921 return sysfs_emit(buf, "0x%08x\n", ps_dev->fw_version); 922 } 923 924 static DEVICE_ATTR_RO(firmware_version); 925 926 static ssize_t hardware_version_show(struct device *dev, 927 struct device_attribute 928 *attr, char *buf) 929 { 930 struct hid_device *hdev = to_hid_device(dev); 931 struct ps_device *ps_dev = hid_get_drvdata(hdev); 932 933 return sysfs_emit(buf, "0x%08x\n", ps_dev->hw_version); 934 } 935 936 static DEVICE_ATTR_RO(hardware_version); 937 938 static struct attribute *ps_device_attrs[] = { 939 &dev_attr_firmware_version.attr, 940 &dev_attr_hardware_version.attr, 941 NULL 942 }; 943 ATTRIBUTE_GROUPS(ps_device); 944 945 static int dualsense_get_calibration_data(struct dualsense *ds) 946 { 947 short gyro_pitch_bias, gyro_pitch_plus, gyro_pitch_minus; 948 short gyro_yaw_bias, gyro_yaw_plus, gyro_yaw_minus; 949 short gyro_roll_bias, gyro_roll_plus, gyro_roll_minus; 950 short gyro_speed_plus, gyro_speed_minus; 951 short acc_x_plus, acc_x_minus; 952 short acc_y_plus, acc_y_minus; 953 short acc_z_plus, acc_z_minus; 954 int speed_2x; 955 int range_2g; 956 int ret = 0; 957 uint8_t *buf; 958 959 buf = kzalloc(DS_FEATURE_REPORT_CALIBRATION_SIZE, GFP_KERNEL); 960 if (!buf) 961 return -ENOMEM; 962 963 ret = ps_get_report(ds->base.hdev, DS_FEATURE_REPORT_CALIBRATION, buf, 964 DS_FEATURE_REPORT_CALIBRATION_SIZE, true); 965 if (ret) { 966 hid_err(ds->base.hdev, "Failed to retrieve DualSense calibration info: %d\n", ret); 967 goto err_free; 968 } 969 970 gyro_pitch_bias = get_unaligned_le16(&buf[1]); 971 gyro_yaw_bias = get_unaligned_le16(&buf[3]); 972 gyro_roll_bias = get_unaligned_le16(&buf[5]); 973 gyro_pitch_plus = get_unaligned_le16(&buf[7]); 974 gyro_pitch_minus = get_unaligned_le16(&buf[9]); 975 gyro_yaw_plus = get_unaligned_le16(&buf[11]); 976 gyro_yaw_minus = get_unaligned_le16(&buf[13]); 977 gyro_roll_plus = get_unaligned_le16(&buf[15]); 978 gyro_roll_minus = get_unaligned_le16(&buf[17]); 979 gyro_speed_plus = get_unaligned_le16(&buf[19]); 980 gyro_speed_minus = get_unaligned_le16(&buf[21]); 981 acc_x_plus = get_unaligned_le16(&buf[23]); 982 acc_x_minus = get_unaligned_le16(&buf[25]); 983 acc_y_plus = get_unaligned_le16(&buf[27]); 984 acc_y_minus = get_unaligned_le16(&buf[29]); 985 acc_z_plus = get_unaligned_le16(&buf[31]); 986 acc_z_minus = get_unaligned_le16(&buf[33]); 987 988 /* 989 * Set gyroscope calibration and normalization parameters. 990 * Data values will be normalized to 1/DS_GYRO_RES_PER_DEG_S degree/s. 991 */ 992 speed_2x = (gyro_speed_plus + gyro_speed_minus); 993 ds->gyro_calib_data[0].abs_code = ABS_RX; 994 ds->gyro_calib_data[0].bias = gyro_pitch_bias; 995 ds->gyro_calib_data[0].sens_numer = speed_2x*DS_GYRO_RES_PER_DEG_S; 996 ds->gyro_calib_data[0].sens_denom = gyro_pitch_plus - gyro_pitch_minus; 997 998 ds->gyro_calib_data[1].abs_code = ABS_RY; 999 ds->gyro_calib_data[1].bias = gyro_yaw_bias; 1000 ds->gyro_calib_data[1].sens_numer = speed_2x*DS_GYRO_RES_PER_DEG_S; 1001 ds->gyro_calib_data[1].sens_denom = gyro_yaw_plus - gyro_yaw_minus; 1002 1003 ds->gyro_calib_data[2].abs_code = ABS_RZ; 1004 ds->gyro_calib_data[2].bias = gyro_roll_bias; 1005 ds->gyro_calib_data[2].sens_numer = speed_2x*DS_GYRO_RES_PER_DEG_S; 1006 ds->gyro_calib_data[2].sens_denom = gyro_roll_plus - gyro_roll_minus; 1007 1008 /* 1009 * Set accelerometer calibration and normalization parameters. 1010 * Data values will be normalized to 1/DS_ACC_RES_PER_G g. 1011 */ 1012 range_2g = acc_x_plus - acc_x_minus; 1013 ds->accel_calib_data[0].abs_code = ABS_X; 1014 ds->accel_calib_data[0].bias = acc_x_plus - range_2g / 2; 1015 ds->accel_calib_data[0].sens_numer = 2*DS_ACC_RES_PER_G; 1016 ds->accel_calib_data[0].sens_denom = range_2g; 1017 1018 range_2g = acc_y_plus - acc_y_minus; 1019 ds->accel_calib_data[1].abs_code = ABS_Y; 1020 ds->accel_calib_data[1].bias = acc_y_plus - range_2g / 2; 1021 ds->accel_calib_data[1].sens_numer = 2*DS_ACC_RES_PER_G; 1022 ds->accel_calib_data[1].sens_denom = range_2g; 1023 1024 range_2g = acc_z_plus - acc_z_minus; 1025 ds->accel_calib_data[2].abs_code = ABS_Z; 1026 ds->accel_calib_data[2].bias = acc_z_plus - range_2g / 2; 1027 ds->accel_calib_data[2].sens_numer = 2*DS_ACC_RES_PER_G; 1028 ds->accel_calib_data[2].sens_denom = range_2g; 1029 1030 err_free: 1031 kfree(buf); 1032 return ret; 1033 } 1034 1035 1036 static int dualsense_get_firmware_info(struct dualsense *ds) 1037 { 1038 uint8_t *buf; 1039 int ret; 1040 1041 buf = kzalloc(DS_FEATURE_REPORT_FIRMWARE_INFO_SIZE, GFP_KERNEL); 1042 if (!buf) 1043 return -ENOMEM; 1044 1045 ret = ps_get_report(ds->base.hdev, DS_FEATURE_REPORT_FIRMWARE_INFO, buf, 1046 DS_FEATURE_REPORT_FIRMWARE_INFO_SIZE, true); 1047 if (ret) { 1048 hid_err(ds->base.hdev, "Failed to retrieve DualSense firmware info: %d\n", ret); 1049 goto err_free; 1050 } 1051 1052 ds->base.hw_version = get_unaligned_le32(&buf[24]); 1053 ds->base.fw_version = get_unaligned_le32(&buf[28]); 1054 1055 /* Update version is some kind of feature version. It is distinct from 1056 * the firmware version as there can be many different variations of a 1057 * controller over time with the same physical shell, but with different 1058 * PCBs and other internal changes. The update version (internal name) is 1059 * used as a means to detect what features are available and change behavior. 1060 * Note: the version is different between DualSense and DualSense Edge. 1061 */ 1062 ds->update_version = get_unaligned_le16(&buf[44]); 1063 1064 err_free: 1065 kfree(buf); 1066 return ret; 1067 } 1068 1069 static int dualsense_get_mac_address(struct dualsense *ds) 1070 { 1071 uint8_t *buf; 1072 int ret = 0; 1073 1074 buf = kzalloc(DS_FEATURE_REPORT_PAIRING_INFO_SIZE, GFP_KERNEL); 1075 if (!buf) 1076 return -ENOMEM; 1077 1078 ret = ps_get_report(ds->base.hdev, DS_FEATURE_REPORT_PAIRING_INFO, buf, 1079 DS_FEATURE_REPORT_PAIRING_INFO_SIZE, true); 1080 if (ret) { 1081 hid_err(ds->base.hdev, "Failed to retrieve DualSense pairing info: %d\n", ret); 1082 goto err_free; 1083 } 1084 1085 memcpy(ds->base.mac_address, &buf[1], sizeof(ds->base.mac_address)); 1086 1087 err_free: 1088 kfree(buf); 1089 return ret; 1090 } 1091 1092 static int dualsense_lightbar_set_brightness(struct led_classdev *cdev, 1093 enum led_brightness brightness) 1094 { 1095 struct led_classdev_mc *mc_cdev = lcdev_to_mccdev(cdev); 1096 struct dualsense *ds = container_of(mc_cdev, struct dualsense, lightbar); 1097 uint8_t red, green, blue; 1098 1099 led_mc_calc_color_components(mc_cdev, brightness); 1100 red = mc_cdev->subled_info[0].brightness; 1101 green = mc_cdev->subled_info[1].brightness; 1102 blue = mc_cdev->subled_info[2].brightness; 1103 1104 dualsense_set_lightbar(ds, red, green, blue); 1105 return 0; 1106 } 1107 1108 static enum led_brightness dualsense_player_led_get_brightness(struct led_classdev *led) 1109 { 1110 struct hid_device *hdev = to_hid_device(led->dev->parent); 1111 struct dualsense *ds = hid_get_drvdata(hdev); 1112 1113 return !!(ds->player_leds_state & BIT(led - ds->player_leds)); 1114 } 1115 1116 static int dualsense_player_led_set_brightness(struct led_classdev *led, enum led_brightness value) 1117 { 1118 struct hid_device *hdev = to_hid_device(led->dev->parent); 1119 struct dualsense *ds = hid_get_drvdata(hdev); 1120 unsigned long flags; 1121 unsigned int led_index; 1122 1123 spin_lock_irqsave(&ds->base.lock, flags); 1124 1125 led_index = led - ds->player_leds; 1126 if (value == LED_OFF) 1127 ds->player_leds_state &= ~BIT(led_index); 1128 else 1129 ds->player_leds_state |= BIT(led_index); 1130 1131 ds->update_player_leds = true; 1132 spin_unlock_irqrestore(&ds->base.lock, flags); 1133 1134 dualsense_schedule_work(ds); 1135 1136 return 0; 1137 } 1138 1139 static void dualsense_init_output_report(struct dualsense *ds, struct dualsense_output_report *rp, 1140 void *buf) 1141 { 1142 struct hid_device *hdev = ds->base.hdev; 1143 1144 if (hdev->bus == BUS_BLUETOOTH) { 1145 struct dualsense_output_report_bt *bt = buf; 1146 1147 memset(bt, 0, sizeof(*bt)); 1148 bt->report_id = DS_OUTPUT_REPORT_BT; 1149 bt->tag = DS_OUTPUT_TAG; /* Tag must be set. Exact meaning is unclear. */ 1150 1151 /* 1152 * Highest 4-bit is a sequence number, which needs to be increased 1153 * every report. Lowest 4-bit is tag and can be zero for now. 1154 */ 1155 bt->seq_tag = (ds->output_seq << 4) | 0x0; 1156 if (++ds->output_seq == 16) 1157 ds->output_seq = 0; 1158 1159 rp->data = buf; 1160 rp->len = sizeof(*bt); 1161 rp->bt = bt; 1162 rp->usb = NULL; 1163 rp->common = &bt->common; 1164 } else { /* USB */ 1165 struct dualsense_output_report_usb *usb = buf; 1166 1167 memset(usb, 0, sizeof(*usb)); 1168 usb->report_id = DS_OUTPUT_REPORT_USB; 1169 1170 rp->data = buf; 1171 rp->len = sizeof(*usb); 1172 rp->bt = NULL; 1173 rp->usb = usb; 1174 rp->common = &usb->common; 1175 } 1176 } 1177 1178 static inline void dualsense_schedule_work(struct dualsense *ds) 1179 { 1180 unsigned long flags; 1181 1182 spin_lock_irqsave(&ds->base.lock, flags); 1183 if (ds->output_worker_initialized) 1184 schedule_work(&ds->output_worker); 1185 spin_unlock_irqrestore(&ds->base.lock, flags); 1186 } 1187 1188 /* 1189 * Helper function to send DualSense output reports. Applies a CRC at the end of a report 1190 * for Bluetooth reports. 1191 */ 1192 static void dualsense_send_output_report(struct dualsense *ds, 1193 struct dualsense_output_report *report) 1194 { 1195 struct hid_device *hdev = ds->base.hdev; 1196 1197 /* Bluetooth packets need to be signed with a CRC in the last 4 bytes. */ 1198 if (report->bt) { 1199 uint32_t crc; 1200 uint8_t seed = PS_OUTPUT_CRC32_SEED; 1201 1202 crc = crc32_le(0xFFFFFFFF, &seed, 1); 1203 crc = ~crc32_le(crc, report->data, report->len - 4); 1204 1205 report->bt->crc32 = cpu_to_le32(crc); 1206 } 1207 1208 hid_hw_output_report(hdev, report->data, report->len); 1209 } 1210 1211 static void dualsense_output_worker(struct work_struct *work) 1212 { 1213 struct dualsense *ds = container_of(work, struct dualsense, output_worker); 1214 struct dualsense_output_report report; 1215 struct dualsense_output_report_common *common; 1216 unsigned long flags; 1217 1218 dualsense_init_output_report(ds, &report, ds->output_report_dmabuf); 1219 common = report.common; 1220 1221 spin_lock_irqsave(&ds->base.lock, flags); 1222 1223 if (ds->update_rumble) { 1224 /* Select classic rumble style haptics and enable it. */ 1225 common->valid_flag0 |= DS_OUTPUT_VALID_FLAG0_HAPTICS_SELECT; 1226 if (ds->use_vibration_v2) 1227 common->valid_flag2 |= DS_OUTPUT_VALID_FLAG2_COMPATIBLE_VIBRATION2; 1228 else 1229 common->valid_flag0 |= DS_OUTPUT_VALID_FLAG0_COMPATIBLE_VIBRATION; 1230 common->motor_left = ds->motor_left; 1231 common->motor_right = ds->motor_right; 1232 ds->update_rumble = false; 1233 } 1234 1235 if (ds->update_lightbar) { 1236 common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_LIGHTBAR_CONTROL_ENABLE; 1237 common->lightbar_red = ds->lightbar_red; 1238 common->lightbar_green = ds->lightbar_green; 1239 common->lightbar_blue = ds->lightbar_blue; 1240 1241 ds->update_lightbar = false; 1242 } 1243 1244 if (ds->update_player_leds) { 1245 common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_PLAYER_INDICATOR_CONTROL_ENABLE; 1246 common->player_leds = ds->player_leds_state; 1247 1248 ds->update_player_leds = false; 1249 } 1250 1251 if (ds->update_mic_mute) { 1252 common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_MIC_MUTE_LED_CONTROL_ENABLE; 1253 common->mute_button_led = ds->mic_muted; 1254 1255 if (ds->mic_muted) { 1256 /* Disable microphone */ 1257 common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_POWER_SAVE_CONTROL_ENABLE; 1258 common->power_save_control |= DS_OUTPUT_POWER_SAVE_CONTROL_MIC_MUTE; 1259 } else { 1260 /* Enable microphone */ 1261 common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_POWER_SAVE_CONTROL_ENABLE; 1262 common->power_save_control &= ~DS_OUTPUT_POWER_SAVE_CONTROL_MIC_MUTE; 1263 } 1264 1265 ds->update_mic_mute = false; 1266 } 1267 1268 spin_unlock_irqrestore(&ds->base.lock, flags); 1269 1270 dualsense_send_output_report(ds, &report); 1271 } 1272 1273 static int dualsense_parse_report(struct ps_device *ps_dev, struct hid_report *report, 1274 u8 *data, int size) 1275 { 1276 struct hid_device *hdev = ps_dev->hdev; 1277 struct dualsense *ds = container_of(ps_dev, struct dualsense, base); 1278 struct dualsense_input_report *ds_report; 1279 uint8_t battery_data, battery_capacity, charging_status, value; 1280 int battery_status; 1281 uint32_t sensor_timestamp; 1282 bool btn_mic_state; 1283 unsigned long flags; 1284 int i; 1285 1286 /* 1287 * DualSense in USB uses the full HID report for reportID 1, but 1288 * Bluetooth uses a minimal HID report for reportID 1 and reports 1289 * the full report using reportID 49. 1290 */ 1291 if (hdev->bus == BUS_USB && report->id == DS_INPUT_REPORT_USB && 1292 size == DS_INPUT_REPORT_USB_SIZE) { 1293 ds_report = (struct dualsense_input_report *)&data[1]; 1294 } else if (hdev->bus == BUS_BLUETOOTH && report->id == DS_INPUT_REPORT_BT && 1295 size == DS_INPUT_REPORT_BT_SIZE) { 1296 /* Last 4 bytes of input report contain crc32 */ 1297 uint32_t report_crc = get_unaligned_le32(&data[size - 4]); 1298 1299 if (!ps_check_crc32(PS_INPUT_CRC32_SEED, data, size - 4, report_crc)) { 1300 hid_err(hdev, "DualSense input CRC's check failed\n"); 1301 return -EILSEQ; 1302 } 1303 1304 ds_report = (struct dualsense_input_report *)&data[2]; 1305 } else { 1306 hid_err(hdev, "Unhandled reportID=%d\n", report->id); 1307 return -1; 1308 } 1309 1310 input_report_abs(ds->gamepad, ABS_X, ds_report->x); 1311 input_report_abs(ds->gamepad, ABS_Y, ds_report->y); 1312 input_report_abs(ds->gamepad, ABS_RX, ds_report->rx); 1313 input_report_abs(ds->gamepad, ABS_RY, ds_report->ry); 1314 input_report_abs(ds->gamepad, ABS_Z, ds_report->z); 1315 input_report_abs(ds->gamepad, ABS_RZ, ds_report->rz); 1316 1317 value = ds_report->buttons[0] & DS_BUTTONS0_HAT_SWITCH; 1318 if (value >= ARRAY_SIZE(ps_gamepad_hat_mapping)) 1319 value = 8; /* center */ 1320 input_report_abs(ds->gamepad, ABS_HAT0X, ps_gamepad_hat_mapping[value].x); 1321 input_report_abs(ds->gamepad, ABS_HAT0Y, ps_gamepad_hat_mapping[value].y); 1322 1323 input_report_key(ds->gamepad, BTN_WEST, ds_report->buttons[0] & DS_BUTTONS0_SQUARE); 1324 input_report_key(ds->gamepad, BTN_SOUTH, ds_report->buttons[0] & DS_BUTTONS0_CROSS); 1325 input_report_key(ds->gamepad, BTN_EAST, ds_report->buttons[0] & DS_BUTTONS0_CIRCLE); 1326 input_report_key(ds->gamepad, BTN_NORTH, ds_report->buttons[0] & DS_BUTTONS0_TRIANGLE); 1327 input_report_key(ds->gamepad, BTN_TL, ds_report->buttons[1] & DS_BUTTONS1_L1); 1328 input_report_key(ds->gamepad, BTN_TR, ds_report->buttons[1] & DS_BUTTONS1_R1); 1329 input_report_key(ds->gamepad, BTN_TL2, ds_report->buttons[1] & DS_BUTTONS1_L2); 1330 input_report_key(ds->gamepad, BTN_TR2, ds_report->buttons[1] & DS_BUTTONS1_R2); 1331 input_report_key(ds->gamepad, BTN_SELECT, ds_report->buttons[1] & DS_BUTTONS1_CREATE); 1332 input_report_key(ds->gamepad, BTN_START, ds_report->buttons[1] & DS_BUTTONS1_OPTIONS); 1333 input_report_key(ds->gamepad, BTN_THUMBL, ds_report->buttons[1] & DS_BUTTONS1_L3); 1334 input_report_key(ds->gamepad, BTN_THUMBR, ds_report->buttons[1] & DS_BUTTONS1_R3); 1335 input_report_key(ds->gamepad, BTN_MODE, ds_report->buttons[2] & DS_BUTTONS2_PS_HOME); 1336 input_sync(ds->gamepad); 1337 1338 /* 1339 * The DualSense has an internal microphone, which can be muted through a mute button 1340 * on the device. The driver is expected to read the button state and program the device 1341 * to mute/unmute audio at the hardware level. 1342 */ 1343 btn_mic_state = !!(ds_report->buttons[2] & DS_BUTTONS2_MIC_MUTE); 1344 if (btn_mic_state && !ds->last_btn_mic_state) { 1345 spin_lock_irqsave(&ps_dev->lock, flags); 1346 ds->update_mic_mute = true; 1347 ds->mic_muted = !ds->mic_muted; /* toggle */ 1348 spin_unlock_irqrestore(&ps_dev->lock, flags); 1349 1350 /* Schedule updating of microphone state at hardware level. */ 1351 dualsense_schedule_work(ds); 1352 } 1353 ds->last_btn_mic_state = btn_mic_state; 1354 1355 /* Parse and calibrate gyroscope data. */ 1356 for (i = 0; i < ARRAY_SIZE(ds_report->gyro); i++) { 1357 int raw_data = (short)le16_to_cpu(ds_report->gyro[i]); 1358 int calib_data = mult_frac(ds->gyro_calib_data[i].sens_numer, 1359 raw_data - ds->gyro_calib_data[i].bias, 1360 ds->gyro_calib_data[i].sens_denom); 1361 1362 input_report_abs(ds->sensors, ds->gyro_calib_data[i].abs_code, calib_data); 1363 } 1364 1365 /* Parse and calibrate accelerometer data. */ 1366 for (i = 0; i < ARRAY_SIZE(ds_report->accel); i++) { 1367 int raw_data = (short)le16_to_cpu(ds_report->accel[i]); 1368 int calib_data = mult_frac(ds->accel_calib_data[i].sens_numer, 1369 raw_data - ds->accel_calib_data[i].bias, 1370 ds->accel_calib_data[i].sens_denom); 1371 1372 input_report_abs(ds->sensors, ds->accel_calib_data[i].abs_code, calib_data); 1373 } 1374 1375 /* Convert timestamp (in 0.33us unit) to timestamp_us */ 1376 sensor_timestamp = le32_to_cpu(ds_report->sensor_timestamp); 1377 if (!ds->sensor_timestamp_initialized) { 1378 ds->sensor_timestamp_us = DIV_ROUND_CLOSEST(sensor_timestamp, 3); 1379 ds->sensor_timestamp_initialized = true; 1380 } else { 1381 uint32_t delta; 1382 1383 if (ds->prev_sensor_timestamp > sensor_timestamp) 1384 delta = (U32_MAX - ds->prev_sensor_timestamp + sensor_timestamp + 1); 1385 else 1386 delta = sensor_timestamp - ds->prev_sensor_timestamp; 1387 ds->sensor_timestamp_us += DIV_ROUND_CLOSEST(delta, 3); 1388 } 1389 ds->prev_sensor_timestamp = sensor_timestamp; 1390 input_event(ds->sensors, EV_MSC, MSC_TIMESTAMP, ds->sensor_timestamp_us); 1391 input_sync(ds->sensors); 1392 1393 for (i = 0; i < ARRAY_SIZE(ds_report->points); i++) { 1394 struct dualsense_touch_point *point = &ds_report->points[i]; 1395 bool active = (point->contact & DS_TOUCH_POINT_INACTIVE) ? false : true; 1396 1397 input_mt_slot(ds->touchpad, i); 1398 input_mt_report_slot_state(ds->touchpad, MT_TOOL_FINGER, active); 1399 1400 if (active) { 1401 int x = (point->x_hi << 8) | point->x_lo; 1402 int y = (point->y_hi << 4) | point->y_lo; 1403 1404 input_report_abs(ds->touchpad, ABS_MT_POSITION_X, x); 1405 input_report_abs(ds->touchpad, ABS_MT_POSITION_Y, y); 1406 } 1407 } 1408 input_mt_sync_frame(ds->touchpad); 1409 input_report_key(ds->touchpad, BTN_LEFT, ds_report->buttons[2] & DS_BUTTONS2_TOUCHPAD); 1410 input_sync(ds->touchpad); 1411 1412 battery_data = ds_report->status & DS_STATUS_BATTERY_CAPACITY; 1413 charging_status = (ds_report->status & DS_STATUS_CHARGING) >> DS_STATUS_CHARGING_SHIFT; 1414 1415 switch (charging_status) { 1416 case 0x0: 1417 /* 1418 * Each unit of battery data corresponds to 10% 1419 * 0 = 0-9%, 1 = 10-19%, .. and 10 = 100% 1420 */ 1421 battery_capacity = min(battery_data * 10 + 5, 100); 1422 battery_status = POWER_SUPPLY_STATUS_DISCHARGING; 1423 break; 1424 case 0x1: 1425 battery_capacity = min(battery_data * 10 + 5, 100); 1426 battery_status = POWER_SUPPLY_STATUS_CHARGING; 1427 break; 1428 case 0x2: 1429 battery_capacity = 100; 1430 battery_status = POWER_SUPPLY_STATUS_FULL; 1431 break; 1432 case 0xa: /* voltage or temperature out of range */ 1433 case 0xb: /* temperature error */ 1434 battery_capacity = 0; 1435 battery_status = POWER_SUPPLY_STATUS_NOT_CHARGING; 1436 break; 1437 case 0xf: /* charging error */ 1438 default: 1439 battery_capacity = 0; 1440 battery_status = POWER_SUPPLY_STATUS_UNKNOWN; 1441 } 1442 1443 spin_lock_irqsave(&ps_dev->lock, flags); 1444 ps_dev->battery_capacity = battery_capacity; 1445 ps_dev->battery_status = battery_status; 1446 spin_unlock_irqrestore(&ps_dev->lock, flags); 1447 1448 return 0; 1449 } 1450 1451 static int dualsense_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect) 1452 { 1453 struct hid_device *hdev = input_get_drvdata(dev); 1454 struct dualsense *ds = hid_get_drvdata(hdev); 1455 unsigned long flags; 1456 1457 if (effect->type != FF_RUMBLE) 1458 return 0; 1459 1460 spin_lock_irqsave(&ds->base.lock, flags); 1461 ds->update_rumble = true; 1462 ds->motor_left = effect->u.rumble.strong_magnitude / 256; 1463 ds->motor_right = effect->u.rumble.weak_magnitude / 256; 1464 spin_unlock_irqrestore(&ds->base.lock, flags); 1465 1466 dualsense_schedule_work(ds); 1467 return 0; 1468 } 1469 1470 static void dualsense_remove(struct ps_device *ps_dev) 1471 { 1472 struct dualsense *ds = container_of(ps_dev, struct dualsense, base); 1473 unsigned long flags; 1474 1475 spin_lock_irqsave(&ds->base.lock, flags); 1476 ds->output_worker_initialized = false; 1477 spin_unlock_irqrestore(&ds->base.lock, flags); 1478 1479 cancel_work_sync(&ds->output_worker); 1480 } 1481 1482 static int dualsense_reset_leds(struct dualsense *ds) 1483 { 1484 struct dualsense_output_report report; 1485 uint8_t *buf; 1486 1487 buf = kzalloc(sizeof(struct dualsense_output_report_bt), GFP_KERNEL); 1488 if (!buf) 1489 return -ENOMEM; 1490 1491 dualsense_init_output_report(ds, &report, buf); 1492 /* 1493 * On Bluetooth the DualSense outputs an animation on the lightbar 1494 * during startup and maintains a color afterwards. We need to explicitly 1495 * reconfigure the lightbar before we can do any programming later on. 1496 * In USB the lightbar is not on by default, but redoing the setup there 1497 * doesn't hurt. 1498 */ 1499 report.common->valid_flag2 = DS_OUTPUT_VALID_FLAG2_LIGHTBAR_SETUP_CONTROL_ENABLE; 1500 report.common->lightbar_setup = DS_OUTPUT_LIGHTBAR_SETUP_LIGHT_OUT; /* Fade light out. */ 1501 dualsense_send_output_report(ds, &report); 1502 1503 kfree(buf); 1504 return 0; 1505 } 1506 1507 static void dualsense_set_lightbar(struct dualsense *ds, uint8_t red, uint8_t green, uint8_t blue) 1508 { 1509 unsigned long flags; 1510 1511 spin_lock_irqsave(&ds->base.lock, flags); 1512 ds->update_lightbar = true; 1513 ds->lightbar_red = red; 1514 ds->lightbar_green = green; 1515 ds->lightbar_blue = blue; 1516 spin_unlock_irqrestore(&ds->base.lock, flags); 1517 1518 dualsense_schedule_work(ds); 1519 } 1520 1521 static void dualsense_set_player_leds(struct dualsense *ds) 1522 { 1523 /* 1524 * The DualSense controller has a row of 5 LEDs used for player ids. 1525 * Behavior on the PlayStation 5 console is to center the player id 1526 * across the LEDs, so e.g. player 1 would be "--x--" with x being 'on'. 1527 * Follow a similar mapping here. 1528 */ 1529 static const int player_ids[5] = { 1530 BIT(2), 1531 BIT(3) | BIT(1), 1532 BIT(4) | BIT(2) | BIT(0), 1533 BIT(4) | BIT(3) | BIT(1) | BIT(0), 1534 BIT(4) | BIT(3) | BIT(2) | BIT(1) | BIT(0) 1535 }; 1536 1537 uint8_t player_id = ds->base.player_id % ARRAY_SIZE(player_ids); 1538 1539 ds->update_player_leds = true; 1540 ds->player_leds_state = player_ids[player_id]; 1541 dualsense_schedule_work(ds); 1542 } 1543 1544 static struct ps_device *dualsense_create(struct hid_device *hdev) 1545 { 1546 struct dualsense *ds; 1547 struct ps_device *ps_dev; 1548 uint8_t max_output_report_size; 1549 int i, ret; 1550 1551 static const struct ps_led_info player_leds_info[] = { 1552 { LED_FUNCTION_PLAYER1, "white", 1, dualsense_player_led_get_brightness, 1553 dualsense_player_led_set_brightness }, 1554 { LED_FUNCTION_PLAYER2, "white", 1, dualsense_player_led_get_brightness, 1555 dualsense_player_led_set_brightness }, 1556 { LED_FUNCTION_PLAYER3, "white", 1, dualsense_player_led_get_brightness, 1557 dualsense_player_led_set_brightness }, 1558 { LED_FUNCTION_PLAYER4, "white", 1, dualsense_player_led_get_brightness, 1559 dualsense_player_led_set_brightness }, 1560 { LED_FUNCTION_PLAYER5, "white", 1, dualsense_player_led_get_brightness, 1561 dualsense_player_led_set_brightness } 1562 }; 1563 1564 ds = devm_kzalloc(&hdev->dev, sizeof(*ds), GFP_KERNEL); 1565 if (!ds) 1566 return ERR_PTR(-ENOMEM); 1567 1568 /* 1569 * Patch version to allow userspace to distinguish between 1570 * hid-generic vs hid-playstation axis and button mapping. 1571 */ 1572 hdev->version |= HID_PLAYSTATION_VERSION_PATCH; 1573 1574 ps_dev = &ds->base; 1575 ps_dev->hdev = hdev; 1576 spin_lock_init(&ps_dev->lock); 1577 ps_dev->battery_capacity = 100; /* initial value until parse_report. */ 1578 ps_dev->battery_status = POWER_SUPPLY_STATUS_UNKNOWN; 1579 ps_dev->parse_report = dualsense_parse_report; 1580 ps_dev->remove = dualsense_remove; 1581 INIT_WORK(&ds->output_worker, dualsense_output_worker); 1582 ds->output_worker_initialized = true; 1583 hid_set_drvdata(hdev, ds); 1584 1585 max_output_report_size = sizeof(struct dualsense_output_report_bt); 1586 ds->output_report_dmabuf = devm_kzalloc(&hdev->dev, max_output_report_size, GFP_KERNEL); 1587 if (!ds->output_report_dmabuf) 1588 return ERR_PTR(-ENOMEM); 1589 1590 ret = dualsense_get_mac_address(ds); 1591 if (ret) { 1592 hid_err(hdev, "Failed to get MAC address from DualSense\n"); 1593 return ERR_PTR(ret); 1594 } 1595 snprintf(hdev->uniq, sizeof(hdev->uniq), "%pMR", ds->base.mac_address); 1596 1597 ret = dualsense_get_firmware_info(ds); 1598 if (ret) { 1599 hid_err(hdev, "Failed to get firmware info from DualSense\n"); 1600 return ERR_PTR(ret); 1601 } 1602 1603 /* Original DualSense firmware simulated classic controller rumble through 1604 * its new haptics hardware. It felt different from classic rumble users 1605 * were used to. Since then new firmwares were introduced to change behavior 1606 * and make this new 'v2' behavior default on PlayStation and other platforms. 1607 * The original DualSense requires a new enough firmware as bundled with PS5 1608 * software released in 2021. DualSense edge supports it out of the box. 1609 * Both devices also support the old mode, but it is not really used. 1610 */ 1611 if (hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER) { 1612 /* Feature version 2.21 introduced new vibration method. */ 1613 ds->use_vibration_v2 = ds->update_version >= DS_FEATURE_VERSION(2, 21); 1614 } else if (hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER_2) { 1615 ds->use_vibration_v2 = true; 1616 } 1617 1618 ret = ps_devices_list_add(ps_dev); 1619 if (ret) 1620 return ERR_PTR(ret); 1621 1622 ret = dualsense_get_calibration_data(ds); 1623 if (ret) { 1624 hid_err(hdev, "Failed to get calibration data from DualSense\n"); 1625 goto err; 1626 } 1627 1628 ds->gamepad = ps_gamepad_create(hdev, dualsense_play_effect); 1629 if (IS_ERR(ds->gamepad)) { 1630 ret = PTR_ERR(ds->gamepad); 1631 goto err; 1632 } 1633 /* Use gamepad input device name as primary device name for e.g. LEDs */ 1634 ps_dev->input_dev_name = dev_name(&ds->gamepad->dev); 1635 1636 ds->sensors = ps_sensors_create(hdev, DS_ACC_RANGE, DS_ACC_RES_PER_G, 1637 DS_GYRO_RANGE, DS_GYRO_RES_PER_DEG_S); 1638 if (IS_ERR(ds->sensors)) { 1639 ret = PTR_ERR(ds->sensors); 1640 goto err; 1641 } 1642 1643 ds->touchpad = ps_touchpad_create(hdev, DS_TOUCHPAD_WIDTH, DS_TOUCHPAD_HEIGHT, 2); 1644 if (IS_ERR(ds->touchpad)) { 1645 ret = PTR_ERR(ds->touchpad); 1646 goto err; 1647 } 1648 1649 ret = ps_device_register_battery(ps_dev); 1650 if (ret) 1651 goto err; 1652 1653 /* 1654 * The hardware may have control over the LEDs (e.g. in Bluetooth on startup). 1655 * Reset the LEDs (lightbar, mute, player leds), so we can control them 1656 * from software. 1657 */ 1658 ret = dualsense_reset_leds(ds); 1659 if (ret) 1660 goto err; 1661 1662 ret = ps_lightbar_register(ps_dev, &ds->lightbar, dualsense_lightbar_set_brightness); 1663 if (ret) 1664 goto err; 1665 1666 /* Set default lightbar color. */ 1667 dualsense_set_lightbar(ds, 0, 0, 128); /* blue */ 1668 1669 for (i = 0; i < ARRAY_SIZE(player_leds_info); i++) { 1670 const struct ps_led_info *led_info = &player_leds_info[i]; 1671 1672 ret = ps_led_register(ps_dev, &ds->player_leds[i], led_info); 1673 if (ret < 0) 1674 goto err; 1675 } 1676 1677 ret = ps_device_set_player_id(ps_dev); 1678 if (ret) { 1679 hid_err(hdev, "Failed to assign player id for DualSense: %d\n", ret); 1680 goto err; 1681 } 1682 1683 /* Set player LEDs to our player id. */ 1684 dualsense_set_player_leds(ds); 1685 1686 /* 1687 * Reporting hardware and firmware is important as there are frequent updates, which 1688 * can change behavior. 1689 */ 1690 hid_info(hdev, "Registered DualSense controller hw_version=0x%08x fw_version=0x%08x\n", 1691 ds->base.hw_version, ds->base.fw_version); 1692 1693 return &ds->base; 1694 1695 err: 1696 ps_devices_list_remove(ps_dev); 1697 return ERR_PTR(ret); 1698 } 1699 1700 static void dualshock4_dongle_calibration_work(struct work_struct *work) 1701 { 1702 struct dualshock4 *ds4 = container_of(work, struct dualshock4, dongle_hotplug_worker); 1703 unsigned long flags; 1704 enum dualshock4_dongle_state dongle_state; 1705 int ret; 1706 1707 ret = dualshock4_get_calibration_data(ds4); 1708 if (ret < 0) { 1709 /* This call is very unlikely to fail for the dongle. When it 1710 * fails we are probably in a very bad state, so mark the 1711 * dongle as disabled. We will re-enable the dongle if a new 1712 * DS4 hotplug is detect from sony_raw_event as any issues 1713 * are likely resolved then (the dongle is quite stupid). 1714 */ 1715 hid_err(ds4->base.hdev, "DualShock 4 USB dongle: calibration failed, disabling device\n"); 1716 dongle_state = DONGLE_DISABLED; 1717 } else { 1718 hid_info(ds4->base.hdev, "DualShock 4 USB dongle: calibration completed\n"); 1719 dongle_state = DONGLE_CONNECTED; 1720 } 1721 1722 spin_lock_irqsave(&ds4->base.lock, flags); 1723 ds4->dongle_state = dongle_state; 1724 spin_unlock_irqrestore(&ds4->base.lock, flags); 1725 } 1726 1727 static int dualshock4_get_calibration_data(struct dualshock4 *ds4) 1728 { 1729 struct hid_device *hdev = ds4->base.hdev; 1730 short gyro_pitch_bias, gyro_pitch_plus, gyro_pitch_minus; 1731 short gyro_yaw_bias, gyro_yaw_plus, gyro_yaw_minus; 1732 short gyro_roll_bias, gyro_roll_plus, gyro_roll_minus; 1733 short gyro_speed_plus, gyro_speed_minus; 1734 short acc_x_plus, acc_x_minus; 1735 short acc_y_plus, acc_y_minus; 1736 short acc_z_plus, acc_z_minus; 1737 int speed_2x; 1738 int range_2g; 1739 int ret = 0; 1740 uint8_t *buf; 1741 1742 if (ds4->base.hdev->bus == BUS_USB) { 1743 int retries; 1744 1745 buf = kzalloc(DS4_FEATURE_REPORT_CALIBRATION_SIZE, GFP_KERNEL); 1746 if (!buf) 1747 return -ENOMEM; 1748 1749 /* We should normally receive the feature report data we asked 1750 * for, but hidraw applications such as Steam can issue feature 1751 * reports as well. In particular for Dongle reconnects, Steam 1752 * and this function are competing resulting in often receiving 1753 * data for a different HID report, so retry a few times. 1754 */ 1755 for (retries = 0; retries < 3; retries++) { 1756 ret = ps_get_report(hdev, DS4_FEATURE_REPORT_CALIBRATION, buf, 1757 DS4_FEATURE_REPORT_CALIBRATION_SIZE, true); 1758 if (ret) { 1759 if (retries < 2) { 1760 hid_warn(hdev, "Retrying DualShock 4 get calibration report (0x02) request\n"); 1761 continue; 1762 } else { 1763 ret = -EILSEQ; 1764 goto err_free; 1765 } 1766 hid_err(hdev, "Failed to retrieve DualShock4 calibration info: %d\n", ret); 1767 goto err_free; 1768 } else { 1769 break; 1770 } 1771 } 1772 } else { /* Bluetooth */ 1773 buf = kzalloc(DS4_FEATURE_REPORT_CALIBRATION_BT_SIZE, GFP_KERNEL); 1774 if (!buf) 1775 return -ENOMEM; 1776 1777 ret = ps_get_report(hdev, DS4_FEATURE_REPORT_CALIBRATION_BT, buf, 1778 DS4_FEATURE_REPORT_CALIBRATION_BT_SIZE, true); 1779 if (ret) { 1780 hid_err(hdev, "Failed to retrieve DualShock4 calibration info: %d\n", ret); 1781 goto err_free; 1782 } 1783 } 1784 1785 gyro_pitch_bias = get_unaligned_le16(&buf[1]); 1786 gyro_yaw_bias = get_unaligned_le16(&buf[3]); 1787 gyro_roll_bias = get_unaligned_le16(&buf[5]); 1788 if (ds4->base.hdev->bus == BUS_USB) { 1789 gyro_pitch_plus = get_unaligned_le16(&buf[7]); 1790 gyro_pitch_minus = get_unaligned_le16(&buf[9]); 1791 gyro_yaw_plus = get_unaligned_le16(&buf[11]); 1792 gyro_yaw_minus = get_unaligned_le16(&buf[13]); 1793 gyro_roll_plus = get_unaligned_le16(&buf[15]); 1794 gyro_roll_minus = get_unaligned_le16(&buf[17]); 1795 } else { 1796 /* BT + Dongle */ 1797 gyro_pitch_plus = get_unaligned_le16(&buf[7]); 1798 gyro_yaw_plus = get_unaligned_le16(&buf[9]); 1799 gyro_roll_plus = get_unaligned_le16(&buf[11]); 1800 gyro_pitch_minus = get_unaligned_le16(&buf[13]); 1801 gyro_yaw_minus = get_unaligned_le16(&buf[15]); 1802 gyro_roll_minus = get_unaligned_le16(&buf[17]); 1803 } 1804 gyro_speed_plus = get_unaligned_le16(&buf[19]); 1805 gyro_speed_minus = get_unaligned_le16(&buf[21]); 1806 acc_x_plus = get_unaligned_le16(&buf[23]); 1807 acc_x_minus = get_unaligned_le16(&buf[25]); 1808 acc_y_plus = get_unaligned_le16(&buf[27]); 1809 acc_y_minus = get_unaligned_le16(&buf[29]); 1810 acc_z_plus = get_unaligned_le16(&buf[31]); 1811 acc_z_minus = get_unaligned_le16(&buf[33]); 1812 1813 /* 1814 * Set gyroscope calibration and normalization parameters. 1815 * Data values will be normalized to 1/DS4_GYRO_RES_PER_DEG_S degree/s. 1816 */ 1817 speed_2x = (gyro_speed_plus + gyro_speed_minus); 1818 ds4->gyro_calib_data[0].abs_code = ABS_RX; 1819 ds4->gyro_calib_data[0].bias = gyro_pitch_bias; 1820 ds4->gyro_calib_data[0].sens_numer = speed_2x*DS4_GYRO_RES_PER_DEG_S; 1821 ds4->gyro_calib_data[0].sens_denom = gyro_pitch_plus - gyro_pitch_minus; 1822 1823 ds4->gyro_calib_data[1].abs_code = ABS_RY; 1824 ds4->gyro_calib_data[1].bias = gyro_yaw_bias; 1825 ds4->gyro_calib_data[1].sens_numer = speed_2x*DS4_GYRO_RES_PER_DEG_S; 1826 ds4->gyro_calib_data[1].sens_denom = gyro_yaw_plus - gyro_yaw_minus; 1827 1828 ds4->gyro_calib_data[2].abs_code = ABS_RZ; 1829 ds4->gyro_calib_data[2].bias = gyro_roll_bias; 1830 ds4->gyro_calib_data[2].sens_numer = speed_2x*DS4_GYRO_RES_PER_DEG_S; 1831 ds4->gyro_calib_data[2].sens_denom = gyro_roll_plus - gyro_roll_minus; 1832 1833 /* 1834 * Set accelerometer calibration and normalization parameters. 1835 * Data values will be normalized to 1/DS4_ACC_RES_PER_G g. 1836 */ 1837 range_2g = acc_x_plus - acc_x_minus; 1838 ds4->accel_calib_data[0].abs_code = ABS_X; 1839 ds4->accel_calib_data[0].bias = acc_x_plus - range_2g / 2; 1840 ds4->accel_calib_data[0].sens_numer = 2*DS4_ACC_RES_PER_G; 1841 ds4->accel_calib_data[0].sens_denom = range_2g; 1842 1843 range_2g = acc_y_plus - acc_y_minus; 1844 ds4->accel_calib_data[1].abs_code = ABS_Y; 1845 ds4->accel_calib_data[1].bias = acc_y_plus - range_2g / 2; 1846 ds4->accel_calib_data[1].sens_numer = 2*DS4_ACC_RES_PER_G; 1847 ds4->accel_calib_data[1].sens_denom = range_2g; 1848 1849 range_2g = acc_z_plus - acc_z_minus; 1850 ds4->accel_calib_data[2].abs_code = ABS_Z; 1851 ds4->accel_calib_data[2].bias = acc_z_plus - range_2g / 2; 1852 ds4->accel_calib_data[2].sens_numer = 2*DS4_ACC_RES_PER_G; 1853 ds4->accel_calib_data[2].sens_denom = range_2g; 1854 1855 err_free: 1856 kfree(buf); 1857 return ret; 1858 } 1859 1860 static int dualshock4_get_firmware_info(struct dualshock4 *ds4) 1861 { 1862 uint8_t *buf; 1863 int ret; 1864 1865 buf = kzalloc(DS4_FEATURE_REPORT_FIRMWARE_INFO_SIZE, GFP_KERNEL); 1866 if (!buf) 1867 return -ENOMEM; 1868 1869 /* Note USB and BT support the same feature report, but this report 1870 * lacks CRC support, so must be disabled in ps_get_report. 1871 */ 1872 ret = ps_get_report(ds4->base.hdev, DS4_FEATURE_REPORT_FIRMWARE_INFO, buf, 1873 DS4_FEATURE_REPORT_FIRMWARE_INFO_SIZE, false); 1874 if (ret) { 1875 hid_err(ds4->base.hdev, "Failed to retrieve DualShock4 firmware info: %d\n", ret); 1876 goto err_free; 1877 } 1878 1879 ds4->base.hw_version = get_unaligned_le16(&buf[35]); 1880 ds4->base.fw_version = get_unaligned_le16(&buf[41]); 1881 1882 err_free: 1883 kfree(buf); 1884 return ret; 1885 } 1886 1887 static int dualshock4_get_mac_address(struct dualshock4 *ds4) 1888 { 1889 struct hid_device *hdev = ds4->base.hdev; 1890 uint8_t *buf; 1891 int ret = 0; 1892 1893 if (hdev->bus == BUS_USB) { 1894 buf = kzalloc(DS4_FEATURE_REPORT_PAIRING_INFO_SIZE, GFP_KERNEL); 1895 if (!buf) 1896 return -ENOMEM; 1897 1898 ret = ps_get_report(hdev, DS4_FEATURE_REPORT_PAIRING_INFO, buf, 1899 DS4_FEATURE_REPORT_PAIRING_INFO_SIZE, false); 1900 if (ret) { 1901 hid_err(hdev, "Failed to retrieve DualShock4 pairing info: %d\n", ret); 1902 goto err_free; 1903 } 1904 1905 memcpy(ds4->base.mac_address, &buf[1], sizeof(ds4->base.mac_address)); 1906 } else { 1907 /* Rely on HIDP for Bluetooth */ 1908 if (strlen(hdev->uniq) != 17) 1909 return -EINVAL; 1910 1911 ret = sscanf(hdev->uniq, "%02hhx:%02hhx:%02hhx:%02hhx:%02hhx:%02hhx", 1912 &ds4->base.mac_address[5], &ds4->base.mac_address[4], 1913 &ds4->base.mac_address[3], &ds4->base.mac_address[2], 1914 &ds4->base.mac_address[1], &ds4->base.mac_address[0]); 1915 1916 if (ret != sizeof(ds4->base.mac_address)) 1917 return -EINVAL; 1918 1919 return 0; 1920 } 1921 1922 err_free: 1923 kfree(buf); 1924 return ret; 1925 } 1926 1927 static enum led_brightness dualshock4_led_get_brightness(struct led_classdev *led) 1928 { 1929 struct hid_device *hdev = to_hid_device(led->dev->parent); 1930 struct dualshock4 *ds4 = hid_get_drvdata(hdev); 1931 unsigned int led_index; 1932 1933 led_index = led - ds4->lightbar_leds; 1934 switch (led_index) { 1935 case 0: 1936 return ds4->lightbar_red; 1937 case 1: 1938 return ds4->lightbar_green; 1939 case 2: 1940 return ds4->lightbar_blue; 1941 case 3: 1942 return ds4->lightbar_enabled; 1943 } 1944 1945 return -1; 1946 } 1947 1948 static int dualshock4_led_set_blink(struct led_classdev *led, unsigned long *delay_on, 1949 unsigned long *delay_off) 1950 { 1951 struct hid_device *hdev = to_hid_device(led->dev->parent); 1952 struct dualshock4 *ds4 = hid_get_drvdata(hdev); 1953 unsigned long flags; 1954 1955 spin_lock_irqsave(&ds4->base.lock, flags); 1956 1957 if (!*delay_on && !*delay_off) { 1958 /* Default to 1 Hz (50 centiseconds on, 50 centiseconds off). */ 1959 ds4->lightbar_blink_on = 50; 1960 ds4->lightbar_blink_off = 50; 1961 } else { 1962 /* Blink delays in centiseconds. */ 1963 ds4->lightbar_blink_on = min_t(unsigned long, *delay_on/10, DS4_LIGHTBAR_MAX_BLINK); 1964 ds4->lightbar_blink_off = min_t(unsigned long, *delay_off/10, DS4_LIGHTBAR_MAX_BLINK); 1965 } 1966 1967 ds4->update_lightbar_blink = true; 1968 1969 spin_unlock_irqrestore(&ds4->base.lock, flags); 1970 1971 dualshock4_schedule_work(ds4); 1972 1973 *delay_on = ds4->lightbar_blink_on; 1974 *delay_off = ds4->lightbar_blink_off; 1975 1976 return 0; 1977 } 1978 1979 static int dualshock4_led_set_brightness(struct led_classdev *led, enum led_brightness value) 1980 { 1981 struct hid_device *hdev = to_hid_device(led->dev->parent); 1982 struct dualshock4 *ds4 = hid_get_drvdata(hdev); 1983 unsigned long flags; 1984 unsigned int led_index; 1985 1986 spin_lock_irqsave(&ds4->base.lock, flags); 1987 1988 led_index = led - ds4->lightbar_leds; 1989 switch (led_index) { 1990 case 0: 1991 ds4->lightbar_red = value; 1992 break; 1993 case 1: 1994 ds4->lightbar_green = value; 1995 break; 1996 case 2: 1997 ds4->lightbar_blue = value; 1998 break; 1999 case 3: 2000 ds4->lightbar_enabled = !!value; 2001 } 2002 2003 ds4->update_lightbar = true; 2004 2005 spin_unlock_irqrestore(&ds4->base.lock, flags); 2006 2007 dualshock4_schedule_work(ds4); 2008 2009 return 0; 2010 } 2011 2012 static void dualshock4_init_output_report(struct dualshock4 *ds4, 2013 struct dualshock4_output_report *rp, void *buf) 2014 { 2015 struct hid_device *hdev = ds4->base.hdev; 2016 2017 if (hdev->bus == BUS_BLUETOOTH) { 2018 struct dualshock4_output_report_bt *bt = buf; 2019 2020 memset(bt, 0, sizeof(*bt)); 2021 bt->report_id = DS4_OUTPUT_REPORT_BT; 2022 2023 rp->data = buf; 2024 rp->len = sizeof(*bt); 2025 rp->bt = bt; 2026 rp->usb = NULL; 2027 rp->common = &bt->common; 2028 } else { /* USB */ 2029 struct dualshock4_output_report_usb *usb = buf; 2030 2031 memset(usb, 0, sizeof(*usb)); 2032 usb->report_id = DS4_OUTPUT_REPORT_USB; 2033 2034 rp->data = buf; 2035 rp->len = sizeof(*usb); 2036 rp->bt = NULL; 2037 rp->usb = usb; 2038 rp->common = &usb->common; 2039 } 2040 } 2041 2042 static void dualshock4_output_worker(struct work_struct *work) 2043 { 2044 struct dualshock4 *ds4 = container_of(work, struct dualshock4, output_worker); 2045 struct dualshock4_output_report report; 2046 struct dualshock4_output_report_common *common; 2047 unsigned long flags; 2048 2049 dualshock4_init_output_report(ds4, &report, ds4->output_report_dmabuf); 2050 common = report.common; 2051 2052 spin_lock_irqsave(&ds4->base.lock, flags); 2053 2054 if (ds4->update_rumble) { 2055 /* Select classic rumble style haptics and enable it. */ 2056 common->valid_flag0 |= DS4_OUTPUT_VALID_FLAG0_MOTOR; 2057 common->motor_left = ds4->motor_left; 2058 common->motor_right = ds4->motor_right; 2059 ds4->update_rumble = false; 2060 } 2061 2062 if (ds4->update_lightbar) { 2063 common->valid_flag0 |= DS4_OUTPUT_VALID_FLAG0_LED; 2064 /* Comptabile behavior with hid-sony, which used a dummy global LED to 2065 * allow enabling/disabling the lightbar. The global LED maps to 2066 * lightbar_enabled. 2067 */ 2068 common->lightbar_red = ds4->lightbar_enabled ? ds4->lightbar_red : 0; 2069 common->lightbar_green = ds4->lightbar_enabled ? ds4->lightbar_green : 0; 2070 common->lightbar_blue = ds4->lightbar_enabled ? ds4->lightbar_blue : 0; 2071 ds4->update_lightbar = false; 2072 } 2073 2074 if (ds4->update_lightbar_blink) { 2075 common->valid_flag0 |= DS4_OUTPUT_VALID_FLAG0_LED_BLINK; 2076 common->lightbar_blink_on = ds4->lightbar_blink_on; 2077 common->lightbar_blink_off = ds4->lightbar_blink_off; 2078 ds4->update_lightbar_blink = false; 2079 } 2080 2081 spin_unlock_irqrestore(&ds4->base.lock, flags); 2082 2083 /* Bluetooth packets need additional flags as well as a CRC in the last 4 bytes. */ 2084 if (report.bt) { 2085 uint32_t crc; 2086 uint8_t seed = PS_OUTPUT_CRC32_SEED; 2087 2088 /* Hardware control flags need to set to let the device know 2089 * there is HID data as well as CRC. 2090 */ 2091 report.bt->hw_control = DS4_OUTPUT_HWCTL_HID | DS4_OUTPUT_HWCTL_CRC32; 2092 2093 if (ds4->update_bt_poll_interval) { 2094 report.bt->hw_control |= ds4->bt_poll_interval; 2095 ds4->update_bt_poll_interval = false; 2096 } 2097 2098 crc = crc32_le(0xFFFFFFFF, &seed, 1); 2099 crc = ~crc32_le(crc, report.data, report.len - 4); 2100 2101 report.bt->crc32 = cpu_to_le32(crc); 2102 } 2103 2104 hid_hw_output_report(ds4->base.hdev, report.data, report.len); 2105 } 2106 2107 static int dualshock4_parse_report(struct ps_device *ps_dev, struct hid_report *report, 2108 u8 *data, int size) 2109 { 2110 struct hid_device *hdev = ps_dev->hdev; 2111 struct dualshock4 *ds4 = container_of(ps_dev, struct dualshock4, base); 2112 struct dualshock4_input_report_common *ds4_report; 2113 struct dualshock4_touch_report *touch_reports; 2114 uint8_t battery_capacity, num_touch_reports, value; 2115 int battery_status, i, j; 2116 uint16_t sensor_timestamp; 2117 unsigned long flags; 2118 2119 /* 2120 * DualShock4 in USB uses the full HID report for reportID 1, but 2121 * Bluetooth uses a minimal HID report for reportID 1 and reports 2122 * the full report using reportID 17. 2123 */ 2124 if (hdev->bus == BUS_USB && report->id == DS4_INPUT_REPORT_USB && 2125 size == DS4_INPUT_REPORT_USB_SIZE) { 2126 struct dualshock4_input_report_usb *usb = (struct dualshock4_input_report_usb *)data; 2127 2128 ds4_report = &usb->common; 2129 num_touch_reports = usb->num_touch_reports; 2130 touch_reports = usb->touch_reports; 2131 } else if (hdev->bus == BUS_BLUETOOTH && report->id == DS4_INPUT_REPORT_BT && 2132 size == DS4_INPUT_REPORT_BT_SIZE) { 2133 struct dualshock4_input_report_bt *bt = (struct dualshock4_input_report_bt *)data; 2134 uint32_t report_crc = get_unaligned_le32(&bt->crc32); 2135 2136 /* Last 4 bytes of input report contains CRC. */ 2137 if (!ps_check_crc32(PS_INPUT_CRC32_SEED, data, size - 4, report_crc)) { 2138 hid_err(hdev, "DualShock4 input CRC's check failed\n"); 2139 return -EILSEQ; 2140 } 2141 2142 ds4_report = &bt->common; 2143 num_touch_reports = bt->num_touch_reports; 2144 touch_reports = bt->touch_reports; 2145 } else { 2146 hid_err(hdev, "Unhandled reportID=%d\n", report->id); 2147 return -1; 2148 } 2149 2150 input_report_abs(ds4->gamepad, ABS_X, ds4_report->x); 2151 input_report_abs(ds4->gamepad, ABS_Y, ds4_report->y); 2152 input_report_abs(ds4->gamepad, ABS_RX, ds4_report->rx); 2153 input_report_abs(ds4->gamepad, ABS_RY, ds4_report->ry); 2154 input_report_abs(ds4->gamepad, ABS_Z, ds4_report->z); 2155 input_report_abs(ds4->gamepad, ABS_RZ, ds4_report->rz); 2156 2157 value = ds4_report->buttons[0] & DS_BUTTONS0_HAT_SWITCH; 2158 if (value >= ARRAY_SIZE(ps_gamepad_hat_mapping)) 2159 value = 8; /* center */ 2160 input_report_abs(ds4->gamepad, ABS_HAT0X, ps_gamepad_hat_mapping[value].x); 2161 input_report_abs(ds4->gamepad, ABS_HAT0Y, ps_gamepad_hat_mapping[value].y); 2162 2163 input_report_key(ds4->gamepad, BTN_WEST, ds4_report->buttons[0] & DS_BUTTONS0_SQUARE); 2164 input_report_key(ds4->gamepad, BTN_SOUTH, ds4_report->buttons[0] & DS_BUTTONS0_CROSS); 2165 input_report_key(ds4->gamepad, BTN_EAST, ds4_report->buttons[0] & DS_BUTTONS0_CIRCLE); 2166 input_report_key(ds4->gamepad, BTN_NORTH, ds4_report->buttons[0] & DS_BUTTONS0_TRIANGLE); 2167 input_report_key(ds4->gamepad, BTN_TL, ds4_report->buttons[1] & DS_BUTTONS1_L1); 2168 input_report_key(ds4->gamepad, BTN_TR, ds4_report->buttons[1] & DS_BUTTONS1_R1); 2169 input_report_key(ds4->gamepad, BTN_TL2, ds4_report->buttons[1] & DS_BUTTONS1_L2); 2170 input_report_key(ds4->gamepad, BTN_TR2, ds4_report->buttons[1] & DS_BUTTONS1_R2); 2171 input_report_key(ds4->gamepad, BTN_SELECT, ds4_report->buttons[1] & DS_BUTTONS1_CREATE); 2172 input_report_key(ds4->gamepad, BTN_START, ds4_report->buttons[1] & DS_BUTTONS1_OPTIONS); 2173 input_report_key(ds4->gamepad, BTN_THUMBL, ds4_report->buttons[1] & DS_BUTTONS1_L3); 2174 input_report_key(ds4->gamepad, BTN_THUMBR, ds4_report->buttons[1] & DS_BUTTONS1_R3); 2175 input_report_key(ds4->gamepad, BTN_MODE, ds4_report->buttons[2] & DS_BUTTONS2_PS_HOME); 2176 input_sync(ds4->gamepad); 2177 2178 /* Parse and calibrate gyroscope data. */ 2179 for (i = 0; i < ARRAY_SIZE(ds4_report->gyro); i++) { 2180 int raw_data = (short)le16_to_cpu(ds4_report->gyro[i]); 2181 int calib_data = mult_frac(ds4->gyro_calib_data[i].sens_numer, 2182 raw_data - ds4->gyro_calib_data[i].bias, 2183 ds4->gyro_calib_data[i].sens_denom); 2184 2185 input_report_abs(ds4->sensors, ds4->gyro_calib_data[i].abs_code, calib_data); 2186 } 2187 2188 /* Parse and calibrate accelerometer data. */ 2189 for (i = 0; i < ARRAY_SIZE(ds4_report->accel); i++) { 2190 int raw_data = (short)le16_to_cpu(ds4_report->accel[i]); 2191 int calib_data = mult_frac(ds4->accel_calib_data[i].sens_numer, 2192 raw_data - ds4->accel_calib_data[i].bias, 2193 ds4->accel_calib_data[i].sens_denom); 2194 2195 input_report_abs(ds4->sensors, ds4->accel_calib_data[i].abs_code, calib_data); 2196 } 2197 2198 /* Convert timestamp (in 5.33us unit) to timestamp_us */ 2199 sensor_timestamp = le16_to_cpu(ds4_report->sensor_timestamp); 2200 if (!ds4->sensor_timestamp_initialized) { 2201 ds4->sensor_timestamp_us = DIV_ROUND_CLOSEST(sensor_timestamp*16, 3); 2202 ds4->sensor_timestamp_initialized = true; 2203 } else { 2204 uint16_t delta; 2205 2206 if (ds4->prev_sensor_timestamp > sensor_timestamp) 2207 delta = (U16_MAX - ds4->prev_sensor_timestamp + sensor_timestamp + 1); 2208 else 2209 delta = sensor_timestamp - ds4->prev_sensor_timestamp; 2210 ds4->sensor_timestamp_us += DIV_ROUND_CLOSEST(delta*16, 3); 2211 } 2212 ds4->prev_sensor_timestamp = sensor_timestamp; 2213 input_event(ds4->sensors, EV_MSC, MSC_TIMESTAMP, ds4->sensor_timestamp_us); 2214 input_sync(ds4->sensors); 2215 2216 for (i = 0; i < num_touch_reports; i++) { 2217 struct dualshock4_touch_report *touch_report = &touch_reports[i]; 2218 2219 for (j = 0; j < ARRAY_SIZE(touch_report->points); j++) { 2220 struct dualshock4_touch_point *point = &touch_report->points[j]; 2221 bool active = (point->contact & DS4_TOUCH_POINT_INACTIVE) ? false : true; 2222 2223 input_mt_slot(ds4->touchpad, j); 2224 input_mt_report_slot_state(ds4->touchpad, MT_TOOL_FINGER, active); 2225 2226 if (active) { 2227 int x = (point->x_hi << 8) | point->x_lo; 2228 int y = (point->y_hi << 4) | point->y_lo; 2229 2230 input_report_abs(ds4->touchpad, ABS_MT_POSITION_X, x); 2231 input_report_abs(ds4->touchpad, ABS_MT_POSITION_Y, y); 2232 } 2233 } 2234 input_mt_sync_frame(ds4->touchpad); 2235 input_sync(ds4->touchpad); 2236 } 2237 input_report_key(ds4->touchpad, BTN_LEFT, ds4_report->buttons[2] & DS_BUTTONS2_TOUCHPAD); 2238 2239 /* 2240 * Interpretation of the battery_capacity data depends on the cable state. 2241 * When no cable is connected (bit4 is 0): 2242 * - 0:10: percentage in units of 10%. 2243 * When a cable is plugged in: 2244 * - 0-10: percentage in units of 10%. 2245 * - 11: battery is full 2246 * - 14: not charging due to Voltage or temperature error 2247 * - 15: charge error 2248 */ 2249 if (ds4_report->status[0] & DS4_STATUS0_CABLE_STATE) { 2250 uint8_t battery_data = ds4_report->status[0] & DS4_STATUS0_BATTERY_CAPACITY; 2251 2252 if (battery_data < 10) { 2253 /* Take the mid-point for each battery capacity value, 2254 * because on the hardware side 0 = 0-9%, 1=10-19%, etc. 2255 * This matches official platform behavior, which does 2256 * the same. 2257 */ 2258 battery_capacity = battery_data * 10 + 5; 2259 battery_status = POWER_SUPPLY_STATUS_CHARGING; 2260 } else if (battery_data == 10) { 2261 battery_capacity = 100; 2262 battery_status = POWER_SUPPLY_STATUS_CHARGING; 2263 } else if (battery_data == DS4_BATTERY_STATUS_FULL) { 2264 battery_capacity = 100; 2265 battery_status = POWER_SUPPLY_STATUS_FULL; 2266 } else { /* 14, 15 and undefined values */ 2267 battery_capacity = 0; 2268 battery_status = POWER_SUPPLY_STATUS_UNKNOWN; 2269 } 2270 } else { 2271 uint8_t battery_data = ds4_report->status[0] & DS4_STATUS0_BATTERY_CAPACITY; 2272 2273 if (battery_data < 10) 2274 battery_capacity = battery_data * 10 + 5; 2275 else /* 10 */ 2276 battery_capacity = 100; 2277 2278 battery_status = POWER_SUPPLY_STATUS_DISCHARGING; 2279 } 2280 2281 spin_lock_irqsave(&ps_dev->lock, flags); 2282 ps_dev->battery_capacity = battery_capacity; 2283 ps_dev->battery_status = battery_status; 2284 spin_unlock_irqrestore(&ps_dev->lock, flags); 2285 2286 return 0; 2287 } 2288 2289 static int dualshock4_dongle_parse_report(struct ps_device *ps_dev, struct hid_report *report, 2290 u8 *data, int size) 2291 { 2292 struct dualshock4 *ds4 = container_of(ps_dev, struct dualshock4, base); 2293 bool connected = false; 2294 2295 /* The dongle reports data using the main USB report (0x1) no matter whether a controller 2296 * is connected with mostly zeros. The report does contain dongle status, which we use to 2297 * determine if a controller is connected and if so we forward to the regular DualShock4 2298 * parsing code. 2299 */ 2300 if (data[0] == DS4_INPUT_REPORT_USB && size == DS4_INPUT_REPORT_USB_SIZE) { 2301 struct dualshock4_input_report_common *ds4_report = (struct dualshock4_input_report_common *)&data[1]; 2302 unsigned long flags; 2303 2304 connected = ds4_report->status[1] & DS4_STATUS1_DONGLE_STATE ? false : true; 2305 2306 if (ds4->dongle_state == DONGLE_DISCONNECTED && connected) { 2307 hid_info(ps_dev->hdev, "DualShock 4 USB dongle: controller connected\n"); 2308 2309 dualshock4_set_default_lightbar_colors(ds4); 2310 2311 spin_lock_irqsave(&ps_dev->lock, flags); 2312 ds4->dongle_state = DONGLE_CALIBRATING; 2313 spin_unlock_irqrestore(&ps_dev->lock, flags); 2314 2315 schedule_work(&ds4->dongle_hotplug_worker); 2316 2317 /* Don't process the report since we don't have 2318 * calibration data, but let hidraw have it anyway. 2319 */ 2320 return 0; 2321 } else if ((ds4->dongle_state == DONGLE_CONNECTED || 2322 ds4->dongle_state == DONGLE_DISABLED) && !connected) { 2323 hid_info(ps_dev->hdev, "DualShock 4 USB dongle: controller disconnected\n"); 2324 2325 spin_lock_irqsave(&ps_dev->lock, flags); 2326 ds4->dongle_state = DONGLE_DISCONNECTED; 2327 spin_unlock_irqrestore(&ps_dev->lock, flags); 2328 2329 /* Return 0, so hidraw can get the report. */ 2330 return 0; 2331 } else if (ds4->dongle_state == DONGLE_CALIBRATING || 2332 ds4->dongle_state == DONGLE_DISABLED || 2333 ds4->dongle_state == DONGLE_DISCONNECTED) { 2334 /* Return 0, so hidraw can get the report. */ 2335 return 0; 2336 } 2337 } 2338 2339 if (connected) 2340 return dualshock4_parse_report(ps_dev, report, data, size); 2341 2342 return 0; 2343 } 2344 2345 static int dualshock4_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect) 2346 { 2347 struct hid_device *hdev = input_get_drvdata(dev); 2348 struct dualshock4 *ds4 = hid_get_drvdata(hdev); 2349 unsigned long flags; 2350 2351 if (effect->type != FF_RUMBLE) 2352 return 0; 2353 2354 spin_lock_irqsave(&ds4->base.lock, flags); 2355 ds4->update_rumble = true; 2356 ds4->motor_left = effect->u.rumble.strong_magnitude / 256; 2357 ds4->motor_right = effect->u.rumble.weak_magnitude / 256; 2358 spin_unlock_irqrestore(&ds4->base.lock, flags); 2359 2360 dualshock4_schedule_work(ds4); 2361 return 0; 2362 } 2363 2364 static void dualshock4_remove(struct ps_device *ps_dev) 2365 { 2366 struct dualshock4 *ds4 = container_of(ps_dev, struct dualshock4, base); 2367 unsigned long flags; 2368 2369 spin_lock_irqsave(&ds4->base.lock, flags); 2370 ds4->output_worker_initialized = false; 2371 spin_unlock_irqrestore(&ds4->base.lock, flags); 2372 2373 cancel_work_sync(&ds4->output_worker); 2374 2375 if (ps_dev->hdev->product == USB_DEVICE_ID_SONY_PS4_CONTROLLER_DONGLE) 2376 cancel_work_sync(&ds4->dongle_hotplug_worker); 2377 } 2378 2379 static inline void dualshock4_schedule_work(struct dualshock4 *ds4) 2380 { 2381 unsigned long flags; 2382 2383 spin_lock_irqsave(&ds4->base.lock, flags); 2384 if (ds4->output_worker_initialized) 2385 schedule_work(&ds4->output_worker); 2386 spin_unlock_irqrestore(&ds4->base.lock, flags); 2387 } 2388 2389 static void dualshock4_set_bt_poll_interval(struct dualshock4 *ds4, uint8_t interval) 2390 { 2391 ds4->bt_poll_interval = interval; 2392 ds4->update_bt_poll_interval = true; 2393 dualshock4_schedule_work(ds4); 2394 } 2395 2396 /* Set default lightbar color based on player. */ 2397 static void dualshock4_set_default_lightbar_colors(struct dualshock4 *ds4) 2398 { 2399 /* Use same player colors as PlayStation 4. 2400 * Array of colors is in RGB. 2401 */ 2402 static const int player_colors[4][3] = { 2403 { 0x00, 0x00, 0x40 }, /* Blue */ 2404 { 0x40, 0x00, 0x00 }, /* Red */ 2405 { 0x00, 0x40, 0x00 }, /* Green */ 2406 { 0x20, 0x00, 0x20 } /* Pink */ 2407 }; 2408 2409 uint8_t player_id = ds4->base.player_id % ARRAY_SIZE(player_colors); 2410 2411 ds4->lightbar_enabled = true; 2412 ds4->lightbar_red = player_colors[player_id][0]; 2413 ds4->lightbar_green = player_colors[player_id][1]; 2414 ds4->lightbar_blue = player_colors[player_id][2]; 2415 2416 ds4->update_lightbar = true; 2417 dualshock4_schedule_work(ds4); 2418 } 2419 2420 static struct ps_device *dualshock4_create(struct hid_device *hdev) 2421 { 2422 struct dualshock4 *ds4; 2423 struct ps_device *ps_dev; 2424 uint8_t max_output_report_size; 2425 int i, ret; 2426 2427 /* The DualShock4 has an RGB lightbar, which the original hid-sony driver 2428 * exposed as a set of 4 LEDs for the 3 color channels and a global control. 2429 * Ideally this should have used the multi-color LED class, which didn't exist 2430 * yet. In addition the driver used a naming scheme not compliant with the LED 2431 * naming spec by using "<mac_address>:<color>", which contained many colons. 2432 * We use a more compliant by using "<device_name>:<color>" name now. Ideally 2433 * would have been "<device_name>:<color>:indicator", but that would break 2434 * existing applications (e.g. Android). Nothing matches against MAC address. 2435 */ 2436 static const struct ps_led_info lightbar_leds_info[] = { 2437 { NULL, "red", 255, dualshock4_led_get_brightness, dualshock4_led_set_brightness }, 2438 { NULL, "green", 255, dualshock4_led_get_brightness, dualshock4_led_set_brightness }, 2439 { NULL, "blue", 255, dualshock4_led_get_brightness, dualshock4_led_set_brightness }, 2440 { NULL, "global", 1, dualshock4_led_get_brightness, dualshock4_led_set_brightness, 2441 dualshock4_led_set_blink }, 2442 }; 2443 2444 ds4 = devm_kzalloc(&hdev->dev, sizeof(*ds4), GFP_KERNEL); 2445 if (!ds4) 2446 return ERR_PTR(-ENOMEM); 2447 2448 /* 2449 * Patch version to allow userspace to distinguish between 2450 * hid-generic vs hid-playstation axis and button mapping. 2451 */ 2452 hdev->version |= HID_PLAYSTATION_VERSION_PATCH; 2453 2454 ps_dev = &ds4->base; 2455 ps_dev->hdev = hdev; 2456 spin_lock_init(&ps_dev->lock); 2457 ps_dev->battery_capacity = 100; /* initial value until parse_report. */ 2458 ps_dev->battery_status = POWER_SUPPLY_STATUS_UNKNOWN; 2459 ps_dev->parse_report = dualshock4_parse_report; 2460 ps_dev->remove = dualshock4_remove; 2461 INIT_WORK(&ds4->output_worker, dualshock4_output_worker); 2462 ds4->output_worker_initialized = true; 2463 hid_set_drvdata(hdev, ds4); 2464 2465 max_output_report_size = sizeof(struct dualshock4_output_report_bt); 2466 ds4->output_report_dmabuf = devm_kzalloc(&hdev->dev, max_output_report_size, GFP_KERNEL); 2467 if (!ds4->output_report_dmabuf) 2468 return ERR_PTR(-ENOMEM); 2469 2470 if (hdev->product == USB_DEVICE_ID_SONY_PS4_CONTROLLER_DONGLE) { 2471 ds4->dongle_state = DONGLE_DISCONNECTED; 2472 INIT_WORK(&ds4->dongle_hotplug_worker, dualshock4_dongle_calibration_work); 2473 2474 /* Override parse report for dongle specific hotplug handling. */ 2475 ps_dev->parse_report = dualshock4_dongle_parse_report; 2476 } 2477 2478 ret = dualshock4_get_mac_address(ds4); 2479 if (ret) { 2480 hid_err(hdev, "Failed to get MAC address from DualShock4\n"); 2481 return ERR_PTR(ret); 2482 } 2483 snprintf(hdev->uniq, sizeof(hdev->uniq), "%pMR", ds4->base.mac_address); 2484 2485 ret = dualshock4_get_firmware_info(ds4); 2486 if (ret) { 2487 hid_err(hdev, "Failed to get firmware info from DualShock4\n"); 2488 return ERR_PTR(ret); 2489 } 2490 2491 ret = ps_devices_list_add(ps_dev); 2492 if (ret) 2493 return ERR_PTR(ret); 2494 2495 ret = dualshock4_get_calibration_data(ds4); 2496 if (ret) { 2497 hid_err(hdev, "Failed to get calibration data from DualShock4\n"); 2498 goto err; 2499 } 2500 2501 ds4->gamepad = ps_gamepad_create(hdev, dualshock4_play_effect); 2502 if (IS_ERR(ds4->gamepad)) { 2503 ret = PTR_ERR(ds4->gamepad); 2504 goto err; 2505 } 2506 2507 /* Use gamepad input device name as primary device name for e.g. LEDs */ 2508 ps_dev->input_dev_name = dev_name(&ds4->gamepad->dev); 2509 2510 ds4->sensors = ps_sensors_create(hdev, DS4_ACC_RANGE, DS4_ACC_RES_PER_G, 2511 DS4_GYRO_RANGE, DS4_GYRO_RES_PER_DEG_S); 2512 if (IS_ERR(ds4->sensors)) { 2513 ret = PTR_ERR(ds4->sensors); 2514 goto err; 2515 } 2516 2517 ds4->touchpad = ps_touchpad_create(hdev, DS4_TOUCHPAD_WIDTH, DS4_TOUCHPAD_HEIGHT, 2); 2518 if (IS_ERR(ds4->touchpad)) { 2519 ret = PTR_ERR(ds4->touchpad); 2520 goto err; 2521 } 2522 2523 ret = ps_device_register_battery(ps_dev); 2524 if (ret) 2525 goto err; 2526 2527 for (i = 0; i < ARRAY_SIZE(lightbar_leds_info); i++) { 2528 const struct ps_led_info *led_info = &lightbar_leds_info[i]; 2529 2530 ret = ps_led_register(ps_dev, &ds4->lightbar_leds[i], led_info); 2531 if (ret < 0) 2532 goto err; 2533 } 2534 2535 dualshock4_set_bt_poll_interval(ds4, DS4_BT_DEFAULT_POLL_INTERVAL_MS); 2536 2537 ret = ps_device_set_player_id(ps_dev); 2538 if (ret) { 2539 hid_err(hdev, "Failed to assign player id for DualShock4: %d\n", ret); 2540 goto err; 2541 } 2542 2543 dualshock4_set_default_lightbar_colors(ds4); 2544 2545 /* 2546 * Reporting hardware and firmware is important as there are frequent updates, which 2547 * can change behavior. 2548 */ 2549 hid_info(hdev, "Registered DualShock4 controller hw_version=0x%08x fw_version=0x%08x\n", 2550 ds4->base.hw_version, ds4->base.fw_version); 2551 return &ds4->base; 2552 2553 err: 2554 ps_devices_list_remove(ps_dev); 2555 return ERR_PTR(ret); 2556 } 2557 2558 static int ps_raw_event(struct hid_device *hdev, struct hid_report *report, 2559 u8 *data, int size) 2560 { 2561 struct ps_device *dev = hid_get_drvdata(hdev); 2562 2563 if (dev && dev->parse_report) 2564 return dev->parse_report(dev, report, data, size); 2565 2566 return 0; 2567 } 2568 2569 static int ps_probe(struct hid_device *hdev, const struct hid_device_id *id) 2570 { 2571 struct ps_device *dev; 2572 int ret; 2573 2574 ret = hid_parse(hdev); 2575 if (ret) { 2576 hid_err(hdev, "Parse failed\n"); 2577 return ret; 2578 } 2579 2580 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW); 2581 if (ret) { 2582 hid_err(hdev, "Failed to start HID device\n"); 2583 return ret; 2584 } 2585 2586 ret = hid_hw_open(hdev); 2587 if (ret) { 2588 hid_err(hdev, "Failed to open HID device\n"); 2589 goto err_stop; 2590 } 2591 2592 if (hdev->product == USB_DEVICE_ID_SONY_PS4_CONTROLLER || 2593 hdev->product == USB_DEVICE_ID_SONY_PS4_CONTROLLER_2 || 2594 hdev->product == USB_DEVICE_ID_SONY_PS4_CONTROLLER_DONGLE) { 2595 dev = dualshock4_create(hdev); 2596 if (IS_ERR(dev)) { 2597 hid_err(hdev, "Failed to create dualshock4.\n"); 2598 ret = PTR_ERR(dev); 2599 goto err_close; 2600 } 2601 } else if (hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER || 2602 hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER_2) { 2603 dev = dualsense_create(hdev); 2604 if (IS_ERR(dev)) { 2605 hid_err(hdev, "Failed to create dualsense.\n"); 2606 ret = PTR_ERR(dev); 2607 goto err_close; 2608 } 2609 } 2610 2611 return ret; 2612 2613 err_close: 2614 hid_hw_close(hdev); 2615 err_stop: 2616 hid_hw_stop(hdev); 2617 return ret; 2618 } 2619 2620 static void ps_remove(struct hid_device *hdev) 2621 { 2622 struct ps_device *dev = hid_get_drvdata(hdev); 2623 2624 ps_devices_list_remove(dev); 2625 ps_device_release_player_id(dev); 2626 2627 if (dev->remove) 2628 dev->remove(dev); 2629 2630 hid_hw_close(hdev); 2631 hid_hw_stop(hdev); 2632 } 2633 2634 static const struct hid_device_id ps_devices[] = { 2635 /* Sony DualShock 4 controllers for PS4 */ 2636 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS4_CONTROLLER) }, 2637 { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS4_CONTROLLER) }, 2638 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS4_CONTROLLER_2) }, 2639 { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS4_CONTROLLER_2) }, 2640 { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS4_CONTROLLER_DONGLE) }, 2641 /* Sony DualSense controllers for PS5 */ 2642 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER) }, 2643 { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER) }, 2644 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER_2) }, 2645 { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER_2) }, 2646 { } 2647 }; 2648 MODULE_DEVICE_TABLE(hid, ps_devices); 2649 2650 static struct hid_driver ps_driver = { 2651 .name = "playstation", 2652 .id_table = ps_devices, 2653 .probe = ps_probe, 2654 .remove = ps_remove, 2655 .raw_event = ps_raw_event, 2656 .driver = { 2657 .dev_groups = ps_device_groups, 2658 }, 2659 }; 2660 2661 static int __init ps_init(void) 2662 { 2663 return hid_register_driver(&ps_driver); 2664 } 2665 2666 static void __exit ps_exit(void) 2667 { 2668 hid_unregister_driver(&ps_driver); 2669 ida_destroy(&ps_player_id_allocator); 2670 } 2671 2672 module_init(ps_init); 2673 module_exit(ps_exit); 2674 2675 MODULE_AUTHOR("Sony Interactive Entertainment"); 2676 MODULE_DESCRIPTION("HID Driver for PlayStation peripherals."); 2677 MODULE_LICENSE("GPL"); 2678