^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) #ifndef __HID_ROCCAT_KOVAPLUS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) #define __HID_ROCCAT_KOVAPLUS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/types.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) KOVAPLUS_SIZE_CONTROL = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) KOVAPLUS_SIZE_INFO = 0x06,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) KOVAPLUS_SIZE_PROFILE_SETTINGS = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) KOVAPLUS_SIZE_PROFILE_BUTTONS = 0x17,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) enum kovaplus_control_requests {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) /* write; value = profile number range 0-4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) KOVAPLUS_CONTROL_REQUEST_PROFILE_SETTINGS = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) /* write; value = profile number range 0-4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) KOVAPLUS_CONTROL_REQUEST_PROFILE_BUTTONS = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) struct kovaplus_actual_profile {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) uint8_t command; /* KOVAPLUS_COMMAND_ACTUAL_PROFILE */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) uint8_t size; /* always 3 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) uint8_t actual_profile; /* Range 0-4! */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) struct kovaplus_profile_settings {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) uint8_t command; /* KOVAPLUS_COMMAND_PROFILE_SETTINGS */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) uint8_t size; /* 16 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) uint8_t profile_index; /* range 0-4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) uint8_t unknown1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) uint8_t sensitivity_x; /* range 1-10 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) uint8_t sensitivity_y; /* range 1-10 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) uint8_t cpi_levels_enabled;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) uint8_t cpi_startup_level; /* range 1-4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) uint8_t data[8];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) struct kovaplus_profile_buttons {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) uint8_t command; /* KOVAPLUS_COMMAND_PROFILE_BUTTONS */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) uint8_t size; /* 23 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) uint8_t profile_index; /* range 0-4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) uint8_t data[20];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) struct kovaplus_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) uint8_t command; /* KOVAPLUS_COMMAND_INFO */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) uint8_t size; /* 6 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) uint8_t firmware_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) uint8_t unknown[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) enum kovaplus_commands {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) KOVAPLUS_COMMAND_ACTUAL_PROFILE = 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) KOVAPLUS_COMMAND_CONTROL = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) KOVAPLUS_COMMAND_PROFILE_SETTINGS = 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) KOVAPLUS_COMMAND_PROFILE_BUTTONS = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) KOVAPLUS_COMMAND_INFO = 0x9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) KOVAPLUS_COMMAND_A = 0xa,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) enum kovaplus_mouse_report_numbers {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) KOVAPLUS_MOUSE_REPORT_NUMBER_MOUSE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) KOVAPLUS_MOUSE_REPORT_NUMBER_AUDIO = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) KOVAPLUS_MOUSE_REPORT_NUMBER_BUTTON = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) KOVAPLUS_MOUSE_REPORT_NUMBER_KBD = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) struct kovaplus_mouse_report_button {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) uint8_t report_number; /* KOVAPLUS_MOUSE_REPORT_NUMBER_BUTTON */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) uint8_t unknown1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) uint8_t type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) uint8_t data1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) uint8_t data2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) enum kovaplus_mouse_report_button_types {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) /* data1 = profile_number range 1-5; no release event */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE_1 = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) /* data1 = profile_number range 1-5; no release event */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE_2 = 0x30,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) /* data1 = button_number range 1-18; data2 = action */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_MACRO = 0x40,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) /* data1 = button_number range 1-18; data2 = action */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_SHORTCUT = 0x50,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) /* data1 = button_number range 1-18; data2 = action */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH = 0x60,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) /* data1 = button_number range 1-18; data2 = action */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER = 0x80,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) /* data1 = 1 = 400, 2 = 800, 4 = 1600, 7 = 3200; no release event */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_CPI = 0xb0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) /* data1 + data2 = sense range 1-10; no release event */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_SENSITIVITY = 0xc0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) /* data1 = type as in profile_buttons; data2 = action */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_MULTIMEDIA = 0xf0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) enum kovaplus_mouse_report_button_actions {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) KOVAPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) KOVAPLUS_MOUSE_REPORT_BUTTON_ACTION_RELEASE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) struct kovaplus_roccat_report {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) uint8_t type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) uint8_t profile;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) uint8_t button;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) uint8_t data1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) uint8_t data2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) struct kovaplus_device {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) int actual_profile;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) int actual_cpi;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) int actual_x_sensitivity;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) int actual_y_sensitivity;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) int roccat_claimed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) int chrdev_minor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) struct mutex kovaplus_lock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) struct kovaplus_profile_settings profile_settings[5];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) struct kovaplus_profile_buttons profile_buttons[5];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) #endif