HID: nintendo: add support for reading user calibration

If the controller's SPI flash contains user stick calibration(s), they
should be prioritized over the factory calibrations. The user
calibrations have 2 magic bytes preceding them. If the bytes are the
correct magic values, the user calibration is used.

Signed-off-by: Daniel J. Ogorchock <djogorchock@gmail.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
This commit is contained in:
Daniel J. Ogorchock 2021-09-11 13:36:35 -04:00 committed by Jiri Kosina
parent 294a828759
commit 83d640c4f8
1 changed files with 152 additions and 62 deletions

View File

@ -23,6 +23,7 @@
*/
#include "hid-ids.h"
#include <asm/unaligned.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/hid.h>
@ -96,11 +97,23 @@ static const u8 JC_USB_RESET = 0x06;
static const u8 JC_USB_PRE_HANDSHAKE = 0x91;
static const u8 JC_USB_SEND_UART = 0x92;
/* SPI storage addresses of factory calibration data */
static const u16 JC_CAL_DATA_START = 0x603d;
static const u16 JC_CAL_DATA_END = 0x604e;
#define JC_CAL_DATA_SIZE (JC_CAL_DATA_END - JC_CAL_DATA_START + 1)
/* Magic value denoting presence of user calibration */
static const u16 JC_CAL_USR_MAGIC_0 = 0xB2;
static const u16 JC_CAL_USR_MAGIC_1 = 0xA1;
static const u8 JC_CAL_USR_MAGIC_SIZE = 2;
/* SPI storage addresses of user calibration data */
static const u16 JC_CAL_USR_LEFT_MAGIC_ADDR = 0x8010;
static const u16 JC_CAL_USR_LEFT_DATA_ADDR = 0x8012;
static const u16 JC_CAL_USR_LEFT_DATA_END = 0x801A;
static const u16 JC_CAL_USR_RIGHT_MAGIC_ADDR = 0x801B;
static const u16 JC_CAL_USR_RIGHT_DATA_ADDR = 0x801D;
#define JC_CAL_STICK_DATA_SIZE \
(JC_CAL_USR_LEFT_DATA_END - JC_CAL_USR_LEFT_DATA_ADDR + 1)
/* SPI storage addresses of factory calibration data */
static const u16 JC_CAL_FCT_DATA_LEFT_ADDR = 0x603d;
static const u16 JC_CAL_FCT_DATA_RIGHT_ADDR = 0x6046;
/* The raw analog joystick values will be mapped in terms of this magnitude */
static const u16 JC_MAX_STICK_MAG = 32767;
@ -531,38 +544,140 @@ static int joycon_set_player_leds(struct joycon_ctlr *ctlr, u8 flash, u8 on)
return joycon_send_subcmd(ctlr, req, 1, HZ/4);
}
static int joycon_request_spi_flash_read(struct joycon_ctlr *ctlr,
u32 start_addr, u8 size, u8 **reply)
{
struct joycon_subcmd_request *req;
struct joycon_input_report *report;
u8 buffer[sizeof(*req) + 5] = { 0 };
u8 *data;
int ret;
if (!reply)
return -EINVAL;
req = (struct joycon_subcmd_request *)buffer;
req->subcmd_id = JC_SUBCMD_SPI_FLASH_READ;
data = req->data;
put_unaligned_le32(start_addr, data);
data[4] = size;
hid_dbg(ctlr->hdev, "requesting SPI flash data\n");
ret = joycon_send_subcmd(ctlr, req, 5, HZ);
if (ret) {
hid_err(ctlr->hdev, "failed reading SPI flash; ret=%d\n", ret);
} else {
report = (struct joycon_input_report *)ctlr->input_buf;
/* The read data starts at the 6th byte */
*reply = &report->reply.data[5];
}
return ret;
}
/*
* User calibration's presence is denoted with a magic byte preceding it.
* returns 0 if magic val is present, 1 if not present, < 0 on error
*/
static int joycon_check_for_cal_magic(struct joycon_ctlr *ctlr, u32 flash_addr)
{
int ret;
u8 *reply;
ret = joycon_request_spi_flash_read(ctlr, flash_addr,
JC_CAL_USR_MAGIC_SIZE, &reply);
if (ret)
return ret;
return reply[0] != JC_CAL_USR_MAGIC_0 || reply[1] != JC_CAL_USR_MAGIC_1;
}
static int joycon_read_stick_calibration(struct joycon_ctlr *ctlr, u16 cal_addr,
struct joycon_stick_cal *cal_x,
struct joycon_stick_cal *cal_y,
bool left_stick)
{
s32 x_max_above;
s32 x_min_below;
s32 y_max_above;
s32 y_min_below;
u8 *raw_cal;
int ret;
ret = joycon_request_spi_flash_read(ctlr, cal_addr,
JC_CAL_STICK_DATA_SIZE, &raw_cal);
if (ret)
return ret;
/* stick calibration parsing: note the order differs based on stick */
if (left_stick) {
x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0,
12);
y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4,
12);
cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0,
12);
cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4,
12);
x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0,
12);
y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4,
12);
} else {
cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0,
12);
cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4,
12);
x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0,
12);
y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4,
12);
x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0,
12);
y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4,
12);
}
cal_x->max = cal_x->center + x_max_above;
cal_x->min = cal_x->center - x_min_below;
cal_y->max = cal_y->center + y_max_above;
cal_y->min = cal_y->center - y_min_below;
return 0;
}
static const u16 DFLT_STICK_CAL_CEN = 2000;
static const u16 DFLT_STICK_CAL_MAX = 3500;
static const u16 DFLT_STICK_CAL_MIN = 500;
static int joycon_request_calibration(struct joycon_ctlr *ctlr)
{
struct joycon_subcmd_request *req;
u8 buffer[sizeof(*req) + 5] = { 0 };
struct joycon_input_report *report;
struct joycon_stick_cal *cal_x;
struct joycon_stick_cal *cal_y;
s32 x_max_above;
s32 x_min_below;
s32 y_max_above;
s32 y_min_below;
u8 *data;
u8 *raw_cal;
u16 left_stick_addr = JC_CAL_FCT_DATA_LEFT_ADDR;
u16 right_stick_addr = JC_CAL_FCT_DATA_RIGHT_ADDR;
int ret;
req = (struct joycon_subcmd_request *)buffer;
req->subcmd_id = JC_SUBCMD_SPI_FLASH_READ;
data = req->data;
data[0] = 0xFF & JC_CAL_DATA_START;
data[1] = 0xFF & (JC_CAL_DATA_START >> 8);
data[2] = 0xFF & (JC_CAL_DATA_START >> 16);
data[3] = 0xFF & (JC_CAL_DATA_START >> 24);
data[4] = JC_CAL_DATA_SIZE;
hid_dbg(ctlr->hdev, "requesting cal data\n");
ret = joycon_send_subcmd(ctlr, req, 5, HZ);
/* check if user stick calibrations are present */
if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_LEFT_MAGIC_ADDR)) {
left_stick_addr = JC_CAL_USR_LEFT_DATA_ADDR;
hid_info(ctlr->hdev, "using user cal for left stick\n");
} else {
hid_info(ctlr->hdev, "using factory cal for left stick\n");
}
if (!joycon_check_for_cal_magic(ctlr, JC_CAL_USR_RIGHT_MAGIC_ADDR)) {
right_stick_addr = JC_CAL_USR_RIGHT_DATA_ADDR;
hid_info(ctlr->hdev, "using user cal for right stick\n");
} else {
hid_info(ctlr->hdev, "using factory cal for right stick\n");
}
/* read the left stick calibration data */
ret = joycon_read_stick_calibration(ctlr, left_stick_addr,
&ctlr->left_stick_cal_x,
&ctlr->left_stick_cal_y,
true);
if (ret) {
hid_warn(ctlr->hdev,
"Failed to read stick cal, using defaults; ret=%d\n",
"Failed to read left stick cal, using dflts; e=%d\n",
ret);
ctlr->left_stick_cal_x.center = DFLT_STICK_CAL_CEN;
@ -572,6 +687,17 @@ static int joycon_request_calibration(struct joycon_ctlr *ctlr)
ctlr->left_stick_cal_y.center = DFLT_STICK_CAL_CEN;
ctlr->left_stick_cal_y.max = DFLT_STICK_CAL_MAX;
ctlr->left_stick_cal_y.min = DFLT_STICK_CAL_MIN;
}
/* read the right stick calibration data */
ret = joycon_read_stick_calibration(ctlr, right_stick_addr,
&ctlr->right_stick_cal_x,
&ctlr->right_stick_cal_y,
false);
if (ret) {
hid_warn(ctlr->hdev,
"Failed to read right stick cal, using dflts; e=%d\n",
ret);
ctlr->right_stick_cal_x.center = DFLT_STICK_CAL_CEN;
ctlr->right_stick_cal_x.max = DFLT_STICK_CAL_MAX;
@ -580,44 +706,8 @@ static int joycon_request_calibration(struct joycon_ctlr *ctlr)
ctlr->right_stick_cal_y.center = DFLT_STICK_CAL_CEN;
ctlr->right_stick_cal_y.max = DFLT_STICK_CAL_MAX;
ctlr->right_stick_cal_y.min = DFLT_STICK_CAL_MIN;
return ret;
}
report = (struct joycon_input_report *)ctlr->input_buf;
raw_cal = &report->reply.data[5];
/* left stick calibration parsing */
cal_x = &ctlr->left_stick_cal_x;
cal_y = &ctlr->left_stick_cal_y;
x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0, 12);
y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4, 12);
cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0, 12);
cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4, 12);
x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0, 12);
y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4, 12);
cal_x->max = cal_x->center + x_max_above;
cal_x->min = cal_x->center - x_min_below;
cal_y->max = cal_y->center + y_max_above;
cal_y->min = cal_y->center - y_min_below;
/* right stick calibration parsing */
raw_cal += 9;
cal_x = &ctlr->right_stick_cal_x;
cal_y = &ctlr->right_stick_cal_y;
cal_x->center = hid_field_extract(ctlr->hdev, (raw_cal + 0), 0, 12);
cal_y->center = hid_field_extract(ctlr->hdev, (raw_cal + 1), 4, 12);
x_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 3), 0, 12);
y_min_below = hid_field_extract(ctlr->hdev, (raw_cal + 4), 4, 12);
x_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 6), 0, 12);
y_max_above = hid_field_extract(ctlr->hdev, (raw_cal + 7), 4, 12);
cal_x->max = cal_x->center + x_max_above;
cal_x->min = cal_x->center - x_min_below;
cal_y->max = cal_y->center + y_max_above;
cal_y->min = cal_y->center - y_min_below;
hid_dbg(ctlr->hdev, "calibration:\n"
"l_x_c=%d l_x_max=%d l_x_min=%d\n"
"l_y_c=%d l_y_max=%d l_y_min=%d\n"