HID: hid-steam: Update list of identifiers from SDL
authorVicki Pfau <vi@endrift.com>
Wed, 20 Dec 2023 03:38:35 +0000 (19:38 -0800)
committerJiri Kosina <jkosina@suse.com>
Tue, 2 Jan 2024 10:20:42 +0000 (11:20 +0100)
SDL includes a list of settings (formerly called registers in this driver),
reports (formerly cmds), and various other identifiers that were provided by
Valve. This commit imports a significant chunk of that list as well as
replacing most of the guessed names and a handful of magic constants. It also
replaces bitmask definitions that used hex with the BIT macro.

Signed-off-by: Vicki Pfau <vi@endrift.com>
Signed-off-by: Jiri Kosina <jkosina@suse.com>
drivers/hid/hid-steam.c

index 667b5b09f93118ddb862d1cf8baae36064f769ca..4f5c647f04dd0c92b948161932d0013cea7d49b4 100644 (file)
@@ -71,51 +71,207 @@ static LIST_HEAD(steam_devices);
 
 /*
  * Commands that can be sent in a feature report.
- * Thanks to Valve for some valuable hints.
+ * Thanks to Valve and SDL for the names.
  */
-#define STEAM_CMD_SET_MAPPINGS         0x80
-#define STEAM_CMD_CLEAR_MAPPINGS       0x81
-#define STEAM_CMD_GET_MAPPINGS         0x82
-#define STEAM_CMD_GET_ATTRIB           0x83
-#define STEAM_CMD_GET_ATTRIB_LABEL     0x84
-#define STEAM_CMD_DEFAULT_MAPPINGS     0x85
-#define STEAM_CMD_FACTORY_RESET                0x86
-#define STEAM_CMD_WRITE_REGISTER       0x87
-#define STEAM_CMD_CLEAR_REGISTER       0x88
-#define STEAM_CMD_READ_REGISTER                0x89
-#define STEAM_CMD_GET_REGISTER_LABEL   0x8a
-#define STEAM_CMD_GET_REGISTER_MAX     0x8b
-#define STEAM_CMD_GET_REGISTER_DEFAULT 0x8c
-#define STEAM_CMD_SET_MODE             0x8d
-#define STEAM_CMD_DEFAULT_MOUSE                0x8e
-#define STEAM_CMD_FORCEFEEDBAK         0x8f
-#define STEAM_CMD_REQUEST_COMM_STATUS  0xb4
-#define STEAM_CMD_GET_SERIAL           0xae
-#define STEAM_CMD_HAPTIC_RUMBLE                0xeb
-
-/* Some useful register ids */
-#define STEAM_REG_LPAD_MODE            0x07
-#define STEAM_REG_RPAD_MODE            0x08
-#define STEAM_REG_RPAD_MARGIN          0x18
-#define STEAM_REG_LED                  0x2d
-#define STEAM_REG_GYRO_MODE            0x30
-#define STEAM_REG_LPAD_CLICK_PRESSURE  0x34
-#define STEAM_REG_RPAD_CLICK_PRESSURE  0x35
-#define STEAM_REG_WATCHDOG_ENABLE              0x47
-
-/* Raw event identifiers */
-#define STEAM_EV_INPUT_DATA            0x01
-#define STEAM_EV_CONNECT               0x03
-#define STEAM_EV_BATTERY               0x04
-#define STEAM_EV_DECK_INPUT_DATA       0x09
+enum {
+       ID_SET_DIGITAL_MAPPINGS         = 0x80,
+       ID_CLEAR_DIGITAL_MAPPINGS       = 0x81,
+       ID_GET_DIGITAL_MAPPINGS         = 0x82,
+       ID_GET_ATTRIBUTES_VALUES        = 0x83,
+       ID_GET_ATTRIBUTE_LABEL          = 0x84,
+       ID_SET_DEFAULT_DIGITAL_MAPPINGS = 0x85,
+       ID_FACTORY_RESET                = 0x86,
+       ID_SET_SETTINGS_VALUES          = 0x87,
+       ID_CLEAR_SETTINGS_VALUES        = 0x88,
+       ID_GET_SETTINGS_VALUES          = 0x89,
+       ID_GET_SETTING_LABEL            = 0x8A,
+       ID_GET_SETTINGS_MAXS            = 0x8B,
+       ID_GET_SETTINGS_DEFAULTS        = 0x8C,
+       ID_SET_CONTROLLER_MODE          = 0x8D,
+       ID_LOAD_DEFAULT_SETTINGS        = 0x8E,
+       ID_TRIGGER_HAPTIC_PULSE         = 0x8F,
+       ID_TURN_OFF_CONTROLLER          = 0x9F,
+
+       ID_GET_DEVICE_INFO              = 0xA1,
+
+       ID_CALIBRATE_TRACKPADS          = 0xA7,
+       ID_RESERVED_0                   = 0xA8,
+       ID_SET_SERIAL_NUMBER            = 0xA9,
+       ID_GET_TRACKPAD_CALIBRATION     = 0xAA,
+       ID_GET_TRACKPAD_FACTORY_CALIBRATION = 0xAB,
+       ID_GET_TRACKPAD_RAW_DATA        = 0xAC,
+       ID_ENABLE_PAIRING               = 0xAD,
+       ID_GET_STRING_ATTRIBUTE         = 0xAE,
+       ID_RADIO_ERASE_RECORDS          = 0xAF,
+       ID_RADIO_WRITE_RECORD           = 0xB0,
+       ID_SET_DONGLE_SETTING           = 0xB1,
+       ID_DONGLE_DISCONNECT_DEVICE     = 0xB2,
+       ID_DONGLE_COMMIT_DEVICE         = 0xB3,
+       ID_DONGLE_GET_WIRELESS_STATE    = 0xB4,
+       ID_CALIBRATE_GYRO               = 0xB5,
+       ID_PLAY_AUDIO                   = 0xB6,
+       ID_AUDIO_UPDATE_START           = 0xB7,
+       ID_AUDIO_UPDATE_DATA            = 0xB8,
+       ID_AUDIO_UPDATE_COMPLETE        = 0xB9,
+       ID_GET_CHIPID                   = 0xBA,
+
+       ID_CALIBRATE_JOYSTICK           = 0xBF,
+       ID_CALIBRATE_ANALOG_TRIGGERS    = 0xC0,
+       ID_SET_AUDIO_MAPPING            = 0xC1,
+       ID_CHECK_GYRO_FW_LOAD           = 0xC2,
+       ID_CALIBRATE_ANALOG             = 0xC3,
+       ID_DONGLE_GET_CONNECTED_SLOTS   = 0xC4,
+
+       ID_RESET_IMU                    = 0xCE,
+
+       ID_TRIGGER_HAPTIC_CMD           = 0xEA,
+       ID_TRIGGER_RUMBLE_CMD           = 0xEB,
+};
+
+/* Settings IDs */
+enum {
+       /* 0 */
+       SETTING_MOUSE_SENSITIVITY,
+       SETTING_MOUSE_ACCELERATION,
+       SETTING_TRACKBALL_ROTATION_ANGLE,
+       SETTING_HAPTIC_INTENSITY_UNUSED,
+       SETTING_LEFT_GAMEPAD_STICK_ENABLED,
+       SETTING_RIGHT_GAMEPAD_STICK_ENABLED,
+       SETTING_USB_DEBUG_MODE,
+       SETTING_LEFT_TRACKPAD_MODE,
+       SETTING_RIGHT_TRACKPAD_MODE,
+       SETTING_MOUSE_POINTER_ENABLED,
+
+       /* 10 */
+       SETTING_DPAD_DEADZONE,
+       SETTING_MINIMUM_MOMENTUM_VEL,
+       SETTING_MOMENTUM_DECAY_AMMOUNT,
+       SETTING_TRACKPAD_RELATIVE_MODE_TICKS_PER_PIXEL,
+       SETTING_HAPTIC_INCREMENT,
+       SETTING_DPAD_ANGLE_SIN,
+       SETTING_DPAD_ANGLE_COS,
+       SETTING_MOMENTUM_VERTICAL_DIVISOR,
+       SETTING_MOMENTUM_MAXIMUM_VELOCITY,
+       SETTING_TRACKPAD_Z_ON,
+
+       /* 20 */
+       SETTING_TRACKPAD_Z_OFF,
+       SETTING_SENSITIVY_SCALE_AMMOUNT,
+       SETTING_LEFT_TRACKPAD_SECONDARY_MODE,
+       SETTING_RIGHT_TRACKPAD_SECONDARY_MODE,
+       SETTING_SMOOTH_ABSOLUTE_MOUSE,
+       SETTING_STEAMBUTTON_POWEROFF_TIME,
+       SETTING_UNUSED_1,
+       SETTING_TRACKPAD_OUTER_RADIUS,
+       SETTING_TRACKPAD_Z_ON_LEFT,
+       SETTING_TRACKPAD_Z_OFF_LEFT,
+
+       /* 30 */
+       SETTING_TRACKPAD_OUTER_SPIN_VEL,
+       SETTING_TRACKPAD_OUTER_SPIN_RADIUS,
+       SETTING_TRACKPAD_OUTER_SPIN_HORIZONTAL_ONLY,
+       SETTING_TRACKPAD_RELATIVE_MODE_DEADZONE,
+       SETTING_TRACKPAD_RELATIVE_MODE_MAX_VEL,
+       SETTING_TRACKPAD_RELATIVE_MODE_INVERT_Y,
+       SETTING_TRACKPAD_DOUBLE_TAP_BEEP_ENABLED,
+       SETTING_TRACKPAD_DOUBLE_TAP_BEEP_PERIOD,
+       SETTING_TRACKPAD_DOUBLE_TAP_BEEP_COUNT,
+       SETTING_TRACKPAD_OUTER_RADIUS_RELEASE_ON_TRANSITION,
+
+       /* 40 */
+       SETTING_RADIAL_MODE_ANGLE,
+       SETTING_HAPTIC_INTENSITY_MOUSE_MODE,
+       SETTING_LEFT_DPAD_REQUIRES_CLICK,
+       SETTING_RIGHT_DPAD_REQUIRES_CLICK,
+       SETTING_LED_BASELINE_BRIGHTNESS,
+       SETTING_LED_USER_BRIGHTNESS,
+       SETTING_ENABLE_RAW_JOYSTICK,
+       SETTING_ENABLE_FAST_SCAN,
+       SETTING_IMU_MODE,
+       SETTING_WIRELESS_PACKET_VERSION,
+
+       /* 50 */
+       SETTING_SLEEP_INACTIVITY_TIMEOUT,
+       SETTING_TRACKPAD_NOISE_THRESHOLD,
+       SETTING_LEFT_TRACKPAD_CLICK_PRESSURE,
+       SETTING_RIGHT_TRACKPAD_CLICK_PRESSURE,
+       SETTING_LEFT_BUMPER_CLICK_PRESSURE,
+       SETTING_RIGHT_BUMPER_CLICK_PRESSURE,
+       SETTING_LEFT_GRIP_CLICK_PRESSURE,
+       SETTING_RIGHT_GRIP_CLICK_PRESSURE,
+       SETTING_LEFT_GRIP2_CLICK_PRESSURE,
+       SETTING_RIGHT_GRIP2_CLICK_PRESSURE,
+
+       /* 60 */
+       SETTING_PRESSURE_MODE,
+       SETTING_CONTROLLER_TEST_MODE,
+       SETTING_TRIGGER_MODE,
+       SETTING_TRACKPAD_Z_THRESHOLD,
+       SETTING_FRAME_RATE,
+       SETTING_TRACKPAD_FILT_CTRL,
+       SETTING_TRACKPAD_CLIP,
+       SETTING_DEBUG_OUTPUT_SELECT,
+       SETTING_TRIGGER_THRESHOLD_PERCENT,
+       SETTING_TRACKPAD_FREQUENCY_HOPPING,
+
+       /* 70 */
+       SETTING_HAPTICS_ENABLED,
+       SETTING_STEAM_WATCHDOG_ENABLE,
+       SETTING_TIMP_TOUCH_THRESHOLD_ON,
+       SETTING_TIMP_TOUCH_THRESHOLD_OFF,
+       SETTING_FREQ_HOPPING,
+       SETTING_TEST_CONTROL,
+       SETTING_HAPTIC_MASTER_GAIN_DB,
+       SETTING_THUMB_TOUCH_THRESH,
+       SETTING_DEVICE_POWER_STATUS,
+       SETTING_HAPTIC_INTENSITY,
+
+       /* 80 */
+       SETTING_STABILIZER_ENABLED,
+       SETTING_TIMP_MODE_MTE,
+};
+
+/* Input report identifiers */
+enum
+{
+       ID_CONTROLLER_STATE = 1,
+       ID_CONTROLLER_DEBUG = 2,
+       ID_CONTROLLER_WIRELESS = 3,
+       ID_CONTROLLER_STATUS = 4,
+       ID_CONTROLLER_DEBUG2 = 5,
+       ID_CONTROLLER_SECONDARY_STATE = 6,
+       ID_CONTROLLER_BLE_STATE = 7,
+       ID_CONTROLLER_DECK_STATE = 9
+};
+
+/* String attribute idenitifiers */
+enum {
+       ATTRIB_STR_BOARD_SERIAL,
+       ATTRIB_STR_UNIT_SERIAL,
+};
 
 /* Values for GYRO_MODE (bitmask) */
