drivers/hid/hid-nintendo.c

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