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