1 // SPDX-License-Identifier: GPL-2.0+
3 * HID driver for Nintendo Switch Joy-Cons and Pro Controllers
5 * Copyright (c) 2019-2021 Daniel J. Ogorchock <djogorchock@gmail.com>
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
17 * This driver supports the Nintendo Switch Joy-Cons and Pro Controllers. The
18 * Pro Controllers can either be used over USB or Bluetooth.
20 * The driver will retrieve the factory calibration info from the controllers,
21 * so little to no user calibration should be required.
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>
39 * Reference the url below for the following HID report defines:
40 * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering
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
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
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
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
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
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
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)
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
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
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
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
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
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
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
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
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
169 * Now, 14.247 truncating to 14 loses a lot of precision, so we rescale the
170 * min/max range by 1000.
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
179 /* frequency/amplitude tables for rumble */
180 struct joycon_rumble_freq_data {
186 struct joycon_rumble_amp_data {
192 #if IS_ENABLED(CONFIG_NINTENDO_FF)
194 * These tables are from
195 * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/rumble_data_table.md
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 }
254 #define joycon_max_rumble_amp (1003)
255 static const struct joycon_rumble_amp_data joycon_rumble_amplitudes[] = {
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 }
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;
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,
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,
313 struct joycon_stick_cal {
319 struct joycon_imu_cal {
325 * All the controller's button values are stored in a u32.
326 * They can be accessed with bitwise ANDs.
328 static const u32 JC_BTN_Y = BIT(0);
329 static const u32 JC_BTN_X = BIT(1);
330 static const u32 JC_BTN_B = BIT(2);
331 static const u32 JC_BTN_A = BIT(3);
332 static const u32 JC_BTN_SR_R = BIT(4);
333 static const u32 JC_BTN_SL_R = BIT(5);
334 static const u32 JC_BTN_R = BIT(6);
335 static const u32 JC_BTN_ZR = BIT(7);
336 static const u32 JC_BTN_MINUS = BIT(8);
337 static const u32 JC_BTN_PLUS = BIT(9);
338 static const u32 JC_BTN_RSTICK = BIT(10);
339 static const u32 JC_BTN_LSTICK = BIT(11);
340 static const u32 JC_BTN_HOME = BIT(12);
341 static const u32 JC_BTN_CAP = BIT(13); /* capture button */
342 static const u32 JC_BTN_DOWN = BIT(16);
343 static const u32 JC_BTN_UP = BIT(17);
344 static const u32 JC_BTN_RIGHT = BIT(18);
345 static const u32 JC_BTN_LEFT = BIT(19);
346 static const u32 JC_BTN_SR_L = BIT(20);
347 static const u32 JC_BTN_SL_L = BIT(21);
348 static const u32 JC_BTN_L = BIT(22);
349 static const u32 JC_BTN_ZL = BIT(23);
351 enum joycon_msg_type {
352 JOYCON_MSG_TYPE_NONE,
354 JOYCON_MSG_TYPE_SUBCMD,
357 struct joycon_rumble_output {
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 */
368 u8 data[]; /* length depends on the subcommand */
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 */
377 struct joycon_imu_data {
386 struct joycon_input_report {
389 u8 bat_con; /* battery and connection info */
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];
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
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,
412 #define JC_NUM_LEDS ARRAY_SIZE(joycon_player_led_names)
414 /* Each physical controller is associated with a joycon_ctlr struct */
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;
424 enum joycon_ctlr_type ctlr_type;
426 /* The following members are used for synchronous sends/receives */
427 enum joycon_msg_type msg_type;
429 struct mutex output_mutex;
430 u8 input_buf[JC_MAX_RESP_SIZE];
431 wait_queue_head_t wait;
435 bool received_input_report;
436 unsigned int last_subcmd_sent_msecs;
438 /* factory calibration data */
439 struct joycon_stick_cal left_stick_cal_x;
440 struct joycon_stick_cal left_stick_cal_y;
441 struct joycon_stick_cal right_stick_cal_x;
442 struct joycon_stick_cal right_stick_cal_y;
444 struct joycon_imu_cal accel_cal;
445 struct joycon_imu_cal gyro_cal;
447 /* prevents needlessly recalculating these divisors every sample */
448 s32 imu_cal_accel_divisor[3];
449 s32 imu_cal_gyro_divisor[3];
451 /* power supply data */
452 struct power_supply *battery;
453 struct power_supply_desc battery_desc;
455 bool battery_charging;
459 u8 rumble_data[JC_RUMBLE_QUEUE_SIZE][JC_RUMBLE_DATA_SIZE];
460 int rumble_queue_head;
461 int rumble_queue_tail;
462 struct workqueue_struct *rumble_queue;
463 struct work_struct rumble_worker;
464 unsigned int rumble_msecs;
469 unsigned short rumble_zero_countdown;
472 struct input_dev *imu_input;
473 bool imu_first_packet_received; /* helps in initiating timestamp */
474 unsigned int imu_timestamp_us; /* timestamp we report to userspace */
475 unsigned int imu_last_pkt_ms; /* used to calc imu report delta */
476 /* the following are used to track the average imu report time delta */
477 unsigned int imu_delta_samples_count;
478 unsigned int imu_delta_samples_sum;
479 unsigned int imu_avg_delta_ms;
482 /* Helper macros for checking controller type */
483 #define jc_type_is_joycon(ctlr) \
484 (ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONL || \
485 ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONR || \
486 ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_CHRGGRIP)
487 #define jc_type_is_procon(ctlr) \
488 (ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_PROCON)
489 #define jc_type_is_chrggrip(ctlr) \
490 (ctlr->hdev->product == USB_DEVICE_ID_NINTENDO_CHRGGRIP)
492 /* Does this controller have inputs associated with left joycon? */
493 #define jc_type_has_left(ctlr) \
494 (ctlr->ctlr_type == JOYCON_CTLR_TYPE_JCL || \
495 ctlr->ctlr_type == JOYCON_CTLR_TYPE_PRO)
497 /* Does this controller have inputs associated with right joycon? */
498 #define jc_type_has_right(ctlr) \
499 (ctlr->ctlr_type == JOYCON_CTLR_TYPE_JCR || \
500 ctlr->ctlr_type == JOYCON_CTLR_TYPE_PRO)
502 static int __joycon_hid_send(struct hid_device *hdev, u8 *data, size_t len)
507 buf = kmemdup(data, len, GFP_KERNEL);
510 ret = hid_hw_output_report(hdev, buf, len);
513 hid_dbg(hdev, "Failed to send output report ret=%d\n", ret);
517 static void joycon_wait_for_input_report(struct joycon_ctlr *ctlr)
522 * If we are in the proper reporting mode, wait for an input
523 * report prior to sending the subcommand. This improves
524 * reliability considerably.
526 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_READ) {
529 spin_lock_irqsave(&ctlr->lock, flags);
530 ctlr->received_input_report = false;
531 spin_unlock_irqrestore(&ctlr->lock, flags);
532 ret = wait_event_timeout(ctlr->wait,
533 ctlr->received_input_report,
535 /* We will still proceed, even with a timeout here */
538 "timeout waiting for input report\n");
543 * Sending subcommands and/or rumble data at too high a rate can cause bluetooth
544 * controller disconnections.
546 static void joycon_enforce_subcmd_rate(struct joycon_ctlr *ctlr)
548 static const unsigned int max_subcmd_rate_ms = 25;
549 unsigned int current_ms = jiffies_to_msecs(jiffies);
550 unsigned int delta_ms = current_ms - ctlr->last_subcmd_sent_msecs;
552 while (delta_ms < max_subcmd_rate_ms &&
553 ctlr->ctlr_state == JOYCON_CTLR_STATE_READ) {
554 joycon_wait_for_input_report(ctlr);
555 current_ms = jiffies_to_msecs(jiffies);
556 delta_ms = current_ms - ctlr->last_subcmd_sent_msecs;
558 ctlr->last_subcmd_sent_msecs = current_ms;
561 static int joycon_hid_send_sync(struct joycon_ctlr *ctlr, u8 *data, size_t len,
568 * The controller occasionally seems to drop subcommands. In testing,
569 * doing one retry after a timeout appears to always work.
572 joycon_enforce_subcmd_rate(ctlr);
574 ret = __joycon_hid_send(ctlr->hdev, data, len);
576 memset(ctlr->input_buf, 0, JC_MAX_RESP_SIZE);
580 ret = wait_event_timeout(ctlr->wait, ctlr->received_resp,
584 "synchronous send/receive timed out\n");
587 "retrying sync send after timeout\n");
589 memset(ctlr->input_buf, 0, JC_MAX_RESP_SIZE);
597 ctlr->received_resp = false;
601 static int joycon_send_usb(struct joycon_ctlr *ctlr, u8 cmd, u32 timeout)
604 u8 buf[2] = {JC_OUTPUT_USB_CMD};
607 ctlr->usb_ack_match = cmd;
608 ctlr->msg_type = JOYCON_MSG_TYPE_USB;
609 ret = joycon_hid_send_sync(ctlr, buf, sizeof(buf), timeout);
611 hid_dbg(ctlr->hdev, "send usb command failed; ret=%d\n", ret);
615 static int joycon_send_subcmd(struct joycon_ctlr *ctlr,
616 struct joycon_subcmd_request *subcmd,
617 size_t data_len, u32 timeout)
622 spin_lock_irqsave(&ctlr->lock, flags);
624 * If the controller has been removed, just return ENODEV so the LED
625 * subsystem doesn't print invalid errors on removal.
627 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_REMOVED) {
628 spin_unlock_irqrestore(&ctlr->lock, flags);
631 memcpy(subcmd->rumble_data, ctlr->rumble_data[ctlr->rumble_queue_tail],
632 JC_RUMBLE_DATA_SIZE);
633 spin_unlock_irqrestore(&ctlr->lock, flags);
635 subcmd->output_id = JC_OUTPUT_RUMBLE_AND_SUBCMD;
636 subcmd->packet_num = ctlr->subcmd_num;
637 if (++ctlr->subcmd_num > 0xF)
638 ctlr->subcmd_num = 0;
639 ctlr->subcmd_ack_match = subcmd->subcmd_id;
640 ctlr->msg_type = JOYCON_MSG_TYPE_SUBCMD;
642 ret = joycon_hid_send_sync(ctlr, (u8 *)subcmd,
643 sizeof(*subcmd) + data_len, timeout);
645 hid_dbg(ctlr->hdev, "send subcommand failed; ret=%d\n", ret);
651 /* Supply nibbles for flash and on. Ones correspond to active */
652 static int joycon_set_player_leds(struct joycon_ctlr *ctlr, u8 flash, u8 on)
654 struct joycon_subcmd_request *req;
655 u8 buffer[sizeof(*req) + 1] = { 0 };
657 req = (struct joycon_subcmd_request *)buffer;
658 req->subcmd_id = JC_SUBCMD_SET_PLAYER_LIGHTS;
659 req->data[0] = (flash << 4) | on;
661 hid_dbg(ctlr->hdev, "setting player leds\n");
662 return joycon_send_subcmd(ctlr, req, 1, HZ/4);
665 static int joycon_request_spi_flash_read(struct joycon_ctlr *ctlr,
666 u32 start_addr, u8 size, u8 **reply)
668 struct joycon_subcmd_request *req;
669 struct joycon_input_report *report;
670 u8 buffer[sizeof(*req) + 5] = { 0 };
677 req = (struct joycon_subcmd_request *)buffer;
678 req->subcmd_id = JC_SUBCMD_SPI_FLASH_READ;
680 put_unaligned_le32(start_addr, data);
683 hid_dbg(ctlr->hdev, "requesting SPI flash data\n");
684 ret = joycon_send_subcmd(ctlr, req, 5, HZ);
686 hid_err(ctlr->hdev, "failed reading SPI flash; ret=%d\n", ret);
688 report = (struct joycon_input_report *)ctlr->input_buf;
689 /* The read data starts at the 6th byte */
690 *reply = &report->subcmd_reply.data[5];
696 * User calibration's presence is denoted with a magic byte preceding it.
697 * returns 0 if magic val is present, 1 if not present, < 0 on error
699 static int joycon_check_for_cal_magic(struct joycon_ctlr *ctlr, u32 flash_addr)
704 ret = joycon_request_spi_flash_read(ctlr, flash_addr,
705 JC_CAL_USR_MAGIC_SIZE, &reply);
709 return reply[0] != JC_CAL_USR_MAGIC_0 || reply[1] != JC_CAL_USR_MAGIC_1;
712 static int joycon_read_stick_calibration(struct joycon_ctlr *ctlr, u16 cal_addr,
713 struct joycon_stick_cal *cal_x,
714 struct joycon_stick_cal *cal_y,
724 ret = joycon_request_spi_flash_read(ctlr, cal_addr,
725 JC_CAL_STICK_DATA_SIZE, &raw_cal);
729 /* stick calibration parsing: note the order differs based on stick */
731 x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0,
733 y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4,
735 cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0,
737 cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4,
739 x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0,
741 y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4,
744 cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0,
746 cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4,
748 x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0,
750 y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4,
752 x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0,
754 y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4,
758 cal_x->max = cal_x->center + x_max_above;
759 cal_x->min = cal_x->center - x_min_below;
760 cal_y->max = cal_y->center + y_max_above;
761 cal_y->min = cal_y->center - y_min_below;
766 static const u16 DFLT_STICK_CAL_CEN = 2000;
767 static const u16 DFLT_STICK_CAL_MAX = 3500;
768 static const u16 DFLT_STICK_CAL_MIN = 500;
769 static int joycon_request_calibration(struct joycon_ctlr *ctlr)
771 u16 left_stick_addr = JC_CAL_FCT_DATA_LEFT_ADDR;
772 u16 right_stick_addr = JC_CAL_FCT_DATA_RIGHT_ADDR;
775 hid_dbg(ctlr->hdev, "requesting cal data\n");
777 /* check if user stick calibrations are present */
778 if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_LEFT_MAGIC_ADDR)) {
779 left_stick_addr = JC_CAL_USR_LEFT_DATA_ADDR;
780 hid_info(ctlr->hdev, "using user cal for left stick\n");
782 hid_info(ctlr->hdev, "using factory cal for left stick\n");
784 if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_RIGHT_MAGIC_ADDR)) {
785 right_stick_addr = JC_CAL_USR_RIGHT_DATA_ADDR;
786 hid_info(ctlr->hdev, "using user cal for right stick\n");
788 hid_info(ctlr->hdev, "using factory cal for right stick\n");
791 /* read the left stick calibration data */
792 ret = joycon_read_stick_calibration(ctlr, left_stick_addr,
793 &ctlr->left_stick_cal_x,
794 &ctlr->left_stick_cal_y,
798 "Failed to read left stick cal, using dflts; e=%d\n",
801 ctlr->left_stick_cal_x.center = DFLT_STICK_CAL_CEN;
802 ctlr->left_stick_cal_x.max = DFLT_STICK_CAL_MAX;
803 ctlr->left_stick_cal_x.min = DFLT_STICK_CAL_MIN;
805 ctlr->left_stick_cal_y.center = DFLT_STICK_CAL_CEN;
806 ctlr->left_stick_cal_y.max = DFLT_STICK_CAL_MAX;
807 ctlr->left_stick_cal_y.min = DFLT_STICK_CAL_MIN;
810 /* read the right stick calibration data */
811 ret = joycon_read_stick_calibration(ctlr, right_stick_addr,
812 &ctlr->right_stick_cal_x,
813 &ctlr->right_stick_cal_y,
817 "Failed to read right stick cal, using dflts; e=%d\n",
820 ctlr->right_stick_cal_x.center = DFLT_STICK_CAL_CEN;
821 ctlr->right_stick_cal_x.max = DFLT_STICK_CAL_MAX;
822 ctlr->right_stick_cal_x.min = DFLT_STICK_CAL_MIN;
824 ctlr->right_stick_cal_y.center = DFLT_STICK_CAL_CEN;
825 ctlr->right_stick_cal_y.max = DFLT_STICK_CAL_MAX;
826 ctlr->right_stick_cal_y.min = DFLT_STICK_CAL_MIN;
829 hid_dbg(ctlr->hdev, "calibration:\n"
830 "l_x_c=%d l_x_max=%d l_x_min=%d\n"
831 "l_y_c=%d l_y_max=%d l_y_min=%d\n"
832 "r_x_c=%d r_x_max=%d r_x_min=%d\n"
833 "r_y_c=%d r_y_max=%d r_y_min=%d\n",
834 ctlr->left_stick_cal_x.center,
835 ctlr->left_stick_cal_x.max,
836 ctlr->left_stick_cal_x.min,
837 ctlr->left_stick_cal_y.center,
838 ctlr->left_stick_cal_y.max,
839 ctlr->left_stick_cal_y.min,
840 ctlr->right_stick_cal_x.center,
841 ctlr->right_stick_cal_x.max,
842 ctlr->right_stick_cal_x.min,
843 ctlr->right_stick_cal_y.center,
844 ctlr->right_stick_cal_y.max,
845 ctlr->right_stick_cal_y.min);
851 * These divisors are calculated once rather than for each sample. They are only
852 * dependent on the IMU calibration values. They are used when processing the
855 static void joycon_calc_imu_cal_divisors(struct joycon_ctlr *ctlr)
859 for (i = 0; i < 3; i++) {
860 ctlr->imu_cal_accel_divisor[i] = ctlr->accel_cal.scale[i] -
861 ctlr->accel_cal.offset[i];
862 ctlr->imu_cal_gyro_divisor[i] = ctlr->gyro_cal.scale[i] -
863 ctlr->gyro_cal.offset[i];
867 static const s16 DFLT_ACCEL_OFFSET /*= 0*/;
868 static const s16 DFLT_ACCEL_SCALE = 16384;
869 static const s16 DFLT_GYRO_OFFSET /*= 0*/;
870 static const s16 DFLT_GYRO_SCALE = 13371;
871 static int joycon_request_imu_calibration(struct joycon_ctlr *ctlr)
873 u16 imu_cal_addr = JC_IMU_CAL_FCT_DATA_ADDR;
878 /* check if user calibration exists */
879 if (!joycon_check_for_cal_magic(ctlr, JC_IMU_CAL_USR_MAGIC_ADDR)) {
880 imu_cal_addr = JC_IMU_CAL_USR_DATA_ADDR;
881 hid_info(ctlr->hdev, "using user cal for IMU\n");
883 hid_info(ctlr->hdev, "using factory cal for IMU\n");
886 /* request IMU calibration data */
887 hid_dbg(ctlr->hdev, "requesting IMU cal data\n");
888 ret = joycon_request_spi_flash_read(ctlr, imu_cal_addr,
889 JC_IMU_CAL_DATA_SIZE, &raw_cal);
892 "Failed to read IMU cal, using defaults; ret=%d\n",
895 for (i = 0; i < 3; i++) {
896 ctlr->accel_cal.offset[i] = DFLT_ACCEL_OFFSET;
897 ctlr->accel_cal.scale[i] = DFLT_ACCEL_SCALE;
898 ctlr->gyro_cal.offset[i] = DFLT_GYRO_OFFSET;
899 ctlr->gyro_cal.scale[i] = DFLT_GYRO_SCALE;
901 joycon_calc_imu_cal_divisors(ctlr);
905 /* IMU calibration parsing */
906 for (i = 0; i < 3; i++) {
909 ctlr->accel_cal.offset[i] = get_unaligned_le16(raw_cal + j);
910 ctlr->accel_cal.scale[i] = get_unaligned_le16(raw_cal + j + 6);
911 ctlr->gyro_cal.offset[i] = get_unaligned_le16(raw_cal + j + 12);
912 ctlr->gyro_cal.scale[i] = get_unaligned_le16(raw_cal + j + 18);
915 joycon_calc_imu_cal_divisors(ctlr);
917 hid_dbg(ctlr->hdev, "IMU calibration:\n"
918 "a_o[0]=%d a_o[1]=%d a_o[2]=%d\n"
919 "a_s[0]=%d a_s[1]=%d a_s[2]=%d\n"
920 "g_o[0]=%d g_o[1]=%d g_o[2]=%d\n"
921 "g_s[0]=%d g_s[1]=%d g_s[2]=%d\n",
922 ctlr->accel_cal.offset[0],
923 ctlr->accel_cal.offset[1],
924 ctlr->accel_cal.offset[2],
925 ctlr->accel_cal.scale[0],
926 ctlr->accel_cal.scale[1],
927 ctlr->accel_cal.scale[2],
928 ctlr->gyro_cal.offset[0],
929 ctlr->gyro_cal.offset[1],
930 ctlr->gyro_cal.offset[2],
931 ctlr->gyro_cal.scale[0],
932 ctlr->gyro_cal.scale[1],
933 ctlr->gyro_cal.scale[2]);
938 static int joycon_set_report_mode(struct joycon_ctlr *ctlr)
940 struct joycon_subcmd_request *req;
941 u8 buffer[sizeof(*req) + 1] = { 0 };
943 req = (struct joycon_subcmd_request *)buffer;
944 req->subcmd_id = JC_SUBCMD_SET_REPORT_MODE;
945 req->data[0] = 0x30; /* standard, full report mode */
947 hid_dbg(ctlr->hdev, "setting controller report mode\n");
948 return joycon_send_subcmd(ctlr, req, 1, HZ);
951 static int joycon_enable_rumble(struct joycon_ctlr *ctlr)
953 struct joycon_subcmd_request *req;
954 u8 buffer[sizeof(*req) + 1] = { 0 };
956 req = (struct joycon_subcmd_request *)buffer;
957 req->subcmd_id = JC_SUBCMD_ENABLE_VIBRATION;
958 req->data[0] = 0x01; /* note: 0x00 would disable */
960 hid_dbg(ctlr->hdev, "enabling rumble\n");
961 return joycon_send_subcmd(ctlr, req, 1, HZ/4);
964 static int joycon_enable_imu(struct joycon_ctlr *ctlr)
966 struct joycon_subcmd_request *req;
967 u8 buffer[sizeof(*req) + 1] = { 0 };
969 req = (struct joycon_subcmd_request *)buffer;
970 req->subcmd_id = JC_SUBCMD_ENABLE_IMU;
971 req->data[0] = 0x01; /* note: 0x00 would disable */
973 hid_dbg(ctlr->hdev, "enabling IMU\n");
974 return joycon_send_subcmd(ctlr, req, 1, HZ);
977 static s32 joycon_map_stick_val(struct joycon_stick_cal *cal, s32 val)
979 s32 center = cal->center;
985 new_val = (val - center) * JC_MAX_STICK_MAG;
986 new_val /= (max - center);
988 new_val = (center - val) * -JC_MAX_STICK_MAG;
989 new_val /= (center - min);
991 new_val = clamp(new_val, (s32)-JC_MAX_STICK_MAG, (s32)JC_MAX_STICK_MAG);
995 static void joycon_input_report_parse_imu_data(struct joycon_ctlr *ctlr,
996 struct joycon_input_report *rep,
997 struct joycon_imu_data *imu_data)
999 u8 *raw = rep->imu_raw_bytes;
1002 for (i = 0; i < 3; i++) {
1003 struct joycon_imu_data *data = &imu_data[i];
1005 data->accel_x = get_unaligned_le16(raw + 0);
1006 data->accel_y = get_unaligned_le16(raw + 2);
1007 data->accel_z = get_unaligned_le16(raw + 4);
1008 data->gyro_x = get_unaligned_le16(raw + 6);
1009 data->gyro_y = get_unaligned_le16(raw + 8);
1010 data->gyro_z = get_unaligned_le16(raw + 10);
1011 /* point to next imu sample */
1012 raw += sizeof(struct joycon_imu_data);
1016 static void joycon_parse_imu_report(struct joycon_ctlr *ctlr,
1017 struct joycon_input_report *rep)
1019 struct joycon_imu_data imu_data[3] = {0}; /* 3 reports per packet */
1020 struct input_dev *idev = ctlr->imu_input;
1021 unsigned int msecs = jiffies_to_msecs(jiffies);
1022 unsigned int last_msecs = ctlr->imu_last_pkt_ms;
1026 joycon_input_report_parse_imu_data(ctlr, rep, imu_data);
1029 * There are complexities surrounding how we determine the timestamps we
1030 * associate with the samples we pass to userspace. The IMU input
1031 * reports do not provide us with a good timestamp. There's a quickly
1032 * incrementing 8-bit counter per input report, but it is not very
1033 * useful for this purpose (it is not entirely clear what rate it
1034 * increments at or if it varies based on packet push rate - more on
1035 * the push rate below...).
1037 * The reverse engineering work done on the joy-cons and pro controllers
1038 * by the community seems to indicate the following:
1039 * - The controller samples the IMU every 1.35ms. It then does some of
1040 * its own processing, probably averaging the samples out.
1041 * - Each imu input report contains 3 IMU samples, (usually 5ms apart).
1042 * - In the standard reporting mode (which this driver uses exclusively)
1043 * input reports are pushed from the controller as follows:
1044 * * joy-con (bluetooth): every 15 ms
1045 * * joy-cons (in charging grip via USB): every 15 ms
1046 * * pro controller (USB): every 15 ms
1047 * * pro controller (bluetooth): every 8 ms (this is the wildcard)
1049 * Further complicating matters is that some bluetooth stacks are known
1050 * to alter the controller's packet rate by hardcoding the bluetooth
1051 * SSR for the switch controllers (android's stack currently sets the
1052 * SSR to 11ms for both the joy-cons and pro controllers).
1054 * In my own testing, I've discovered that my pro controller either
1055 * reports IMU sample batches every 11ms or every 15ms. This rate is
1056 * stable after connecting. It isn't 100% clear what determines this
1057 * rate. Importantly, even when sending every 11ms, none of the samples
1058 * are duplicates. This seems to indicate that the time deltas between
1059 * reported samples can vary based on the input report rate.
1061 * The solution employed in this driver is to keep track of the average
1062 * time delta between IMU input reports. In testing, this value has
1063 * proven to be stable, staying at 15ms or 11ms, though other hardware
1064 * configurations and bluetooth stacks could potentially see other rates
1065 * (hopefully this will become more clear as more people use the
1068 * Keeping track of the average report delta allows us to submit our
1069 * timestamps to userspace based on that. Each report contains 3
1070 * samples, so the IMU sampling rate should be avg_time_delta/3. We can
1071 * also use this average to detect events where we have dropped a
1072 * packet. The userspace timestamp for the samples will be adjusted
1073 * accordingly to prevent unwanted behvaior.
1075 if (!ctlr->imu_first_packet_received) {
1076 ctlr->imu_timestamp_us = 0;
1077 ctlr->imu_delta_samples_count = 0;
1078 ctlr->imu_delta_samples_sum = 0;
1079 ctlr->imu_avg_delta_ms = JC_IMU_DFLT_AVG_DELTA_MS;
1080 ctlr->imu_first_packet_received = true;
1082 unsigned int delta = msecs - last_msecs;
1083 unsigned int dropped_pkts;
1084 unsigned int dropped_threshold;
1086 /* avg imu report delta housekeeping */
1087 ctlr->imu_delta_samples_sum += delta;
1088 ctlr->imu_delta_samples_count++;
1089 if (ctlr->imu_delta_samples_count >=
1090 JC_IMU_SAMPLES_PER_DELTA_AVG) {
1091 ctlr->imu_avg_delta_ms = ctlr->imu_delta_samples_sum /
1092 ctlr->imu_delta_samples_count;
1093 /* don't ever want divide by zero shenanigans */
1094 if (ctlr->imu_avg_delta_ms == 0) {
1095 ctlr->imu_avg_delta_ms = 1;
1096 hid_warn(ctlr->hdev,
1097 "calculated avg imu delta of 0\n");
1099 ctlr->imu_delta_samples_count = 0;
1100 ctlr->imu_delta_samples_sum = 0;
1103 /* useful for debugging IMU sample rate */
1105 "imu_report: ms=%u last_ms=%u delta=%u avg_delta=%u\n",
1106 msecs, last_msecs, delta, ctlr->imu_avg_delta_ms);
1108 /* check if any packets have been dropped */
1109 dropped_threshold = ctlr->imu_avg_delta_ms * 3 / 2;
1110 dropped_pkts = (delta - min(delta, dropped_threshold)) /
1111 ctlr->imu_avg_delta_ms;
1112 ctlr->imu_timestamp_us += 1000 * ctlr->imu_avg_delta_ms;
1113 if (dropped_pkts > JC_IMU_DROPPED_PKT_WARNING) {
1114 hid_warn(ctlr->hdev,
1115 "compensating for %u dropped IMU reports\n",
1117 hid_warn(ctlr->hdev,
1118 "delta=%u avg_delta=%u\n",
1119 delta, ctlr->imu_avg_delta_ms);
1122 ctlr->imu_last_pkt_ms = msecs;
1124 /* Each IMU input report contains three samples */
1125 for (i = 0; i < 3; i++) {
1126 input_event(idev, EV_MSC, MSC_TIMESTAMP,
1127 ctlr->imu_timestamp_us);
1130 * These calculations (which use the controller's calibration
1131 * settings to improve the final values) are based on those
1132 * found in the community's reverse-engineering repo (linked at
1133 * top of driver). For hid-nintendo, we make sure that the final
1134 * value given to userspace is always in terms of the axis
1135 * resolution we provided.
1137 * Currently only the gyro calculations subtract the calibration
1138 * offsets from the raw value itself. In testing, doing the same
1139 * for the accelerometer raw values decreased accuracy.
1141 * Note that the gyro values are multiplied by the
1142 * precision-saving scaling factor to prevent large inaccuracies
1143 * due to truncation of the resolution value which would
1144 * otherwise occur. To prevent overflow (without resorting to 64
1145 * bit integer math), the mult_frac macro is used.
1147 value[0] = mult_frac((JC_IMU_PREC_RANGE_SCALE *
1148 (imu_data[i].gyro_x -
1149 ctlr->gyro_cal.offset[0])),
1150 ctlr->gyro_cal.scale[0],
1151 ctlr->imu_cal_gyro_divisor[0]);
1152 value[1] = mult_frac((JC_IMU_PREC_RANGE_SCALE *
1153 (imu_data[i].gyro_y -
1154 ctlr->gyro_cal.offset[1])),
1155 ctlr->gyro_cal.scale[1],
1156 ctlr->imu_cal_gyro_divisor[1]);
1157 value[2] = mult_frac((JC_IMU_PREC_RANGE_SCALE *
1158 (imu_data[i].gyro_z -
1159 ctlr->gyro_cal.offset[2])),
1160 ctlr->gyro_cal.scale[2],
1161 ctlr->imu_cal_gyro_divisor[2]);
1163 value[3] = ((s32)imu_data[i].accel_x *
1164 ctlr->accel_cal.scale[0]) /
1165 ctlr->imu_cal_accel_divisor[0];
1166 value[4] = ((s32)imu_data[i].accel_y *
1167 ctlr->accel_cal.scale[1]) /
1168 ctlr->imu_cal_accel_divisor[1];
1169 value[5] = ((s32)imu_data[i].accel_z *
1170 ctlr->accel_cal.scale[2]) /
1171 ctlr->imu_cal_accel_divisor[2];
1173 hid_dbg(ctlr->hdev, "raw_gyro: g_x=%d g_y=%d g_z=%d\n",
1174 imu_data[i].gyro_x, imu_data[i].gyro_y,
1175 imu_data[i].gyro_z);
1176 hid_dbg(ctlr->hdev, "raw_accel: a_x=%d a_y=%d a_z=%d\n",
1177 imu_data[i].accel_x, imu_data[i].accel_y,
1178 imu_data[i].accel_z);
1181 * The right joy-con has 2 axes negated, Y and Z. This is due to
1182 * the orientation of the IMU in the controller. We negate those
1183 * axes' values in order to be consistent with the left joy-con
1184 * and the pro controller:
1185 * X: positive is pointing toward the triggers
1186 * Y: positive is pointing to the left
1187 * Z: positive is pointing up (out of the buttons/sticks)
1188 * The axes follow the right-hand rule.
1190 if (jc_type_is_joycon(ctlr) && jc_type_has_right(ctlr)) {
1193 /* negate all but x axis */
1194 for (j = 1; j < 6; ++j) {
1201 input_report_abs(idev, ABS_RX, value[0]);
1202 input_report_abs(idev, ABS_RY, value[1]);
1203 input_report_abs(idev, ABS_RZ, value[2]);
1204 input_report_abs(idev, ABS_X, value[3]);
1205 input_report_abs(idev, ABS_Y, value[4]);
1206 input_report_abs(idev, ABS_Z, value[5]);
1208 /* convert to micros and divide by 3 (3 samples per report). */
1209 ctlr->imu_timestamp_us += ctlr->imu_avg_delta_ms * 1000 / 3;
1213 static void joycon_parse_report(struct joycon_ctlr *ctlr,
1214 struct joycon_input_report *rep)
1216 struct input_dev *dev = ctlr->input;
1217 unsigned long flags;
1220 unsigned long msecs = jiffies_to_msecs(jiffies);
1222 spin_lock_irqsave(&ctlr->lock, flags);
1223 if (IS_ENABLED(CONFIG_NINTENDO_FF) && rep->vibrator_report &&
1224 (msecs - ctlr->rumble_msecs) >= JC_RUMBLE_PERIOD_MS &&
1225 (ctlr->rumble_queue_head != ctlr->rumble_queue_tail ||
1226 ctlr->rumble_zero_countdown > 0)) {
1228 * When this value reaches 0, we know we've sent multiple
1229 * packets to the controller instructing it to disable rumble.
1230 * We can safely stop sending periodic rumble packets until the
1233 if (ctlr->rumble_zero_countdown > 0)
1234 ctlr->rumble_zero_countdown--;
1235 queue_work(ctlr->rumble_queue, &ctlr->rumble_worker);
1238 /* Parse the battery status */
1240 ctlr->host_powered = tmp & BIT(0);
1241 ctlr->battery_charging = tmp & BIT(4);
1245 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1248 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
1250 case 2: /* medium */
1251 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
1254 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_HIGH;
1257 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1260 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1261 hid_warn(ctlr->hdev, "Invalid battery status\n");
1264 spin_unlock_irqrestore(&ctlr->lock, flags);
1266 /* Parse the buttons and sticks */
1267 btns = hid_field_extract(ctlr->hdev, rep->button_status, 0, 24);
1269 if (jc_type_has_left(ctlr)) {
1275 /* get raw stick values */
1276 raw_x = hid_field_extract(ctlr->hdev, rep->left_stick, 0, 12);
1277 raw_y = hid_field_extract(ctlr->hdev,
1278 rep->left_stick + 1, 4, 12);
1279 /* map the stick values */
1280 x = joycon_map_stick_val(&ctlr->left_stick_cal_x, raw_x);
1281 y = -joycon_map_stick_val(&ctlr->left_stick_cal_y, raw_y);
1283 input_report_abs(dev, ABS_X, x);
1284 input_report_abs(dev, ABS_Y, y);
1286 /* report buttons */
1287 input_report_key(dev, BTN_TL, btns & JC_BTN_L);
1288 input_report_key(dev, BTN_TL2, btns & JC_BTN_ZL);
1289 input_report_key(dev, BTN_SELECT, btns & JC_BTN_MINUS);
1290 input_report_key(dev, BTN_THUMBL, btns & JC_BTN_LSTICK);
1291 input_report_key(dev, BTN_Z, btns & JC_BTN_CAP);
1293 if (jc_type_is_joycon(ctlr)) {
1294 /* Report the S buttons as the non-existent triggers */
1295 input_report_key(dev, BTN_TR, btns & JC_BTN_SL_L);
1296 input_report_key(dev, BTN_TR2, btns & JC_BTN_SR_L);
1298 /* Report d-pad as digital buttons for the joy-cons */
1299 input_report_key(dev, BTN_DPAD_DOWN,
1300 btns & JC_BTN_DOWN);
1301 input_report_key(dev, BTN_DPAD_UP, btns & JC_BTN_UP);
1302 input_report_key(dev, BTN_DPAD_RIGHT,
1303 btns & JC_BTN_RIGHT);
1304 input_report_key(dev, BTN_DPAD_LEFT,
1305 btns & JC_BTN_LEFT);
1311 if (btns & JC_BTN_LEFT)
1313 else if (btns & JC_BTN_RIGHT)
1315 input_report_abs(dev, ABS_HAT0X, hatx);
1318 if (btns & JC_BTN_UP)
1320 else if (btns & JC_BTN_DOWN)
1322 input_report_abs(dev, ABS_HAT0Y, haty);
1325 if (jc_type_has_right(ctlr)) {
1331 /* get raw stick values */
1332 raw_x = hid_field_extract(ctlr->hdev, rep->right_stick, 0, 12);
1333 raw_y = hid_field_extract(ctlr->hdev,
1334 rep->right_stick + 1, 4, 12);
1335 /* map stick values */
1336 x = joycon_map_stick_val(&ctlr->right_stick_cal_x, raw_x);
1337 y = -joycon_map_stick_val(&ctlr->right_stick_cal_y, raw_y);
1339 input_report_abs(dev, ABS_RX, x);
1340 input_report_abs(dev, ABS_RY, y);
1342 /* report buttons */
1343 input_report_key(dev, BTN_TR, btns & JC_BTN_R);
1344 input_report_key(dev, BTN_TR2, btns & JC_BTN_ZR);
1345 if (jc_type_is_joycon(ctlr)) {
1346 /* Report the S buttons as the non-existent triggers */
1347 input_report_key(dev, BTN_TL, btns & JC_BTN_SL_R);
1348 input_report_key(dev, BTN_TL2, btns & JC_BTN_SR_R);
1350 input_report_key(dev, BTN_START, btns & JC_BTN_PLUS);
1351 input_report_key(dev, BTN_THUMBR, btns & JC_BTN_RSTICK);
1352 input_report_key(dev, BTN_MODE, btns & JC_BTN_HOME);
1353 input_report_key(dev, BTN_WEST, btns & JC_BTN_Y);
1354 input_report_key(dev, BTN_NORTH, btns & JC_BTN_X);
1355 input_report_key(dev, BTN_EAST, btns & JC_BTN_A);
1356 input_report_key(dev, BTN_SOUTH, btns & JC_BTN_B);
1362 * Immediately after receiving a report is the most reliable time to
1363 * send a subcommand to the controller. Wake any subcommand senders
1364 * waiting for a report.
1366 if (unlikely(mutex_is_locked(&ctlr->output_mutex))) {
1367 spin_lock_irqsave(&ctlr->lock, flags);
1368 ctlr->received_input_report = true;
1369 spin_unlock_irqrestore(&ctlr->lock, flags);
1370 wake_up(&ctlr->wait);
1373 /* parse IMU data if present */
1374 if (rep->id == JC_INPUT_IMU_DATA)
1375 joycon_parse_imu_report(ctlr, rep);
1378 static int joycon_send_rumble_data(struct joycon_ctlr *ctlr)
1381 unsigned long flags;
1382 struct joycon_rumble_output rumble_output = { 0 };
1384 spin_lock_irqsave(&ctlr->lock, flags);
1386 * If the controller has been removed, just return ENODEV so the LED
1387 * subsystem doesn't print invalid errors on removal.
1389 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_REMOVED) {
1390 spin_unlock_irqrestore(&ctlr->lock, flags);
1393 memcpy(rumble_output.rumble_data,
1394 ctlr->rumble_data[ctlr->rumble_queue_tail],
1395 JC_RUMBLE_DATA_SIZE);
1396 spin_unlock_irqrestore(&ctlr->lock, flags);
1398 rumble_output.output_id = JC_OUTPUT_RUMBLE_ONLY;
1399 rumble_output.packet_num = ctlr->subcmd_num;
1400 if (++ctlr->subcmd_num > 0xF)
1401 ctlr->subcmd_num = 0;
1403 joycon_enforce_subcmd_rate(ctlr);
1405 ret = __joycon_hid_send(ctlr->hdev, (u8 *)&rumble_output,
1406 sizeof(rumble_output));
1410 static void joycon_rumble_worker(struct work_struct *work)
1412 struct joycon_ctlr *ctlr = container_of(work, struct joycon_ctlr,
1414 unsigned long flags;
1419 mutex_lock(&ctlr->output_mutex);
1420 ret = joycon_send_rumble_data(ctlr);
1421 mutex_unlock(&ctlr->output_mutex);
1423 /* -ENODEV means the controller was just unplugged */
1424 spin_lock_irqsave(&ctlr->lock, flags);
1425 if (ret < 0 && ret != -ENODEV &&
1426 ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED)
1427 hid_warn(ctlr->hdev, "Failed to set rumble; e=%d", ret);
1429 ctlr->rumble_msecs = jiffies_to_msecs(jiffies);
1430 if (ctlr->rumble_queue_tail != ctlr->rumble_queue_head) {
1431 if (++ctlr->rumble_queue_tail >= JC_RUMBLE_QUEUE_SIZE)
1432 ctlr->rumble_queue_tail = 0;
1436 spin_unlock_irqrestore(&ctlr->lock, flags);
1440 #if IS_ENABLED(CONFIG_NINTENDO_FF)
1441 static struct joycon_rumble_freq_data joycon_find_rumble_freq(u16 freq)
1443 const size_t length = ARRAY_SIZE(joycon_rumble_frequencies);
1444 const struct joycon_rumble_freq_data *data = joycon_rumble_frequencies;
1447 if (freq > data[0].freq) {
1448 for (i = 1; i < length - 1; i++) {
1449 if (freq > data[i - 1].freq && freq <= data[i].freq)
1457 static struct joycon_rumble_amp_data joycon_find_rumble_amp(u16 amp)
1459 const size_t length = ARRAY_SIZE(joycon_rumble_amplitudes);
1460 const struct joycon_rumble_amp_data *data = joycon_rumble_amplitudes;
1463 if (amp > data[0].amp) {
1464 for (i = 1; i < length - 1; i++) {
1465 if (amp > data[i - 1].amp && amp <= data[i].amp)
1473 static void joycon_encode_rumble(u8 *data, u16 freq_low, u16 freq_high, u16 amp)
1475 struct joycon_rumble_freq_data freq_data_low;
1476 struct joycon_rumble_freq_data freq_data_high;
1477 struct joycon_rumble_amp_data amp_data;
1479 freq_data_low = joycon_find_rumble_freq(freq_low);
1480 freq_data_high = joycon_find_rumble_freq(freq_high);
1481 amp_data = joycon_find_rumble_amp(amp);
1483 data[0] = (freq_data_high.high >> 8) & 0xFF;
1484 data[1] = (freq_data_high.high & 0xFF) + amp_data.high;
1485 data[2] = freq_data_low.low + ((amp_data.low >> 8) & 0xFF);
1486 data[3] = amp_data.low & 0xFF;
1489 static const u16 JOYCON_MAX_RUMBLE_HIGH_FREQ = 1253;
1490 static const u16 JOYCON_MIN_RUMBLE_HIGH_FREQ = 82;
1491 static const u16 JOYCON_MAX_RUMBLE_LOW_FREQ = 626;
1492 static const u16 JOYCON_MIN_RUMBLE_LOW_FREQ = 41;
1494 static void joycon_clamp_rumble_freqs(struct joycon_ctlr *ctlr)
1496 unsigned long flags;
1498 spin_lock_irqsave(&ctlr->lock, flags);
1499 ctlr->rumble_ll_freq = clamp(ctlr->rumble_ll_freq,
1500 JOYCON_MIN_RUMBLE_LOW_FREQ,
1501 JOYCON_MAX_RUMBLE_LOW_FREQ);
1502 ctlr->rumble_lh_freq = clamp(ctlr->rumble_lh_freq,
1503 JOYCON_MIN_RUMBLE_HIGH_FREQ,
1504 JOYCON_MAX_RUMBLE_HIGH_FREQ);
1505 ctlr->rumble_rl_freq = clamp(ctlr->rumble_rl_freq,
1506 JOYCON_MIN_RUMBLE_LOW_FREQ,
1507 JOYCON_MAX_RUMBLE_LOW_FREQ);
1508 ctlr->rumble_rh_freq = clamp(ctlr->rumble_rh_freq,
1509 JOYCON_MIN_RUMBLE_HIGH_FREQ,
1510 JOYCON_MAX_RUMBLE_HIGH_FREQ);
1511 spin_unlock_irqrestore(&ctlr->lock, flags);
1514 static int joycon_set_rumble(struct joycon_ctlr *ctlr, u16 amp_r, u16 amp_l,
1517 u8 data[JC_RUMBLE_DATA_SIZE];
1523 unsigned long flags;
1525 spin_lock_irqsave(&ctlr->lock, flags);
1526 freq_r_low = ctlr->rumble_rl_freq;
1527 freq_r_high = ctlr->rumble_rh_freq;
1528 freq_l_low = ctlr->rumble_ll_freq;
1529 freq_l_high = ctlr->rumble_lh_freq;
1530 /* limit number of silent rumble packets to reduce traffic */
1531 if (amp_l != 0 || amp_r != 0)
1532 ctlr->rumble_zero_countdown = JC_RUMBLE_ZERO_AMP_PKT_CNT;
1533 spin_unlock_irqrestore(&ctlr->lock, flags);
1536 amp = amp_r * (u32)joycon_max_rumble_amp / 65535;
1537 joycon_encode_rumble(data + 4, freq_r_low, freq_r_high, amp);
1540 amp = amp_l * (u32)joycon_max_rumble_amp / 65535;
1541 joycon_encode_rumble(data, freq_l_low, freq_l_high, amp);
1543 spin_lock_irqsave(&ctlr->lock, flags);
1544 if (++ctlr->rumble_queue_head >= JC_RUMBLE_QUEUE_SIZE)
1545 ctlr->rumble_queue_head = 0;
1546 memcpy(ctlr->rumble_data[ctlr->rumble_queue_head], data,
1547 JC_RUMBLE_DATA_SIZE);
1548 spin_unlock_irqrestore(&ctlr->lock, flags);
1550 /* don't wait for the periodic send (reduces latency) */
1552 queue_work(ctlr->rumble_queue, &ctlr->rumble_worker);
1557 static int joycon_play_effect(struct input_dev *dev, void *data,
1558 struct ff_effect *effect)
1560 struct joycon_ctlr *ctlr = input_get_drvdata(dev);
1562 if (effect->type != FF_RUMBLE)
1565 return joycon_set_rumble(ctlr,
1566 effect->u.rumble.weak_magnitude,
1567 effect->u.rumble.strong_magnitude,
1570 #endif /* IS_ENABLED(CONFIG_NINTENDO_FF) */
1572 static const unsigned int joycon_button_inputs_l[] = {
1573 BTN_SELECT, BTN_Z, BTN_THUMBL,
1575 0 /* 0 signals end of array */
1578 static const unsigned int joycon_button_inputs_r[] = {
1579 BTN_START, BTN_MODE, BTN_THUMBR,
1580 BTN_SOUTH, BTN_EAST, BTN_NORTH, BTN_WEST,
1582 0 /* 0 signals end of array */
1585 /* We report joy-con d-pad inputs as buttons and pro controller as a hat. */
1586 static const unsigned int joycon_dpad_inputs_jc[] = {
1587 BTN_DPAD_UP, BTN_DPAD_DOWN, BTN_DPAD_LEFT, BTN_DPAD_RIGHT,
1588 0 /* 0 signals end of array */
1591 static int joycon_input_create(struct joycon_ctlr *ctlr)
1593 struct hid_device *hdev;
1595 const char *imu_name;
1601 switch (hdev->product) {
1602 case USB_DEVICE_ID_NINTENDO_PROCON:
1603 name = "Nintendo Switch Pro Controller";
1604 imu_name = "Nintendo Switch Pro Controller IMU";
1606 case USB_DEVICE_ID_NINTENDO_CHRGGRIP:
1607 if (jc_type_has_left(ctlr)) {
1608 name = "Nintendo Switch Left Joy-Con (Grip)";
1609 imu_name = "Nintendo Switch Left Joy-Con IMU (Grip)";
1611 name = "Nintendo Switch Right Joy-Con (Grip)";
1612 imu_name = "Nintendo Switch Right Joy-Con IMU (Grip)";
1615 case USB_DEVICE_ID_NINTENDO_JOYCONL:
1616 name = "Nintendo Switch Left Joy-Con";
1617 imu_name = "Nintendo Switch Left Joy-Con IMU";
1619 case USB_DEVICE_ID_NINTENDO_JOYCONR:
1620 name = "Nintendo Switch Right Joy-Con";
1621 imu_name = "Nintendo Switch Right Joy-Con IMU";
1623 default: /* Should be impossible */
1624 hid_err(hdev, "Invalid hid product\n");
1628 ctlr->input = devm_input_allocate_device(&hdev->dev);
1631 ctlr->input->id.bustype = hdev->bus;
1632 ctlr->input->id.vendor = hdev->vendor;
1633 ctlr->input->id.product = hdev->product;
1634 ctlr->input->id.version = hdev->version;
1635 ctlr->input->uniq = ctlr->mac_addr_str;
1636 ctlr->input->name = name;
1637 ctlr->input->phys = hdev->phys;
1638 input_set_drvdata(ctlr->input, ctlr);
1640 /* set up sticks and buttons */
1641 if (jc_type_has_left(ctlr)) {
1642 input_set_abs_params(ctlr->input, ABS_X,
1643 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1644 JC_STICK_FUZZ, JC_STICK_FLAT);
1645 input_set_abs_params(ctlr->input, ABS_Y,
1646 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1647 JC_STICK_FUZZ, JC_STICK_FLAT);
1649 for (i = 0; joycon_button_inputs_l[i] > 0; i++)
1650 input_set_capability(ctlr->input, EV_KEY,
1651 joycon_button_inputs_l[i]);
1653 /* configure d-pad differently for joy-con vs pro controller */
1654 if (hdev->product != USB_DEVICE_ID_NINTENDO_PROCON) {
1655 for (i = 0; joycon_dpad_inputs_jc[i] > 0; i++)
1656 input_set_capability(ctlr->input, EV_KEY,
1657 joycon_dpad_inputs_jc[i]);
1659 input_set_abs_params(ctlr->input, ABS_HAT0X,
1660 -JC_MAX_DPAD_MAG, JC_MAX_DPAD_MAG,
1661 JC_DPAD_FUZZ, JC_DPAD_FLAT);
1662 input_set_abs_params(ctlr->input, ABS_HAT0Y,
1663 -JC_MAX_DPAD_MAG, JC_MAX_DPAD_MAG,
1664 JC_DPAD_FUZZ, JC_DPAD_FLAT);
1667 if (jc_type_has_right(ctlr)) {
1668 input_set_abs_params(ctlr->input, ABS_RX,
1669 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1670 JC_STICK_FUZZ, JC_STICK_FLAT);
1671 input_set_abs_params(ctlr->input, ABS_RY,
1672 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1673 JC_STICK_FUZZ, JC_STICK_FLAT);
1675 for (i = 0; joycon_button_inputs_r[i] > 0; i++)
1676 input_set_capability(ctlr->input, EV_KEY,
1677 joycon_button_inputs_r[i]);
1680 /* Let's report joy-con S triggers separately */
1681 if (hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONL) {
1682 input_set_capability(ctlr->input, EV_KEY, BTN_TR);
1683 input_set_capability(ctlr->input, EV_KEY, BTN_TR2);
1684 } else if (hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONR) {
1685 input_set_capability(ctlr->input, EV_KEY, BTN_TL);
1686 input_set_capability(ctlr->input, EV_KEY, BTN_TL2);
1689 #if IS_ENABLED(CONFIG_NINTENDO_FF)
1691 input_set_capability(ctlr->input, EV_FF, FF_RUMBLE);
1692 input_ff_create_memless(ctlr->input, NULL, joycon_play_effect);
1693 ctlr->rumble_ll_freq = JC_RUMBLE_DFLT_LOW_FREQ;
1694 ctlr->rumble_lh_freq = JC_RUMBLE_DFLT_HIGH_FREQ;
1695 ctlr->rumble_rl_freq = JC_RUMBLE_DFLT_LOW_FREQ;
1696 ctlr->rumble_rh_freq = JC_RUMBLE_DFLT_HIGH_FREQ;
1697 joycon_clamp_rumble_freqs(ctlr);
1698 joycon_set_rumble(ctlr, 0, 0, false);
1699 ctlr->rumble_msecs = jiffies_to_msecs(jiffies);
1702 ret = input_register_device(ctlr->input);
1706 /* configure the imu input device */
1707 ctlr->imu_input = devm_input_allocate_device(&hdev->dev);
1708 if (!ctlr->imu_input)
1711 ctlr->imu_input->id.bustype = hdev->bus;
1712 ctlr->imu_input->id.vendor = hdev->vendor;
1713 ctlr->imu_input->id.product = hdev->product;
1714 ctlr->imu_input->id.version = hdev->version;
1715 ctlr->imu_input->uniq = ctlr->mac_addr_str;
1716 ctlr->imu_input->name = imu_name;
1717 ctlr->imu_input->phys = hdev->phys;
1718 input_set_drvdata(ctlr->imu_input, ctlr);
1720 /* configure imu axes */
1721 input_set_abs_params(ctlr->imu_input, ABS_X,
1722 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG,
1723 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT);
1724 input_set_abs_params(ctlr->imu_input, ABS_Y,
1725 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG,
1726 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT);
1727 input_set_abs_params(ctlr->imu_input, ABS_Z,
1728 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG,
1729 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT);
1730 input_abs_set_res(ctlr->imu_input, ABS_X, JC_IMU_ACCEL_RES_PER_G);
1731 input_abs_set_res(ctlr->imu_input, ABS_Y, JC_IMU_ACCEL_RES_PER_G);
1732 input_abs_set_res(ctlr->imu_input, ABS_Z, JC_IMU_ACCEL_RES_PER_G);
1734 input_set_abs_params(ctlr->imu_input, ABS_RX,
1735 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG,
1736 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT);
1737 input_set_abs_params(ctlr->imu_input, ABS_RY,
1738 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG,
1739 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT);
1740 input_set_abs_params(ctlr->imu_input, ABS_RZ,
1741 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG,
1742 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT);
1744 input_abs_set_res(ctlr->imu_input, ABS_RX, JC_IMU_GYRO_RES_PER_DPS);
1745 input_abs_set_res(ctlr->imu_input, ABS_RY, JC_IMU_GYRO_RES_PER_DPS);
1746 input_abs_set_res(ctlr->imu_input, ABS_RZ, JC_IMU_GYRO_RES_PER_DPS);
1748 __set_bit(EV_MSC, ctlr->imu_input->evbit);
1749 __set_bit(MSC_TIMESTAMP, ctlr->imu_input->mscbit);
1750 __set_bit(INPUT_PROP_ACCELEROMETER, ctlr->imu_input->propbit);
1752 ret = input_register_device(ctlr->imu_input);
1759 static int joycon_player_led_brightness_set(struct led_classdev *led,
1760 enum led_brightness brightness)
1762 struct device *dev = led->dev->parent;
1763 struct hid_device *hdev = to_hid_device(dev);
1764 struct joycon_ctlr *ctlr;
1770 ctlr = hid_get_drvdata(hdev);
1772 hid_err(hdev, "No controller data\n");
1776 /* determine which player led this is */
1777 for (num = 0; num < JC_NUM_LEDS; num++) {
1778 if (&ctlr->leds[num] == led)
1781 if (num >= JC_NUM_LEDS)
1784 mutex_lock(&ctlr->output_mutex);
1785 for (i = 0; i < JC_NUM_LEDS; i++) {
1787 val |= brightness << i;
1789 val |= ctlr->leds[i].brightness << i;
1791 ret = joycon_set_player_leds(ctlr, 0, val);
1792 mutex_unlock(&ctlr->output_mutex);
1797 static int joycon_home_led_brightness_set(struct led_classdev *led,
1798 enum led_brightness brightness)
1800 struct device *dev = led->dev->parent;
1801 struct hid_device *hdev = to_hid_device(dev);
1802 struct joycon_ctlr *ctlr;
1803 struct joycon_subcmd_request *req;
1804 u8 buffer[sizeof(*req) + 5] = { 0 };
1808 ctlr = hid_get_drvdata(hdev);
1810 hid_err(hdev, "No controller data\n");
1814 req = (struct joycon_subcmd_request *)buffer;
1815 req->subcmd_id = JC_SUBCMD_SET_HOME_LIGHT;
1818 data[1] = brightness << 4;
1819 data[2] = brightness | (brightness << 4);
1823 hid_dbg(hdev, "setting home led brightness\n");
1824 mutex_lock(&ctlr->output_mutex);
1825 ret = joycon_send_subcmd(ctlr, req, 5, HZ/4);
1826 mutex_unlock(&ctlr->output_mutex);
1831 static DEFINE_MUTEX(joycon_input_num_mutex);
1832 static int joycon_leds_create(struct joycon_ctlr *ctlr)
1834 struct hid_device *hdev = ctlr->hdev;
1835 struct device *dev = &hdev->dev;
1836 const char *d_name = dev_name(dev);
1837 struct led_classdev *led;
1841 static int input_num = 1;
1843 /* Set the default controller player leds based on controller number */
1844 mutex_lock(&joycon_input_num_mutex);
1845 mutex_lock(&ctlr->output_mutex);
1846 ret = joycon_set_player_leds(ctlr, 0, 0xF >> (4 - input_num));
1848 hid_warn(ctlr->hdev, "Failed to set leds; ret=%d\n", ret);
1849 mutex_unlock(&ctlr->output_mutex);
1851 /* configure the player LEDs */
1852 for (i = 0; i < JC_NUM_LEDS; i++) {
1853 name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s:%s",
1856 joycon_player_led_names[i]);
1858 mutex_unlock(&joycon_input_num_mutex);
1862 led = &ctlr->leds[i];
1864 led->brightness = ((i + 1) <= input_num) ? 1 : 0;
1865 led->max_brightness = 1;
1866 led->brightness_set_blocking =
1867 joycon_player_led_brightness_set;
1868 led->flags = LED_CORE_SUSPENDRESUME | LED_HW_PLUGGABLE;
1870 ret = devm_led_classdev_register(&hdev->dev, led);
1872 hid_err(hdev, "Failed registering %s LED\n", led->name);
1873 mutex_unlock(&joycon_input_num_mutex);
1878 if (++input_num > 4)
1880 mutex_unlock(&joycon_input_num_mutex);
1882 /* configure the home LED */
1883 if (jc_type_has_right(ctlr)) {
1884 name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s:%s",
1887 LED_FUNCTION_PLAYER5);
1891 led = &ctlr->home_led;
1893 led->brightness = 0;
1894 led->max_brightness = 0xF;
1895 led->brightness_set_blocking = joycon_home_led_brightness_set;
1896 led->flags = LED_CORE_SUSPENDRESUME | LED_HW_PLUGGABLE;
1897 ret = devm_led_classdev_register(&hdev->dev, led);
1899 hid_err(hdev, "Failed registering home led\n");
1902 /* Set the home LED to 0 as default state */
1903 ret = joycon_home_led_brightness_set(led, 0);
1905 hid_err(hdev, "Failed to set home LED dflt; ret=%d\n",
1914 static int joycon_battery_get_property(struct power_supply *supply,
1915 enum power_supply_property prop,
1916 union power_supply_propval *val)
1918 struct joycon_ctlr *ctlr = power_supply_get_drvdata(supply);
1919 unsigned long flags;
1925 spin_lock_irqsave(&ctlr->lock, flags);
1926 capacity = ctlr->battery_capacity;
1927 charging = ctlr->battery_charging;
1928 powered = ctlr->host_powered;
1929 spin_unlock_irqrestore(&ctlr->lock, flags);
1932 case POWER_SUPPLY_PROP_PRESENT:
1935 case POWER_SUPPLY_PROP_SCOPE:
1936 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1938 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
1939 val->intval = capacity;
1941 case POWER_SUPPLY_PROP_STATUS:
1943 val->intval = POWER_SUPPLY_STATUS_CHARGING;
1944 else if (capacity == POWER_SUPPLY_CAPACITY_LEVEL_FULL &&
1946 val->intval = POWER_SUPPLY_STATUS_FULL;
1948 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
1957 static enum power_supply_property joycon_battery_props[] = {
1958 POWER_SUPPLY_PROP_PRESENT,
1959 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
1960 POWER_SUPPLY_PROP_SCOPE,
1961 POWER_SUPPLY_PROP_STATUS,
1964 static int joycon_power_supply_create(struct joycon_ctlr *ctlr)
1966 struct hid_device *hdev = ctlr->hdev;
1967 struct power_supply_config supply_config = { .drv_data = ctlr, };
1968 const char * const name_fmt = "nintendo_switch_controller_battery_%s";
1971 /* Set initially to unknown before receiving first input report */
1972 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1974 /* Configure the battery's description */
1975 ctlr->battery_desc.properties = joycon_battery_props;
1976 ctlr->battery_desc.num_properties =
1977 ARRAY_SIZE(joycon_battery_props);
1978 ctlr->battery_desc.get_property = joycon_battery_get_property;
1979 ctlr->battery_desc.type = POWER_SUPPLY_TYPE_BATTERY;
1980 ctlr->battery_desc.use_for_apm = 0;
1981 ctlr->battery_desc.name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
1983 dev_name(&hdev->dev));
1984 if (!ctlr->battery_desc.name)
1987 ctlr->battery = devm_power_supply_register(&hdev->dev,
1988 &ctlr->battery_desc,
1990 if (IS_ERR(ctlr->battery)) {
1991 ret = PTR_ERR(ctlr->battery);
1992 hid_err(hdev, "Failed to register battery; ret=%d\n", ret);
1996 return power_supply_powers(ctlr->battery, &hdev->dev);
1999 static int joycon_read_info(struct joycon_ctlr *ctlr)
2004 struct joycon_subcmd_request req = { 0 };
2005 struct joycon_input_report *report;
2007 req.subcmd_id = JC_SUBCMD_REQ_DEV_INFO;
2008 ret = joycon_send_subcmd(ctlr, &req, 0, HZ);
2010 hid_err(ctlr->hdev, "Failed to get joycon info; ret=%d\n", ret);
2014 report = (struct joycon_input_report *)ctlr->input_buf;
2016 for (i = 4, j = 0; j < 6; i++, j++)
2017 ctlr->mac_addr[j] = report->subcmd_reply.data[i];
2019 ctlr->mac_addr_str = devm_kasprintf(&ctlr->hdev->dev, GFP_KERNEL,
2020 "%02X:%02X:%02X:%02X:%02X:%02X",
2027 if (!ctlr->mac_addr_str)
2029 hid_info(ctlr->hdev, "controller MAC = %s\n", ctlr->mac_addr_str);
2031 /* Retrieve the type so we can distinguish for charging grip */
2032 ctlr->ctlr_type = report->subcmd_reply.data[2];
2037 /* Common handler for parsing inputs */
2038 static int joycon_ctlr_read_handler(struct joycon_ctlr *ctlr, u8 *data,
2041 if (data[0] == JC_INPUT_SUBCMD_REPLY || data[0] == JC_INPUT_IMU_DATA ||
2042 data[0] == JC_INPUT_MCU_DATA) {
2043 if (size >= 12) /* make sure it contains the input report */
2044 joycon_parse_report(ctlr,
2045 (struct joycon_input_report *)data);
2051 static int joycon_ctlr_handle_event(struct joycon_ctlr *ctlr, u8 *data,
2056 struct joycon_input_report *report;
2058 if (unlikely(mutex_is_locked(&ctlr->output_mutex)) &&
2059 ctlr->msg_type != JOYCON_MSG_TYPE_NONE) {
2060 switch (ctlr->msg_type) {
2061 case JOYCON_MSG_TYPE_USB:
2064 if (data[0] == JC_INPUT_USB_RESPONSE &&
2065 data[1] == ctlr->usb_ack_match)
2068 case JOYCON_MSG_TYPE_SUBCMD:
2069 if (size < sizeof(struct joycon_input_report) ||
2070 data[0] != JC_INPUT_SUBCMD_REPLY)
2072 report = (struct joycon_input_report *)data;
2073 if (report->subcmd_reply.id == ctlr->subcmd_ack_match)
2081 memcpy(ctlr->input_buf, data,
2082 min(size, (int)JC_MAX_RESP_SIZE));
2083 ctlr->msg_type = JOYCON_MSG_TYPE_NONE;
2084 ctlr->received_resp = true;
2085 wake_up(&ctlr->wait);
2087 /* This message has been handled */
2092 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_READ)
2093 ret = joycon_ctlr_read_handler(ctlr, data, size);
2098 static int nintendo_hid_event(struct hid_device *hdev,
2099 struct hid_report *report, u8 *raw_data, int size)
2101 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev);
2106 return joycon_ctlr_handle_event(ctlr, raw_data, size);
2109 static int nintendo_hid_probe(struct hid_device *hdev,
2110 const struct hid_device_id *id)
2113 struct joycon_ctlr *ctlr;
2115 hid_dbg(hdev, "probe - start\n");
2117 ctlr = devm_kzalloc(&hdev->dev, sizeof(*ctlr), GFP_KERNEL);
2124 ctlr->ctlr_state = JOYCON_CTLR_STATE_INIT;
2125 ctlr->rumble_queue_head = JC_RUMBLE_QUEUE_SIZE - 1;
2126 ctlr->rumble_queue_tail = 0;
2127 hid_set_drvdata(hdev, ctlr);
2128 mutex_init(&ctlr->output_mutex);
2129 init_waitqueue_head(&ctlr->wait);
2130 spin_lock_init(&ctlr->lock);
2131 ctlr->rumble_queue = alloc_workqueue("hid-nintendo-rumble_wq",
2132 WQ_FREEZABLE | WQ_MEM_RECLAIM, 0);
2133 if (!ctlr->rumble_queue) {
2137 INIT_WORK(&ctlr->rumble_worker, joycon_rumble_worker);
2139 ret = hid_parse(hdev);
2141 hid_err(hdev, "HID parse failed\n");
2146 * Patch the hw version of pro controller/joycons, so applications can
2147 * distinguish between the default HID mappings and the mappings defined
2148 * by the Linux game controller spec. This is important for the SDL2
2149 * library, which has a game controller database, which uses device ids
2150 * in combination with version as a key.
2152 hdev->version |= 0x8000;
2154 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
2156 hid_err(hdev, "HW start failed\n");
2160 ret = hid_hw_open(hdev);
2162 hid_err(hdev, "cannot start hardware I/O\n");
2166 hid_device_io_start(hdev);
2168 /* Initialize the controller */
2169 mutex_lock(&ctlr->output_mutex);
2170 /* if handshake command fails, assume ble pro controller */
2171 if ((jc_type_is_procon(ctlr) || jc_type_is_chrggrip(ctlr)) &&
2172 !joycon_send_usb(ctlr, JC_USB_CMD_HANDSHAKE, HZ)) {
2173 hid_dbg(hdev, "detected USB controller\n");
2174 /* set baudrate for improved latency */
2175 ret = joycon_send_usb(ctlr, JC_USB_CMD_BAUDRATE_3M, HZ);
2177 hid_err(hdev, "Failed to set baudrate; ret=%d\n", ret);
2181 ret = joycon_send_usb(ctlr, JC_USB_CMD_HANDSHAKE, HZ);
2183 hid_err(hdev, "Failed handshake; ret=%d\n", ret);
2187 * Set no timeout (to keep controller in USB mode).
2188 * This doesn't send a response, so ignore the timeout.
2190 joycon_send_usb(ctlr, JC_USB_CMD_NO_TIMEOUT, HZ/10);
2191 } else if (jc_type_is_chrggrip(ctlr)) {
2192 hid_err(hdev, "Failed charging grip handshake\n");
2197 /* get controller calibration data, and parse it */
2198 ret = joycon_request_calibration(ctlr);
2201 * We can function with default calibration, but it may be
2202 * inaccurate. Provide a warning, and continue on.
2204 hid_warn(hdev, "Analog stick positions may be inaccurate\n");
2207 /* get IMU calibration data, and parse it */
2208 ret = joycon_request_imu_calibration(ctlr);
2211 * We can function with default calibration, but it may be
2212 * inaccurate. Provide a warning, and continue on.
2214 hid_warn(hdev, "Unable to read IMU calibration data\n");
2217 /* Set the reporting mode to 0x30, which is the full report mode */
2218 ret = joycon_set_report_mode(ctlr);
2220 hid_err(hdev, "Failed to set report mode; ret=%d\n", ret);
2225 ret = joycon_enable_rumble(ctlr);
2227 hid_err(hdev, "Failed to enable rumble; ret=%d\n", ret);
2231 /* Enable the IMU */
2232 ret = joycon_enable_imu(ctlr);
2234 hid_err(hdev, "Failed to enable the IMU; ret=%d\n", ret);
2238 ret = joycon_read_info(ctlr);
2240 hid_err(hdev, "Failed to retrieve controller info; ret=%d\n",
2245 mutex_unlock(&ctlr->output_mutex);
2247 /* Initialize the leds */
2248 ret = joycon_leds_create(ctlr);
2250 hid_err(hdev, "Failed to create leds; ret=%d\n", ret);
2254 /* Initialize the battery power supply */
2255 ret = joycon_power_supply_create(ctlr);
2257 hid_err(hdev, "Failed to create power_supply; ret=%d\n", ret);
2261 ret = joycon_input_create(ctlr);
2263 hid_err(hdev, "Failed to create input device; ret=%d\n", ret);
2267 ctlr->ctlr_state = JOYCON_CTLR_STATE_READ;
2269 hid_dbg(hdev, "probe - success\n");
2273 mutex_unlock(&ctlr->output_mutex);
2279 destroy_workqueue(ctlr->rumble_queue);
2281 hid_err(hdev, "probe - fail = %d\n", ret);
2285 static void nintendo_hid_remove(struct hid_device *hdev)
2287 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev);
2288 unsigned long flags;
2290 hid_dbg(hdev, "remove\n");
2292 /* Prevent further attempts at sending subcommands. */
2293 spin_lock_irqsave(&ctlr->lock, flags);
2294 ctlr->ctlr_state = JOYCON_CTLR_STATE_REMOVED;
2295 spin_unlock_irqrestore(&ctlr->lock, flags);
2297 destroy_workqueue(ctlr->rumble_queue);
2303 static const struct hid_device_id nintendo_hid_devices[] = {
2304 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO,
2305 USB_DEVICE_ID_NINTENDO_PROCON) },
2306 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
2307 USB_DEVICE_ID_NINTENDO_PROCON) },
2308 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO,
2309 USB_DEVICE_ID_NINTENDO_CHRGGRIP) },
2310 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
2311 USB_DEVICE_ID_NINTENDO_JOYCONL) },
2312 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
2313 USB_DEVICE_ID_NINTENDO_JOYCONR) },
2316 MODULE_DEVICE_TABLE(hid, nintendo_hid_devices);
2318 static struct hid_driver nintendo_hid_driver = {
2320 .id_table = nintendo_hid_devices,
2321 .probe = nintendo_hid_probe,
2322 .remove = nintendo_hid_remove,
2323 .raw_event = nintendo_hid_event,
2325 module_hid_driver(nintendo_hid_driver);
2327 MODULE_LICENSE("GPL");
2328 MODULE_AUTHOR("Daniel J. Ogorchock <djogorchock@gmail.com>");
2329 MODULE_DESCRIPTION("Driver for Nintendo Switch Controllers");