projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'ata-6.2-rc7' of git://git.kernel.org/pub/scm/linux/kernel/git/dlemoal...
[linux-block.git] / drivers / hid / hid-nintendo.c
CommitLineData
2af16c1f
DO		 1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * HID driver for Nintendo Switch Joy-Cons and Pro Controllers
4 *
e93363f7 5 * Copyright (c) 2019-2021 Daniel J. Ogorchock <djogorchock@gmail.com>
2af16c1f
DO		 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
c4eae84f 12 * https://github.com/Davidobot/BetterJoyForCemu
2af16c1f
DO		 13 * hid-wiimote kernel hid driver
14 * hid-logitech-hidpp driver
08ebba5c 15 * hid-sony driver
2af16c1f
DO		 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"
83d640c4 26#include <asm/unaligned.h>
2af16c1f
DO		 27#include <linux/delay.h>
28#include <linux/device.h>
4ff5b108 29#include <linux/kernel.h>
2af16c1f
DO		 30#include <linux/hid.h>
31#include <linux/input.h>
c4eae84f 32#include <linux/jiffies.h>
c5e62676 33#include <linux/leds.h>
2af16c1f 34#include <linux/module.h>
08ebba5c 35#include <linux/power_supply.h>
2af16c1f
DO		 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 */
daf11ca2
JK		 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
2af16c1f
DO		 49
50/* Subcommand IDs */
daf11ca2
JK		 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
2af16c1f
DO		 74
75/* Input Reports */
daf11ca2
JK		 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
2af16c1f
DO		 81
82/* Feature Reports */
daf11ca2
JK		 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
2af16c1f
DO		 90
91/* USB Commands */
daf11ca2
JK		 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
2af16c1f 100
83d640c4 101/* Magic value denoting presence of user calibration */
daf11ca2
JK		 102#define JC_CAL_USR_MAGIC_0 0xB2
103#define JC_CAL_USR_MAGIC_1 0xA1
104#define JC_CAL_USR_MAGIC_SIZE 2
83d640c4
DO		 105
106/* SPI storage addresses of user calibration data */
daf11ca2
JK		 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
83d640c4
DO		 112#define JC_CAL_STICK_DATA_SIZE \
113 (JC_CAL_USR_LEFT_DATA_END - JC_CAL_USR_LEFT_DATA_ADDR + 1)
2af16c1f 114
83d640c4 115/* SPI storage addresses of factory calibration data */
daf11ca2
JK		 116#define JC_CAL_FCT_DATA_LEFT_ADDR 0x603d
117#define JC_CAL_FCT_DATA_RIGHT_ADDR 0x6046
2af16c1f 118
4ff5b108 119/* SPI storage addresses of IMU factory calibration data */
daf11ca2
JK		 120#define JC_IMU_CAL_FCT_DATA_ADDR 0x6020
121#define JC_IMU_CAL_FCT_DATA_END 0x6037
4ff5b108
DO		 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 */
daf11ca2
JK		 125#define JC_IMU_CAL_USR_MAGIC_ADDR 0x8026
126#define JC_IMU_CAL_USR_DATA_ADDR 0x8028
4ff5b108 127
2af16c1f 128/* The raw analog joystick values will be mapped in terms of this magnitude */
daf11ca2
JK		 129#define JC_MAX_STICK_MAG 32767
130#define JC_STICK_FUZZ 250
131#define JC_STICK_FLAT 500
2af16c1f
DO		 132
133/* Hat values for pro controller's d-pad */
daf11ca2
JK		 134#define JC_MAX_DPAD_MAG 1
135#define JC_DPAD_FUZZ 0
136#define JC_DPAD_FLAT 0
2af16c1f 137
4ff5b108 138/* Under most circumstances IMU reports are pushed every 15ms; use as default */
daf11ca2 139#define JC_IMU_DFLT_AVG_DELTA_MS 15
4ff5b108 140/* How many samples to sum before calculating average IMU report delta */
daf11ca2 141#define JC_IMU_SAMPLES_PER_DELTA_AVG 300
4ff5b108 142/* Controls how many dropped IMU packets at once trigger a warning message */
daf11ca2 143#define JC_IMU_DROPPED_PKT_WARNING 3
4ff5b108
DO		 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 */
daf11ca2
JK		 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
4ff5b108
DO		 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 */
daf11ca2 172#define JC_IMU_PREC_RANGE_SCALE 1000
4ff5b108 173/* Note: change mag and res_per_dps if prec_range_scale is ever altered */
daf11ca2
JK		 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
4ff5b108 178
c4eae84f
DO		 179/* frequency/amplitude tables for rumble */
180struct joycon_rumble_freq_data {
181 u16 high;
182 u8 low;
183 u16 freq; /* Hz*/
184};
185
186struct joycon_rumble_amp_data {
187 u8 high;
188 u16 low;
189 u16 amp;
190};
191
f61e0639 192#if IS_ENABLED(CONFIG_NINTENDO_FF)
c4eae84f
DO		 193/*
194 * These tables are from
195 * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/rumble_data_table.md
196 */
197static 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)
255static 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};
f61e0639
JK		 293static const u16 JC_RUMBLE_DFLT_LOW_FREQ = 160;
294static const u16 JC_RUMBLE_DFLT_HIGH_FREQ = 320;
92cdfba4 295static const unsigned short JC_RUMBLE_ZERO_AMP_PKT_CNT = 5;
f61e0639
JK		 296#endif /* IS_ENABLED(CONFIG_NINTENDO_FF) */
297static const u16 JC_RUMBLE_PERIOD_MS = 50;
c4eae84f 298
2af16c1f
DO		 299/* States for controller state machine */
300enum joycon_ctlr_state {
301 JOYCON_CTLR_STATE_INIT,
302 JOYCON_CTLR_STATE_READ,
012bd52c 303 JOYCON_CTLR_STATE_REMOVED,
2af16c1f
DO		 304};
305
294a8287
DO		 306/* Controller type received as part of device info */
307enum joycon_ctlr_type {
308 JOYCON_CTLR_TYPE_JCL = 0x01,
309 JOYCON_CTLR_TYPE_JCR = 0x02,
310 JOYCON_CTLR_TYPE_PRO = 0x03,
311};
312
2af16c1f
DO		 313struct joycon_stick_cal {
314 s32 max;
315 s32 min;
316 s32 center;
317};
318
4ff5b108
DO		 319struct joycon_imu_cal {
320 s16 offset[3];
321 s16 scale[3];
322};
323
2af16c1f
DO		 324/*
325 * All the controller's button values are stored in a u32.
326 * They can be accessed with bitwise ANDs.
327 */
328static const u32 JC_BTN_Y = BIT(0);
329static const u32 JC_BTN_X = BIT(1);
330static const u32 JC_BTN_B = BIT(2);
331static const u32 JC_BTN_A = BIT(3);
332static const u32 JC_BTN_SR_R = BIT(4);
333static const u32 JC_BTN_SL_R = BIT(5);
334static const u32 JC_BTN_R = BIT(6);
335static const u32 JC_BTN_ZR = BIT(7);
336static const u32 JC_BTN_MINUS = BIT(8);
337static const u32 JC_BTN_PLUS = BIT(9);
338static const u32 JC_BTN_RSTICK = BIT(10);
339static const u32 JC_BTN_LSTICK = BIT(11);
340static const u32 JC_BTN_HOME = BIT(12);
341static const u32 JC_BTN_CAP = BIT(13); /* capture button */
342static const u32 JC_BTN_DOWN = BIT(16);
343static const u32 JC_BTN_UP = BIT(17);
344static const u32 JC_BTN_RIGHT = BIT(18);
345static const u32 JC_BTN_LEFT = BIT(19);
346static const u32 JC_BTN_SR_L = BIT(20);
347static const u32 JC_BTN_SL_L = BIT(21);
348static const u32 JC_BTN_L = BIT(22);
349static const u32 JC_BTN_ZL = BIT(23);
350
351enum joycon_msg_type {
352 JOYCON_MSG_TYPE_NONE,
353 JOYCON_MSG_TYPE_USB,
354 JOYCON_MSG_TYPE_SUBCMD,
355};
356
4c048f6b
DO		 357struct joycon_rumble_output {
358 u8 output_id;
359 u8 packet_num;
360 u8 rumble_data[8];
361} __packed;
362
2af16c1f
DO		 363struct 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
371struct 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
4ff5b108
DO		 377struct 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
2af16c1f
DO		 386struct 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
4ff5b108
DO		 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 };
2af16c1f
DO		 400} __packed;
401
402#define JC_MAX_RESP_SIZE (sizeof(struct joycon_input_report) + 35)
c4eae84f
DO		 403#define JC_RUMBLE_DATA_SIZE 8
404#define JC_RUMBLE_QUEUE_SIZE 8
405
c5e62676
DO		 406static 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
2af16c1f
DO		 414/* Each physical controller is associated with a joycon_ctlr struct */
415struct joycon_ctlr {
416 struct hid_device *hdev;
417 struct input_dev *input;
697e5c7a
DO		 418 struct led_classdev leds[JC_NUM_LEDS]; /* player leds */
419 struct led_classdev home_led;
2af16c1f 420 enum joycon_ctlr_state ctlr_state;
08ebba5c 421 spinlock_t lock;
14252473
DO		 422 u8 mac_addr[6];
423 char *mac_addr_str;
294a8287 424 enum joycon_ctlr_type ctlr_type;
2af16c1f
DO		 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;
479da173 435 bool received_input_report;
e93363f7 436 unsigned int last_subcmd_sent_msecs;
2af16c1f
DO		 437
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;
443
4ff5b108
DO		 444 struct joycon_imu_cal accel_cal;
445 struct joycon_imu_cal gyro_cal;
446
447 /* prevents needlessly recalculating these divisors every sample */
448 s32 imu_cal_accel_divisor[3];
449 s32 imu_cal_gyro_divisor[3];
450
08ebba5c
DO		 451 /* power supply data */
452 struct power_supply *battery;
453 struct power_supply_desc battery_desc;
454 u8 battery_capacity;
455 bool battery_charging;
456 bool host_powered;
c4eae84f
DO		 457
458 /* rumble */
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;
465 u16 rumble_ll_freq;
466 u16 rumble_lh_freq;
467 u16 rumble_rl_freq;
468 u16 rumble_rh_freq;
dad74e18 469 unsigned short rumble_zero_countdown;
4ff5b108
DO		 470
471 /* imu */
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;
2af16c1f
DO		 480};
481
294a8287
DO		 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)
491
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)
496
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)
501
2af16c1f
DO		 502static int __joycon_hid_send(struct hid_device *hdev, u8 *data, size_t len)
503{
504 u8 *buf;
505 int ret;
506
507 buf = kmemdup(data, len, GFP_KERNEL);
508 if (!buf)
509 return -ENOMEM;
510 ret = hid_hw_output_report(hdev, buf, len);
511 kfree(buf);
512 if (ret < 0)
513 hid_dbg(hdev, "Failed to send output report ret=%d\n", ret);
514 return ret;
515}
516
e93363f7
DO		 517static void joycon_wait_for_input_report(struct joycon_ctlr *ctlr)
518{
519 int ret;
520
521 /*
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.
525 */
526 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_READ) {
527 unsigned long flags;
528
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,
534 HZ / 4);
535 /* We will still proceed, even with a timeout here */
536 if (!ret)
537 hid_warn(ctlr->hdev,
538 "timeout waiting for input report\n");
539 }
540}
541
542/*
543 * Sending subcommands and/or rumble data at too high a rate can cause bluetooth
544 * controller disconnections.
545 */
546static void joycon_enforce_subcmd_rate(struct joycon_ctlr *ctlr)
547{
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;
551
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;
557 }
558 ctlr->last_subcmd_sent_msecs = current_ms;
559}
560
6b5dca2d
DO		 561static int joycon_hid_send_sync(struct joycon_ctlr *ctlr, u8 *data, size_t len,
562 u32 timeout)
2af16c1f
DO		 563{
564 int ret;
6b5dca2d 565 int tries = 2;
2af16c1f 566
6b5dca2d
DO		 567 /*
568 * The controller occasionally seems to drop subcommands. In testing,
569 * doing one retry after a timeout appears to always work.
570 */
571 while (tries--) {
e93363f7 572 joycon_enforce_subcmd_rate(ctlr);
479da173 573
6b5dca2d
DO		 574 ret = __joycon_hid_send(ctlr->hdev, data, len);
575 if (ret < 0) {
576 memset(ctlr->input_buf, 0, JC_MAX_RESP_SIZE);
577 return ret;
578 }
2af16c1f 579
6b5dca2d
DO		 580 ret = wait_event_timeout(ctlr->wait, ctlr->received_resp,
581 timeout);
582 if (!ret) {
583 hid_dbg(ctlr->hdev,
584 "synchronous send/receive timed out\n");
585 if (tries) {
586 hid_dbg(ctlr->hdev,
587 "retrying sync send after timeout\n");
588 }
589 memset(ctlr->input_buf, 0, JC_MAX_RESP_SIZE);
590 ret = -ETIMEDOUT;
591 } else {
592 ret = 0;
593 break;
594 }
2af16c1f
DO		 595 }
596
597 ctlr->received_resp = false;
6b5dca2d 598 return ret;
2af16c1f
DO		 599}
600
6b5dca2d 601static int joycon_send_usb(struct joycon_ctlr *ctlr, u8 cmd, u32 timeout)
2af16c1f
DO		 602{
603 int ret;
604 u8 buf[2] = {JC_OUTPUT_USB_CMD};
605
606 buf[1] = cmd;
607 ctlr->usb_ack_match = cmd;
608 ctlr->msg_type = JOYCON_MSG_TYPE_USB;
6b5dca2d 609 ret = joycon_hid_send_sync(ctlr, buf, sizeof(buf), timeout);
2af16c1f
DO		 610 if (ret)
611 hid_dbg(ctlr->hdev, "send usb command failed; ret=%d\n", ret);
612 return ret;
613}
614
615static int joycon_send_subcmd(struct joycon_ctlr *ctlr,
616 struct joycon_subcmd_request *subcmd,
6b5dca2d 617 size_t data_len, u32 timeout)
2af16c1f
DO		 618{
619 int ret;
c4eae84f
DO		 620 unsigned long flags;
621
622 spin_lock_irqsave(&ctlr->lock, flags);
012bd52c
DO		 623 /*
624 * If the controller has been removed, just return ENODEV so the LED
625 * subsystem doesn't print invalid errors on removal.
626 */
627 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_REMOVED) {
628 spin_unlock_irqrestore(&ctlr->lock, flags);
629 return -ENODEV;
630 }
c4eae84f
DO		 631 memcpy(subcmd->rumble_data, ctlr->rumble_data[ctlr->rumble_queue_tail],
632 JC_RUMBLE_DATA_SIZE);
633 spin_unlock_irqrestore(&ctlr->lock, flags);
2af16c1f
DO		 634
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;
641
642 ret = joycon_hid_send_sync(ctlr, (u8 *)subcmd,
6b5dca2d 643 sizeof(*subcmd) + data_len, timeout);
2af16c1f
DO		 644 if (ret < 0)
645 hid_dbg(ctlr->hdev, "send subcommand failed; ret=%d\n", ret);
646 else
647 ret = 0;
648 return ret;
649}
650
651/* Supply nibbles for flash and on. Ones correspond to active */
652static int joycon_set_player_leds(struct joycon_ctlr *ctlr, u8 flash, u8 on)
653{
654 struct joycon_subcmd_request *req;
655 u8 buffer[sizeof(*req) + 1] = { 0 };
656
657 req = (struct joycon_subcmd_request *)buffer;
658 req->subcmd_id = JC_SUBCMD_SET_PLAYER_LIGHTS;
659 req->data[0] = (flash << 4) | on;
660
661 hid_dbg(ctlr->hdev, "setting player leds\n");
6b5dca2d 662 return joycon_send_subcmd(ctlr, req, 1, HZ/4);
2af16c1f
DO		 663}
664
83d640c4
DO		 665static int joycon_request_spi_flash_read(struct joycon_ctlr *ctlr,
666 u32 start_addr, u8 size, u8 **reply)
2af16c1f
DO		 667{
668 struct joycon_subcmd_request *req;
2af16c1f 669 struct joycon_input_report *report;
83d640c4
DO		 670 u8 buffer[sizeof(*req) + 5] = { 0 };
671 u8 *data;
672 int ret;
673
674 if (!reply)
675 return -EINVAL;
676
677 req = (struct joycon_subcmd_request *)buffer;
678 req->subcmd_id = JC_SUBCMD_SPI_FLASH_READ;
679 data = req->data;
680 put_unaligned_le32(start_addr, data);
681 data[4] = size;
682
683 hid_dbg(ctlr->hdev, "requesting SPI flash data\n");
684 ret = joycon_send_subcmd(ctlr, req, 5, HZ);
685 if (ret) {
686 hid_err(ctlr->hdev, "failed reading SPI flash; ret=%d\n", ret);
687 } else {
688 report = (struct joycon_input_report *)ctlr->input_buf;
689 /* The read data starts at the 6th byte */
4ff5b108 690 *reply = &report->subcmd_reply.data[5];
83d640c4
DO		 691 }
692 return ret;
693}
694
695/*
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
698 */
699static int joycon_check_for_cal_magic(struct joycon_ctlr *ctlr, u32 flash_addr)
700{
701 int ret;
702 u8 *reply;
703
704 ret = joycon_request_spi_flash_read(ctlr, flash_addr,
705 JC_CAL_USR_MAGIC_SIZE, &reply);
706 if (ret)
707 return ret;
708
709 return reply[0] != JC_CAL_USR_MAGIC_0 || reply[1] != JC_CAL_USR_MAGIC_1;
710}
711
712static 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,
715 bool left_stick)
716{
2af16c1f
DO		 717 s32 x_max_above;
718 s32 x_min_below;
719 s32 y_max_above;
720 s32 y_min_below;
2af16c1f
DO		 721 u8 *raw_cal;
722 int ret;
723
83d640c4
DO		 724 ret = joycon_request_spi_flash_read(ctlr, cal_addr,
725 JC_CAL_STICK_DATA_SIZE, &raw_cal);
726 if (ret)
727 return ret;
728
729 /* stick calibration parsing: note the order differs based on stick */
730 if (left_stick) {
731 x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0,
732 12);
733 y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4,
734 12);
735 cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0,
736 12);
737 cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4,
738 12);
739 x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0,
740 12);
741 y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4,
742 12);
743 } else {
744 cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0,
745 12);
746 cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4,
747 12);
748 x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0,
749 12);
750 y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4,
751 12);
752 x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0,
753 12);
754 y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4,
755 12);
756 }
757
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;
762
50503e36
JK		 763 /* check if calibration values are plausible */
764 if (cal_x->min >= cal_x->center || cal_x->center >= cal_x->max ||
765 cal_y->min >= cal_y->center || cal_y->center >= cal_y->max)
766 ret = -EINVAL;
767
768 return ret;
83d640c4
DO		 769}
770
771static const u16 DFLT_STICK_CAL_CEN = 2000;
772static const u16 DFLT_STICK_CAL_MAX = 3500;
773static const u16 DFLT_STICK_CAL_MIN = 500;
50503e36
JK		 774static void joycon_use_default_calibration(struct hid_device *hdev,
775 struct joycon_stick_cal *cal_x,
776 struct joycon_stick_cal *cal_y,
777 const char *stick, int ret)
778{
779 hid_warn(hdev,
780 "Failed to read %s stick cal, using defaults; e=%d\n",
781 stick, ret);
782
783 cal_x->center = cal_y->center = DFLT_STICK_CAL_CEN;
784 cal_x->max = cal_y->max = DFLT_STICK_CAL_MAX;
785 cal_x->min = cal_y->min = DFLT_STICK_CAL_MIN;
786}
787
83d640c4
DO		 788static int joycon_request_calibration(struct joycon_ctlr *ctlr)
789{
790 u16 left_stick_addr = JC_CAL_FCT_DATA_LEFT_ADDR;
791 u16 right_stick_addr = JC_CAL_FCT_DATA_RIGHT_ADDR;
792 int ret;
2af16c1f
DO		 793
794 hid_dbg(ctlr->hdev, "requesting cal data\n");
83d640c4
DO		 795
796 /* check if user stick calibrations are present */
797 if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_LEFT_MAGIC_ADDR)) {
798 left_stick_addr = JC_CAL_USR_LEFT_DATA_ADDR;
799 hid_info(ctlr->hdev, "using user cal for left stick\n");
800 } else {
801 hid_info(ctlr->hdev, "using factory cal for left stick\n");
802 }
803 if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_RIGHT_MAGIC_ADDR)) {
804 right_stick_addr = JC_CAL_USR_RIGHT_DATA_ADDR;
805 hid_info(ctlr->hdev, "using user cal for right stick\n");
806 } else {
807 hid_info(ctlr->hdev, "using factory cal for right stick\n");
808 }
809
810 /* read the left stick calibration data */
811 ret = joycon_read_stick_calibration(ctlr, left_stick_addr,
812 &ctlr->left_stick_cal_x,
813 &ctlr->left_stick_cal_y,
814 true);
2af16c1f 815
50503e36
JK		 816 if (ret)
817 joycon_use_default_calibration(ctlr->hdev,
818 &ctlr->left_stick_cal_x,
819 &ctlr->left_stick_cal_y,
820 "left", ret);
83d640c4
DO		 821
822 /* read the right stick calibration data */
823 ret = joycon_read_stick_calibration(ctlr, right_stick_addr,
824 &ctlr->right_stick_cal_x,
825 &ctlr->right_stick_cal_y,
826 false);
2af16c1f 827
50503e36
JK		 828 if (ret)
829 joycon_use_default_calibration(ctlr->hdev,
830 &ctlr->right_stick_cal_x,
831 &ctlr->right_stick_cal_y,
832 "right", ret);
2af16c1f 833
2af16c1f
DO		 834 hid_dbg(ctlr->hdev, "calibration:\n"
835 "l_x_c=%d l_x_max=%d l_x_min=%d\n"
836 "l_y_c=%d l_y_max=%d l_y_min=%d\n"
837 "r_x_c=%d r_x_max=%d r_x_min=%d\n"
838 "r_y_c=%d r_y_max=%d r_y_min=%d\n",
839 ctlr->left_stick_cal_x.center,
840 ctlr->left_stick_cal_x.max,
841 ctlr->left_stick_cal_x.min,
842 ctlr->left_stick_cal_y.center,
843 ctlr->left_stick_cal_y.max,
844 ctlr->left_stick_cal_y.min,
845 ctlr->right_stick_cal_x.center,
846 ctlr->right_stick_cal_x.max,
847 ctlr->right_stick_cal_x.min,
848 ctlr->right_stick_cal_y.center,
849 ctlr->right_stick_cal_y.max,
850 ctlr->right_stick_cal_y.min);
851
852 return 0;
853}
854
4ff5b108
DO		 855/*
856 * These divisors are calculated once rather than for each sample. They are only
857 * dependent on the IMU calibration values. They are used when processing the
858 * IMU input reports.
859 */
860static void joycon_calc_imu_cal_divisors(struct joycon_ctlr *ctlr)
861{
862 int i;
863
864 for (i = 0; i < 3; i++) {
865 ctlr->imu_cal_accel_divisor[i] = ctlr->accel_cal.scale[i] -
866 ctlr->accel_cal.offset[i];
867 ctlr->imu_cal_gyro_divisor[i] = ctlr->gyro_cal.scale[i] -
868 ctlr->gyro_cal.offset[i];
869 }
870}
871
872static const s16 DFLT_ACCEL_OFFSET /*= 0*/;
873static const s16 DFLT_ACCEL_SCALE = 16384;
874static const s16 DFLT_GYRO_OFFSET /*= 0*/;
875static const s16 DFLT_GYRO_SCALE = 13371;
876static int joycon_request_imu_calibration(struct joycon_ctlr *ctlr)
877{
878 u16 imu_cal_addr = JC_IMU_CAL_FCT_DATA_ADDR;
879 u8 *raw_cal;
880 int ret;
881 int i;
882
883 /* check if user calibration exists */
884 if (!joycon_check_for_cal_magic(ctlr, JC_IMU_CAL_USR_MAGIC_ADDR)) {
885 imu_cal_addr = JC_IMU_CAL_USR_DATA_ADDR;
886 hid_info(ctlr->hdev, "using user cal for IMU\n");
887 } else {
888 hid_info(ctlr->hdev, "using factory cal for IMU\n");
889 }
890
891 /* request IMU calibration data */
892 hid_dbg(ctlr->hdev, "requesting IMU cal data\n");
893 ret = joycon_request_spi_flash_read(ctlr, imu_cal_addr,
894 JC_IMU_CAL_DATA_SIZE, &raw_cal);
895 if (ret) {
896 hid_warn(ctlr->hdev,
897 "Failed to read IMU cal, using defaults; ret=%d\n",
898 ret);
899
900 for (i = 0; i < 3; i++) {
901 ctlr->accel_cal.offset[i] = DFLT_ACCEL_OFFSET;
902 ctlr->accel_cal.scale[i] = DFLT_ACCEL_SCALE;
903 ctlr->gyro_cal.offset[i] = DFLT_GYRO_OFFSET;
904 ctlr->gyro_cal.scale[i] = DFLT_GYRO_SCALE;
905 }
906 joycon_calc_imu_cal_divisors(ctlr);
907 return ret;
908 }
909
910 /* IMU calibration parsing */
911 for (i = 0; i < 3; i++) {
912 int j = i * 2;
913
914 ctlr->accel_cal.offset[i] = get_unaligned_le16(raw_cal + j);
915 ctlr->accel_cal.scale[i] = get_unaligned_le16(raw_cal + j + 6);
916 ctlr->gyro_cal.offset[i] = get_unaligned_le16(raw_cal + j + 12);
917 ctlr->gyro_cal.scale[i] = get_unaligned_le16(raw_cal + j + 18);
918 }
919
920 joycon_calc_imu_cal_divisors(ctlr);
921
922 hid_dbg(ctlr->hdev, "IMU calibration:\n"
923 "a_o[0]=%d a_o[1]=%d a_o[2]=%d\n"
924 "a_s[0]=%d a_s[1]=%d a_s[2]=%d\n"
925 "g_o[0]=%d g_o[1]=%d g_o[2]=%d\n"
926 "g_s[0]=%d g_s[1]=%d g_s[2]=%d\n",
927 ctlr->accel_cal.offset[0],
928 ctlr->accel_cal.offset[1],
929 ctlr->accel_cal.offset[2],
930 ctlr->accel_cal.scale[0],
931 ctlr->accel_cal.scale[1],
932 ctlr->accel_cal.scale[2],
933 ctlr->gyro_cal.offset[0],
934 ctlr->gyro_cal.offset[1],
935 ctlr->gyro_cal.offset[2],
936 ctlr->gyro_cal.scale[0],
937 ctlr->gyro_cal.scale[1],
938 ctlr->gyro_cal.scale[2]);
939
940 return 0;
941}
942
2af16c1f
DO		 943static int joycon_set_report_mode(struct joycon_ctlr *ctlr)
944{
945 struct joycon_subcmd_request *req;
946 u8 buffer[sizeof(*req) + 1] = { 0 };
947
948 req = (struct joycon_subcmd_request *)buffer;
949 req->subcmd_id = JC_SUBCMD_SET_REPORT_MODE;
950 req->data[0] = 0x30; /* standard, full report mode */
951
952 hid_dbg(ctlr->hdev, "setting controller report mode\n");
6b5dca2d 953 return joycon_send_subcmd(ctlr, req, 1, HZ);
2af16c1f
DO		 954}
955
c4eae84f
DO		 956static int joycon_enable_rumble(struct joycon_ctlr *ctlr)
957{
958 struct joycon_subcmd_request *req;
959 u8 buffer[sizeof(*req) + 1] = { 0 };
960
961 req = (struct joycon_subcmd_request *)buffer;
962 req->subcmd_id = JC_SUBCMD_ENABLE_VIBRATION;
963 req->data[0] = 0x01; /* note: 0x00 would disable */
964
965 hid_dbg(ctlr->hdev, "enabling rumble\n");
6b5dca2d 966 return joycon_send_subcmd(ctlr, req, 1, HZ/4);
c4eae84f
DO		 967}
968
4ff5b108
DO		 969static int joycon_enable_imu(struct joycon_ctlr *ctlr)
970{
971 struct joycon_subcmd_request *req;
972 u8 buffer[sizeof(*req) + 1] = { 0 };
973
974 req = (struct joycon_subcmd_request *)buffer;
975 req->subcmd_id = JC_SUBCMD_ENABLE_IMU;
976 req->data[0] = 0x01; /* note: 0x00 would disable */
977
978 hid_dbg(ctlr->hdev, "enabling IMU\n");
979 return joycon_send_subcmd(ctlr, req, 1, HZ);
980}
981
2af16c1f
DO		 982static s32 joycon_map_stick_val(struct joycon_stick_cal *cal, s32 val)
983{
984 s32 center = cal->center;
985 s32 min = cal->min;
986 s32 max = cal->max;
987 s32 new_val;
988
989 if (val > center) {
990 new_val = (val - center) * JC_MAX_STICK_MAG;
991 new_val /= (max - center);
992 } else {
993 new_val = (center - val) * -JC_MAX_STICK_MAG;
994 new_val /= (center - min);
995 }
996 new_val = clamp(new_val, (s32)-JC_MAX_STICK_MAG, (s32)JC_MAX_STICK_MAG);
997 return new_val;
998}
999
4ff5b108
DO		 1000static void joycon_input_report_parse_imu_data(struct joycon_ctlr *ctlr,
1001 struct joycon_input_report *rep,
1002 struct joycon_imu_data *imu_data)
1003{
1004 u8 *raw = rep->imu_raw_bytes;
1005 int i;
1006
1007 for (i = 0; i < 3; i++) {
1008 struct joycon_imu_data *data = &imu_data[i];
1009
1010 data->accel_x = get_unaligned_le16(raw + 0);
1011 data->accel_y = get_unaligned_le16(raw + 2);
1012 data->accel_z = get_unaligned_le16(raw + 4);
1013 data->gyro_x = get_unaligned_le16(raw + 6);
1014 data->gyro_y = get_unaligned_le16(raw + 8);
1015 data->gyro_z = get_unaligned_le16(raw + 10);
1016 /* point to next imu sample */
1017 raw += sizeof(struct joycon_imu_data);
1018 }
1019}
1020
1021static void joycon_parse_imu_report(struct joycon_ctlr *ctlr,
1022 struct joycon_input_report *rep)
1023{
1024 struct joycon_imu_data imu_data[3] = {0}; /* 3 reports per packet */
1025 struct input_dev *idev = ctlr->imu_input;
1026 unsigned int msecs = jiffies_to_msecs(jiffies);
1027 unsigned int last_msecs = ctlr->imu_last_pkt_ms;
1028 int i;
1029 int value[6];
1030
1031 joycon_input_report_parse_imu_data(ctlr, rep, imu_data);
1032
1033 /*
1034 * There are complexities surrounding how we determine the timestamps we
1035 * associate with the samples we pass to userspace. The IMU input
1036 * reports do not provide us with a good timestamp. There's a quickly
1037 * incrementing 8-bit counter per input report, but it is not very
1038 * useful for this purpose (it is not entirely clear what rate it
1039 * increments at or if it varies based on packet push rate - more on
1040 * the push rate below...).
1041 *
1042 * The reverse engineering work done on the joy-cons and pro controllers
1043 * by the community seems to indicate the following:
1044 * - The controller samples the IMU every 1.35ms. It then does some of
1045 * its own processing, probably averaging the samples out.
1046 * - Each imu input report contains 3 IMU samples, (usually 5ms apart).
1047 * - In the standard reporting mode (which this driver uses exclusively)
1048 * input reports are pushed from the controller as follows:
1049 * * joy-con (bluetooth): every 15 ms
1050 * * joy-cons (in charging grip via USB): every 15 ms
1051 * * pro controller (USB): every 15 ms
1052 * * pro controller (bluetooth): every 8 ms (this is the wildcard)
1053 *
1054 * Further complicating matters is that some bluetooth stacks are known
1055 * to alter the controller's packet rate by hardcoding the bluetooth
1056 * SSR for the switch controllers (android's stack currently sets the
1057 * SSR to 11ms for both the joy-cons and pro controllers).
1058 *
1059 * In my own testing, I've discovered that my pro controller either
1060 * reports IMU sample batches every 11ms or every 15ms. This rate is
1061 * stable after connecting. It isn't 100% clear what determines this
1062 * rate. Importantly, even when sending every 11ms, none of the samples
1063 * are duplicates. This seems to indicate that the time deltas between
1064 * reported samples can vary based on the input report rate.
1065 *
1066 * The solution employed in this driver is to keep track of the average
1067 * time delta between IMU input reports. In testing, this value has
1068 * proven to be stable, staying at 15ms or 11ms, though other hardware
1069 * configurations and bluetooth stacks could potentially see other rates
1070 * (hopefully this will become more clear as more people use the
1071 * driver).
1072 *
1073 * Keeping track of the average report delta allows us to submit our
1074 * timestamps to userspace based on that. Each report contains 3
1075 * samples, so the IMU sampling rate should be avg_time_delta/3. We can
1076 * also use this average to detect events where we have dropped a
1077 * packet. The userspace timestamp for the samples will be adjusted
1078 * accordingly to prevent unwanted behvaior.
1079 */
1080 if (!ctlr->imu_first_packet_received) {
1081 ctlr->imu_timestamp_us = 0;
1082 ctlr->imu_delta_samples_count = 0;
1083 ctlr->imu_delta_samples_sum = 0;
1084 ctlr->imu_avg_delta_ms = JC_IMU_DFLT_AVG_DELTA_MS;
1085 ctlr->imu_first_packet_received = true;
1086 } else {
1087 unsigned int delta = msecs - last_msecs;
1088 unsigned int dropped_pkts;
1089 unsigned int dropped_threshold;
1090
1091 /* avg imu report delta housekeeping */
1092 ctlr->imu_delta_samples_sum += delta;
1093 ctlr->imu_delta_samples_count++;
1094 if (ctlr->imu_delta_samples_count >=
1095 JC_IMU_SAMPLES_PER_DELTA_AVG) {
1096 ctlr->imu_avg_delta_ms = ctlr->imu_delta_samples_sum /
1097 ctlr->imu_delta_samples_count;
1098 /* don't ever want divide by zero shenanigans */
1099 if (ctlr->imu_avg_delta_ms == 0) {
1100 ctlr->imu_avg_delta_ms = 1;
1101 hid_warn(ctlr->hdev,
1102 "calculated avg imu delta of 0\n");
1103 }
1104 ctlr->imu_delta_samples_count = 0;
1105 ctlr->imu_delta_samples_sum = 0;
1106 }
1107
1108 /* useful for debugging IMU sample rate */
1109 hid_dbg(ctlr->hdev,
1110 "imu_report: ms=%u last_ms=%u delta=%u avg_delta=%u\n",
1111 msecs, last_msecs, delta, ctlr->imu_avg_delta_ms);
1112
1113 /* check if any packets have been dropped */
1114 dropped_threshold = ctlr->imu_avg_delta_ms * 3 / 2;
1115 dropped_pkts = (delta - min(delta, dropped_threshold)) /
1116 ctlr->imu_avg_delta_ms;
1117 ctlr->imu_timestamp_us += 1000 * ctlr->imu_avg_delta_ms;
1118 if (dropped_pkts > JC_IMU_DROPPED_PKT_WARNING) {
1119 hid_warn(ctlr->hdev,
1120 "compensating for %u dropped IMU reports\n",
1121 dropped_pkts);
1122 hid_warn(ctlr->hdev,
1123 "delta=%u avg_delta=%u\n",
1124 delta, ctlr->imu_avg_delta_ms);
1125 }
1126 }
1127 ctlr->imu_last_pkt_ms = msecs;
1128
1129 /* Each IMU input report contains three samples */
1130 for (i = 0; i < 3; i++) {
1131 input_event(idev, EV_MSC, MSC_TIMESTAMP,
1132 ctlr->imu_timestamp_us);
1133
1134 /*
1135 * These calculations (which use the controller's calibration
1136 * settings to improve the final values) are based on those
1137 * found in the community's reverse-engineering repo (linked at
1138 * top of driver). For hid-nintendo, we make sure that the final
1139 * value given to userspace is always in terms of the axis
1140 * resolution we provided.
1141 *
1142 * Currently only the gyro calculations subtract the calibration
1143 * offsets from the raw value itself. In testing, doing the same
1144 * for the accelerometer raw values decreased accuracy.
1145 *
1146 * Note that the gyro values are multiplied by the
1147 * precision-saving scaling factor to prevent large inaccuracies
1148 * due to truncation of the resolution value which would
1149 * otherwise occur. To prevent overflow (without resorting to 64
1150 * bit integer math), the mult_frac macro is used.
1151 */
1152 value[0] = mult_frac((JC_IMU_PREC_RANGE_SCALE *
1153 (imu_data[i].gyro_x -
1154 ctlr->gyro_cal.offset[0])),
1155 ctlr->gyro_cal.scale[0],
1156 ctlr->imu_cal_gyro_divisor[0]);
1157 value[1] = mult_frac((JC_IMU_PREC_RANGE_SCALE *
1158 (imu_data[i].gyro_y -
1159 ctlr->gyro_cal.offset[1])),
1160 ctlr->gyro_cal.scale[1],
1161 ctlr->imu_cal_gyro_divisor[1]);
1162 value[2] = mult_frac((JC_IMU_PREC_RANGE_SCALE *
1163 (imu_data[i].gyro_z -
1164 ctlr->gyro_cal.offset[2])),
1165 ctlr->gyro_cal.scale[2],
1166 ctlr->imu_cal_gyro_divisor[2]);
1167
1168 value[3] = ((s32)imu_data[i].accel_x *
1169 ctlr->accel_cal.scale[0]) /
1170 ctlr->imu_cal_accel_divisor[0];
1171 value[4] = ((s32)imu_data[i].accel_y *
1172 ctlr->accel_cal.scale[1]) /
1173 ctlr->imu_cal_accel_divisor[1];
1174 value[5] = ((s32)imu_data[i].accel_z *
1175 ctlr->accel_cal.scale[2]) /
1176 ctlr->imu_cal_accel_divisor[2];
1177
1178 hid_dbg(ctlr->hdev, "raw_gyro: g_x=%d g_y=%d g_z=%d\n",
1179 imu_data[i].gyro_x, imu_data[i].gyro_y,
1180 imu_data[i].gyro_z);
1181 hid_dbg(ctlr->hdev, "raw_accel: a_x=%d a_y=%d a_z=%d\n",
1182 imu_data[i].accel_x, imu_data[i].accel_y,
1183 imu_data[i].accel_z);
1184
1185 /*
1186 * The right joy-con has 2 axes negated, Y and Z. This is due to
1187 * the orientation of the IMU in the controller. We negate those
1188 * axes' values in order to be consistent with the left joy-con
1189 * and the pro controller:
1190 * X: positive is pointing toward the triggers
1191 * Y: positive is pointing to the left
1192 * Z: positive is pointing up (out of the buttons/sticks)
1193 * The axes follow the right-hand rule.
1194 */
1195 if (jc_type_is_joycon(ctlr) && jc_type_has_right(ctlr)) {
1196 int j;
1197
1198 /* negate all but x axis */
1199 for (j = 1; j < 6; ++j) {
1200 if (j == 3)
1201 continue;
1202 value[j] *= -1;
1203 }
1204 }
1205
1206 input_report_abs(idev, ABS_RX, value[0]);
1207 input_report_abs(idev, ABS_RY, value[1]);
1208 input_report_abs(idev, ABS_RZ, value[2]);
1209 input_report_abs(idev, ABS_X, value[3]);
1210 input_report_abs(idev, ABS_Y, value[4]);
1211 input_report_abs(idev, ABS_Z, value[5]);
1212 input_sync(idev);
1213 /* convert to micros and divide by 3 (3 samples per report). */
1214 ctlr->imu_timestamp_us += ctlr->imu_avg_delta_ms * 1000 / 3;
1215 }
1216}
1217
2af16c1f
DO		 1218static void joycon_parse_report(struct joycon_ctlr *ctlr,
1219 struct joycon_input_report *rep)
1220{
1221 struct input_dev *dev = ctlr->input;
08ebba5c
DO		 1222 unsigned long flags;
1223 u8 tmp;
2af16c1f 1224 u32 btns;
c4eae84f
DO		 1225 unsigned long msecs = jiffies_to_msecs(jiffies);
1226
1227 spin_lock_irqsave(&ctlr->lock, flags);
1228 if (IS_ENABLED(CONFIG_NINTENDO_FF) && rep->vibrator_report &&
1ff89e06 1229 ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED &&
dad74e18
DO		 1230 (msecs - ctlr->rumble_msecs) >= JC_RUMBLE_PERIOD_MS &&
1231 (ctlr->rumble_queue_head != ctlr->rumble_queue_tail ||
1232 ctlr->rumble_zero_countdown > 0)) {
1233 /*
1234 * When this value reaches 0, we know we've sent multiple
1235 * packets to the controller instructing it to disable rumble.
1236 * We can safely stop sending periodic rumble packets until the
1237 * next ff effect.
1238 */
1239 if (ctlr->rumble_zero_countdown > 0)
1240 ctlr->rumble_zero_countdown--;
c4eae84f 1241 queue_work(ctlr->rumble_queue, &ctlr->rumble_worker);
dad74e18 1242 }
2af16c1f 1243
08ebba5c
DO		 1244 /* Parse the battery status */
1245 tmp = rep->bat_con;
08ebba5c
DO		 1246 ctlr->host_powered = tmp & BIT(0);
1247 ctlr->battery_charging = tmp & BIT(4);
1248 tmp = tmp >> 5;
1249 switch (tmp) {
1250 case 0: /* empty */
1251 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1252 break;
1253 case 1: /* low */
1254 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
1255 break;
1256 case 2: /* medium */
1257 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
1258 break;
1259 case 3: /* high */
1260 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_HIGH;
1261 break;
1262 case 4: /* full */
1263 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1264 break;
1265 default:
1266 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1267 hid_warn(ctlr->hdev, "Invalid battery status\n");
1268 break;
1269 }
1270 spin_unlock_irqrestore(&ctlr->lock, flags);
1271
1272 /* Parse the buttons and sticks */
2af16c1f
DO		 1273 btns = hid_field_extract(ctlr->hdev, rep->button_status, 0, 24);
1274
294a8287 1275 if (jc_type_has_left(ctlr)) {
2af16c1f
DO		 1276 u16 raw_x;
1277 u16 raw_y;
1278 s32 x;
1279 s32 y;
1280
1281 /* get raw stick values */
1282 raw_x = hid_field_extract(ctlr->hdev, rep->left_stick, 0, 12);
1283 raw_y = hid_field_extract(ctlr->hdev,
1284 rep->left_stick + 1, 4, 12);
1285 /* map the stick values */
1286 x = joycon_map_stick_val(&ctlr->left_stick_cal_x, raw_x);
1287 y = -joycon_map_stick_val(&ctlr->left_stick_cal_y, raw_y);
1288 /* report sticks */
1289 input_report_abs(dev, ABS_X, x);
1290 input_report_abs(dev, ABS_Y, y);
1291
1292 /* report buttons */
1293 input_report_key(dev, BTN_TL, btns & JC_BTN_L);
1294 input_report_key(dev, BTN_TL2, btns & JC_BTN_ZL);
1295 input_report_key(dev, BTN_SELECT, btns & JC_BTN_MINUS);
1296 input_report_key(dev, BTN_THUMBL, btns & JC_BTN_LSTICK);
1297 input_report_key(dev, BTN_Z, btns & JC_BTN_CAP);
1298
294a8287 1299 if (jc_type_is_joycon(ctlr)) {
2af16c1f
DO		 1300 /* Report the S buttons as the non-existent triggers */
1301 input_report_key(dev, BTN_TR, btns & JC_BTN_SL_L);
1302 input_report_key(dev, BTN_TR2, btns & JC_BTN_SR_L);
1303
1304 /* Report d-pad as digital buttons for the joy-cons */
1305 input_report_key(dev, BTN_DPAD_DOWN,
1306 btns & JC_BTN_DOWN);
1307 input_report_key(dev, BTN_DPAD_UP, btns & JC_BTN_UP);
1308 input_report_key(dev, BTN_DPAD_RIGHT,
1309 btns & JC_BTN_RIGHT);
1310 input_report_key(dev, BTN_DPAD_LEFT,
1311 btns & JC_BTN_LEFT);
1312 } else {
1313 int hatx = 0;
1314 int haty = 0;
1315
1316 /* d-pad x */
1317 if (btns & JC_BTN_LEFT)
1318 hatx = -1;
1319 else if (btns & JC_BTN_RIGHT)
1320 hatx = 1;
1321 input_report_abs(dev, ABS_HAT0X, hatx);
1322
1323 /* d-pad y */
1324 if (btns & JC_BTN_UP)
1325 haty = -1;
1326 else if (btns & JC_BTN_DOWN)
1327 haty = 1;
1328 input_report_abs(dev, ABS_HAT0Y, haty);
1329 }
1330 }
294a8287 1331 if (jc_type_has_right(ctlr)) {
2af16c1f
DO		 1332 u16 raw_x;
1333 u16 raw_y;
1334 s32 x;
1335 s32 y;
1336
1337 /* get raw stick values */
1338 raw_x = hid_field_extract(ctlr->hdev, rep->right_stick, 0, 12);
1339 raw_y = hid_field_extract(ctlr->hdev,
1340 rep->right_stick + 1, 4, 12);
1341 /* map stick values */
1342 x = joycon_map_stick_val(&ctlr->right_stick_cal_x, raw_x);
1343 y = -joycon_map_stick_val(&ctlr->right_stick_cal_y, raw_y);
1344 /* report sticks */
1345 input_report_abs(dev, ABS_RX, x);
1346 input_report_abs(dev, ABS_RY, y);
1347
1348 /* report buttons */
1349 input_report_key(dev, BTN_TR, btns & JC_BTN_R);
1350 input_report_key(dev, BTN_TR2, btns & JC_BTN_ZR);
294a8287 1351 if (jc_type_is_joycon(ctlr)) {
2af16c1f
DO		 1352 /* Report the S buttons as the non-existent triggers */
1353 input_report_key(dev, BTN_TL, btns & JC_BTN_SL_R);
1354 input_report_key(dev, BTN_TL2, btns & JC_BTN_SR_R);
1355 }
1356 input_report_key(dev, BTN_START, btns & JC_BTN_PLUS);
1357 input_report_key(dev, BTN_THUMBR, btns & JC_BTN_RSTICK);
1358 input_report_key(dev, BTN_MODE, btns & JC_BTN_HOME);
1359 input_report_key(dev, BTN_WEST, btns & JC_BTN_Y);
1360 input_report_key(dev, BTN_NORTH, btns & JC_BTN_X);
1361 input_report_key(dev, BTN_EAST, btns & JC_BTN_A);
1362 input_report_key(dev, BTN_SOUTH, btns & JC_BTN_B);
1363 }
1364
1365 input_sync(dev);
479da173
DO		 1366
1367 /*
1368 * Immediately after receiving a report is the most reliable time to
1369 * send a subcommand to the controller. Wake any subcommand senders
1370 * waiting for a report.
1371 */
1372 if (unlikely(mutex_is_locked(&ctlr->output_mutex))) {
1373 spin_lock_irqsave(&ctlr->lock, flags);
1374 ctlr->received_input_report = true;
1375 spin_unlock_irqrestore(&ctlr->lock, flags);
1376 wake_up(&ctlr->wait);
1377 }
4ff5b108
DO		 1378
1379 /* parse IMU data if present */
1380 if (rep->id == JC_INPUT_IMU_DATA)
1381 joycon_parse_imu_report(ctlr, rep);
2af16c1f
DO		 1382}
1383
4c048f6b
DO		 1384static int joycon_send_rumble_data(struct joycon_ctlr *ctlr)
1385{
1386 int ret;
1387 unsigned long flags;
1388 struct joycon_rumble_output rumble_output = { 0 };
1389
1390 spin_lock_irqsave(&ctlr->lock, flags);
1391 /*
1392 * If the controller has been removed, just return ENODEV so the LED
1393 * subsystem doesn't print invalid errors on removal.
1394 */
1395 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_REMOVED) {
1396 spin_unlock_irqrestore(&ctlr->lock, flags);
1397 return -ENODEV;
1398 }
1399 memcpy(rumble_output.rumble_data,
1400 ctlr->rumble_data[ctlr->rumble_queue_tail],
1401 JC_RUMBLE_DATA_SIZE);
1402 spin_unlock_irqrestore(&ctlr->lock, flags);
1403
1404 rumble_output.output_id = JC_OUTPUT_RUMBLE_ONLY;
1405 rumble_output.packet_num = ctlr->subcmd_num;
1406 if (++ctlr->subcmd_num > 0xF)
1407 ctlr->subcmd_num = 0;
1408
e93363f7
DO		 1409 joycon_enforce_subcmd_rate(ctlr);
1410
4c048f6b
DO		 1411 ret = __joycon_hid_send(ctlr->hdev, (u8 *)&rumble_output,
1412 sizeof(rumble_output));
1413 return ret;
1414}
1415
c4eae84f
DO		 1416static void joycon_rumble_worker(struct work_struct *work)
1417{
1418 struct joycon_ctlr *ctlr = container_of(work, struct joycon_ctlr,
1419 rumble_worker);
1420 unsigned long flags;
1421 bool again = true;
1422 int ret;
1423
1424 while (again) {
1425 mutex_lock(&ctlr->output_mutex);
4c048f6b 1426 ret = joycon_send_rumble_data(ctlr);
c4eae84f 1427 mutex_unlock(&ctlr->output_mutex);
c4eae84f 1428
012bd52c 1429 /* -ENODEV means the controller was just unplugged */
c4eae84f 1430 spin_lock_irqsave(&ctlr->lock, flags);
012bd52c
DO		 1431 if (ret < 0 && ret != -ENODEV &&
1432 ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED)
1433 hid_warn(ctlr->hdev, "Failed to set rumble; e=%d", ret);
1434
c4eae84f
DO		 1435 ctlr->rumble_msecs = jiffies_to_msecs(jiffies);
1436 if (ctlr->rumble_queue_tail != ctlr->rumble_queue_head) {
1437 if (++ctlr->rumble_queue_tail >= JC_RUMBLE_QUEUE_SIZE)
1438 ctlr->rumble_queue_tail = 0;
1439 } else {
1440 again = false;
1441 }
1442 spin_unlock_irqrestore(&ctlr->lock, flags);
1443 }
1444}
1445
1446#if IS_ENABLED(CONFIG_NINTENDO_FF)
1447static struct joycon_rumble_freq_data joycon_find_rumble_freq(u16 freq)
1448{
1449 const size_t length = ARRAY_SIZE(joycon_rumble_frequencies);
1450 const struct joycon_rumble_freq_data *data = joycon_rumble_frequencies;
1451 int i = 0;
1452
1453 if (freq > data[0].freq) {
1454 for (i = 1; i < length - 1; i++) {
1455 if (freq > data[i - 1].freq && freq <= data[i].freq)
1456 break;
1457 }
1458 }
1459
1460 return data[i];
1461}
1462
1463static struct joycon_rumble_amp_data joycon_find_rumble_amp(u16 amp)
1464{
1465 const size_t length = ARRAY_SIZE(joycon_rumble_amplitudes);
1466 const struct joycon_rumble_amp_data *data = joycon_rumble_amplitudes;
1467 int i = 0;
1468
1469 if (amp > data[0].amp) {
1470 for (i = 1; i < length - 1; i++) {
1471 if (amp > data[i - 1].amp && amp <= data[i].amp)
1472 break;
1473 }
1474 }
1475
1476 return data[i];
1477}
1478
1479static void joycon_encode_rumble(u8 *data, u16 freq_low, u16 freq_high, u16 amp)
1480{
1481 struct joycon_rumble_freq_data freq_data_low;
1482 struct joycon_rumble_freq_data freq_data_high;
1483 struct joycon_rumble_amp_data amp_data;
1484
1485 freq_data_low = joycon_find_rumble_freq(freq_low);
1486 freq_data_high = joycon_find_rumble_freq(freq_high);
1487 amp_data = joycon_find_rumble_amp(amp);
1488
1489 data[0] = (freq_data_high.high >> 8) & 0xFF;
1490 data[1] = (freq_data_high.high & 0xFF) + amp_data.high;
1491 data[2] = freq_data_low.low + ((amp_data.low >> 8) & 0xFF);
1492 data[3] = amp_data.low & 0xFF;
1493}
1494
1495static const u16 JOYCON_MAX_RUMBLE_HIGH_FREQ = 1253;
1496static const u16 JOYCON_MIN_RUMBLE_HIGH_FREQ = 82;
1497static const u16 JOYCON_MAX_RUMBLE_LOW_FREQ = 626;
1498static const u16 JOYCON_MIN_RUMBLE_LOW_FREQ = 41;
1499
1500static void joycon_clamp_rumble_freqs(struct joycon_ctlr *ctlr)
1501{
1502 unsigned long flags;
1503
1504 spin_lock_irqsave(&ctlr->lock, flags);
1505 ctlr->rumble_ll_freq = clamp(ctlr->rumble_ll_freq,
1506 JOYCON_MIN_RUMBLE_LOW_FREQ,
1507 JOYCON_MAX_RUMBLE_LOW_FREQ);
1508 ctlr->rumble_lh_freq = clamp(ctlr->rumble_lh_freq,
1509 JOYCON_MIN_RUMBLE_HIGH_FREQ,
1510 JOYCON_MAX_RUMBLE_HIGH_FREQ);
1511 ctlr->rumble_rl_freq = clamp(ctlr->rumble_rl_freq,
1512 JOYCON_MIN_RUMBLE_LOW_FREQ,
1513 JOYCON_MAX_RUMBLE_LOW_FREQ);
1514 ctlr->rumble_rh_freq = clamp(ctlr->rumble_rh_freq,
1515 JOYCON_MIN_RUMBLE_HIGH_FREQ,
1516 JOYCON_MAX_RUMBLE_HIGH_FREQ);
1517 spin_unlock_irqrestore(&ctlr->lock, flags);
1518}
1519
1520static int joycon_set_rumble(struct joycon_ctlr *ctlr, u16 amp_r, u16 amp_l,
1521 bool schedule_now)
1522{
1523 u8 data[JC_RUMBLE_DATA_SIZE];
1524 u16 amp;
1525 u16 freq_r_low;
1526 u16 freq_r_high;
1527 u16 freq_l_low;
1528 u16 freq_l_high;
1529 unsigned long flags;
1530
1531 spin_lock_irqsave(&ctlr->lock, flags);
1532 freq_r_low = ctlr->rumble_rl_freq;
1533 freq_r_high = ctlr->rumble_rh_freq;
1534 freq_l_low = ctlr->rumble_ll_freq;
1535 freq_l_high = ctlr->rumble_lh_freq;
dad74e18
DO		 1536 /* limit number of silent rumble packets to reduce traffic */
1537 if (amp_l != 0 || amp_r != 0)
1538 ctlr->rumble_zero_countdown = JC_RUMBLE_ZERO_AMP_PKT_CNT;
c4eae84f
DO		 1539 spin_unlock_irqrestore(&ctlr->lock, flags);
1540
1541 /* right joy-con */
1542 amp = amp_r * (u32)joycon_max_rumble_amp / 65535;
1543 joycon_encode_rumble(data + 4, freq_r_low, freq_r_high, amp);
1544
1545 /* left joy-con */
1546 amp = amp_l * (u32)joycon_max_rumble_amp / 65535;
1547 joycon_encode_rumble(data, freq_l_low, freq_l_high, amp);
1548
1549 spin_lock_irqsave(&ctlr->lock, flags);
1550 if (++ctlr->rumble_queue_head >= JC_RUMBLE_QUEUE_SIZE)
1551 ctlr->rumble_queue_head = 0;
1552 memcpy(ctlr->rumble_data[ctlr->rumble_queue_head], data,
1553 JC_RUMBLE_DATA_SIZE);
c4eae84f
DO		 1554
1555 /* don't wait for the periodic send (reduces latency) */
1ff89e06 1556 if (schedule_now && ctlr->ctlr_state != JOYCON_CTLR_STATE_REMOVED)
c4eae84f
DO		 1557 queue_work(ctlr->rumble_queue, &ctlr->rumble_worker);
1558
1ff89e06
DO		 1559 spin_unlock_irqrestore(&ctlr->lock, flags);
1560
c4eae84f
DO		 1561 return 0;
1562}
1563
1564static int joycon_play_effect(struct input_dev *dev, void *data,
1565 struct ff_effect *effect)
1566{
1567 struct joycon_ctlr *ctlr = input_get_drvdata(dev);
1568
1569 if (effect->type != FF_RUMBLE)
1570 return 0;
1571
1572 return joycon_set_rumble(ctlr,
1573 effect->u.rumble.weak_magnitude,
1574 effect->u.rumble.strong_magnitude,
1575 true);
1576}
1577#endif /* IS_ENABLED(CONFIG_NINTENDO_FF) */
2af16c1f
DO		 1578
1579static const unsigned int joycon_button_inputs_l[] = {
1580 BTN_SELECT, BTN_Z, BTN_THUMBL,
1581 BTN_TL, BTN_TL2,
1582 0 /* 0 signals end of array */
1583};
1584
1585static const unsigned int joycon_button_inputs_r[] = {
1586 BTN_START, BTN_MODE, BTN_THUMBR,
1587 BTN_SOUTH, BTN_EAST, BTN_NORTH, BTN_WEST,
1588 BTN_TR, BTN_TR2,
1589 0 /* 0 signals end of array */
1590};
1591
1592/* We report joy-con d-pad inputs as buttons and pro controller as a hat. */
1593static const unsigned int joycon_dpad_inputs_jc[] = {
1594 BTN_DPAD_UP, BTN_DPAD_DOWN, BTN_DPAD_LEFT, BTN_DPAD_RIGHT,
ab5f3404 1595 0 /* 0 signals end of array */
2af16c1f
DO		 1596};
1597
2af16c1f
DO		 1598static int joycon_input_create(struct joycon_ctlr *ctlr)
1599{
1600 struct hid_device *hdev;
2af16c1f 1601 const char *name;
4ff5b108 1602 const char *imu_name;
2af16c1f
DO		 1603 int ret;
1604 int i;
1605
1606 hdev = ctlr->hdev;
1607
1608 switch (hdev->product) {
1609 case USB_DEVICE_ID_NINTENDO_PROCON:
1610 name = "Nintendo Switch Pro Controller";
4ff5b108 1611 imu_name = "Nintendo Switch Pro Controller IMU";
2af16c1f 1612 break;
294a8287 1613 case USB_DEVICE_ID_NINTENDO_CHRGGRIP:
4ff5b108 1614 if (jc_type_has_left(ctlr)) {
294a8287 1615 name = "Nintendo Switch Left Joy-Con (Grip)";
4ff5b108
DO		 1616 imu_name = "Nintendo Switch Left Joy-Con IMU (Grip)";
1617 } else {
294a8287 1618 name = "Nintendo Switch Right Joy-Con (Grip)";
4ff5b108
DO		 1619 imu_name = "Nintendo Switch Right Joy-Con IMU (Grip)";
1620 }
294a8287 1621 break;
2af16c1f
DO		 1622 case USB_DEVICE_ID_NINTENDO_JOYCONL:
1623 name = "Nintendo Switch Left Joy-Con";
4ff5b108 1624 imu_name = "Nintendo Switch Left Joy-Con IMU";
2af16c1f
DO		 1625 break;
1626 case USB_DEVICE_ID_NINTENDO_JOYCONR:
1627 name = "Nintendo Switch Right Joy-Con";
4ff5b108 1628 imu_name = "Nintendo Switch Right Joy-Con IMU";
2af16c1f
DO		 1629 break;
1630 default: /* Should be impossible */
1631 hid_err(hdev, "Invalid hid product\n");
1632 return -EINVAL;
1633 }
1634
1635 ctlr->input = devm_input_allocate_device(&hdev->dev);
1636 if (!ctlr->input)
1637 return -ENOMEM;
1638 ctlr->input->id.bustype = hdev->bus;
1639 ctlr->input->id.vendor = hdev->vendor;
1640 ctlr->input->id.product = hdev->product;
1641 ctlr->input->id.version = hdev->version;
14252473 1642 ctlr->input->uniq = ctlr->mac_addr_str;
2af16c1f 1643 ctlr->input->name = name;
842fec05 1644 ctlr->input->phys = hdev->phys;
2af16c1f
DO		 1645 input_set_drvdata(ctlr->input, ctlr);
1646
2af16c1f 1647 /* set up sticks and buttons */
294a8287 1648 if (jc_type_has_left(ctlr)) {
2af16c1f
DO		 1649 input_set_abs_params(ctlr->input, ABS_X,
1650 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1651 JC_STICK_FUZZ, JC_STICK_FLAT);
1652 input_set_abs_params(ctlr->input, ABS_Y,
1653 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1654 JC_STICK_FUZZ, JC_STICK_FLAT);
1655
1656 for (i = 0; joycon_button_inputs_l[i] > 0; i++)
1657 input_set_capability(ctlr->input, EV_KEY,
1658 joycon_button_inputs_l[i]);
1659
1660 /* configure d-pad differently for joy-con vs pro controller */
1661 if (hdev->product != USB_DEVICE_ID_NINTENDO_PROCON) {
1662 for (i = 0; joycon_dpad_inputs_jc[i] > 0; i++)
1663 input_set_capability(ctlr->input, EV_KEY,
1664 joycon_dpad_inputs_jc[i]);
1665 } else {
1666 input_set_abs_params(ctlr->input, ABS_HAT0X,
1667 -JC_MAX_DPAD_MAG, JC_MAX_DPAD_MAG,
1668 JC_DPAD_FUZZ, JC_DPAD_FLAT);
1669 input_set_abs_params(ctlr->input, ABS_HAT0Y,
1670 -JC_MAX_DPAD_MAG, JC_MAX_DPAD_MAG,
1671 JC_DPAD_FUZZ, JC_DPAD_FLAT);
1672 }
1673 }
294a8287 1674 if (jc_type_has_right(ctlr)) {
2af16c1f
DO		 1675 input_set_abs_params(ctlr->input, ABS_RX,
1676 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1677 JC_STICK_FUZZ, JC_STICK_FLAT);
1678 input_set_abs_params(ctlr->input, ABS_RY,
1679 -JC_MAX_STICK_MAG, JC_MAX_STICK_MAG,
1680 JC_STICK_FUZZ, JC_STICK_FLAT);
1681
1682 for (i = 0; joycon_button_inputs_r[i] > 0; i++)
1683 input_set_capability(ctlr->input, EV_KEY,
1684 joycon_button_inputs_r[i]);
1685 }
1686
1687 /* Let's report joy-con S triggers separately */
1688 if (hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONL) {
1689 input_set_capability(ctlr->input, EV_KEY, BTN_TR);
1690 input_set_capability(ctlr->input, EV_KEY, BTN_TR2);
1691 } else if (hdev->product == USB_DEVICE_ID_NINTENDO_JOYCONR) {
1692 input_set_capability(ctlr->input, EV_KEY, BTN_TL);
1693 input_set_capability(ctlr->input, EV_KEY, BTN_TL2);
1694 }
1695
c4eae84f
DO		 1696#if IS_ENABLED(CONFIG_NINTENDO_FF)
1697 /* set up rumble */
1698 input_set_capability(ctlr->input, EV_FF, FF_RUMBLE);
1699 input_ff_create_memless(ctlr->input, NULL, joycon_play_effect);
1700 ctlr->rumble_ll_freq = JC_RUMBLE_DFLT_LOW_FREQ;
1701 ctlr->rumble_lh_freq = JC_RUMBLE_DFLT_HIGH_FREQ;
1702 ctlr->rumble_rl_freq = JC_RUMBLE_DFLT_LOW_FREQ;
1703 ctlr->rumble_rh_freq = JC_RUMBLE_DFLT_HIGH_FREQ;
1704 joycon_clamp_rumble_freqs(ctlr);
1705 joycon_set_rumble(ctlr, 0, 0, false);
1706 ctlr->rumble_msecs = jiffies_to_msecs(jiffies);
1707#endif
1708
2af16c1f
DO		 1709 ret = input_register_device(ctlr->input);
1710 if (ret)
1711 return ret;
1712
4ff5b108
DO		 1713 /* configure the imu input device */
1714 ctlr->imu_input = devm_input_allocate_device(&hdev->dev);
1715 if (!ctlr->imu_input)
1716 return -ENOMEM;
1717
1718 ctlr->imu_input->id.bustype = hdev->bus;
1719 ctlr->imu_input->id.vendor = hdev->vendor;
1720 ctlr->imu_input->id.product = hdev->product;
1721 ctlr->imu_input->id.version = hdev->version;
1722 ctlr->imu_input->uniq = ctlr->mac_addr_str;
1723 ctlr->imu_input->name = imu_name;
842fec05 1724 ctlr->imu_input->phys = hdev->phys;
4ff5b108
DO		 1725 input_set_drvdata(ctlr->imu_input, ctlr);
1726
1727 /* configure imu axes */
1728 input_set_abs_params(ctlr->imu_input, ABS_X,
1729 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG,
1730 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT);
1731 input_set_abs_params(ctlr->imu_input, ABS_Y,
1732 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG,
1733 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT);
1734 input_set_abs_params(ctlr->imu_input, ABS_Z,
1735 -JC_IMU_MAX_ACCEL_MAG, JC_IMU_MAX_ACCEL_MAG,
1736 JC_IMU_ACCEL_FUZZ, JC_IMU_ACCEL_FLAT);
1737 input_abs_set_res(ctlr->imu_input, ABS_X, JC_IMU_ACCEL_RES_PER_G);
1738 input_abs_set_res(ctlr->imu_input, ABS_Y, JC_IMU_ACCEL_RES_PER_G);
1739 input_abs_set_res(ctlr->imu_input, ABS_Z, JC_IMU_ACCEL_RES_PER_G);
1740
1741 input_set_abs_params(ctlr->imu_input, ABS_RX,
1742 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG,
1743 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT);
1744 input_set_abs_params(ctlr->imu_input, ABS_RY,
1745 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG,
1746 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT);
1747 input_set_abs_params(ctlr->imu_input, ABS_RZ,
1748 -JC_IMU_MAX_GYRO_MAG, JC_IMU_MAX_GYRO_MAG,
1749 JC_IMU_GYRO_FUZZ, JC_IMU_GYRO_FLAT);
1750
1751 input_abs_set_res(ctlr->imu_input, ABS_RX, JC_IMU_GYRO_RES_PER_DPS);
1752 input_abs_set_res(ctlr->imu_input, ABS_RY, JC_IMU_GYRO_RES_PER_DPS);
1753 input_abs_set_res(ctlr->imu_input, ABS_RZ, JC_IMU_GYRO_RES_PER_DPS);
1754
1755 __set_bit(EV_MSC, ctlr->imu_input->evbit);
1756 __set_bit(MSC_TIMESTAMP, ctlr->imu_input->mscbit);
1757 __set_bit(INPUT_PROP_ACCELEROMETER, ctlr->imu_input->propbit);
1758
1759 ret = input_register_device(ctlr->imu_input);
1760 if (ret)
1761 return ret;
1762
c5e62676
DO		 1763 return 0;
1764}
1765
1766static int joycon_player_led_brightness_set(struct led_classdev *led,
1767 enum led_brightness brightness)
1768{
1769 struct device *dev = led->dev->parent;
1770 struct hid_device *hdev = to_hid_device(dev);
1771 struct joycon_ctlr *ctlr;
1772 int val = 0;
1773 int i;
1774 int ret;
1775 int num;
1776
1777 ctlr = hid_get_drvdata(hdev);
1778 if (!ctlr) {
1779 hid_err(hdev, "No controller data\n");
1780 return -ENODEV;
1781 }
1782
1783 /* determine which player led this is */
1784 for (num = 0; num < JC_NUM_LEDS; num++) {
1785 if (&ctlr->leds[num] == led)
1786 break;
1787 }
1788 if (num >= JC_NUM_LEDS)
1789 return -EINVAL;
1790
1791 mutex_lock(&ctlr->output_mutex);
1792 for (i = 0; i < JC_NUM_LEDS; i++) {
1793 if (i == num)
1794 val |= brightness << i;
1795 else
1796 val |= ctlr->leds[i].brightness << i;
1797 }
1798 ret = joycon_set_player_leds(ctlr, 0, val);
1799 mutex_unlock(&ctlr->output_mutex);
1800
1801 return ret;
1802}
1803
697e5c7a
DO		 1804static int joycon_home_led_brightness_set(struct led_classdev *led,
1805 enum led_brightness brightness)
1806{
1807 struct device *dev = led->dev->parent;
1808 struct hid_device *hdev = to_hid_device(dev);
1809 struct joycon_ctlr *ctlr;
1810 struct joycon_subcmd_request *req;
1811 u8 buffer[sizeof(*req) + 5] = { 0 };
1812 u8 *data;
1813 int ret;
1814
1815 ctlr = hid_get_drvdata(hdev);
1816 if (!ctlr) {
1817 hid_err(hdev, "No controller data\n");
1818 return -ENODEV;
1819 }
1820
1821 req = (struct joycon_subcmd_request *)buffer;
1822 req->subcmd_id = JC_SUBCMD_SET_HOME_LIGHT;
1823 data = req->data;
1824 data[0] = 0x01;
1825 data[1] = brightness << 4;
1826 data[2] = brightness | (brightness << 4);
1827 data[3] = 0x11;
1828 data[4] = 0x11;
1829
1830 hid_dbg(hdev, "setting home led brightness\n");
1831 mutex_lock(&ctlr->output_mutex);
6b5dca2d 1832 ret = joycon_send_subcmd(ctlr, req, 5, HZ/4);
697e5c7a
DO		 1833 mutex_unlock(&ctlr->output_mutex);
1834
1835 return ret;
1836}
1837
c5e62676 1838static DEFINE_MUTEX(joycon_input_num_mutex);
697e5c7a 1839static int joycon_leds_create(struct joycon_ctlr *ctlr)
c5e62676
DO		 1840{
1841 struct hid_device *hdev = ctlr->hdev;
1842 struct device *dev = &hdev->dev;
1843 const char *d_name = dev_name(dev);
1844 struct led_classdev *led;
1845 char *name;
1846 int ret = 0;
1847 int i;
1848 static int input_num = 1;
1849
2af16c1f
DO		 1850 /* Set the default controller player leds based on controller number */
1851 mutex_lock(&joycon_input_num_mutex);
1852 mutex_lock(&ctlr->output_mutex);
1853 ret = joycon_set_player_leds(ctlr, 0, 0xF >> (4 - input_num));
1854 if (ret)
1855 hid_warn(ctlr->hdev, "Failed to set leds; ret=%d\n", ret);
1856 mutex_unlock(&ctlr->output_mutex);
c5e62676
DO		 1857
1858 /* configure the player LEDs */
1859 for (i = 0; i < JC_NUM_LEDS; i++) {
1860 name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s:%s",
1861 d_name,
1862 "green",
1863 joycon_player_led_names[i]);
304dd368
DC		 1864 if (!name) {
1865 mutex_unlock(&joycon_input_num_mutex);
c5e62676 1866 return -ENOMEM;
304dd368 1867 }
c5e62676
DO		 1868
1869 led = &ctlr->leds[i];
1870 led->name = name;
1871 led->brightness = ((i + 1) <= input_num) ? 1 : 0;
1872 led->max_brightness = 1;
1873 led->brightness_set_blocking =
1874 joycon_player_led_brightness_set;
1875 led->flags = LED_CORE_SUSPENDRESUME | LED_HW_PLUGGABLE;
1876
1877 ret = devm_led_classdev_register(&hdev->dev, led);
1878 if (ret) {
1879 hid_err(hdev, "Failed registering %s LED\n", led->name);
304dd368 1880 mutex_unlock(&joycon_input_num_mutex);
697e5c7a 1881 return ret;
c5e62676
DO		 1882 }
1883 }
1884
2af16c1f
DO		 1885 if (++input_num > 4)
1886 input_num = 1;
1887 mutex_unlock(&joycon_input_num_mutex);
1888
697e5c7a 1889 /* configure the home LED */
294a8287 1890 if (jc_type_has_right(ctlr)) {
697e5c7a
DO		 1891 name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s:%s",
1892 d_name,
1893 "blue",
1894 LED_FUNCTION_PLAYER5);
1895 if (!name)
1896 return -ENOMEM;
1897
1898 led = &ctlr->home_led;
1899 led->name = name;
1900 led->brightness = 0;
1901 led->max_brightness = 0xF;
1902 led->brightness_set_blocking = joycon_home_led_brightness_set;
1903 led->flags = LED_CORE_SUSPENDRESUME | LED_HW_PLUGGABLE;
1904 ret = devm_led_classdev_register(&hdev->dev, led);
1905 if (ret) {
1906 hid_err(hdev, "Failed registering home led\n");
1907 return ret;
1908 }
1909 /* Set the home LED to 0 as default state */
1910 ret = joycon_home_led_brightness_set(led, 0);
1911 if (ret) {
8b30fb40
IZ		 1912 hid_warn(hdev, "Failed to set home LED default, unregistering home LED");
1913 devm_led_classdev_unregister(&hdev->dev, led);
697e5c7a
DO		 1914 }
1915 }
1916
2af16c1f
DO		 1917 return 0;
1918}
1919
08ebba5c
DO		 1920static int joycon_battery_get_property(struct power_supply *supply,
1921 enum power_supply_property prop,
1922 union power_supply_propval *val)
1923{
1924 struct joycon_ctlr *ctlr = power_supply_get_drvdata(supply);
1925 unsigned long flags;
1926 int ret = 0;
1927 u8 capacity;
1928 bool charging;
1929 bool powered;
1930
1931 spin_lock_irqsave(&ctlr->lock, flags);
1932 capacity = ctlr->battery_capacity;
1933 charging = ctlr->battery_charging;
1934 powered = ctlr->host_powered;
1935 spin_unlock_irqrestore(&ctlr->lock, flags);
1936
1937 switch (prop) {
1938 case POWER_SUPPLY_PROP_PRESENT:
1939 val->intval = 1;
1940 break;
1941 case POWER_SUPPLY_PROP_SCOPE:
1942 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1943 break;
1944 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
1945 val->intval = capacity;
1946 break;
1947 case POWER_SUPPLY_PROP_STATUS:
1948 if (charging)
1949 val->intval = POWER_SUPPLY_STATUS_CHARGING;
1950 else if (capacity == POWER_SUPPLY_CAPACITY_LEVEL_FULL &&
1951 powered)
1952 val->intval = POWER_SUPPLY_STATUS_FULL;
1953 else
1954 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
1955 break;
1956 default:
1957 ret = -EINVAL;
1958 break;
1959 }
1960 return ret;
1961}
1962
1963static enum power_supply_property joycon_battery_props[] = {
1964 POWER_SUPPLY_PROP_PRESENT,
1965 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
1966 POWER_SUPPLY_PROP_SCOPE,
1967 POWER_SUPPLY_PROP_STATUS,
1968};
1969
1970static int joycon_power_supply_create(struct joycon_ctlr *ctlr)
1971{
1972 struct hid_device *hdev = ctlr->hdev;
1973 struct power_supply_config supply_config = { .drv_data = ctlr, };
1974 const char * const name_fmt = "nintendo_switch_controller_battery_%s";
1975 int ret = 0;
1976
1977 /* Set initially to unknown before receiving first input report */
1978 ctlr->battery_capacity = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1979
1980 /* Configure the battery's description */
1981 ctlr->battery_desc.properties = joycon_battery_props;
1982 ctlr->battery_desc.num_properties =
1983 ARRAY_SIZE(joycon_battery_props);
1984 ctlr->battery_desc.get_property = joycon_battery_get_property;
1985 ctlr->battery_desc.type = POWER_SUPPLY_TYPE_BATTERY;
1986 ctlr->battery_desc.use_for_apm = 0;
1987 ctlr->battery_desc.name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
1988 name_fmt,
1989 dev_name(&hdev->dev));
1990 if (!ctlr->battery_desc.name)
1991 return -ENOMEM;
1992
1993 ctlr->battery = devm_power_supply_register(&hdev->dev,
1994 &ctlr->battery_desc,
1995 &supply_config);
1996 if (IS_ERR(ctlr->battery)) {
1997 ret = PTR_ERR(ctlr->battery);
1998 hid_err(hdev, "Failed to register battery; ret=%d\n", ret);
1999 return ret;
2000 }
2001
2002 return power_supply_powers(ctlr->battery, &hdev->dev);
2003}
2004
294a8287 2005static int joycon_read_info(struct joycon_ctlr *ctlr)
14252473
DO		 2006{
2007 int ret;
2008 int i;
2009 int j;
2010 struct joycon_subcmd_request req = { 0 };
2011 struct joycon_input_report *report;
2012
2013 req.subcmd_id = JC_SUBCMD_REQ_DEV_INFO;
2014 ret = joycon_send_subcmd(ctlr, &req, 0, HZ);
2015 if (ret) {
2016 hid_err(ctlr->hdev, "Failed to get joycon info; ret=%d\n", ret);
2017 return ret;
2018 }
2019
2020 report = (struct joycon_input_report *)ctlr->input_buf;
2021
2022 for (i = 4, j = 0; j < 6; i++, j++)
4ff5b108 2023 ctlr->mac_addr[j] = report->subcmd_reply.data[i];
14252473
DO		 2024
2025 ctlr->mac_addr_str = devm_kasprintf(&ctlr->hdev->dev, GFP_KERNEL,
2026 "%02X:%02X:%02X:%02X:%02X:%02X",
2027 ctlr->mac_addr[0],
2028 ctlr->mac_addr[1],
2029 ctlr->mac_addr[2],
2030 ctlr->mac_addr[3],
2031 ctlr->mac_addr[4],
2032 ctlr->mac_addr[5]);
2033 if (!ctlr->mac_addr_str)
2034 return -ENOMEM;
2035 hid_info(ctlr->hdev, "controller MAC = %s\n", ctlr->mac_addr_str);
2036
294a8287 2037 /* Retrieve the type so we can distinguish for charging grip */
4ff5b108 2038 ctlr->ctlr_type = report->subcmd_reply.data[2];
294a8287 2039
14252473
DO		 2040 return 0;
2041}
2042
2af16c1f
DO		 2043/* Common handler for parsing inputs */
2044static int joycon_ctlr_read_handler(struct joycon_ctlr *ctlr, u8 *data,
2045 int size)
2046{
2047 if (data[0] == JC_INPUT_SUBCMD_REPLY || data[0] == JC_INPUT_IMU_DATA ||
2048 data[0] == JC_INPUT_MCU_DATA) {
2049 if (size >= 12) /* make sure it contains the input report */
2050 joycon_parse_report(ctlr,
2051 (struct joycon_input_report *)data);
2052 }
2053
2054 return 0;
2055}
2056
2057static int joycon_ctlr_handle_event(struct joycon_ctlr *ctlr, u8 *data,
2058 int size)
2059{
2060 int ret = 0;
2061 bool match = false;
2062 struct joycon_input_report *report;
2063
2064 if (unlikely(mutex_is_locked(&ctlr->output_mutex)) &&
2065 ctlr->msg_type != JOYCON_MSG_TYPE_NONE) {
2066 switch (ctlr->msg_type) {
2067 case JOYCON_MSG_TYPE_USB:
2068 if (size < 2)
2069 break;
2070 if (data[0] == JC_INPUT_USB_RESPONSE &&
2071 data[1] == ctlr->usb_ack_match)
2072 match = true;
2073 break;
2074 case JOYCON_MSG_TYPE_SUBCMD:
2075 if (size < sizeof(struct joycon_input_report) ||
2076 data[0] != JC_INPUT_SUBCMD_REPLY)
2077 break;
2078 report = (struct joycon_input_report *)data;
4ff5b108 2079 if (report->subcmd_reply.id == ctlr->subcmd_ack_match)
2af16c1f
DO		 2080 match = true;
2081 break;
2082 default:
2083 break;
2084 }
2085
2086 if (match) {
2087 memcpy(ctlr->input_buf, data,
2088 min(size, (int)JC_MAX_RESP_SIZE));
2089 ctlr->msg_type = JOYCON_MSG_TYPE_NONE;
2090 ctlr->received_resp = true;
2091 wake_up(&ctlr->wait);
2092
2093 /* This message has been handled */
2094 return 1;
2095 }
2096 }
2097
2098 if (ctlr->ctlr_state == JOYCON_CTLR_STATE_READ)
2099 ret = joycon_ctlr_read_handler(ctlr, data, size);
2100
2101 return ret;
2102}
2103
2104static int nintendo_hid_event(struct hid_device *hdev,
2105 struct hid_report *report, u8 *raw_data, int size)
2106{
2107 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev);
2108
2109 if (size < 1)
2110 return -EINVAL;
2111
2112 return joycon_ctlr_handle_event(ctlr, raw_data, size);
2113}
2114
2115static int nintendo_hid_probe(struct hid_device *hdev,
2116 const struct hid_device_id *id)
2117{
2118 int ret;
2119 struct joycon_ctlr *ctlr;
2120
2121 hid_dbg(hdev, "probe - start\n");
2122
2123 ctlr = devm_kzalloc(&hdev->dev, sizeof(*ctlr), GFP_KERNEL);
2124 if (!ctlr) {
2125 ret = -ENOMEM;
2126 goto err;
2127 }
2128
2129 ctlr->hdev = hdev;
2130 ctlr->ctlr_state = JOYCON_CTLR_STATE_INIT;
c4eae84f
DO		 2131 ctlr->rumble_queue_head = JC_RUMBLE_QUEUE_SIZE - 1;
2132 ctlr->rumble_queue_tail = 0;
2af16c1f
DO		 2133 hid_set_drvdata(hdev, ctlr);
2134 mutex_init(&ctlr->output_mutex);
2135 init_waitqueue_head(&ctlr->wait);
08ebba5c 2136 spin_lock_init(&ctlr->lock);
c4eae84f
DO		 2137 ctlr->rumble_queue = alloc_workqueue("hid-nintendo-rumble_wq",
2138 WQ_FREEZABLE | WQ_MEM_RECLAIM, 0);
fe23b6bb
JJB		 2139 if (!ctlr->rumble_queue) {
2140 ret = -ENOMEM;
2141 goto err;
2142 }
c4eae84f 2143 INIT_WORK(&ctlr->rumble_worker, joycon_rumble_worker);
2af16c1f
DO		 2144
2145 ret = hid_parse(hdev);
2146 if (ret) {
2147 hid_err(hdev, "HID parse failed\n");
c4eae84f 2148 goto err_wq;
2af16c1f
DO		 2149 }
2150
c7d0d636
DO		 2151 /*
2152 * Patch the hw version of pro controller/joycons, so applications can
2153 * distinguish between the default HID mappings and the mappings defined
2154 * by the Linux game controller spec. This is important for the SDL2
2155 * library, which has a game controller database, which uses device ids
2156 * in combination with version as a key.
2157 */
2158 hdev->version |= 0x8000;
2159
2af16c1f
DO		 2160 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
2161 if (ret) {
2162 hid_err(hdev, "HW start failed\n");
c4eae84f 2163 goto err_wq;
2af16c1f
DO		 2164 }
2165
2166 ret = hid_hw_open(hdev);
2167 if (ret) {
2168 hid_err(hdev, "cannot start hardware I/O\n");
2169 goto err_stop;
2170 }
2171
2172 hid_device_io_start(hdev);
2173
2174 /* Initialize the controller */
2175 mutex_lock(&ctlr->output_mutex);
2176 /* if handshake command fails, assume ble pro controller */
294a8287 2177 if ((jc_type_is_procon(ctlr) || jc_type_is_chrggrip(ctlr)) &&
6b5dca2d 2178 !joycon_send_usb(ctlr, JC_USB_CMD_HANDSHAKE, HZ)) {
2af16c1f
DO		 2179 hid_dbg(hdev, "detected USB controller\n");
2180 /* set baudrate for improved latency */
6b5dca2d 2181 ret = joycon_send_usb(ctlr, JC_USB_CMD_BAUDRATE_3M, HZ);
2af16c1f
DO		 2182 if (ret) {
2183 hid_err(hdev, "Failed to set baudrate; ret=%d\n", ret);
2184 goto err_mutex;
2185 }
2186 /* handshake */
6b5dca2d 2187 ret = joycon_send_usb(ctlr, JC_USB_CMD_HANDSHAKE, HZ);
2af16c1f
DO		 2188 if (ret) {
2189 hid_err(hdev, "Failed handshake; ret=%d\n", ret);
2190 goto err_mutex;
2191 }
2192 /*
2193 * Set no timeout (to keep controller in USB mode).
2194 * This doesn't send a response, so ignore the timeout.
2195 */
6b5dca2d 2196 joycon_send_usb(ctlr, JC_USB_CMD_NO_TIMEOUT, HZ/10);
294a8287
DO		 2197 } else if (jc_type_is_chrggrip(ctlr)) {
2198 hid_err(hdev, "Failed charging grip handshake\n");
2199 ret = -ETIMEDOUT;
2200 goto err_mutex;
2af16c1f
DO		 2201 }
2202
2203 /* get controller calibration data, and parse it */
2204 ret = joycon_request_calibration(ctlr);
2205 if (ret) {
2206 /*
2207 * We can function with default calibration, but it may be
2208 * inaccurate. Provide a warning, and continue on.
2209 */
2210 hid_warn(hdev, "Analog stick positions may be inaccurate\n");
2211 }
2212
4ff5b108
DO		 2213 /* get IMU calibration data, and parse it */
2214 ret = joycon_request_imu_calibration(ctlr);
2215 if (ret) {
2216 /*
2217 * We can function with default calibration, but it may be
2218 * inaccurate. Provide a warning, and continue on.
2219 */
2220 hid_warn(hdev, "Unable to read IMU calibration data\n");
2221 }
2222
2af16c1f
DO		 2223 /* Set the reporting mode to 0x30, which is the full report mode */
2224 ret = joycon_set_report_mode(ctlr);
2225 if (ret) {
2226 hid_err(hdev, "Failed to set report mode; ret=%d\n", ret);
2227 goto err_mutex;
2228 }
2229
c4eae84f
DO		 2230 /* Enable rumble */
2231 ret = joycon_enable_rumble(ctlr);
2232 if (ret) {
2233 hid_err(hdev, "Failed to enable rumble; ret=%d\n", ret);
2234 goto err_mutex;
2235 }
2236
4ff5b108
DO		 2237 /* Enable the IMU */
2238 ret = joycon_enable_imu(ctlr);
2239 if (ret) {
2240 hid_err(hdev, "Failed to enable the IMU; ret=%d\n", ret);
2241 goto err_mutex;
2242 }
2243
294a8287 2244 ret = joycon_read_info(ctlr);
14252473 2245 if (ret) {
294a8287 2246 hid_err(hdev, "Failed to retrieve controller info; ret=%d\n",
14252473
DO		 2247 ret);
2248 goto err_mutex;
2249 }
2250
2af16c1f
DO		 2251 mutex_unlock(&ctlr->output_mutex);
2252
c5e62676 2253 /* Initialize the leds */
697e5c7a 2254 ret = joycon_leds_create(ctlr);
c5e62676
DO		 2255 if (ret) {
2256 hid_err(hdev, "Failed to create leds; ret=%d\n", ret);
2257 goto err_close;
2258 }
2259
08ebba5c
DO		 2260 /* Initialize the battery power supply */
2261 ret = joycon_power_supply_create(ctlr);
2262 if (ret) {
2263 hid_err(hdev, "Failed to create power_supply; ret=%d\n", ret);
2264 goto err_close;
2265 }
2266
2af16c1f
DO		 2267 ret = joycon_input_create(ctlr);
2268 if (ret) {
2269 hid_err(hdev, "Failed to create input device; ret=%d\n", ret);
2270 goto err_close;
2271 }
2272
2273 ctlr->ctlr_state = JOYCON_CTLR_STATE_READ;
2274
2275 hid_dbg(hdev, "probe - success\n");
2276 return 0;
2277
2278err_mutex:
2279 mutex_unlock(&ctlr->output_mutex);
2280err_close:
2281 hid_hw_close(hdev);
2282err_stop:
2283 hid_hw_stop(hdev);
c4eae84f
DO		 2284err_wq:
2285 destroy_workqueue(ctlr->rumble_queue);
2af16c1f
DO		 2286err:
2287 hid_err(hdev, "probe - fail = %d\n", ret);
2288 return ret;
2289}
2290
2291static void nintendo_hid_remove(struct hid_device *hdev)
2292{
c4eae84f 2293 struct joycon_ctlr *ctlr = hid_get_drvdata(hdev);
012bd52c 2294 unsigned long flags;
c4eae84f 2295
2af16c1f 2296 hid_dbg(hdev, "remove\n");
012bd52c
DO		 2297
2298 /* Prevent further attempts at sending subcommands. */
2299 spin_lock_irqsave(&ctlr->lock, flags);
2300 ctlr->ctlr_state = JOYCON_CTLR_STATE_REMOVED;
2301 spin_unlock_irqrestore(&ctlr->lock, flags);
2302
c4eae84f 2303 destroy_workqueue(ctlr->rumble_queue);
012bd52c 2304
2af16c1f
DO		 2305 hid_hw_close(hdev);
2306 hid_hw_stop(hdev);
2307}
2308
2309static const struct hid_device_id nintendo_hid_devices[] = {
2310 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO,
2311 USB_DEVICE_ID_NINTENDO_PROCON) },
2312 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
2313 USB_DEVICE_ID_NINTENDO_PROCON) },
294a8287
DO		 2314 { HID_USB_DEVICE(USB_VENDOR_ID_NINTENDO,
2315 USB_DEVICE_ID_NINTENDO_CHRGGRIP) },
2af16c1f
DO		 2316 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
2317 USB_DEVICE_ID_NINTENDO_JOYCONL) },
2318 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
2319 USB_DEVICE_ID_NINTENDO_JOYCONR) },
2320 { }
2321};
2322MODULE_DEVICE_TABLE(hid, nintendo_hid_devices);
2323
2324static struct hid_driver nintendo_hid_driver = {
2325 .name = "nintendo",
2326 .id_table = nintendo_hid_devices,
2327 .probe = nintendo_hid_probe,
2328 .remove = nintendo_hid_remove,
2329 .raw_event = nintendo_hid_event,
2330};
2331module_hid_driver(nintendo_hid_driver);
2332
2333MODULE_LICENSE("GPL");
2334MODULE_AUTHOR("Daniel J. Ogorchock <djogorchock@gmail.com>");
2335MODULE_DESCRIPTION("Driver for Nintendo Switch Controllers");
4ff5b108 2336
Linux 6.x block layer and io_uring tree(s)