Merge tag 'clone3-v5.3' of git://git.kernel.org/pub/scm/linux/kernel/git/brauner...
[linux-2.6-microblaze.git] / drivers / hid / hid-asus.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  HID driver for Asus notebook built-in keyboard.
4  *  Fixes small logical maximum to match usage maximum.
5  *
6  *  Currently supported devices are:
7  *    EeeBook X205TA
8  *    VivoBook E200HA
9  *
10  *  Copyright (c) 2016 Yusuke Fujimaki <usk.fujimaki@gmail.com>
11  *
12  *  This module based on hid-ortek by
13  *  Copyright (c) 2010 Johnathon Harris <jmharris@gmail.com>
14  *  Copyright (c) 2011 Jiri Kosina
15  *
16  *  This module has been updated to add support for Asus i2c touchpad.
17  *
18  *  Copyright (c) 2016 Brendan McGrath <redmcg@redmandi.dyndns.org>
19  *  Copyright (c) 2016 Victor Vlasenko <victor.vlasenko@sysgears.com>
20  *  Copyright (c) 2016 Frederik Wenigwieser <frederik.wenigwieser@gmail.com>
21  */
22
23 /*
24  */
25
26 #include <linux/dmi.h>
27 #include <linux/hid.h>
28 #include <linux/module.h>
29 #include <linux/platform_data/x86/asus-wmi.h>
30 #include <linux/input/mt.h>
31 #include <linux/usb.h> /* For to_usb_interface for T100 touchpad intf check */
32 #include <linux/power_supply.h>
33
34 #include "hid-ids.h"
35
36 MODULE_AUTHOR("Yusuke Fujimaki <usk.fujimaki@gmail.com>");
37 MODULE_AUTHOR("Brendan McGrath <redmcg@redmandi.dyndns.org>");
38 MODULE_AUTHOR("Victor Vlasenko <victor.vlasenko@sysgears.com>");
39 MODULE_AUTHOR("Frederik Wenigwieser <frederik.wenigwieser@gmail.com>");
40 MODULE_DESCRIPTION("Asus HID Keyboard and TouchPad");
41
42 #define T100_TPAD_INTF 2
43
44 #define T100CHI_MOUSE_REPORT_ID 0x06
45 #define FEATURE_REPORT_ID 0x0d
46 #define INPUT_REPORT_ID 0x5d
47 #define FEATURE_KBD_REPORT_ID 0x5a
48 #define FEATURE_KBD_REPORT_SIZE 16
49
50 #define SUPPORT_KBD_BACKLIGHT BIT(0)
51
52 #define MAX_TOUCH_MAJOR 8
53 #define MAX_PRESSURE 128
54
55 #define BTN_LEFT_MASK 0x01
56 #define CONTACT_TOOL_TYPE_MASK 0x80
57 #define CONTACT_X_MSB_MASK 0xf0
58 #define CONTACT_Y_MSB_MASK 0x0f
59 #define CONTACT_TOUCH_MAJOR_MASK 0x07
60 #define CONTACT_PRESSURE_MASK 0x7f
61
62 #define BATTERY_REPORT_ID       (0x03)
63 #define BATTERY_REPORT_SIZE     (1 + 8)
64 #define BATTERY_LEVEL_MAX       ((u8)255)
65 #define BATTERY_STAT_DISCONNECT (0)
66 #define BATTERY_STAT_CHARGING   (1)
67 #define BATTERY_STAT_FULL       (2)
68
69 #define QUIRK_FIX_NOTEBOOK_REPORT       BIT(0)
70 #define QUIRK_NO_INIT_REPORTS           BIT(1)
71 #define QUIRK_SKIP_INPUT_MAPPING        BIT(2)
72 #define QUIRK_IS_MULTITOUCH             BIT(3)
73 #define QUIRK_NO_CONSUMER_USAGES        BIT(4)
74 #define QUIRK_USE_KBD_BACKLIGHT         BIT(5)
75 #define QUIRK_T100_KEYBOARD             BIT(6)
76 #define QUIRK_T100CHI                   BIT(7)
77 #define QUIRK_G752_KEYBOARD             BIT(8)
78 #define QUIRK_T101HA_DOCK               BIT(9)
79 #define QUIRK_T90CHI                    BIT(10)
80
81 #define I2C_KEYBOARD_QUIRKS                     (QUIRK_FIX_NOTEBOOK_REPORT | \
82                                                  QUIRK_NO_INIT_REPORTS | \
83                                                  QUIRK_NO_CONSUMER_USAGES)
84 #define I2C_TOUCHPAD_QUIRKS                     (QUIRK_NO_INIT_REPORTS | \
85                                                  QUIRK_SKIP_INPUT_MAPPING | \
86                                                  QUIRK_IS_MULTITOUCH)
87
88 #define TRKID_SGN       ((TRKID_MAX + 1) >> 1)
89
90 struct asus_kbd_leds {
91         struct led_classdev cdev;
92         struct hid_device *hdev;
93         struct work_struct work;
94         unsigned int brightness;
95         bool removed;
96 };
97
98 struct asus_touchpad_info {
99         int max_x;
100         int max_y;
101         int res_x;
102         int res_y;
103         int contact_size;
104         int max_contacts;
105 };
106
107 struct asus_drvdata {
108         unsigned long quirks;
109         struct hid_device *hdev;
110         struct input_dev *input;
111         struct asus_kbd_leds *kbd_backlight;
112         const struct asus_touchpad_info *tp;
113         bool enable_backlight;
114         struct power_supply *battery;
115         struct power_supply_desc battery_desc;
116         int battery_capacity;
117         int battery_stat;
118         bool battery_in_query;
119         unsigned long battery_next_query;
120 };
121
122 static int asus_report_battery(struct asus_drvdata *, u8 *, int);
123
124 static const struct asus_touchpad_info asus_i2c_tp = {
125         .max_x = 2794,
126         .max_y = 1758,
127         .contact_size = 5,
128         .max_contacts = 5,
129 };
130
131 static const struct asus_touchpad_info asus_t100ta_tp = {
132         .max_x = 2240,
133         .max_y = 1120,
134         .res_x = 30, /* units/mm */
135         .res_y = 27, /* units/mm */
136         .contact_size = 5,
137         .max_contacts = 5,
138 };
139
140 static const struct asus_touchpad_info asus_t100ha_tp = {
141         .max_x = 2640,
142         .max_y = 1320,
143         .res_x = 30, /* units/mm */
144         .res_y = 29, /* units/mm */
145         .contact_size = 5,
146         .max_contacts = 5,
147 };
148
149 static const struct asus_touchpad_info asus_t200ta_tp = {
150         .max_x = 3120,
151         .max_y = 1716,
152         .res_x = 30, /* units/mm */
153         .res_y = 28, /* units/mm */
154         .contact_size = 5,
155         .max_contacts = 5,
156 };
157
158 static const struct asus_touchpad_info asus_t100chi_tp = {
159         .max_x = 2640,
160         .max_y = 1320,
161         .res_x = 31, /* units/mm */
162         .res_y = 29, /* units/mm */
163         .contact_size = 3,
164         .max_contacts = 4,
165 };
166
167 static void asus_report_contact_down(struct asus_drvdata *drvdat,
168                 int toolType, u8 *data)
169 {
170         struct input_dev *input = drvdat->input;
171         int touch_major, pressure, x, y;
172
173         x = (data[0] & CONTACT_X_MSB_MASK) << 4 | data[1];
174         y = drvdat->tp->max_y - ((data[0] & CONTACT_Y_MSB_MASK) << 8 | data[2]);
175
176         input_report_abs(input, ABS_MT_POSITION_X, x);
177         input_report_abs(input, ABS_MT_POSITION_Y, y);
178
179         if (drvdat->tp->contact_size < 5)
180                 return;
181
182         if (toolType == MT_TOOL_PALM) {
183                 touch_major = MAX_TOUCH_MAJOR;
184                 pressure = MAX_PRESSURE;
185         } else {
186                 touch_major = (data[3] >> 4) & CONTACT_TOUCH_MAJOR_MASK;
187                 pressure = data[4] & CONTACT_PRESSURE_MASK;
188         }
189
190         input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major);
191         input_report_abs(input, ABS_MT_PRESSURE, pressure);
192 }
193
194 /* Required for Synaptics Palm Detection */
195 static void asus_report_tool_width(struct asus_drvdata *drvdat)
196 {
197         struct input_mt *mt = drvdat->input->mt;
198         struct input_mt_slot *oldest;
199         int oldid, count, i;
200
201         if (drvdat->tp->contact_size < 5)
202                 return;
203
204         oldest = NULL;
205         oldid = mt->trkid;
206         count = 0;
207
208         for (i = 0; i < mt->num_slots; ++i) {
209                 struct input_mt_slot *ps = &mt->slots[i];
210                 int id = input_mt_get_value(ps, ABS_MT_TRACKING_ID);
211
212                 if (id < 0)
213                         continue;
214                 if ((id - oldid) & TRKID_SGN) {
215                         oldest = ps;
216                         oldid = id;
217                 }
218                 count++;
219         }
220
221         if (oldest) {
222                 input_report_abs(drvdat->input, ABS_TOOL_WIDTH,
223                         input_mt_get_value(oldest, ABS_MT_TOUCH_MAJOR));
224         }
225 }
226
227 static int asus_report_input(struct asus_drvdata *drvdat, u8 *data, int size)
228 {
229         int i, toolType = MT_TOOL_FINGER;
230         u8 *contactData = data + 2;
231
232         if (size != 3 + drvdat->tp->contact_size * drvdat->tp->max_contacts)
233                 return 0;
234
235         for (i = 0; i < drvdat->tp->max_contacts; i++) {
236                 bool down = !!(data[1] & BIT(i+3));
237
238                 if (drvdat->tp->contact_size >= 5)
239                         toolType = contactData[3] & CONTACT_TOOL_TYPE_MASK ?
240                                                 MT_TOOL_PALM : MT_TOOL_FINGER;
241
242                 input_mt_slot(drvdat->input, i);
243                 input_mt_report_slot_state(drvdat->input, toolType, down);
244
245                 if (down) {
246                         asus_report_contact_down(drvdat, toolType, contactData);
247                         contactData += drvdat->tp->contact_size;
248                 }
249         }
250
251         input_report_key(drvdat->input, BTN_LEFT, data[1] & BTN_LEFT_MASK);
252         asus_report_tool_width(drvdat);
253
254         input_mt_sync_frame(drvdat->input);
255         input_sync(drvdat->input);
256
257         return 1;
258 }
259
260 static int asus_event(struct hid_device *hdev, struct hid_field *field,
261                       struct hid_usage *usage, __s32 value)
262 {
263         if ((usage->hid & HID_USAGE_PAGE) == 0xff310000 &&
264             (usage->hid & HID_USAGE) != 0x00 && !usage->type) {
265                 hid_warn(hdev, "Unmapped Asus vendor usagepage code 0x%02x\n",
266                          usage->hid & HID_USAGE);
267         }
268
269         return 0;
270 }
271
272 static int asus_raw_event(struct hid_device *hdev,
273                 struct hid_report *report, u8 *data, int size)
274 {
275         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
276
277         if (drvdata->battery && data[0] == BATTERY_REPORT_ID)
278                 return asus_report_battery(drvdata, data, size);
279
280         if (drvdata->tp && data[0] == INPUT_REPORT_ID)
281                 return asus_report_input(drvdata, data, size);
282
283         return 0;
284 }
285
286 static int asus_kbd_set_report(struct hid_device *hdev, u8 *buf, size_t buf_size)
287 {
288         unsigned char *dmabuf;
289         int ret;
290
291         dmabuf = kmemdup(buf, buf_size, GFP_KERNEL);
292         if (!dmabuf)
293                 return -ENOMEM;
294
295         ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, dmabuf,
296                                  buf_size, HID_FEATURE_REPORT,
297                                  HID_REQ_SET_REPORT);
298         kfree(dmabuf);
299
300         return ret;
301 }
302
303 static int asus_kbd_init(struct hid_device *hdev)
304 {
305         u8 buf[] = { FEATURE_KBD_REPORT_ID, 0x41, 0x53, 0x55, 0x53, 0x20, 0x54,
306                      0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 };
307         int ret;
308
309         ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
310         if (ret < 0)
311                 hid_err(hdev, "Asus failed to send init command: %d\n", ret);
312
313         return ret;
314 }
315
316 static int asus_kbd_get_functions(struct hid_device *hdev,
317                                   unsigned char *kbd_func)
318 {
319         u8 buf[] = { FEATURE_KBD_REPORT_ID, 0x05, 0x20, 0x31, 0x00, 0x08 };
320         u8 *readbuf;
321         int ret;
322
323         ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
324         if (ret < 0) {
325                 hid_err(hdev, "Asus failed to send configuration command: %d\n", ret);
326                 return ret;
327         }
328
329         readbuf = kzalloc(FEATURE_KBD_REPORT_SIZE, GFP_KERNEL);
330         if (!readbuf)
331                 return -ENOMEM;
332
333         ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, readbuf,
334                                  FEATURE_KBD_REPORT_SIZE, HID_FEATURE_REPORT,
335                                  HID_REQ_GET_REPORT);
336         if (ret < 0) {
337                 hid_err(hdev, "Asus failed to request functions: %d\n", ret);
338                 kfree(readbuf);
339                 return ret;
340         }
341
342         *kbd_func = readbuf[6];
343
344         kfree(readbuf);
345         return ret;
346 }
347
348 static void asus_kbd_backlight_set(struct led_classdev *led_cdev,
349                                    enum led_brightness brightness)
350 {
351         struct asus_kbd_leds *led = container_of(led_cdev, struct asus_kbd_leds,
352                                                  cdev);
353         if (led->brightness == brightness)
354                 return;
355
356         led->brightness = brightness;
357         schedule_work(&led->work);
358 }
359
360 static enum led_brightness asus_kbd_backlight_get(struct led_classdev *led_cdev)
361 {
362         struct asus_kbd_leds *led = container_of(led_cdev, struct asus_kbd_leds,
363                                                  cdev);
364
365         return led->brightness;
366 }
367
368 static void asus_kbd_backlight_work(struct work_struct *work)
369 {
370         struct asus_kbd_leds *led = container_of(work, struct asus_kbd_leds, work);
371         u8 buf[] = { FEATURE_KBD_REPORT_ID, 0xba, 0xc5, 0xc4, 0x00 };
372         int ret;
373
374         if (led->removed)
375                 return;
376
377         buf[4] = led->brightness;
378
379         ret = asus_kbd_set_report(led->hdev, buf, sizeof(buf));
380         if (ret < 0)
381                 hid_err(led->hdev, "Asus failed to set keyboard backlight: %d\n", ret);
382 }
383
384 /* WMI-based keyboard backlight LED control (via asus-wmi driver) takes
385  * precedence. We only activate HID-based backlight control when the
386  * WMI control is not available.
387  */
388 static bool asus_kbd_wmi_led_control_present(struct hid_device *hdev)
389 {
390         u32 value;
391         int ret;
392
393         if (!IS_ENABLED(CONFIG_ASUS_WMI))
394                 return false;
395
396         ret = asus_wmi_evaluate_method(ASUS_WMI_METHODID_DSTS2,
397                                        ASUS_WMI_DEVID_KBD_BACKLIGHT, 0, &value);
398         hid_dbg(hdev, "WMI backlight check: rc %d value %x", ret, value);
399         if (ret)
400                 return false;
401
402         return !!(value & ASUS_WMI_DSTS_PRESENCE_BIT);
403 }
404
405 static int asus_kbd_register_leds(struct hid_device *hdev)
406 {
407         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
408         unsigned char kbd_func;
409         int ret;
410
411         /* Initialize keyboard */
412         ret = asus_kbd_init(hdev);
413         if (ret < 0)
414                 return ret;
415
416         /* Get keyboard functions */
417         ret = asus_kbd_get_functions(hdev, &kbd_func);
418         if (ret < 0)
419                 return ret;
420
421         /* Check for backlight support */
422         if (!(kbd_func & SUPPORT_KBD_BACKLIGHT))
423                 return -ENODEV;
424
425         drvdata->kbd_backlight = devm_kzalloc(&hdev->dev,
426                                               sizeof(struct asus_kbd_leds),
427                                               GFP_KERNEL);
428         if (!drvdata->kbd_backlight)
429                 return -ENOMEM;
430
431         drvdata->kbd_backlight->removed = false;
432         drvdata->kbd_backlight->brightness = 0;
433         drvdata->kbd_backlight->hdev = hdev;
434         drvdata->kbd_backlight->cdev.name = "asus::kbd_backlight";
435         drvdata->kbd_backlight->cdev.max_brightness = 3;
436         drvdata->kbd_backlight->cdev.brightness_set = asus_kbd_backlight_set;
437         drvdata->kbd_backlight->cdev.brightness_get = asus_kbd_backlight_get;
438         INIT_WORK(&drvdata->kbd_backlight->work, asus_kbd_backlight_work);
439
440         ret = devm_led_classdev_register(&hdev->dev, &drvdata->kbd_backlight->cdev);
441         if (ret < 0) {
442                 /* No need to have this still around */
443                 devm_kfree(&hdev->dev, drvdata->kbd_backlight);
444         }
445
446         return ret;
447 }
448
449 /*
450  * [0]       REPORT_ID (same value defined in report descriptor)
451  * [1]       rest battery level. range [0..255]
452  * [2]..[7]  Bluetooth hardware address (MAC address)
453  * [8]       charging status
454  *            = 0 : AC offline / discharging
455  *            = 1 : AC online  / charging
456  *            = 2 : AC online  / fully charged
457  */
458 static int asus_parse_battery(struct asus_drvdata *drvdata, u8 *data, int size)
459 {
460         u8 sts;
461         u8 lvl;
462         int val;
463
464         lvl = data[1];
465         sts = data[8];
466
467         drvdata->battery_capacity = ((int)lvl * 100) / (int)BATTERY_LEVEL_MAX;
468
469         switch (sts) {
470         case BATTERY_STAT_CHARGING:
471                 val = POWER_SUPPLY_STATUS_CHARGING;
472                 break;
473         case BATTERY_STAT_FULL:
474                 val = POWER_SUPPLY_STATUS_FULL;
475                 break;
476         case BATTERY_STAT_DISCONNECT:
477         default:
478                 val = POWER_SUPPLY_STATUS_DISCHARGING;
479                 break;
480         }
481         drvdata->battery_stat = val;
482
483         return 0;
484 }
485
486 static int asus_report_battery(struct asus_drvdata *drvdata, u8 *data, int size)
487 {
488         /* notify only the autonomous event by device */
489         if ((drvdata->battery_in_query == false) &&
490                          (size == BATTERY_REPORT_SIZE))
491                 power_supply_changed(drvdata->battery);
492
493         return 0;
494 }
495
496 static int asus_battery_query(struct asus_drvdata *drvdata)
497 {
498         u8 *buf;
499         int ret = 0;
500
501         buf = kmalloc(BATTERY_REPORT_SIZE, GFP_KERNEL);
502         if (!buf)
503                 return -ENOMEM;
504
505         drvdata->battery_in_query = true;
506         ret = hid_hw_raw_request(drvdata->hdev, BATTERY_REPORT_ID,
507                                 buf, BATTERY_REPORT_SIZE,
508                                 HID_INPUT_REPORT, HID_REQ_GET_REPORT);
509         drvdata->battery_in_query = false;
510         if (ret == BATTERY_REPORT_SIZE)
511                 ret = asus_parse_battery(drvdata, buf, BATTERY_REPORT_SIZE);
512         else
513                 ret = -ENODATA;
514
515         kfree(buf);
516
517         return ret;
518 }
519
520 static enum power_supply_property asus_battery_props[] = {
521         POWER_SUPPLY_PROP_STATUS,
522         POWER_SUPPLY_PROP_PRESENT,
523         POWER_SUPPLY_PROP_CAPACITY,
524         POWER_SUPPLY_PROP_SCOPE,
525         POWER_SUPPLY_PROP_MODEL_NAME,
526 };
527
528 #define QUERY_MIN_INTERVAL      (60 * HZ)       /* 60[sec] */
529
530 static int asus_battery_get_property(struct power_supply *psy,
531                                 enum power_supply_property psp,
532                                 union power_supply_propval *val)
533 {
534         struct asus_drvdata *drvdata = power_supply_get_drvdata(psy);
535         int ret = 0;
536
537         switch (psp) {
538         case POWER_SUPPLY_PROP_STATUS:
539         case POWER_SUPPLY_PROP_CAPACITY:
540                 if (time_before(drvdata->battery_next_query, jiffies)) {
541                         drvdata->battery_next_query =
542                                          jiffies + QUERY_MIN_INTERVAL;
543                         ret = asus_battery_query(drvdata);
544                         if (ret)
545                                 return ret;
546                 }
547                 if (psp == POWER_SUPPLY_PROP_STATUS)
548                         val->intval = drvdata->battery_stat;
549                 else
550                         val->intval = drvdata->battery_capacity;
551                 break;
552         case POWER_SUPPLY_PROP_PRESENT:
553                 val->intval = 1;
554                 break;
555         case POWER_SUPPLY_PROP_SCOPE:
556                 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
557                 break;
558         case POWER_SUPPLY_PROP_MODEL_NAME:
559                 val->strval = drvdata->hdev->name;
560                 break;
561         default:
562                 ret = -EINVAL;
563                 break;
564         }
565
566         return ret;
567 }
568
569 static int asus_battery_probe(struct hid_device *hdev)
570 {
571         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
572         struct power_supply_config pscfg = { .drv_data = drvdata };
573         int ret = 0;
574
575         drvdata->battery_capacity = 0;
576         drvdata->battery_stat = POWER_SUPPLY_STATUS_UNKNOWN;
577         drvdata->battery_in_query = false;
578
579         drvdata->battery_desc.properties = asus_battery_props;
580         drvdata->battery_desc.num_properties = ARRAY_SIZE(asus_battery_props);
581         drvdata->battery_desc.get_property = asus_battery_get_property;
582         drvdata->battery_desc.type = POWER_SUPPLY_TYPE_BATTERY;
583         drvdata->battery_desc.use_for_apm = 0;
584         drvdata->battery_desc.name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
585                                         "asus-keyboard-%s-battery",
586                                         strlen(hdev->uniq) ?
587                                         hdev->uniq : dev_name(&hdev->dev));
588         if (!drvdata->battery_desc.name)
589                 return -ENOMEM;
590
591         drvdata->battery_next_query = jiffies;
592
593         drvdata->battery = devm_power_supply_register(&hdev->dev,
594                                 &(drvdata->battery_desc), &pscfg);
595         if (IS_ERR(drvdata->battery)) {
596                 ret = PTR_ERR(drvdata->battery);
597                 drvdata->battery = NULL;
598                 hid_err(hdev, "Unable to register battery device\n");
599                 return ret;
600         }
601
602         power_supply_powers(drvdata->battery, &hdev->dev);
603
604         return ret;
605 }
606
607 static int asus_input_configured(struct hid_device *hdev, struct hid_input *hi)
608 {
609         struct input_dev *input = hi->input;
610         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
611
612         /* T100CHI uses MULTI_INPUT, bind the touchpad to the mouse hid_input */
613         if (drvdata->quirks & QUIRK_T100CHI &&
614             hi->report->id != T100CHI_MOUSE_REPORT_ID)
615                 return 0;
616
617         if (drvdata->tp) {
618                 int ret;
619
620                 input_set_abs_params(input, ABS_MT_POSITION_X, 0,
621                                      drvdata->tp->max_x, 0, 0);
622                 input_set_abs_params(input, ABS_MT_POSITION_Y, 0,
623                                      drvdata->tp->max_y, 0, 0);
624                 input_abs_set_res(input, ABS_MT_POSITION_X, drvdata->tp->res_x);
625                 input_abs_set_res(input, ABS_MT_POSITION_Y, drvdata->tp->res_y);
626
627                 if (drvdata->tp->contact_size >= 5) {
628                         input_set_abs_params(input, ABS_TOOL_WIDTH, 0,
629                                              MAX_TOUCH_MAJOR, 0, 0);
630                         input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0,
631                                              MAX_TOUCH_MAJOR, 0, 0);
632                         input_set_abs_params(input, ABS_MT_PRESSURE, 0,
633                                               MAX_PRESSURE, 0, 0);
634                 }
635
636                 __set_bit(BTN_LEFT, input->keybit);
637                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
638
639                 ret = input_mt_init_slots(input, drvdata->tp->max_contacts,
640                                           INPUT_MT_POINTER);
641
642                 if (ret) {
643                         hid_err(hdev, "Asus input mt init slots failed: %d\n", ret);
644                         return ret;
645                 }
646         }
647
648         drvdata->input = input;
649
650         if (drvdata->enable_backlight &&
651             !asus_kbd_wmi_led_control_present(hdev) &&
652             asus_kbd_register_leds(hdev))
653                 hid_warn(hdev, "Failed to initialize backlight.\n");
654
655         return 0;
656 }
657
658 #define asus_map_key_clear(c)   hid_map_usage_clear(hi, usage, bit, \
659                                                     max, EV_KEY, (c))
660 static int asus_input_mapping(struct hid_device *hdev,
661                 struct hid_input *hi, struct hid_field *field,
662                 struct hid_usage *usage, unsigned long **bit,
663                 int *max)
664 {
665         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
666
667         if (drvdata->quirks & QUIRK_SKIP_INPUT_MAPPING) {
668                 /* Don't map anything from the HID report.
669                  * We do it all manually in asus_input_configured
670                  */
671                 return -1;
672         }
673
674         /*
675          * Ignore a bunch of bogus collections in the T100CHI descriptor.
676          * This avoids a bunch of non-functional hid_input devices getting
677          * created because of the T100CHI using HID_QUIRK_MULTI_INPUT.
678          */
679         if (drvdata->quirks & (QUIRK_T100CHI | QUIRK_T90CHI)) {
680                 if (field->application == (HID_UP_GENDESK | 0x0080) ||
681                     usage->hid == (HID_UP_GENDEVCTRLS | 0x0024) ||
682                     usage->hid == (HID_UP_GENDEVCTRLS | 0x0025) ||
683                     usage->hid == (HID_UP_GENDEVCTRLS | 0x0026))
684                         return -1;
685                 /*
686                  * We use the hid_input for the mouse report for the touchpad,
687                  * keep the left button, to avoid the core removing it.
688                  */
689                 if (field->application == HID_GD_MOUSE &&
690                     usage->hid != (HID_UP_BUTTON | 1))
691                         return -1;
692         }
693
694         /* ASUS-specific keyboard hotkeys */
695         if ((usage->hid & HID_USAGE_PAGE) == 0xff310000) {
696                 set_bit(EV_REP, hi->input->evbit);
697                 switch (usage->hid & HID_USAGE) {
698                 case 0x10: asus_map_key_clear(KEY_BRIGHTNESSDOWN);      break;
699                 case 0x20: asus_map_key_clear(KEY_BRIGHTNESSUP);                break;
700                 case 0x35: asus_map_key_clear(KEY_DISPLAY_OFF);         break;
701                 case 0x6c: asus_map_key_clear(KEY_SLEEP);               break;
702                 case 0x7c: asus_map_key_clear(KEY_MICMUTE);             break;
703                 case 0x82: asus_map_key_clear(KEY_CAMERA);              break;
704                 case 0x88: asus_map_key_clear(KEY_RFKILL);                      break;
705                 case 0xb5: asus_map_key_clear(KEY_CALC);                        break;
706                 case 0xc4: asus_map_key_clear(KEY_KBDILLUMUP);          break;
707                 case 0xc5: asus_map_key_clear(KEY_KBDILLUMDOWN);                break;
708
709                 /* ASUS touchpad toggle */
710                 case 0x6b: asus_map_key_clear(KEY_F21);                 break;
711
712                 /* ROG key */
713                 case 0x38: asus_map_key_clear(KEY_PROG1);               break;
714
715                 /* Fn+C ASUS Splendid */
716                 case 0xba: asus_map_key_clear(KEY_PROG2);               break;
717
718                 /* Fn+Space Power4Gear Hybrid */
719                 case 0x5c: asus_map_key_clear(KEY_PROG3);               break;
720
721                 /* Fn+F5 "fan" symbol on FX503VD */
722                 case 0x99: asus_map_key_clear(KEY_PROG4);               break;
723
724                 default:
725                         /* ASUS lazily declares 256 usages, ignore the rest,
726                          * as some make the keyboard appear as a pointer device. */
727                         return -1;
728                 }
729
730                 /*
731                  * Check and enable backlight only on devices with UsagePage ==
732                  * 0xff31 to avoid initializing the keyboard firmware multiple
733                  * times on devices with multiple HID descriptors but same
734                  * PID/VID.
735                  */
736                 if (drvdata->quirks & QUIRK_USE_KBD_BACKLIGHT)
737                         drvdata->enable_backlight = true;
738
739                 return 1;
740         }
741
742         if ((usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR) {
743                 set_bit(EV_REP, hi->input->evbit);
744                 switch (usage->hid & HID_USAGE) {
745                 case 0xff01: asus_map_key_clear(BTN_1); break;
746                 case 0xff02: asus_map_key_clear(BTN_2); break;
747                 case 0xff03: asus_map_key_clear(BTN_3); break;
748                 case 0xff04: asus_map_key_clear(BTN_4); break;
749                 case 0xff05: asus_map_key_clear(BTN_5); break;
750                 case 0xff06: asus_map_key_clear(BTN_6); break;
751                 case 0xff07: asus_map_key_clear(BTN_7); break;
752                 case 0xff08: asus_map_key_clear(BTN_8); break;
753                 case 0xff09: asus_map_key_clear(BTN_9); break;
754                 case 0xff0a: asus_map_key_clear(BTN_A); break;
755                 case 0xff0b: asus_map_key_clear(BTN_B); break;
756                 case 0x00f1: asus_map_key_clear(KEY_WLAN);      break;
757                 case 0x00f2: asus_map_key_clear(KEY_BRIGHTNESSDOWN);    break;
758                 case 0x00f3: asus_map_key_clear(KEY_BRIGHTNESSUP);      break;
759                 case 0x00f4: asus_map_key_clear(KEY_DISPLAY_OFF);       break;
760                 case 0x00f7: asus_map_key_clear(KEY_CAMERA);    break;
761                 case 0x00f8: asus_map_key_clear(KEY_PROG1);     break;
762                 default:
763                         return 0;
764                 }
765
766                 return 1;
767         }
768
769         if (drvdata->quirks & QUIRK_NO_CONSUMER_USAGES &&
770                 (usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER) {
771                 switch (usage->hid & HID_USAGE) {
772                 case 0xe2: /* Mute */
773                 case 0xe9: /* Volume up */
774                 case 0xea: /* Volume down */
775                         return 0;
776                 default:
777                         /* Ignore dummy Consumer usages which make the
778                          * keyboard incorrectly appear as a pointer device.
779                          */
780                         return -1;
781                 }
782         }
783
784         return 0;
785 }
786
787 static int asus_start_multitouch(struct hid_device *hdev)
788 {
789         int ret;
790         static const unsigned char buf[] = {
791                 FEATURE_REPORT_ID, 0x00, 0x03, 0x01, 0x00
792         };
793         unsigned char *dmabuf = kmemdup(buf, sizeof(buf), GFP_KERNEL);
794
795         if (!dmabuf) {
796                 ret = -ENOMEM;
797                 hid_err(hdev, "Asus failed to alloc dma buf: %d\n", ret);
798                 return ret;
799         }
800
801         ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, sizeof(buf),
802                                         HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
803
804         kfree(dmabuf);
805
806         if (ret != sizeof(buf)) {
807                 hid_err(hdev, "Asus failed to start multitouch: %d\n", ret);
808                 return ret;
809         }
810
811         return 0;
812 }
813
814 static int __maybe_unused asus_reset_resume(struct hid_device *hdev)
815 {
816         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
817
818         if (drvdata->tp)
819                 return asus_start_multitouch(hdev);
820
821         return 0;
822 }
823
824 static int asus_probe(struct hid_device *hdev, const struct hid_device_id *id)
825 {
826         int ret;
827         struct asus_drvdata *drvdata;
828
829         drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
830         if (drvdata == NULL) {
831                 hid_err(hdev, "Can't alloc Asus descriptor\n");
832                 return -ENOMEM;
833         }
834
835         hid_set_drvdata(hdev, drvdata);
836
837         drvdata->quirks = id->driver_data;
838
839         /*
840          * T90CHI's keyboard dock returns same ID values as T100CHI's dock.
841          * Thus, identify T90CHI dock with product name string.
842          */
843         if (strstr(hdev->name, "T90CHI")) {
844                 drvdata->quirks &= ~QUIRK_T100CHI;
845                 drvdata->quirks |= QUIRK_T90CHI;
846         }
847
848         if (drvdata->quirks & QUIRK_IS_MULTITOUCH)
849                 drvdata->tp = &asus_i2c_tp;
850
851         if (drvdata->quirks & QUIRK_T100_KEYBOARD) {
852                 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
853
854                 if (intf->altsetting->desc.bInterfaceNumber == T100_TPAD_INTF) {
855                         drvdata->quirks = QUIRK_SKIP_INPUT_MAPPING;
856                         /*
857                          * The T100HA uses the same USB-ids as the T100TAF and
858                          * the T200TA uses the same USB-ids as the T100TA, while
859                          * both have different max x/y values as the T100TA[F].
860                          */
861                         if (dmi_match(DMI_PRODUCT_NAME, "T100HAN"))
862                                 drvdata->tp = &asus_t100ha_tp;
863                         else if (dmi_match(DMI_PRODUCT_NAME, "T200TA"))
864                                 drvdata->tp = &asus_t200ta_tp;
865                         else
866                                 drvdata->tp = &asus_t100ta_tp;
867                 }
868         }
869
870         if (drvdata->quirks & QUIRK_T100CHI) {
871                 /*
872                  * All functionality is on a single HID interface and for
873                  * userspace the touchpad must be a separate input_dev.
874                  */
875                 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
876                 drvdata->tp = &asus_t100chi_tp;
877         }
878
879         if (drvdata->quirks & QUIRK_NO_INIT_REPORTS)
880                 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
881
882         drvdata->hdev = hdev;
883
884         if (drvdata->quirks & (QUIRK_T100CHI | QUIRK_T90CHI)) {
885                 ret = asus_battery_probe(hdev);
886                 if (ret) {
887                         hid_err(hdev,
888                             "Asus hid battery_probe failed: %d\n", ret);
889                         return ret;
890                 }
891         }
892
893         ret = hid_parse(hdev);
894         if (ret) {
895                 hid_err(hdev, "Asus hid parse failed: %d\n", ret);
896                 return ret;
897         }
898
899         /* use hid-multitouch for T101HA touchpad */
900         if (id->driver_data & QUIRK_T101HA_DOCK &&
901             hdev->collection->usage == HID_GD_MOUSE)
902                 return -ENODEV;
903
904         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
905         if (ret) {
906                 hid_err(hdev, "Asus hw start failed: %d\n", ret);
907                 return ret;
908         }
909
910         if (!drvdata->input) {
911                 hid_err(hdev, "Asus input not registered\n");
912                 ret = -ENOMEM;
913                 goto err_stop_hw;
914         }
915
916         if (drvdata->tp) {
917                 drvdata->input->name = "Asus TouchPad";
918         } else {
919                 drvdata->input->name = "Asus Keyboard";
920         }
921
922         if (drvdata->tp) {
923                 ret = asus_start_multitouch(hdev);
924                 if (ret)
925                         goto err_stop_hw;
926         }
927
928         return 0;
929 err_stop_hw:
930         hid_hw_stop(hdev);
931         return ret;
932 }
933
934 static void asus_remove(struct hid_device *hdev)
935 {
936         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
937
938         if (drvdata->kbd_backlight) {
939                 drvdata->kbd_backlight->removed = true;
940                 cancel_work_sync(&drvdata->kbd_backlight->work);
941         }
942
943         hid_hw_stop(hdev);
944 }
945
946 static const __u8 asus_g752_fixed_rdesc[] = {
947         0x19, 0x00,                     /*   Usage Minimum (0x00)       */
948         0x2A, 0xFF, 0x00,               /*   Usage Maximum (0xFF)       */
949 };
950
951 static __u8 *asus_report_fixup(struct hid_device *hdev, __u8 *rdesc,
952                 unsigned int *rsize)
953 {
954         struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
955
956         if (drvdata->quirks & QUIRK_FIX_NOTEBOOK_REPORT &&
957                         *rsize >= 56 && rdesc[54] == 0x25 && rdesc[55] == 0x65) {
958                 hid_info(hdev, "Fixing up Asus notebook report descriptor\n");
959                 rdesc[55] = 0xdd;
960         }
961         /* For the T100TA/T200TA keyboard dock */
962         if (drvdata->quirks & QUIRK_T100_KEYBOARD &&
963                  (*rsize == 76 || *rsize == 101) &&
964                  rdesc[73] == 0x81 && rdesc[74] == 0x01) {
965                 hid_info(hdev, "Fixing up Asus T100 keyb report descriptor\n");
966                 rdesc[74] &= ~HID_MAIN_ITEM_CONSTANT;
967         }
968         /* For the T100CHI/T90CHI keyboard dock */
969         if (drvdata->quirks & (QUIRK_T100CHI | QUIRK_T90CHI)) {
970                 int rsize_orig;
971                 int offs;
972
973                 if (drvdata->quirks & QUIRK_T100CHI) {
974                         rsize_orig = 403;
975                         offs = 388;
976                 } else {
977                         rsize_orig = 306;
978                         offs = 291;
979                 }
980
981                 /*
982                  * Change Usage (76h) to Usage Minimum (00h), Usage Maximum
983                  * (FFh) and clear the flags in the Input() byte.
984                  * Note the descriptor has a bogus 0 byte at the end so we
985                  * only need 1 extra byte.
986                  */
987                 if (*rsize == rsize_orig &&
988                         rdesc[offs] == 0x09 && rdesc[offs + 1] == 0x76) {
989                         *rsize = rsize_orig + 1;
990                         rdesc = kmemdup(rdesc, *rsize, GFP_KERNEL);
991                         if (!rdesc)
992                                 return NULL;
993
994                         hid_info(hdev, "Fixing up %s keyb report descriptor\n",
995                                 drvdata->quirks & QUIRK_T100CHI ?
996                                 "T100CHI" : "T90CHI");
997                         memmove(rdesc + offs + 4, rdesc + offs + 2, 12);
998                         rdesc[offs] = 0x19;
999                         rdesc[offs + 1] = 0x00;
1000                         rdesc[offs + 2] = 0x29;
1001                         rdesc[offs + 3] = 0xff;
1002                         rdesc[offs + 14] = 0x00;
1003                 }
1004         }
1005
1006         if (drvdata->quirks & QUIRK_G752_KEYBOARD &&
1007                  *rsize == 75 && rdesc[61] == 0x15 && rdesc[62] == 0x00) {
1008                 /* report is missing usage mninum and maximum */
1009                 __u8 *new_rdesc;
1010                 size_t new_size = *rsize + sizeof(asus_g752_fixed_rdesc);
1011
1012                 new_rdesc = devm_kzalloc(&hdev->dev, new_size, GFP_KERNEL);
1013                 if (new_rdesc == NULL)
1014                         return rdesc;
1015
1016                 hid_info(hdev, "Fixing up Asus G752 keyb report descriptor\n");
1017                 /* copy the valid part */
1018                 memcpy(new_rdesc, rdesc, 61);
1019                 /* insert missing part */
1020                 memcpy(new_rdesc + 61, asus_g752_fixed_rdesc, sizeof(asus_g752_fixed_rdesc));
1021                 /* copy remaining data */
1022                 memcpy(new_rdesc + 61 + sizeof(asus_g752_fixed_rdesc), rdesc + 61, *rsize - 61);
1023
1024                 *rsize = new_size;
1025                 rdesc = new_rdesc;
1026         }
1027
1028         return rdesc;
1029 }
1030
1031 static const struct hid_device_id asus_devices[] = {
1032         { HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK,
1033                 USB_DEVICE_ID_ASUSTEK_I2C_KEYBOARD), I2C_KEYBOARD_QUIRKS},
1034         { HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK,
1035                 USB_DEVICE_ID_ASUSTEK_I2C_TOUCHPAD), I2C_TOUCHPAD_QUIRKS },
1036         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1037                 USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD1), QUIRK_USE_KBD_BACKLIGHT },
1038         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1039                 USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD2), QUIRK_USE_KBD_BACKLIGHT },
1040         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1041                 USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD3), QUIRK_G752_KEYBOARD },
1042         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1043                 USB_DEVICE_ID_ASUSTEK_FX503VD_KEYBOARD),
1044           QUIRK_USE_KBD_BACKLIGHT },
1045         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1046                 USB_DEVICE_ID_ASUSTEK_T100TA_KEYBOARD),
1047           QUIRK_T100_KEYBOARD | QUIRK_NO_CONSUMER_USAGES },
1048         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1049                 USB_DEVICE_ID_ASUSTEK_T100TAF_KEYBOARD),
1050           QUIRK_T100_KEYBOARD | QUIRK_NO_CONSUMER_USAGES },
1051         { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
1052                 USB_DEVICE_ID_ASUSTEK_T101HA_KEYBOARD), QUIRK_T101HA_DOCK },
1053         { HID_USB_DEVICE(USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_ASUS_AK1D) },
1054         { HID_USB_DEVICE(USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_ASUS_MD_5110) },
1055         { HID_USB_DEVICE(USB_VENDOR_ID_JESS, USB_DEVICE_ID_ASUS_MD_5112) },
1056         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK,
1057                 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD), QUIRK_T100CHI },
1058
1059         { }
1060 };
1061 MODULE_DEVICE_TABLE(hid, asus_devices);
1062
1063 static struct hid_driver asus_driver = {
1064         .name                   = "asus",
1065         .id_table               = asus_devices,
1066         .report_fixup           = asus_report_fixup,
1067         .probe                  = asus_probe,
1068         .remove                 = asus_remove,
1069         .input_mapping          = asus_input_mapping,
1070         .input_configured       = asus_input_configured,
1071 #ifdef CONFIG_PM
1072         .reset_resume           = asus_reset_resume,
1073 #endif
1074         .event                  = asus_event,
1075         .raw_event              = asus_raw_event
1076 };
1077 module_hid_driver(asus_driver);
1078
1079 MODULE_LICENSE("GPL");