1 // SPDX-License-Identifier: GPL-2.0+
3 * HID driver for UC-Logic devices not fully compliant with HID standard
5 * Copyright (c) 2010-2014 Nikolai Kondrashov
6 * Copyright (c) 2013 Martin Rusko
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)
16 #include <linux/device.h>
17 #include <linux/hid.h>
18 #include <linux/module.h>
19 #include <linux/timer.h>
20 #include "usbhid/usbhid.h"
21 #include "hid-uclogic-params.h"
26 struct uclogic_drvdata {
27 /* Interface parameters */
28 struct uclogic_params params;
29 /* Pointer to the replacement report descriptor. NULL if none. */
32 * Size of the replacement report descriptor.
33 * Only valid if desc_ptr is not NULL
35 unsigned int desc_size;
36 /* Pen input device */
37 struct input_dev *pen_input;
39 struct timer_list inrange_timer;
40 /* Last rotary encoder state, or U8_MAX for none */
45 * uclogic_inrange_timeout - handle pen in-range state timeout.
46 * Emulate input events normally generated when pen goes out of range for
47 * tablets which don't report that.
49 * @t: The timer the timeout handler is attached to, stored in a struct
52 static void uclogic_inrange_timeout(struct timer_list *t)
54 struct uclogic_drvdata *drvdata = from_timer(drvdata, t,
56 struct input_dev *input = drvdata->pen_input;
60 input_report_abs(input, ABS_PRESSURE, 0);
61 /* If BTN_TOUCH state is changing */
62 if (test_bit(BTN_TOUCH, input->key)) {
63 input_event(input, EV_MSC, MSC_SCAN,
64 /* Digitizer Tip Switch usage */
66 input_report_key(input, BTN_TOUCH, 0);
68 input_report_key(input, BTN_TOOL_PEN, 0);
72 static __u8 *uclogic_report_fixup(struct hid_device *hdev, __u8 *rdesc,
75 struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
77 if (drvdata->desc_ptr != NULL) {
78 rdesc = drvdata->desc_ptr;
79 *rsize = drvdata->desc_size;
84 static int uclogic_input_mapping(struct hid_device *hdev,
86 struct hid_field *field,
87 struct hid_usage *usage,
91 struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
92 struct uclogic_params *params = &drvdata->params;
94 /* discard the unused pen interface */
95 if (params->pen_unused && (field->application == HID_DG_PEN))
98 /* let hid-core decide what to do */
102 static int uclogic_input_configured(struct hid_device *hdev,
103 struct hid_input *hi)
105 struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
106 struct uclogic_params *params = &drvdata->params;
108 const char *suffix = NULL;
109 struct hid_field *field;
112 /* no report associated (HID_QUIRK_MULTI_INPUT not set) */
117 * If this is the input corresponding to the pen report
118 * in need of tweaking.
120 if (hi->report->id == params->pen.id) {
121 /* Remember the input device so we can simulate events */
122 drvdata->pen_input = hi->input;
125 field = hi->report->field[0];
127 switch (field->application) {
128 case HID_GD_KEYBOARD:
140 case HID_CP_CONSUMER_CONTROL:
141 suffix = "Consumer Control";
143 case HID_GD_SYSTEM_CONTROL:
144 suffix = "System Control";
149 len = strlen(hdev->name) + 2 + strlen(suffix);
150 name = devm_kzalloc(&hi->input->dev, len, GFP_KERNEL);
152 snprintf(name, len, "%s %s", hdev->name, suffix);
153 hi->input->name = name;
160 static int uclogic_probe(struct hid_device *hdev,
161 const struct hid_device_id *id)
164 struct uclogic_drvdata *drvdata = NULL;
165 bool params_initialized = false;
167 if (!hid_is_usb(hdev))
171 * libinput requires the pad interface to be on a different node
172 * than the pen, so use QUIRK_MULTI_INPUT for all tablets.
174 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
176 /* Allocate and assign driver data */
177 drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
178 if (drvdata == NULL) {
182 timer_setup(&drvdata->inrange_timer, uclogic_inrange_timeout, 0);
183 drvdata->re_state = U8_MAX;
184 hid_set_drvdata(hdev, drvdata);
186 /* Initialize the device and retrieve interface parameters */
187 rc = uclogic_params_init(&drvdata->params, hdev);
189 hid_err(hdev, "failed probing parameters: %d\n", rc);
192 params_initialized = true;
193 hid_dbg(hdev, "parameters:\n" UCLOGIC_PARAMS_FMT_STR,
194 UCLOGIC_PARAMS_FMT_ARGS(&drvdata->params));
195 if (drvdata->params.invalid) {
196 hid_info(hdev, "interface is invalid, ignoring\n");
201 /* Generate replacement report descriptor */
202 rc = uclogic_params_get_desc(&drvdata->params,
204 &drvdata->desc_size);
207 "failed generating replacement report descriptor: %d\n",
212 rc = hid_parse(hdev);
214 hid_err(hdev, "parse failed\n");
218 rc = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
220 hid_err(hdev, "hw start failed\n");
226 /* Assume "remove" might not be called if "probe" failed */
227 if (params_initialized)
228 uclogic_params_cleanup(&drvdata->params);
233 static int uclogic_resume(struct hid_device *hdev)
236 struct uclogic_params params;
238 /* Re-initialize the device, but discard parameters */
239 rc = uclogic_params_init(¶ms, hdev);
241 hid_err(hdev, "failed to re-initialize the device\n");
243 uclogic_params_cleanup(¶ms);
249 static int uclogic_raw_event(struct hid_device *hdev,
250 struct hid_report *report,
253 struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
254 struct uclogic_params *params = &drvdata->params;
256 /* Tweak pen reports, if necessary */
257 if (!params->pen_unused &&
258 (report->type == HID_INPUT_REPORT) &&
259 (report->id == params->pen.id) &&
261 /* If it's the "virtual" frame controls report */
262 if (params->frame.id != 0 &&
263 data[1] & params->pen_frame_flag) {
264 /* Change to virtual frame controls report ID */
265 data[0] = params->frame.id;
268 /* If in-range reports are inverted */
269 if (params->pen.inrange ==
270 UCLOGIC_PARAMS_PEN_INRANGE_INVERTED) {
271 /* Invert the in-range bit */
275 * If report contains fragmented high-resolution pen
278 if (size >= 10 && params->pen.fragmented_hires) {
279 u8 pressure_low_byte;
280 u8 pressure_high_byte;
282 /* Lift pressure bytes */
283 pressure_low_byte = data[6];
284 pressure_high_byte = data[7];
286 * Move Y coord to make space for high-order X
291 /* Move high-order X coord byte */
293 /* Move high-order Y coord byte */
295 /* Place pressure bytes */
296 data[8] = pressure_low_byte;
297 data[9] = pressure_high_byte;
299 /* If we need to emulate in-range detection */
300 if (params->pen.inrange == UCLOGIC_PARAMS_PEN_INRANGE_NONE) {
301 /* Set in-range bit */
303 /* (Re-)start in-range timeout */
304 mod_timer(&drvdata->inrange_timer,
305 jiffies + msecs_to_jiffies(100));
309 /* Tweak frame control reports, if necessary */
310 if ((report->type == HID_INPUT_REPORT) &&
311 (report->id == params->frame.id)) {
312 /* If need to, and can, set pad device ID for Wacom drivers */
313 if (params->frame.dev_id_byte > 0 &&
314 params->frame.dev_id_byte < size) {
315 data[params->frame.dev_id_byte] = 0xf;
317 /* If need to, and can, read rotary encoder state change */
318 if (params->frame.re_lsb > 0 &&
319 params->frame.re_lsb / 8 < size) {
320 unsigned int byte = params->frame.re_lsb / 8;
321 unsigned int bit = params->frame.re_lsb % 8;
324 u8 prev_state = drvdata->re_state;
325 /* Read Gray-coded state */
326 u8 state = (data[byte] >> bit) & 0x3;
327 /* Encode state change into 2-bit signed integer */
328 if ((prev_state == 1 && state == 0) ||
329 (prev_state == 2 && state == 3)) {
331 } else if ((prev_state == 2 && state == 0) ||
332 (prev_state == 1 && state == 3)) {
338 data[byte] = (data[byte] & ~((u8)3 << bit)) |
341 drvdata->re_state = state;
348 static void uclogic_remove(struct hid_device *hdev)
350 struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
352 del_timer_sync(&drvdata->inrange_timer);
354 kfree(drvdata->desc_ptr);
355 uclogic_params_cleanup(&drvdata->params);
358 static const struct hid_device_id uclogic_devices[] = {
359 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
360 USB_DEVICE_ID_UCLOGIC_TABLET_PF1209) },
361 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
362 USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U) },
363 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
364 USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U) },
365 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
366 USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U) },
367 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
368 USB_DEVICE_ID_UCLOGIC_TABLET_WP1062) },
369 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
370 USB_DEVICE_ID_UCLOGIC_WIRELESS_TABLET_TWHL850) },
371 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
372 USB_DEVICE_ID_UCLOGIC_TABLET_TWHA60) },
373 { HID_USB_DEVICE(USB_VENDOR_ID_HUION,
374 USB_DEVICE_ID_HUION_TABLET) },
375 { HID_USB_DEVICE(USB_VENDOR_ID_HUION,
376 USB_DEVICE_ID_HUION_HS64) },
377 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
378 USB_DEVICE_ID_HUION_TABLET) },
379 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
380 USB_DEVICE_ID_YIYNOVA_TABLET) },
381 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
382 USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_81) },
383 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
384 USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_45) },
385 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
386 USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_47) },
387 { HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
388 USB_DEVICE_ID_UCLOGIC_DRAWIMAGE_G3) },
389 { HID_USB_DEVICE(USB_VENDOR_ID_UGTIZER,
390 USB_DEVICE_ID_UGTIZER_TABLET_GP0610) },
391 { HID_USB_DEVICE(USB_VENDOR_ID_UGTIZER,
392 USB_DEVICE_ID_UGTIZER_TABLET_GT5040) },
393 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
394 USB_DEVICE_ID_UGEE_TABLET_G5) },
395 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
396 USB_DEVICE_ID_UGEE_TABLET_EX07S) },
397 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
398 USB_DEVICE_ID_UGEE_TABLET_RAINBOW_CV720) },
399 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
400 USB_DEVICE_ID_UGEE_XPPEN_TABLET_G540) },
401 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
402 USB_DEVICE_ID_UGEE_XPPEN_TABLET_G640) },
403 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
404 USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO01) },
407 MODULE_DEVICE_TABLE(hid, uclogic_devices);
409 static struct hid_driver uclogic_driver = {
411 .id_table = uclogic_devices,
412 .probe = uclogic_probe,
413 .remove = uclogic_remove,
414 .report_fixup = uclogic_report_fixup,
415 .raw_event = uclogic_raw_event,
416 .input_mapping = uclogic_input_mapping,
417 .input_configured = uclogic_input_configured,
419 .resume = uclogic_resume,
420 .reset_resume = uclogic_resume,
423 module_hid_driver(uclogic_driver);
425 MODULE_AUTHOR("Martin Rusko");
426 MODULE_AUTHOR("Nikolai Kondrashov");
427 MODULE_LICENSE("GPL");