Blame view

drivers/hid/hid-rmi.c 25.9 KB
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
  /*
   *  Copyright (c) 2013 Andrew Duggan <aduggan@synaptics.com>
   *  Copyright (c) 2013 Synaptics Incorporated
   *  Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@gmail.com>
   *  Copyright (c) 2014 Red Hat, Inc
   *
   * This program is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License as published by the Free
   * Software Foundation; either version 2 of the License, or (at your option)
   * any later version.
   */
  
  #include <linux/kernel.h>
  #include <linux/hid.h>
  #include <linux/input.h>
  #include <linux/input/mt.h>
  #include <linux/module.h>
  #include <linux/pm.h>
  #include <linux/slab.h>
  #include <linux/wait.h>
  #include <linux/sched.h>
  #include "hid-ids.h"
  
  #define RMI_MOUSE_REPORT_ID		0x01 /* Mouse emulation Report */
  #define RMI_WRITE_REPORT_ID		0x09 /* Output Report */
  #define RMI_READ_ADDR_REPORT_ID		0x0a /* Output Report */
  #define RMI_READ_DATA_REPORT_ID		0x0b /* Input Report */
  #define RMI_ATTN_REPORT_ID		0x0c /* Input Report */
  #define RMI_SET_RMI_MODE_REPORT_ID	0x0f /* Feature Report */
  
  /* flags */
  #define RMI_READ_REQUEST_PENDING	BIT(0)
  #define RMI_READ_DATA_PENDING		BIT(1)
  #define RMI_STARTED			BIT(2)
  
  enum rmi_mode_type {
  	RMI_MODE_OFF			= 0,
  	RMI_MODE_ATTN_REPORTS		= 1,
  	RMI_MODE_NO_PACKED_ATTN_REPORTS	= 2,
  };
  
  struct rmi_function {
  	unsigned page;			/* page of the function */
  	u16 query_base_addr;		/* base address for queries */
  	u16 command_base_addr;		/* base address for commands */
  	u16 control_base_addr;		/* base address for controls */
  	u16 data_base_addr;		/* base address for datas */
  	unsigned int interrupt_base;	/* cross-function interrupt number
  					 * (uniq in the device)*/
  	unsigned int interrupt_count;	/* number of interrupts */
  	unsigned int report_size;	/* size of a report */
  	unsigned long irq_mask;		/* mask of the interrupts
  					 * (to be applied against ATTN IRQ) */
  };
  
  /**
   * struct rmi_data - stores information for hid communication
   *
   * @page_mutex: Locks current page to avoid changing pages in unexpected ways.
   * @page: Keeps track of the current virtual page
   *
   * @wait: Used for waiting for read data
   *
   * @writeReport: output buffer when writing RMI registers
   * @readReport: input buffer when reading RMI registers
   *
   * @input_report_size: size of an input report (advertised by HID)
   * @output_report_size: size of an output report (advertised by HID)
   *
   * @flags: flags for the current device (started, reading, etc...)
   *
   * @f11: placeholder of internal RMI function F11 description
   * @f30: placeholder of internal RMI function F30 description
   *
   * @max_fingers: maximum finger count reported by the device
   * @max_x: maximum x value reported by the device
   * @max_y: maximum y value reported by the device
   *
   * @gpio_led_count: count of GPIOs + LEDs reported by F30
   * @button_count: actual physical buttons count
   * @button_mask: button mask used to decode GPIO ATTN reports
   * @button_state_mask: pull state of the buttons
   *
   * @input: pointer to the kernel input device
   *
   * @reset_work: worker which will be called in case of a mouse report
   * @hdev: pointer to the struct hid_device
   */
  struct rmi_data {
  	struct mutex page_mutex;
  	int page;
  
  	wait_queue_head_t wait;
  
  	u8 *writeReport;
  	u8 *readReport;
  
  	int input_report_size;
  	int output_report_size;
  
  	unsigned long flags;
  
  	struct rmi_function f11;
  	struct rmi_function f30;
  
  	unsigned int max_fingers;
  	unsigned int max_x;
  	unsigned int max_y;
  	unsigned int x_size_mm;
  	unsigned int y_size_mm;
  
  	unsigned int gpio_led_count;
  	unsigned int button_count;
  	unsigned long button_mask;
  	unsigned long button_state_mask;
  
  	struct input_dev *input;
  
  	struct work_struct reset_work;
  	struct hid_device *hdev;
  };
  
  #define RMI_PAGE(addr) (((addr) >> 8) & 0xff)
  
  static int rmi_write_report(struct hid_device *hdev, u8 *report, int len);
  
  /**
   * rmi_set_page - Set RMI page
   * @hdev: The pointer to the hid_device struct
   * @page: The new page address.
   *
   * RMI devices have 16-bit addressing, but some of the physical
   * implementations (like SMBus) only have 8-bit addressing. So RMI implements
   * a page address at 0xff of every page so we can reliable page addresses
   * every 256 registers.
   *
   * The page_mutex lock must be held when this function is entered.
   *
   * Returns zero on success, non-zero on failure.
   */
  static int rmi_set_page(struct hid_device *hdev, u8 page)
  {
  	struct rmi_data *data = hid_get_drvdata(hdev);
  	int retval;
  
  	data->writeReport[0] = RMI_WRITE_REPORT_ID;
  	data->writeReport[1] = 1;
  	data->writeReport[2] = 0xFF;
  	data->writeReport[4] = page;
  
  	retval = rmi_write_report(hdev, data->writeReport,
  			data->output_report_size);
  	if (retval != data->output_report_size) {
  		dev_err(&hdev->dev,
  			"%s: set page failed: %d.", __func__, retval);
  		return retval;
  	}
  
  	data->page = page;
  	return 0;
  }
  
  static int rmi_set_mode(struct hid_device *hdev, u8 mode)
  {
  	int ret;
  	u8 txbuf[2] = {RMI_SET_RMI_MODE_REPORT_ID, mode};
  
  	ret = hid_hw_raw_request(hdev, RMI_SET_RMI_MODE_REPORT_ID, txbuf,
  			sizeof(txbuf), HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
  	if (ret < 0) {
  		dev_err(&hdev->dev, "unable to set rmi mode to %d (%d)
  ", mode,
  			ret);
  		return ret;
  	}
  
  	return 0;
  }
  
  static int rmi_write_report(struct hid_device *hdev, u8 *report, int len)
  {
  	int ret;
  
  	ret = hid_hw_output_report(hdev, (void *)report, len);
  	if (ret < 0) {
  		dev_err(&hdev->dev, "failed to write hid report (%d)
  ", ret);
  		return ret;
  	}
  
  	return ret;
  }
  
  static int rmi_read_block(struct hid_device *hdev, u16 addr, void *buf,
  		const int len)
  {
  	struct rmi_data *data = hid_get_drvdata(hdev);
  	int ret;
  	int bytes_read;
  	int bytes_needed;
  	int retries;
  	int read_input_count;
  
  	mutex_lock(&data->page_mutex);
  
  	if (RMI_PAGE(addr) != data->page) {
  		ret = rmi_set_page(hdev, RMI_PAGE(addr));
  		if (ret < 0)
  			goto exit;
  	}
  
  	for (retries = 5; retries > 0; retries--) {
  		data->writeReport[0] = RMI_READ_ADDR_REPORT_ID;
  		data->writeReport[1] = 0; /* old 1 byte read count */
  		data->writeReport[2] = addr & 0xFF;
  		data->writeReport[3] = (addr >> 8) & 0xFF;
  		data->writeReport[4] = len  & 0xFF;
  		data->writeReport[5] = (len >> 8) & 0xFF;
  
  		set_bit(RMI_READ_REQUEST_PENDING, &data->flags);
  
  		ret = rmi_write_report(hdev, data->writeReport,
  						data->output_report_size);
  		if (ret != data->output_report_size) {
  			clear_bit(RMI_READ_REQUEST_PENDING, &data->flags);
  			dev_err(&hdev->dev,
  				"failed to write request output report (%d)
  ",
  				ret);
  			goto exit;
  		}
  
  		bytes_read = 0;
  		bytes_needed = len;
  		while (bytes_read < len) {
  			if (!wait_event_timeout(data->wait,
  				test_bit(RMI_READ_DATA_PENDING, &data->flags),
  					msecs_to_jiffies(1000))) {
  				hid_warn(hdev, "%s: timeout elapsed
  ",
  					 __func__);
  				ret = -EAGAIN;
  				break;
  			}
  
  			read_input_count = data->readReport[1];
  			memcpy(buf + bytes_read, &data->readReport[2],
  				read_input_count < bytes_needed ?
  					read_input_count : bytes_needed);
  
  			bytes_read += read_input_count;
  			bytes_needed -= read_input_count;
  			clear_bit(RMI_READ_DATA_PENDING, &data->flags);
  		}
  
  		if (ret >= 0) {
  			ret = 0;
  			break;
  		}
  	}
  
  exit:
  	clear_bit(RMI_READ_REQUEST_PENDING, &data->flags);
  	mutex_unlock(&data->page_mutex);
  	return ret;
  }
  
  static inline int rmi_read(struct hid_device *hdev, u16 addr, void *buf)
  {
  	return rmi_read_block(hdev, addr, buf, 1);
  }
  
  static void rmi_f11_process_touch(struct rmi_data *hdata, int slot,
  		u8 finger_state, u8 *touch_data)
  {
  	int x, y, wx, wy;
  	int wide, major, minor;
  	int z;
  
  	input_mt_slot(hdata->input, slot);
  	input_mt_report_slot_state(hdata->input, MT_TOOL_FINGER,
  			finger_state == 0x01);
  	if (finger_state == 0x01) {
876e7a8a1   Andrew Duggan   HID: rmi: fix mas...
284
  		x = (touch_data[0] << 4) | (touch_data[2] & 0x0F);
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
285
  		y = (touch_data[1] << 4) | (touch_data[2] >> 4);
876e7a8a1   Andrew Duggan   HID: rmi: fix mas...
286
  		wx = touch_data[3] & 0x0F;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
  		wy = touch_data[3] >> 4;
  		wide = (wx > wy);
  		major = max(wx, wy);
  		minor = min(wx, wy);
  		z = touch_data[4];
  
  		/* y is inverted */
  		y = hdata->max_y - y;
  
  		input_event(hdata->input, EV_ABS, ABS_MT_POSITION_X, x);
  		input_event(hdata->input, EV_ABS, ABS_MT_POSITION_Y, y);
  		input_event(hdata->input, EV_ABS, ABS_MT_ORIENTATION, wide);
  		input_event(hdata->input, EV_ABS, ABS_MT_PRESSURE, z);
  		input_event(hdata->input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
  		input_event(hdata->input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
  	}
  }
  
  static void rmi_reset_work(struct work_struct *work)
  {
  	struct rmi_data *hdata = container_of(work, struct rmi_data,
  						reset_work);
  
  	/* switch the device to RMI if we receive a generic mouse report */
  	rmi_set_mode(hdata->hdev, RMI_MODE_ATTN_REPORTS);
  }
  
  static inline int rmi_schedule_reset(struct hid_device *hdev)
  {
  	struct rmi_data *hdata = hid_get_drvdata(hdev);
  	return schedule_work(&hdata->reset_work);
  }
  
  static int rmi_f11_input_event(struct hid_device *hdev, u8 irq, u8 *data,
  		int size)
  {
  	struct rmi_data *hdata = hid_get_drvdata(hdev);
  	int offset;
  	int i;
5b65c2a02   Benjamin Tissoires   HID: rmi: check s...
326
  	if (!(irq & hdata->f11.irq_mask) || size <= 0)
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
327
328
329
330
331
332
333
334
  		return 0;
  
  	offset = (hdata->max_fingers >> 2) + 1;
  	for (i = 0; i < hdata->max_fingers; i++) {
  		int fs_byte_position = i >> 2;
  		int fs_bit_position = (i & 0x3) << 1;
  		int finger_state = (data[fs_byte_position] >> fs_bit_position) &
  					0x03;
5b65c2a02   Benjamin Tissoires   HID: rmi: check s...
335
336
337
338
339
340
341
342
343
344
345
346
347
  		int position = offset + 5 * i;
  
  		if (position + 5 > size) {
  			/* partial report, go on with what we received */
  			printk_once(KERN_WARNING
  				"%s %s: Detected incomplete finger report. Finger reports may occasionally get dropped on this platform.
  ",
  				 dev_driver_string(&hdev->dev),
  				 dev_name(&hdev->dev));
  			hid_dbg(hdev, "Incomplete finger report
  ");
  			break;
  		}
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
348

5b65c2a02   Benjamin Tissoires   HID: rmi: check s...
349
  		rmi_f11_process_touch(hdata, i, finger_state, &data[position]);
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
  	}
  	input_mt_sync_frame(hdata->input);
  	input_sync(hdata->input);
  	return hdata->f11.report_size;
  }
  
  static int rmi_f30_input_event(struct hid_device *hdev, u8 irq, u8 *data,
  		int size)
  {
  	struct rmi_data *hdata = hid_get_drvdata(hdev);
  	int i;
  	int button = 0;
  	bool value;
  
  	if (!(irq & hdata->f30.irq_mask))
  		return 0;
5b65c2a02   Benjamin Tissoires   HID: rmi: check s...
366
367
368
369
370
  	if (size < (int)hdata->f30.report_size) {
  		hid_warn(hdev, "Click Button pressed, but the click data is missing
  ");
  		return 0;
  	}
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
  	for (i = 0; i < hdata->gpio_led_count; i++) {
  		if (test_bit(i, &hdata->button_mask)) {
  			value = (data[i / 8] >> (i & 0x07)) & BIT(0);
  			if (test_bit(i, &hdata->button_state_mask))
  				value = !value;
  			input_event(hdata->input, EV_KEY, BTN_LEFT + button++,
  					value);
  		}
  	}
  	return hdata->f30.report_size;
  }
  
  static int rmi_input_event(struct hid_device *hdev, u8 *data, int size)
  {
  	struct rmi_data *hdata = hid_get_drvdata(hdev);
  	unsigned long irq_mask = 0;
  	unsigned index = 2;
  
  	if (!(test_bit(RMI_STARTED, &hdata->flags)))
  		return 0;
  
  	irq_mask |= hdata->f11.irq_mask;
  	irq_mask |= hdata->f30.irq_mask;
  
  	if (data[1] & ~irq_mask)
01a5f8a40   Andrew Duggan   HID: rmi: change ...
396
397
  		hid_dbg(hdev, "unknown intr source:%02lx %s:%d
  ",
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
  			data[1] & ~irq_mask, __FILE__, __LINE__);
  
  	if (hdata->f11.interrupt_base < hdata->f30.interrupt_base) {
  		index += rmi_f11_input_event(hdev, data[1], &data[index],
  				size - index);
  		index += rmi_f30_input_event(hdev, data[1], &data[index],
  				size - index);
  	} else {
  		index += rmi_f30_input_event(hdev, data[1], &data[index],
  				size - index);
  		index += rmi_f11_input_event(hdev, data[1], &data[index],
  				size - index);
  	}
  
  	return 1;
  }
  
  static int rmi_read_data_event(struct hid_device *hdev, u8 *data, int size)
  {
  	struct rmi_data *hdata = hid_get_drvdata(hdev);
  
  	if (!test_bit(RMI_READ_REQUEST_PENDING, &hdata->flags)) {
01a5f8a40   Andrew Duggan   HID: rmi: change ...
420
421
  		hid_dbg(hdev, "no read request pending
  ");
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
422
423
424
425
426
427
428
429
430
431
  		return 0;
  	}
  
  	memcpy(hdata->readReport, data, size < hdata->input_report_size ?
  			size : hdata->input_report_size);
  	set_bit(RMI_READ_DATA_PENDING, &hdata->flags);
  	wake_up(&hdata->wait);
  
  	return 1;
  }
5b65c2a02   Benjamin Tissoires   HID: rmi: check s...
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
  static int rmi_check_sanity(struct hid_device *hdev, u8 *data, int size)
  {
  	int valid_size = size;
  	/*
  	 * On the Dell XPS 13 9333, the bus sometimes get confused and fills
  	 * the report with a sentinel value "ff". Synaptics told us that such
  	 * behavior does not comes from the touchpad itself, so we filter out
  	 * such reports here.
  	 */
  
  	while ((data[valid_size - 1] == 0xff) && valid_size > 0)
  		valid_size--;
  
  	return valid_size;
  }
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
447
448
449
  static int rmi_raw_event(struct hid_device *hdev,
  		struct hid_report *report, u8 *data, int size)
  {
5b65c2a02   Benjamin Tissoires   HID: rmi: check s...
450
451
452
  	size = rmi_check_sanity(hdev, data, size);
  	if (size < 2)
  		return 0;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
453
454
455
456
457
458
459
460
461
462
463
464
  	switch (data[0]) {
  	case RMI_READ_DATA_REPORT_ID:
  		return rmi_read_data_event(hdev, data, size);
  	case RMI_ATTN_REPORT_ID:
  		return rmi_input_event(hdev, data, size);
  	case RMI_MOUSE_REPORT_ID:
  		rmi_schedule_reset(hdev);
  		break;
  	}
  
  	return 0;
  }
a278e2683   Geert Uytterhoeven   HID: rmi: Protect...
465
  #ifdef CONFIG_PM
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
466
467
468
469
470
471
472
473
474
  static int rmi_post_reset(struct hid_device *hdev)
  {
  	return rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
  }
  
  static int rmi_post_resume(struct hid_device *hdev)
  {
  	return rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
  }
a278e2683   Geert Uytterhoeven   HID: rmi: Protect...
475
  #endif /* CONFIG_PM */
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
  
  #define RMI4_MAX_PAGE 0xff
  #define RMI4_PAGE_SIZE 0x0100
  
  #define PDT_START_SCAN_LOCATION 0x00e9
  #define PDT_END_SCAN_LOCATION	0x0005
  #define RMI4_END_OF_PDT(id) ((id) == 0x00 || (id) == 0xff)
  
  struct pdt_entry {
  	u8 query_base_addr:8;
  	u8 command_base_addr:8;
  	u8 control_base_addr:8;
  	u8 data_base_addr:8;
  	u8 interrupt_source_count:3;
  	u8 bits3and4:2;
  	u8 function_version:2;
  	u8 bit7:1;
  	u8 function_number:8;
  } __attribute__((__packed__));
  
  static inline unsigned long rmi_gen_mask(unsigned irq_base, unsigned irq_count)
  {
  	return GENMASK(irq_count + irq_base - 1, irq_base);
  }
  
  static void rmi_register_function(struct rmi_data *data,
  	struct pdt_entry *pdt_entry, int page, unsigned interrupt_count)
  {
  	struct rmi_function *f = NULL;
  	u16 page_base = page << 8;
  
  	switch (pdt_entry->function_number) {
  	case 0x11:
  		f = &data->f11;
  		break;
  	case 0x30:
  		f = &data->f30;
  		break;
  	}
  
  	if (f) {
  		f->page = page;
  		f->query_base_addr = page_base | pdt_entry->query_base_addr;
  		f->command_base_addr = page_base | pdt_entry->command_base_addr;
  		f->control_base_addr = page_base | pdt_entry->control_base_addr;
  		f->data_base_addr = page_base | pdt_entry->data_base_addr;
  		f->interrupt_base = interrupt_count;
  		f->interrupt_count = pdt_entry->interrupt_source_count;
  		f->irq_mask = rmi_gen_mask(f->interrupt_base,
  						f->interrupt_count);
  	}
  }
  
  static int rmi_scan_pdt(struct hid_device *hdev)
  {
  	struct rmi_data *data = hid_get_drvdata(hdev);
  	struct pdt_entry entry;
  	int page;
  	bool page_has_function;
  	int i;
  	int retval;
  	int interrupt = 0;
  	u16 page_start, pdt_start , pdt_end;
  
  	hid_info(hdev, "Scanning PDT...
  ");
  
  	for (page = 0; (page <= RMI4_MAX_PAGE); page++) {
  		page_start = RMI4_PAGE_SIZE * page;
  		pdt_start = page_start + PDT_START_SCAN_LOCATION;
  		pdt_end = page_start + PDT_END_SCAN_LOCATION;
  
  		page_has_function = false;
  		for (i = pdt_start; i >= pdt_end; i -= sizeof(entry)) {
  			retval = rmi_read_block(hdev, i, &entry, sizeof(entry));
  			if (retval) {
  				hid_err(hdev,
  					"Read of PDT entry at %#06x failed.
  ",
  					i);
  				goto error_exit;
  			}
  
  			if (RMI4_END_OF_PDT(entry.function_number))
  				break;
  
  			page_has_function = true;
  
  			hid_info(hdev, "Found F%02X on page %#04x
  ",
  					entry.function_number, page);
  
  			rmi_register_function(data, &entry, page, interrupt);
  			interrupt += entry.interrupt_source_count;
  		}
  
  		if (!page_has_function)
  			break;
  	}
  
  	hid_info(hdev, "%s: Done with PDT scan.
  ", __func__);
  	retval = 0;
  
  error_exit:
  	return retval;
  }
  
  static int rmi_populate_f11(struct hid_device *hdev)
  {
  	struct rmi_data *data = hid_get_drvdata(hdev);
  	u8 buf[20];
  	int ret;
f15475c39   Andrew Duggan   HID: rmi: check f...
589
  	bool has_query9;
9e2c327ee   Andrew Duggan   HID: rmi: make co...
590
  	bool has_query10 = false;
f15475c39   Andrew Duggan   HID: rmi: check f...
591
  	bool has_query11;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
592
  	bool has_query12;
427a5746b   Andrew Duggan   HID: rmi: Check f...
593
594
595
  	bool has_query27;
  	bool has_query28;
  	bool has_query36 = false;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
596
  	bool has_physical_props;
9e2c327ee   Andrew Duggan   HID: rmi: make co...
597
598
  	bool has_gestures;
  	bool has_rel;
427a5746b   Andrew Duggan   HID: rmi: Check f...
599
  	bool has_data40 = false;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
600
  	unsigned x_size, y_size;
427a5746b   Andrew Duggan   HID: rmi: Check f...
601
  	u16 query_offset;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
602
603
604
605
606
607
608
609
610
611
612
613
614
615
  
  	if (!data->f11.query_base_addr) {
  		hid_err(hdev, "No 2D sensor found, giving up.
  ");
  		return -ENODEV;
  	}
  
  	/* query 0 contains some useful information */
  	ret = rmi_read(hdev, data->f11.query_base_addr, buf);
  	if (ret) {
  		hid_err(hdev, "can not get query 0: %d.
  ", ret);
  		return ret;
  	}
f15475c39   Andrew Duggan   HID: rmi: check f...
616
617
  	has_query9 = !!(buf[0] & BIT(3));
  	has_query11 = !!(buf[0] & BIT(4));
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
618
  	has_query12 = !!(buf[0] & BIT(5));
427a5746b   Andrew Duggan   HID: rmi: Check f...
619
620
  	has_query27 = !!(buf[0] & BIT(6));
  	has_query28 = !!(buf[0] & BIT(7));
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
  
  	/* query 1 to get the max number of fingers */
  	ret = rmi_read(hdev, data->f11.query_base_addr + 1, buf);
  	if (ret) {
  		hid_err(hdev, "can not get NumberOfFingers: %d.
  ", ret);
  		return ret;
  	}
  	data->max_fingers = (buf[0] & 0x07) + 1;
  	if (data->max_fingers > 5)
  		data->max_fingers = 10;
  
  	data->f11.report_size = data->max_fingers * 5 +
  				DIV_ROUND_UP(data->max_fingers, 4);
  
  	if (!(buf[0] & BIT(4))) {
  		hid_err(hdev, "No absolute events, giving up.
  ");
  		return -ENODEV;
  	}
9e2c327ee   Andrew Duggan   HID: rmi: make co...
641
642
643
644
645
646
647
648
649
650
651
652
653
  	has_rel = !!(buf[0] & BIT(3));
  	has_gestures = !!(buf[0] & BIT(5));
  
  	if (has_gestures) {
  		/* query 8 to find out if query 10 exists */
  		ret = rmi_read(hdev, data->f11.query_base_addr + 8, buf);
  		if (ret) {
  			hid_err(hdev, "can not read gesture information: %d.
  ",
  				ret);
  			return ret;
  		}
  		has_query10 = !!(buf[0] & BIT(2));
f15475c39   Andrew Duggan   HID: rmi: check f...
654
  	}
f15475c39   Andrew Duggan   HID: rmi: check f...
655

9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
656
  	/*
9e2c327ee   Andrew Duggan   HID: rmi: make co...
657
658
659
  	 * At least 4 queries are guaranteed to be present in F11
  	 * +1 for query 5 which is present since absolute events are
  	 * reported and +1 for query 12.
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
660
  	 */
427a5746b   Andrew Duggan   HID: rmi: Check f...
661
  	query_offset = 6;
9e2c327ee   Andrew Duggan   HID: rmi: make co...
662
663
  
  	if (has_rel)
427a5746b   Andrew Duggan   HID: rmi: Check f...
664
  		++query_offset; /* query 6 is present */
9e2c327ee   Andrew Duggan   HID: rmi: make co...
665
666
  
  	if (has_gestures)
427a5746b   Andrew Duggan   HID: rmi: Check f...
667
  		query_offset += 2; /* query 7 and 8 are present */
f15475c39   Andrew Duggan   HID: rmi: check f...
668
669
  
  	if (has_query9)
427a5746b   Andrew Duggan   HID: rmi: Check f...
670
  		++query_offset;
f15475c39   Andrew Duggan   HID: rmi: check f...
671
672
  
  	if (has_query10)
427a5746b   Andrew Duggan   HID: rmi: Check f...
673
  		++query_offset;
f15475c39   Andrew Duggan   HID: rmi: check f...
674
675
  
  	if (has_query11)
427a5746b   Andrew Duggan   HID: rmi: Check f...
676
  		++query_offset;
f15475c39   Andrew Duggan   HID: rmi: check f...
677
678
  
  	/* query 12 to know if the physical properties are reported */
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
679
  	if (has_query12) {
f15475c39   Andrew Duggan   HID: rmi: check f...
680
  		ret = rmi_read(hdev, data->f11.query_base_addr
427a5746b   Andrew Duggan   HID: rmi: Check f...
681
  				+ query_offset, buf);
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
682
683
684
685
686
687
688
689
  		if (ret) {
  			hid_err(hdev, "can not get query 12: %d.
  ", ret);
  			return ret;
  		}
  		has_physical_props = !!(buf[0] & BIT(5));
  
  		if (has_physical_props) {
427a5746b   Andrew Duggan   HID: rmi: Check f...
690
  			query_offset += 1;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
691
  			ret = rmi_read_block(hdev,
f15475c39   Andrew Duggan   HID: rmi: check f...
692
  					data->f11.query_base_addr
427a5746b   Andrew Duggan   HID: rmi: Check f...
693
  						+ query_offset, buf, 4);
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
  			if (ret) {
  				hid_err(hdev, "can not read query 15-18: %d.
  ",
  					ret);
  				return ret;
  			}
  
  			x_size = buf[0] | (buf[1] << 8);
  			y_size = buf[2] | (buf[3] << 8);
  
  			data->x_size_mm = DIV_ROUND_CLOSEST(x_size, 10);
  			data->y_size_mm = DIV_ROUND_CLOSEST(y_size, 10);
  
  			hid_info(hdev, "%s: size in mm: %d x %d
  ",
  				 __func__, data->x_size_mm, data->y_size_mm);
427a5746b   Andrew Duggan   HID: rmi: Check f...
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
  
  			/*
  			 * query 15 - 18 contain the size of the sensor
  			 * and query 19 - 26 contain bezel dimensions
  			 */
  			query_offset += 12;
  		}
  	}
  
  	if (has_query27)
  		++query_offset;
  
  	if (has_query28) {
  		ret = rmi_read(hdev, data->f11.query_base_addr
  				+ query_offset, buf);
  		if (ret) {
  			hid_err(hdev, "can not get query 28: %d.
  ", ret);
  			return ret;
  		}
  
  		has_query36 = !!(buf[0] & BIT(6));
  	}
  
  	if (has_query36) {
  		query_offset += 2;
  		ret = rmi_read(hdev, data->f11.query_base_addr
  				+ query_offset, buf);
  		if (ret) {
  			hid_err(hdev, "can not get query 36: %d.
  ", ret);
  			return ret;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
742
  		}
427a5746b   Andrew Duggan   HID: rmi: Check f...
743
744
  
  		has_data40 = !!(buf[0] & BIT(5));
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
745
  	}
427a5746b   Andrew Duggan   HID: rmi: Check f...
746
747
748
  
  	if (has_data40)
  		data->f11.report_size += data->max_fingers * 2;
dcce58379   Benjamin Tissoires   HID: rmi: do not ...
749
750
751
752
753
754
755
  	/*
  	 * retrieve the ctrl registers
  	 * the ctrl register has a size of 20 but a fw bug split it into 16 + 4,
  	 * and there is no way to know if the first 20 bytes are here or not.
  	 * We use only the first 10 bytes, so get only them.
  	 */
  	ret = rmi_read_block(hdev, data->f11.control_base_addr, buf, 10);
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
756
  	if (ret) {
dcce58379   Benjamin Tissoires   HID: rmi: do not ...
757
758
  		hid_err(hdev, "can not read ctrl block of size 10: %d.
  ", ret);
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
  		return ret;
  	}
  
  	data->max_x = buf[6] | (buf[7] << 8);
  	data->max_y = buf[8] | (buf[9] << 8);
  
  	return 0;
  }
  
  static int rmi_populate_f30(struct hid_device *hdev)
  {
  	struct rmi_data *data = hid_get_drvdata(hdev);
  	u8 buf[20];
  	int ret;
  	bool has_gpio, has_led;
  	unsigned bytes_per_ctrl;
  	u8 ctrl2_addr;
  	int ctrl2_3_length;
  	int i;
  
  	/* function F30 is for physical buttons */
  	if (!data->f30.query_base_addr) {
  		hid_err(hdev, "No GPIO/LEDs found, giving up.
  ");
  		return -ENODEV;
  	}
  
  	ret = rmi_read_block(hdev, data->f30.query_base_addr, buf, 2);
  	if (ret) {
  		hid_err(hdev, "can not get F30 query registers: %d.
  ", ret);
  		return ret;
  	}
  
  	has_gpio = !!(buf[0] & BIT(3));
  	has_led = !!(buf[0] & BIT(2));
  	data->gpio_led_count = buf[1] & 0x1f;
  
  	/* retrieve ctrl 2 & 3 registers */
  	bytes_per_ctrl = (data->gpio_led_count + 7) / 8;
  	/* Ctrl0 is present only if both has_gpio and has_led are set*/
  	ctrl2_addr = (has_gpio && has_led) ? bytes_per_ctrl : 0;
  	/* Ctrl1 is always be present */
  	ctrl2_addr += bytes_per_ctrl;
  	ctrl2_3_length = 2 * bytes_per_ctrl;
  
  	data->f30.report_size = bytes_per_ctrl;
  
  	ret = rmi_read_block(hdev, data->f30.control_base_addr + ctrl2_addr,
  				buf, ctrl2_3_length);
  	if (ret) {
  		hid_err(hdev, "can not read ctrl 2&3 block of size %d: %d.
  ",
  			ctrl2_3_length, ret);
  		return ret;
  	}
  
  	for (i = 0; i < data->gpio_led_count; i++) {
  		int byte_position = i >> 3;
  		int bit_position = i & 0x07;
  		u8 dir_byte = buf[byte_position];
  		u8 data_byte = buf[byte_position + bytes_per_ctrl];
  		bool dir = (dir_byte >> bit_position) & BIT(0);
  		bool dat = (data_byte >> bit_position) & BIT(0);
  
  		if (dir == 0) {
  			/* input mode */
  			if (dat) {
  				/* actual buttons have pull up resistor */
  				data->button_count++;
  				set_bit(i, &data->button_mask);
  				set_bit(i, &data->button_state_mask);
  			}
  		}
  
  	}
  
  	return 0;
  }
  
  static int rmi_populate(struct hid_device *hdev)
  {
  	int ret;
  
  	ret = rmi_scan_pdt(hdev);
  	if (ret) {
  		hid_err(hdev, "PDT scan failed with code %d.
  ", ret);
  		return ret;
  	}
  
  	ret = rmi_populate_f11(hdev);
  	if (ret) {
  		hid_err(hdev, "Error while initializing F11 (%d).
  ", ret);
  		return ret;
  	}
  
  	ret = rmi_populate_f30(hdev);
  	if (ret)
  		hid_warn(hdev, "Error while initializing F30 (%d).
  ", ret);
  
  	return 0;
  }
  
  static void rmi_input_configured(struct hid_device *hdev, struct hid_input *hi)
  {
  	struct rmi_data *data = hid_get_drvdata(hdev);
  	struct input_dev *input = hi->input;
  	int ret;
  	int res_x, res_y, i;
  
  	data->input = input;
  
  	hid_dbg(hdev, "Opening low level driver
  ");
  	ret = hid_hw_open(hdev);
  	if (ret)
  		return;
  
  	/* Allow incoming hid reports */
  	hid_device_io_start(hdev);
  
  	ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
  	if (ret < 0) {
  		dev_err(&hdev->dev, "failed to set rmi mode
  ");
  		goto exit;
  	}
  
  	ret = rmi_set_page(hdev, 0);
  	if (ret < 0) {
  		dev_err(&hdev->dev, "failed to set page select to 0.
  ");
  		goto exit;
  	}
  
  	ret = rmi_populate(hdev);
  	if (ret)
  		goto exit;
  
  	__set_bit(EV_ABS, input->evbit);
  	input_set_abs_params(input, ABS_MT_POSITION_X, 1, data->max_x, 0, 0);
  	input_set_abs_params(input, ABS_MT_POSITION_Y, 1, data->max_y, 0, 0);
b668fdce4   Jiri Kosina   HID: rmi: fix wro...
904
  	if (data->x_size_mm && data->y_size_mm) {
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
905
  		res_x = (data->max_x - 1) / data->x_size_mm;
b668fdce4   Jiri Kosina   HID: rmi: fix wro...
906
  		res_y = (data->max_y - 1) / data->y_size_mm;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
  
  		input_abs_set_res(input, ABS_MT_POSITION_X, res_x);
  		input_abs_set_res(input, ABS_MT_POSITION_Y, res_y);
  	}
  
  	input_set_abs_params(input, ABS_MT_ORIENTATION, 0, 1, 0, 0);
  	input_set_abs_params(input, ABS_MT_PRESSURE, 0, 0xff, 0, 0);
  	input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 0x0f, 0, 0);
  	input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 0x0f, 0, 0);
  
  	input_mt_init_slots(input, data->max_fingers, INPUT_MT_POINTER);
  
  	if (data->button_count) {
  		__set_bit(EV_KEY, input->evbit);
  		for (i = 0; i < data->button_count; i++)
  			__set_bit(BTN_LEFT + i, input->keybit);
  
  		if (data->button_count == 1)
  			__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
  	}
  
  	set_bit(RMI_STARTED, &data->flags);
  
  exit:
  	hid_device_io_stop(hdev);
  	hid_hw_close(hdev);
  }
  
  static int rmi_input_mapping(struct hid_device *hdev,
  		struct hid_input *hi, struct hid_field *field,
  		struct hid_usage *usage, unsigned long **bit, int *max)
  {
  	/* we want to make HID ignore the advertised HID collection */
  	return -1;
  }
  
  static int rmi_probe(struct hid_device *hdev, const struct hid_device_id *id)
  {
  	struct rmi_data *data = NULL;
  	int ret;
  	size_t alloc_size;
dd3edeb6a   Andrew Duggan   HID: rmi: check t...
948
949
  	struct hid_report *input_report;
  	struct hid_report *output_report;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
  
  	data = devm_kzalloc(&hdev->dev, sizeof(struct rmi_data), GFP_KERNEL);
  	if (!data)
  		return -ENOMEM;
  
  	INIT_WORK(&data->reset_work, rmi_reset_work);
  	data->hdev = hdev;
  
  	hid_set_drvdata(hdev, data);
  
  	hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
  
  	ret = hid_parse(hdev);
  	if (ret) {
  		hid_err(hdev, "parse failed
  ");
  		return ret;
  	}
dd3edeb6a   Andrew Duggan   HID: rmi: check t...
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
  	input_report = hdev->report_enum[HID_INPUT_REPORT]
  			.report_id_hash[RMI_ATTN_REPORT_ID];
  	if (!input_report) {
  		hid_err(hdev, "device does not have expected input report
  ");
  		ret = -ENODEV;
  		return ret;
  	}
  
  	data->input_report_size = (input_report->size >> 3) + 1 /* report id */;
  
  	output_report = hdev->report_enum[HID_OUTPUT_REPORT]
  			.report_id_hash[RMI_WRITE_REPORT_ID];
  	if (!output_report) {
  		hid_err(hdev, "device does not have expected output report
  ");
  		ret = -ENODEV;
  		return ret;
  	}
  
  	data->output_report_size = (output_report->size >> 3)
  					+ 1 /* report id */;
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
  
  	alloc_size = data->output_report_size + data->input_report_size;
  
  	data->writeReport = devm_kzalloc(&hdev->dev, alloc_size, GFP_KERNEL);
  	if (!data->writeReport) {
  		ret = -ENOMEM;
  		return ret;
  	}
  
  	data->readReport = data->writeReport + data->output_report_size;
  
  	init_waitqueue_head(&data->wait);
  
  	mutex_init(&data->page_mutex);
  
  	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
  	if (ret) {
  		hid_err(hdev, "hw start failed
  ");
  		return ret;
  	}
daebdd7ee   Andrew Duggan   HID: rmi: print a...
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
  	if (!test_bit(RMI_STARTED, &data->flags))
  		/*
  		 * The device maybe in the bootloader if rmi_input_configured
  		 * failed to find F11 in the PDT. Print an error, but don't
  		 * return an error from rmi_probe so that hidraw will be
  		 * accessible from userspace. That way a userspace tool
  		 * can be used to reload working firmware on the touchpad.
  		 */
  		hid_err(hdev, "Device failed to be properly configured
  ");
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
1021

9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
  	return 0;
  }
  
  static void rmi_remove(struct hid_device *hdev)
  {
  	struct rmi_data *hdata = hid_get_drvdata(hdev);
  
  	clear_bit(RMI_STARTED, &hdata->flags);
  
  	hid_hw_stop(hdev);
  }
  
  static const struct hid_device_id rmi_id[] = {
ba391e5a5   Benjamin Tissoires   HID: rmi: do not ...
1035
  	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_RMI, HID_ANY_ID, HID_ANY_ID) },
9fb6bf02e   Benjamin Tissoires   HID: rmi: introdu...
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
  	{ }
  };
  MODULE_DEVICE_TABLE(hid, rmi_id);
  
  static struct hid_driver rmi_driver = {
  	.name = "hid-rmi",
  	.id_table		= rmi_id,
  	.probe			= rmi_probe,
  	.remove			= rmi_remove,
  	.raw_event		= rmi_raw_event,
  	.input_mapping		= rmi_input_mapping,
  	.input_configured	= rmi_input_configured,
  #ifdef CONFIG_PM
  	.resume			= rmi_post_resume,
  	.reset_resume		= rmi_post_reset,
  #endif
  };
  
  module_hid_driver(rmi_driver);
  
  MODULE_AUTHOR("Andrew Duggan <aduggan@synaptics.com>");
  MODULE_DESCRIPTION("RMI HID driver");
  MODULE_LICENSE("GPL");