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