1/*
2 *  HID driver for Kye/Genius devices not fully compliant with HID standard
3 *
4 *  Copyright (c) 2009 Jiri Kosina
5 *  Copyright (c) 2009 Tomas Hanak
6 *  Copyright (c) 2012 Nikolai Kondrashov
7 */
8
9/*
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
13 * any later version.
14 */
15
16#include <linux/device.h>
17#include <linux/hid.h>
18#include <linux/module.h>
19
20#include "hid-ids.h"
21
22/*
23 * See EasyPen i405X description, device and HID report descriptors at
24 * http://sf.net/apps/mediawiki/digimend/?title=KYE_EasyPen_i405X
25 */
26
27/* Original EasyPen i405X report descriptor size */
28#define EASYPEN_I405X_RDESC_ORIG_SIZE	476
29
30/* Fixed EasyPen i405X report descriptor */
31static __u8 easypen_i405x_rdesc_fixed[] = {
32	0x06, 0x00, 0xFF, /*  Usage Page (FF00h),             */
33	0x09, 0x01,       /*  Usage (01h),                    */
34	0xA1, 0x01,       /*  Collection (Application),       */
35	0x85, 0x05,       /*    Report ID (5),                */
36	0x09, 0x01,       /*    Usage (01h),                  */
37	0x15, 0x80,       /*    Logical Minimum (-128),       */
38	0x25, 0x7F,       /*    Logical Maximum (127),        */
39	0x75, 0x08,       /*    Report Size (8),              */
40	0x95, 0x07,       /*    Report Count (7),             */
41	0xB1, 0x02,       /*    Feature (Variable),           */
42	0xC0,             /*  End Collection,                 */
43	0x05, 0x0D,       /*  Usage Page (Digitizer),         */
44	0x09, 0x02,       /*  Usage (Pen),                    */
45	0xA1, 0x01,       /*  Collection (Application),       */
46	0x85, 0x10,       /*    Report ID (16),               */
47	0x09, 0x20,       /*    Usage (Stylus),               */
48	0xA0,             /*    Collection (Physical),        */
49	0x14,             /*      Logical Minimum (0),        */
50	0x25, 0x01,       /*      Logical Maximum (1),        */
51	0x75, 0x01,       /*      Report Size (1),            */
52	0x09, 0x42,       /*      Usage (Tip Switch),         */
53	0x09, 0x44,       /*      Usage (Barrel Switch),      */
54	0x09, 0x46,       /*      Usage (Tablet Pick),        */
55	0x95, 0x03,       /*      Report Count (3),           */
56	0x81, 0x02,       /*      Input (Variable),           */
57	0x95, 0x04,       /*      Report Count (4),           */
58	0x81, 0x03,       /*      Input (Constant, Variable), */
59	0x09, 0x32,       /*      Usage (In Range),           */
60	0x95, 0x01,       /*      Report Count (1),           */
61	0x81, 0x02,       /*      Input (Variable),           */
62	0x75, 0x10,       /*      Report Size (16),           */
63	0x95, 0x01,       /*      Report Count (1),           */
64	0xA4,             /*      Push,                       */
65	0x05, 0x01,       /*      Usage Page (Desktop),       */
66	0x55, 0xFD,       /*      Unit Exponent (-3),         */
67	0x65, 0x13,       /*      Unit (Inch),                */
68	0x34,             /*      Physical Minimum (0),       */
69	0x09, 0x30,       /*      Usage (X),                  */
70	0x46, 0x7C, 0x15, /*      Physical Maximum (5500),    */
71	0x26, 0x00, 0x37, /*      Logical Maximum (14080),    */
72	0x81, 0x02,       /*      Input (Variable),           */
73	0x09, 0x31,       /*      Usage (Y),                  */
74	0x46, 0xA0, 0x0F, /*      Physical Maximum (4000),    */
75	0x26, 0x00, 0x28, /*      Logical Maximum (10240),    */
76	0x81, 0x02,       /*      Input (Variable),           */
77	0xB4,             /*      Pop,                        */
78	0x09, 0x30,       /*      Usage (Tip Pressure),       */
79	0x26, 0xFF, 0x03, /*      Logical Maximum (1023),     */
80	0x81, 0x02,       /*      Input (Variable),           */
81	0xC0,             /*    End Collection,               */
82	0xC0              /*  End Collection                  */
83};
84
85/*
86 * See MousePen i608X description, device and HID report descriptors at
87 * http://sf.net/apps/mediawiki/digimend/?title=KYE_MousePen_i608X
88 */
89
90/* Original MousePen i608X report descriptor size */
91#define MOUSEPEN_I608X_RDESC_ORIG_SIZE	476
92
93/* Fixed MousePen i608X report descriptor */
94static __u8 mousepen_i608x_rdesc_fixed[] = {
95	0x06, 0x00, 0xFF, /*  Usage Page (FF00h),             */
96	0x09, 0x01,       /*  Usage (01h),                    */
97	0xA1, 0x01,       /*  Collection (Application),       */
98	0x85, 0x05,       /*    Report ID (5),                */
99	0x09, 0x01,       /*    Usage (01h),                  */
100	0x15, 0x80,       /*    Logical Minimum (-128),       */
101	0x25, 0x7F,       /*    Logical Maximum (127),        */
102	0x75, 0x08,       /*    Report Size (8),              */
103	0x95, 0x07,       /*    Report Count (7),             */
104	0xB1, 0x02,       /*    Feature (Variable),           */
105	0xC0,             /*  End Collection,                 */
106	0x05, 0x0D,       /*  Usage Page (Digitizer),         */
107	0x09, 0x02,       /*  Usage (Pen),                    */
108	0xA1, 0x01,       /*  Collection (Application),       */
109	0x85, 0x10,       /*    Report ID (16),               */
110	0x09, 0x20,       /*    Usage (Stylus),               */
111	0xA0,             /*    Collection (Physical),        */
112	0x14,             /*      Logical Minimum (0),        */
113	0x25, 0x01,       /*      Logical Maximum (1),        */
114	0x75, 0x01,       /*      Report Size (1),            */
115	0x09, 0x42,       /*      Usage (Tip Switch),         */
116	0x09, 0x44,       /*      Usage (Barrel Switch),      */
117	0x09, 0x46,       /*      Usage (Tablet Pick),        */
118	0x95, 0x03,       /*      Report Count (3),           */
119	0x81, 0x02,       /*      Input (Variable),           */
120	0x95, 0x04,       /*      Report Count (4),           */
121	0x81, 0x03,       /*      Input (Constant, Variable), */
122	0x09, 0x32,       /*      Usage (In Range),           */
123	0x95, 0x01,       /*      Report Count (1),           */
124	0x81, 0x02,       /*      Input (Variable),           */
125	0x75, 0x10,       /*      Report Size (16),           */
126	0x95, 0x01,       /*      Report Count (1),           */
127	0xA4,             /*      Push,                       */
128	0x05, 0x01,       /*      Usage Page (Desktop),       */
129	0x55, 0xFD,       /*      Unit Exponent (-3),         */
130	0x65, 0x13,       /*      Unit (Inch),                */
131	0x34,             /*      Physical Minimum (0),       */
132	0x09, 0x30,       /*      Usage (X),                  */
133	0x46, 0x40, 0x1F, /*      Physical Maximum (8000),    */
134	0x26, 0x00, 0x50, /*      Logical Maximum (20480),    */
135	0x81, 0x02,       /*      Input (Variable),           */
136	0x09, 0x31,       /*      Usage (Y),                  */
137	0x46, 0x70, 0x17, /*      Physical Maximum (6000),    */
138	0x26, 0x00, 0x3C, /*      Logical Maximum (15360),    */
139	0x81, 0x02,       /*      Input (Variable),           */
140	0xB4,             /*      Pop,                        */
141	0x09, 0x30,       /*      Usage (Tip Pressure),       */
142	0x26, 0xFF, 0x03, /*      Logical Maximum (1023),     */
143	0x81, 0x02,       /*      Input (Variable),           */
144	0xC0,             /*    End Collection,               */
145	0xC0,             /*  End Collection,                 */
146	0x05, 0x01,       /*  Usage Page (Desktop),           */
147	0x09, 0x02,       /*  Usage (Mouse),                  */
148	0xA1, 0x01,       /*  Collection (Application),       */
149	0x85, 0x11,       /*    Report ID (17),               */
150	0x09, 0x01,       /*    Usage (Pointer),              */
151	0xA0,             /*    Collection (Physical),        */
152	0x14,             /*      Logical Minimum (0),        */
153	0xA4,             /*      Push,                       */
154	0x05, 0x09,       /*      Usage Page (Button),        */
155	0x75, 0x01,       /*      Report Size (1),            */
156	0x19, 0x01,       /*      Usage Minimum (01h),        */
157	0x29, 0x03,       /*      Usage Maximum (03h),        */
158	0x25, 0x01,       /*      Logical Maximum (1),        */
159	0x95, 0x03,       /*      Report Count (3),           */
160	0x81, 0x02,       /*      Input (Variable),           */
161	0x95, 0x05,       /*      Report Count (5),           */
162	0x81, 0x01,       /*      Input (Constant),           */
163	0xB4,             /*      Pop,                        */
164	0x95, 0x01,       /*      Report Count (1),           */
165	0xA4,             /*      Push,                       */
166	0x55, 0xFD,       /*      Unit Exponent (-3),         */
167	0x65, 0x13,       /*      Unit (Inch),                */
168	0x34,             /*      Physical Minimum (0),       */
169	0x75, 0x10,       /*      Report Size (16),           */
170	0x09, 0x30,       /*      Usage (X),                  */
171	0x46, 0x40, 0x1F, /*      Physical Maximum (8000),    */
172	0x26, 0x00, 0x50, /*      Logical Maximum (20480),    */
173	0x81, 0x02,       /*      Input (Variable),           */
174	0x09, 0x31,       /*      Usage (Y),                  */
175	0x46, 0x70, 0x17, /*      Physical Maximum (6000),    */
176	0x26, 0x00, 0x3C, /*      Logical Maximum (15360),    */
177	0x81, 0x02,       /*      Input (Variable),           */
178	0xB4,             /*      Pop,                        */
179	0x75, 0x08,       /*      Report Size (8),            */
180	0x09, 0x38,       /*      Usage (Wheel),              */
181	0x15, 0xFF,       /*      Logical Minimum (-1),       */
182	0x25, 0x01,       /*      Logical Maximum (1),        */
183	0x81, 0x06,       /*      Input (Variable, Relative), */
184	0x81, 0x01,       /*      Input (Constant),           */
185	0xC0,             /*    End Collection,               */
186	0xC0              /*  End Collection                  */
187};
188
189/*
190 * See EasyPen M610X description, device and HID report descriptors at
191 * http://sf.net/apps/mediawiki/digimend/?title=KYE_EasyPen_M610X
192 */
193
194/* Original EasyPen M610X report descriptor size */
195#define EASYPEN_M610X_RDESC_ORIG_SIZE	476
196
197/* Fixed EasyPen M610X report descriptor */
198static __u8 easypen_m610x_rdesc_fixed[] = {
199	0x06, 0x00, 0xFF,             /*  Usage Page (FF00h),             */
200	0x09, 0x01,                   /*  Usage (01h),                    */
201	0xA1, 0x01,                   /*  Collection (Application),       */
202	0x85, 0x05,                   /*    Report ID (5),                */
203	0x09, 0x01,                   /*    Usage (01h),                  */
204	0x15, 0x80,                   /*    Logical Minimum (-128),       */
205	0x25, 0x7F,                   /*    Logical Maximum (127),        */
206	0x75, 0x08,                   /*    Report Size (8),              */
207	0x95, 0x07,                   /*    Report Count (7),             */
208	0xB1, 0x02,                   /*    Feature (Variable),           */
209	0xC0,                         /*  End Collection,                 */
210	0x05, 0x0D,                   /*  Usage Page (Digitizer),         */
211	0x09, 0x02,                   /*  Usage (Pen),                    */
212	0xA1, 0x01,                   /*  Collection (Application),       */
213	0x85, 0x10,                   /*    Report ID (16),               */
214	0x09, 0x20,                   /*    Usage (Stylus),               */
215	0xA0,                         /*    Collection (Physical),        */
216	0x14,                         /*      Logical Minimum (0),        */
217	0x25, 0x01,                   /*      Logical Maximum (1),        */
218	0x75, 0x01,                   /*      Report Size (1),            */
219	0x09, 0x42,                   /*      Usage (Tip Switch),         */
220	0x09, 0x44,                   /*      Usage (Barrel Switch),      */
221	0x09, 0x46,                   /*      Usage (Tablet Pick),        */
222	0x95, 0x03,                   /*      Report Count (3),           */
223	0x81, 0x02,                   /*      Input (Variable),           */
224	0x95, 0x04,                   /*      Report Count (4),           */
225	0x81, 0x03,                   /*      Input (Constant, Variable), */
226	0x09, 0x32,                   /*      Usage (In Range),           */
227	0x95, 0x01,                   /*      Report Count (1),           */
228	0x81, 0x02,                   /*      Input (Variable),           */
229	0x75, 0x10,                   /*      Report Size (16),           */
230	0x95, 0x01,                   /*      Report Count (1),           */
231	0xA4,                         /*      Push,                       */
232	0x05, 0x01,                   /*      Usage Page (Desktop),       */
233	0x55, 0xFD,                   /*      Unit Exponent (-3),         */
234	0x65, 0x13,                   /*      Unit (Inch),                */
235	0x34,                         /*      Physical Minimum (0),       */
236	0x09, 0x30,                   /*      Usage (X),                  */
237	0x46, 0x10, 0x27,             /*      Physical Maximum (10000),   */
238	0x27, 0x00, 0xA0, 0x00, 0x00, /*      Logical Maximum (40960),    */
239	0x81, 0x02,                   /*      Input (Variable),           */
240	0x09, 0x31,                   /*      Usage (Y),                  */
241	0x46, 0x6A, 0x18,             /*      Physical Maximum (6250),    */
242	0x26, 0x00, 0x64,             /*      Logical Maximum (25600),    */
243	0x81, 0x02,                   /*      Input (Variable),           */
244	0xB4,                         /*      Pop,                        */
245	0x09, 0x30,                   /*      Usage (Tip Pressure),       */
246	0x26, 0xFF, 0x03,             /*      Logical Maximum (1023),     */
247	0x81, 0x02,                   /*      Input (Variable),           */
248	0xC0,                         /*    End Collection,               */
249	0xC0,                         /*  End Collection,                 */
250	0x05, 0x0C,                   /*  Usage Page (Consumer),          */
251	0x09, 0x01,                   /*  Usage (Consumer Control),       */
252	0xA1, 0x01,                   /*  Collection (Application),       */
253	0x85, 0x12,                   /*    Report ID (18),               */
254	0x14,                         /*    Logical Minimum (0),          */
255	0x25, 0x01,                   /*    Logical Maximum (1),          */
256	0x75, 0x01,                   /*    Report Size (1),              */
257	0x95, 0x04,                   /*    Report Count (4),             */
258	0x0A, 0x1A, 0x02,             /*    Usage (AC Undo),              */
259	0x0A, 0x79, 0x02,             /*    Usage (AC Redo Or Repeat),    */
260	0x0A, 0x2D, 0x02,             /*    Usage (AC Zoom In),           */
261	0x0A, 0x2E, 0x02,             /*    Usage (AC Zoom Out),          */
262	0x81, 0x02,                   /*    Input (Variable),             */
263	0x95, 0x01,                   /*    Report Count (1),             */
264	0x75, 0x14,                   /*    Report Size (20),             */
265	0x81, 0x03,                   /*    Input (Constant, Variable),   */
266	0x75, 0x20,                   /*    Report Size (32),             */
267	0x81, 0x03,                   /*    Input (Constant, Variable),   */
268	0xC0                          /*  End Collection                  */
269};
270
271
272/* Original PenSketch M912 report descriptor size */
273#define PENSKETCH_M912_RDESC_ORIG_SIZE	482
274
275/* Fixed PenSketch M912 report descriptor */
276static __u8 pensketch_m912_rdesc_fixed[] = {
277	0x05, 0x01,                   /*  Usage Page (Desktop),           */
278	0x08,                         /*  Usage (00h),                    */
279	0xA1, 0x01,                   /*  Collection (Application),       */
280	0x85, 0x05,                   /*    Report ID (5),                */
281	0x06, 0x00, 0xFF,             /*    Usage Page (FF00h),           */
282	0x09, 0x01,                   /*    Usage (01h),                  */
283	0x15, 0x81,                   /*    Logical Minimum (-127),       */
284	0x25, 0x7F,                   /*    Logical Maximum (127),        */
285	0x75, 0x08,                   /*    Report Size (8),              */
286	0x95, 0x07,                   /*    Report Count (7),             */
287	0xB1, 0x02,                   /*    Feature (Variable),           */
288	0xC0,                         /*  End Collection,                 */
289	0x05, 0x0D,                   /*  Usage Page (Digitizer),         */
290	0x09, 0x02,                   /*  Usage (Pen),                    */
291	0xA1, 0x01,                   /*  Collection (Application),       */
292	0x85, 0x10,                   /*    Report ID (16),               */
293	0x09, 0x20,                   /*    Usage (Stylus),               */
294	0xA0,                         /*    Collection (Physical),        */
295	0x09, 0x42,                   /*      Usage (Tip Switch),         */
296	0x09, 0x44,                   /*      Usage (Barrel Switch),      */
297	0x09, 0x46,                   /*      Usage (Tablet Pick),        */
298	0x14,                         /*      Logical Minimum (0),        */
299	0x25, 0x01,                   /*      Logical Maximum (1),        */
300	0x75, 0x01,                   /*      Report Size (1),            */
301	0x95, 0x03,                   /*      Report Count (3),           */
302	0x81, 0x02,                   /*      Input (Variable),           */
303	0x95, 0x04,                   /*      Report Count (4),           */
304	0x81, 0x03,                   /*      Input (Constant, Variable), */
305	0x09, 0x32,                   /*      Usage (In Range),           */
306	0x95, 0x01,                   /*      Report Count (1),           */
307	0x81, 0x02,                   /*      Input (Variable),           */
308	0x75, 0x10,                   /*      Report Size (16),           */
309	0x95, 0x01,                   /*      Report Count (1),           */
310	0xA4,                         /*      Push,                       */
311	0x05, 0x01,                   /*      Usage Page (Desktop),       */
312	0x55, 0xFD,                   /*      Unit Exponent (-3),         */
313	0x65, 0x13,                   /*      Unit (Inch),                */
314	0x14,                         /*      Logical Minimum (0),        */
315	0x34,                         /*      Physical Minimum (0),       */
316	0x09, 0x30,                   /*      Usage (X),                  */
317	0x27, 0x00, 0xF0, 0x00, 0x00, /*      Logical Maximum (61440),    */
318	0x46, 0xE0, 0x2E,             /*      Physical Maximum (12000),   */
319	0x81, 0x02,                   /*      Input (Variable),           */
320	0x09, 0x31,                   /*      Usage (Y),                  */
321	0x27, 0x00, 0xB4, 0x00, 0x00, /*      Logical Maximum (46080),    */
322	0x46, 0x28, 0x23,             /*      Physical Maximum (9000),    */
323	0x81, 0x02,                   /*      Input (Variable),           */
324	0xB4,                         /*      Pop,                        */
325	0x09, 0x30,                   /*      Usage (Tip Pressure),       */
326	0x14,                         /*      Logical Minimum (0),        */
327	0x26, 0xFF, 0x07,             /*      Logical Maximum (2047),     */
328	0x81, 0x02,                   /*      Input (Variable),           */
329	0xC0,                         /*    End Collection,               */
330	0xC0,                         /*  End Collection,                 */
331	0x05, 0x0D,                   /*  Usage Page (Digitizer),         */
332	0x09, 0x21,                   /*  Usage (Puck),                   */
333	0xA1, 0x01,                   /*  Collection (Application),       */
334	0x85, 0x11,                   /*    Report ID (17),               */
335	0x09, 0x21,                   /*    Usage (Puck),                 */
336	0xA0,                         /*    Collection (Physical),        */
337	0x05, 0x09,                   /*      Usage Page (Button),        */
338	0x75, 0x01,                   /*      Report Size (1),            */
339	0x19, 0x01,                   /*      Usage Minimum (01h),        */
340	0x29, 0x03,                   /*      Usage Maximum (03h),        */
341	0x14,                         /*      Logical Minimum (0),        */
342	0x25, 0x01,                   /*      Logical Maximum (1),        */
343	0x95, 0x03,                   /*      Report Count (3),           */
344	0x81, 0x02,                   /*      Input (Variable),           */
345	0x95, 0x04,                   /*      Report Count (4),           */
346	0x81, 0x01,                   /*      Input (Constant),           */
347	0x95, 0x01,                   /*      Report Count (1),           */
348	0x0B, 0x32, 0x00, 0x0D, 0x00, /*      Usage (Digitizer In Range), */
349	0x14,                         /*      Logical Minimum (0),        */
350	0x25, 0x01,                   /*      Logical Maximum (1),        */
351	0x81, 0x02,                   /*      Input (Variable),           */
352	0xA4,                         /*      Push,                       */
353	0x05, 0x01,                   /*      Usage Page (Desktop),       */
354	0x75, 0x10,                   /*      Report Size (16),           */
355	0x95, 0x01,                   /*      Report Count (1),           */
356	0x55, 0xFD,                   /*      Unit Exponent (-3),         */
357	0x65, 0x13,                   /*      Unit (Inch),                */
358	0x14,                         /*      Logical Minimum (0),        */
359	0x34,                         /*      Physical Minimum (0),       */
360	0x09, 0x30,                   /*      Usage (X),                  */
361	0x27, 0x00, 0xF0, 0x00, 0x00, /*      Logical Maximum (61440),    */
362	0x46, 0xE0, 0x2E,             /*      Physical Maximum (12000),   */
363	0x81, 0x02,                   /*      Input (Variable),           */
364	0x09, 0x31,                   /*      Usage (Y),                  */
365	0x27, 0x00, 0xB4, 0x00, 0x00, /*      Logical Maximum (46080),    */
366	0x46, 0x28, 0x23,             /*      Physical Maximum (9000),    */
367	0x81, 0x02,                   /*      Input (Variable),           */
368	0x09, 0x38,                   /*      Usage (Wheel),              */
369	0x75, 0x08,                   /*      Report Size (8),            */
370	0x95, 0x01,                   /*      Report Count (1),           */
371	0x15, 0xFF,                   /*      Logical Minimum (-1),       */
372	0x25, 0x01,                   /*      Logical Maximum (1),        */
373	0x34,                         /*      Physical Minimum (0),       */
374	0x44,                         /*      Physical Maximum (0),       */
375	0x81, 0x06,                   /*      Input (Variable, Relative), */
376	0xB4,                         /*      Pop,                        */
377	0xC0,                         /*    End Collection,               */
378	0xC0,                         /*  End Collection,                 */
379	0x05, 0x0C,                   /*  Usage Page (Consumer),          */
380	0x09, 0x01,                   /*  Usage (Consumer Control),       */
381	0xA1, 0x01,                   /*  Collection (Application),       */
382	0x85, 0x12,                   /*    Report ID (18),               */
383	0x14,                         /*    Logical Minimum (0),          */
384	0x25, 0x01,                   /*    Logical Maximum (1),          */
385	0x75, 0x01,                   /*    Report Size (1),              */
386	0x95, 0x08,                   /*    Report Count (8),             */
387	0x05, 0x0C,                   /*    Usage Page (Consumer),        */
388	0x0A, 0x6A, 0x02,             /*    Usage (AC Delete),            */
389	0x0A, 0x1A, 0x02,             /*    Usage (AC Undo),              */
390	0x0A, 0x01, 0x02,             /*    Usage (AC New),               */
391	0x0A, 0x2F, 0x02,             /*    Usage (AC Zoom),              */
392	0x0A, 0x25, 0x02,             /*    Usage (AC Forward),           */
393	0x0A, 0x24, 0x02,             /*    Usage (AC Back),              */
394	0x0A, 0x2D, 0x02,             /*    Usage (AC Zoom In),           */
395	0x0A, 0x2E, 0x02,             /*    Usage (AC Zoom Out),          */
396	0x81, 0x02,                   /*    Input (Variable),             */
397	0x95, 0x30,                   /*    Report Count (48),            */
398	0x81, 0x03,                   /*    Input (Constant, Variable),   */
399	0xC0                          /*  End Collection                  */
400};
401
402static __u8 *kye_consumer_control_fixup(struct hid_device *hdev, __u8 *rdesc,
403		unsigned int *rsize, int offset, const char *device_name) {
404	/*
405	 * the fixup that need to be done:
406	 *   - change Usage Maximum in the Comsumer Control
407	 *     (report ID 3) to a reasonable value
408	 */
409	if (*rsize >= offset + 31 &&
410	    /* Usage Page (Consumer Devices) */
411	    rdesc[offset] == 0x05 && rdesc[offset + 1] == 0x0c &&
412	    /* Usage (Consumer Control) */
413	    rdesc[offset + 2] == 0x09 && rdesc[offset + 3] == 0x01 &&
414	    /*   Usage Maximum > 12287 */
415	    rdesc[offset + 10] == 0x2a && rdesc[offset + 12] > 0x2f) {
416		hid_info(hdev, "fixing up %s report descriptor\n", device_name);
417		rdesc[offset + 12] = 0x2f;
418	}
419	return rdesc;
420}
421
422static __u8 *kye_report_fixup(struct hid_device *hdev, __u8 *rdesc,
423		unsigned int *rsize)
424{
425	switch (hdev->product) {
426	case USB_DEVICE_ID_KYE_ERGO_525V:
427		/* the fixups that need to be done:
428		 *   - change led usage page to button for extra buttons
429		 *   - report size 8 count 1 must be size 1 count 8 for button
430		 *     bitfield
431		 *   - change the button usage range to 4-7 for the extra
432		 *     buttons
433		 */
434		if (*rsize >= 75 &&
435			rdesc[61] == 0x05 && rdesc[62] == 0x08 &&
436			rdesc[63] == 0x19 && rdesc[64] == 0x08 &&
437			rdesc[65] == 0x29 && rdesc[66] == 0x0f &&
438			rdesc[71] == 0x75 && rdesc[72] == 0x08 &&
439			rdesc[73] == 0x95 && rdesc[74] == 0x01) {
440			hid_info(hdev,
441				 "fixing up Kye/Genius Ergo Mouse "
442				 "report descriptor\n");
443			rdesc[62] = 0x09;
444			rdesc[64] = 0x04;
445			rdesc[66] = 0x07;
446			rdesc[72] = 0x01;
447			rdesc[74] = 0x08;
448		}
449		break;
450	case USB_DEVICE_ID_KYE_EASYPEN_I405X:
451		if (*rsize == EASYPEN_I405X_RDESC_ORIG_SIZE) {
452			rdesc = easypen_i405x_rdesc_fixed;
453			*rsize = sizeof(easypen_i405x_rdesc_fixed);
454		}
455		break;
456	case USB_DEVICE_ID_KYE_MOUSEPEN_I608X:
457	case USB_DEVICE_ID_KYE_MOUSEPEN_I608X_2:
458		if (*rsize == MOUSEPEN_I608X_RDESC_ORIG_SIZE) {
459			rdesc = mousepen_i608x_rdesc_fixed;
460			*rsize = sizeof(mousepen_i608x_rdesc_fixed);
461		}
462		break;
463	case USB_DEVICE_ID_KYE_EASYPEN_M610X:
464		if (*rsize == EASYPEN_M610X_RDESC_ORIG_SIZE) {
465			rdesc = easypen_m610x_rdesc_fixed;
466			*rsize = sizeof(easypen_m610x_rdesc_fixed);
467		}
468		break;
469	case USB_DEVICE_ID_KYE_PENSKETCH_M912:
470		if (*rsize == PENSKETCH_M912_RDESC_ORIG_SIZE) {
471			rdesc = pensketch_m912_rdesc_fixed;
472			*rsize = sizeof(pensketch_m912_rdesc_fixed);
473		}
474		break;
475	case USB_DEVICE_ID_GENIUS_GILA_GAMING_MOUSE:
476		rdesc = kye_consumer_control_fixup(hdev, rdesc, rsize, 104,
477					"Genius Gila Gaming Mouse");
478		break;
479	case USB_DEVICE_ID_GENIUS_GX_IMPERATOR:
480		rdesc = kye_consumer_control_fixup(hdev, rdesc, rsize, 83,
481					"Genius Gx Imperator Keyboard");
482		break;
483	case USB_DEVICE_ID_GENIUS_MANTICORE:
484		rdesc = kye_consumer_control_fixup(hdev, rdesc, rsize, 104,
485					"Genius Manticore Keyboard");
486		break;
487	}
488	return rdesc;
489}
490
491/**
492 * Enable fully-functional tablet mode by setting a special feature report.
493 *
494 * @hdev:	HID device
495 *
496 * The specific report ID and data were discovered by sniffing the
497 * Windows driver traffic.
498 */
499static int kye_tablet_enable(struct hid_device *hdev)
500{
501	struct list_head *list;
502	struct list_head *head;
503	struct hid_report *report;
504	__s32 *value;
505
506	list = &hdev->report_enum[HID_FEATURE_REPORT].report_list;
507	list_for_each(head, list) {
508		report = list_entry(head, struct hid_report, list);
509		if (report->id == 5)
510			break;
511	}
512
513	if (head == list) {
514		hid_err(hdev, "tablet-enabling feature report not found\n");
515		return -ENODEV;
516	}
517
518	if (report->maxfield < 1 || report->field[0]->report_count < 7) {
519		hid_err(hdev, "invalid tablet-enabling feature report\n");
520		return -ENODEV;
521	}
522
523	value = report->field[0]->value;
524
525	value[0] = 0x12;
526	value[1] = 0x10;
527	value[2] = 0x11;
528	value[3] = 0x12;
529	value[4] = 0x00;
530	value[5] = 0x00;
531	value[6] = 0x00;
532	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
533
534	return 0;
535}
536
537static int kye_probe(struct hid_device *hdev, const struct hid_device_id *id)
538{
539	int ret;
540
541	ret = hid_parse(hdev);
542	if (ret) {
543		hid_err(hdev, "parse failed\n");
544		goto err;
545	}
546
547	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
548	if (ret) {
549		hid_err(hdev, "hw start failed\n");
550		goto err;
551	}
552
553	switch (id->product) {
554	case USB_DEVICE_ID_KYE_EASYPEN_I405X:
555	case USB_DEVICE_ID_KYE_MOUSEPEN_I608X:
556	case USB_DEVICE_ID_KYE_MOUSEPEN_I608X_2:
557	case USB_DEVICE_ID_KYE_EASYPEN_M610X:
558	case USB_DEVICE_ID_KYE_PENSKETCH_M912:
559		ret = kye_tablet_enable(hdev);
560		if (ret) {
561			hid_err(hdev, "tablet enabling failed\n");
562			goto enabling_err;
563		}
564		break;
565	case USB_DEVICE_ID_GENIUS_MANTICORE:
566		/*
567		 * The manticore keyboard needs to have all the interfaces
568		 * opened at least once to be fully functional.
569		 */
570		if (hid_hw_open(hdev))
571			hid_hw_close(hdev);
572		break;
573	}
574
575	return 0;
576enabling_err:
577	hid_hw_stop(hdev);
578err:
579	return ret;
580}
581
582static const struct hid_device_id kye_devices[] = {
583	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_ERGO_525V) },
584	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
585				USB_DEVICE_ID_KYE_EASYPEN_I405X) },
586	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
587				USB_DEVICE_ID_KYE_MOUSEPEN_I608X) },
588	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
589				USB_DEVICE_ID_KYE_MOUSEPEN_I608X_2) },
590	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
591				USB_DEVICE_ID_KYE_EASYPEN_M610X) },
592	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
593				USB_DEVICE_ID_GENIUS_GILA_GAMING_MOUSE) },
594	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
595				USB_DEVICE_ID_GENIUS_GX_IMPERATOR) },
596	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
597				USB_DEVICE_ID_GENIUS_MANTICORE) },
598	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE,
599				USB_DEVICE_ID_KYE_PENSKETCH_M912) },
600	{ }
601};
602MODULE_DEVICE_TABLE(hid, kye_devices);
603
604static struct hid_driver kye_driver = {
605	.name = "kye",
606	.id_table = kye_devices,
607	.probe = kye_probe,
608	.report_fixup = kye_report_fixup,
609};
610module_hid_driver(kye_driver);
611
612MODULE_LICENSE("GPL");
613