[linux-block.git] / drivers / hid / hid-roccat-koneplus.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __HID_ROCCAT_KONEPLUS_H
#define __HID_ROCCAT_KONEPLUS_H

/*
 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
 */

/*
 */

#include <linux/types.h>

enum {
	KONEPLUS_SIZE_ACTUAL_PROFILE = 0x03,
	KONEPLUS_SIZE_CONTROL = 0x03,
	KONEPLUS_SIZE_FIRMWARE_WRITE = 0x0402,
	KONEPLUS_SIZE_INFO = 0x06,
	KONEPLUS_SIZE_MACRO = 0x0822,
	KONEPLUS_SIZE_PROFILE_SETTINGS = 0x2b,
	KONEPLUS_SIZE_PROFILE_BUTTONS = 0x4d,
	KONEPLUS_SIZE_SENSOR = 0x06,
	KONEPLUS_SIZE_TALK = 0x10,
	KONEPLUS_SIZE_TCU = 0x04,
	KONEPLUS_SIZE_TCU_IMAGE = 0x0404,
};

enum koneplus_control_requests {
	KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS = 0x80,
	KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS = 0x90,
};

struct koneplus_actual_profile {
	uint8_t command; /* KONEPLUS_COMMAND_ACTUAL_PROFILE */
	uint8_t size; /* always 3 */
	uint8_t actual_profile; /* Range 0-4! */
} __attribute__ ((__packed__));

struct koneplus_info {
	uint8_t command; /* KONEPLUS_COMMAND_INFO */
	uint8_t size; /* always 6 */
	uint8_t firmware_version;
	uint8_t unknown[3];
} __attribute__ ((__packed__));

enum koneplus_commands {
	KONEPLUS_COMMAND_ACTUAL_PROFILE = 0x5,
	KONEPLUS_COMMAND_CONTROL = 0x4,
	KONEPLUS_COMMAND_PROFILE_SETTINGS = 0x6,
	KONEPLUS_COMMAND_PROFILE_BUTTONS = 0x7,
	KONEPLUS_COMMAND_MACRO = 0x8,
	KONEPLUS_COMMAND_INFO = 0x9,
	KONEPLUS_COMMAND_TCU = 0xc,
	KONEPLUS_COMMAND_TCU_IMAGE = 0xc,
	KONEPLUS_COMMAND_E = 0xe,
	KONEPLUS_COMMAND_SENSOR = 0xf,
	KONEPLUS_COMMAND_TALK = 0x10,
	KONEPLUS_COMMAND_FIRMWARE_WRITE = 0x1b,
	KONEPLUS_COMMAND_FIRMWARE_WRITE_CONTROL = 0x1c,
};

enum koneplus_mouse_report_numbers {
	KONEPLUS_MOUSE_REPORT_NUMBER_HID = 1,
	KONEPLUS_MOUSE_REPORT_NUMBER_AUDIO = 2,
	KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON = 3,
};

struct koneplus_mouse_report_button {
	uint8_t report_number; /* always KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON */
	uint8_t zero1;
	uint8_t type;
	uint8_t data1;
	uint8_t data2;
	uint8_t zero2;
	uint8_t unknown[2];
} __attribute__ ((__packed__));

enum koneplus_mouse_report_button_types {
	/* data1 = new profile range 1-5 */
	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE = 0x20,

	/* data1 = button number range 1-24; data2 = action */
	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH = 0x60,

	/* data1 = button number range 1-24; data2 = action */
	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER = 0x80,

	/* data1 = setting number range 1-5 */
	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_CPI = 0xb0,

	/* data1 and data2 = range 0x1-0xb */
	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_SENSITIVITY = 0xc0,

	/* data1 = 22 = next track...
	 * data2 = action
	 */
	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_MULTIMEDIA = 0xf0,
	KONEPLUS_MOUSE_REPORT_TALK = 0xff,
};

enum koneplus_mouse_report_button_action {
	KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS = 0,
	KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_RELEASE = 1,
};

struct koneplus_roccat_report {
	uint8_t type;
	uint8_t data1;
	uint8_t data2;
	uint8_t profile;
} __attribute__ ((__packed__));

struct koneplus_device {
	int actual_profile;

	int roccat_claimed;
	int chrdev_minor;

	struct mutex koneplus_lock;
};

#endif
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
47dbdbff SA	2	#ifndef __HID_ROCCAT_KONEPLUS_H
	3	#define __HID_ROCCAT_KONEPLUS_H
	4
	5	/*
	6	* Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
	7	*/
	8
	9	/*
47dbdbff SA	10	*/
	11
	12	#include <linux/types.h>
	13