-#define STEAM_GYRO_MODE_OFF            0x0000
-#define STEAM_GYRO_MODE_STEERING       0x0001
-#define STEAM_GYRO_MODE_TILT           0x0002
-#define STEAM_GYRO_MODE_SEND_ORIENTATION       0x0004
-#define STEAM_GYRO_MODE_SEND_RAW_ACCEL         0x0008
-#define STEAM_GYRO_MODE_SEND_RAW_GYRO          0x0010
+enum {
+       SETTING_GYRO_MODE_OFF                   = 0,
+       SETTING_GYRO_MODE_STEERING              = BIT(0),
+       SETTING_GYRO_MODE_TILT                  = BIT(1),
+       SETTING_GYRO_MODE_SEND_ORIENTATION      = BIT(2),
+       SETTING_GYRO_MODE_SEND_RAW_ACCEL        = BIT(3),
+       SETTING_GYRO_MODE_SEND_RAW_GYRO         = BIT(4),
+};
+
+/* Trackpad modes */
+enum {
+       TRACKPAD_ABSOLUTE_MOUSE,
+       TRACKPAD_RELATIVE_MOUSE,
+       TRACKPAD_DPAD_FOUR_WAY_DISCRETE,
+       TRACKPAD_DPAD_FOUR_WAY_OVERLAP,
+       TRACKPAD_DPAD_EIGHT_WAY,
+       TRACKPAD_RADIAL_MODE,
+       TRACKPAD_ABSOLUTE_DPAD,
+       TRACKPAD_NONE,
+       TRACKPAD_GESTURE_KEYBOARD,
+};
 
 /* Other random constants */
 #define STEAM_SERIAL_LEN 10
