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