^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_PYRA_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) #define __HID_ROCCAT_PYRA_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) PYRA_SIZE_CONTROL = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) PYRA_SIZE_INFO = 0x06,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) PYRA_SIZE_PROFILE_SETTINGS = 0x0d,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) PYRA_SIZE_PROFILE_BUTTONS = 0x13,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) PYRA_SIZE_SETTINGS = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) enum pyra_control_requests {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) PYRA_CONTROL_REQUEST_PROFILE_SETTINGS = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) PYRA_CONTROL_REQUEST_PROFILE_BUTTONS = 0x20
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) struct pyra_settings {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) uint8_t command; /* PYRA_COMMAND_SETTINGS */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) uint8_t size; /* always 3 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) uint8_t startup_profile; /* Range 0-4! */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) } __attribute__ ((__packed__));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) struct pyra_profile_settings {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) uint8_t command; /* PYRA_COMMAND_PROFILE_SETTINGS */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) uint8_t size; /* always 0xd */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) uint8_t number; /* Range 0-4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) uint8_t xysync;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) uint8_t x_sensitivity; /* 0x1-0xa */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) uint8_t y_sensitivity;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) uint8_t x_cpi; /* unused */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) uint8_t y_cpi; /* this value is for x and y */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) uint8_t lightswitch; /* 0 = off, 1 = on */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) uint8_t light_effect;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) uint8_t handedness;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) uint16_t checksum; /* byte sum */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) } __attribute__ ((__packed__));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) struct pyra_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) uint8_t command; /* PYRA_COMMAND_INFO */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) uint8_t size; /* always 6 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) uint8_t firmware_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) uint8_t unknown1; /* always 0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) uint8_t unknown2; /* always 1 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) uint8_t unknown3; /* always 0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) } __attribute__ ((__packed__));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) enum pyra_commands {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) PYRA_COMMAND_CONTROL = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) PYRA_COMMAND_SETTINGS = 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) PYRA_COMMAND_PROFILE_SETTINGS = 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) PYRA_COMMAND_PROFILE_BUTTONS = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) PYRA_COMMAND_INFO = 0x9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) PYRA_COMMAND_B = 0xb
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) enum pyra_mouse_report_numbers {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) PYRA_MOUSE_REPORT_NUMBER_HID = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) PYRA_MOUSE_REPORT_NUMBER_AUDIO = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) PYRA_MOUSE_REPORT_NUMBER_BUTTON = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) struct pyra_mouse_event_button {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) uint8_t report_number; /* always 3 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) uint8_t unknown; /* always 0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) uint8_t type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) uint8_t data1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) uint8_t data2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) } __attribute__ ((__packed__));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) struct pyra_mouse_event_audio {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) uint8_t report_number; /* always 2 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) uint8_t type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) uint8_t unused; /* always 0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) } __attribute__ ((__packed__));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) /* hid audio controls */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) enum pyra_mouse_event_audio_types {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) PYRA_MOUSE_EVENT_AUDIO_TYPE_MUTE = 0xe2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) PYRA_MOUSE_EVENT_AUDIO_TYPE_VOLUME_UP = 0xe9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) PYRA_MOUSE_EVENT_AUDIO_TYPE_VOLUME_DOWN = 0xea,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) enum pyra_mouse_event_button_types {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) * Mouse sends tilt events on report_number 1 and 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * Tilt events are sent repeatedly with 0.94s between first and second
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) * event and 0.22s on subsequent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) PYRA_MOUSE_EVENT_BUTTON_TYPE_TILT = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) * These are sent sequentially
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) * data1 contains new profile number in range 1-5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_1 = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2 = 0x30,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) * data1 = button_number (rmp index)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) * data2 = pressed/released
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO = 0x40,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT = 0x50,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) * data1 = button_number (rmp index)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH = 0x60,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) /* data1 = new cpi */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI = 0xb0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) /* data1 and data2 = new sensitivity */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) PYRA_MOUSE_EVENT_BUTTON_TYPE_SENSITIVITY = 0xc0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) PYRA_MOUSE_EVENT_BUTTON_TYPE_MULTIMEDIA = 0xf0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) PYRA_MOUSE_EVENT_BUTTON_PRESS = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) PYRA_MOUSE_EVENT_BUTTON_RELEASE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) struct pyra_roccat_report {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) uint8_t type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) uint8_t value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) uint8_t key;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) } __attribute__ ((__packed__));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) struct pyra_device {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) int actual_profile;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) int actual_cpi;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) int roccat_claimed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) int chrdev_minor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) struct mutex pyra_lock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) struct pyra_profile_settings profile_settings[5];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) #endif