]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/hid/wacom_sys.c
HID: wacom: Split apart 'wacom_setup_pentouch_input_capabilites'
[mirror_ubuntu-bionic-kernel.git] / drivers / hid / wacom_sys.c
CommitLineData
3bea733a 1/*
4104d13f 2 * drivers/input/tablet/wacom_sys.c
3bea733a 3 *
232f5693 4 * USB Wacom tablet support - system specific code
3bea733a
PC
5 */
6
7/*
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 */
13
3bea733a 14#include "wacom_wac.h"
51269fe8 15#include "wacom.h"
b58ba1ba 16#include <linux/input/mt.h>
3bea733a 17
a417ea44 18#define WAC_MSG_RETRIES 5
3bea733a 19
912ca216 20#define WAC_CMD_WL_LED_CONTROL 0x03
5d7e7d47
EH
21#define WAC_CMD_LED_CONTROL 0x20
22#define WAC_CMD_ICON_START 0x21
23#define WAC_CMD_ICON_XFER 0x23
849e2f06 24#define WAC_CMD_ICON_BT_XFER 0x26
5d7e7d47
EH
25#define WAC_CMD_RETRIES 10
26
e0984bc3
PC
27#define DEV_ATTR_RW_PERM (S_IRUGO | S_IWUSR | S_IWGRP)
28#define DEV_ATTR_WO_PERM (S_IWUSR | S_IWGRP)
29
c64d8834
PC
30static int wacom_get_report(struct hid_device *hdev, u8 type, u8 *buf,
31 size_t size, unsigned int retries)
3bea733a 32{
5d7e7d47
EH
33 int retval;
34
35 do {
c64d8834 36 retval = hid_hw_raw_request(hdev, buf[0], buf, size, type,
27b20a9d 37 HID_REQ_GET_REPORT);
aef3156d
JG
38 } while ((retval == -ETIMEDOUT || retval == -EAGAIN) && --retries);
39
40 if (retval < 0)
41 hid_err(hdev, "wacom_get_report: ran out of retries "
42 "(last error = %d)\n", retval);
5d7e7d47
EH
43
44 return retval;
3bea733a
PC
45}
46
296b7378
PF
47static int wacom_set_report(struct hid_device *hdev, u8 type, u8 *buf,
48 size_t size, unsigned int retries)
3bea733a 49{
5d7e7d47
EH
50 int retval;
51
52 do {
296b7378 53 retval = hid_hw_raw_request(hdev, buf[0], buf, size, type,
27b20a9d 54 HID_REQ_SET_REPORT);
aef3156d
JG
55 } while ((retval == -ETIMEDOUT || retval == -EAGAIN) && --retries);
56
57 if (retval < 0)
58 hid_err(hdev, "wacom_set_report: ran out of retries "
59 "(last error = %d)\n", retval);
5d7e7d47
EH
60
61 return retval;
3bea733a
PC
62}
63
29b47391
BT
64static int wacom_raw_event(struct hid_device *hdev, struct hid_report *report,
65 u8 *raw_data, int size)
3bea733a 66{
29b47391 67 struct wacom *wacom = hid_get_drvdata(hdev);
3bea733a 68
29b47391
BT
69 if (size > WACOM_PKGLEN_MAX)
70 return 1;
3bea733a 71
29b47391 72 memcpy(wacom->wacom_wac.data, raw_data, size);
3bea733a 73
29b47391
BT
74 wacom_wac_irq(&wacom->wacom_wac, size);
75
76 return 0;
3bea733a
PC
77}
78
3bea733a
PC
79static int wacom_open(struct input_dev *dev)
80{
7791bdae 81 struct wacom *wacom = input_get_drvdata(dev);
29b47391 82
dff67416 83 return hid_hw_open(wacom->hdev);
3bea733a
PC
84}
85
86static void wacom_close(struct input_dev *dev)
87{
7791bdae 88 struct wacom *wacom = input_get_drvdata(dev);
3bea733a 89
29b47391 90 hid_hw_close(wacom->hdev);
3bea733a
PC
91}
92
115d5e12 93/*
198fdee2 94 * Calculate the resolution of the X or Y axis using hidinput_calc_abs_res.
115d5e12
JG
95 */
96static int wacom_calc_hid_res(int logical_extents, int physical_extents,
c669fb2b 97 unsigned unit, int exponent)
115d5e12 98{
198fdee2
BT
99 struct hid_field field = {
100 .logical_maximum = logical_extents,
101 .physical_maximum = physical_extents,
102 .unit = unit,
103 .unit_exponent = exponent,
104 };
105
106 return hidinput_calc_abs_res(&field, ABS_X);
115d5e12
JG
107}
108
c669fb2b
BT
109static void wacom_feature_mapping(struct hid_device *hdev,
110 struct hid_field *field, struct hid_usage *usage)
f393ee2b 111{
c669fb2b
BT
112 struct wacom *wacom = hid_get_drvdata(hdev);
113 struct wacom_features *features = &wacom->wacom_wac.features;
5ae6e89f 114 struct hid_data *hid_data = &wacom->wacom_wac.hid_data;
8ffffd52
BT
115 u8 *data;
116 int ret;
f393ee2b 117
c669fb2b
BT
118 switch (usage->hid) {
119 case HID_DG_CONTACTMAX:
120 /* leave touch_max as is if predefined */
8ffffd52
BT
121 if (!features->touch_max) {
122 /* read manually */
123 data = kzalloc(2, GFP_KERNEL);
124 if (!data)
125 break;
126 data[0] = field->report->id;
127 ret = wacom_get_report(hdev, HID_FEATURE_REPORT,
05e8fd92
JG
128 data, 2, WAC_CMD_RETRIES);
129 if (ret == 2) {
8ffffd52 130 features->touch_max = data[1];
05e8fd92
JG
131 } else {
132 features->touch_max = 16;
133 hid_warn(hdev, "wacom_feature_mapping: "
134 "could not get HID_DG_CONTACTMAX, "
135 "defaulting to %d\n",
136 features->touch_max);
137 }
8ffffd52
BT
138 kfree(data);
139 }
c669fb2b 140 break;
5ae6e89f
BT
141 case HID_DG_INPUTMODE:
142 /* Ignore if value index is out of bounds. */
143 if (usage->usage_index >= field->report_count) {
144 dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
145 break;
146 }
147
148 hid_data->inputmode = field->report->id;
149 hid_data->inputmode_index = usage->usage_index;
150 break;
f393ee2b
PC
151 }
152}
153
428f8588
CB
154/*
155 * Interface Descriptor of wacom devices can be incomplete and
156 * inconsistent so wacom_features table is used to store stylus
157 * device's packet lengths, various maximum values, and tablet
158 * resolution based on product ID's.
159 *
160 * For devices that contain 2 interfaces, wacom_features table is
161 * inaccurate for the touch interface. Since the Interface Descriptor
162 * for touch interfaces has pretty complete data, this function exists
163 * to query tablet for this missing information instead of hard coding in
164 * an additional table.
165 *
166 * A typical Interface Descriptor for a stylus will contain a
167 * boot mouse application collection that is not of interest and this
168 * function will ignore it.
169 *
170 * It also contains a digitizer application collection that also is not
171 * of interest since any information it contains would be duplicate
172 * of what is in wacom_features. Usually it defines a report of an array
173 * of bytes that could be used as max length of the stylus packet returned.
174 * If it happens to define a Digitizer-Stylus Physical Collection then
175 * the X and Y logical values contain valid data but it is ignored.
176 *
177 * A typical Interface Descriptor for a touch interface will contain a
178 * Digitizer-Finger Physical Collection which will define both logical
179 * X/Y maximum as well as the physical size of tablet. Since touch
180 * interfaces haven't supported pressure or distance, this is enough
181 * information to override invalid values in the wacom_features table.
4134361a 182 *
c669fb2b
BT
183 * Intuos5 touch interface and 3rd gen Bamboo Touch do not contain useful
184 * data. We deal with them after returning from this function.
428f8588 185 */
c669fb2b
BT
186static void wacom_usage_mapping(struct hid_device *hdev,
187 struct hid_field *field, struct hid_usage *usage)
545f4e99 188{
c669fb2b
BT
189 struct wacom *wacom = hid_get_drvdata(hdev);
190 struct wacom_features *features = &wacom->wacom_wac.features;
d97a5522
BT
191 bool finger = WACOM_FINGER_FIELD(field);
192 bool pen = WACOM_PEN_FIELD(field);
e9fc413f 193
c669fb2b
BT
194 /*
195 * Requiring Stylus Usage will ignore boot mouse
196 * X/Y values and some cases of invalid Digitizer X/Y
197 * values commonly reported.
198 */
042628ab 199 if (pen)
aa86b18c 200 features->device_type |= WACOM_DEVICETYPE_PEN;
042628ab 201 else if (finger)
aa86b18c 202 features->device_type |= WACOM_DEVICETYPE_TOUCH;
042628ab 203 else
c669fb2b
BT
204 return;
205
30ebc1ae
PC
206 /*
207 * Bamboo models do not support HID_DG_CONTACTMAX.
208 * And, Bamboo Pen only descriptor contains touch.
209 */
210 if (features->type != BAMBOO_PT) {
211 /* ISDv4 touch devices at least supports one touch point */
212 if (finger && !features->touch_max)
213 features->touch_max = 1;
214 }
c669fb2b
BT
215
216 switch (usage->hid) {
217 case HID_GD_X:
218 features->x_max = field->logical_maximum;
219 if (finger) {
c669fb2b
BT
220 features->x_phy = field->physical_maximum;
221 if (features->type != BAMBOO_PT) {
222 features->unit = field->unit;
223 features->unitExpo = field->unit_exponent;
545f4e99 224 }
c669fb2b
BT
225 }
226 break;
227 case HID_GD_Y:
228 features->y_max = field->logical_maximum;
229 if (finger) {
230 features->y_phy = field->physical_maximum;
231 if (features->type != BAMBOO_PT) {
232 features->unit = field->unit;
233 features->unitExpo = field->unit_exponent;
234 }
235 }
236 break;
237 case HID_DG_TIPPRESSURE:
238 if (pen)
239 features->pressure_max = field->logical_maximum;
240 break;
241 }
7704ac93
BT
242
243 if (features->type == HID_GENERIC)
244 wacom_wac_usage_mapping(hdev, field, usage);
c669fb2b 245}
4134361a 246
b58ba1ba
JG
247static void wacom_post_parse_hid(struct hid_device *hdev,
248 struct wacom_features *features)
249{
250 struct wacom *wacom = hid_get_drvdata(hdev);
251 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
252
253 if (features->type == HID_GENERIC) {
254 /* Any last-minute generic device setup */
255 if (features->touch_max > 1) {
256 input_mt_init_slots(wacom_wac->input, wacom_wac->features.touch_max,
257 INPUT_MT_DIRECT);
258 }
259 }
260}
261
c669fb2b
BT
262static void wacom_parse_hid(struct hid_device *hdev,
263 struct wacom_features *features)
264{
265 struct hid_report_enum *rep_enum;
266 struct hid_report *hreport;
267 int i, j;
268
269 /* check features first */
270 rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
271 list_for_each_entry(hreport, &rep_enum->report_list, list) {
272 for (i = 0; i < hreport->maxfield; i++) {
273 /* Ignore if report count is out of bounds. */
274 if (hreport->field[i]->report_count < 1)
275 continue;
276
277 for (j = 0; j < hreport->field[i]->maxusage; j++) {
278 wacom_feature_mapping(hdev, hreport->field[i],
279 hreport->field[i]->usage + j);
4134361a 280 }
545f4e99
PC
281 }
282 }
283
c669fb2b
BT
284 /* now check the input usages */
285 rep_enum = &hdev->report_enum[HID_INPUT_REPORT];
286 list_for_each_entry(hreport, &rep_enum->report_list, list) {
287
288 if (!hreport->maxfield)
289 continue;
290
291 for (i = 0; i < hreport->maxfield; i++)
292 for (j = 0; j < hreport->field[i]->maxusage; j++)
293 wacom_usage_mapping(hdev, hreport->field[i],
294 hreport->field[i]->usage + j);
295 }
b58ba1ba
JG
296
297 wacom_post_parse_hid(hdev, features);
545f4e99
PC
298}
299
5ae6e89f
BT
300static int wacom_hid_set_device_mode(struct hid_device *hdev)
301{
302 struct wacom *wacom = hid_get_drvdata(hdev);
303 struct hid_data *hid_data = &wacom->wacom_wac.hid_data;
304 struct hid_report *r;
305 struct hid_report_enum *re;
306
307 if (hid_data->inputmode < 0)
308 return 0;
309
310 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
311 r = re->report_id_hash[hid_data->inputmode];
312 if (r) {
313 r->field[0]->value[hid_data->inputmode_index] = 2;
314 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
315 }
316 return 0;
317}
318
27b20a9d
BT
319static int wacom_set_device_mode(struct hid_device *hdev, int report_id,
320 int length, int mode)
3b7307c2
DT
321{
322 unsigned char *rep_data;
fe494bc2 323 int error = -ENOMEM, limit = 0;
3b7307c2 324
fe494bc2 325 rep_data = kzalloc(length, GFP_KERNEL);
3b7307c2 326 if (!rep_data)
ec67bbed
PC
327 return error;
328
fe494bc2 329 do {
9937c026
CB
330 rep_data[0] = report_id;
331 rep_data[1] = mode;
332
296b7378
PF
333 error = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data,
334 length, 1);
3cb83157 335 if (error >= 0)
27b20a9d 336 error = wacom_get_report(hdev, HID_FEATURE_REPORT,
c64d8834 337 rep_data, length, 1);
fe494bc2
JG
338 } while ((error < 0 || rep_data[1] != mode) && limit++ < WAC_MSG_RETRIES);
339
340 kfree(rep_data);
341
342 return error < 0 ? error : 0;
343}
344
f81a1295
BT
345static int wacom_bt_query_tablet_data(struct hid_device *hdev, u8 speed,
346 struct wacom_features *features)
347{
387142bb
BT
348 struct wacom *wacom = hid_get_drvdata(hdev);
349 int ret;
350 u8 rep_data[2];
351
352 switch (features->type) {
353 case GRAPHIRE_BT:
354 rep_data[0] = 0x03;
355 rep_data[1] = 0x00;
296b7378
PF
356 ret = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data, 2,
357 3);
387142bb
BT
358
359 if (ret >= 0) {
360 rep_data[0] = speed == 0 ? 0x05 : 0x06;
361 rep_data[1] = 0x00;
362
363 ret = wacom_set_report(hdev, HID_FEATURE_REPORT,
296b7378 364 rep_data, 2, 3);
387142bb
BT
365
366 if (ret >= 0) {
367 wacom->wacom_wac.bt_high_speed = speed;
368 return 0;
369 }
370 }
371
372 /*
373 * Note that if the raw queries fail, it's not a hard failure
374 * and it is safe to continue
375 */
376 hid_warn(hdev, "failed to poke device, command %d, err %d\n",
377 rep_data[0], ret);
378 break;
81af7e61
BT
379 case INTUOS4WL:
380 if (speed == 1)
381 wacom->wacom_wac.bt_features &= ~0x20;
382 else
383 wacom->wacom_wac.bt_features |= 0x20;
384
385 rep_data[0] = 0x03;
386 rep_data[1] = wacom->wacom_wac.bt_features;
387
296b7378
PF
388 ret = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data, 2,
389 1);
81af7e61
BT
390 if (ret >= 0)
391 wacom->wacom_wac.bt_high_speed = speed;
392 break;
387142bb
BT
393 }
394
f81a1295
BT
395 return 0;
396}
397
fe494bc2
JG
398/*
399 * Switch the tablet into its most-capable mode. Wacom tablets are
400 * typically configured to power-up in a mode which sends mouse-like
401 * reports to the OS. To get absolute position, pressure data, etc.
402 * from the tablet, it is necessary to switch the tablet out of this
403 * mode and into one which sends the full range of tablet data.
404 */
27b20a9d
BT
405static int wacom_query_tablet_data(struct hid_device *hdev,
406 struct wacom_features *features)
fe494bc2 407{
f81a1295
BT
408 if (hdev->bus == BUS_BLUETOOTH)
409 return wacom_bt_query_tablet_data(hdev, 1, features);
410
5ae6e89f
BT
411 if (features->type == HID_GENERIC)
412 return wacom_hid_set_device_mode(hdev);
413
aa86b18c 414 if (features->device_type & WACOM_DEVICETYPE_TOUCH) {
ea2e6024 415 if (features->type > TABLETPC) {
fe494bc2 416 /* MT Tablet PC touch */
27b20a9d 417 return wacom_set_device_mode(hdev, 3, 4, 4);
fe494bc2 418 }
36d3c510 419 else if (features->type == WACOM_24HDT || features->type == CINTIQ_HYBRID) {
27b20a9d 420 return wacom_set_device_mode(hdev, 18, 3, 2);
b1e4279e 421 }
500d4160
PC
422 else if (features->type == WACOM_27QHDT) {
423 return wacom_set_device_mode(hdev, 131, 3, 2);
424 }
8c97a765
BT
425 else if (features->type == BAMBOO_PAD) {
426 return wacom_set_device_mode(hdev, 2, 2, 2);
427 }
aa86b18c 428 } else if (features->device_type & WACOM_DEVICETYPE_PEN) {
fe494bc2 429 if (features->type <= BAMBOO_PT && features->type != WIRELESS) {
27b20a9d 430 return wacom_set_device_mode(hdev, 2, 2, 2);
1963518b 431 }
ec67bbed 432 }
3b7307c2 433
fe494bc2 434 return 0;
3b7307c2
DT
435}
436
c669fb2b 437static void wacom_retrieve_hid_descriptor(struct hid_device *hdev,
1963518b 438 struct wacom_features *features)
ec67bbed 439{
27b20a9d
BT
440 struct wacom *wacom = hid_get_drvdata(hdev);
441 struct usb_interface *intf = wacom->intf;
ec67bbed 442
fed87e65 443 /* default features */
fed87e65
HR
444 features->x_fuzz = 4;
445 features->y_fuzz = 4;
446 features->pressure_fuzz = 0;
447 features->distance_fuzz = 0;
ec67bbed 448
d3825d51
CB
449 /*
450 * The wireless device HID is basic and layout conflicts with
451 * other tablets (monitor and touch interface can look like pen).
452 * Skip the query for this type and modify defaults based on
453 * interface number.
454 */
455 if (features->type == WIRELESS) {
456 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
aa86b18c 457 features->device_type = WACOM_DEVICETYPE_NONE;
d3825d51 458 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
aa86b18c 459 features->device_type |= WACOM_DEVICETYPE_TOUCH;
d3825d51
CB
460 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
461 }
462 }
463
c669fb2b 464 wacom_parse_hid(hdev, features);
ec67bbed
PC
465}
466
4451e088 467struct wacom_hdev_data {
4492efff
PC
468 struct list_head list;
469 struct kref kref;
4451e088 470 struct hid_device *dev;
4492efff
PC
471 struct wacom_shared shared;
472};
473
474static LIST_HEAD(wacom_udev_list);
475static DEFINE_MUTEX(wacom_udev_list_lock);
476
4451e088
BT
477static bool wacom_are_sibling(struct hid_device *hdev,
478 struct hid_device *sibling)
aea2bf6a 479{
4451e088
BT
480 struct wacom *wacom = hid_get_drvdata(hdev);
481 struct wacom_features *features = &wacom->wacom_wac.features;
482 int vid = features->oVid;
483 int pid = features->oPid;
484 int n1,n2;
485
486 if (vid == 0 && pid == 0) {
487 vid = hdev->vendor;
488 pid = hdev->product;
489 }
aea2bf6a 490
4451e088
BT
491 if (vid != sibling->vendor || pid != sibling->product)
492 return false;
aea2bf6a 493
4451e088
BT
494 /* Compare the physical path. */
495 n1 = strrchr(hdev->phys, '.') - hdev->phys;
496 n2 = strrchr(sibling->phys, '.') - sibling->phys;
497 if (n1 != n2 || n1 <= 0 || n2 <= 0)
498 return false;
aea2bf6a 499
4451e088 500 return !strncmp(hdev->phys, sibling->phys, n1);
aea2bf6a
JG
501}
502
4451e088 503static struct wacom_hdev_data *wacom_get_hdev_data(struct hid_device *hdev)
4492efff 504{
4451e088 505 struct wacom_hdev_data *data;
4492efff
PC
506
507 list_for_each_entry(data, &wacom_udev_list, list) {
4451e088 508 if (wacom_are_sibling(hdev, data->dev)) {
4492efff
PC
509 kref_get(&data->kref);
510 return data;
511 }
512 }
513
514 return NULL;
515}
516
4451e088 517static int wacom_add_shared_data(struct hid_device *hdev)
4492efff 518{
4451e088
BT
519 struct wacom *wacom = hid_get_drvdata(hdev);
520 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
521 struct wacom_hdev_data *data;
4492efff
PC
522 int retval = 0;
523
524 mutex_lock(&wacom_udev_list_lock);
525
4451e088 526 data = wacom_get_hdev_data(hdev);
4492efff 527 if (!data) {
4451e088 528 data = kzalloc(sizeof(struct wacom_hdev_data), GFP_KERNEL);
4492efff
PC
529 if (!data) {
530 retval = -ENOMEM;
531 goto out;
532 }
533
534 kref_init(&data->kref);
4451e088 535 data->dev = hdev;
4492efff
PC
536 list_add_tail(&data->list, &wacom_udev_list);
537 }
538
4451e088 539 wacom_wac->shared = &data->shared;
4492efff 540
aa86b18c 541 if (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)
a97ac104 542 wacom_wac->shared->touch = hdev;
aa86b18c 543 else if (wacom_wac->features.device_type & WACOM_DEVICETYPE_PEN)
a97ac104
BT
544 wacom_wac->shared->pen = hdev;
545
4492efff
PC
546out:
547 mutex_unlock(&wacom_udev_list_lock);
548 return retval;
549}
550
551static void wacom_release_shared_data(struct kref *kref)
552{
4451e088
BT
553 struct wacom_hdev_data *data =
554 container_of(kref, struct wacom_hdev_data, kref);
4492efff
PC
555
556 mutex_lock(&wacom_udev_list_lock);
557 list_del(&data->list);
558 mutex_unlock(&wacom_udev_list_lock);
559
560 kfree(data);
561}
562
a97ac104 563static void wacom_remove_shared_data(struct wacom *wacom)
4492efff 564{
4451e088 565 struct wacom_hdev_data *data;
a97ac104
BT
566 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
567
568 if (wacom_wac->shared) {
569 data = container_of(wacom_wac->shared, struct wacom_hdev_data,
570 shared);
571
572 if (wacom_wac->shared->touch == wacom->hdev)
573 wacom_wac->shared->touch = NULL;
574 else if (wacom_wac->shared->pen == wacom->hdev)
575 wacom_wac->shared->pen = NULL;
4492efff 576
4492efff 577 kref_put(&data->kref, wacom_release_shared_data);
a97ac104 578 wacom_wac->shared = NULL;
4492efff
PC
579 }
580}
581
5d7e7d47
EH
582static int wacom_led_control(struct wacom *wacom)
583{
584 unsigned char *buf;
9b5b95dd 585 int retval;
912ca216
PC
586 unsigned char report_id = WAC_CMD_LED_CONTROL;
587 int buf_size = 9;
5d7e7d47 588
912ca216
PC
589 if (wacom->wacom_wac.pid) { /* wireless connected */
590 report_id = WAC_CMD_WL_LED_CONTROL;
591 buf_size = 13;
592 }
593 buf = kzalloc(buf_size, GFP_KERNEL);
5d7e7d47
EH
594 if (!buf)
595 return -ENOMEM;
596
9b5b95dd 597 if (wacom->wacom_wac.features.type >= INTUOS5S &&
9a35c411 598 wacom->wacom_wac.features.type <= INTUOSPL) {
9b5b95dd
JG
599 /*
600 * Touch Ring and crop mark LED luminance may take on
601 * one of four values:
602 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
603 */
604 int ring_led = wacom->led.select[0] & 0x03;
605 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
606 int crop_lum = 0;
912ca216
PC
607 unsigned char led_bits = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
608
609 buf[0] = report_id;
610 if (wacom->wacom_wac.pid) {
611 wacom_get_report(wacom->hdev, HID_FEATURE_REPORT,
612 buf, buf_size, WAC_CMD_RETRIES);
613 buf[0] = report_id;
614 buf[4] = led_bits;
615 } else
616 buf[1] = led_bits;
9b5b95dd
JG
617 }
618 else {
619 int led = wacom->led.select[0] | 0x4;
620
621 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
622 wacom->wacom_wac.features.type == WACOM_24HD)
623 led |= (wacom->led.select[1] << 4) | 0x40;
624
912ca216 625 buf[0] = report_id;
9b5b95dd
JG
626 buf[1] = led;
627 buf[2] = wacom->led.llv;
628 buf[3] = wacom->led.hlv;
629 buf[4] = wacom->led.img_lum;
630 }
5d7e7d47 631
912ca216 632 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, buf_size,
296b7378 633 WAC_CMD_RETRIES);
5d7e7d47
EH
634 kfree(buf);
635
636 return retval;
637}
638
849e2f06
BT
639static int wacom_led_putimage(struct wacom *wacom, int button_id, u8 xfer_id,
640 const unsigned len, const void *img)
5d7e7d47
EH
641{
642 unsigned char *buf;
643 int i, retval;
849e2f06 644 const unsigned chunk_len = len / 4; /* 4 chunks are needed to be sent */
5d7e7d47 645
849e2f06 646 buf = kzalloc(chunk_len + 3 , GFP_KERNEL);
5d7e7d47
EH
647 if (!buf)
648 return -ENOMEM;
649
650 /* Send 'start' command */
651 buf[0] = WAC_CMD_ICON_START;
652 buf[1] = 1;
296b7378
PF
653 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
654 WAC_CMD_RETRIES);
5d7e7d47
EH
655 if (retval < 0)
656 goto out;
657
849e2f06 658 buf[0] = xfer_id;
5d7e7d47
EH
659 buf[1] = button_id & 0x07;
660 for (i = 0; i < 4; i++) {
661 buf[2] = i;
849e2f06 662 memcpy(buf + 3, img + i * chunk_len, chunk_len);
5d7e7d47 663
27b20a9d 664 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
296b7378 665 buf, chunk_len + 3, WAC_CMD_RETRIES);
5d7e7d47
EH
666 if (retval < 0)
667 break;
668 }
669
670 /* Send 'stop' */
671 buf[0] = WAC_CMD_ICON_START;
672 buf[1] = 0;
296b7378
PF
673 wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
674 WAC_CMD_RETRIES);
5d7e7d47
EH
675
676out:
677 kfree(buf);
678 return retval;
679}
680
09e7d941 681static ssize_t wacom_led_select_store(struct device *dev, int set_id,
5d7e7d47
EH
682 const char *buf, size_t count)
683{
c31a408f 684 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
29b47391 685 struct wacom *wacom = hid_get_drvdata(hdev);
5d7e7d47
EH
686 unsigned int id;
687 int err;
688
689 err = kstrtouint(buf, 10, &id);
690 if (err)
691 return err;
692
693 mutex_lock(&wacom->lock);
694
09e7d941 695 wacom->led.select[set_id] = id & 0x3;
5d7e7d47
EH
696 err = wacom_led_control(wacom);
697
698 mutex_unlock(&wacom->lock);
699
700 return err < 0 ? err : count;
701}
702
09e7d941
PC
703#define DEVICE_LED_SELECT_ATTR(SET_ID) \
704static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
705 struct device_attribute *attr, const char *buf, size_t count) \
706{ \
707 return wacom_led_select_store(dev, SET_ID, buf, count); \
708} \
04c59abd
PC
709static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
710 struct device_attribute *attr, char *buf) \
711{ \
c31a408f 712 struct hid_device *hdev = container_of(dev, struct hid_device, dev);\
29b47391 713 struct wacom *wacom = hid_get_drvdata(hdev); \
37449adc
PC
714 return scnprintf(buf, PAGE_SIZE, "%d\n", \
715 wacom->led.select[SET_ID]); \
04c59abd 716} \
e0984bc3 717static DEVICE_ATTR(status_led##SET_ID##_select, DEV_ATTR_RW_PERM, \
04c59abd 718 wacom_led##SET_ID##_select_show, \
09e7d941
PC
719 wacom_led##SET_ID##_select_store)
720
721DEVICE_LED_SELECT_ATTR(0);
722DEVICE_LED_SELECT_ATTR(1);
5d7e7d47
EH
723
724static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
725 const char *buf, size_t count)
726{
727 unsigned int value;
728 int err;
729
730 err = kstrtouint(buf, 10, &value);
731 if (err)
732 return err;
733
734 mutex_lock(&wacom->lock);
735
736 *dest = value & 0x7f;
737 err = wacom_led_control(wacom);
738
739 mutex_unlock(&wacom->lock);
740
741 return err < 0 ? err : count;
742}
743
744#define DEVICE_LUMINANCE_ATTR(name, field) \
745static ssize_t wacom_##name##_luminance_store(struct device *dev, \
746 struct device_attribute *attr, const char *buf, size_t count) \
747{ \
c31a408f 748 struct hid_device *hdev = container_of(dev, struct hid_device, dev);\
29b47391 749 struct wacom *wacom = hid_get_drvdata(hdev); \
5d7e7d47
EH
750 \
751 return wacom_luminance_store(wacom, &wacom->led.field, \
752 buf, count); \
753} \
37449adc
PC
754static ssize_t wacom_##name##_luminance_show(struct device *dev, \
755 struct device_attribute *attr, char *buf) \
756{ \
757 struct wacom *wacom = dev_get_drvdata(dev); \
758 return scnprintf(buf, PAGE_SIZE, "%d\n", wacom->led.field); \
759} \
e0984bc3 760static DEVICE_ATTR(name##_luminance, DEV_ATTR_RW_PERM, \
37449adc
PC
761 wacom_##name##_luminance_show, \
762 wacom_##name##_luminance_store)
5d7e7d47
EH
763
764DEVICE_LUMINANCE_ATTR(status0, llv);
765DEVICE_LUMINANCE_ATTR(status1, hlv);
766DEVICE_LUMINANCE_ATTR(buttons, img_lum);
767
768static ssize_t wacom_button_image_store(struct device *dev, int button_id,
769 const char *buf, size_t count)
770{
c31a408f 771 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
29b47391 772 struct wacom *wacom = hid_get_drvdata(hdev);
5d7e7d47 773 int err;
849e2f06
BT
774 unsigned len;
775 u8 xfer_id;
776
777 if (hdev->bus == BUS_BLUETOOTH) {
778 len = 256;
779 xfer_id = WAC_CMD_ICON_BT_XFER;
780 } else {
781 len = 1024;
782 xfer_id = WAC_CMD_ICON_XFER;
783 }
5d7e7d47 784
849e2f06 785 if (count != len)
5d7e7d47
EH
786 return -EINVAL;
787
788 mutex_lock(&wacom->lock);
789
849e2f06 790 err = wacom_led_putimage(wacom, button_id, xfer_id, len, buf);
5d7e7d47
EH
791
792 mutex_unlock(&wacom->lock);
793
794 return err < 0 ? err : count;
795}
796
797#define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
798static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
799 struct device_attribute *attr, const char *buf, size_t count) \
800{ \
801 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
802} \
e0984bc3 803static DEVICE_ATTR(button##BUTTON_ID##_rawimg, DEV_ATTR_WO_PERM, \
5d7e7d47
EH
804 NULL, wacom_btnimg##BUTTON_ID##_store)
805
806DEVICE_BTNIMG_ATTR(0);
807DEVICE_BTNIMG_ATTR(1);
808DEVICE_BTNIMG_ATTR(2);
809DEVICE_BTNIMG_ATTR(3);
810DEVICE_BTNIMG_ATTR(4);
811DEVICE_BTNIMG_ATTR(5);
812DEVICE_BTNIMG_ATTR(6);
813DEVICE_BTNIMG_ATTR(7);
814
09e7d941
PC
815static struct attribute *cintiq_led_attrs[] = {
816 &dev_attr_status_led0_select.attr,
817 &dev_attr_status_led1_select.attr,
818 NULL
819};
820
821static struct attribute_group cintiq_led_attr_group = {
822 .name = "wacom_led",
823 .attrs = cintiq_led_attrs,
824};
825
826static struct attribute *intuos4_led_attrs[] = {
5d7e7d47
EH
827 &dev_attr_status0_luminance.attr,
828 &dev_attr_status1_luminance.attr,
09e7d941 829 &dev_attr_status_led0_select.attr,
5d7e7d47
EH
830 &dev_attr_buttons_luminance.attr,
831 &dev_attr_button0_rawimg.attr,
832 &dev_attr_button1_rawimg.attr,
833 &dev_attr_button2_rawimg.attr,
834 &dev_attr_button3_rawimg.attr,
835 &dev_attr_button4_rawimg.attr,
836 &dev_attr_button5_rawimg.attr,
837 &dev_attr_button6_rawimg.attr,
838 &dev_attr_button7_rawimg.attr,
839 NULL
840};
841
09e7d941 842static struct attribute_group intuos4_led_attr_group = {
5d7e7d47 843 .name = "wacom_led",
09e7d941 844 .attrs = intuos4_led_attrs,
5d7e7d47
EH
845};
846
9b5b95dd
JG
847static struct attribute *intuos5_led_attrs[] = {
848 &dev_attr_status0_luminance.attr,
849 &dev_attr_status_led0_select.attr,
850 NULL
851};
852
853static struct attribute_group intuos5_led_attr_group = {
854 .name = "wacom_led",
855 .attrs = intuos5_led_attrs,
856};
857
5d7e7d47
EH
858static int wacom_initialize_leds(struct wacom *wacom)
859{
860 int error;
861
862cf553
JG
862 if (!(wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD))
863 return 0;
864
09e7d941
PC
865 /* Initialize default values */
866 switch (wacom->wacom_wac.features.type) {
a19fc986 867 case INTUOS4S:
09e7d941 868 case INTUOS4:
81af7e61 869 case INTUOS4WL:
09e7d941
PC
870 case INTUOS4L:
871 wacom->led.select[0] = 0;
872 wacom->led.select[1] = 0;
f4fa9a6d 873 wacom->led.llv = 10;
5d7e7d47
EH
874 wacom->led.hlv = 20;
875 wacom->led.img_lum = 10;
c31a408f 876 error = sysfs_create_group(&wacom->hdev->dev.kobj,
09e7d941
PC
877 &intuos4_led_attr_group);
878 break;
879
246835fc 880 case WACOM_24HD:
09e7d941
PC
881 case WACOM_21UX2:
882 wacom->led.select[0] = 0;
883 wacom->led.select[1] = 0;
884 wacom->led.llv = 0;
885 wacom->led.hlv = 0;
886 wacom->led.img_lum = 0;
5d7e7d47 887
c31a408f 888 error = sysfs_create_group(&wacom->hdev->dev.kobj,
09e7d941
PC
889 &cintiq_led_attr_group);
890 break;
891
9b5b95dd
JG
892 case INTUOS5S:
893 case INTUOS5:
894 case INTUOS5L:
9a35c411
PC
895 case INTUOSPS:
896 case INTUOSPM:
897 case INTUOSPL:
862cf553
JG
898 wacom->led.select[0] = 0;
899 wacom->led.select[1] = 0;
900 wacom->led.llv = 32;
901 wacom->led.hlv = 0;
902 wacom->led.img_lum = 0;
903
904 error = sysfs_create_group(&wacom->hdev->dev.kobj,
905 &intuos5_led_attr_group);
9b5b95dd
JG
906 break;
907
09e7d941
PC
908 default:
909 return 0;
5d7e7d47
EH
910 }
911
09e7d941 912 if (error) {
c31a408f 913 hid_err(wacom->hdev,
09e7d941
PC
914 "cannot create sysfs group err: %d\n", error);
915 return error;
916 }
917 wacom_led_control(wacom);
c757cbaf 918 wacom->led_initialized = true;
09e7d941 919
5d7e7d47
EH
920 return 0;
921}
922
923static void wacom_destroy_leds(struct wacom *wacom)
924{
c757cbaf
BT
925 if (!wacom->led_initialized)
926 return;
927
862cf553
JG
928 if (!(wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD))
929 return;
930
c757cbaf
BT
931 wacom->led_initialized = false;
932
09e7d941 933 switch (wacom->wacom_wac.features.type) {
a19fc986 934 case INTUOS4S:
09e7d941 935 case INTUOS4:
81af7e61 936 case INTUOS4WL:
09e7d941 937 case INTUOS4L:
c31a408f 938 sysfs_remove_group(&wacom->hdev->dev.kobj,
09e7d941
PC
939 &intuos4_led_attr_group);
940 break;
941
246835fc 942 case WACOM_24HD:
09e7d941 943 case WACOM_21UX2:
c31a408f 944 sysfs_remove_group(&wacom->hdev->dev.kobj,
09e7d941
PC
945 &cintiq_led_attr_group);
946 break;
9b5b95dd
JG
947
948 case INTUOS5S:
949 case INTUOS5:
950 case INTUOS5L:
9a35c411
PC
951 case INTUOSPS:
952 case INTUOSPM:
953 case INTUOSPL:
862cf553
JG
954 sysfs_remove_group(&wacom->hdev->dev.kobj,
955 &intuos5_led_attr_group);
9b5b95dd 956 break;
5d7e7d47
EH
957 }
958}
959
a1d552cc 960static enum power_supply_property wacom_battery_props[] = {
71fa641e 961 POWER_SUPPLY_PROP_PRESENT,
ac8d1010 962 POWER_SUPPLY_PROP_STATUS,
6e2a6e80 963 POWER_SUPPLY_PROP_SCOPE,
a1d552cc
CB
964 POWER_SUPPLY_PROP_CAPACITY
965};
966
7dbd229e
BT
967static enum power_supply_property wacom_ac_props[] = {
968 POWER_SUPPLY_PROP_PRESENT,
969 POWER_SUPPLY_PROP_ONLINE,
970 POWER_SUPPLY_PROP_SCOPE,
971};
972
a1d552cc
CB
973static int wacom_battery_get_property(struct power_supply *psy,
974 enum power_supply_property psp,
975 union power_supply_propval *val)
976{
297d716f 977 struct wacom *wacom = power_supply_get_drvdata(psy);
a1d552cc
CB
978 int ret = 0;
979
980 switch (psp) {
71fa641e
JG
981 case POWER_SUPPLY_PROP_PRESENT:
982 val->intval = wacom->wacom_wac.bat_connected;
983 break;
6e2a6e80
BN
984 case POWER_SUPPLY_PROP_SCOPE:
985 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
986 break;
a1d552cc
CB
987 case POWER_SUPPLY_PROP_CAPACITY:
988 val->intval =
ac8d1010
BT
989 wacom->wacom_wac.battery_capacity;
990 break;
991 case POWER_SUPPLY_PROP_STATUS:
992 if (wacom->wacom_wac.bat_charging)
993 val->intval = POWER_SUPPLY_STATUS_CHARGING;
994 else if (wacom->wacom_wac.battery_capacity == 100 &&
995 wacom->wacom_wac.ps_connected)
996 val->intval = POWER_SUPPLY_STATUS_FULL;
b0882cb7
JG
997 else if (wacom->wacom_wac.ps_connected)
998 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
ac8d1010
BT
999 else
1000 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
a1d552cc
CB
1001 break;
1002 default:
1003 ret = -EINVAL;
1004 break;
1005 }
1006
1007 return ret;
1008}
1009
7dbd229e
BT
1010static int wacom_ac_get_property(struct power_supply *psy,
1011 enum power_supply_property psp,
1012 union power_supply_propval *val)
1013{
297d716f 1014 struct wacom *wacom = power_supply_get_drvdata(psy);
7dbd229e
BT
1015 int ret = 0;
1016
1017 switch (psp) {
1018 case POWER_SUPPLY_PROP_PRESENT:
1019 /* fall through */
1020 case POWER_SUPPLY_PROP_ONLINE:
1021 val->intval = wacom->wacom_wac.ps_connected;
1022 break;
1023 case POWER_SUPPLY_PROP_SCOPE:
1024 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1025 break;
1026 default:
1027 ret = -EINVAL;
1028 break;
1029 }
1030 return ret;
1031}
1032
a1d552cc
CB
1033static int wacom_initialize_battery(struct wacom *wacom)
1034{
d70420b9 1035 static atomic_t battery_no = ATOMIC_INIT(0);
297d716f 1036 struct power_supply_config psy_cfg = { .drv_data = wacom, };
d70420b9 1037 unsigned long n;
a1d552cc 1038
ac8d1010 1039 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) {
297d716f
KK
1040 struct power_supply_desc *bat_desc = &wacom->battery_desc;
1041 struct power_supply_desc *ac_desc = &wacom->ac_desc;
d70420b9 1042 n = atomic_inc_return(&battery_no) - 1;
7dbd229e 1043
297d716f
KK
1044 bat_desc->properties = wacom_battery_props;
1045 bat_desc->num_properties = ARRAY_SIZE(wacom_battery_props);
1046 bat_desc->get_property = wacom_battery_get_property;
d70420b9 1047 sprintf(wacom->wacom_wac.bat_name, "wacom_battery_%ld", n);
297d716f
KK
1048 bat_desc->name = wacom->wacom_wac.bat_name;
1049 bat_desc->type = POWER_SUPPLY_TYPE_BATTERY;
1050 bat_desc->use_for_apm = 0;
a1d552cc 1051
297d716f
KK
1052 ac_desc->properties = wacom_ac_props;
1053 ac_desc->num_properties = ARRAY_SIZE(wacom_ac_props);
1054 ac_desc->get_property = wacom_ac_get_property;
7dbd229e 1055 sprintf(wacom->wacom_wac.ac_name, "wacom_ac_%ld", n);
297d716f
KK
1056 ac_desc->name = wacom->wacom_wac.ac_name;
1057 ac_desc->type = POWER_SUPPLY_TYPE_MAINS;
1058 ac_desc->use_for_apm = 0;
1059
1060 wacom->battery = power_supply_register(&wacom->hdev->dev,
1061 &wacom->battery_desc, &psy_cfg);
1062 if (IS_ERR(wacom->battery))
1063 return PTR_ERR(wacom->battery);
1064
1065 power_supply_powers(wacom->battery, &wacom->hdev->dev);
1066
1067 wacom->ac = power_supply_register(&wacom->hdev->dev,
1068 &wacom->ac_desc,
1069 &psy_cfg);
1070 if (IS_ERR(wacom->ac)) {
1071 power_supply_unregister(wacom->battery);
1072 return PTR_ERR(wacom->ac);
7dbd229e
BT
1073 }
1074
297d716f 1075 power_supply_powers(wacom->ac, &wacom->hdev->dev);
a1d552cc
CB
1076 }
1077
7dbd229e 1078 return 0;
a1d552cc
CB
1079}
1080
1081static void wacom_destroy_battery(struct wacom *wacom)
1082{
8de29a35 1083 if (wacom->battery) {
297d716f
KK
1084 power_supply_unregister(wacom->battery);
1085 wacom->battery = NULL;
1086 power_supply_unregister(wacom->ac);
1087 wacom->ac = NULL;
b7af2bb8 1088 }
a1d552cc
CB
1089}
1090
f81a1295
BT
1091static ssize_t wacom_show_speed(struct device *dev,
1092 struct device_attribute
1093 *attr, char *buf)
1094{
1095 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1096 struct wacom *wacom = hid_get_drvdata(hdev);
1097
1098 return snprintf(buf, PAGE_SIZE, "%i\n", wacom->wacom_wac.bt_high_speed);
1099}
1100
1101static ssize_t wacom_store_speed(struct device *dev,
1102 struct device_attribute *attr,
1103 const char *buf, size_t count)
1104{
1105 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1106 struct wacom *wacom = hid_get_drvdata(hdev);
1107 u8 new_speed;
1108
1109 if (kstrtou8(buf, 0, &new_speed))
1110 return -EINVAL;
1111
1112 if (new_speed != 0 && new_speed != 1)
1113 return -EINVAL;
1114
1115 wacom_bt_query_tablet_data(hdev, new_speed, &wacom->wacom_wac.features);
1116
1117 return count;
1118}
1119
e0984bc3 1120static DEVICE_ATTR(speed, DEV_ATTR_RW_PERM,
f81a1295
BT
1121 wacom_show_speed, wacom_store_speed);
1122
d2d13f18 1123static struct input_dev *wacom_allocate_input(struct wacom *wacom)
3aac0ef1
CB
1124{
1125 struct input_dev *input_dev;
b6c79f2c 1126 struct hid_device *hdev = wacom->hdev;
3aac0ef1 1127 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
3aac0ef1
CB
1128
1129 input_dev = input_allocate_device();
d2d13f18
BT
1130 if (!input_dev)
1131 return NULL;
3aac0ef1
CB
1132
1133 input_dev->name = wacom_wac->name;
b6c79f2c
BT
1134 input_dev->phys = hdev->phys;
1135 input_dev->dev.parent = &hdev->dev;
3aac0ef1
CB
1136 input_dev->open = wacom_open;
1137 input_dev->close = wacom_close;
b6c79f2c
BT
1138 input_dev->uniq = hdev->uniq;
1139 input_dev->id.bustype = hdev->bus;
1140 input_dev->id.vendor = hdev->vendor;
12969e3b 1141 input_dev->id.product = wacom_wac->pid ? wacom_wac->pid : hdev->product;
b6c79f2c 1142 input_dev->id.version = hdev->version;
3aac0ef1
CB
1143 input_set_drvdata(input_dev, wacom);
1144
d2d13f18
BT
1145 return input_dev;
1146}
1147
2546dacd 1148static void wacom_free_inputs(struct wacom *wacom)
008f4d9e 1149{
2546dacd
BT
1150 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1151
1152 if (wacom_wac->input)
1153 input_free_device(wacom_wac->input);
1154 if (wacom_wac->pad_input)
1155 input_free_device(wacom_wac->pad_input);
1156 wacom_wac->input = NULL;
1157 wacom_wac->pad_input = NULL;
008f4d9e
BT
1158}
1159
2546dacd 1160static int wacom_allocate_inputs(struct wacom *wacom)
d2d13f18
BT
1161{
1162 struct input_dev *input_dev, *pad_input_dev;
1163 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
d2d13f18
BT
1164
1165 input_dev = wacom_allocate_input(wacom);
1166 pad_input_dev = wacom_allocate_input(wacom);
1167 if (!input_dev || !pad_input_dev) {
2546dacd
BT
1168 wacom_free_inputs(wacom);
1169 return -ENOMEM;
d2d13f18
BT
1170 }
1171
3aac0ef1 1172 wacom_wac->input = input_dev;
d2d13f18
BT
1173 wacom_wac->pad_input = pad_input_dev;
1174 wacom_wac->pad_input->name = wacom_wac->pad_name;
1175
2546dacd
BT
1176 return 0;
1177}
1178
1179static void wacom_clean_inputs(struct wacom *wacom)
1180{
1181 if (wacom->wacom_wac.input) {
1182 if (wacom->wacom_wac.input_registered)
1183 input_unregister_device(wacom->wacom_wac.input);
1184 else
1185 input_free_device(wacom->wacom_wac.input);
1186 }
1187 if (wacom->wacom_wac.pad_input) {
954df6ad 1188 if (wacom->wacom_wac.pad_registered)
2546dacd
BT
1189 input_unregister_device(wacom->wacom_wac.pad_input);
1190 else
1191 input_free_device(wacom->wacom_wac.pad_input);
1192 }
1193 wacom->wacom_wac.input = NULL;
1194 wacom->wacom_wac.pad_input = NULL;
1195 wacom_destroy_leds(wacom);
1196}
1197
1198static int wacom_register_inputs(struct wacom *wacom)
1199{
1200 struct input_dev *input_dev, *pad_input_dev;
1201 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
2636a3f2
JG
1202 struct wacom_features *features = &wacom_wac->features;
1203 int error = 0;
2546dacd
BT
1204
1205 input_dev = wacom_wac->input;
1206 pad_input_dev = wacom_wac->pad_input;
1207
1208 if (!input_dev || !pad_input_dev)
1209 return -EINVAL;
1210
2636a3f2
JG
1211 if (features->device_type & WACOM_DEVICETYPE_PEN)
1212 error = wacom_setup_pen_input_capabilities(input_dev, wacom_wac);
1213 if (!error && features->device_type & WACOM_DEVICETYPE_TOUCH)
1214 error = wacom_setup_touch_input_capabilities(input_dev, wacom_wac);
30ebc1ae
PC
1215 if (!error) {
1216 error = input_register_device(input_dev);
1217 if (error)
1218 return error;
954df6ad 1219 wacom_wac->input_registered = true;
30ebc1ae 1220 }
1963518b 1221
d2d13f18
BT
1222 error = wacom_setup_pad_input_capabilities(pad_input_dev, wacom_wac);
1223 if (error) {
1224 /* no pad in use on this interface */
1225 input_free_device(pad_input_dev);
1226 wacom_wac->pad_input = NULL;
1227 pad_input_dev = NULL;
1228 } else {
1229 error = input_register_device(pad_input_dev);
1230 if (error)
7fefeec5 1231 goto fail_register_pad_input;
954df6ad 1232 wacom_wac->pad_registered = true;
912ca216
PC
1233
1234 error = wacom_initialize_leds(wacom);
1235 if (error)
7fefeec5 1236 goto fail_leds;
d2d13f18
BT
1237 }
1238
1963518b 1239 return 0;
3aac0ef1 1240
7fefeec5 1241fail_leds:
912ca216
PC
1242 input_unregister_device(pad_input_dev);
1243 pad_input_dev = NULL;
954df6ad 1244 wacom_wac->pad_registered = false;
7fefeec5 1245fail_register_pad_input:
d2d13f18 1246 input_unregister_device(input_dev);
1963518b 1247 wacom_wac->input = NULL;
954df6ad 1248 wacom_wac->input_registered = false;
3aac0ef1
CB
1249 return error;
1250}
1251
16bf288c
CB
1252static void wacom_wireless_work(struct work_struct *work)
1253{
1254 struct wacom *wacom = container_of(work, struct wacom, work);
1255 struct usb_device *usbdev = wacom->usbdev;
1256 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
29b47391 1257 struct hid_device *hdev1, *hdev2;
b7af2bb8
CB
1258 struct wacom *wacom1, *wacom2;
1259 struct wacom_wac *wacom_wac1, *wacom_wac2;
1260 int error;
16bf288c
CB
1261
1262 /*
1263 * Regardless if this is a disconnect or a new tablet,
b7af2bb8 1264 * remove any existing input and battery devices.
16bf288c
CB
1265 */
1266
b7af2bb8
CB
1267 wacom_destroy_battery(wacom);
1268
16bf288c 1269 /* Stylus interface */
29b47391
BT
1270 hdev1 = usb_get_intfdata(usbdev->config->interface[1]);
1271 wacom1 = hid_get_drvdata(hdev1);
b7af2bb8 1272 wacom_wac1 = &(wacom1->wacom_wac);
2546dacd 1273 wacom_clean_inputs(wacom1);
16bf288c
CB
1274
1275 /* Touch interface */
29b47391
BT
1276 hdev2 = usb_get_intfdata(usbdev->config->interface[2]);
1277 wacom2 = hid_get_drvdata(hdev2);
b7af2bb8 1278 wacom_wac2 = &(wacom2->wacom_wac);
2546dacd 1279 wacom_clean_inputs(wacom2);
16bf288c
CB
1280
1281 if (wacom_wac->pid == 0) {
e2114ce1 1282 hid_info(wacom->hdev, "wireless tablet disconnected\n");
ac8d1010 1283 wacom_wac1->shared->type = 0;
16bf288c 1284 } else {
29b47391 1285 const struct hid_device_id *id = wacom_ids;
16bf288c 1286
e2114ce1 1287 hid_info(wacom->hdev, "wireless tablet connected with PID %x\n",
eb71d1bb 1288 wacom_wac->pid);
16bf288c 1289
29b47391
BT
1290 while (id->bus) {
1291 if (id->vendor == USB_VENDOR_ID_WACOM &&
1292 id->product == wacom_wac->pid)
16bf288c
CB
1293 break;
1294 id++;
1295 }
1296
29b47391 1297 if (!id->bus) {
e2114ce1 1298 hid_info(wacom->hdev, "ignoring unknown PID.\n");
16bf288c
CB
1299 return;
1300 }
1301
1302 /* Stylus interface */
b7af2bb8 1303 wacom_wac1->features =
29b47391 1304 *((struct wacom_features *)id->driver_data);
aa86b18c 1305 wacom_wac1->features.device_type |= WACOM_DEVICETYPE_PEN;
862cf553
JG
1306 if (wacom_wac1->features.type != INTUOSHT &&
1307 wacom_wac1->features.type != BAMBOO_PT)
1308 wacom_wac1->features.device_type |= WACOM_DEVICETYPE_PAD;
57bcfce3
PC
1309 snprintf(wacom_wac1->name, WACOM_NAME_MAX, "%s (WL) Pen",
1310 wacom_wac1->features.name);
008f4d9e
BT
1311 snprintf(wacom_wac1->pad_name, WACOM_NAME_MAX, "%s (WL) Pad",
1312 wacom_wac1->features.name);
961794a0
PC
1313 wacom_wac1->shared->touch_max = wacom_wac1->features.touch_max;
1314 wacom_wac1->shared->type = wacom_wac1->features.type;
912ca216 1315 wacom_wac1->pid = wacom_wac->pid;
2546dacd
BT
1316 error = wacom_allocate_inputs(wacom1) ||
1317 wacom_register_inputs(wacom1);
b7af2bb8 1318 if (error)
57bcfce3 1319 goto fail;
16bf288c
CB
1320
1321 /* Touch interface */
b5fd2a3e
PC
1322 if (wacom_wac1->features.touch_max ||
1323 wacom_wac1->features.type == INTUOSHT) {
57bcfce3 1324 wacom_wac2->features =
29b47391 1325 *((struct wacom_features *)id->driver_data);
57bcfce3 1326 wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
57bcfce3 1327 wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
862cf553
JG
1328 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1329 "%s (WL) Finger",wacom_wac2->features.name);
008f4d9e 1330 snprintf(wacom_wac2->pad_name, WACOM_NAME_MAX,
862cf553
JG
1331 "%s (WL) Pad",wacom_wac2->features.name);
1332 if (wacom_wac1->features.touch_max)
1333 wacom_wac2->features.device_type |= WACOM_DEVICETYPE_TOUCH;
1334 if (wacom_wac1->features.type == INTUOSHT ||
1335 wacom_wac1->features.type == BAMBOO_PT)
1336 wacom_wac2->features.device_type |= WACOM_DEVICETYPE_PAD;
912ca216 1337 wacom_wac2->pid = wacom_wac->pid;
2546dacd
BT
1338 error = wacom_allocate_inputs(wacom2) ||
1339 wacom_register_inputs(wacom2);
57bcfce3
PC
1340 if (error)
1341 goto fail;
961794a0
PC
1342
1343 if (wacom_wac1->features.type == INTUOSHT &&
1344 wacom_wac1->features.touch_max)
1345 wacom_wac->shared->touch_input = wacom_wac2->input;
57bcfce3 1346 }
b7af2bb8
CB
1347
1348 error = wacom_initialize_battery(wacom);
1349 if (error)
57bcfce3 1350 goto fail;
16bf288c 1351 }
b7af2bb8
CB
1352
1353 return;
1354
57bcfce3 1355fail:
2546dacd
BT
1356 wacom_clean_inputs(wacom1);
1357 wacom_clean_inputs(wacom2);
b7af2bb8 1358 return;
16bf288c
CB
1359}
1360
fce9957d
JG
1361void wacom_battery_work(struct work_struct *work)
1362{
1363 struct wacom *wacom = container_of(work, struct wacom, work);
1364
1365 if ((wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
8de29a35 1366 !wacom->battery) {
fce9957d
JG
1367 wacom_initialize_battery(wacom);
1368 }
1369 else if (!(wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
8de29a35 1370 wacom->battery) {
fce9957d
JG
1371 wacom_destroy_battery(wacom);
1372 }
1373}
1374
401d7d10
PC
1375/*
1376 * Not all devices report physical dimensions from HID.
1377 * Compute the default from hardcoded logical dimension
1378 * and resolution before driver overwrites them.
1379 */
1380static void wacom_set_default_phy(struct wacom_features *features)
1381{
1382 if (features->x_resolution) {
1383 features->x_phy = (features->x_max * 100) /
1384 features->x_resolution;
1385 features->y_phy = (features->y_max * 100) /
1386 features->y_resolution;
1387 }
1388}
1389
1390static void wacom_calculate_res(struct wacom_features *features)
1391{
3d64f54d
PC
1392 /* set unit to "100th of a mm" for devices not reported by HID */
1393 if (!features->unit) {
1394 features->unit = 0x11;
1395 features->unitExpo = -3;
1396 }
1397
401d7d10
PC
1398 features->x_resolution = wacom_calc_hid_res(features->x_max,
1399 features->x_phy,
1400 features->unit,
1401 features->unitExpo);
1402 features->y_resolution = wacom_calc_hid_res(features->y_max,
1403 features->y_phy,
1404 features->unit,
1405 features->unitExpo);
1406}
1407
01c846f9
BT
1408static size_t wacom_compute_pktlen(struct hid_device *hdev)
1409{
1410 struct hid_report_enum *report_enum;
1411 struct hid_report *report;
1412 size_t size = 0;
1413
1414 report_enum = hdev->report_enum + HID_INPUT_REPORT;
1415
1416 list_for_each_entry(report, &report_enum->report_list, list) {
dabb05c6 1417 size_t report_size = hid_report_len(report);
01c846f9
BT
1418 if (report_size > size)
1419 size = report_size;
1420 }
1421
1422 return size;
1423}
1424
c24eab4e
PC
1425static void wacom_update_name(struct wacom *wacom)
1426{
1427 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1428 struct wacom_features *features = &wacom_wac->features;
44b5250b 1429 char name[WACOM_NAME_MAX];
c24eab4e
PC
1430
1431 /* Generic devices name unspecified */
1432 if ((features->type == HID_GENERIC) && !strcmp("Wacom HID", features->name)) {
1433 if (strstr(wacom->hdev->name, "Wacom") ||
1434 strstr(wacom->hdev->name, "wacom") ||
1435 strstr(wacom->hdev->name, "WACOM")) {
1436 /* name is in HID descriptor, use it */
44b5250b 1437 strlcpy(name, wacom->hdev->name, sizeof(name));
c24eab4e
PC
1438
1439 /* strip out excess whitespaces */
1440 while (1) {
44b5250b 1441 char *gap = strstr(name, " ");
c24eab4e
PC
1442 if (gap == NULL)
1443 break;
1444 /* shift everything including the terminator */
1445 memmove(gap, gap+1, strlen(gap));
1446 }
1447 /* get rid of trailing whitespace */
44b5250b
JG
1448 if (name[strlen(name)-1] == ' ')
1449 name[strlen(name)-1] = '\0';
c24eab4e
PC
1450 } else {
1451 /* no meaningful name retrieved. use product ID */
44b5250b 1452 snprintf(name, sizeof(name),
c24eab4e
PC
1453 "%s %X", features->name, wacom->hdev->product);
1454 }
1455 } else {
44b5250b 1456 strlcpy(name, features->name, sizeof(name));
c24eab4e
PC
1457 }
1458
1459 /* Append the device type to the name */
1460 snprintf(wacom_wac->pad_name, sizeof(wacom_wac->pad_name),
44b5250b 1461 "%s Pad", name);
c24eab4e 1462
aa86b18c 1463 if (features->device_type & WACOM_DEVICETYPE_PEN) {
44b5250b
JG
1464 snprintf(wacom_wac->name, sizeof(wacom_wac->name),
1465 "%s Pen", name);
8d80f790 1466 }
aa86b18c 1467 else if (features->device_type & WACOM_DEVICETYPE_TOUCH) {
862cf553
JG
1468 snprintf(wacom_wac->name, sizeof(wacom_wac->name),
1469 "%s Finger", name);
1470 }
1471 else if (features->device_type & WACOM_DEVICETYPE_PAD) {
1472 snprintf(wacom_wac->name, sizeof(wacom_wac->name),
1473 "%s Pad", name);
8d80f790 1474 }
c24eab4e
PC
1475}
1476
29b47391
BT
1477static int wacom_probe(struct hid_device *hdev,
1478 const struct hid_device_id *id)
3bea733a 1479{
29b47391 1480 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
3bea733a 1481 struct usb_device *dev = interface_to_usbdev(intf);
3bea733a
PC
1482 struct wacom *wacom;
1483 struct wacom_wac *wacom_wac;
e33da8a5 1484 struct wacom_features *features;
e33da8a5 1485 int error;
7704ac93 1486 unsigned int connect_mask = HID_CONNECT_HIDRAW;
3bea733a 1487
29b47391 1488 if (!id->driver_data)
b036f6fb
BB
1489 return -EINVAL;
1490
8ffffd52
BT
1491 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
1492
5fcad167
BT
1493 /* hid-core sets this quirk for the boot interface */
1494 hdev->quirks &= ~HID_QUIRK_NOGET;
1495
3bea733a 1496 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
f1823940
DC
1497 if (!wacom)
1498 return -ENOMEM;
e33da8a5 1499
29b47391
BT
1500 hid_set_drvdata(hdev, wacom);
1501 wacom->hdev = hdev;
1502
ba9a3541
BT
1503 /* ask for the report descriptor to be loaded by HID */
1504 error = hid_parse(hdev);
1505 if (error) {
1506 hid_err(hdev, "parse failed\n");
7fefeec5 1507 goto fail_parse;
ba9a3541
BT
1508 }
1509
51269fe8 1510 wacom_wac = &wacom->wacom_wac;
29b47391 1511 wacom_wac->features = *((struct wacom_features *)id->driver_data);
e33da8a5 1512 features = &wacom_wac->features;
01c846f9 1513 features->pktlen = wacom_compute_pktlen(hdev);
e33da8a5
JC
1514 if (features->pktlen > WACOM_PKGLEN_MAX) {
1515 error = -EINVAL;
7fefeec5 1516 goto fail_pktlen;
e33da8a5 1517 }
3bea733a 1518
29b47391
BT
1519 if (features->check_for_hid_type && features->hid_type != hdev->type) {
1520 error = -ENODEV;
7fefeec5 1521 goto fail_type;
e33da8a5 1522 }
3bea733a 1523
3bea733a 1524 wacom->usbdev = dev;
e7224094
ON
1525 wacom->intf = intf;
1526 mutex_init(&wacom->lock);
16bf288c 1527 INIT_WORK(&wacom->work, wacom_wireless_work);
3bea733a 1528
494078b0
BT
1529 if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1530 error = wacom_allocate_inputs(wacom);
1531 if (error)
1532 goto fail_allocate_inputs;
1533 }
1534
8c97a765
BT
1535 /*
1536 * Bamboo Pad has a generic hid handling for the Pen, and we switch it
1537 * into debug mode for the touch part.
1538 * We ignore the other interfaces.
1539 */
1540 if (features->type == BAMBOO_PAD) {
1541 if (features->pktlen == WACOM_PKGLEN_PENABLED) {
1542 features->type = HID_GENERIC;
1543 } else if ((features->pktlen != WACOM_PKGLEN_BPAD_TOUCH) &&
1544 (features->pktlen != WACOM_PKGLEN_BPAD_TOUCH_USB)) {
1545 error = -ENODEV;
1546 goto fail_shared_data;
1547 }
1548 }
1549
401d7d10
PC
1550 /* set the default size in case we do not get them from hid */
1551 wacom_set_default_phy(features);
1552
f393ee2b 1553 /* Retrieve the physical and logical size for touch devices */
c669fb2b 1554 wacom_retrieve_hid_descriptor(hdev, features);
42f4f272 1555 wacom_setup_device_quirks(wacom);
042628ab 1556
aa86b18c
JG
1557 if (features->device_type == WACOM_DEVICETYPE_NONE &&
1558 features->type != WIRELESS) {
8e116d31
JG
1559 error = features->type == HID_GENERIC ? -ENODEV : 0;
1560
042628ab 1561 dev_warn(&hdev->dev, "Unknown device_type for '%s'. %s.",
8e116d31
JG
1562 hdev->name,
1563 error ? "Ignoring" : "Assuming pen");
1564
1565 if (error)
1566 goto fail_shared_data;
042628ab 1567
aa86b18c 1568 features->device_type |= WACOM_DEVICETYPE_PEN;
042628ab
JG
1569 }
1570
401d7d10
PC
1571 wacom_calculate_res(features);
1572
c24eab4e 1573 wacom_update_name(wacom);
4492efff 1574
f3586d2f
PC
1575 error = wacom_add_shared_data(hdev);
1576 if (error)
1577 goto fail_shared_data;
49b764ae 1578
f81a1295
BT
1579 if (!(features->quirks & WACOM_QUIRK_MONITOR) &&
1580 (features->quirks & WACOM_QUIRK_BATTERY)) {
1581 error = wacom_initialize_battery(wacom);
1582 if (error)
7fefeec5 1583 goto fail_battery;
f81a1295
BT
1584 }
1585
d3825d51 1586 if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
494078b0 1587 error = wacom_register_inputs(wacom);
d3825d51 1588 if (error)
7fefeec5 1589 goto fail_register_inputs;
f81a1295
BT
1590 }
1591
1592 if (hdev->bus == BUS_BLUETOOTH) {
1593 error = device_create_file(&hdev->dev, &dev_attr_speed);
1594 if (error)
1595 hid_warn(hdev,
1596 "can't create sysfs speed attribute err: %d\n",
1597 error);
d3825d51 1598 }
5d7e7d47 1599
7704ac93
BT
1600 if (features->type == HID_GENERIC)
1601 connect_mask |= HID_CONNECT_DRIVER;
1602
29b47391 1603 /* Regular HID work starts now */
7704ac93 1604 error = hid_hw_start(hdev, connect_mask);
29b47391
BT
1605 if (error) {
1606 hid_err(hdev, "hw start failed\n");
7fefeec5 1607 goto fail_hw_start;
d3825d51 1608 }
961794a0 1609
5ae6e89f
BT
1610 /* Note that if query fails it is not a hard failure */
1611 wacom_query_tablet_data(hdev, features);
1612
29b47391
BT
1613 if (features->quirks & WACOM_QUIRK_MONITOR)
1614 error = hid_hw_open(hdev);
1615
862cf553
JG
1616 if (wacom_wac->features.type == INTUOSHT &&
1617 wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH) {
961794a0
PC
1618 wacom_wac->shared->touch_input = wacom_wac->input;
1619 }
1620
3bea733a
PC
1621 return 0;
1622
7fefeec5 1623fail_hw_start:
7fefeec5 1624 if (hdev->bus == BUS_BLUETOOTH)
f81a1295 1625 device_remove_file(&hdev->dev, &dev_attr_speed);
7fefeec5 1626fail_register_inputs:
2546dacd 1627 wacom_clean_inputs(wacom);
7fefeec5
BT
1628 wacom_destroy_battery(wacom);
1629fail_battery:
a97ac104 1630 wacom_remove_shared_data(wacom);
7fefeec5 1631fail_shared_data:
494078b0
BT
1632 wacom_clean_inputs(wacom);
1633fail_allocate_inputs:
7fefeec5
BT
1634fail_type:
1635fail_pktlen:
1636fail_parse:
1637 kfree(wacom);
29b47391 1638 hid_set_drvdata(hdev, NULL);
5014186d 1639 return error;
3bea733a
PC
1640}
1641
29b47391 1642static void wacom_remove(struct hid_device *hdev)
3bea733a 1643{
29b47391 1644 struct wacom *wacom = hid_get_drvdata(hdev);
3bea733a 1645
29b47391 1646 hid_hw_stop(hdev);
e7224094 1647
16bf288c 1648 cancel_work_sync(&wacom->work);
2546dacd 1649 wacom_clean_inputs(wacom);
f81a1295
BT
1650 if (hdev->bus == BUS_BLUETOOTH)
1651 device_remove_file(&hdev->dev, &dev_attr_speed);
a1d552cc 1652 wacom_destroy_battery(wacom);
a97ac104 1653 wacom_remove_shared_data(wacom);
e7224094 1654
29b47391
BT
1655 hid_set_drvdata(hdev, NULL);
1656 kfree(wacom);
e7224094
ON
1657}
1658
41a74581 1659#ifdef CONFIG_PM
29b47391 1660static int wacom_resume(struct hid_device *hdev)
e7224094 1661{
29b47391 1662 struct wacom *wacom = hid_get_drvdata(hdev);
51269fe8 1663 struct wacom_features *features = &wacom->wacom_wac.features;
e7224094
ON
1664
1665 mutex_lock(&wacom->lock);
38101475
PC
1666
1667 /* switch to wacom mode first */
27b20a9d 1668 wacom_query_tablet_data(hdev, features);
5d7e7d47 1669 wacom_led_control(wacom);
38101475 1670
e7224094
ON
1671 mutex_unlock(&wacom->lock);
1672
29b47391 1673 return 0;
e7224094
ON
1674}
1675
29b47391 1676static int wacom_reset_resume(struct hid_device *hdev)
e7224094 1677{
29b47391 1678 return wacom_resume(hdev);
3bea733a 1679}
41a74581 1680#endif /* CONFIG_PM */
3bea733a 1681
29b47391 1682static struct hid_driver wacom_driver = {
3bea733a 1683 .name = "wacom",
b036f6fb 1684 .id_table = wacom_ids,
3bea733a 1685 .probe = wacom_probe,
29b47391 1686 .remove = wacom_remove,
7704ac93
BT
1687 .event = wacom_wac_event,
1688 .report = wacom_wac_report,
29b47391 1689#ifdef CONFIG_PM
e7224094
ON
1690 .resume = wacom_resume,
1691 .reset_resume = wacom_reset_resume,
29b47391
BT
1692#endif
1693 .raw_event = wacom_raw_event,
3bea733a 1694};
29b47391 1695module_hid_driver(wacom_driver);
f2e0a7d4
BT
1696
1697MODULE_VERSION(DRIVER_VERSION);
1698MODULE_AUTHOR(DRIVER_AUTHOR);
1699MODULE_DESCRIPTION(DRIVER_DESC);
1700MODULE_LICENSE(DRIVER_LICENSE);