f114fec5 SA	14	enum {
f114fec5 SA	15	KONEPLUS_SIZE_ACTUAL_PROFILE = 0x03,
bb060d65	16	KONEPLUS_SIZE_CONTROL = 0x03,
f114fec5 SA	17	KONEPLUS_SIZE_FIRMWARE_WRITE = 0x0402,
	18	KONEPLUS_SIZE_INFO = 0x06,
	19	KONEPLUS_SIZE_MACRO = 0x0822,
	20	KONEPLUS_SIZE_PROFILE_SETTINGS = 0x2b,
	21	KONEPLUS_SIZE_PROFILE_BUTTONS = 0x4d,
	22	KONEPLUS_SIZE_SENSOR = 0x06,
	23	KONEPLUS_SIZE_TALK = 0x10,
955dca35	24	KONEPLUS_SIZE_TCU = 0x04,
f114fec5 SA	25	KONEPLUS_SIZE_TCU_IMAGE = 0x0404,
f114fec5 SA	26	};
6d1dec85	27
47dbdbff	28	enum koneplus_control_requests {
47dbdbff SA	29	KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS = 0x80,
	30	KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS = 0x90,
	31	};
	32
b50f315c SA	33	struct koneplus_actual_profile {
b50f315c SA	34	uint8_t command; /* KONEPLUS_COMMAND_ACTUAL_PROFILE */
47dbdbff	35	uint8_t size; /* always 3 */
b50f315c	36	uint8_t actual_profile; /* Range 0-4! */
4d043101	37	} __attribute__ ((__packed__));
47dbdbff	38
47dbdbff SA	39	struct koneplus_info {
	40	uint8_t command; /* KONEPLUS_COMMAND_INFO */
	41	uint8_t size; /* always 6 */
	42	uint8_t firmware_version;
	43	uint8_t unknown[3];
4d043101	44	} __attribute__ ((__packed__));
47dbdbff	45
47dbdbff	46	enum koneplus_commands {
b50f315c	47	KONEPLUS_COMMAND_ACTUAL_PROFILE = 0x5,
bb060d65	48	KONEPLUS_COMMAND_CONTROL = 0x4,
47dbdbff SA	49	KONEPLUS_COMMAND_PROFILE_SETTINGS = 0x6,
	50	KONEPLUS_COMMAND_PROFILE_BUTTONS = 0x7,
	51	KONEPLUS_COMMAND_MACRO = 0x8,
	52	KONEPLUS_COMMAND_INFO = 0x9,
1edd5b42	53	KONEPLUS_COMMAND_TCU = 0xc,
f114fec5	54	KONEPLUS_COMMAND_TCU_IMAGE = 0xc,
47dbdbff SA	55	KONEPLUS_COMMAND_E = 0xe,
47dbdbff SA	56	KONEPLUS_COMMAND_SENSOR = 0xf,
6d1dec85	57	KONEPLUS_COMMAND_TALK = 0x10,
47dbdbff SA	58	KONEPLUS_COMMAND_FIRMWARE_WRITE = 0x1b,
	59	KONEPLUS_COMMAND_FIRMWARE_WRITE_CONTROL = 0x1c,
	60	};
	61
47dbdbff SA	62	enum koneplus_mouse_report_numbers {
	63	KONEPLUS_MOUSE_REPORT_NUMBER_HID = 1,
	64	KONEPLUS_MOUSE_REPORT_NUMBER_AUDIO = 2,
	65	KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON = 3,
	66	};
	67
	68	struct koneplus_mouse_report_button {
	69	uint8_t report_number; /* always KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON */
	70	uint8_t zero1;
	71	uint8_t type;
	72	uint8_t data1;
	73	uint8_t data2;
	74	uint8_t zero2;
	75	uint8_t unknown[2];
4d043101	76	} __attribute__ ((__packed__));
47dbdbff SA	77
	78	enum koneplus_mouse_report_button_types {
	79	/* data1 = new profile range 1-5 */
	80	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE = 0x20,
	81
	82	/* data1 = button number range 1-24; data2 = action */
	83	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH = 0x60,
	84
	85	/* data1 = button number range 1-24; data2 = action */
	86	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER = 0x80,
	87
	88	/* data1 = setting number range 1-5 */
	89	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_CPI = 0xb0,
	90
	91	/* data1 and data2 = range 0x1-0xb */
	92	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_SENSITIVITY = 0xc0,
	93
	94	/* data1 = 22 = next track...
	95	* data2 = action
	96	*/
	97	KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_MULTIMEDIA = 0xf0,
6d1dec85	98	KONEPLUS_MOUSE_REPORT_TALK = 0xff,
47dbdbff SA	99	};
	100
	101	enum koneplus_mouse_report_button_action {
	102	KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS = 0,
	103	KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_RELEASE = 1,
	104	};
	105
	106	struct koneplus_roccat_report {
	107	uint8_t type;
	108	uint8_t data1;
	109	uint8_t data2;
	110	uint8_t profile;
4d043101	111	} __attribute__ ((__packed__));
47dbdbff SA	112
	113	struct koneplus_device {
	114	int actual_profile;
	115
	116	int roccat_claimed;
	117	int chrdev_minor;
	118
	119	struct mutex koneplus_lock;
47dbdbff SA	120	};
	121
	122	#endif