2 * Wacom protocol 4 serial tablet driver
4 * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
5 * Copyright 2011-2012 Julian Squires <julian@cipht.net>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version of 2 of the License, or (at your
10 * option) any later version. See the file COPYING in the main directory of
11 * this archive for more details.
13 * Many thanks to Bill Seremetis, without whom PenPartner support
14 * would not have been possible. Thanks to Patrick Mahoney.
16 * This driver was developed with reference to much code written by others,
18 * - elo, gunze drivers by Vojtech Pavlik <vojtech@ucw.cz>;
19 * - wacom_w8001 driver by Jaya Kumar <jayakumar.lkml@gmail.com>;
20 * - the USB wacom input driver, credited to many people
21 * (see drivers/input/tablet/wacom.h);
22 * - new and old versions of linuxwacom / xf86-input-wacom credited to
23 * Frederic Lepied, France. <Lepied@XFree86.org> and
24 * Ping Cheng, Wacom. <pingc@wacom.com>;
25 * - and xf86wacom.c (a presumably ancient version of the linuxwacom code),
26 * by Frederic Lepied and Raph Levien <raph@gtk.org>.
29 * - support pad buttons; (requires access to a model with pad buttons)
30 * - support (protocol 4-style) tilt (requires access to a > 1.4 rom model)
34 * Wacom serial protocol 4 documentation taken from linuxwacom-0.9.9 code,
35 * protocol 4 uses 7 or 9 byte of data in the following format:
38 * bit 7 Sync bit always 1
39 * bit 6 Pointing device detected
40 * bit 5 Cursor = 0 / Stylus = 1
42 * bit 3 1 if a button on the pointing device has been pressed
75 * bit 6 Sign of pressure data; or wheel-rel for cursor tool
76 * bit 5 P7; or REL1 for cursor tool
77 * bit 4 P6; or REL0 for cursor tool
83 * byte 8 and 9 are optional and present only
88 * bit 6 Sign of tilt X
98 * bit 6 Sign of tilt Y
107 #include <linux/completion.h>
108 #include <linux/init.h>
109 #include <linux/input.h>
110 #include <linux/interrupt.h>
111 #include <linux/kernel.h>
112 #include <linux/module.h>
113 #include <linux/serio.h>
114 #include <linux/slab.h>
115 #include <linux/string.h>
117 MODULE_AUTHOR("Julian Squires <julian@cipht.net>, Hans de Goede <hdegoede@redhat.com>");
118 MODULE_DESCRIPTION("Wacom protocol 4 serial tablet driver");
119 MODULE_LICENSE("GPL");
121 #define REQUEST_MODEL_AND_ROM_VERSION "~#"
122 #define REQUEST_MAX_COORDINATES "~C\r"
123 #define REQUEST_CONFIGURATION_STRING "~R\r"
124 #define REQUEST_RESET_TO_PROTOCOL_IV "\r#"
126 * Note: sending "\r$\r" causes at least the Digitizer II to send
127 * packets in ASCII instead of binary. "\r#" seems to undo that.
130 #define COMMAND_START_SENDING_PACKETS "ST\r"
131 #define COMMAND_STOP_SENDING_PACKETS "SP\r"
132 #define COMMAND_MULTI_MODE_INPUT "MU1\r"
133 #define COMMAND_ORIGIN_IN_UPPER_LEFT "OC1\r"
134 #define COMMAND_ENABLE_ALL_MACRO_BUTTONS "~M0\r"
135 #define COMMAND_DISABLE_GROUP_1_MACRO_BUTTONS "~M1\r"
136 #define COMMAND_TRANSMIT_AT_MAX_RATE "IT0\r"
137 #define COMMAND_DISABLE_INCREMENTAL_MODE "IN0\r"
138 #define COMMAND_ENABLE_CONTINUOUS_MODE "SR\r"
139 #define COMMAND_ENABLE_PRESSURE_MODE "PH1\r"
140 #define COMMAND_Z_FILTER "ZF1\r"
142 /* Note that this is a protocol 4 packet without tilt information. */
143 #define PACKET_LENGTH 7
147 #define F_COVERS_SCREEN 0x01
148 #define F_HAS_STYLUS2 0x02
149 #define F_HAS_SCROLLWHEEL 0x04
152 #define STYLUS_DEVICE_ID 0x02
153 #define CURSOR_DEVICE_ID 0x06
154 #define ERASER_DEVICE_ID 0x0A
156 enum { STYLUS = 1, ERASER, CURSOR };
158 static const struct {
163 { STYLUS_DEVICE_ID, BTN_TOOL_PEN },
164 { ERASER_DEVICE_ID, BTN_TOOL_RUBBER },
165 { CURSOR_DEVICE_ID, BTN_TOOL_MOUSE },
169 struct input_dev *dev;
170 struct completion cmd_done;
174 unsigned int extra_z_bits;
176 unsigned int res_x, res_y;
177 unsigned int max_x, max_y;
185 MODEL_CINTIQ = 0x504C, /* PL */
186 MODEL_CINTIQ2 = 0x4454, /* DT */
187 MODEL_DIGITIZER_II = 0x5544, /* UD */
188 MODEL_GRAPHIRE = 0x4554, /* ET */
189 MODEL_PENPARTNER = 0x4354, /* CT */
190 MODEL_ARTPAD_II = 0x4B54, /* KT */
193 static void wacom_handle_model_response(struct wacom *wacom)
195 int major_v, minor_v, r = 0;
198 p = strrchr(wacom->data, 'V');
200 r = sscanf(p + 1, "%u.%u", &major_v, &minor_v);
202 major_v = minor_v = 0;
204 switch (wacom->data[2] << 8 | wacom->data[3]) {
205 case MODEL_CINTIQ: /* UNTESTED */
207 if ((wacom->data[2] << 8 | wacom->data[3]) == MODEL_CINTIQ) {
208 wacom->dev->name = "Wacom Cintiq";
209 wacom->dev->id.version = MODEL_CINTIQ;
211 wacom->dev->name = "Wacom Cintiq II";
212 wacom->dev->id.version = MODEL_CINTIQ2;
217 switch (wacom->data[5] << 8 | wacom->data[6]) {
218 case 0x3731: /* PL-710 */
222 case 0x3535: /* PL-550 */
223 case 0x3830: /* PL-800 */
224 wacom->extra_z_bits = 2;
227 wacom->flags = F_COVERS_SCREEN;
230 case MODEL_PENPARTNER:
231 wacom->dev->name = "Wacom Penpartner";
232 wacom->dev->id.version = MODEL_PENPARTNER;
238 wacom->dev->name = "Wacom Graphire";
239 wacom->dev->id.version = MODEL_GRAPHIRE;
244 wacom->extra_z_bits = 2;
245 wacom->eraser_mask = 0x08;
246 wacom->flags = F_HAS_STYLUS2 | F_HAS_SCROLLWHEEL;
249 case MODEL_ARTPAD_II:
250 case MODEL_DIGITIZER_II:
251 wacom->dev->name = "Wacom Digitizer II";
252 wacom->dev->id.version = MODEL_DIGITIZER_II;
253 if (major_v == 1 && minor_v <= 2)
254 wacom->extra_z_bits = 0; /* UNTESTED */
258 dev_err(&wacom->dev->dev, "Unsupported Wacom model %s\n",
260 wacom->result = -ENODEV;
264 dev_info(&wacom->dev->dev, "%s tablet, version %u.%u\n",
265 wacom->dev->name, major_v, minor_v);
268 static void wacom_handle_configuration_response(struct wacom *wacom)
272 dev_dbg(&wacom->dev->dev, "Configuration string: %s\n", wacom->data);
273 r = sscanf(wacom->data, "~R%x,%u,%u,%u,%u", &skip, &skip, &skip,
274 &wacom->res_x, &wacom->res_y);
276 dev_warn(&wacom->dev->dev, "could not get resolution\n");
279 static void wacom_handle_coordinates_response(struct wacom *wacom)
283 dev_dbg(&wacom->dev->dev, "Coordinates string: %s\n", wacom->data);
284 r = sscanf(wacom->data, "~C%u,%u", &wacom->max_x, &wacom->max_y);
286 dev_warn(&wacom->dev->dev, "could not get max coordinates\n");
289 static void wacom_handle_response(struct wacom *wacom)
291 if (wacom->data[0] != '~' || wacom->data[1] != wacom->expect) {
292 dev_err(&wacom->dev->dev,
293 "Wacom got an unexpected response: %s\n", wacom->data);
294 wacom->result = -EIO;
298 switch (wacom->data[1]) {
300 wacom_handle_model_response(wacom);
303 wacom_handle_configuration_response(wacom);
306 wacom_handle_coordinates_response(wacom);
311 complete(&wacom->cmd_done);
314 static void wacom_handle_packet(struct wacom *wacom)
316 u8 in_proximity_p, stylus_p, button;
320 in_proximity_p = wacom->data[0] & 0x40;
321 stylus_p = wacom->data[0] & 0x20;
322 button = (wacom->data[3] & 0x78) >> 3;
323 x = (wacom->data[0] & 3) << 14 | wacom->data[1]<<7 | wacom->data[2];
324 y = (wacom->data[3] & 3) << 14 | wacom->data[4]<<7 | wacom->data[5];
326 if (in_proximity_p && stylus_p) {
327 z = wacom->data[6] & 0x7f;
328 if (wacom->extra_z_bits >= 1)
329 z = z << 1 | (wacom->data[3] & 0x4) >> 2;
330 if (wacom->extra_z_bits > 1)
331 z = z << 1 | (wacom->data[0] & 0x4) >> 2;
332 z = z ^ (0x40 << wacom->extra_z_bits);
338 tool = (button & wacom->eraser_mask) ? ERASER : STYLUS;
342 if (tool != wacom->tool && wacom->tool != 0) {
343 input_report_key(wacom->dev, tools[wacom->tool].input_id, 0);
344 input_sync(wacom->dev);
348 input_report_key(wacom->dev, tools[tool].input_id, in_proximity_p);
349 input_report_abs(wacom->dev, ABS_MISC,
350 in_proximity_p ? tools[tool].device_id : 0);
351 input_report_abs(wacom->dev, ABS_X, x);
352 input_report_abs(wacom->dev, ABS_Y, y);
353 input_report_abs(wacom->dev, ABS_PRESSURE, z);
355 input_report_key(wacom->dev, BTN_TOUCH, button & 1);
356 input_report_key(wacom->dev, BTN_STYLUS, button & 2);
357 input_report_key(wacom->dev, BTN_STYLUS2, button & 4);
359 input_report_key(wacom->dev, BTN_LEFT, button & 1);
360 input_report_key(wacom->dev, BTN_RIGHT, button & 2);
361 input_report_key(wacom->dev, BTN_MIDDLE, button & 4);
362 /* handle relative wheel for non-stylus device */
363 z = (wacom->data[6] & 0x30) >> 4;
364 if (wacom->data[6] & 0x40)
366 input_report_rel(wacom->dev, REL_WHEEL, z);
368 input_sync(wacom->dev);
371 static void wacom_clear_data_buf(struct wacom *wacom)
373 memset(wacom->data, 0, DATA_SIZE);
377 static irqreturn_t wacom_interrupt(struct serio *serio, unsigned char data,
380 struct wacom *wacom = serio_get_drvdata(serio);
386 * We're either expecting a carriage return-terminated ASCII
387 * response string, or a seven-byte packet with the MSB set on
390 * Note however that some tablets (the PenPartner, for
391 * example) don't send a carriage return at the end of a
392 * command. We handle these by waiting for timeout.
394 if (data == '\r' && !(wacom->data[0] & 0x80)) {
395 wacom_handle_response(wacom);
396 wacom_clear_data_buf(wacom);
400 /* Leave place for 0 termination */
401 if (wacom->idx > (DATA_SIZE - 2)) {
402 dev_dbg(&wacom->dev->dev,
403 "throwing away %d bytes of garbage\n", wacom->idx);
404 wacom_clear_data_buf(wacom);
406 wacom->data[wacom->idx++] = data;
408 if (wacom->idx == PACKET_LENGTH && (wacom->data[0] & 0x80)) {
409 wacom_handle_packet(wacom);
410 wacom_clear_data_buf(wacom);
416 static void wacom_disconnect(struct serio *serio)
418 struct wacom *wacom = serio_get_drvdata(serio);
421 serio_set_drvdata(serio, NULL);
422 input_unregister_device(wacom->dev);
426 static int wacom_send(struct serio *serio, const u8 *command)
430 for (; !err && *command; command++)
431 err = serio_write(serio, *command);
436 static int wacom_send_setup_string(struct wacom *wacom, struct serio *serio)
440 switch (wacom->dev->id.version) {
441 case MODEL_CINTIQ: /* UNTESTED */
442 cmd = COMMAND_ORIGIN_IN_UPPER_LEFT
443 COMMAND_TRANSMIT_AT_MAX_RATE
444 COMMAND_ENABLE_CONTINUOUS_MODE
445 COMMAND_START_SENDING_PACKETS;
448 case MODEL_PENPARTNER:
449 cmd = COMMAND_ENABLE_PRESSURE_MODE
450 COMMAND_START_SENDING_PACKETS;
454 cmd = COMMAND_MULTI_MODE_INPUT
455 COMMAND_ORIGIN_IN_UPPER_LEFT
456 COMMAND_ENABLE_ALL_MACRO_BUTTONS
457 COMMAND_DISABLE_GROUP_1_MACRO_BUTTONS
458 COMMAND_TRANSMIT_AT_MAX_RATE
459 COMMAND_DISABLE_INCREMENTAL_MODE
460 COMMAND_ENABLE_CONTINUOUS_MODE
462 COMMAND_START_SENDING_PACKETS;
466 return wacom_send(serio, cmd);
469 static int wacom_send_and_wait(struct wacom *wacom, struct serio *serio,
470 const u8 *cmd, const char *desc)
475 wacom->expect = cmd[1];
476 init_completion(&wacom->cmd_done);
478 err = wacom_send(serio, cmd);
482 u = wait_for_completion_timeout(&wacom->cmd_done, HZ);
484 /* Timeout, process what we've received. */
485 wacom_handle_response(wacom);
489 return wacom->result;
492 static int wacom_setup(struct wacom *wacom, struct serio *serio)
496 /* Note that setting the link speed is the job of inputattach.
497 * We assume that reset negotiation has already happened,
499 err = wacom_send_and_wait(wacom, serio, REQUEST_MODEL_AND_ROM_VERSION,
500 "model and version");
504 if (!(wacom->res_x && wacom->res_y)) {
505 err = wacom_send_and_wait(wacom, serio,
506 REQUEST_CONFIGURATION_STRING,
507 "configuration string");
512 if (!(wacom->max_x && wacom->max_y)) {
513 err = wacom_send_and_wait(wacom, serio,
514 REQUEST_MAX_COORDINATES,
515 "coordinates string");
520 return wacom_send_setup_string(wacom, serio);
523 static int wacom_connect(struct serio *serio, struct serio_driver *drv)
526 struct input_dev *input_dev;
529 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
530 input_dev = input_allocate_device();
531 if (!wacom || !input_dev)
534 wacom->dev = input_dev;
535 wacom->extra_z_bits = 1;
536 wacom->eraser_mask = 0x04;
537 wacom->tool = wacom->idx = 0;
538 snprintf(wacom->phys, sizeof(wacom->phys), "%s/input0", serio->phys);
539 input_dev->phys = wacom->phys;
540 input_dev->id.bustype = BUS_RS232;
541 input_dev->id.vendor = SERIO_WACOM_IV;
542 input_dev->id.product = serio->id.extra;
543 input_dev->dev.parent = &serio->dev;
545 input_dev->evbit[0] =
546 BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) | BIT_MASK(EV_REL);
547 set_bit(ABS_MISC, input_dev->absbit);
548 set_bit(BTN_TOOL_PEN, input_dev->keybit);
549 set_bit(BTN_TOOL_RUBBER, input_dev->keybit);
550 set_bit(BTN_TOOL_MOUSE, input_dev->keybit);
551 set_bit(BTN_TOUCH, input_dev->keybit);
552 set_bit(BTN_STYLUS, input_dev->keybit);
553 set_bit(BTN_LEFT, input_dev->keybit);
554 set_bit(BTN_RIGHT, input_dev->keybit);
555 set_bit(BTN_MIDDLE, input_dev->keybit);
557 serio_set_drvdata(serio, wacom);
559 err = serio_open(serio, drv);
563 err = wacom_setup(wacom, serio);
567 set_bit(INPUT_PROP_DIRECT, input_dev->propbit);
568 if (!(wacom->flags & F_COVERS_SCREEN))
569 __set_bit(INPUT_PROP_POINTER, input_dev->propbit);
571 if (wacom->flags & F_HAS_STYLUS2)
572 __set_bit(BTN_STYLUS2, input_dev->keybit);
574 if (wacom->flags & F_HAS_SCROLLWHEEL)
575 __set_bit(REL_WHEEL, input_dev->relbit);
577 input_abs_set_res(wacom->dev, ABS_X, wacom->res_x);
578 input_abs_set_res(wacom->dev, ABS_Y, wacom->res_y);
579 input_set_abs_params(wacom->dev, ABS_X, 0, wacom->max_x, 0, 0);
580 input_set_abs_params(wacom->dev, ABS_Y, 0, wacom->max_y, 0, 0);
581 input_set_abs_params(wacom->dev, ABS_PRESSURE, -1,
582 (1 << (7 + wacom->extra_z_bits)) - 1, 0, 0);
584 err = input_register_device(wacom->dev);
593 serio_set_drvdata(serio, NULL);
594 input_free_device(input_dev);
599 static const struct serio_device_id wacom_serio_ids[] = {
602 .proto = SERIO_WACOM_IV,
609 MODULE_DEVICE_TABLE(serio, wacom_serio_ids);
611 static struct serio_driver wacom_drv = {
613 .name = "wacom_serial4",
615 .description = "Wacom protocol 4 serial tablet driver",
616 .id_table = wacom_serio_ids,
617 .interrupt = wacom_interrupt,
618 .connect = wacom_connect,
619 .disconnect = wacom_disconnect,
622 module_serio_driver(wacom_drv);