1// SPDX-License-Identifier: GPL-2.0+ 2/* 3 * HID driver for Nintendo Switch Joy-Cons and Pro Controllers 4 * 5 * Copyright (c) 2019-2021 Daniel J. Ogorchock <djogorchock@gmail.com> 6 * Portions Copyright (c) 2020 Nadia Holmquist Pedersen <nadia@nhp.sh> 7 * Copyright (c) 2022 Emily Strickland <linux@emily.st> 8 * Copyright (c) 2023 Ryan McClelland <rymcclel@gmail.com> 9 * 10 * The following resources/projects were referenced for this driver: 11 * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering 12 * https://gitlab.com/pjranki/joycon-linux-kernel (Peter Rankin) 13 * https://github.com/FrotBot/SwitchProConLinuxUSB 14 * https://github.com/MTCKC/ProconXInput 15 * https://github.com/Davidobot/BetterJoyForCemu 16 * hid-wiimote kernel hid driver 17 * hid-logitech-hidpp driver 18 * hid-sony driver 19 * 20 * This driver supports the Nintendo Switch Joy-Cons and Pro Controllers. The 21 * Pro Controllers can either be used over USB or Bluetooth. 22 * 23 * This driver also incorporates support for Nintendo Switch Online controllers 24 * for the NES, SNES, Sega Genesis, and N64. 25 * 26 * The driver will retrieve the factory calibration info from the controllers, 27 * so little to no user calibration should be required. 28 * 29 */ 30 31#include "hid-ids.h" 32#include <asm/unaligned.h> 33#include <linux/delay.h> 34#include <linux/device.h> 35#include <linux/kernel.h> 36#include <linux/hid.h> 37#include <linux/idr.h> 38#include <linux/input.h> 39#include <linux/jiffies.h> 40#include <linux/leds.h> 41#include <linux/module.h> 42#include <linux/power_supply.h> 43#include <linux/spinlock.h> 44 45/* 46 * Reference the url below for the following HID report defines: 47 * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering 48 */ 49 50/* Output Reports */ 51#define JC_OUTPUT_RUMBLE_AND_SUBCMD 0x01 52#define JC_OUTPUT_FW_UPDATE_PKT 0x03 53#define JC_OUTPUT_RUMBLE_ONLY 0x10 54#define JC_OUTPUT_MCU_DATA 0x11 55#define JC_OUTPUT_USB_CMD 0x80 56 57/* Subcommand IDs */ 58#define JC_SUBCMD_STATE 0x00 59#define JC_SUBCMD_MANUAL_BT_PAIRING 0x01 60#define JC_SUBCMD_REQ_DEV_INFO 0x02 61#define JC_SUBCMD_SET_REPORT_MODE 0x03 62#define JC_SUBCMD_TRIGGERS_ELAPSED 0x04 63#define JC_SUBCMD_GET_PAGE_LIST_STATE 0x05 64#define JC_SUBCMD_SET_HCI_STATE 0x06 65#define JC_SUBCMD_RESET_PAIRING_INFO 0x07 66#define JC_SUBCMD_LOW_POWER_MODE 0x08 67#define JC_SUBCMD_SPI_FLASH_READ 0x10 68#define JC_SUBCMD_SPI_FLASH_WRITE 0x11 69#define JC_SUBCMD_RESET_MCU 0x20 70#define JC_SUBCMD_SET_MCU_CONFIG 0x21 71#define JC_SUBCMD_SET_MCU_STATE 0x22 72#define JC_SUBCMD_SET_PLAYER_LIGHTS 0x30 73#define JC_SUBCMD_GET_PLAYER_LIGHTS 0x31 74#define JC_SUBCMD_SET_HOME_LIGHT 0x38 75#define JC_SUBCMD_ENABLE_IMU 0x40 76#define JC_SUBCMD_SET_IMU_SENSITIVITY 0x41 77#define JC_SUBCMD_WRITE_IMU_REG 0x42 78#define JC_SUBCMD_READ_IMU_REG 0x43 79#define JC_SUBCMD_ENABLE_VIBRATION 0x48 80#define JC_SUBCMD_GET_REGULATED_VOLTAGE 0x50 81 82/* Input Reports */ 83#define JC_INPUT_BUTTON_EVENT 0x3F 84#define JC_INPUT_SUBCMD_REPLY 0x21 85#define JC_INPUT_IMU_DATA 0x30 86#define JC_INPUT_MCU_DATA 0x31 87#define JC_INPUT_USB_RESPONSE 0x81 88 89/* Feature Reports */ 90#define JC_FEATURE_LAST_SUBCMD 0x02 91#define JC_FEATURE_OTA_FW_UPGRADE 0x70 92#define JC_FEATURE_SETUP_MEM_READ 0x71 93#define JC_FEATURE_MEM_READ 0x72 94#define JC_FEATURE_ERASE_MEM_SECTOR 0x73 95#define JC_FEATURE_MEM_WRITE 0x74 96#define JC_FEATURE_LAUNCH 0x75 97 98/* USB Commands */ 99#define JC_USB_CMD_CONN_STATUS 0x01 100#define JC_USB_CMD_HANDSHAKE 0x02 101#define JC_USB_CMD_BAUDRATE_3M 0x03 102#define JC_USB_CMD_NO_TIMEOUT 0x04 103#define JC_USB_CMD_EN_TIMEOUT 0x05 104#define JC_USB_RESET 0x06 105#define JC_USB_PRE_HANDSHAKE 0x91 106#define JC_USB_SEND_UART 0x92 107 108/* Magic value denoting presence of user calibration */ 109#define JC_CAL_USR_MAGIC_0 0xB2 110#define JC_CAL_USR_MAGIC_1 0xA1 111#define JC_CAL_USR_MAGIC_SIZE 2 112 113/* SPI storage addresses of user calibration data */ 114#define JC_CAL_USR_LEFT_MAGIC_ADDR 0x8010 115#define JC_CAL_USR_LEFT_DATA_ADDR 0x8012 116#define JC_CAL_USR_LEFT_DATA_END 0x801A 117#define JC_CAL_USR_RIGHT_MAGIC_ADDR 0x801B 118#define JC_CAL_USR_RIGHT_DATA_ADDR 0x801D 119#define JC_CAL_STICK_DATA_SIZE \ 120 (JC_CAL_USR_LEFT_DATA_END - JC_CAL_USR_LEFT_DATA_ADDR + 1) 121 122/* SPI storage addresses of factory calibration data */ 123#define JC_CAL_FCT_DATA_LEFT_ADDR 0x603d 124#define JC_CAL_FCT_DATA_RIGHT_ADDR 0x6046 125 126/* SPI storage addresses of IMU factory calibration data */ 127#define JC_IMU_CAL_FCT_DATA_ADDR 0x6020 128#define JC_IMU_CAL_FCT_DATA_END 0x6037 129#define JC_IMU_CAL_DATA_SIZE \ 130 (JC_IMU_CAL_FCT_DATA_END - JC_IMU_CAL_FCT_DATA_ADDR + 1) 131/* SPI storage addresses of IMU user calibration data */ 132#define JC_IMU_CAL_USR_MAGIC_ADDR 0x8026 133#define JC_IMU_CAL_USR_DATA_ADDR 0x8028 134 135/* The raw analog joystick values will be mapped in terms of this magnitude */ 136#define JC_MAX_STICK_MAG 32767 137#define JC_STICK_FUZZ 250 138#define JC_STICK_FLAT 500 139 140/* Hat values for pro controller's d-pad */ 141#define JC_MAX_DPAD_MAG 1 142#define JC_DPAD_FUZZ 0 143#define JC_DPAD_FLAT 0 144 145/* Under most circumstances IMU reports are pushed every 15ms; use as default */ 146#define JC_IMU_DFLT_AVG_DELTA_MS 15 147/* How many samples to sum before calculating average IMU report delta */ 148#define JC_IMU_SAMPLES_PER_DELTA_AVG 300 149/* Controls how many dropped IMU packets at once trigger a warning message */ 150#define JC_IMU_DROPPED_PKT_WARNING 3 151 152/* 153 * The controller's accelerometer has a sensor resolution of 16bits and is 154 * configured with a range of +-8000 milliGs. Therefore, the resolution can be 155 * calculated thus: (2^16-1)/(8000 * 2) = 4.096 digits per milliG 156 * Resolution per G (rather than per millliG): 4.096 * 1000 = 4096 digits per G 157 * Alternatively: 1/4096 = .0002441 Gs per digit 158 */ 159#define JC_IMU_MAX_ACCEL_MAG 32767 160#define JC_IMU_ACCEL_RES_PER_G 4096 161#define JC_IMU_ACCEL_FUZZ 10 162#define JC_IMU_ACCEL_FLAT 0 163 164/* 165 * The controller's gyroscope has a sensor resolution of 16bits and is 166 * configured with a range of +-2000 degrees/second. 167 * Digits per dps: (2^16 -1)/(2000*2) = 16.38375 168 * dps per digit: 16.38375E-1 = .0610 169 * 170 * STMicro recommends in the datasheet to add 15% to the dps/digit. This allows 171 * the full sensitivity range to be saturated without clipping. This yields more 172 * accurate results, so it's the technique this driver uses. 173 * dps per digit (corrected): .0610 * 1.15 = .0702 174 * digits per dps (corrected): .0702E-1 = 14.247 175 * 176 * Now, 14.247 truncating to 14 loses a lot of precision, so we rescale the 177 * min/max range by 1000. 178 */ 179#define JC_IMU_PREC_RANGE_SCALE 1000 180/* Note: change mag and res_per_dps if prec_range_scale is ever altered */ 181#define JC_IMU_MAX_GYRO_MAG 32767000 /* (2^16-1)*1000 */ 182#define JC_IMU_GYRO_RES_PER_DPS 14247 /* (14.247*1000) */ 183#define JC_IMU_GYRO_FUZZ 10 184#define JC_IMU_GYRO_FLAT 0 185 186/* frequency/amplitude tables for rumble */ 187struct joycon_rumble_freq_data { 188 u16 high; 189 u8 low; 190 u16 freq; /* Hz*/ 191}; 192 193struct joycon_rumble_amp_data { 194 u8 high; 195 u16 low; 196 u16 amp; 197}; 198 199#if IS_ENABLED(CONFIG_NINTENDO_FF) 200/* 201 * These tables are from 202 * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/rumble_data_table.md 203 */ 204static const struct joycon_rumble_freq_data joycon_rumble_frequencies[] = { 205 /* high, low, freq */ 206 { 0x0000, 0x01, 41 }, { 0x0000, 0x02, 42 }, { 0x0000, 0x03, 43 }, 207 { 0x0000, 0x04, 44 }, { 0x0000, 0x05, 45 }, { 0x0000, 0x06, 46 }, 208 { 0x0000, 0x07, 47 }, { 0x0000, 0x08, 48 }, { 0x0000, 0x09, 49 }, 209 { 0x0000, 0x0A, 50 }, { 0x0000, 0x0B, 51 }, { 0x0000, 0x0C, 52 }, 210 { 0x0000, 0x0D, 53 }, { 0x0000, 0x0E, 54 }, { 0x0000, 0x0F, 55 }, 211 { 0x0000, 0x10, 57 }, { 0x0000, 0x11, 58 }, { 0x0000, 0x12, 59 }, 212 { 0x0000, 0x13, 60 }, { 0x0000, 0x14, 62 }, { 0x0000, 0x15, 63 }, 213 { 0x0000, 0x16, 64 }, { 0x0000, 0x17, 66 }, { 0x0000, 0x18, 67 }, 214 { 0x0000, 0x19, 69 }, { 0x0000, 0x1A, 70 }, { 0x0000, 0x1B, 72 }, 215 { 0x0000, 0x1C, 73 }, { 0x0000, 0x1D, 75 }, { 0x0000, 0x1e, 77 }, 216 { 0x0000, 0x1f, 78 }, { 0x0000, 0x20, 80 }, { 0x0400, 0x21, 82 }, 217 { 0x0800, 0x22, 84 }, { 0x0c00, 0x23, 85 }, { 0x1000, 0x24, 87 }, 218 { 0x1400, 0x25, 89 }, { 0x1800, 0x26, 91 }, { 0x1c00, 0x27, 93 }, 219 { 0x2000, 0x28, 95 }, { 0x2400, 0x29, 97 }, { 0x2800, 0x2a, 99 }, 220 { 0x2c00, 0x2b, 102 }, { 0x3000, 0x2c, 104 }, { 0x3400, 0x2d, 106 }, 221 { 0x3800, 0x2e, 108 }, { 0x3c00, 0x2f, 111 }, { 0x4000, 0x30, 113 }, 222 { 0x4400, 0x31, 116 }, { 0x4800, 0x32, 118 }, { 0x4c00, 0x33, 121 }, 223 { 0x5000, 0x34, 123 }, { 0x5400, 0x35, 126 }, { 0x5800, 0x36, 129 }, 224 { 0x5c00, 0x37, 132 }, { 0x6000, 0x38, 135 }, { 0x6400, 0x39, 137 }, 225 { 0x6800, 0x3a, 141 }, { 0x6c00, 0x3b, 144 }, { 0x7000, 0x3c, 147 }, 226 { 0x7400, 0x3d, 150 }, { 0x7800, 0x3e, 153 }, { 0x7c00, 0x3f, 157 }, 227 { 0x8000, 0x40, 160 }, { 0x8400, 0x41, 164 }, { 0x8800, 0x42, 167 }, 228 { 0x8c00, 0x43, 171 }, { 0x9000, 0x44, 174 }, { 0x9400, 0x45, 178 }, 229 { 0x9800, 0x46, 182 }, { 0x9c00, 0x47, 186 }, { 0xa000, 0x48, 190 }, 230 { 0xa400, 0x49, 194 }, { 0xa800, 0x4a, 199 }, { 0xac00, 0x4b, 203 }, 231 { 0xb000, 0x4c, 207 }, { 0xb400, 0x4d, 212 }, { 0xb800, 0x4e, 217 }, 232 { 0xbc00, 0x4f, 221 }, { 0xc000, 0x50, 226 }, { 0xc400, 0x51, 231 }, 233 { 0xc800, 0x52, 236 }, { 0xcc00, 0x53, 241 }, { 0xd000, 0x54, 247 }, 234 { 0xd400, 0x55, 252 }, { 0xd800, 0x56, 258 }, { 0xdc00, 0x57, 263 }, 235 { 0xe000, 0x58, 269 }, { 0xe400, 0x59, 275 }, { 0xe800, 0x5a, 281 }, 236 { 0xec00, 0x5b, 287 }, { 0xf000, 0x5c, 293 }, { 0xf400, 0x5d, 300 }, 237 { 0xf800, 0x5e, 306 }, { 0xfc00, 0x5f, 313 }, { 0x0001, 0x60, 320 }, 238 { 0x0401, 0x61, 327 }, { 0x0801, 0x62, 334 }, { 0x0c01, 0x63, 341 }, 239 { 0x1001, 0x64, 349 }, { 0x1401, 0x65, 357 }, { 0x1801, 0x66, 364 }, 240 { 0x1c01, 0x67, 372 }, { 0x2001, 0x68, 381 }, { 0x2401, 0x69, 389 }, 241 { 0x2801, 0x6a, 397 }, { 0x2c01, 0x6b, 406 }, { 0x3001, 0x6c, 415 }, 242 { 0x3401, 0x6d, 424 }, { 0x3801, 0x6e, 433 }, { 0x3c01, 0x6f, 443 }, 243 { 0x4001, 0x70, 453 }, { 0x4401, 0x71, 462 }, { 0x4801, 0x72, 473 }, 244 { 0x4c01, 0x73, 483 }, { 0x5001, 0x74, 494 }, { 0x5401, 0x75, 504 }, 245 { 0x5801, 0x76, 515 }, { 0x5c01, 0x77, 527 }, { 0x6001, 0x78, 538 }, 246 { 0x6401, 0x79, 550 }, { 0x6801, 0x7a, 562 }, { 0x6c01, 0x7b, 574 }, 247 { 0x7001, 0x7c, 587 }, { 0x7401, 0x7d, 600 }, { 0x7801, 0x7e, 613 }, 248 { 0x7c01, 0x7f, 626 }, { 0x8001, 0x00, 640 }, { 0x8401, 0x00, 654 }, 249 { 0x8801, 0x00, 668 }, { 0x8c01, 0x00, 683 }, { 0x9001, 0x00, 698 }, 250 { 0x9401, 0x00, 713 }, { 0x9801, 0x00, 729 }, { 0x9c01, 0x00, 745 }, 251 { 0xa001, 0x00, 761 }, { 0xa401, 0x00, 778 }, { 0xa801, 0x00, 795 }, 252 { 0xac01, 0x00, 812 }, { 0xb001, 0x00, 830 }, { 0xb401, 0x00, 848 }, 253 { 0xb801, 0x00, 867 }, { 0xbc01, 0x00, 886 }, { 0xc001, 0x00, 905 }, 254 { 0xc401, 0x00, 925 }, { 0xc801, 0x00, 945 }, { 0xcc01, 0x00, 966 }, 255 { 0xd001, 0x00, 987 }, { 0xd401, 0x00, 1009 }, { 0xd801, 0x00, 1031 }, 256 { 0xdc01, 0x00, 1053 }, { 0xe001, 0x00, 1076 }, { 0xe401, 0x00, 1100 }, 257 { 0xe801, 0x00, 1124 }, { 0xec01, 0x00, 1149 }, { 0xf001, 0x00, 1174 }, 258 { 0xf401, 0x00, 1199 }, { 0xf801, 0x00, 1226 }, { 0xfc01, 0x00, 1253 } 259}; 260 261#define joycon_max_rumble_amp (1003) 262static const struct joycon_rumble_amp_data joycon_rumble_amplitudes[] = { 263 /* high, low, amp */ 264 { 0x00, 0x0040, 0 }, 265 { 0x02, 0x8040, 10 }, { 0x04, 0x0041, 12 }, { 0x06, 0x8041, 14 }, 266 { 0x08, 0x0042, 17 }, { 0x0a, 0x8042, 20 }, { 0x0c, 0x0043, 24 }, 267 { 0x0e, 0x8043, 28 }, { 0x10, 0x0044, 33 }, { 0x12, 0x8044, 40 }, 268 { 0x14, 0x0045, 47 }, { 0x16, 0x8045, 56 }, { 0x18, 0x0046, 67 }, 269 { 0x1a, 0x8046, 80 }, { 0x1c, 0x0047, 95 }, { 0x1e, 0x8047, 112 }, 270 { 0x20, 0x0048, 117 }, { 0x22, 0x8048, 123 }, { 0x24, 0x0049, 128 }, 271 { 0x26, 0x8049, 134 }, { 0x28, 0x004a, 140 }, { 0x2a, 0x804a, 146 }, 272 { 0x2c, 0x004b, 152 }, { 0x2e, 0x804b, 159 }, { 0x30, 0x004c, 166 }, 273 { 0x32, 0x804c, 173 }, { 0x34, 0x004d, 181 }, { 0x36, 0x804d, 189 }, 274 { 0x38, 0x004e, 198 }, { 0x3a, 0x804e, 206 }, { 0x3c, 0x004f, 215 }, 275 { 0x3e, 0x804f, 225 }, { 0x40, 0x0050, 230 }, { 0x42, 0x8050, 235 }, 276 { 0x44, 0x0051, 240 }, { 0x46, 0x8051, 245 }, { 0x48, 0x0052, 251 }, 277 { 0x4a, 0x8052, 256 }, { 0x4c, 0x0053, 262 }, { 0x4e, 0x8053, 268 }, 278 { 0x50, 0x0054, 273 }, { 0x52, 0x8054, 279 }, { 0x54, 0x0055, 286 }, 279 { 0x56, 0x8055, 292 }, { 0x58, 0x0056, 298 }, { 0x5a, 0x8056, 305 }, 280 { 0x5c, 0x0057, 311 }, { 0x5e, 0x8057, 318 }, { 0x60, 0x0058, 325 }, 281 { 0x62, 0x8058, 332 }, { 0x64, 0x0059, 340 }, { 0x66, 0x8059, 347 }, 282 { 0x68, 0x005a, 355 }, { 0x6a, 0x805a, 362 }, { 0x6c, 0x005b, 370 }, 283 { 0x6e, 0x805b, 378 }, { 0x70, 0x005c, 387 }, { 0x72, 0x805c, 395 }, 284 { 0x74, 0x005d, 404 }, { 0x76, 0x805d, 413 }, { 0x78, 0x005e, 422 }, 285 { 0x7a, 0x805e, 431 }, { 0x7c, 0x005f, 440 }, { 0x7e, 0x805f, 450 }, 286 { 0x80, 0x0060, 460 }, { 0x82, 0x8060, 470 }, { 0x84, 0x0061, 480 }, 287 { 0x86, 0x8061, 491 }, { 0x88, 0x0062, 501 }, { 0x8a, 0x8062, 512 }, 288 { 0x8c, 0x0063, 524 }, { 0x8e, 0x8063, 535 }, { 0x90, 0x0064, 547 }, 289 { 0x92, 0x8064, 559 }, { 0x94, 0x0065, 571 }, { 0x96, 0x8065, 584 }, 290 { 0x98, 0x0066, 596 }, { 0x9a, 0x8066, 609 }, { 0x9c, 0x0067, 623 }, 291 { 0x9e, 0x8067, 636 }, { 0xa0, 0x0068, 650 }, { 0xa2, 0x8068, 665 }, 292 { 0xa4, 0x0069, 679 }, { 0xa6, 0x8069, 694 }, { 0xa8, 0x006a, 709 }, 293 { 0xaa, 0x806a, 725 }, { 0xac, 0x006b, 741 }, { 0xae, 0x806b, 757 }, 294 { 0xb0, 0x006c, 773 }, { 0xb2, 0x806c, 790 }, { 0xb4, 0x006d, 808 }, 295 { 0xb6, 0x806d, 825 }, { 0xb8, 0x006e, 843 }, { 0xba, 0x806e, 862 }, 296 { 0xbc, 0x006f, 881 }, { 0xbe, 0x806f, 900 }, { 0xc0, 0x0070, 920 }, 297 { 0xc2, 0x8070, 940 }, { 0xc4, 0x0071, 960 }, { 0xc6, 0x8071, 981 }, 298 { 0xc8, 0x0072, joycon_max_rumble_amp } 299}; 300static const u16 JC_RUMBLE_DFLT_LOW_FREQ = 160; 301static const u16 JC_RUMBLE_DFLT_HIGH_FREQ = 320; 302static const unsigned short JC_RUMBLE_ZERO_AMP_PKT_CNT = 5; 303#endif /* IS_ENABLED(CONFIG_NINTENDO_FF) */ 304static const u16 JC_RUMBLE_PERIOD_MS = 50; 305 306/* States for controller state machine */ 307enum joycon_ctlr_state { 308 JOYCON_CTLR_STATE_INIT, 309 JOYCON_CTLR_STATE_READ, 310 JOYCON_CTLR_STATE_REMOVED, 311}; 312 313/* Controller type received as part of device info */ 314enum joycon_ctlr_type { 315 JOYCON_CTLR_TYPE_JCL = 0x01, 316 JOYCON_CTLR_TYPE_JCR = 0x02, 317 JOYCON_CTLR_TYPE_PRO = 0x03, 318 JOYCON_CTLR_TYPE_NESL = 0x09, 319 JOYCON_CTLR_TYPE_NESR = 0x0A, 320 JOYCON_CTLR_TYPE_SNES = 0x0B, 321 JOYCON_CTLR_TYPE_GEN = 0x0D, 322 JOYCON_CTLR_TYPE_N64 = 0x0C, 323}; 324 325struct joycon_stick_cal { 326 s32 max; 327 s32 min; 328 s32 center; 329}; 330 331struct joycon_imu_cal { 332 s16 offset[3]; 333 s16 scale[3]; 334}; 335 336/* 337 * All the controller's button values are stored in a u32. 338 * They can be accessed with bitwise ANDs. 339 */ 340#define JC_BTN_Y BIT(0) 341#define JC_BTN_X BIT(1) 342#define JC_BTN_B BIT(2) 343#define JC_BTN_A BIT(3) 344#define JC_BTN_SR_R BIT(4) 345#define JC_BTN_SL_R BIT(5) 346#define JC_BTN_R BIT(6) 347#define JC_BTN_ZR BIT(7) 348#define JC_BTN_MINUS BIT(8) 349#define JC_BTN_PLUS BIT(9) 350#define JC_BTN_RSTICK BIT(10) 351#define JC_BTN_LSTICK BIT(11) 352#define JC_BTN_HOME BIT(12) 353#define JC_BTN_CAP BIT(13) /* capture button */ 354#define JC_BTN_DOWN BIT(16) 355#define JC_BTN_UP BIT(17) 356#define JC_BTN_RIGHT BIT(18) 357#define JC_BTN_LEFT BIT(19) 358#define JC_BTN_SR_L BIT(20) 359#define JC_BTN_SL_L BIT(21) 360#define JC_BTN_L BIT(22) 361#define JC_BTN_ZL BIT(23) 362 363struct joycon_ctlr_button_mapping { 364 u32 code; 365 u32 bit; 366}; 367 368/* 369 * D-pad is configured as buttons for the left Joy-Con only! 370 */ 371static const struct joycon_ctlr_button_mapping left_joycon_button_mappings[] = { 372 { BTN_TL, JC_BTN_L, }, 373 { BTN_TL2, JC_BTN_ZL, }, 374 { BTN_SELECT, JC_BTN_MINUS, }, 375 { BTN_THUMBL, JC_BTN_LSTICK, }, 376 { BTN_DPAD_UP, JC_BTN_UP, }, 377 { BTN_DPAD_DOWN, JC_BTN_DOWN, }, 378 { BTN_DPAD_LEFT, JC_BTN_LEFT, }, 379 { BTN_DPAD_RIGHT, JC_BTN_RIGHT, }, 380 { BTN_Z, JC_BTN_CAP, }, 381 { /* sentinel */ }, 382}; 383 384/* 385 * The unused *right*-side triggers become the SL/SR triggers for the *left* 386 * Joy-Con, if and only if we're not using a charging grip. 387 */ 388static const struct joycon_ctlr_button_mapping left_joycon_s_button_mappings[] = { 389 { BTN_TR, JC_BTN_SL_L, }, 390 { BTN_TR2, JC_BTN_SR_L, }, 391 { /* sentinel */ }, 392}; 393 394static const struct joycon_ctlr_button_mapping right_joycon_button_mappings[] = { 395 { BTN_EAST, JC_BTN_A, }, 396 { BTN_SOUTH, JC_BTN_B, }, 397 { BTN_NORTH, JC_BTN_X, }, 398 { BTN_WEST, JC_BTN_Y, }, 399 { BTN_TR, JC_BTN_R, }, 400 { BTN_TR2, JC_BTN_ZR, }, 401 { BTN_START, JC_BTN_PLUS, }, 402 { BTN_THUMBR, JC_BTN_RSTICK, }, 403 { BTN_MODE, JC_BTN_HOME, }, 404 { /* sentinel */ }, 405}; 406 407/* 408 * The unused *left*-side triggers become the SL/SR triggers for the *right* 409 * Joy-Con, if and only if we're not using a charging grip. 410 */ 411static const struct joycon_ctlr_button_mapping right_joycon_s_button_mappings[] = { 412 { BTN_TL, JC_BTN_SL_R, }, 413 { BTN_TL2, JC_BTN_SR_R, }, 414 { /* sentinel */ }, 415}; 416 417static const struct joycon_ctlr_button_mapping procon_button_mappings[] = { 418 { BTN_EAST, JC_BTN_A, }, 419 { BTN_SOUTH, JC_BTN_B, }, 420 { BTN_NORTH, JC_BTN_X, }, 421 { BTN_WEST, JC_BTN_Y, }, 422 { BTN_TL, JC_BTN_L, }, 423 { BTN_TR, JC_BTN_R, }, 424 { BTN_TL2, JC_BTN_ZL, }, 425 { BTN_TR2, JC_BTN_ZR, }, 426 { BTN_SELECT, JC_BTN_MINUS, }, 427 { BTN_START, JC_BTN_PLUS, }, 428 { BTN_THUMBL, JC_BTN_LSTICK, }, 429 { BTN_THUMBR, JC_BTN_RSTICK, }, 430 { BTN_MODE, JC_BTN_HOME, }, 431 { BTN_Z, JC_BTN_CAP, }, 432 { /* sentinel */ }, 433}; 434 435static const struct joycon_ctlr_button_mapping nescon_button_mappings[] = { 436 { BTN_SOUTH, JC_BTN_A, }, 437 { BTN_EAST, JC_BTN_B, }, 438 { BTN_TL, JC_BTN_L, }, 439 { BTN_TR, JC_BTN_R, }, 440 { BTN_SELECT, JC_BTN_MINUS, }, 441 { BTN_START, JC_BTN_PLUS, }, 442 { /* sentinel */ }, 443}; 444 445static const struct joycon_ctlr_button_mapping snescon_button_mappings[] = { 446 { BTN_EAST, JC_BTN_A, }, 447 { BTN_SOUTH, JC_BTN_B, }, 448 { BTN_NORTH, JC_BTN_X, }, 449 { BTN_WEST, JC_BTN_Y, }, 450 { BTN_TL, JC_BTN_L, }, 451 { BTN_TR, JC_BTN_R, }, 452 { BTN_TL2, JC_BTN_ZL, }, 453 { BTN_TR2, JC_BTN_ZR, }, 454 { BTN_SELECT, JC_BTN_MINUS, }, 455 { BTN_START, JC_BTN_PLUS, }, 456 { /* sentinel */ }, 457}; 458 459/* 460 * "A", "B", and "C" are mapped positionally, rather than by label (e.g., "A" 461 * gets assigned to BTN_EAST instead of BTN_A). 462 */ 463static const struct joycon_ctlr_button_mapping gencon_button_mappings[] = { 464 { BTN_SOUTH, JC_BTN_A, }, 465 { BTN_EAST, JC_BTN_B, }, 466 { BTN_WEST, JC_BTN_R, }, 467 { BTN_SELECT, JC_BTN_ZR, }, 468 { BTN_START, JC_BTN_PLUS, }, 469 { BTN_MODE, JC_BTN_HOME, }, 470 { BTN_Z, JC_BTN_CAP, }, 471 { /* sentinel */ }, 472}; 473 474/* 475 * N64's C buttons get assigned to d-pad directions and registered as buttons. 476 */ 477static const struct joycon_ctlr_button_mapping n64con_button_mappings[] = { 478 { BTN_A, JC_BTN_A, }, 479 { BTN_B, JC_BTN_B, }, 480 { BTN_TL2, JC_BTN_ZL, }, /* Z */ 481 { BTN_TL, JC_BTN_L, }, 482 { BTN_TR, JC_BTN_R, }, 483 { BTN_TR2, JC_BTN_LSTICK, }, /* ZR */ 484 { BTN_START, JC_BTN_PLUS, }, 485 { BTN_SELECT, JC_BTN_Y, }, /* C UP */ 486 { BTN_X, JC_BTN_ZR, }, /* C DOWN */ 487 { BTN_Y, JC_BTN_X, }, /* C LEFT */ 488 { BTN_C, JC_BTN_MINUS, }, /* C RIGHT */ 489 { BTN_MODE, JC_BTN_HOME, }, 490 { BTN_Z, JC_BTN_CAP, }, 491 { /* sentinel */ }, 492}; 493 494enum joycon_msg_type { 495 JOYCON_MSG_TYPE_NONE, 496 JOYCON_MSG_TYPE_USB, 497 JOYCON_MSG_TYPE_SUBCMD, 498}; 499 500struct joycon_rumble_output { 501 u8 output_id; 502 u8 packet_num; 503 u8 rumble_data[8]; 504} __packed; 505 506struct joycon_subcmd_request { 507 u8 output_id; /* must be 0x01 for subcommand, 0x10 for rumble only */ 508 u8 packet_num; /* incremented every send */ 509 u8 rumble_data[8]; 510 u8 subcmd_id; 511 u8 data[]; /* length depends on the subcommand */ 512} __packed; 513 514struct joycon_subcmd_reply { 515 u8 ack; /* MSB 1 for ACK, 0 for NACK */ 516 u8 id; /* id of requested subcmd */ 517 u8 data[]; /* will be at most 35 bytes */ 518} __packed; 519 520struct joycon_imu_data { 521 s16 accel_x; 522 s16 accel_y; 523 s16 accel_z; 524 s16 gyro_x; 525 s16 gyro_y; 526 s16 gyro_z; 527} __packed; 528 529struct joycon_input_report { 530 u8 id; 531 u8 timer; 532 u8 bat_con; /* battery and connection info */ 533 u8 button_status[3]; 534 u8 left_stick[3]; 535 u8 right_stick[3]; 536 u8 vibrator_report; 537 538 union { 539 struct joycon_subcmd_reply subcmd_reply; 540 /* IMU input reports contain 3 samples */ 541 u8 imu_raw_bytes[sizeof(struct joycon_imu_data) * 3]; 542 }; 543} __packed; 544 545#define JC_MAX_RESP_SIZE (sizeof(struct joycon_input_report) + 35) 546#define JC_RUMBLE_DATA_SIZE 8 547#define JC_RUMBLE_QUEUE_SIZE 8 548 549static const char * const joycon_player_led_names[] = { 550 LED_FUNCTION_PLAYER1, 551 LED_FUNCTION_PLAYER2, 552 LED_FUNCTION_PLAYER3, 553 LED_FUNCTION_PLAYER4, 554}; 555#define JC_NUM_LEDS ARRAY_SIZE(joycon_player_led_names) 556#define JC_NUM_LED_PATTERNS 8 557/* Taken from https://www.nintendo.com/my/support/qa/detail/33822 */ 558static const enum led_brightness joycon_player_led_patterns[JC_NUM_LED_PATTERNS][JC_NUM_LEDS] = { 559 { 1, 0, 0, 0 }, 560 { 1, 1, 0, 0 }, 561 { 1, 1, 1, 0 }, 562 { 1, 1, 1, 1 }, 563 { 1, 0, 0, 1 }, 564 { 1, 0, 1, 0 }, 565 { 1, 0, 1, 1 }, 566 { 0, 1, 1, 0 }, 567}; 568 569/* Each physical controller is associated with a joycon_ctlr struct */ 570struct joycon_ctlr { 571 struct hid_device *hdev; 572 struct input_dev *input; 573 u32 player_id; 574 struct led_classdev leds[JC_NUM_LEDS]; /* player leds */ 575 struct led_classdev home_led; 576 enum joycon_ctlr_state ctlr_state; 577 spinlock_t lock; 578 u8 mac_addr[6]; 579 char *mac_addr_str; 580 enum joycon_ctlr_type ctlr_type; 581 582 /* The following members are used for synchronous sends/receives */ 583 enum joycon_msg_type msg_type; 584 u8 subcmd_num; 585 struct mutex output_mutex; 586 u8 input_buf[JC_MAX_RESP_SIZE]; 587 wait_queue_head_t wait; 588 bool received_resp; 589 u8 usb_ack_match; 590 u8 subcmd_ack_match; 591 bool received_input_report; 592 unsigned int last_input_report_msecs; 593 unsigned int last_subcmd_sent_msecs; 594 unsigned int consecutive_valid_report_deltas; 595 596 /* factory calibration data */ 597 struct joycon_stick_cal left_stick_cal_x; 598 struct joycon_stick_cal left_stick_cal_y; 599 struct joycon_stick_cal right_stick_cal_x; 600 struct joycon_stick_cal right_stick_cal_y; 601 602 struct joycon_imu_cal accel_cal; 603 struct joycon_imu_cal gyro_cal; 604 605 /* prevents needlessly recalculating these divisors every sample */ 606 s32 imu_cal_accel_divisor[3]; 607 s32 imu_cal_gyro_divisor[3]; 608 609 /* power supply data */ 610 struct power_supply *battery; 611 struct power_supply_desc battery_desc; 612 u8 battery_capacity; 613 bool battery_charging; 614 bool host_powered; 615 616 /* rumble */ 617 u8 rumble_data[JC_RUMBLE_QUEUE_SIZE][JC_RUMBLE_DATA_SIZE]; 618 int rumble_queue_head; 619 int rumble_queue_tail; 620 struct workqueue_struct *rumble_queue; 621 struct work_struct rumble_worker; 622 unsigned int rumble_msecs; 623 u16 rumble_ll_freq; 624 u16 rumble_lh_freq; 625 u16 rumble_rl_freq; 626 u16 rumble_rh_freq; 627 unsigned short rumble_zero_countdown; 628 629 /* imu */ 630 struct input_dev *imu_input; 631 bool imu_first_packet_received; /* helps in initiating timestamp */ 632 unsigned int imu_timestamp_us; /* timestamp we report to userspace */ 633 unsigned int imu_last_pkt_ms; /* used to calc imu report delta */ 634 /* the following are used to track the average imu report time delta */ 635 unsigned int imu_delta_samples_count; 636 unsigned int imu_delta_samples_sum; 637 unsigned int imu_avg_delta_ms; 638}; 639 640/* Helper macros for checking controller type */ 641#define jc_type_is_joycon(ctlr) \ 642 (ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONL || \ 643 ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONR || \ 644 ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_CHRGGRIP) 645#define jc_type_is_procon(ctlr) \ 646 (ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_PROCON) 647#define jc_type_is_chrggrip(ctlr) \ 648 (ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_CHRGGRIP) 649 650/* Does this controller have inputs associated with left joycon? */ 651#define jc_type_has_left(ctlr) \ 652 (ctlr->ctlr_type == JOYCON_CTLR_TYPE_JCL || \ 653 ctlr->ctlr_type == JOYCON_CTLR_TYPE_PRO || \ 654 ctlr->ctlr_type == JOYCON_CTLR_TYPE_N64) 655 656/* Does this controller have inputs associated with right joycon? */ 657#define jc_type_has_right(ctlr) \ 658 (ctlr->ctlr_type == JOYCON_CTLR_TYPE_JCR || \ 659 ctlr->ctlr_type == JOYCON_CTLR_TYPE_PRO) 660 661 662/* 663 * Controller device helpers 664 * 665 * These look at the device ID known to the HID subsystem to identify a device, 666 * but take caution: some NSO devices lie about themselves (NES Joy-Cons and 667 * Sega Genesis controller). See type helpers below. 668 * 669 * These helpers are most useful early during the HID probe or in conjunction 670 * with the capability helpers below. 671 */ 672static inline bool joycon_device_is_procon(struct joycon_ctlr *ctlr) 673{ 674 return ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_PROCON; 675} 676 677static inline bool joycon_device_is_chrggrip(struct joycon_ctlr *ctlr) 678{ 679 return ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_CHRGGRIP; 680} 681 682static inline bool joycon_device_is_snescon(struct joycon_ctlr *ctlr) 683{ 684 return ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_SNESCON; 685} 686 687static inline bool joycon_device_is_gencon(struct joycon_ctlr *ctlr) 688{ 689 return ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_GENCON; 690} 691 692static inline bool joycon_device_is_n64con(struct joycon_ctlr *ctlr) 693{ 694 return ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_N64CON; 695} 696 697/* 698 * Controller type helpers 699 * 700 * These are slightly different than the device-ID-based helpers above. They are 701 * generally more reliable, since they can distinguish between, e.g., Genesis 702 * versus SNES, or NES Joy-Cons versus regular Switch Joy-Cons. They're most 703 * useful for reporting available inputs. For other kinds of distinctions, see 704 * the capability helpers below. 705 * 706 * They have two major drawbacks: (1) they're not available until after we set 707 * the reporting method and then request the device info; (2) they can't 708 * distinguish all controllers (like the Charging Grip from the Pro controller.) 709 */ 710static inline bool joycon_type_is_left_joycon(struct joycon_ctlr *ctlr) 711{ 712 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_JCL; 713} 714 715static inline bool joycon_type_is_right_joycon(struct joycon_ctlr *ctlr) 716{ 717 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_JCR; 718} 719 720static inline bool joycon_type_is_procon(struct joycon_ctlr *ctlr) 721{ 722 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_PRO; 723} 724 725static inline bool joycon_type_is_snescon(struct joycon_ctlr *ctlr) 726{ 727 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_SNES; 728} 729 730static inline bool joycon_type_is_gencon(struct joycon_ctlr *ctlr) 731{ 732 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_GEN; 733} 734 735static inline bool joycon_type_is_n64con(struct joycon_ctlr *ctlr) 736{ 737 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_N64; 738} 739 740static inline bool joycon_type_is_left_nescon(struct joycon_ctlr *ctlr) 741{ 742 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_NESL; 743} 744 745static inline bool joycon_type_is_right_nescon(struct joycon_ctlr *ctlr) 746{ 747 return ctlr->ctlr_type == JOYCON_CTLR_TYPE_NESR; 748} 749 750static inline bool joycon_type_is_any_joycon(struct joycon_ctlr *ctlr) 751{ 752 return joycon_type_is_left_joycon(ctlr) || 753 joycon_type_is_right_joycon(ctlr) || 754 joycon_device_is_chrggrip(ctlr); 755} 756 757static inline bool joycon_type_is_any_nescon(struct joycon_ctlr *ctlr) 758{ 759 return joycon_type_is_left_nescon(ctlr) || 760 joycon_type_is_right_nescon(ctlr); 761} 762 763/* 764 * Controller capability helpers 765 * 766 * These helpers combine the use of the helpers above to detect certain 767 * capabilities during initialization. They are always accurate but (since they 768 * use type helpers) cannot be used early in the HID probe. 769 */ 770static inline bool joycon_has_imu(struct joycon_ctlr *ctlr) 771{ 772 return joycon_device_is_chrggrip(ctlr) || 773 joycon_type_is_any_joycon(ctlr) || 774 joycon_type_is_procon(ctlr); 775} 776 777static inline bool joycon_has_joysticks(struct joycon_ctlr *ctlr) 778{ 779 return joycon_device_is_chrggrip(ctlr) || 780 joycon_type_is_any_joycon(ctlr) || 781 joycon_type_is_procon(ctlr) || 782 joycon_type_is_n64con(ctlr); 783} 784 785static inline bool joycon_has_rumble(struct joycon_ctlr *ctlr) 786{ 787 return joycon_device_is_chrggrip(ctlr) || 788 joycon_type_is_any_joycon(ctlr) || 789 joycon_type_is_procon(ctlr) || 790 joycon_type_is_n64con(ctlr); 791} 792 793static inline bool joycon_using_usb(struct joycon_ctlr *ctlr) 794{ 795 return ctlr->hdev->bus == BUS_USB; 796} 797 798static int __joycon_hid_send(struct hid_device *hdev, u8 *data, size_t len) 799{ 800 u8 *buf; 801 int ret; 802 803 buf = kmemdup(data, len, GFP_KERNEL); 804 if (!buf) 805 return -ENOMEM; 806 ret = hid_hw_output_report(hdev, buf, len); 807 kfree(buf); 808 if (ret < 0) 809 hid_dbg(hdev, "Failed to send output report ret=%d\n", ret); 810 return ret; 811} 812 813static void joycon_wait_for_input_report(struct joycon_ctlr *ctlr) 814{ 815 int ret; 816 817 /* 818 * If we are in the proper reporting mode, wait for an input 819 * report prior to sending the subcommand. This improves 820 * reliability considerably. 821 */ 822 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_READ) { 823 unsigned long flags; 824 825 spin_lock_irqsave(&ctlr->lock, flags); 826 ctlr->received_input_report = false; 827 spin_unlock_irqrestore(&ctlr->lock, flags); 828 ret = wait_event_timeout(ctlr->wait, 829 ctlr->received_input_report, 830 HZ / 4); 831 /* We will still proceed, even with a timeout here */ 832 if (!ret) 833 hid_warn(ctlr->hdev, 834 "timeout waiting for input report\n"); 835 } 836} 837 838/* 839 * Sending subcommands and/or rumble data at too high a rate can cause bluetooth 840 * controller disconnections. 841 */ 842#define JC_INPUT_REPORT_MIN_DELTA 8 843#define JC_INPUT_REPORT_MAX_DELTA 17 844#define JC_SUBCMD_TX_OFFSET_MS 4 845#define JC_SUBCMD_VALID_DELTA_REQ 3 846#define JC_SUBCMD_RATE_MAX_ATTEMPTS 500 847#define JC_SUBCMD_RATE_LIMITER_USB_MS 20 848#define JC_SUBCMD_RATE_LIMITER_BT_MS 60 849#define JC_SUBCMD_RATE_LIMITER_MS(ctlr) ((ctlr)->hdev->bus == BUS_USB ? JC_SUBCMD_RATE_LIMITER_USB_MS : JC_SUBCMD_RATE_LIMITER_BT_MS) 850static void joycon_enforce_subcmd_rate(struct joycon_ctlr *ctlr) 851{ 852 unsigned int current_ms; 853 unsigned long subcmd_delta; 854 int consecutive_valid_deltas = 0; 855 int attempts = 0; 856 unsigned long flags; 857 858 if (unlikely(ctlr->ctlr_state != JOYCON_CTLR_STATE_READ)) 859 return; 860 861 do { 862 joycon_wait_for_input_report(ctlr); 863 current_ms = jiffies_to_msecs(jiffies); 864 subcmd_delta = current_ms - ctlr->last_subcmd_sent_msecs; 865 866 spin_lock_irqsave(&ctlr->lock, flags); 867 consecutive_valid_deltas = ctlr->consecutive_valid_report_deltas; 868 spin_unlock_irqrestore(&ctlr->lock, flags); 869 870 attempts++; 871 } while ((consecutive_valid_deltas < JC_SUBCMD_VALID_DELTA_REQ || 872 subcmd_delta < JC_SUBCMD_RATE_LIMITER_MS(ctlr)) && 873 ctlr->ctlr_state == JOYCON_CTLR_STATE_READ && 874 attempts < JC_SUBCMD_RATE_MAX_ATTEMPTS); 875 876 if (attempts >= JC_SUBCMD_RATE_MAX_ATTEMPTS) { 877 hid_warn(ctlr->hdev, "%s: exceeded max attempts", __func__); 878 return; 879 } 880 881 ctlr->last_subcmd_sent_msecs = current_ms; 882 883 /* 884 * Wait a short time after receiving an input report before 885 * transmitting. This should reduce odds of a TX coinciding with an RX. 886 * Minimizing concurrent BT traffic with the controller seems to lower 887 * the rate of disconnections. 888 */ 889 msleep(JC_SUBCMD_TX_OFFSET_MS); 890} 891 892static int joycon_hid_send_sync(struct joycon_ctlr *ctlr, u8 *data, size_t len, 893 u32 timeout) 894{ 895 int ret; 896 int tries = 2; 897 898 /* 899 * The controller occasionally seems to drop subcommands. In testing, 900 * doing one retry after a timeout appears to always work. 901 */ 902 while (tries--) { 903 joycon_enforce_subcmd_rate(ctlr); 904 905 ret = __joycon_hid_send(ctlr->hdev, data, len); 906 if (ret < 0) { 907 memset(ctlr->input_buf, 0, JC_MAX_RESP_SIZE); 908 return ret; 909 } 910 911 ret = wait_event_timeout(ctlr->wait, ctlr->received_resp, 912 timeout); 913 if (!ret) { 914 hid_dbg(ctlr->hdev, 915 "synchronous send/receive timed out\n"); 916 if (tries) { 917 hid_dbg(ctlr->hdev, 918 "retrying sync send after timeout\n"); 919 } 920 memset(ctlr->input_buf, 0, JC_MAX_RESP_SIZE); 921 ret = -ETIMEDOUT; 922 } else { 923 ret = 0; 924 break; 925 } 926 } 927 928 ctlr->received_resp = false; 929 return ret; 930} 931 932static int joycon_send_usb(struct joycon_ctlr *ctlr, u8 cmd, u32 timeout) 933{ 934 int ret; 935 u8 buf[2] = {JC_OUTPUT_USB_CMD}; 936 937 buf[1] = cmd; 938 ctlr->usb_ack_match = cmd; 939 ctlr->msg_type = JOYCON_MSG_TYPE_USB; 940 ret = joycon_hid_send_sync(ctlr, buf, sizeof(buf), timeout); 941 if (ret) 942 hid_dbg(ctlr->hdev, "send usb command failed; ret=%d\n", ret); 943 return ret; 944} 945 946static int joycon_send_subcmd(struct joycon_ctlr *ctlr, 947 struct joycon_subcmd_request *subcmd, 948 size_t data_len, u32 timeout) 949{ 950 int ret; 951 unsigned long flags; 952 953 spin_lock_irqsave(&ctlr->lock, flags); 954 /* 955 * If the controller has been removed, just return ENODEV so the LED 956 * subsystem doesn't print invalid errors on removal. 957 */ 958 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_REMOVED) { 959 spin_unlock_irqrestore(&ctlr->lock, flags); 960 return -ENODEV; 961 } 962 memcpy(subcmd->rumble_data, ctlr->rumble_data[ctlr->rumble_queue_tail], 963 JC_RUMBLE_DATA_SIZE); 964 spin_unlock_irqrestore(&ctlr->lock, flags); 965 966 subcmd->output_id = JC_OUTPUT_RUMBLE_AND_SUBCMD; 967 subcmd->packet_num = ctlr->subcmd_num; 968 if (++ctlr->subcmd_num > 0xF) 969 ctlr->subcmd_num = 0; 970 ctlr->subcmd_ack_match = subcmd->subcmd_id; 971 ctlr->msg_type = JOYCON_MSG_TYPE_SUBCMD; 972 973 ret = joycon_hid_send_sync(ctlr, (u8 *)subcmd, 974 sizeof(*subcmd) + data_len, timeout); 975 if (ret < 0) 976 hid_dbg(ctlr->hdev, "send subcommand failed; ret=%d\n", ret); 977 else 978 ret = 0; 979 return ret; 980} 981 982/* Supply nibbles for flash and on. Ones correspond to active */ 983static int joycon_set_player_leds(struct joycon_ctlr *ctlr, u8 flash, u8 on) 984{ 985 struct joycon_subcmd_request *req; 986 u8 buffer[sizeof(*req) + 1] = { 0 }; 987 988 req = (struct joycon_subcmd_request *)buffer; 989 req->subcmd_id = JC_SUBCMD_SET_PLAYER_LIGHTS; 990 req->data[0] = (flash << 4) | on; 991 992 hid_dbg(ctlr->hdev, "setting player leds\n"); 993 return joycon_send_subcmd(ctlr, req, 1, HZ/4); 994} 995 996static int joycon_set_home_led(struct joycon_ctlr *ctlr, enum led_brightness brightness) 997{ 998 struct joycon_subcmd_request *req; 999 u8 buffer[sizeof(*req) + 5] = { 0 }; 1000 u8 *data; 1001 1002 req = (struct joycon_subcmd_request *)buffer; 1003 req->subcmd_id = JC_SUBCMD_SET_HOME_LIGHT; 1004 data = req->data; 1005 data[0] = 0x01; 1006 data[1] = brightness << 4; 1007 data[2] = brightness | (brightness << 4); 1008 data[3] = 0x11; 1009 data[4] = 0x11; 1010 1011 hid_dbg(ctlr->hdev, "setting home led brightness\n"); 1012 return joycon_send_subcmd(ctlr, req, 5, HZ/4); 1013} 1014 1015static int joycon_request_spi_flash_read(struct joycon_ctlr *ctlr, 1016 u32 start_addr, u8 size, u8 **reply) 1017{ 1018 struct joycon_subcmd_request *req; 1019 struct joycon_input_report *report; 1020 u8 buffer[sizeof(*req) + 5] = { 0 }; 1021 u8 *data; 1022 int ret; 1023 1024 if (!reply) 1025 return -EINVAL; 1026 1027 req = (struct joycon_subcmd_request *)buffer; 1028 req->subcmd_id = JC_SUBCMD_SPI_FLASH_READ; 1029 data = req->data; 1030 put_unaligned_le32(start_addr, data); 1031 data[4] = size; 1032 1033 hid_dbg(ctlr->hdev, "requesting SPI flash data\n"); 1034 ret = joycon_send_subcmd(ctlr, req, 5, HZ); 1035 if (ret) { 1036 hid_err(ctlr->hdev, "failed reading SPI flash; ret=%d\n", ret); 1037 } else { 1038 report = (struct joycon_input_report *)ctlr->input_buf; 1039 /* The read data starts at the 6th byte */ 1040 *reply = &report->subcmd_reply.data[5]; 1041 } 1042 return ret; 1043} 1044 1045/* 1046 * User calibration's presence is denoted with a magic byte preceding it. 1047 * returns 0 if magic val is present, 1 if not present, < 0 on error 1048 */ 1049static int joycon_check_for_cal_magic(struct joycon_ctlr *ctlr, u32 flash_addr) 1050{ 1051 int ret; 1052 u8 *reply; 1053 1054 ret = joycon_request_spi_flash_read(ctlr, flash_addr, 1055 JC_CAL_USR_MAGIC_SIZE, &reply); 1056 if (ret) 1057 return ret; 1058 1059 return reply[0] != JC_CAL_USR_MAGIC_0 || reply[1] != JC_CAL_USR_MAGIC_1; 1060} 1061 1062static int joycon_read_stick_calibration(struct joycon_ctlr *ctlr, u16 cal_addr, 1063 struct joycon_stick_cal *cal_x, 1064 struct joycon_stick_cal *cal_y, 1065 bool left_stick) 1066{ 1067 s32 x_max_above; 1068 s32 x_min_below; 1069 s32 y_max_above; 1070 s32 y_min_below; 1071 u8 *raw_cal; 1072 int ret; 1073 1074 ret = joycon_request_spi_flash_read(ctlr, cal_addr, 1075 JC_CAL_STICK_DATA_SIZE, &raw_cal); 1076 if (ret) 1077 return ret; 1078 1079 /* stick calibration parsing: note the order differs based on stick */ 1080 if (left_stick) { 1081 x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0, 1082 12); 1083 y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4, 1084 12); 1085 cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0, 1086 12); 1087 cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4, 1088 12); 1089 x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0, 1090 12); 1091 y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4, 1092 12); 1093 } else { 1094 cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0, 1095 12); 1096 cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4, 1097 12); 1098 x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0, 1099 12); 1100 y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4, 1101 12); 1102 x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0, 1103 12); 1104 y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4, 1105 12); 1106 } 1107 1108 cal_x->max = cal_x->center + x_max_above; 1109 cal_x->min = cal_x->center - x_min_below; 1110 cal_y->max = cal_y->center + y_max_above; 1111 cal_y->min = cal_y->center - y_min_below; 1112 1113 /* check if calibration values are plausible */ 1114 if (cal_x->min >= cal_x->center || cal_x->center >= cal_x->max || 1115 cal_y->min >= cal_y->center || cal_y->center >= cal_y->max) 1116 ret = -EINVAL; 1117 1118 return ret; 1119} 1120 1121static const u16 DFLT_STICK_CAL_CEN = 2000; 1122static const u16 DFLT_STICK_CAL_MAX = 3500; 1123static const u16 DFLT_STICK_CAL_MIN = 500; 1124static void joycon_use_default_calibration(struct hid_device *hdev, 1125 struct joycon_stick_cal *cal_x, 1126 struct joycon_stick_cal *cal_y, 1127 const char *stick, int ret) 1128{ 1129 hid_warn(hdev, 1130 "Failed to read %s stick cal, using defaults; e=%d\n", 1131 stick, ret); 1132 1133 cal_x->center = cal_y->center = DFLT_STICK_CAL_CEN; 1134 cal_x->max = cal_y->max = DFLT_STICK_CAL_MAX; 1135 cal_x->min = cal_y->min = DFLT_STICK_CAL_MIN; 1136} 1137 1138static int joycon_request_calibration(struct joycon_ctlr *ctlr) 1139{ 1140 u16 left_stick_addr = JC_CAL_FCT_DATA_LEFT_ADDR; 1141 u16 right_stick_addr = JC_CAL_FCT_DATA_RIGHT_ADDR; 1142 int ret; 1143 1144 hid_dbg(ctlr->hdev, "requesting cal data\n"); 1145 1146 /* check if user stick calibrations are present */ 1147 if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_LEFT_MAGIC_ADDR)) { 1148 left_stick_addr = JC_CAL_USR_LEFT_DATA_ADDR; 1149 hid_info(ctlr->hdev, "using user cal for left stick\n"); 1150 } else { 1151 hid_info(ctlr->hdev, "using factory cal for left stick\n"); 1152 } 1153 if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_RIGHT_MAGIC_ADDR)) { 1154 right_stick_addr = JC_CAL_USR_RIGHT_DATA_ADDR; 1155 hid_info(ctlr->hdev, "using user cal for right stick\n"); 1156 } else { 1157 hid_info(ctlr->hdev, "using factory cal for right stick\n"); 1158 } 1159 1160 /* read the left stick calibration data */ 1161 ret = joycon_read_stick_calibration(ctlr, left_stick_addr, 1162 &ctlr->left_stick_cal_x, 1163 &ctlr->left_stick_cal_y, 1164 true); 1165 1166 if (ret) 1167 joycon_use_default_calibration(ctlr->hdev, 1168 &ctlr->left_stick_cal_x, 1169 &ctlr->left_stick_cal_y, 1170 "left", ret); 1171 1172 /* read the right stick calibration data */ 1173 ret = joycon_read_stick_calibration(ctlr, right_stick_addr, 1174 &ctlr->right_stick_cal_x, 1175 &ctlr->right_stick_cal_y, 1176 false); 1177 1178 if (ret) 1179 joycon_use_default_calibration(ctlr->hdev, 1180 &ctlr->right_stick_cal_x, 1181 &ctlr->right_stick_cal_y, 1182 "right", ret); 1183 1184 hid_dbg(ctlr->hdev, "calibration:\n" 1185 "l_x_c=%d l_x_max=%d l_x_min=%d\n" 1186 "l_y_c=%d l_y_max=%d l_y_min=%d\n" 1187 "r_x_c=%d r_x_max=%d r_x_min=%d\n" 1188 "r_y_c=%d r_y_max=%d r_y_min=%d\n", 1189 ctlr->left_stick_cal_x.center, 1190 ctlr->left_stick_cal_x.max, 1191 ctlr->left_stick_cal_x.min, 1192 ctlr->left_stick_cal_y.center, 1193 ctlr->left_stick_cal_y.max, 1194 ctlr->left_stick_cal_y.min, 1195 ctlr->right_stick_cal_x.center, 1196 ctlr->right_stick_cal_x.max, 1197 ctlr->right_stick_cal_x.min, 1198 ctlr->right_stick_cal_y.center, 1199 ctlr->right_stick_cal_y.max, 1200 ctlr->right_stick_cal_y.min); 1201 1202 return 0; 1203} 1204 1205/* 1206 * These divisors are calculated once rather than for each sample. They are only 1207 * dependent on the IMU calibration values. They are used when processing the 1208 * IMU input reports. 1209 */ 1210static void joycon_calc_imu_cal_divisors(struct joycon_ctlr *ctlr) 1211{ 1212 int i, divz = 0; 1213 1214 for (i = 0; i < 3; i++) { 1215 ctlr->imu_cal_accel_divisor[i] = ctlr->accel_cal.scale[i] - 1216 ctlr->accel_cal.offset[i]; 1217 ctlr->imu_cal_gyro_divisor[i] = ctlr->gyro_cal.scale[i] - 1218 ctlr->gyro_cal.offset[i]; 1219 1220 if (ctlr->imu_cal_accel_divisor[i] == 0) { 1221 ctlr->imu_cal_accel_divisor[i] = 1; 1222 divz++; 1223 } 1224 1225 if (ctlr->imu_cal_gyro_divisor[i] == 0) { 1226 ctlr->imu_cal_gyro_divisor[i] = 1; 1227 divz++; 1228 } 1229 } 1230 1231 if (divz) 1232 hid_warn(ctlr->hdev, "inaccurate IMU divisors (%d)\n", divz); 1233} 1234 1235static const s16 DFLT_ACCEL_OFFSET /*= 0*/; 1236static const s16 DFLT_ACCEL_SCALE = 16384; 1237static const s16 DFLT_GYRO_OFFSET /*= 0*/; 1238static const s16 DFLT_GYRO_SCALE = 13371; 1239static int joycon_request_imu_calibration(struct joycon_ctlr *ctlr) 1240{ 1241 u16 imu_cal_addr = JC_IMU_CAL_FCT_DATA_ADDR; 1242 u8 *raw_cal; 1243 int ret; 1244 int i; 1245 1246 /* check if user calibration exists */ 1247 if (!joycon_check_for_cal_magic(ctlr, JC_IMU_CAL_USR_MAGIC_ADDR)) { 1248 imu_cal_addr = JC_IMU_CAL_USR_DATA_ADDR; 1249 hid_info(ctlr->hdev, "using user cal for IMU\n"); 1250 } else { 1251 hid_info(ctlr->hdev, "using factory cal for IMU\n"); 1252 } 1253 1254 /* request IMU calibration data */ 1255 hid_dbg(ctlr->hdev, "requesting IMU cal data\n"); 1256 ret = joycon_request_spi_flash_read(ctlr, imu_cal_addr, 1257 JC_IMU_CAL_DATA_SIZE, &raw_cal); 1258 if (ret) { 1259 hid_warn(ctlr->hdev, 1260 "Failed to read IMU cal, using defaults; ret=%d\n", 1261 ret); 1262 1263 for (i = 0; i < 3; i++) { 1264 ctlr->accel_cal.offset[i] = DFLT_ACCEL_OFFSET; 1265 ctlr->accel_cal.scale[i] = DFLT_ACCEL_SCALE; 1266 ctlr->gyro_cal.offset[i] = DFLT_GYRO_OFFSET; 1267 ctlr->gyro_cal.scale[i] = DFLT_GYRO_SCALE; 1268 } 1269 joycon_calc_imu_cal_divisors(ctlr); 1270 return ret; 1271 } 1272 1273 /* IMU calibration parsing */ 1274 for (i = 0; i < 3; i++) { 1275 int j = i * 2; 1276 1277 ctlr->accel_cal.offset[i] = get_unaligned_le16(raw_cal + j); 1278 ctlr->accel_cal.scale[i] = get_unaligned_le16(raw_cal + j + 6); 1279 ctlr->gyro_cal.offset[i] = get_unaligned_le16(raw_cal + j + 12); 1280 ctlr->gyro_cal.scale[i] = get_unaligned_le16(raw_cal + j + 18); 1281 } 1282 1283 joycon_calc_imu_cal_divisors(ctlr); 1284 1285 hid_dbg(ctlr->hdev, "IMU calibration:\n" 1286 "a_o[0]=%d a_o[1]=%d a_o[2]=%d\n" 1287 "a_s[0]=%d a_s[1]=%d a_s[2]=%d\n" 1288 "g_o[0]=%d g_o[1]=%d g_o[2]=%d\n" 1289 "g_s[0]=%d g_s[1]=%d g_s[2]=%d\n", 1290 ctlr->accel_cal.offset[0], 1291 ctlr->accel_cal.offset[1], 1292 ctlr->accel_cal.offset[2], 1293 ctlr->accel_cal.scale[0], 1294 ctlr->accel_cal.scale[1], 1295 ctlr->accel_cal.scale[2], 1296 ctlr->gyro_cal.offset[0], 1297 ctlr->gyro_cal.offset[1], 1298 ctlr->gyro_cal.offset[2], 1299 ctlr->gyro_cal.scale[0], 1300 ctlr->gyro_cal.scale[1], 1301 ctlr->gyro_cal.scale[2]); 1302 1303 return 0; 1304} 1305 1306static int joycon_set_report_mode(struct joycon_ctlr *ctlr) 1307{ 1308 struct joycon_subcmd_request *req; 1309 u8 buffer[sizeof(*req) + 1] = { 0 }; 1310 1311 req = (struct joycon_subcmd_request *)buffer; 1312 req->subcmd_id = JC_SUBCMD_SET_REPORT_MODE; 1313 req->data[0] = 0x30; /* standard, full report mode */ 1314 1315 hid_dbg(ctlr->hdev, "setting controller report mode\n"); 1316 return joycon_send_subcmd(ctlr, req, 1, HZ); 1317} 1318 1319static int joycon_enable_rumble(struct joycon_ctlr *ctlr) 1320{ 1321 struct joycon_subcmd_request *req; 1322 u8 buffer[sizeof(*req) + 1] = { 0 }; 1323 1324 req = (struct joycon_subcmd_request *)buffer; 1325 req->subcmd_id = JC_SUBCMD_ENABLE_VIBRATION; 1326 req->data[0] = 0x01; /* note: 0x00 would disable */ 1327 1328 hid_dbg(ctlr->hdev, "enabling rumble\n"); 1329 return joycon_send_subcmd(ctlr, req, 1, HZ/4); 1330} 1331 1332static int joycon_enable_imu(struct joycon_ctlr *ctlr) 1333{ 1334 struct joycon_subcmd_request *req; 1335 u8 buffer[sizeof(*req) + 1] = { 0 }; 1336 1337 req = (struct joycon_subcmd_request *)buffer; 1338 req->subcmd_id = JC_SUBCMD_ENABLE_IMU; 1339 req->data[0] = 0x01; /* note: 0x00 would disable */ 1340 1341 hid_dbg(ctlr->hdev, "enabling IMU\n"); 1342 return joycon_send_subcmd(ctlr, req, 1, HZ); 1343} 1344 1345static s32 joycon_map_stick_val(struct joycon_stick_cal *cal, s32 val) 1346{ 1347 s32 center = cal->center; 1348 s32 min = cal->min; 1349 s32 max = cal->max; 1350 s32 new_val; 1351 1352 if (val > center) { 1353 new_val = (val - center) * JC_MAX_STICK_MAG; 1354 new_val /= (max - center); 1355 } else { 1356 new_val = (center - val) * -JC_MAX_STICK_MAG; 1357 new_val /= (center - min); 1358 } 1359 new_val = clamp(new_val, (s32)-JC_MAX_STICK_MAG, (s32)JC_MAX_STICK_MAG); 1360 return new_val; 1361} 1362 1363static void joycon_input_report_parse_imu_data(struct joycon_ctlr *ctlr, 1364 struct joycon_input_report *rep, 1365 struct joycon_imu_data *imu_data) 1366{ 1367 u8 *raw = rep->imu_raw_bytes; 1368 int i; 1369 1370 for (i = 0; i < 3; i++) { 1371 struct joycon_imu_data *data = &imu_data[i]; 1372 1373 data->accel_x = get_unaligned_le16(raw + 0); 1374 data->accel_y = get_unaligned_le16(raw + 2); 1375 data->accel_z = get_unaligned_le16(raw + 4); 1376 data->gyro_x = get_unaligned_le16(raw + 6); 1377 data->gyro_y = get_unaligned_le16(raw + 8); 1378 data->gyro_z = get_unaligned_le16(raw + 10); 1379 /* point to next imu sample */ 1380 raw += sizeof(struct joycon_imu_data); 1381 } 1382} 1383 1384static void joycon_parse_imu_report(struct joycon_ctlr *ctlr, 1385 struct joycon_input_report *rep) 1386{ 1387 struct joycon_imu_data imu_data[3] = {0}; /* 3 reports per packet */ 1388 struct input_dev *idev = ctlr->imu_input; 1389 unsigned int msecs = jiffies_to_msecs(jiffies); 1390 unsigned int last_msecs = ctlr->imu_last_pkt_ms; 1391 int i; 1392 int value[6]; 1393 1394 joycon_input_report_parse_imu_data(ctlr, rep, imu_data); 1395 1396 /* 1397 * There are complexities surrounding how we determine the timestamps we 1398 * associate with the samples we pass to userspace. The IMU input 1399 * reports do not provide us with a good timestamp. There's a quickly 1400 * incrementing 8-bit counter per input report, but it is not very 1401 * useful for this purpose (it is not entirely clear what rate it 1402 * increments at or if it varies based on packet push rate - more on 1403 * the push rate below...). 1404 * 1405 * The reverse engineering work done on the joy-cons and pro controllers 1406 * by the community seems to indicate the following: 1407 * - The controller samples the IMU every 1.35ms. It then does some of 1408 * its own processing, probably averaging the samples out. 1409 * - Each imu input report contains 3 IMU samples, (usually 5ms apart). 1410 * - In the standard reporting mode (which this driver uses exclusively) 1411 * input reports are pushed from the controller as follows: 1412 * * joy-con (bluetooth): every 15 ms 1413 * * joy-cons (in charging grip via USB): every 15 ms 1414 * * pro controller (USB): every 15 ms 1415 * * pro controller (bluetooth): every 8 ms (this is the wildcard) 1416 * 1417 * Further complicating matters is that some bluetooth stacks are known 1418 * to alter the controller's packet rate by hardcoding the bluetooth 1419 * SSR for the switch controllers (android's stack currently sets the 1420 * SSR to 11ms for both the joy-cons and pro controllers). 1421 * 1422 * In my own testing, I've discovered that my pro controller either 1423 * reports IMU sample batches every 11ms or every 15ms. This rate is 1424 * stable after connecting. It isn't 100% clear what determines this 1425 * rate. Importantly, even when sending every 11ms, none of the samples 1426 * are duplicates. This seems to indicate that the time deltas between 1427 * reported samples can vary based on the input report rate. 1428 * 1429 * The solution employed in this driver is to keep track of the average 1430 * time delta between IMU input reports. In testing, this value has 1431 * proven to be stable, staying at 15ms or 11ms, though other hardware 1432 * configurations and bluetooth stacks could potentially see other rates 1433 * (hopefully this will become more clear as more people use the 1434 * driver). 1435 * 1436 * Keeping track of the average report delta allows us to submit our 1437 * timestamps to userspace based on that. Each report contains 3 1438 * samples, so the IMU sampling rate should be avg_time_delta/3. We can 1439 * also use this average to detect events where we have dropped a 1440 * packet. The userspace timestamp for the samples will be adjusted 1441 * accordingly to prevent unwanted behvaior. 1442 */ 1443 if (!ctlr->imu_first_packet_received) { 1444 ctlr->imu_timestamp_us = 0; 1445 ctlr->imu_delta_samples_count = 0; 1446 ctlr->imu_delta_samples_sum = 0; 1447 ctlr->imu_avg_delta_ms = JC_IMU_DFLT_AVG_DELTA_MS; 1448 ctlr->imu_first_packet_received = true; 1449 } else { 1450 unsigned int delta = msecs - last_msecs; 1451 unsigned int dropped_pkts; 1452 unsigned int dropped_threshold; 1453 1454 /* avg imu report delta housekeeping */ 1455 ctlr->imu_delta_samples_sum += delta; 1456 ctlr->imu_delta_samples_count++; 1457 if (ctlr->imu_delta_samples_count >= 1458 JC_IMU_SAMPLES_PER_DELTA_AVG) { 1459 ctlr->imu_avg_delta_ms = ctlr->imu_delta_samples_sum / 1460 ctlr->imu_delta_samples_count; 1461 ctlr->imu_delta_samples_count = 0; 1462 ctlr->imu_delta_samples_sum = 0; 1463 } 1464 1465 /* don't ever want divide by zero shenanigans */ 1466 if (ctlr->imu_avg_delta_ms == 0) { 1467 ctlr->imu_avg_delta_ms = 1; 1468 hid_warn(ctlr->hdev, "calculated avg imu delta of 0\n"); 1469 } 1470 1471 /* useful for debugging IMU sample rate */ 1472 hid_dbg(ctlr->hdev, 1473 "imu_report: ms=%u last_ms=%u delta=%u avg_delta=%u\n", 1474 msecs, last_msecs, delta, ctlr->imu_avg_delta_ms); 1475 1476 /* check if any packets have been dropped */ 1477 dropped_threshold = ctlr->imu_avg_delta_ms * 3 / 2; 1478 dropped_pkts = (delta - min(delta, dropped_threshold)) / 1479 ctlr->imu_avg_delta_ms; 1480 ctlr->imu_timestamp_us += 1000 * ctlr->imu_avg_delta_ms; 1481 if (dropped_pkts > JC_IMU_DROPPED_PKT_WARNING) { 1482 hid_warn(ctlr->hdev, 1483 "compensating for %u dropped IMU reports\n", 1484 dropped_pkts); 1485 hid_warn(ctlr->hdev, 1486 "delta=%u avg_delta=%u\n", 1487 delta, ctlr->imu_avg_delta_ms); 1488 } 1489 } 1490 ctlr->imu_last_pkt_ms = msecs; 1491 1492 /* Each IMU input report contains three samples */ 1493 for (i = 0; i < 3; i++) { 1494 input_event(idev, EV_MSC, MSC_TIMESTAMP, 1495 ctlr->imu_timestamp_us); 1496 1497 /* 1498 * These calculations (which use the controller's calibration 1499 * settings to improve the final values) are based on those 1500 * found in the community's reverse-engineering repo (linked at 1501 * top of driver). For hid-nintendo, we make sure that the final 1502 * value given to userspace is always in terms of the axis 1503 * resolution we provided. 1504 * 1505 * Currently only the gyro calculations subtract the calibration 1506 * offsets from the raw value itself. In testing, doing the same 1507 * for the accelerometer raw values decreased accuracy. 1508 * 1509 * Note that the gyro values are multiplied by the 1510 * precision-saving scaling factor to prevent large inaccuracies 1511 * due to truncation of the resolution value which would 1512 * otherwise occur. To prevent overflow (without resorting to 64 1513 * bit integer math), the mult_frac macro is used. 1514 */ 1515 value[0] = mult_frac((JC_IMU_PREC_RANGE_SCALE * 1516 (imu_data[i].gyro_x - 1517 ctlr->gyro_cal.offset[0])), 1518 ctlr->gyro_cal.scale[0], 1519 ctlr->imu_cal_gyro_divisor[0]); 1520 value[1] = mult_frac((JC_IMU_PREC_RANGE_SCALE * 1521 (imu_data[i].gyro_y - 1522 ctlr->gyro_cal.offset[1])), 1523 ctlr->gyro_cal.scale[1], 1524 ctlr->imu_cal_gyro_divisor[1]); 1525 value[2] = mult_frac((JC_IMU_PREC_RANGE_SCALE * 1526 (imu_data[i].gyro_z - 1527 ctlr->gyro_cal.offset[2])), 1528 ctlr->gyro_cal.scale[2], 1529 ctlr->imu_cal_gyro_divisor[2]); 1530 1531 value[3] = ((s32)imu_data[i].accel_x * 1532 ctlr->accel_cal.scale[0]) / 1533 ctlr->imu_cal_accel_divisor[0]; 1534 value[4] = ((s32)imu_data[i].accel_y * 1535 ctlr->accel_cal.scale[1]) / 1536 ctlr->imu_cal_accel_divisor[1]; 1537 value[5] = ((s32)imu_data[i].accel_z * 1538 ctlr->accel_cal.scale[2]) / 1539 ctlr->imu_cal_accel_divisor[2]; 1540 1541 hid_dbg(ctlr->hdev, "raw_gyro: g_x=%d g_y=%d g_z=%d\n", 1542 imu_data[i].gyro_x, imu_data[i].gyro_y, 1543 imu_data[i].gyro_z); 1544 hid_dbg(ctlr->hdev, "raw_accel: a_x=%d a_y=%d a_z=%d\n", 1545 imu_data[i].accel_x, imu_data[i].accel_y, 1546 imu_data[i].accel_z); 1547 1548 /* 1549 * The right joy-con has 2 axes negated, Y and Z. This is due to 1550 * the orientation of the IMU in the controller. We negate those 1551 * axes' values in order to be consistent with the left joy-con 1552 * and the pro controller: 1553 * X: positive is pointing toward the triggers 1554 * Y: positive is pointing to the left 1555 * Z: positive is pointing up (out of the buttons/sticks) 1556 * The axes follow the right-hand rule. 1557 */ 1558 if (jc_type_is_joycon(ctlr) && jc_type_has_right(ctlr)) { 1559 int j; 1560 1561 /* negate all but x axis */ 1562 for (j = 1; j < 6; ++j) { 1563 if (j == 3) 1564 continue; 1565 value[j] *= -1; 1566 } 1567 } 1568 1569 input_report_abs(idev, ABS_RX, value[0]); 1570 input_report_abs(idev, ABS_RY, value[1]); 1571 input_report_abs(idev, ABS_RZ, value[2]); 1572 input_report_abs(idev, ABS_X, value[3]); 1573 input_report_abs(idev, ABS_Y, value[4]); 1574 input_report_abs(idev, ABS_Z, value[5]); 1575 input_sync(idev); 1576 /* convert to micros and divide by 3 (3 samples per report). */ 1577 ctlr->imu_timestamp_us += ctlr->imu_avg_delta_ms * 1000 / 3; 1578 } 1579} 1580 1581static void joycon_handle_rumble_report(struct joycon_ctlr *ctlr, struct joycon_input_report *rep) 1582{ 1583 unsigned long flags; 1584 unsigned long msecs = jiffies_to_msecs(jiffies); 1585 1586 spin_lock_irqsave(&ctlr->lock, flags); 1587 if (IS_ENABLED(CONFIG_NINTENDO_FF) && rep->vibrator_report && 1588 ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED && 1589 (msecs - ctlr->rumble_msecs) >= JC_RUMBLE_PERIOD_MS && 1590 (ctlr->rumble_queue_head != ctlr->rumble_queue_tail || 1591 ctlr->rumble_zero_countdown > 0)) { 1592 /* 1593 * When this value reaches 0, we know we've sent multiple 1594 * packets to the controller instructing it to disable rumble. 1595 * We can safely stop sending periodic rumble packets until the 1596 * next ff effect. 1597 */ 1598 if (ctlr->rumble_zero_countdown > 0) 1599 ctlr->rumble_zero_countdown--; 1600 queue_work(ctlr->rumble_queue, &ctlr->rumble_worker); 1601 } 1602 1603 spin_unlock_irqrestore(&ctlr->lock, flags); 1604} 1605 1606static void joycon_parse_battery_status(struct joycon_ctlr *ctlr, struct joycon_input_report *rep) 1607{ 1608 u8 tmp; 1609 unsigned long flags; 1610 1611 spin_lock_irqsave(&ctlr->lock, flags); 1612 1613 tmp = rep->bat_con; 1614 ctlr->host_powered = tmp & BIT(0); 1615 ctlr->battery_charging = tmp & BIT(4); 1616 tmp = tmp >> 5; 1617 1618 switch (tmp) { 1619 case 0: /* empty */ 1620 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL; 1621 break; 1622 case 1: /* low */ 1623 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_LOW; 1624 break; 1625 case 2: /* medium */ 1626 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL; 1627 break; 1628 case 3: /* high */ 1629 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_HIGH; 1630 break; 1631 case 4: /* full */ 1632 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_FULL; 1633 break; 1634 default: 1635 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN; 1636 hid_warn(ctlr->hdev, "Invalid battery status\n"); 1637 break; 1638 } 1639 1640 spin_unlock_irqrestore(&ctlr->lock, flags); 1641} 1642 1643static void joycon_report_left_stick(struct joycon_ctlr *ctlr, 1644 struct joycon_input_report *rep) 1645{ 1646 u16 raw_x; 1647 u16 raw_y; 1648 s32 x; 1649 s32 y; 1650 1651 raw_x = hid_field_extract(ctlr->hdev, rep->left_stick, 0, 12); 1652 raw_y = hid_field_extract(ctlr->hdev, rep->left_stick + 1, 4, 12); 1653 1654 x = joycon_map_stick_val(&ctlr->left_stick_cal_x, raw_x); 1655 y = -joycon_map_stick_val(&ctlr->left_stick_cal_y, raw_y); 1656 1657 input_report_abs(ctlr->input, ABS_X, x); 1658 input_report_abs(ctlr->input, ABS_Y, y); 1659} 1660 1661static void joycon_report_right_stick(struct joycon_ctlr *ctlr, 1662 struct joycon_input_report *rep) 1663{ 1664 u16 raw_x; 1665 u16 raw_y; 1666 s32 x; 1667 s32 y; 1668 1669 raw_x = hid_field_extract(ctlr->hdev, rep->right_stick, 0, 12); 1670 raw_y = hid_field_extract(ctlr->hdev, rep->right_stick + 1, 4, 12); 1671 1672 x = joycon_map_stick_val(&ctlr->right_stick_cal_x, raw_x); 1673 y = -joycon_map_stick_val(&ctlr->right_stick_cal_y, raw_y); 1674 1675 input_report_abs(ctlr->input, ABS_RX, x); 1676 input_report_abs(ctlr->input, ABS_RY, y); 1677} 1678 1679static void joycon_report_dpad(struct joycon_ctlr *ctlr, 1680 struct joycon_input_report *rep) 1681{ 1682 int hatx = 0; 1683 int haty = 0; 1684 u32 btns = hid_field_extract(ctlr->hdev, rep->button_status, 0, 24); 1685 1686 if (btns & JC_BTN_LEFT) 1687 hatx = -1; 1688 else if (btns & JC_BTN_RIGHT) 1689 hatx = 1; 1690 1691 if (btns & JC_BTN_UP) 1692 haty = -1; 1693 else if (btns & JC_BTN_DOWN) 1694 haty = 1; 1695 1696 input_report_abs(ctlr->input, ABS_HAT0X, hatx); 1697 input_report_abs(ctlr->input, ABS_HAT0Y, haty); 1698} 1699 1700static void joycon_report_buttons(struct joycon_ctlr *ctlr, 1701 struct joycon_input_report *rep, 1702 const struct joycon_ctlr_button_mapping button_mappings[]) 1703{ 1704 const struct joycon_ctlr_button_mapping *button; 1705 u32 status = hid_field_extract(ctlr->hdev, rep->button_status, 0, 24); 1706 1707 for (button = button_mappings; button->code; button++) 1708 input_report_key(ctlr->input, button->code, status & button->bit); 1709} 1710 1711static void joycon_parse_report(struct joycon_ctlr *ctlr, 1712 struct joycon_input_report *rep) 1713{ 1714 unsigned long flags; 1715 unsigned long msecs = jiffies_to_msecs(jiffies); 1716 unsigned long report_delta_ms = msecs - ctlr->last_input_report_msecs; 1717 1718 if (joycon_has_rumble(ctlr)) 1719 joycon_handle_rumble_report(ctlr, rep); 1720 1721 joycon_parse_battery_status(ctlr, rep); 1722 1723 if (joycon_type_is_left_joycon(ctlr)) { 1724 joycon_report_left_stick(ctlr, rep); 1725 joycon_report_buttons(ctlr, rep, left_joycon_button_mappings); 1726 if (!joycon_device_is_chrggrip(ctlr)) 1727 joycon_report_buttons(ctlr, rep, left_joycon_s_button_mappings); 1728 } else if (joycon_type_is_right_joycon(ctlr)) { 1729 joycon_report_right_stick(ctlr, rep); 1730 joycon_report_buttons(ctlr, rep, right_joycon_button_mappings); 1731 if (!joycon_device_is_chrggrip(ctlr)) 1732 joycon_report_buttons(ctlr, rep, right_joycon_s_button_mappings); 1733 } else if (joycon_type_is_procon(ctlr)) { 1734 joycon_report_left_stick(ctlr, rep); 1735 joycon_report_right_stick(ctlr, rep); 1736 joycon_report_dpad(ctlr, rep); 1737 joycon_report_buttons(ctlr, rep, procon_button_mappings); 1738 } else if (joycon_type_is_any_nescon(ctlr)) { 1739 joycon_report_dpad(ctlr, rep); 1740 joycon_report_buttons(ctlr, rep, nescon_button_mappings); 1741 } else if (joycon_type_is_snescon(ctlr)) { 1742 joycon_report_dpad(ctlr, rep); 1743 joycon_report_buttons(ctlr, rep, snescon_button_mappings); 1744 } else if (joycon_type_is_gencon(ctlr)) { 1745 joycon_report_dpad(ctlr, rep); 1746 joycon_report_buttons(ctlr, rep, gencon_button_mappings); 1747 } else if (joycon_type_is_n64con(ctlr)) { 1748 joycon_report_left_stick(ctlr, rep); 1749 joycon_report_dpad(ctlr, rep); 1750 joycon_report_buttons(ctlr, rep, n64con_button_mappings); 1751 } 1752 1753 input_sync(ctlr->input); 1754 1755 spin_lock_irqsave(&ctlr->lock, flags); 1756 ctlr->last_input_report_msecs = msecs; 1757 /* 1758 * Was this input report a reasonable time delta compared to the prior 1759 * report? We use this information to decide when a safe time is to send 1760 * rumble packets or subcommand packets. 1761 */ 1762 if (report_delta_ms >= JC_INPUT_REPORT_MIN_DELTA && 1763 report_delta_ms <= JC_INPUT_REPORT_MAX_DELTA) { 1764 if (ctlr->consecutive_valid_report_deltas < JC_SUBCMD_VALID_DELTA_REQ) 1765 ctlr->consecutive_valid_report_deltas++; 1766 } else { 1767 ctlr->consecutive_valid_report_deltas = 0; 1768 } 1769 /* 1770 * Our consecutive valid report tracking is only relevant for 1771 * bluetooth-connected controllers. For USB devices, we're beholden to 1772 * USB's underlying polling rate anyway. Always set to the consecutive 1773 * delta requirement. 1774 */ 1775 if (ctlr->hdev->bus == BUS_USB) 1776 ctlr->consecutive_valid_report_deltas = JC_SUBCMD_VALID_DELTA_REQ; 1777 1778 spin_unlock_irqrestore(&ctlr->lock, flags); 1779 1780 /* 1781 * Immediately after receiving a report is the most reliable time to 1782 * send a subcommand to the controller. Wake any subcommand senders 1783 * waiting for a report. 1784 */ 1785 if (unlikely(mutex_is_locked(&ctlr->output_mutex))) { 1786 spin_lock_irqsave(&ctlr->lock, flags); 1787 ctlr->received_input_report = true; 1788 spin_unlock_irqrestore(&ctlr->lock, flags); 1789 wake_up(&ctlr->wait); 1790 } 1791 1792 /* parse IMU data if present */ 1793 if ((rep->id == JC_INPUT_IMU_DATA) && joycon_has_imu(ctlr)) 1794 joycon_parse_imu_report(ctlr, rep); 1795} 1796 1797static int joycon_send_rumble_data(struct joycon_ctlr *ctlr) 1798{ 1799 int ret; 1800 unsigned long flags; 1801 struct joycon_rumble_output rumble_output = { 0 }; 1802 1803 spin_lock_irqsave(&ctlr->lock, flags); 1804 /* 1805 * If the controller has been removed, just return ENODEV so the LED 1806 * subsystem doesn't print invalid errors on removal. 1807 */ 1808 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_REMOVED) { 1809 spin_unlock_irqrestore(&ctlr->lock, flags); 1810 return -ENODEV; 1811 } 1812 memcpy(rumble_output.rumble_data, 1813 ctlr->rumble_data[ctlr->rumble_queue_tail], 1814 JC_RUMBLE_DATA_SIZE); 1815 spin_unlock_irqrestore(&ctlr->lock, flags); 1816 1817 rumble_output.output_id = JC_OUTPUT_RUMBLE_ONLY; 1818 rumble_output.packet_num = ctlr->subcmd_num; 1819 if (++ctlr->subcmd_num > 0xF) 1820 ctlr->subcmd_num = 0; 1821 1822 joycon_enforce_subcmd_rate(ctlr); 1823 1824 ret = __joycon_hid_send(ctlr->hdev, (u8 *)&rumble_output, 1825 sizeof(rumble_output)); 1826 return ret; 1827} 1828 1829static void joycon_rumble_worker(struct work_struct *work) 1830{ 1831 struct joycon_ctlr *ctlr = container_of(work, struct joycon_ctlr, 1832 rumble_worker); 1833 unsigned long flags; 1834 bool again = true; 1835 int ret; 1836 1837 while (again) { 1838 mutex_lock(&ctlr->output_mutex); 1839 ret = joycon_send_rumble_data(ctlr); 1840 mutex_unlock(&ctlr->output_mutex); 1841 1842 /* -ENODEV means the controller was just unplugged */ 1843 spin_lock_irqsave(&ctlr->lock, flags); 1844 if (ret < 0 && ret != -ENODEV && 1845 ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED) 1846 hid_warn(ctlr->hdev, "Failed to set rumble; e=%d", ret); 1847 1848 ctlr->rumble_msecs = jiffies_to_msecs(jiffies); 1849 if (ctlr->rumble_queue_tail != ctlr->rumble_queue_head) { 1850 if (++ctlr->rumble_queue_tail >= JC_RUMBLE_QUEUE_SIZE) 1851 ctlr->rumble_queue_tail = 0; 1852 } else { 1853 again = false; 1854 } 1855 spin_unlock_irqrestore(&ctlr->lock, flags); 1856 } 1857} 1858 1859#if IS_ENABLED(CONFIG_NINTENDO_FF) 1860static struct joycon_rumble_freq_data joycon_find_rumble_freq(u16 freq) 1861{ 1862 const size_t length = ARRAY_SIZE(joycon_rumble_frequencies); 1863 const struct joycon_rumble_freq_data *data = joycon_rumble_frequencies; 1864 int i = 0; 1865 1866 if (freq > data[0].freq) { 1867 for (i = 1; i < length - 1; i++) { 1868 if (freq > data[i - 1].freq && freq <= data[i].freq) 1869 break; 1870 } 1871 } 1872 1873 return data[i]; 1874} 1875 1876static struct joycon_rumble_amp_data joycon_find_rumble_amp(u16 amp) 1877{ 1878 const size_t length = ARRAY_SIZE(joycon_rumble_amplitudes); 1879 const struct joycon_rumble_amp_data *data = joycon_rumble_amplitudes; 1880 int i = 0; 1881 1882 if (amp > data[0].amp) { 1883 for (i = 1; i < length - 1; i++) { 1884 if (amp > data[i - 1].amp && amp <= data[i].amp) 1885 break; 1886 } 1887 } 1888 1889 return data[i]; 1890} 1891 1892static void joycon_encode_rumble(u8 *data, u16 freq_low, u16 freq_high, u16 amp) 1893{ 1894 struct joycon_rumble_freq_data freq_data_low; 1895 struct joycon_rumble_freq_data freq_data_high; 1896 struct joycon_rumble_amp_data amp_data; 1897 1898 freq_data_low = joycon_find_rumble_freq(freq_low); 1899 freq_data_high = joycon_find_rumble_freq(freq_high); 1900 amp_data = joycon_find_rumble_amp(amp); 1901 1902 data[0] = (freq_data_high.high >> 8) & 0xFF; 1903 data[1] = (freq_data_high.high & 0xFF) + amp_data.high; 1904 data[2] = freq_data_low.low + ((amp_data.low >> 8) & 0xFF); 1905 data[3] = amp_data.low & 0xFF; 1906} 1907 1908static const u16 JOYCON_MAX_RUMBLE_HIGH_FREQ = 1253; 1909static const u16 JOYCON_MIN_RUMBLE_HIGH_FREQ = 82; 1910static const u16 JOYCON_MAX_RUMBLE_LOW_FREQ = 626; 1911static const u16 JOYCON_MIN_RUMBLE_LOW_FREQ = 41; 1912 1913static void joycon_clamp_rumble_freqs(struct joycon_ctlr *ctlr) 1914{ 1915 unsigned long flags; 1916 1917 spin_lock_irqsave(&ctlr->lock, flags); 1918 ctlr->rumble_ll_freq = clamp(ctlr->rumble_ll_freq, 1919 JOYCON_MIN_RUMBLE_LOW_FREQ, 1920 JOYCON_MAX_RUMBLE_LOW_FREQ); 1921 ctlr->rumble_lh_freq = clamp(ctlr->rumble_lh_freq, 1922 JOYCON_MIN_RUMBLE_HIGH_FREQ, 1923 JOYCON_MAX_RUMBLE_HIGH_FREQ); 1924 ctlr->rumble_rl_freq = clamp(ctlr->rumble_rl_freq, 1925 JOYCON_MIN_RUMBLE_LOW_FREQ, 1926 JOYCON_MAX_RUMBLE_LOW_FREQ); 1927 ctlr->rumble_rh_freq = clamp(ctlr->rumble_rh_freq, 1928 JOYCON_MIN_RUMBLE_HIGH_FREQ, 1929 JOYCON_MAX_RUMBLE_HIGH_FREQ); 1930 spin_unlock_irqrestore(&ctlr->lock, flags); 1931} 1932 1933static int joycon_set_rumble(struct joycon_ctlr *ctlr, u16 amp_r, u16 amp_l, 1934 bool schedule_now) 1935{ 1936 u8 data[JC_RUMBLE_DATA_SIZE]; 1937 u16 amp; 1938 u16 freq_r_low; 1939 u16 freq_r_high; 1940 u16 freq_l_low; 1941 u16 freq_l_high; 1942 unsigned long flags; 1943 int next_rq_head; 1944 1945 spin_lock_irqsave(&ctlr->lock, flags); 1946 freq_r_low = ctlr->rumble_rl_freq; 1947 freq_r_high = ctlr->rumble_rh_freq; 1948 freq_l_low = ctlr->rumble_ll_freq; 1949 freq_l_high = ctlr->rumble_lh_freq; 1950 /* limit number of silent rumble packets to reduce traffic */ 1951 if (amp_l != 0 || amp_r != 0) 1952 ctlr->rumble_zero_countdown = JC_RUMBLE_ZERO_AMP_PKT_CNT; 1953 spin_unlock_irqrestore(&ctlr->lock, flags); 1954 1955 /* right joy-con */ 1956 amp = amp_r * (u32)joycon_max_rumble_amp / 65535; 1957 joycon_encode_rumble(data + 4, freq_r_low, freq_r_high, amp); 1958 1959 /* left joy-con */ 1960 amp = amp_l * (u32)joycon_max_rumble_amp / 65535; 1961 joycon_encode_rumble(data, freq_l_low, freq_l_high, amp); 1962 1963 spin_lock_irqsave(&ctlr->lock, flags); 1964 1965 next_rq_head = ctlr->rumble_queue_head + 1; 1966 if (next_rq_head >= JC_RUMBLE_QUEUE_SIZE) 1967 next_rq_head = 0; 1968 1969 /* Did we overrun the circular buffer? 1970 * If so, be sure we keep the latest intended rumble state. 1971 */ 1972 if (next_rq_head == ctlr->rumble_queue_tail) { 1973 hid_dbg(ctlr->hdev, "rumble queue is full"); 1974 /* overwrite the prior value at the end of the circular buf */ 1975 next_rq_head = ctlr->rumble_queue_head; 1976 } 1977 1978 ctlr->rumble_queue_head = next_rq_head; 1979 memcpy(ctlr->rumble_data[ctlr->rumble_queue_head], data, 1980 JC_RUMBLE_DATA_SIZE); 1981 1982 /* don't wait for the periodic send (reduces latency) */ 1983 if (schedule_now && ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED) 1984 queue_work(ctlr->rumble_queue, &ctlr->rumble_worker); 1985 1986 spin_unlock_irqrestore(&ctlr->lock, flags); 1987 1988 return 0; 1989} 1990 1991static int joycon_play_effect(struct input_dev *dev, void *data, 1992 struct ff_effect *effect) 1993{ 1994 struct joycon_ctlr *ctlr = input_get_drvdata(dev); 1995 1996 if (effect->type != FF_RUMBLE) 1997 return 0; 1998 1999 return joycon_set_rumble(ctlr, 2000 effect->u.rumble.weak_magnitude, 2001 effect->u.rumble.strong_magnitude, 2002 true); 2003} 2004#endif /* IS_ENABLED(CONFIG_NINTENDO_FF) */ 2005 2006static void joycon_config_left_stick(struct input_dev *idev) 2007{ 2008 input_set_abs_params(idev, 2009 ABS_X, 2010 -JC_MAX_STICK_MAG, 2011 JC_MAX_STICK_MAG, 2012 JC_STICK_FUZZ, 2013 JC_STICK_FLAT); 2014 input_set_abs_params(idev, 2015 ABS_Y, 2016 -JC_MAX_STICK_MAG, 2017 JC_MAX_STICK_MAG, 2018 JC_STICK_FUZZ, 2019 JC_STICK_FLAT); 2020} 2021 2022static void joycon_config_right_stick(struct input_dev *idev) 2023{ 2024 input_set_abs_params(idev, 2025 ABS_RX, 2026 -JC_MAX_STICK_MAG, 2027 JC_MAX_STICK_MAG, 2028 JC_STICK_FUZZ, 2029 JC_STICK_FLAT); 2030 input_set_abs_params(idev, 2031 ABS_RY, 2032 -JC_MAX_STICK_MAG, 2033 JC_MAX_STICK_MAG, 2034 JC_STICK_FUZZ, 2035 JC_STICK_FLAT); 2036} 2037 2038static void joycon_config_dpad(struct input_dev *idev) 2039{ 2040 input_set_abs_params(idev, 2041 ABS_HAT0X, 2042 -JC_MAX_DPAD_MAG, 2043 JC_MAX_DPAD_MAG, 2044 JC_DPAD_FUZZ, 2045 JC_DPAD_FLAT); 2046 input_set_abs_params(idev, 2047 ABS_HAT0Y, 2048 -JC_MAX_DPAD_MAG, 2049 JC_MAX_DPAD_MAG, 2050 JC_DPAD_FUZZ, 2051 JC_DPAD_FLAT); 2052} 2053 2054static void joycon_config_buttons(struct input_dev *idev, 2055 const struct joycon_ctlr_button_mapping button_mappings[]) 2056{ 2057 const struct joycon_ctlr_button_mapping *button; 2058 2059 for (button = button_mappings; button->code; button++) 2060 input_set_capability(idev, EV_KEY, button->code); 2061} 2062 2063static void joycon_config_rumble(struct joycon_ctlr *ctlr) 2064{ 2065#if IS_ENABLED(CONFIG_NINTENDO_FF) 2066 /* set up rumble */ 2067 input_set_capability(ctlr->input, EV_FF, FF_RUMBLE); 2068 input_ff_create_memless(ctlr->input, NULL, joycon_play_effect); 2069 ctlr->rumble_ll_freq = JC_RUMBLE_DFLT_LOW_FREQ; 2070 ctlr->rumble_lh_freq = JC_RUMBLE_DFLT_HIGH_FREQ; 2071 ctlr->rumble_rl_freq = JC_RUMBLE_DFLT_LOW_FREQ; 2072 ctlr->rumble_rh_freq = JC_RUMBLE_DFLT_HIGH_FREQ; 2073 joycon_clamp_rumble_freqs(ctlr); 2074 joycon_set_rumble(ctlr, 0, 0, false); 2075 ctlr->rumble_msecs = jiffies_to_msecs(jiffies); 2076#endif 2077} 2078 2079static int joycon_imu_input_create(struct joycon_ctlr *ctlr) 2080{ 2081 struct hid_device *hdev; 2082 const char *imu_name; 2083 int ret; 2084 2085 hdev = ctlr->hdev; 2086 2087 /* configure the imu input device */ 2088 ctlr->imu_input = devm_input_allocate_device(&hdev->dev); 2089 if (!ctlr->imu_input) 2090 return -ENOMEM; 2091 2092 ctlr->imu_input->id.bustype = hdev->bus; 2093 ctlr->imu_input->id.vendor = hdev->vendor; 2094 ctlr->imu_input->id.product = hdev->product; 2095 ctlr->imu_input->id.version = hdev->version; 2096 ctlr->imu_input->uniq = ctlr->mac_addr_str; 2097 ctlr->imu_input->phys = hdev->phys; 2098 2099 imu_name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s (IMU)", ctlr->input->name); 2100 if (!imu_name) 2101 return -ENOMEM; 2102 2103 ctlr->imu_input->name = imu_name; 2104 2105 input_set_drvdata(ctlr->imu_input, ctlr); 2106 2107 /* configure imu axes */ 2108 input_set_abs_params(ctlr->imu_input, ABS_X, 2109 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG, 2110 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT); 2111 input_set_abs_params(ctlr->imu_input, ABS_Y, 2112 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG, 2113 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT); 2114 input_set_abs_params(ctlr->imu_input, ABS_Z, 2115 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG, 2116 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT); 2117 input_abs_set_res(ctlr->imu_input, ABS_X, JC_IMU_ACCEL_RES_PER_G); 2118 input_abs_set_res(ctlr->imu_input, ABS_Y, JC_IMU_ACCEL_RES_PER_G); 2119 input_abs_set_res(ctlr->imu_input, ABS_Z, JC_IMU_ACCEL_RES_PER_G); 2120 2121 input_set_abs_params(ctlr->imu_input, ABS_RX, 2122 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG, 2123 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT); 2124 input_set_abs_params(ctlr->imu_input, ABS_RY, 2125 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG, 2126 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT); 2127 input_set_abs_params(ctlr->imu_input, ABS_RZ, 2128 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG, 2129 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT); 2130 2131 input_abs_set_res(ctlr->imu_input, ABS_RX, JC_IMU_GYRO_RES_PER_DPS); 2132 input_abs_set_res(ctlr->imu_input, ABS_RY, JC_IMU_GYRO_RES_PER_DPS); 2133 input_abs_set_res(ctlr->imu_input, ABS_RZ, JC_IMU_GYRO_RES_PER_DPS); 2134 2135 __set_bit(EV_MSC, ctlr->imu_input->evbit); 2136 __set_bit(MSC_TIMESTAMP, ctlr->imu_input->mscbit); 2137 __set_bit(INPUT_PROP_ACCELEROMETER, ctlr->imu_input->propbit); 2138 2139 ret = input_register_device(ctlr->imu_input); 2140 if (ret) 2141 return ret; 2142 2143 return 0; 2144} 2145 2146static int joycon_input_create(struct joycon_ctlr *ctlr) 2147{ 2148 struct hid_device *hdev; 2149 int ret; 2150 2151 hdev = ctlr->hdev; 2152 2153 ctlr->input = devm_input_allocate_device(&hdev->dev); 2154 if (!ctlr->input) 2155 return -ENOMEM; 2156 ctlr->input->id.bustype = hdev->bus; 2157 ctlr->input->id.vendor = hdev->vendor; 2158 ctlr->input->id.product = hdev->product; 2159 ctlr->input->id.version = hdev->version; 2160 ctlr->input->uniq = ctlr->mac_addr_str; 2161 ctlr->input->name = hdev->name; 2162 ctlr->input->phys = hdev->phys; 2163 input_set_drvdata(ctlr->input, ctlr); 2164 2165 ret = input_register_device(ctlr->input); 2166 if (ret) 2167 return ret; 2168 2169 if (joycon_type_is_right_joycon(ctlr)) { 2170 joycon_config_right_stick(ctlr->input); 2171 joycon_config_buttons(ctlr->input, right_joycon_button_mappings); 2172 if (!joycon_device_is_chrggrip(ctlr)) 2173 joycon_config_buttons(ctlr->input, right_joycon_s_button_mappings); 2174 } else if (joycon_type_is_left_joycon(ctlr)) { 2175 joycon_config_left_stick(ctlr->input); 2176 joycon_config_buttons(ctlr->input, left_joycon_button_mappings); 2177 if (!joycon_device_is_chrggrip(ctlr)) 2178 joycon_config_buttons(ctlr->input, left_joycon_s_button_mappings); 2179 } else if (joycon_type_is_procon(ctlr)) { 2180 joycon_config_left_stick(ctlr->input); 2181 joycon_config_right_stick(ctlr->input); 2182 joycon_config_dpad(ctlr->input); 2183 joycon_config_buttons(ctlr->input, procon_button_mappings); 2184 } else if (joycon_type_is_any_nescon(ctlr)) { 2185 joycon_config_dpad(ctlr->input); 2186 joycon_config_buttons(ctlr->input, nescon_button_mappings); 2187 } else if (joycon_type_is_snescon(ctlr)) { 2188 joycon_config_dpad(ctlr->input); 2189 joycon_config_buttons(ctlr->input, snescon_button_mappings); 2190 } else if (joycon_type_is_gencon(ctlr)) { 2191 joycon_config_dpad(ctlr->input); 2192 joycon_config_buttons(ctlr->input, gencon_button_mappings); 2193 } else if (joycon_type_is_n64con(ctlr)) { 2194 joycon_config_dpad(ctlr->input); 2195 joycon_config_left_stick(ctlr->input); 2196 joycon_config_buttons(ctlr->input, n64con_button_mappings); 2197 } 2198 2199 if (joycon_has_imu(ctlr)) { 2200 ret = joycon_imu_input_create(ctlr); 2201 if (ret) 2202 return ret; 2203 } 2204 2205 if (joycon_has_rumble(ctlr)) 2206 joycon_config_rumble(ctlr); 2207 2208 return 0; 2209} 2210 2211/* Because the subcommand sets all the leds at once, the brightness argument is ignored */ 2212static int joycon_player_led_brightness_set(struct led_classdev *led, 2213 enum led_brightness brightness) 2214{ 2215 struct device *dev = led->dev->parent; 2216 struct hid_device *hdev = to_hid_device(dev); 2217 struct joycon_ctlr *ctlr; 2218 int val = 0; 2219 int i; 2220 int ret; 2221 2222 ctlr = hid_get_drvdata(hdev); 2223 if (!ctlr) { 2224 hid_err(hdev, "No controller data\n"); 2225 return -ENODEV; 2226 } 2227 2228 for (i = 0; i < JC_NUM_LEDS; i++) 2229 val |= ctlr->leds[i].brightness << i; 2230 2231 mutex_lock(&ctlr->output_mutex); 2232 ret = joycon_set_player_leds(ctlr, 0, val); 2233 mutex_unlock(&ctlr->output_mutex); 2234 2235 return ret; 2236} 2237 2238static int joycon_home_led_brightness_set(struct led_classdev *led, 2239 enum led_brightness brightness) 2240{ 2241 struct device *dev = led->dev->parent; 2242 struct hid_device *hdev = to_hid_device(dev); 2243 struct joycon_ctlr *ctlr; 2244 int ret; 2245 2246 ctlr = hid_get_drvdata(hdev); 2247 if (!ctlr) { 2248 hid_err(hdev, "No controller data\n"); 2249 return -ENODEV; 2250 } 2251 mutex_lock(&ctlr->output_mutex); 2252 ret = joycon_set_home_led(ctlr, brightness); 2253 mutex_unlock(&ctlr->output_mutex); 2254 return ret; 2255} 2256 2257static DEFINE_IDA(nintendo_player_id_allocator); 2258 2259static int joycon_leds_create(struct joycon_ctlr *ctlr) 2260{ 2261 struct hid_device *hdev = ctlr->hdev; 2262 struct device *dev = &hdev->dev; 2263 const char *d_name = dev_name(dev); 2264 struct led_classdev *led; 2265 int led_val = 0; 2266 char *name; 2267 int ret; 2268 int i; 2269 int player_led_pattern; 2270 2271 /* configure the player LEDs */ 2272 ctlr->player_id = U32_MAX; 2273 ret = ida_alloc(&nintendo_player_id_allocator, GFP_KERNEL); 2274 if (ret < 0) { 2275 hid_warn(hdev, "Failed to allocate player ID, skipping; ret=%d\n", ret); 2276 goto home_led; 2277 } 2278 ctlr->player_id = ret; 2279 player_led_pattern = ret % JC_NUM_LED_PATTERNS; 2280 hid_info(ctlr->hdev, "assigned player %d led pattern", player_led_pattern + 1); 2281 2282 for (i = 0; i < JC_NUM_LEDS; i++) { 2283 name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s:%s", 2284 d_name, 2285 "green", 2286 joycon_player_led_names[i]); 2287 if (!name) 2288 return -ENOMEM; 2289 2290 led = &ctlr->leds[i]; 2291 led->name = name; 2292 led->brightness = joycon_player_led_patterns[player_led_pattern][i]; 2293 led->max_brightness = 1; 2294 led->brightness_set_blocking = 2295 joycon_player_led_brightness_set; 2296 led->flags = LED_CORE_SUSPENDRESUME | LED_HW_PLUGGABLE; 2297 2298 led_val |= joycon_player_led_patterns[player_led_pattern][i] << i; 2299 } 2300 mutex_lock(&ctlr->output_mutex); 2301 ret = joycon_set_player_leds(ctlr, 0, led_val); 2302 mutex_unlock(&ctlr->output_mutex); 2303 if (ret) { 2304 hid_warn(hdev, "Failed to set players LEDs, skipping registration; ret=%d\n", ret); 2305 goto home_led; 2306 } 2307 2308 for (i = 0; i < JC_NUM_LEDS; i++) { 2309 led = &ctlr->leds[i]; 2310 ret = devm_led_classdev_register(&hdev->dev, led); 2311 if (ret) { 2312 hid_err(hdev, "Failed to register player %d LED; ret=%d\n", i + 1, ret); 2313 return ret; 2314 } 2315 } 2316 2317home_led: 2318 /* configure the home LED */ 2319 if (jc_type_has_right(ctlr)) { 2320 name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s:%s", 2321 d_name, 2322 "blue", 2323 LED_FUNCTION_PLAYER5); 2324 if (!name) 2325 return -ENOMEM; 2326 2327 led = &ctlr->home_led; 2328 led->name = name; 2329 led->brightness = 0; 2330 led->max_brightness = 0xF; 2331 led->brightness_set_blocking = joycon_home_led_brightness_set; 2332 led->flags = LED_CORE_SUSPENDRESUME | LED_HW_PLUGGABLE; 2333 2334 /* Set the home LED to 0 as default state */ 2335 mutex_lock(&ctlr->output_mutex); 2336 ret = joycon_set_home_led(ctlr, 0); 2337 mutex_unlock(&ctlr->output_mutex); 2338 if (ret) { 2339 hid_warn(hdev, "Failed to set home LED, skipping registration; ret=%d\n", ret); 2340 return 0; 2341 } 2342 2343 ret = devm_led_classdev_register(&hdev->dev, led); 2344 if (ret) { 2345 hid_err(hdev, "Failed to register home LED; ret=%d\n", ret); 2346 return ret; 2347 } 2348 } 2349 2350 return 0; 2351} 2352 2353static int joycon_battery_get_property(struct power_supply *supply, 2354 enum power_supply_property prop, 2355 union power_supply_propval *val) 2356{ 2357 struct joycon_ctlr *ctlr = power_supply_get_drvdata(supply); 2358 unsigned long flags; 2359 int ret = 0; 2360 u8 capacity; 2361 bool charging; 2362 bool powered; 2363 2364 spin_lock_irqsave(&ctlr->lock, flags); 2365 capacity = ctlr->battery_capacity; 2366 charging = ctlr->battery_charging; 2367 powered = ctlr->host_powered; 2368 spin_unlock_irqrestore(&ctlr->lock, flags); 2369 2370 switch (prop) { 2371 case POWER_SUPPLY_PROP_PRESENT: 2372 val->intval = 1; 2373 break; 2374 case POWER_SUPPLY_PROP_SCOPE: 2375 val->intval = POWER_SUPPLY_SCOPE_DEVICE; 2376 break; 2377 case POWER_SUPPLY_PROP_CAPACITY_LEVEL: 2378 val->intval = capacity; 2379 break; 2380 case POWER_SUPPLY_PROP_STATUS: 2381 if (charging) 2382 val->intval = POWER_SUPPLY_STATUS_CHARGING; 2383 else if (capacity == POWER_SUPPLY_CAPACITY_LEVEL_FULL && 2384 powered) 2385 val->intval = POWER_SUPPLY_STATUS_FULL; 2386 else 2387 val->intval = POWER_SUPPLY_STATUS_DISCHARGING; 2388 break; 2389 default: 2390 ret = -EINVAL; 2391 break; 2392 } 2393 return ret; 2394} 2395 2396static enum power_supply_property joycon_battery_props[] = { 2397 POWER_SUPPLY_PROP_PRESENT, 2398 POWER_SUPPLY_PROP_CAPACITY_LEVEL, 2399 POWER_SUPPLY_PROP_SCOPE, 2400 POWER_SUPPLY_PROP_STATUS, 2401}; 2402 2403static int joycon_power_supply_create(struct joycon_ctlr *ctlr) 2404{ 2405 struct hid_device *hdev = ctlr->hdev; 2406 struct power_supply_config supply_config = { .drv_data = ctlr, }; 2407 const char * const name_fmt = "nintendo_switch_controller_battery_%s"; 2408 int ret = 0; 2409 2410 /* Set initially to unknown before receiving first input report */ 2411 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN; 2412 2413 /* Configure the battery's description */ 2414 ctlr->battery_desc.properties = joycon_battery_props; 2415 ctlr->battery_desc.num_properties = 2416 ARRAY_SIZE(joycon_battery_props); 2417 ctlr->battery_desc.get_property = joycon_battery_get_property; 2418 ctlr->battery_desc.type = POWER_SUPPLY_TYPE_BATTERY; 2419 ctlr->battery_desc.use_for_apm = 0; 2420 ctlr->battery_desc.name = devm_kasprintf(&hdev->dev, GFP_KERNEL, 2421 name_fmt, 2422 dev_name(&hdev->dev)); 2423 if (!ctlr->battery_desc.name) 2424 return -ENOMEM; 2425 2426 ctlr->battery = devm_power_supply_register(&hdev->dev, 2427 &ctlr->battery_desc, 2428 &supply_config); 2429 if (IS_ERR(ctlr->battery)) { 2430 ret = PTR_ERR(ctlr->battery); 2431 hid_err(hdev, "Failed to register battery; ret=%d\n", ret); 2432 return ret; 2433 } 2434 2435 return power_supply_powers(ctlr->battery, &hdev->dev); 2436} 2437 2438static int joycon_read_info(struct joycon_ctlr *ctlr) 2439{ 2440 int ret; 2441 int i; 2442 int j; 2443 struct joycon_subcmd_request req = { 0 }; 2444 struct joycon_input_report *report; 2445 2446 req.subcmd_id = JC_SUBCMD_REQ_DEV_INFO; 2447 ret = joycon_send_subcmd(ctlr, &req, 0, HZ); 2448 if (ret) { 2449 hid_err(ctlr->hdev, "Failed to get joycon info; ret=%d\n", ret); 2450 return ret; 2451 } 2452 2453 report = (struct joycon_input_report *)ctlr->input_buf; 2454 2455 for (i = 4, j = 0; j < 6; i++, j++) 2456 ctlr->mac_addr[j] = report->subcmd_reply.data[i]; 2457 2458 ctlr->mac_addr_str = devm_kasprintf(&ctlr->hdev->dev, GFP_KERNEL, 2459 "%02X:%02X:%02X:%02X:%02X:%02X", 2460 ctlr->mac_addr[0], 2461 ctlr->mac_addr[1], 2462 ctlr->mac_addr[2], 2463 ctlr->mac_addr[3], 2464 ctlr->mac_addr[4], 2465 ctlr->mac_addr[5]); 2466 if (!ctlr->mac_addr_str) 2467 return -ENOMEM; 2468 hid_info(ctlr->hdev, "controller MAC = %s\n", ctlr->mac_addr_str); 2469 2470 /* 2471 * Retrieve the type so we can distinguish the controller type 2472 * Unfortantly the hdev->product can't always be used due to a ?bug? 2473 * with the NSO Genesis controller. Over USB, it will report the 2474 * PID as 0x201E, but over bluetooth it will report the PID as 0x2017 2475 * which is the same as the NSO SNES controller. This is different from 2476 * the rest of the controllers which will report the same PID over USB 2477 * and bluetooth. 2478 */ 2479 ctlr->ctlr_type = report->subcmd_reply.data[2]; 2480 hid_dbg(ctlr->hdev, "controller type = 0x%02X\n", ctlr->ctlr_type); 2481 2482 return 0; 2483} 2484 2485static int joycon_init(struct hid_device *hdev) 2486{ 2487 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev); 2488 int ret = 0; 2489 2490 mutex_lock(&ctlr->output_mutex); 2491 /* if handshake command fails, assume ble pro controller */ 2492 if (joycon_using_usb(ctlr) && !joycon_send_usb(ctlr, JC_USB_CMD_HANDSHAKE, HZ)) { 2493 hid_dbg(hdev, "detected USB controller\n"); 2494 /* set baudrate for improved latency */ 2495 ret = joycon_send_usb(ctlr, JC_USB_CMD_BAUDRATE_3M, HZ); 2496 if (ret) { 2497 /* 2498 * We can function with the default baudrate. 2499 * Provide a warning, and continue on. 2500 */ 2501 hid_warn(hdev, "Failed to set baudrate (ret=%d), continuing anyway\n", ret); 2502 } 2503 /* handshake */ 2504 ret = joycon_send_usb(ctlr, JC_USB_CMD_HANDSHAKE, HZ); 2505 if (ret) { 2506 hid_err(hdev, "Failed handshake; ret=%d\n", ret); 2507 goto out_unlock; 2508 } 2509 /* 2510 * Set no timeout (to keep controller in USB mode). 2511 * This doesn't send a response, so ignore the timeout. 2512 */ 2513 joycon_send_usb(ctlr, JC_USB_CMD_NO_TIMEOUT, HZ/10); 2514 } else if (jc_type_is_chrggrip(ctlr)) { 2515 hid_err(hdev, "Failed charging grip handshake\n"); 2516 ret = -ETIMEDOUT; 2517 goto out_unlock; 2518 } 2519 2520 /* needed to retrieve the controller type */ 2521 ret = joycon_read_info(ctlr); 2522 if (ret) { 2523 hid_err(hdev, "Failed to retrieve controller info; ret=%d\n", 2524 ret); 2525 goto out_unlock; 2526 } 2527 2528 if (joycon_has_joysticks(ctlr)) { 2529 /* get controller calibration data, and parse it */ 2530 ret = joycon_request_calibration(ctlr); 2531 if (ret) { 2532 /* 2533 * We can function with default calibration, but it may be 2534 * inaccurate. Provide a warning, and continue on. 2535 */ 2536 hid_warn(hdev, "Analog stick positions may be inaccurate\n"); 2537 } 2538 } 2539 2540 if (joycon_has_imu(ctlr)) { 2541 /* get IMU calibration data, and parse it */ 2542 ret = joycon_request_imu_calibration(ctlr); 2543 if (ret) { 2544 /* 2545 * We can function with default calibration, but it may be 2546 * inaccurate. Provide a warning, and continue on. 2547 */ 2548 hid_warn(hdev, "Unable to read IMU calibration data\n"); 2549 } 2550 2551 /* Enable the IMU */ 2552 ret = joycon_enable_imu(ctlr); 2553 if (ret) { 2554 hid_err(hdev, "Failed to enable the IMU; ret=%d\n", ret); 2555 goto out_unlock; 2556 } 2557 } 2558 2559 /* Set the reporting mode to 0x30, which is the full report mode */ 2560 ret = joycon_set_report_mode(ctlr); 2561 if (ret) { 2562 hid_err(hdev, "Failed to set report mode; ret=%d\n", ret); 2563 goto out_unlock; 2564 } 2565 2566 if (joycon_has_rumble(ctlr)) { 2567 /* Enable rumble */ 2568 ret = joycon_enable_rumble(ctlr); 2569 if (ret) { 2570 hid_err(hdev, "Failed to enable rumble; ret=%d\n", ret); 2571 goto out_unlock; 2572 } 2573 } 2574 2575out_unlock: 2576 mutex_unlock(&ctlr->output_mutex); 2577 return ret; 2578} 2579 2580/* Common handler for parsing inputs */ 2581static int joycon_ctlr_read_handler(struct joycon_ctlr *ctlr, u8 *data, 2582 int size) 2583{ 2584 if (data[0] == JC_INPUT_SUBCMD_REPLY || data[0] == JC_INPUT_IMU_DATA || 2585 data[0] == JC_INPUT_MCU_DATA) { 2586 if (size >= 12) /* make sure it contains the input report */ 2587 joycon_parse_report(ctlr, 2588 (struct joycon_input_report *)data); 2589 } 2590 2591 return 0; 2592} 2593 2594static int joycon_ctlr_handle_event(struct joycon_ctlr *ctlr, u8 *data, 2595 int size) 2596{ 2597 int ret = 0; 2598 bool match = false; 2599 struct joycon_input_report *report; 2600 2601 if (unlikely(mutex_is_locked(&ctlr->output_mutex)) && 2602 ctlr->msg_type != JOYCON_MSG_TYPE_NONE) { 2603 switch (ctlr->msg_type) { 2604 case JOYCON_MSG_TYPE_USB: 2605 if (size < 2) 2606 break; 2607 if (data[0] == JC_INPUT_USB_RESPONSE && 2608 data[1] == ctlr->usb_ack_match) 2609 match = true; 2610 break; 2611 case JOYCON_MSG_TYPE_SUBCMD: 2612 if (size < sizeof(struct joycon_input_report) || 2613 data[0] != JC_INPUT_SUBCMD_REPLY) 2614 break; 2615 report = (struct joycon_input_report *)data; 2616 if (report->subcmd_reply.id == ctlr->subcmd_ack_match) 2617 match = true; 2618 break; 2619 default: 2620 break; 2621 } 2622 2623 if (match) { 2624 memcpy(ctlr->input_buf, data, 2625 min(size, (int)JC_MAX_RESP_SIZE)); 2626 ctlr->msg_type = JOYCON_MSG_TYPE_NONE; 2627 ctlr->received_resp = true; 2628 wake_up(&ctlr->wait); 2629 2630 /* This message has been handled */ 2631 return 1; 2632 } 2633 } 2634 2635 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_READ) 2636 ret = joycon_ctlr_read_handler(ctlr, data, size); 2637 2638 return ret; 2639} 2640 2641static int nintendo_hid_event(struct hid_device *hdev, 2642 struct hid_report *report, u8 *raw_data, int size) 2643{ 2644 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev); 2645 2646 if (size < 1) 2647 return -EINVAL; 2648 2649 return joycon_ctlr_handle_event(ctlr, raw_data, size); 2650} 2651 2652static int nintendo_hid_probe(struct hid_device *hdev, 2653 const struct hid_device_id *id) 2654{ 2655 int ret; 2656 struct joycon_ctlr *ctlr; 2657 2658 hid_dbg(hdev, "probe - start\n"); 2659 2660 ctlr = devm_kzalloc(&hdev->dev, sizeof(*ctlr), GFP_KERNEL); 2661 if (!ctlr) { 2662 ret = -ENOMEM; 2663 goto err; 2664 } 2665 2666 ctlr->hdev = hdev; 2667 ctlr->ctlr_state = JOYCON_CTLR_STATE_INIT; 2668 ctlr->rumble_queue_head = 0; 2669 ctlr->rumble_queue_tail = 0; 2670 hid_set_drvdata(hdev, ctlr); 2671 mutex_init(&ctlr->output_mutex); 2672 init_waitqueue_head(&ctlr->wait); 2673 spin_lock_init(&ctlr->lock); 2674 ctlr->rumble_queue = alloc_workqueue("hid-nintendo-rumble_wq", 2675 WQ_FREEZABLE | WQ_MEM_RECLAIM, 0); 2676 if (!ctlr->rumble_queue) { 2677 ret = -ENOMEM; 2678 goto err; 2679 } 2680 INIT_WORK(&ctlr->rumble_worker, joycon_rumble_worker); 2681 2682 ret = hid_parse(hdev); 2683 if (ret) { 2684 hid_err(hdev, "HID parse failed\n"); 2685 goto err_wq; 2686 } 2687 2688 /* 2689 * Patch the hw version of pro controller/joycons, so applications can 2690 * distinguish between the default HID mappings and the mappings defined 2691 * by the Linux game controller spec. This is important for the SDL2 2692 * library, which has a game controller database, which uses device ids 2693 * in combination with version as a key. 2694 */ 2695 hdev->version |= 0x8000; 2696 2697 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW); 2698 if (ret) { 2699 hid_err(hdev, "HW start failed\n"); 2700 goto err_wq; 2701 } 2702 2703 ret = hid_hw_open(hdev); 2704 if (ret) { 2705 hid_err(hdev, "cannot start hardware I/O\n"); 2706 goto err_stop; 2707 } 2708 2709 hid_device_io_start(hdev); 2710 2711 ret = joycon_init(hdev); 2712 if (ret) { 2713 hid_err(hdev, "Failed to initialize controller; ret=%d\n", ret); 2714 goto err_close; 2715 } 2716 2717 /* Initialize the leds */ 2718 ret = joycon_leds_create(ctlr); 2719 if (ret) { 2720 hid_err(hdev, "Failed to create leds; ret=%d\n", ret); 2721 goto err_close; 2722 } 2723 2724 /* Initialize the battery power supply */ 2725 ret = joycon_power_supply_create(ctlr); 2726 if (ret) { 2727 hid_err(hdev, "Failed to create power_supply; ret=%d\n", ret); 2728 goto err_close; 2729 } 2730 2731 ret = joycon_input_create(ctlr); 2732 if (ret) { 2733 hid_err(hdev, "Failed to create input device; ret=%d\n", ret); 2734 goto err_close; 2735 } 2736 2737 ctlr->ctlr_state = JOYCON_CTLR_STATE_READ; 2738 2739 hid_dbg(hdev, "probe - success\n"); 2740 return 0; 2741 2742err_close: 2743 hid_hw_close(hdev); 2744err_stop: 2745 hid_hw_stop(hdev); 2746err_wq: 2747 destroy_workqueue(ctlr->rumble_queue); 2748err: 2749 hid_err(hdev, "probe - fail = %d\n", ret); 2750 return ret; 2751} 2752 2753static void nintendo_hid_remove(struct hid_device *hdev) 2754{ 2755 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev); 2756 unsigned long flags; 2757 2758 hid_dbg(hdev, "remove\n"); 2759 2760 /* Prevent further attempts at sending subcommands. */ 2761 spin_lock_irqsave(&ctlr->lock, flags); 2762 ctlr->ctlr_state = JOYCON_CTLR_STATE_REMOVED; 2763 spin_unlock_irqrestore(&ctlr->lock, flags); 2764 2765 destroy_workqueue(ctlr->rumble_queue); 2766 ida_free(&nintendo_player_id_allocator, ctlr->player_id); 2767 2768 hid_hw_close(hdev); 2769 hid_hw_stop(hdev); 2770} 2771 2772#ifdef CONFIG_PM 2773 2774static int nintendo_hid_resume(struct hid_device *hdev) 2775{ 2776 int ret = joycon_init(hdev); 2777 2778 if (ret) 2779 hid_err(hdev, "Failed to restore controller after resume"); 2780 2781 return ret; 2782} 2783 2784#endif 2785 2786static const struct hid_device_id nintendo_hid_devices[] = { 2787 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO, 2788 USB_DEVICE_ID_NINTENDO_PROCON) }, 2789 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO, 2790 USB_DEVICE_ID_NINTENDO_SNESCON) }, 2791 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO, 2792 USB_DEVICE_ID_NINTENDO_GENCON) }, 2793 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO, 2794 USB_DEVICE_ID_NINTENDO_N64CON) }, 2795 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, 2796 USB_DEVICE_ID_NINTENDO_PROCON) }, 2797 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO, 2798 USB_DEVICE_ID_NINTENDO_CHRGGRIP) }, 2799 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, 2800 USB_DEVICE_ID_NINTENDO_JOYCONL) }, 2801 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, 2802 USB_DEVICE_ID_NINTENDO_JOYCONR) }, 2803 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, 2804 USB_DEVICE_ID_NINTENDO_SNESCON) }, 2805 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, 2806 USB_DEVICE_ID_NINTENDO_GENCON) }, 2807 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, 2808 USB_DEVICE_ID_NINTENDO_N64CON) }, 2809 { } 2810}; 2811MODULE_DEVICE_TABLE(hid, nintendo_hid_devices); 2812 2813static struct hid_driver nintendo_hid_driver = { 2814 .name = "nintendo", 2815 .id_table = nintendo_hid_devices, 2816 .probe = nintendo_hid_probe, 2817 .remove = nintendo_hid_remove, 2818 .raw_event = nintendo_hid_event, 2819 2820#ifdef CONFIG_PM 2821 .resume = nintendo_hid_resume, 2822#endif 2823}; 2824static int __init nintendo_init(void) 2825{ 2826 return hid_register_driver(&nintendo_hid_driver); 2827} 2828 2829static void __exit nintendo_exit(void) 2830{ 2831 hid_unregister_driver(&nintendo_hid_driver); 2832 ida_destroy(&nintendo_player_id_allocator); 2833} 2834 2835module_init(nintendo_init); 2836module_exit(nintendo_exit); 2837 2838MODULE_LICENSE("GPL"); 2839MODULE_AUTHOR("Ryan McClelland <rymcclel@gmail.com>"); 2840MODULE_AUTHOR("Emily Strickland <linux@emily.st>"); 2841MODULE_AUTHOR("Daniel J. Ogorchock <djogorchock@gmail.com>"); 2842MODULE_DESCRIPTION("Driver for Nintendo Switch Controllers"); 2843