18c2ecf20Sopenharmony_ci// SPDX-License-Identifier: GPL-2.0-or-later
28c2ecf20Sopenharmony_ci/*
38c2ecf20Sopenharmony_ci * HID driver for Corsair devices
48c2ecf20Sopenharmony_ci *
58c2ecf20Sopenharmony_ci * Supported devices:
68c2ecf20Sopenharmony_ci *  - Vengeance K70 Keyboard
78c2ecf20Sopenharmony_ci *  - K70 RAPIDFIRE Keyboard
88c2ecf20Sopenharmony_ci *  - Vengeance K90 Keyboard
98c2ecf20Sopenharmony_ci *  - Scimitar PRO RGB Gaming Mouse
108c2ecf20Sopenharmony_ci *
118c2ecf20Sopenharmony_ci * Copyright (c) 2015 Clement Vuchener
128c2ecf20Sopenharmony_ci * Copyright (c) 2017 Oscar Campos
138c2ecf20Sopenharmony_ci * Copyright (c) 2017 Aaron Bottegal
148c2ecf20Sopenharmony_ci */
158c2ecf20Sopenharmony_ci
168c2ecf20Sopenharmony_ci/*
178c2ecf20Sopenharmony_ci */
188c2ecf20Sopenharmony_ci
198c2ecf20Sopenharmony_ci#include <linux/hid.h>
208c2ecf20Sopenharmony_ci#include <linux/module.h>
218c2ecf20Sopenharmony_ci#include <linux/usb.h>
228c2ecf20Sopenharmony_ci#include <linux/leds.h>
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ci#include "hid-ids.h"
258c2ecf20Sopenharmony_ci
268c2ecf20Sopenharmony_ci#define CORSAIR_USE_K90_MACRO	(1<<0)
278c2ecf20Sopenharmony_ci#define CORSAIR_USE_K90_BACKLIGHT	(1<<1)
288c2ecf20Sopenharmony_ci
298c2ecf20Sopenharmony_cistruct k90_led {
308c2ecf20Sopenharmony_ci	struct led_classdev cdev;
318c2ecf20Sopenharmony_ci	int brightness;
328c2ecf20Sopenharmony_ci	struct work_struct work;
338c2ecf20Sopenharmony_ci	bool removed;
348c2ecf20Sopenharmony_ci};
358c2ecf20Sopenharmony_ci
368c2ecf20Sopenharmony_cistruct k90_drvdata {
378c2ecf20Sopenharmony_ci	struct k90_led record_led;
388c2ecf20Sopenharmony_ci};
398c2ecf20Sopenharmony_ci
408c2ecf20Sopenharmony_cistruct corsair_drvdata {
418c2ecf20Sopenharmony_ci	unsigned long quirks;
428c2ecf20Sopenharmony_ci	struct k90_drvdata *k90;
438c2ecf20Sopenharmony_ci	struct k90_led *backlight;
448c2ecf20Sopenharmony_ci};
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ci#define K90_GKEY_COUNT	18
478c2ecf20Sopenharmony_ci
488c2ecf20Sopenharmony_cistatic int corsair_usage_to_gkey(unsigned int usage)
498c2ecf20Sopenharmony_ci{
508c2ecf20Sopenharmony_ci	/* G1 (0xd0) to G16 (0xdf) */
518c2ecf20Sopenharmony_ci	if (usage >= 0xd0 && usage <= 0xdf)
528c2ecf20Sopenharmony_ci		return usage - 0xd0 + 1;
538c2ecf20Sopenharmony_ci	/* G17 (0xe8) to G18 (0xe9) */
548c2ecf20Sopenharmony_ci	if (usage >= 0xe8 && usage <= 0xe9)
558c2ecf20Sopenharmony_ci		return usage - 0xe8 + 17;
568c2ecf20Sopenharmony_ci	return 0;
578c2ecf20Sopenharmony_ci}
588c2ecf20Sopenharmony_ci
598c2ecf20Sopenharmony_cistatic unsigned short corsair_gkey_map[K90_GKEY_COUNT] = {
608c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY1,
618c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY2,
628c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY3,
638c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY4,
648c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY5,
658c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY6,
668c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY7,
678c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY8,
688c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY9,
698c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY10,
708c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY11,
718c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY12,
728c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY13,
738c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY14,
748c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY15,
758c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY16,
768c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY17,
778c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY18,
788c2ecf20Sopenharmony_ci};
798c2ecf20Sopenharmony_ci
808c2ecf20Sopenharmony_cimodule_param_array_named(gkey_codes, corsair_gkey_map, ushort, NULL, S_IRUGO);
818c2ecf20Sopenharmony_ciMODULE_PARM_DESC(gkey_codes, "Key codes for the G-keys");
828c2ecf20Sopenharmony_ci
838c2ecf20Sopenharmony_cistatic unsigned short corsair_record_keycodes[2] = {
848c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY19,
858c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY20
868c2ecf20Sopenharmony_ci};
878c2ecf20Sopenharmony_ci
888c2ecf20Sopenharmony_cimodule_param_array_named(recordkey_codes, corsair_record_keycodes, ushort,
898c2ecf20Sopenharmony_ci			 NULL, S_IRUGO);
908c2ecf20Sopenharmony_ciMODULE_PARM_DESC(recordkey_codes, "Key codes for the MR (start and stop record) button");
918c2ecf20Sopenharmony_ci
928c2ecf20Sopenharmony_cistatic unsigned short corsair_profile_keycodes[3] = {
938c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY21,
948c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY22,
958c2ecf20Sopenharmony_ci	BTN_TRIGGER_HAPPY23
968c2ecf20Sopenharmony_ci};
978c2ecf20Sopenharmony_ci
988c2ecf20Sopenharmony_cimodule_param_array_named(profilekey_codes, corsair_profile_keycodes, ushort,
998c2ecf20Sopenharmony_ci			 NULL, S_IRUGO);
1008c2ecf20Sopenharmony_ciMODULE_PARM_DESC(profilekey_codes, "Key codes for the profile buttons");
1018c2ecf20Sopenharmony_ci
1028c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_SPECIAL_MIN 0xf0
1038c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_SPECIAL_MAX 0xff
1048c2ecf20Sopenharmony_ci
1058c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_MACRO_RECORD_START 0xf6
1068c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_MACRO_RECORD_STOP 0xf7
1078c2ecf20Sopenharmony_ci
1088c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_PROFILE 0xf1
1098c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_M1 0xf1
1108c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_M2 0xf2
1118c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_M3 0xf3
1128c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_PROFILE_MAX 0xf3
1138c2ecf20Sopenharmony_ci
1148c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_META_OFF 0xf4
1158c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_META_ON  0xf5
1168c2ecf20Sopenharmony_ci
1178c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_LIGHT 0xfa
1188c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_LIGHT_OFF 0xfa
1198c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_LIGHT_DIM 0xfb
1208c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_LIGHT_MEDIUM 0xfc
1218c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_LIGHT_BRIGHT 0xfd
1228c2ecf20Sopenharmony_ci#define CORSAIR_USAGE_LIGHT_MAX 0xfd
1238c2ecf20Sopenharmony_ci
1248c2ecf20Sopenharmony_ci/* USB control protocol */
1258c2ecf20Sopenharmony_ci
1268c2ecf20Sopenharmony_ci#define K90_REQUEST_BRIGHTNESS 49
1278c2ecf20Sopenharmony_ci#define K90_REQUEST_MACRO_MODE 2
1288c2ecf20Sopenharmony_ci#define K90_REQUEST_STATUS 4
1298c2ecf20Sopenharmony_ci#define K90_REQUEST_GET_MODE 5
1308c2ecf20Sopenharmony_ci#define K90_REQUEST_PROFILE 20
1318c2ecf20Sopenharmony_ci
1328c2ecf20Sopenharmony_ci#define K90_MACRO_MODE_SW 0x0030
1338c2ecf20Sopenharmony_ci#define K90_MACRO_MODE_HW 0x0001
1348c2ecf20Sopenharmony_ci
1358c2ecf20Sopenharmony_ci#define K90_MACRO_LED_ON  0x0020
1368c2ecf20Sopenharmony_ci#define K90_MACRO_LED_OFF 0x0040
1378c2ecf20Sopenharmony_ci
1388c2ecf20Sopenharmony_ci/*
1398c2ecf20Sopenharmony_ci * LED class devices
1408c2ecf20Sopenharmony_ci */
1418c2ecf20Sopenharmony_ci
1428c2ecf20Sopenharmony_ci#define K90_BACKLIGHT_LED_SUFFIX "::backlight"
1438c2ecf20Sopenharmony_ci#define K90_RECORD_LED_SUFFIX "::record"
1448c2ecf20Sopenharmony_ci
1458c2ecf20Sopenharmony_cistatic enum led_brightness k90_backlight_get(struct led_classdev *led_cdev)
1468c2ecf20Sopenharmony_ci{
1478c2ecf20Sopenharmony_ci	int ret;
1488c2ecf20Sopenharmony_ci	struct k90_led *led = container_of(led_cdev, struct k90_led, cdev);
1498c2ecf20Sopenharmony_ci	struct device *dev = led->cdev.dev->parent;
1508c2ecf20Sopenharmony_ci	struct usb_interface *usbif = to_usb_interface(dev->parent);
1518c2ecf20Sopenharmony_ci	struct usb_device *usbdev = interface_to_usbdev(usbif);
1528c2ecf20Sopenharmony_ci	int brightness;
1538c2ecf20Sopenharmony_ci	char *data;
1548c2ecf20Sopenharmony_ci
1558c2ecf20Sopenharmony_ci	data = kmalloc(8, GFP_KERNEL);
1568c2ecf20Sopenharmony_ci	if (!data)
1578c2ecf20Sopenharmony_ci		return -ENOMEM;
1588c2ecf20Sopenharmony_ci
1598c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
1608c2ecf20Sopenharmony_ci			      K90_REQUEST_STATUS,
1618c2ecf20Sopenharmony_ci			      USB_DIR_IN | USB_TYPE_VENDOR |
1628c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, 0, 0, data, 8,
1638c2ecf20Sopenharmony_ci			      USB_CTRL_SET_TIMEOUT);
1648c2ecf20Sopenharmony_ci	if (ret < 5) {
1658c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to get K90 initial state (error %d).\n",
1668c2ecf20Sopenharmony_ci			 ret);
1678c2ecf20Sopenharmony_ci		ret = -EIO;
1688c2ecf20Sopenharmony_ci		goto out;
1698c2ecf20Sopenharmony_ci	}
1708c2ecf20Sopenharmony_ci	brightness = data[4];
1718c2ecf20Sopenharmony_ci	if (brightness < 0 || brightness > 3) {
1728c2ecf20Sopenharmony_ci		dev_warn(dev,
1738c2ecf20Sopenharmony_ci			 "Read invalid backlight brightness: %02hhx.\n",
1748c2ecf20Sopenharmony_ci			 data[4]);
1758c2ecf20Sopenharmony_ci		ret = -EIO;
1768c2ecf20Sopenharmony_ci		goto out;
1778c2ecf20Sopenharmony_ci	}
1788c2ecf20Sopenharmony_ci	ret = brightness;
1798c2ecf20Sopenharmony_ciout:
1808c2ecf20Sopenharmony_ci	kfree(data);
1818c2ecf20Sopenharmony_ci
1828c2ecf20Sopenharmony_ci	return ret;
1838c2ecf20Sopenharmony_ci}
1848c2ecf20Sopenharmony_ci
1858c2ecf20Sopenharmony_cistatic enum led_brightness k90_record_led_get(struct led_classdev *led_cdev)
1868c2ecf20Sopenharmony_ci{
1878c2ecf20Sopenharmony_ci	struct k90_led *led = container_of(led_cdev, struct k90_led, cdev);
1888c2ecf20Sopenharmony_ci
1898c2ecf20Sopenharmony_ci	return led->brightness;
1908c2ecf20Sopenharmony_ci}
1918c2ecf20Sopenharmony_ci
1928c2ecf20Sopenharmony_cistatic void k90_brightness_set(struct led_classdev *led_cdev,
1938c2ecf20Sopenharmony_ci			       enum led_brightness brightness)
1948c2ecf20Sopenharmony_ci{
1958c2ecf20Sopenharmony_ci	struct k90_led *led = container_of(led_cdev, struct k90_led, cdev);
1968c2ecf20Sopenharmony_ci
1978c2ecf20Sopenharmony_ci	led->brightness = brightness;
1988c2ecf20Sopenharmony_ci	schedule_work(&led->work);
1998c2ecf20Sopenharmony_ci}
2008c2ecf20Sopenharmony_ci
2018c2ecf20Sopenharmony_cistatic void k90_backlight_work(struct work_struct *work)
2028c2ecf20Sopenharmony_ci{
2038c2ecf20Sopenharmony_ci	int ret;
2048c2ecf20Sopenharmony_ci	struct k90_led *led = container_of(work, struct k90_led, work);
2058c2ecf20Sopenharmony_ci	struct device *dev;
2068c2ecf20Sopenharmony_ci	struct usb_interface *usbif;
2078c2ecf20Sopenharmony_ci	struct usb_device *usbdev;
2088c2ecf20Sopenharmony_ci
2098c2ecf20Sopenharmony_ci	if (led->removed)
2108c2ecf20Sopenharmony_ci		return;
2118c2ecf20Sopenharmony_ci
2128c2ecf20Sopenharmony_ci	dev = led->cdev.dev->parent;
2138c2ecf20Sopenharmony_ci	usbif = to_usb_interface(dev->parent);
2148c2ecf20Sopenharmony_ci	usbdev = interface_to_usbdev(usbif);
2158c2ecf20Sopenharmony_ci
2168c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
2178c2ecf20Sopenharmony_ci			      K90_REQUEST_BRIGHTNESS,
2188c2ecf20Sopenharmony_ci			      USB_DIR_OUT | USB_TYPE_VENDOR |
2198c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, led->brightness, 0,
2208c2ecf20Sopenharmony_ci			      NULL, 0, USB_CTRL_SET_TIMEOUT);
2218c2ecf20Sopenharmony_ci	if (ret != 0)
2228c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to set backlight brightness (error: %d).\n",
2238c2ecf20Sopenharmony_ci			 ret);
2248c2ecf20Sopenharmony_ci}
2258c2ecf20Sopenharmony_ci
2268c2ecf20Sopenharmony_cistatic void k90_record_led_work(struct work_struct *work)
2278c2ecf20Sopenharmony_ci{
2288c2ecf20Sopenharmony_ci	int ret;
2298c2ecf20Sopenharmony_ci	struct k90_led *led = container_of(work, struct k90_led, work);
2308c2ecf20Sopenharmony_ci	struct device *dev;
2318c2ecf20Sopenharmony_ci	struct usb_interface *usbif;
2328c2ecf20Sopenharmony_ci	struct usb_device *usbdev;
2338c2ecf20Sopenharmony_ci	int value;
2348c2ecf20Sopenharmony_ci
2358c2ecf20Sopenharmony_ci	if (led->removed)
2368c2ecf20Sopenharmony_ci		return;
2378c2ecf20Sopenharmony_ci
2388c2ecf20Sopenharmony_ci	dev = led->cdev.dev->parent;
2398c2ecf20Sopenharmony_ci	usbif = to_usb_interface(dev->parent);
2408c2ecf20Sopenharmony_ci	usbdev = interface_to_usbdev(usbif);
2418c2ecf20Sopenharmony_ci
2428c2ecf20Sopenharmony_ci	if (led->brightness > 0)
2438c2ecf20Sopenharmony_ci		value = K90_MACRO_LED_ON;
2448c2ecf20Sopenharmony_ci	else
2458c2ecf20Sopenharmony_ci		value = K90_MACRO_LED_OFF;
2468c2ecf20Sopenharmony_ci
2478c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
2488c2ecf20Sopenharmony_ci			      K90_REQUEST_MACRO_MODE,
2498c2ecf20Sopenharmony_ci			      USB_DIR_OUT | USB_TYPE_VENDOR |
2508c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, value, 0, NULL, 0,
2518c2ecf20Sopenharmony_ci			      USB_CTRL_SET_TIMEOUT);
2528c2ecf20Sopenharmony_ci	if (ret != 0)
2538c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to set record LED state (error: %d).\n",
2548c2ecf20Sopenharmony_ci			 ret);
2558c2ecf20Sopenharmony_ci}
2568c2ecf20Sopenharmony_ci
2578c2ecf20Sopenharmony_ci/*
2588c2ecf20Sopenharmony_ci * Keyboard attributes
2598c2ecf20Sopenharmony_ci */
2608c2ecf20Sopenharmony_ci
2618c2ecf20Sopenharmony_cistatic ssize_t k90_show_macro_mode(struct device *dev,
2628c2ecf20Sopenharmony_ci				   struct device_attribute *attr, char *buf)
2638c2ecf20Sopenharmony_ci{
2648c2ecf20Sopenharmony_ci	int ret;
2658c2ecf20Sopenharmony_ci	struct usb_interface *usbif = to_usb_interface(dev->parent);
2668c2ecf20Sopenharmony_ci	struct usb_device *usbdev = interface_to_usbdev(usbif);
2678c2ecf20Sopenharmony_ci	const char *macro_mode;
2688c2ecf20Sopenharmony_ci	char *data;
2698c2ecf20Sopenharmony_ci
2708c2ecf20Sopenharmony_ci	data = kmalloc(2, GFP_KERNEL);
2718c2ecf20Sopenharmony_ci	if (!data)
2728c2ecf20Sopenharmony_ci		return -ENOMEM;
2738c2ecf20Sopenharmony_ci
2748c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2758c2ecf20Sopenharmony_ci			      K90_REQUEST_GET_MODE,
2768c2ecf20Sopenharmony_ci			      USB_DIR_IN | USB_TYPE_VENDOR |
2778c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, 0, 0, data, 2,
2788c2ecf20Sopenharmony_ci			      USB_CTRL_SET_TIMEOUT);
2798c2ecf20Sopenharmony_ci	if (ret < 1) {
2808c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to get K90 initial mode (error %d).\n",
2818c2ecf20Sopenharmony_ci			 ret);
2828c2ecf20Sopenharmony_ci		ret = -EIO;
2838c2ecf20Sopenharmony_ci		goto out;
2848c2ecf20Sopenharmony_ci	}
2858c2ecf20Sopenharmony_ci
2868c2ecf20Sopenharmony_ci	switch (data[0]) {
2878c2ecf20Sopenharmony_ci	case K90_MACRO_MODE_HW:
2888c2ecf20Sopenharmony_ci		macro_mode = "HW";
2898c2ecf20Sopenharmony_ci		break;
2908c2ecf20Sopenharmony_ci
2918c2ecf20Sopenharmony_ci	case K90_MACRO_MODE_SW:
2928c2ecf20Sopenharmony_ci		macro_mode = "SW";
2938c2ecf20Sopenharmony_ci		break;
2948c2ecf20Sopenharmony_ci	default:
2958c2ecf20Sopenharmony_ci		dev_warn(dev, "K90 in unknown mode: %02hhx.\n",
2968c2ecf20Sopenharmony_ci			 data[0]);
2978c2ecf20Sopenharmony_ci		ret = -EIO;
2988c2ecf20Sopenharmony_ci		goto out;
2998c2ecf20Sopenharmony_ci	}
3008c2ecf20Sopenharmony_ci
3018c2ecf20Sopenharmony_ci	ret = snprintf(buf, PAGE_SIZE, "%s\n", macro_mode);
3028c2ecf20Sopenharmony_ciout:
3038c2ecf20Sopenharmony_ci	kfree(data);
3048c2ecf20Sopenharmony_ci
3058c2ecf20Sopenharmony_ci	return ret;
3068c2ecf20Sopenharmony_ci}
3078c2ecf20Sopenharmony_ci
3088c2ecf20Sopenharmony_cistatic ssize_t k90_store_macro_mode(struct device *dev,
3098c2ecf20Sopenharmony_ci				    struct device_attribute *attr,
3108c2ecf20Sopenharmony_ci				    const char *buf, size_t count)
3118c2ecf20Sopenharmony_ci{
3128c2ecf20Sopenharmony_ci	int ret;
3138c2ecf20Sopenharmony_ci	struct usb_interface *usbif = to_usb_interface(dev->parent);
3148c2ecf20Sopenharmony_ci	struct usb_device *usbdev = interface_to_usbdev(usbif);
3158c2ecf20Sopenharmony_ci	__u16 value;
3168c2ecf20Sopenharmony_ci
3178c2ecf20Sopenharmony_ci	if (strncmp(buf, "SW", 2) == 0)
3188c2ecf20Sopenharmony_ci		value = K90_MACRO_MODE_SW;
3198c2ecf20Sopenharmony_ci	else if (strncmp(buf, "HW", 2) == 0)
3208c2ecf20Sopenharmony_ci		value = K90_MACRO_MODE_HW;
3218c2ecf20Sopenharmony_ci	else
3228c2ecf20Sopenharmony_ci		return -EINVAL;
3238c2ecf20Sopenharmony_ci
3248c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
3258c2ecf20Sopenharmony_ci			      K90_REQUEST_MACRO_MODE,
3268c2ecf20Sopenharmony_ci			      USB_DIR_OUT | USB_TYPE_VENDOR |
3278c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, value, 0, NULL, 0,
3288c2ecf20Sopenharmony_ci			      USB_CTRL_SET_TIMEOUT);
3298c2ecf20Sopenharmony_ci	if (ret != 0) {
3308c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to set macro mode.\n");
3318c2ecf20Sopenharmony_ci		return ret;
3328c2ecf20Sopenharmony_ci	}
3338c2ecf20Sopenharmony_ci
3348c2ecf20Sopenharmony_ci	return count;
3358c2ecf20Sopenharmony_ci}
3368c2ecf20Sopenharmony_ci
3378c2ecf20Sopenharmony_cistatic ssize_t k90_show_current_profile(struct device *dev,
3388c2ecf20Sopenharmony_ci					struct device_attribute *attr,
3398c2ecf20Sopenharmony_ci					char *buf)
3408c2ecf20Sopenharmony_ci{
3418c2ecf20Sopenharmony_ci	int ret;
3428c2ecf20Sopenharmony_ci	struct usb_interface *usbif = to_usb_interface(dev->parent);
3438c2ecf20Sopenharmony_ci	struct usb_device *usbdev = interface_to_usbdev(usbif);
3448c2ecf20Sopenharmony_ci	int current_profile;
3458c2ecf20Sopenharmony_ci	char *data;
3468c2ecf20Sopenharmony_ci
3478c2ecf20Sopenharmony_ci	data = kmalloc(8, GFP_KERNEL);
3488c2ecf20Sopenharmony_ci	if (!data)
3498c2ecf20Sopenharmony_ci		return -ENOMEM;
3508c2ecf20Sopenharmony_ci
3518c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
3528c2ecf20Sopenharmony_ci			      K90_REQUEST_STATUS,
3538c2ecf20Sopenharmony_ci			      USB_DIR_IN | USB_TYPE_VENDOR |
3548c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, 0, 0, data, 8,
3558c2ecf20Sopenharmony_ci			      USB_CTRL_SET_TIMEOUT);
3568c2ecf20Sopenharmony_ci	if (ret < 8) {
3578c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to get K90 initial state (error %d).\n",
3588c2ecf20Sopenharmony_ci			 ret);
3598c2ecf20Sopenharmony_ci		ret = -EIO;
3608c2ecf20Sopenharmony_ci		goto out;
3618c2ecf20Sopenharmony_ci	}
3628c2ecf20Sopenharmony_ci	current_profile = data[7];
3638c2ecf20Sopenharmony_ci	if (current_profile < 1 || current_profile > 3) {
3648c2ecf20Sopenharmony_ci		dev_warn(dev, "Read invalid current profile: %02hhx.\n",
3658c2ecf20Sopenharmony_ci			 data[7]);
3668c2ecf20Sopenharmony_ci		ret = -EIO;
3678c2ecf20Sopenharmony_ci		goto out;
3688c2ecf20Sopenharmony_ci	}
3698c2ecf20Sopenharmony_ci
3708c2ecf20Sopenharmony_ci	ret = snprintf(buf, PAGE_SIZE, "%d\n", current_profile);
3718c2ecf20Sopenharmony_ciout:
3728c2ecf20Sopenharmony_ci	kfree(data);
3738c2ecf20Sopenharmony_ci
3748c2ecf20Sopenharmony_ci	return ret;
3758c2ecf20Sopenharmony_ci}
3768c2ecf20Sopenharmony_ci
3778c2ecf20Sopenharmony_cistatic ssize_t k90_store_current_profile(struct device *dev,
3788c2ecf20Sopenharmony_ci					 struct device_attribute *attr,
3798c2ecf20Sopenharmony_ci					 const char *buf, size_t count)
3808c2ecf20Sopenharmony_ci{
3818c2ecf20Sopenharmony_ci	int ret;
3828c2ecf20Sopenharmony_ci	struct usb_interface *usbif = to_usb_interface(dev->parent);
3838c2ecf20Sopenharmony_ci	struct usb_device *usbdev = interface_to_usbdev(usbif);
3848c2ecf20Sopenharmony_ci	int profile;
3858c2ecf20Sopenharmony_ci
3868c2ecf20Sopenharmony_ci	if (kstrtoint(buf, 10, &profile))
3878c2ecf20Sopenharmony_ci		return -EINVAL;
3888c2ecf20Sopenharmony_ci	if (profile < 1 || profile > 3)
3898c2ecf20Sopenharmony_ci		return -EINVAL;
3908c2ecf20Sopenharmony_ci
3918c2ecf20Sopenharmony_ci	ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
3928c2ecf20Sopenharmony_ci			      K90_REQUEST_PROFILE,
3938c2ecf20Sopenharmony_ci			      USB_DIR_OUT | USB_TYPE_VENDOR |
3948c2ecf20Sopenharmony_ci			      USB_RECIP_DEVICE, profile, 0, NULL, 0,
3958c2ecf20Sopenharmony_ci			      USB_CTRL_SET_TIMEOUT);
3968c2ecf20Sopenharmony_ci	if (ret != 0) {
3978c2ecf20Sopenharmony_ci		dev_warn(dev, "Failed to change current profile (error %d).\n",
3988c2ecf20Sopenharmony_ci			 ret);
3998c2ecf20Sopenharmony_ci		return ret;
4008c2ecf20Sopenharmony_ci	}
4018c2ecf20Sopenharmony_ci
4028c2ecf20Sopenharmony_ci	return count;
4038c2ecf20Sopenharmony_ci}
4048c2ecf20Sopenharmony_ci
4058c2ecf20Sopenharmony_cistatic DEVICE_ATTR(macro_mode, 0644, k90_show_macro_mode, k90_store_macro_mode);
4068c2ecf20Sopenharmony_cistatic DEVICE_ATTR(current_profile, 0644, k90_show_current_profile,
4078c2ecf20Sopenharmony_ci		   k90_store_current_profile);
4088c2ecf20Sopenharmony_ci
4098c2ecf20Sopenharmony_cistatic struct attribute *k90_attrs[] = {
4108c2ecf20Sopenharmony_ci	&dev_attr_macro_mode.attr,
4118c2ecf20Sopenharmony_ci	&dev_attr_current_profile.attr,
4128c2ecf20Sopenharmony_ci	NULL
4138c2ecf20Sopenharmony_ci};
4148c2ecf20Sopenharmony_ci
4158c2ecf20Sopenharmony_cistatic const struct attribute_group k90_attr_group = {
4168c2ecf20Sopenharmony_ci	.attrs = k90_attrs,
4178c2ecf20Sopenharmony_ci};
4188c2ecf20Sopenharmony_ci
4198c2ecf20Sopenharmony_ci/*
4208c2ecf20Sopenharmony_ci * Driver functions
4218c2ecf20Sopenharmony_ci */
4228c2ecf20Sopenharmony_ci
4238c2ecf20Sopenharmony_cistatic int k90_init_backlight(struct hid_device *dev)
4248c2ecf20Sopenharmony_ci{
4258c2ecf20Sopenharmony_ci	int ret;
4268c2ecf20Sopenharmony_ci	struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
4278c2ecf20Sopenharmony_ci	size_t name_sz;
4288c2ecf20Sopenharmony_ci	char *name;
4298c2ecf20Sopenharmony_ci
4308c2ecf20Sopenharmony_ci	drvdata->backlight = kzalloc(sizeof(struct k90_led), GFP_KERNEL);
4318c2ecf20Sopenharmony_ci	if (!drvdata->backlight) {
4328c2ecf20Sopenharmony_ci		ret = -ENOMEM;
4338c2ecf20Sopenharmony_ci		goto fail_backlight_alloc;
4348c2ecf20Sopenharmony_ci	}
4358c2ecf20Sopenharmony_ci
4368c2ecf20Sopenharmony_ci	name_sz =
4378c2ecf20Sopenharmony_ci	    strlen(dev_name(&dev->dev)) + sizeof(K90_BACKLIGHT_LED_SUFFIX);
4388c2ecf20Sopenharmony_ci	name = kzalloc(name_sz, GFP_KERNEL);
4398c2ecf20Sopenharmony_ci	if (!name) {
4408c2ecf20Sopenharmony_ci		ret = -ENOMEM;
4418c2ecf20Sopenharmony_ci		goto fail_name_alloc;
4428c2ecf20Sopenharmony_ci	}
4438c2ecf20Sopenharmony_ci	snprintf(name, name_sz, "%s" K90_BACKLIGHT_LED_SUFFIX,
4448c2ecf20Sopenharmony_ci		 dev_name(&dev->dev));
4458c2ecf20Sopenharmony_ci	drvdata->backlight->removed = false;
4468c2ecf20Sopenharmony_ci	drvdata->backlight->cdev.name = name;
4478c2ecf20Sopenharmony_ci	drvdata->backlight->cdev.max_brightness = 3;
4488c2ecf20Sopenharmony_ci	drvdata->backlight->cdev.brightness_set = k90_brightness_set;
4498c2ecf20Sopenharmony_ci	drvdata->backlight->cdev.brightness_get = k90_backlight_get;
4508c2ecf20Sopenharmony_ci	INIT_WORK(&drvdata->backlight->work, k90_backlight_work);
4518c2ecf20Sopenharmony_ci	ret = led_classdev_register(&dev->dev, &drvdata->backlight->cdev);
4528c2ecf20Sopenharmony_ci	if (ret != 0)
4538c2ecf20Sopenharmony_ci		goto fail_register_cdev;
4548c2ecf20Sopenharmony_ci
4558c2ecf20Sopenharmony_ci	return 0;
4568c2ecf20Sopenharmony_ci
4578c2ecf20Sopenharmony_cifail_register_cdev:
4588c2ecf20Sopenharmony_ci	kfree(drvdata->backlight->cdev.name);
4598c2ecf20Sopenharmony_cifail_name_alloc:
4608c2ecf20Sopenharmony_ci	kfree(drvdata->backlight);
4618c2ecf20Sopenharmony_ci	drvdata->backlight = NULL;
4628c2ecf20Sopenharmony_cifail_backlight_alloc:
4638c2ecf20Sopenharmony_ci	return ret;
4648c2ecf20Sopenharmony_ci}
4658c2ecf20Sopenharmony_ci
4668c2ecf20Sopenharmony_cistatic int k90_init_macro_functions(struct hid_device *dev)
4678c2ecf20Sopenharmony_ci{
4688c2ecf20Sopenharmony_ci	int ret;
4698c2ecf20Sopenharmony_ci	struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
4708c2ecf20Sopenharmony_ci	struct k90_drvdata *k90;
4718c2ecf20Sopenharmony_ci	size_t name_sz;
4728c2ecf20Sopenharmony_ci	char *name;
4738c2ecf20Sopenharmony_ci
4748c2ecf20Sopenharmony_ci	k90 = kzalloc(sizeof(struct k90_drvdata), GFP_KERNEL);
4758c2ecf20Sopenharmony_ci	if (!k90) {
4768c2ecf20Sopenharmony_ci		ret = -ENOMEM;
4778c2ecf20Sopenharmony_ci		goto fail_drvdata;
4788c2ecf20Sopenharmony_ci	}
4798c2ecf20Sopenharmony_ci	drvdata->k90 = k90;
4808c2ecf20Sopenharmony_ci
4818c2ecf20Sopenharmony_ci	/* Init LED device for record LED */
4828c2ecf20Sopenharmony_ci	name_sz = strlen(dev_name(&dev->dev)) + sizeof(K90_RECORD_LED_SUFFIX);
4838c2ecf20Sopenharmony_ci	name = kzalloc(name_sz, GFP_KERNEL);
4848c2ecf20Sopenharmony_ci	if (!name) {
4858c2ecf20Sopenharmony_ci		ret = -ENOMEM;
4868c2ecf20Sopenharmony_ci		goto fail_record_led_alloc;
4878c2ecf20Sopenharmony_ci	}
4888c2ecf20Sopenharmony_ci	snprintf(name, name_sz, "%s" K90_RECORD_LED_SUFFIX,
4898c2ecf20Sopenharmony_ci		 dev_name(&dev->dev));
4908c2ecf20Sopenharmony_ci	k90->record_led.removed = false;
4918c2ecf20Sopenharmony_ci	k90->record_led.cdev.name = name;
4928c2ecf20Sopenharmony_ci	k90->record_led.cdev.max_brightness = 1;
4938c2ecf20Sopenharmony_ci	k90->record_led.cdev.brightness_set = k90_brightness_set;
4948c2ecf20Sopenharmony_ci	k90->record_led.cdev.brightness_get = k90_record_led_get;
4958c2ecf20Sopenharmony_ci	INIT_WORK(&k90->record_led.work, k90_record_led_work);
4968c2ecf20Sopenharmony_ci	k90->record_led.brightness = 0;
4978c2ecf20Sopenharmony_ci	ret = led_classdev_register(&dev->dev, &k90->record_led.cdev);
4988c2ecf20Sopenharmony_ci	if (ret != 0)
4998c2ecf20Sopenharmony_ci		goto fail_record_led;
5008c2ecf20Sopenharmony_ci
5018c2ecf20Sopenharmony_ci	/* Init attributes */
5028c2ecf20Sopenharmony_ci	ret = sysfs_create_group(&dev->dev.kobj, &k90_attr_group);
5038c2ecf20Sopenharmony_ci	if (ret != 0)
5048c2ecf20Sopenharmony_ci		goto fail_sysfs;
5058c2ecf20Sopenharmony_ci
5068c2ecf20Sopenharmony_ci	return 0;
5078c2ecf20Sopenharmony_ci
5088c2ecf20Sopenharmony_cifail_sysfs:
5098c2ecf20Sopenharmony_ci	k90->record_led.removed = true;
5108c2ecf20Sopenharmony_ci	led_classdev_unregister(&k90->record_led.cdev);
5118c2ecf20Sopenharmony_ci	cancel_work_sync(&k90->record_led.work);
5128c2ecf20Sopenharmony_cifail_record_led:
5138c2ecf20Sopenharmony_ci	kfree(k90->record_led.cdev.name);
5148c2ecf20Sopenharmony_cifail_record_led_alloc:
5158c2ecf20Sopenharmony_ci	kfree(k90);
5168c2ecf20Sopenharmony_cifail_drvdata:
5178c2ecf20Sopenharmony_ci	drvdata->k90 = NULL;
5188c2ecf20Sopenharmony_ci	return ret;
5198c2ecf20Sopenharmony_ci}
5208c2ecf20Sopenharmony_ci
5218c2ecf20Sopenharmony_cistatic void k90_cleanup_backlight(struct hid_device *dev)
5228c2ecf20Sopenharmony_ci{
5238c2ecf20Sopenharmony_ci	struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
5248c2ecf20Sopenharmony_ci
5258c2ecf20Sopenharmony_ci	if (drvdata->backlight) {
5268c2ecf20Sopenharmony_ci		drvdata->backlight->removed = true;
5278c2ecf20Sopenharmony_ci		led_classdev_unregister(&drvdata->backlight->cdev);
5288c2ecf20Sopenharmony_ci		cancel_work_sync(&drvdata->backlight->work);
5298c2ecf20Sopenharmony_ci		kfree(drvdata->backlight->cdev.name);
5308c2ecf20Sopenharmony_ci		kfree(drvdata->backlight);
5318c2ecf20Sopenharmony_ci	}
5328c2ecf20Sopenharmony_ci}
5338c2ecf20Sopenharmony_ci
5348c2ecf20Sopenharmony_cistatic void k90_cleanup_macro_functions(struct hid_device *dev)
5358c2ecf20Sopenharmony_ci{
5368c2ecf20Sopenharmony_ci	struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
5378c2ecf20Sopenharmony_ci	struct k90_drvdata *k90 = drvdata->k90;
5388c2ecf20Sopenharmony_ci
5398c2ecf20Sopenharmony_ci	if (k90) {
5408c2ecf20Sopenharmony_ci		sysfs_remove_group(&dev->dev.kobj, &k90_attr_group);
5418c2ecf20Sopenharmony_ci
5428c2ecf20Sopenharmony_ci		k90->record_led.removed = true;
5438c2ecf20Sopenharmony_ci		led_classdev_unregister(&k90->record_led.cdev);
5448c2ecf20Sopenharmony_ci		cancel_work_sync(&k90->record_led.work);
5458c2ecf20Sopenharmony_ci		kfree(k90->record_led.cdev.name);
5468c2ecf20Sopenharmony_ci
5478c2ecf20Sopenharmony_ci		kfree(k90);
5488c2ecf20Sopenharmony_ci	}
5498c2ecf20Sopenharmony_ci}
5508c2ecf20Sopenharmony_ci
5518c2ecf20Sopenharmony_cistatic int corsair_probe(struct hid_device *dev, const struct hid_device_id *id)
5528c2ecf20Sopenharmony_ci{
5538c2ecf20Sopenharmony_ci	int ret;
5548c2ecf20Sopenharmony_ci	unsigned long quirks = id->driver_data;
5558c2ecf20Sopenharmony_ci	struct corsair_drvdata *drvdata;
5568c2ecf20Sopenharmony_ci	struct usb_interface *usbif;
5578c2ecf20Sopenharmony_ci
5588c2ecf20Sopenharmony_ci	if (!hid_is_usb(dev))
5598c2ecf20Sopenharmony_ci		return -EINVAL;
5608c2ecf20Sopenharmony_ci
5618c2ecf20Sopenharmony_ci	usbif = to_usb_interface(dev->dev.parent);
5628c2ecf20Sopenharmony_ci
5638c2ecf20Sopenharmony_ci	drvdata = devm_kzalloc(&dev->dev, sizeof(struct corsair_drvdata),
5648c2ecf20Sopenharmony_ci			       GFP_KERNEL);
5658c2ecf20Sopenharmony_ci	if (drvdata == NULL)
5668c2ecf20Sopenharmony_ci		return -ENOMEM;
5678c2ecf20Sopenharmony_ci	drvdata->quirks = quirks;
5688c2ecf20Sopenharmony_ci	hid_set_drvdata(dev, drvdata);
5698c2ecf20Sopenharmony_ci
5708c2ecf20Sopenharmony_ci	ret = hid_parse(dev);
5718c2ecf20Sopenharmony_ci	if (ret != 0) {
5728c2ecf20Sopenharmony_ci		hid_err(dev, "parse failed\n");
5738c2ecf20Sopenharmony_ci		return ret;
5748c2ecf20Sopenharmony_ci	}
5758c2ecf20Sopenharmony_ci	ret = hid_hw_start(dev, HID_CONNECT_DEFAULT);
5768c2ecf20Sopenharmony_ci	if (ret != 0) {
5778c2ecf20Sopenharmony_ci		hid_err(dev, "hw start failed\n");
5788c2ecf20Sopenharmony_ci		return ret;
5798c2ecf20Sopenharmony_ci	}
5808c2ecf20Sopenharmony_ci
5818c2ecf20Sopenharmony_ci	if (usbif->cur_altsetting->desc.bInterfaceNumber == 0) {
5828c2ecf20Sopenharmony_ci		if (quirks & CORSAIR_USE_K90_MACRO) {
5838c2ecf20Sopenharmony_ci			ret = k90_init_macro_functions(dev);
5848c2ecf20Sopenharmony_ci			if (ret != 0)
5858c2ecf20Sopenharmony_ci				hid_warn(dev, "Failed to initialize K90 macro functions.\n");
5868c2ecf20Sopenharmony_ci		}
5878c2ecf20Sopenharmony_ci		if (quirks & CORSAIR_USE_K90_BACKLIGHT) {
5888c2ecf20Sopenharmony_ci			ret = k90_init_backlight(dev);
5898c2ecf20Sopenharmony_ci			if (ret != 0)
5908c2ecf20Sopenharmony_ci				hid_warn(dev, "Failed to initialize K90 backlight.\n");
5918c2ecf20Sopenharmony_ci		}
5928c2ecf20Sopenharmony_ci	}
5938c2ecf20Sopenharmony_ci
5948c2ecf20Sopenharmony_ci	return 0;
5958c2ecf20Sopenharmony_ci}
5968c2ecf20Sopenharmony_ci
5978c2ecf20Sopenharmony_cistatic void corsair_remove(struct hid_device *dev)
5988c2ecf20Sopenharmony_ci{
5998c2ecf20Sopenharmony_ci	k90_cleanup_macro_functions(dev);
6008c2ecf20Sopenharmony_ci	k90_cleanup_backlight(dev);
6018c2ecf20Sopenharmony_ci
6028c2ecf20Sopenharmony_ci	hid_hw_stop(dev);
6038c2ecf20Sopenharmony_ci}
6048c2ecf20Sopenharmony_ci
6058c2ecf20Sopenharmony_cistatic int corsair_event(struct hid_device *dev, struct hid_field *field,
6068c2ecf20Sopenharmony_ci			 struct hid_usage *usage, __s32 value)
6078c2ecf20Sopenharmony_ci{
6088c2ecf20Sopenharmony_ci	struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
6098c2ecf20Sopenharmony_ci
6108c2ecf20Sopenharmony_ci	if (!drvdata->k90)
6118c2ecf20Sopenharmony_ci		return 0;
6128c2ecf20Sopenharmony_ci
6138c2ecf20Sopenharmony_ci	switch (usage->hid & HID_USAGE) {
6148c2ecf20Sopenharmony_ci	case CORSAIR_USAGE_MACRO_RECORD_START:
6158c2ecf20Sopenharmony_ci		drvdata->k90->record_led.brightness = 1;
6168c2ecf20Sopenharmony_ci		break;
6178c2ecf20Sopenharmony_ci	case CORSAIR_USAGE_MACRO_RECORD_STOP:
6188c2ecf20Sopenharmony_ci		drvdata->k90->record_led.brightness = 0;
6198c2ecf20Sopenharmony_ci		break;
6208c2ecf20Sopenharmony_ci	default:
6218c2ecf20Sopenharmony_ci		break;
6228c2ecf20Sopenharmony_ci	}
6238c2ecf20Sopenharmony_ci
6248c2ecf20Sopenharmony_ci	return 0;
6258c2ecf20Sopenharmony_ci}
6268c2ecf20Sopenharmony_ci
6278c2ecf20Sopenharmony_cistatic int corsair_input_mapping(struct hid_device *dev,
6288c2ecf20Sopenharmony_ci				 struct hid_input *input,
6298c2ecf20Sopenharmony_ci				 struct hid_field *field,
6308c2ecf20Sopenharmony_ci				 struct hid_usage *usage, unsigned long **bit,
6318c2ecf20Sopenharmony_ci				 int *max)
6328c2ecf20Sopenharmony_ci{
6338c2ecf20Sopenharmony_ci	int gkey;
6348c2ecf20Sopenharmony_ci
6358c2ecf20Sopenharmony_ci	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_KEYBOARD)
6368c2ecf20Sopenharmony_ci		return 0;
6378c2ecf20Sopenharmony_ci
6388c2ecf20Sopenharmony_ci	gkey = corsair_usage_to_gkey(usage->hid & HID_USAGE);
6398c2ecf20Sopenharmony_ci	if (gkey != 0) {
6408c2ecf20Sopenharmony_ci		hid_map_usage_clear(input, usage, bit, max, EV_KEY,
6418c2ecf20Sopenharmony_ci				    corsair_gkey_map[gkey - 1]);
6428c2ecf20Sopenharmony_ci		return 1;
6438c2ecf20Sopenharmony_ci	}
6448c2ecf20Sopenharmony_ci	if ((usage->hid & HID_USAGE) >= CORSAIR_USAGE_SPECIAL_MIN &&
6458c2ecf20Sopenharmony_ci	    (usage->hid & HID_USAGE) <= CORSAIR_USAGE_SPECIAL_MAX) {
6468c2ecf20Sopenharmony_ci		switch (usage->hid & HID_USAGE) {
6478c2ecf20Sopenharmony_ci		case CORSAIR_USAGE_MACRO_RECORD_START:
6488c2ecf20Sopenharmony_ci			hid_map_usage_clear(input, usage, bit, max, EV_KEY,
6498c2ecf20Sopenharmony_ci					    corsair_record_keycodes[0]);
6508c2ecf20Sopenharmony_ci			return 1;
6518c2ecf20Sopenharmony_ci
6528c2ecf20Sopenharmony_ci		case CORSAIR_USAGE_MACRO_RECORD_STOP:
6538c2ecf20Sopenharmony_ci			hid_map_usage_clear(input, usage, bit, max, EV_KEY,
6548c2ecf20Sopenharmony_ci					    corsair_record_keycodes[1]);
6558c2ecf20Sopenharmony_ci			return 1;
6568c2ecf20Sopenharmony_ci
6578c2ecf20Sopenharmony_ci		case CORSAIR_USAGE_M1:
6588c2ecf20Sopenharmony_ci			hid_map_usage_clear(input, usage, bit, max, EV_KEY,
6598c2ecf20Sopenharmony_ci					    corsair_profile_keycodes[0]);
6608c2ecf20Sopenharmony_ci			return 1;
6618c2ecf20Sopenharmony_ci
6628c2ecf20Sopenharmony_ci		case CORSAIR_USAGE_M2:
6638c2ecf20Sopenharmony_ci			hid_map_usage_clear(input, usage, bit, max, EV_KEY,
6648c2ecf20Sopenharmony_ci					    corsair_profile_keycodes[1]);
6658c2ecf20Sopenharmony_ci			return 1;
6668c2ecf20Sopenharmony_ci
6678c2ecf20Sopenharmony_ci		case CORSAIR_USAGE_M3:
6688c2ecf20Sopenharmony_ci			hid_map_usage_clear(input, usage, bit, max, EV_KEY,
6698c2ecf20Sopenharmony_ci					    corsair_profile_keycodes[2]);
6708c2ecf20Sopenharmony_ci			return 1;
6718c2ecf20Sopenharmony_ci
6728c2ecf20Sopenharmony_ci		default:
6738c2ecf20Sopenharmony_ci			return -1;
6748c2ecf20Sopenharmony_ci		}
6758c2ecf20Sopenharmony_ci	}
6768c2ecf20Sopenharmony_ci
6778c2ecf20Sopenharmony_ci	return 0;
6788c2ecf20Sopenharmony_ci}
6798c2ecf20Sopenharmony_ci
6808c2ecf20Sopenharmony_ci/*
6818c2ecf20Sopenharmony_ci * The report descriptor of some of the Corsair gaming mice is
6828c2ecf20Sopenharmony_ci * non parseable as they define two consecutive Logical Minimum for
6838c2ecf20Sopenharmony_ci * the Usage Page (Consumer) in rdescs bytes 75 and 77 being 77 0x16
6848c2ecf20Sopenharmony_ci * that should be obviousy 0x26 for Logical Magimum of 16 bits. This
6858c2ecf20Sopenharmony_ci * prevents poper parsing of the report descriptor due Logical
6868c2ecf20Sopenharmony_ci * Minimum being larger than Logical Maximum.
6878c2ecf20Sopenharmony_ci *
6888c2ecf20Sopenharmony_ci * This driver fixes the report descriptor for:
6898c2ecf20Sopenharmony_ci * - USB ID 1b1c:1b34, sold as GLAIVE RGB Gaming mouse
6908c2ecf20Sopenharmony_ci * - USB ID 1b1c:1b3e, sold as Scimitar RGB Pro Gaming mouse
6918c2ecf20Sopenharmony_ci */
6928c2ecf20Sopenharmony_ci
6938c2ecf20Sopenharmony_cistatic __u8 *corsair_mouse_report_fixup(struct hid_device *hdev, __u8 *rdesc,
6948c2ecf20Sopenharmony_ci        unsigned int *rsize)
6958c2ecf20Sopenharmony_ci{
6968c2ecf20Sopenharmony_ci	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
6978c2ecf20Sopenharmony_ci
6988c2ecf20Sopenharmony_ci	if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
6998c2ecf20Sopenharmony_ci		/*
7008c2ecf20Sopenharmony_ci		 * Corsair GLAIVE RGB and Scimitar RGB Pro report descriptor is
7018c2ecf20Sopenharmony_ci		 * broken and defines two different Logical Minimum for the
7028c2ecf20Sopenharmony_ci		 * Consumer Application. The byte 77 should be a 0x26 defining
7038c2ecf20Sopenharmony_ci		 * a 16 bits integer for the Logical Maximum but it is a 0x16
7048c2ecf20Sopenharmony_ci		 * instead (Logical Minimum)
7058c2ecf20Sopenharmony_ci		 */
7068c2ecf20Sopenharmony_ci		switch (hdev->product) {
7078c2ecf20Sopenharmony_ci		case USB_DEVICE_ID_CORSAIR_GLAIVE_RGB:
7088c2ecf20Sopenharmony_ci		case USB_DEVICE_ID_CORSAIR_SCIMITAR_PRO_RGB:
7098c2ecf20Sopenharmony_ci			if (*rsize >= 172 && rdesc[75] == 0x15 && rdesc[77] == 0x16
7108c2ecf20Sopenharmony_ci			&& rdesc[78] == 0xff && rdesc[79] == 0x0f) {
7118c2ecf20Sopenharmony_ci				hid_info(hdev, "Fixing up report descriptor\n");
7128c2ecf20Sopenharmony_ci				rdesc[77] = 0x26;
7138c2ecf20Sopenharmony_ci			}
7148c2ecf20Sopenharmony_ci			break;
7158c2ecf20Sopenharmony_ci		}
7168c2ecf20Sopenharmony_ci
7178c2ecf20Sopenharmony_ci	}
7188c2ecf20Sopenharmony_ci	return rdesc;
7198c2ecf20Sopenharmony_ci}
7208c2ecf20Sopenharmony_ci
7218c2ecf20Sopenharmony_cistatic const struct hid_device_id corsair_devices[] = {
7228c2ecf20Sopenharmony_ci	{ HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR, USB_DEVICE_ID_CORSAIR_K90),
7238c2ecf20Sopenharmony_ci		.driver_data = CORSAIR_USE_K90_MACRO |
7248c2ecf20Sopenharmony_ci			       CORSAIR_USE_K90_BACKLIGHT },
7258c2ecf20Sopenharmony_ci	{ HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR,
7268c2ecf20Sopenharmony_ci            USB_DEVICE_ID_CORSAIR_GLAIVE_RGB) },
7278c2ecf20Sopenharmony_ci	{ HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR,
7288c2ecf20Sopenharmony_ci            USB_DEVICE_ID_CORSAIR_SCIMITAR_PRO_RGB) },
7298c2ecf20Sopenharmony_ci	/*
7308c2ecf20Sopenharmony_ci	 * Vengeance K70 and K70 RAPIDFIRE share product IDs.
7318c2ecf20Sopenharmony_ci	 */
7328c2ecf20Sopenharmony_ci	{ HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR,
7338c2ecf20Sopenharmony_ci            USB_DEVICE_ID_CORSAIR_K70R) },
7348c2ecf20Sopenharmony_ci	{}
7358c2ecf20Sopenharmony_ci};
7368c2ecf20Sopenharmony_ci
7378c2ecf20Sopenharmony_ciMODULE_DEVICE_TABLE(hid, corsair_devices);
7388c2ecf20Sopenharmony_ci
7398c2ecf20Sopenharmony_cistatic struct hid_driver corsair_driver = {
7408c2ecf20Sopenharmony_ci	.name = "corsair",
7418c2ecf20Sopenharmony_ci	.id_table = corsair_devices,
7428c2ecf20Sopenharmony_ci	.probe = corsair_probe,
7438c2ecf20Sopenharmony_ci	.event = corsair_event,
7448c2ecf20Sopenharmony_ci	.remove = corsair_remove,
7458c2ecf20Sopenharmony_ci	.input_mapping = corsair_input_mapping,
7468c2ecf20Sopenharmony_ci	.report_fixup = corsair_mouse_report_fixup,
7478c2ecf20Sopenharmony_ci};
7488c2ecf20Sopenharmony_ci
7498c2ecf20Sopenharmony_cimodule_hid_driver(corsair_driver);
7508c2ecf20Sopenharmony_ci
7518c2ecf20Sopenharmony_ciMODULE_LICENSE("GPL");
7528c2ecf20Sopenharmony_ci/* Original K90 driver author */
7538c2ecf20Sopenharmony_ciMODULE_AUTHOR("Clement Vuchener");
7548c2ecf20Sopenharmony_ci/* Scimitar PRO RGB driver author */
7558c2ecf20Sopenharmony_ciMODULE_AUTHOR("Oscar Campos");
7568c2ecf20Sopenharmony_ciMODULE_DESCRIPTION("HID driver for Corsair devices");
757