]>
Commit | Line | Data |
---|---|---|
2874c5fd | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
14bf62cd SA |
2 | #ifndef __HID_ROCCAT_KONE_H |
3 | #define __HID_ROCCAT_KONE_H | |
4 | ||
5 | /* | |
6 | * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net> | |
7 | */ | |
8 | ||
9 | /* | |
14bf62cd SA |
10 | */ |
11 | ||
12 | #include <linux/types.h> | |
13 | ||
14bf62cd SA |
14 | struct kone_keystroke { |
15 | uint8_t key; | |
16 | uint8_t action; | |
17 | uint16_t period; /* in milliseconds */ | |
4d043101 | 18 | } __attribute__ ((__packed__)); |
14bf62cd SA |
19 | |
20 | enum kone_keystroke_buttons { | |
21 | kone_keystroke_button_1 = 0xf0, /* left mouse button */ | |
22 | kone_keystroke_button_2 = 0xf1, /* right mouse button */ | |
23 | kone_keystroke_button_3 = 0xf2, /* wheel */ | |
24 | kone_keystroke_button_9 = 0xf3, /* side button up */ | |
25 | kone_keystroke_button_8 = 0xf4 /* side button down */ | |
26 | }; | |
27 | ||
28 | enum kone_keystroke_actions { | |
29 | kone_keystroke_action_press = 0, | |
30 | kone_keystroke_action_release = 1 | |
31 | }; | |
32 | ||
33 | struct kone_button_info { | |
34 | uint8_t number; /* range 1-8 */ | |
35 | uint8_t type; | |
36 | uint8_t macro_type; /* 0 = short, 1 = overlong */ | |
37 | uint8_t macro_set_name[16]; /* can be max 15 chars long */ | |
38 | uint8_t macro_name[16]; /* can be max 15 chars long */ | |
39 | uint8_t count; | |
40 | struct kone_keystroke keystrokes[20]; | |
4d043101 | 41 | } __attribute__ ((__packed__)); |
14bf62cd SA |
42 | |
43 | enum kone_button_info_types { | |
44 | /* valid button types until firmware 1.32 */ | |
45 | kone_button_info_type_button_1 = 0x1, /* click (left mouse button) */ | |
46 | kone_button_info_type_button_2 = 0x2, /* menu (right mouse button)*/ | |
47 | kone_button_info_type_button_3 = 0x3, /* scroll (wheel) */ | |
48 | kone_button_info_type_double_click = 0x4, | |
49 | kone_button_info_type_key = 0x5, | |
50 | kone_button_info_type_macro = 0x6, | |
51 | kone_button_info_type_off = 0x7, | |
52 | /* TODO clarify function and rename */ | |
53 | kone_button_info_type_osd_xy_prescaling = 0x8, | |
54 | kone_button_info_type_osd_dpi = 0x9, | |
55 | kone_button_info_type_osd_profile = 0xa, | |
56 | kone_button_info_type_button_9 = 0xb, /* ie forward */ | |
57 | kone_button_info_type_button_8 = 0xc, /* ie backward */ | |
58 | kone_button_info_type_dpi_up = 0xd, /* internal */ | |
59 | kone_button_info_type_dpi_down = 0xe, /* internal */ | |
60 | kone_button_info_type_button_7 = 0xf, /* tilt left */ | |
61 | kone_button_info_type_button_6 = 0x10, /* tilt right */ | |
62 | kone_button_info_type_profile_up = 0x11, /* internal */ | |
63 | kone_button_info_type_profile_down = 0x12, /* internal */ | |
64 | /* additional valid button types since firmware 1.38 */ | |
65 | kone_button_info_type_multimedia_open_player = 0x20, | |
66 | kone_button_info_type_multimedia_next_track = 0x21, | |
67 | kone_button_info_type_multimedia_prev_track = 0x22, | |
68 | kone_button_info_type_multimedia_play_pause = 0x23, | |
69 | kone_button_info_type_multimedia_stop = 0x24, | |
70 | kone_button_info_type_multimedia_mute = 0x25, | |
71 | kone_button_info_type_multimedia_volume_up = 0x26, | |
72 | kone_button_info_type_multimedia_volume_down = 0x27 | |
73 | }; | |
74 | ||
73b3577d SA |
75 | enum kone_button_info_numbers { |
76 | kone_button_top = 1, | |
77 | kone_button_wheel_tilt_left = 2, | |
78 | kone_button_wheel_tilt_right = 3, | |
79 | kone_button_forward = 4, | |
80 | kone_button_backward = 5, | |
81 | kone_button_middle = 6, | |
82 | kone_button_plus = 7, | |
83 | kone_button_minus = 8, | |
84 | }; | |
85 | ||
14bf62cd SA |
86 | struct kone_light_info { |
87 | uint8_t number; /* number of light 1-5 */ | |
88 | uint8_t mod; /* 1 = on, 2 = off */ | |
89 | uint8_t red; /* range 0x00-0xff */ | |
90 | uint8_t green; /* range 0x00-0xff */ | |
91 | uint8_t blue; /* range 0x00-0xff */ | |
4d043101 | 92 | } __attribute__ ((__packed__)); |
14bf62cd SA |
93 | |
94 | struct kone_profile { | |
95 | uint16_t size; /* always 975 */ | |
96 | uint16_t unused; /* always 0 */ | |
97 | ||
98 | /* | |
99 | * range 1-5 | |
100 | * This number does not need to correspond with location where profile | |
101 | * saved | |
102 | */ | |
103 | uint8_t profile; /* range 1-5 */ | |
104 | ||
105 | uint16_t main_sensitivity; /* range 100-1000 */ | |
106 | uint8_t xy_sensitivity_enabled; /* 1 = on, 2 = off */ | |
107 | uint16_t x_sensitivity; /* range 100-1000 */ | |
108 | uint16_t y_sensitivity; /* range 100-1000 */ | |
109 | uint8_t dpi_rate; /* bit 1 = 800, ... */ | |
110 | uint8_t startup_dpi; /* range 1-6 */ | |
111 | uint8_t polling_rate; /* 1 = 125Hz, 2 = 500Hz, 3 = 1000Hz */ | |
112 | /* kone has no dcu | |
113 | * value is always 2 in firmwares <= 1.32 and | |
114 | * 1 in firmwares > 1.32 | |
115 | */ | |
116 | uint8_t dcu_flag; | |
117 | uint8_t light_effect_1; /* range 1-3 */ | |
118 | uint8_t light_effect_2; /* range 1-5 */ | |
119 | uint8_t light_effect_3; /* range 1-4 */ | |
120 | uint8_t light_effect_speed; /* range 0-255 */ | |
121 | ||
122 | struct kone_light_info light_infos[5]; | |
73b3577d | 123 | /* offset is kone_button_info_numbers - 1 */ |
14bf62cd SA |
124 | struct kone_button_info button_infos[8]; |
125 | ||
126 | uint16_t checksum; /* \brief holds checksum of struct */ | |
4d043101 | 127 | } __attribute__ ((__packed__)); |
14bf62cd SA |
128 | |
129 | enum kone_polling_rates { | |
130 | kone_polling_rate_125 = 1, | |
131 | kone_polling_rate_500 = 2, | |
132 | kone_polling_rate_1000 = 3 | |
133 | }; | |
134 | ||
135 | struct kone_settings { | |
136 | uint16_t size; /* always 36 */ | |
137 | uint8_t startup_profile; /* 1-5 */ | |
138 | uint8_t unknown1; | |
139 | uint8_t tcu; /* 0 = off, 1 = on */ | |
140 | uint8_t unknown2[23]; | |
141 | uint8_t calibration_data[4]; | |
142 | uint8_t unknown3[2]; | |
143 | uint16_t checksum; | |
4d043101 | 144 | } __attribute__ ((__packed__)); |
14bf62cd SA |
145 | |
146 | /* | |
147 | * 12 byte mouse event read by interrupt_read | |
148 | */ | |
149 | struct kone_mouse_event { | |
150 | uint8_t report_number; /* always 1 */ | |
151 | uint8_t button; | |
152 | uint16_t x; | |
153 | uint16_t y; | |
154 | uint8_t wheel; /* up = 1, down = -1 */ | |
155 | uint8_t tilt; /* right = 1, left = -1 */ | |
156 | uint8_t unknown; | |
157 | uint8_t event; | |
158 | uint8_t value; /* press = 0, release = 1 */ | |
159 | uint8_t macro_key; /* 0 to 8 */ | |
4d043101 | 160 | } __attribute__ ((__packed__)); |
14bf62cd SA |
161 | |
162 | enum kone_mouse_events { | |
163 | /* osd events are thought to be display on screen */ | |
164 | kone_mouse_event_osd_dpi = 0xa0, | |
165 | kone_mouse_event_osd_profile = 0xb0, | |
1edd5b42 | 166 | /* TODO clarify meaning and occurence of kone_mouse_event_calibration */ |
14bf62cd SA |
167 | kone_mouse_event_calibration = 0xc0, |
168 | kone_mouse_event_call_overlong_macro = 0xe0, | |
b42065f3 | 169 | kone_mouse_event_multimedia = 0xe1, |
73b3577d | 170 | /* switch events notify if user changed values with mousebutton click */ |
14bf62cd SA |
171 | kone_mouse_event_switch_dpi = 0xf0, |
172 | kone_mouse_event_switch_profile = 0xf1 | |
173 | }; | |
174 | ||
175 | enum kone_commands { | |
176 | kone_command_profile = 0x5a, | |
177 | kone_command_settings = 0x15a, | |
178 | kone_command_firmware_version = 0x25a, | |
179 | kone_command_weight = 0x45a, | |
180 | kone_command_calibrate = 0x55a, | |
181 | kone_command_confirm_write = 0x65a, | |
182 | kone_command_firmware = 0xe5a | |
183 | }; | |
184 | ||
206f5f2f SA |
185 | struct kone_roccat_report { |
186 | uint8_t event; | |
187 | uint8_t value; /* holds dpi or profile value */ | |
188 | uint8_t key; /* macro key on overlong macro execution */ | |
4d043101 | 189 | } __attribute__ ((__packed__)); |
14bf62cd SA |
190 | |
191 | struct kone_device { | |
192 | /* | |
193 | * Storing actual values when we get informed about changes since there | |
194 | * is no way of getting this information from the device on demand | |
195 | */ | |
196 | int actual_profile, actual_dpi; | |
73b3577d SA |
197 | /* Used for neutralizing abnormal button behaviour */ |
198 | struct kone_mouse_event last_mouse_event; | |
199 | ||
14bf62cd SA |
200 | /* |
201 | * It's unlikely that multiple sysfs attributes are accessed at a time, | |
202 | * so only one mutex is used to secure hardware access and profiles and | |
203 | * settings of this struct. | |
204 | */ | |
205 | struct mutex kone_lock; | |
206 | ||
207 | /* | |
208 | * Storing the data here reduces IO and ensures that data is available | |
209 | * when its needed (E.g. interrupt handler). | |
210 | */ | |
211 | struct kone_profile profiles[5]; | |
212 | struct kone_settings settings; | |
213 | ||
214 | /* | |
215 | * firmware doesn't change unless firmware update is implemented, | |
216 | * so it's read only once | |
217 | */ | |
218 | int firmware_version; | |
206f5f2f SA |
219 | |
220 | int roccat_claimed; | |
221 | int chrdev_minor; | |
14bf62cd SA |
222 | }; |
223 | ||
224 | #endif |