@@ -226,13 +382,13 @@ static inline int steam_send_report_byte(struct steam_device *steam, u8 cmd)
        return steam_send_report(steam, &cmd, 1);
 }
 
-static int steam_write_registers(struct steam_device *steam,
+static int steam_write_settings(struct steam_device *steam,
                /* u8 reg, u16 val */...)
 {
        /* Send: 0x87 len (reg valLo valHi)* */
        u8 reg;
        u16 val;
-       u8 cmd[64] = {STEAM_CMD_WRITE_REGISTER, 0x00};
+       u8 cmd[64] = {ID_SET_SETTINGS_VALUES, 0x00};
        int ret;
        va_list args;
 
@@ -268,7 +424,7 @@ static int steam_get_serial(struct steam_device *steam)
         * Recv: 0xae 0x15 0x01 serialnumber (10 chars)
         */
        int ret = 0;
-       u8 cmd[] = {STEAM_CMD_GET_SERIAL, 0x15, 0x01};
+       u8 cmd[] = {ID_GET_STRING_ATTRIBUTE, 0x15, ATTRIB_STR_UNIT_SERIAL};
        u8 reply[3 + STEAM_SERIAL_LEN + 1];
 
        mutex_lock(&steam->report_mutex);
@@ -278,7 +434,7 @@ static int steam_get_serial(struct steam_device *steam)
        ret = steam_recv_report(steam, reply, sizeof(reply));
        if (ret < 0)
                goto out;
-       if (reply[0] != 0xae || reply[1] != 0x15 || reply[2] != 0x01) {
+       if (reply[0] != ID_GET_STRING_ATTRIBUTE || reply[1] != 0x15 || reply[2] != ATTRIB_STR_UNIT_SERIAL) {
                ret = -EIO;
                goto out;
        }
@@ -298,7 +454,7 @@ static inline int steam_request_conn_status(struct steam_device *steam)
 {
        int ret;
        mutex_lock(&steam->report_mutex);
-       ret = steam_send_report_byte(steam, STEAM_CMD_REQUEST_COMM_STATUS);
+       ret = steam_send_report_byte(steam, ID_DONGLE_GET_WIRELESS_STATE);
        mutex_unlock(&steam->report_mutex);
        return ret;
 }
@@ -308,7 +464,7 @@ static inline int steam_haptic_rumble(struct steam_device *steam,
                                u8 left_gain, u8 right_gain)
 {
        int ret;
-       u8 report[11] = {STEAM_CMD_HAPTIC_RUMBLE, 9};
+       u8 report[11] = {ID_TRIGGER_RUMBLE_CMD, 9};
 
        report[3] = intensity & 0xFF;
        report[4] = intensity >> 8;
@@ -351,28 +507,28 @@ static void steam_set_lizard_mode(struct steam_device *steam, bool enable)
        if (enable) {
                mutex_lock(&steam->report_mutex);
                /* enable esc, enter, cursors */
-               steam_send_report_byte(steam, STEAM_CMD_DEFAULT_MAPPINGS);
-               /* enable mouse */
-               steam_send_report_byte(steam, STEAM_CMD_DEFAULT_MOUSE);
+               steam_send_report_byte(steam, ID_SET_DEFAULT_DIGITAL_MAPPINGS);
+               /* reset settings */
+               steam_send_report_byte(steam, ID_LOAD_DEFAULT_SETTINGS);
                mutex_unlock(&steam->report_mutex);
        } else {
                mutex_lock(&steam->report_mutex);
                /* disable esc, enter, cursor */
-               steam_send_report_byte(steam, STEAM_CMD_CLEAR_MAPPINGS);
+               steam_send_report_byte(steam, ID_CLEAR_DIGITAL_MAPPINGS);
 
                if (steam->quirks & STEAM_QUIRK_DECK) {
-                       steam_write_registers(steam,
-                               STEAM_REG_LPAD_MODE, 0x07, /* disable mouse */
-                               STEAM_REG_RPAD_MODE, 0x07, /* disable mouse */
-                               STEAM_REG_LPAD_CLICK_PRESSURE, 0xFFFF, /* disable clicky pad */
-                               STEAM_REG_RPAD_CLICK_PRESSURE, 0xFFFF, /* disable clicky pad */
-                               STEAM_REG_WATCHDOG_ENABLE, 0, /* disable watchdog that tests if Steam is active */
+                       steam_write_settings(steam,
+                               SETTING_LEFT_TRACKPAD_MODE, TRACKPAD_NONE, /* disable mouse */
+                               SETTING_RIGHT_TRACKPAD_MODE, TRACKPAD_NONE, /* disable mouse */
+                               SETTING_LEFT_TRACKPAD_CLICK_PRESSURE, 0xFFFF, /* disable haptic click */
+                               SETTING_RIGHT_TRACKPAD_CLICK_PRESSURE, 0xFFFF, /* disable haptic click */
+                               SETTING_STEAM_WATCHDOG_ENABLE, 0, /* disable watchdog that tests if Steam is active */
                                0);
                        mutex_unlock(&steam->report_mutex);
                } else {
-                       steam_write_registers(steam,
-                               STEAM_REG_LPAD_MODE, 0x07, /* disable mouse */
-                               STEAM_REG_RPAD_MODE, 0x07, /* disable mouse */
+                       steam_write_settings(steam,
+                               SETTING_LEFT_TRACKPAD_MODE, TRACKPAD_NONE, /* disable mouse */
+                               SETTING_RIGHT_TRACKPAD_MODE, TRACKPAD_NONE, /* disable mouse */
                                0);
                        mutex_unlock(&steam->report_mutex);
                }
@@ -1362,7 +1518,7 @@ static int steam_raw_event(struct hid_device *hdev,
                return 0;
 
        switch (data[2]) {
-       case STEAM_EV_INPUT_DATA:
+       case ID_CONTROLLER_STATE:
                if (steam->client_opened)
                        return 0;
                rcu_read_lock();
@@ -1371,7 +1527,7 @@ static int steam_raw_event(struct hid_device *hdev,
                        steam_do_input_event(steam, input, data);
                rcu_read_unlock();
                break;
-       case STEAM_EV_DECK_INPUT_DATA:
+       case ID_CONTROLLER_DECK_STATE:
                if (steam->client_opened)
                        return 0;
                rcu_read_lock();
@@ -1380,7 +1536,7 @@ static int steam_raw_event(struct hid_device *hdev,
                        steam_do_deck_input_event(steam, input, data);
                rcu_read_unlock();
                break;
-       case STEAM_EV_CONNECT:
+       case ID_CONTROLLER_WIRELESS:
                /*
                 * The payload of this event is a single byte:
                 *  0x01: disconnected.
@@ -1395,7 +1551,7 @@ static int steam_raw_event(struct hid_device *hdev,
                        break;
                }
                break;
-       case STEAM_EV_BATTERY:
+       case ID_CONTROLLER_STATUS:
                if (steam->quirks & STEAM_QUIRK_WIRELESS) {
                        rcu_read_lock();
                        battery = rcu_dereference(steam->battery);