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