Linux Audio

Check our new training course

Loading...
v6.8
  1// SPDX-License-Identifier: GPL-2.0-or-later
  2/*
  3 *  Copyright (c) 2013 Andrew Duggan <aduggan@synaptics.com>
  4 *  Copyright (c) 2013 Synaptics Incorporated
  5 *  Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@gmail.com>
  6 *  Copyright (c) 2014 Red Hat, Inc
 
 
 
 
 
  7 */
  8
  9#include <linux/kernel.h>
 10#include <linux/hid.h>
 11#include <linux/input.h>
 12#include <linux/input/mt.h>
 13#include <linux/irq.h>
 14#include <linux/irqdomain.h>
 15#include <linux/module.h>
 16#include <linux/pm.h>
 17#include <linux/slab.h>
 18#include <linux/wait.h>
 19#include <linux/sched.h>
 20#include <linux/rmi.h>
 21#include "hid-ids.h"
 22
 23#define RMI_MOUSE_REPORT_ID		0x01 /* Mouse emulation Report */
 24#define RMI_WRITE_REPORT_ID		0x09 /* Output Report */
 25#define RMI_READ_ADDR_REPORT_ID		0x0a /* Output Report */
 26#define RMI_READ_DATA_REPORT_ID		0x0b /* Input Report */
 27#define RMI_ATTN_REPORT_ID		0x0c /* Input Report */
 28#define RMI_SET_RMI_MODE_REPORT_ID	0x0f /* Feature Report */
 29
 30/* flags */
 31#define RMI_READ_REQUEST_PENDING	0
 32#define RMI_READ_DATA_PENDING		1
 33#define RMI_STARTED			2
 34
 35/* device flags */
 36#define RMI_DEVICE			BIT(0)
 37#define RMI_DEVICE_HAS_PHYS_BUTTONS	BIT(1)
 38#define RMI_DEVICE_OUTPUT_SET_REPORT	BIT(2)
 39
 40/*
 41 * retrieve the ctrl registers
 42 * the ctrl register has a size of 20 but a fw bug split it into 16 + 4,
 43 * and there is no way to know if the first 20 bytes are here or not.
 44 * We use only the first 12 bytes, so get only them.
 45 */
 46#define RMI_F11_CTRL_REG_COUNT		12
 47
 48enum rmi_mode_type {
 49	RMI_MODE_OFF			= 0,
 50	RMI_MODE_ATTN_REPORTS		= 1,
 51	RMI_MODE_NO_PACKED_ATTN_REPORTS	= 2,
 52};
 53
 54/**
 55 * struct rmi_data - stores information for hid communication
 56 *
 57 * @page_mutex: Locks current page to avoid changing pages in unexpected ways.
 58 * @page: Keeps track of the current virtual page
 59 * @xport: transport device to be registered with the RMI4 core.
 60 *
 61 * @wait: Used for waiting for read data
 62 *
 63 * @writeReport: output buffer when writing RMI registers
 64 * @readReport: input buffer when reading RMI registers
 65 *
 66 * @input_report_size: size of an input report (advertised by HID)
 67 * @output_report_size: size of an output report (advertised by HID)
 68 *
 69 * @flags: flags for the current device (started, reading, etc...)
 70 *
 71 * @reset_work: worker which will be called in case of a mouse report
 72 * @hdev: pointer to the struct hid_device
 73 *
 74 * @device_flags: flags which describe the device
 75 *
 76 * @domain: the IRQ domain allocated for this RMI4 device
 77 * @rmi_irq: the irq that will be used to generate events to rmi-core
 78 */
 79struct rmi_data {
 80	struct mutex page_mutex;
 81	int page;
 82	struct rmi_transport_dev xport;
 83
 84	wait_queue_head_t wait;
 85
 86	u8 *writeReport;
 87	u8 *readReport;
 88
 89	u32 input_report_size;
 90	u32 output_report_size;
 91
 92	unsigned long flags;
 93
 94	struct work_struct reset_work;
 95	struct hid_device *hdev;
 96
 97	unsigned long device_flags;
 98
 99	struct irq_domain *domain;
100	int rmi_irq;
101};
102
103#define RMI_PAGE(addr) (((addr) >> 8) & 0xff)
104
105static int rmi_write_report(struct hid_device *hdev, u8 *report, int len);
106
107/**
108 * rmi_set_page - Set RMI page
109 * @hdev: The pointer to the hid_device struct
110 * @page: The new page address.
111 *
112 * RMI devices have 16-bit addressing, but some of the physical
113 * implementations (like SMBus) only have 8-bit addressing. So RMI implements
114 * a page address at 0xff of every page so we can reliable page addresses
115 * every 256 registers.
116 *
117 * The page_mutex lock must be held when this function is entered.
118 *
119 * Returns zero on success, non-zero on failure.
120 */
121static int rmi_set_page(struct hid_device *hdev, u8 page)
122{
123	struct rmi_data *data = hid_get_drvdata(hdev);
124	int retval;
125
126	data->writeReport[0] = RMI_WRITE_REPORT_ID;
127	data->writeReport[1] = 1;
128	data->writeReport[2] = 0xFF;
129	data->writeReport[4] = page;
130
131	retval = rmi_write_report(hdev, data->writeReport,
132			data->output_report_size);
133	if (retval != data->output_report_size) {
134		dev_err(&hdev->dev,
135			"%s: set page failed: %d.", __func__, retval);
136		return retval;
137	}
138
139	data->page = page;
140	return 0;
141}
142
143static int rmi_set_mode(struct hid_device *hdev, u8 mode)
144{
145	int ret;
146	const u8 txbuf[2] = {RMI_SET_RMI_MODE_REPORT_ID, mode};
147	u8 *buf;
148
149	buf = kmemdup(txbuf, sizeof(txbuf), GFP_KERNEL);
150	if (!buf)
151		return -ENOMEM;
152
153	ret = hid_hw_raw_request(hdev, RMI_SET_RMI_MODE_REPORT_ID, buf,
154			sizeof(txbuf), HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
155	kfree(buf);
156	if (ret < 0) {
157		dev_err(&hdev->dev, "unable to set rmi mode to %d (%d)\n", mode,
158			ret);
159		return ret;
160	}
161
162	return 0;
163}
164
165static int rmi_write_report(struct hid_device *hdev, u8 *report, int len)
166{
167	struct rmi_data *data = hid_get_drvdata(hdev);
168	int ret;
169
170	if (data->device_flags & RMI_DEVICE_OUTPUT_SET_REPORT) {
171		/*
172		 * Talk to device by using SET_REPORT requests instead.
173		 */
174		ret = hid_hw_raw_request(hdev, report[0], report,
175				len, HID_OUTPUT_REPORT, HID_REQ_SET_REPORT);
176	} else {
177		ret = hid_hw_output_report(hdev, (void *)report, len);
178	}
179
180	if (ret < 0) {
181		dev_err(&hdev->dev, "failed to write hid report (%d)\n", ret);
182		return ret;
183	}
184
185	return ret;
186}
187
188static int rmi_hid_read_block(struct rmi_transport_dev *xport, u16 addr,
189		void *buf, size_t len)
190{
191	struct rmi_data *data = container_of(xport, struct rmi_data, xport);
192	struct hid_device *hdev = data->hdev;
193	int ret;
194	int bytes_read;
195	int bytes_needed;
196	int retries;
197	int read_input_count;
198
199	mutex_lock(&data->page_mutex);
200
201	if (RMI_PAGE(addr) != data->page) {
202		ret = rmi_set_page(hdev, RMI_PAGE(addr));
203		if (ret < 0)
204			goto exit;
205	}
206
207	for (retries = 5; retries > 0; retries--) {
208		data->writeReport[0] = RMI_READ_ADDR_REPORT_ID;
209		data->writeReport[1] = 0; /* old 1 byte read count */
210		data->writeReport[2] = addr & 0xFF;
211		data->writeReport[3] = (addr >> 8) & 0xFF;
212		data->writeReport[4] = len  & 0xFF;
213		data->writeReport[5] = (len >> 8) & 0xFF;
214
215		set_bit(RMI_READ_REQUEST_PENDING, &data->flags);
216
217		ret = rmi_write_report(hdev, data->writeReport,
218						data->output_report_size);
219		if (ret != data->output_report_size) {
 
220			dev_err(&hdev->dev,
221				"failed to write request output report (%d)\n",
222				ret);
223			goto exit;
224		}
225
226		bytes_read = 0;
227		bytes_needed = len;
228		while (bytes_read < len) {
229			if (!wait_event_timeout(data->wait,
230				test_bit(RMI_READ_DATA_PENDING, &data->flags),
231					msecs_to_jiffies(1000))) {
232				hid_warn(hdev, "%s: timeout elapsed\n",
233					 __func__);
234				ret = -EAGAIN;
235				break;
236			}
237
238			read_input_count = data->readReport[1];
239			memcpy(buf + bytes_read, &data->readReport[2],
240				min(read_input_count, bytes_needed));
 
241
242			bytes_read += read_input_count;
243			bytes_needed -= read_input_count;
244			clear_bit(RMI_READ_DATA_PENDING, &data->flags);
245		}
246
247		if (ret >= 0) {
248			ret = 0;
249			break;
250		}
251	}
252
253exit:
254	clear_bit(RMI_READ_REQUEST_PENDING, &data->flags);
255	mutex_unlock(&data->page_mutex);
256	return ret;
257}
258
259static int rmi_hid_write_block(struct rmi_transport_dev *xport, u16 addr,
260		const void *buf, size_t len)
261{
262	struct rmi_data *data = container_of(xport, struct rmi_data, xport);
263	struct hid_device *hdev = data->hdev;
264	int ret;
265
266	mutex_lock(&data->page_mutex);
267
268	if (RMI_PAGE(addr) != data->page) {
269		ret = rmi_set_page(hdev, RMI_PAGE(addr));
270		if (ret < 0)
271			goto exit;
272	}
273
274	data->writeReport[0] = RMI_WRITE_REPORT_ID;
275	data->writeReport[1] = len;
276	data->writeReport[2] = addr & 0xFF;
277	data->writeReport[3] = (addr >> 8) & 0xFF;
278	memcpy(&data->writeReport[4], buf, len);
279
280	ret = rmi_write_report(hdev, data->writeReport,
281					data->output_report_size);
282	if (ret < 0) {
283		dev_err(&hdev->dev,
284			"failed to write request output report (%d)\n",
285			ret);
286		goto exit;
287	}
288	ret = 0;
289
290exit:
291	mutex_unlock(&data->page_mutex);
292	return ret;
293}
294
295static int rmi_reset_attn_mode(struct hid_device *hdev)
296{
297	struct rmi_data *data = hid_get_drvdata(hdev);
298	struct rmi_device *rmi_dev = data->xport.rmi_dev;
299	int ret;
300
301	ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
302	if (ret)
303		return ret;
304
305	if (test_bit(RMI_STARTED, &data->flags))
306		ret = rmi_dev->driver->reset_handler(rmi_dev);
307
308	return ret;
309}
310
311static void rmi_reset_work(struct work_struct *work)
312{
313	struct rmi_data *hdata = container_of(work, struct rmi_data,
314						reset_work);
315
316	/* switch the device to RMI if we receive a generic mouse report */
317	rmi_reset_attn_mode(hdata->hdev);
318}
319
320static int rmi_input_event(struct hid_device *hdev, u8 *data, int size)
321{
322	struct rmi_data *hdata = hid_get_drvdata(hdev);
323	struct rmi_device *rmi_dev = hdata->xport.rmi_dev;
324	unsigned long flags;
325
326	if (!(test_bit(RMI_STARTED, &hdata->flags)))
327		return 0;
328
329	pm_wakeup_event(hdev->dev.parent, 0);
330
331	local_irq_save(flags);
332
333	rmi_set_attn_data(rmi_dev, data[1], &data[2], size - 2);
334
335	generic_handle_irq(hdata->rmi_irq);
336
337	local_irq_restore(flags);
338
339	return 1;
340}
341
342static int rmi_read_data_event(struct hid_device *hdev, u8 *data, int size)
343{
344	struct rmi_data *hdata = hid_get_drvdata(hdev);
345
346	if (!test_bit(RMI_READ_REQUEST_PENDING, &hdata->flags)) {
347		hid_dbg(hdev, "no read request pending\n");
348		return 0;
349	}
350
351	memcpy(hdata->readReport, data, min((u32)size, hdata->input_report_size));
 
352	set_bit(RMI_READ_DATA_PENDING, &hdata->flags);
353	wake_up(&hdata->wait);
354
355	return 1;
356}
357
358static int rmi_check_sanity(struct hid_device *hdev, u8 *data, int size)
359{
360	int valid_size = size;
361	/*
362	 * On the Dell XPS 13 9333, the bus sometimes get confused and fills
363	 * the report with a sentinel value "ff". Synaptics told us that such
364	 * behavior does not comes from the touchpad itself, so we filter out
365	 * such reports here.
366	 */
367
368	while ((data[valid_size - 1] == 0xff) && valid_size > 0)
369		valid_size--;
370
371	return valid_size;
372}
373
374static int rmi_raw_event(struct hid_device *hdev,
375		struct hid_report *report, u8 *data, int size)
376{
377	struct rmi_data *hdata = hid_get_drvdata(hdev);
378
379	if (!(hdata->device_flags & RMI_DEVICE))
380		return 0;
381
382	size = rmi_check_sanity(hdev, data, size);
383	if (size < 2)
384		return 0;
385
386	switch (data[0]) {
387	case RMI_READ_DATA_REPORT_ID:
388		return rmi_read_data_event(hdev, data, size);
389	case RMI_ATTN_REPORT_ID:
390		return rmi_input_event(hdev, data, size);
391	default:
392		return 1;
393	}
394
395	return 0;
396}
397
398static int rmi_event(struct hid_device *hdev, struct hid_field *field,
399			struct hid_usage *usage, __s32 value)
400{
401	struct rmi_data *data = hid_get_drvdata(hdev);
402
403	if ((data->device_flags & RMI_DEVICE) &&
404	    (field->application == HID_GD_POINTER ||
405	    field->application == HID_GD_MOUSE)) {
406		if (data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS) {
407			if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
408				return 0;
409
410			if ((usage->hid == HID_GD_X || usage->hid == HID_GD_Y)
411			    && !value)
412				return 1;
413		}
414
415		schedule_work(&data->reset_work);
416		return 1;
417	}
418
419	return 0;
420}
421
422static void rmi_report(struct hid_device *hid, struct hid_report *report)
423{
424	struct hid_field *field = report->field[0];
425
426	if (!(hid->claimed & HID_CLAIMED_INPUT))
427		return;
428
429	switch (report->id) {
430	case RMI_READ_DATA_REPORT_ID:
431	case RMI_ATTN_REPORT_ID:
432		return;
433	}
434
435	if (field && field->hidinput && field->hidinput->input)
436		input_sync(field->hidinput->input);
437}
438
439static int rmi_suspend(struct hid_device *hdev, pm_message_t message)
440{
441	struct rmi_data *data = hid_get_drvdata(hdev);
442	struct rmi_device *rmi_dev = data->xport.rmi_dev;
443	int ret;
444
445	if (!(data->device_flags & RMI_DEVICE))
446		return 0;
447
448	ret = rmi_driver_suspend(rmi_dev, false);
449	if (ret) {
450		hid_warn(hdev, "Failed to suspend device: %d\n", ret);
451		return ret;
452	}
453
454	return 0;
455}
456
457static int rmi_post_resume(struct hid_device *hdev)
458{
459	struct rmi_data *data = hid_get_drvdata(hdev);
460	struct rmi_device *rmi_dev = data->xport.rmi_dev;
461	int ret;
462
463	if (!(data->device_flags & RMI_DEVICE))
464		return 0;
465
466	/* Make sure the HID device is ready to receive events */
467	ret = hid_hw_open(hdev);
468	if (ret)
469		return ret;
470
471	ret = rmi_reset_attn_mode(hdev);
472	if (ret)
473		goto out;
474
475	ret = rmi_driver_resume(rmi_dev, false);
476	if (ret) {
477		hid_warn(hdev, "Failed to resume device: %d\n", ret);
478		goto out;
479	}
480
481out:
482	hid_hw_close(hdev);
483	return ret;
484}
 
485
486static int rmi_hid_reset(struct rmi_transport_dev *xport, u16 reset_addr)
487{
488	struct rmi_data *data = container_of(xport, struct rmi_data, xport);
489	struct hid_device *hdev = data->hdev;
490
491	return rmi_reset_attn_mode(hdev);
492}
493
494static int rmi_input_configured(struct hid_device *hdev, struct hid_input *hi)
495{
496	struct rmi_data *data = hid_get_drvdata(hdev);
497	struct input_dev *input = hi->input;
498	int ret = 0;
499
500	if (!(data->device_flags & RMI_DEVICE))
501		return 0;
502
503	data->xport.input = input;
504
505	hid_dbg(hdev, "Opening low level driver\n");
506	ret = hid_hw_open(hdev);
507	if (ret)
508		return ret;
509
510	/* Allow incoming hid reports */
511	hid_device_io_start(hdev);
512
513	ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
514	if (ret < 0) {
515		dev_err(&hdev->dev, "failed to set rmi mode\n");
516		goto exit;
517	}
518
519	ret = rmi_set_page(hdev, 0);
520	if (ret < 0) {
521		dev_err(&hdev->dev, "failed to set page select to 0.\n");
522		goto exit;
523	}
524
525	ret = rmi_register_transport_device(&data->xport);
526	if (ret < 0) {
527		dev_err(&hdev->dev, "failed to register transport driver\n");
528		goto exit;
529	}
530
531	set_bit(RMI_STARTED, &data->flags);
532
533exit:
534	hid_device_io_stop(hdev);
535	hid_hw_close(hdev);
536	return ret;
537}
538
539static int rmi_input_mapping(struct hid_device *hdev,
540		struct hid_input *hi, struct hid_field *field,
541		struct hid_usage *usage, unsigned long **bit, int *max)
542{
543	struct rmi_data *data = hid_get_drvdata(hdev);
544
545	/*
546	 * we want to make HID ignore the advertised HID collection
547	 * for RMI deivces
548	 */
549	if (data->device_flags & RMI_DEVICE) {
550		if ((data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS) &&
551		    ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON))
552			return 0;
553
554		return -1;
555	}
556
557	return 0;
558}
559
560static int rmi_check_valid_report_id(struct hid_device *hdev, unsigned type,
561		unsigned id, struct hid_report **report)
562{
563	int i;
564
565	*report = hdev->report_enum[type].report_id_hash[id];
566	if (*report) {
567		for (i = 0; i < (*report)->maxfield; i++) {
568			unsigned app = (*report)->field[i]->application;
569			if ((app & HID_USAGE_PAGE) >= HID_UP_MSVENDOR)
570				return 1;
571		}
572	}
573
574	return 0;
575}
576
577static struct rmi_device_platform_data rmi_hid_pdata = {
578	.sensor_pdata = {
579		.sensor_type = rmi_sensor_touchpad,
580		.axis_align.flip_y = true,
581		.dribble = RMI_REG_STATE_ON,
582		.palm_detect = RMI_REG_STATE_OFF,
583	},
584};
585
586static const struct rmi_transport_ops hid_rmi_ops = {
587	.write_block	= rmi_hid_write_block,
588	.read_block	= rmi_hid_read_block,
589	.reset		= rmi_hid_reset,
590};
591
592static void rmi_irq_teardown(void *data)
593{
594	struct rmi_data *hdata = data;
595	struct irq_domain *domain = hdata->domain;
596
597	if (!domain)
598		return;
599
600	irq_dispose_mapping(irq_find_mapping(domain, 0));
601
602	irq_domain_remove(domain);
603	hdata->domain = NULL;
604	hdata->rmi_irq = 0;
605}
606
607static int rmi_irq_map(struct irq_domain *h, unsigned int virq,
608		       irq_hw_number_t hw_irq_num)
609{
610	irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq);
611
612	return 0;
613}
614
615static const struct irq_domain_ops rmi_irq_ops = {
616	.map = rmi_irq_map,
617};
618
619static int rmi_setup_irq_domain(struct hid_device *hdev)
620{
621	struct rmi_data *hdata = hid_get_drvdata(hdev);
622	int ret;
623
624	hdata->domain = irq_domain_create_linear(hdev->dev.fwnode, 1,
625						 &rmi_irq_ops, hdata);
626	if (!hdata->domain)
627		return -ENOMEM;
628
629	ret = devm_add_action_or_reset(&hdev->dev, &rmi_irq_teardown, hdata);
630	if (ret)
631		return ret;
632
633	hdata->rmi_irq = irq_create_mapping(hdata->domain, 0);
634	if (hdata->rmi_irq <= 0) {
635		hid_err(hdev, "Can't allocate an IRQ\n");
636		return hdata->rmi_irq < 0 ? hdata->rmi_irq : -ENXIO;
637	}
638
639	return 0;
640}
641
642static int rmi_probe(struct hid_device *hdev, const struct hid_device_id *id)
643{
644	struct rmi_data *data = NULL;
645	int ret;
646	size_t alloc_size;
647	struct hid_report *input_report;
648	struct hid_report *output_report;
649	struct hid_report *feature_report;
650
651	data = devm_kzalloc(&hdev->dev, sizeof(struct rmi_data), GFP_KERNEL);
652	if (!data)
653		return -ENOMEM;
654
655	INIT_WORK(&data->reset_work, rmi_reset_work);
656	data->hdev = hdev;
657
658	hid_set_drvdata(hdev, data);
659
660	hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
661	hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
662
663	ret = hid_parse(hdev);
664	if (ret) {
665		hid_err(hdev, "parse failed\n");
666		return ret;
667	}
668
669	if (id->driver_data)
670		data->device_flags = id->driver_data;
671
672	/*
673	 * Check for the RMI specific report ids. If they are misisng
674	 * simply return and let the events be processed by hid-input
675	 */
676	if (!rmi_check_valid_report_id(hdev, HID_FEATURE_REPORT,
677	    RMI_SET_RMI_MODE_REPORT_ID, &feature_report)) {
678		hid_dbg(hdev, "device does not have set mode feature report\n");
679		goto start;
680	}
681
682	if (!rmi_check_valid_report_id(hdev, HID_INPUT_REPORT,
683	    RMI_ATTN_REPORT_ID, &input_report)) {
684		hid_dbg(hdev, "device does not have attention input report\n");
685		goto start;
686	}
687
688	data->input_report_size = hid_report_len(input_report);
689
690	if (!rmi_check_valid_report_id(hdev, HID_OUTPUT_REPORT,
691	    RMI_WRITE_REPORT_ID, &output_report)) {
692		hid_dbg(hdev,
693			"device does not have rmi write output report\n");
694		goto start;
695	}
696
697	data->output_report_size = hid_report_len(output_report);
698
699	data->device_flags |= RMI_DEVICE;
700	alloc_size = data->output_report_size + data->input_report_size;
701
702	data->writeReport = devm_kzalloc(&hdev->dev, alloc_size, GFP_KERNEL);
703	if (!data->writeReport) {
704		hid_err(hdev, "failed to allocate buffer for HID reports\n");
705		return -ENOMEM;
706	}
707
708	data->readReport = data->writeReport + data->output_report_size;
709
710	init_waitqueue_head(&data->wait);
711
712	mutex_init(&data->page_mutex);
713
714	ret = rmi_setup_irq_domain(hdev);
715	if (ret) {
716		hid_err(hdev, "failed to allocate IRQ domain\n");
717		return ret;
718	}
719
720	if (data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS)
721		rmi_hid_pdata.gpio_data.disable = true;
722
723	data->xport.dev = hdev->dev.parent;
724	data->xport.pdata = rmi_hid_pdata;
725	data->xport.pdata.irq = data->rmi_irq;
726	data->xport.proto_name = "hid";
727	data->xport.ops = &hid_rmi_ops;
728
729start:
730	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
731	if (ret) {
732		hid_err(hdev, "hw start failed\n");
733		return ret;
734	}
735
736	return 0;
737}
738
739static void rmi_remove(struct hid_device *hdev)
740{
741	struct rmi_data *hdata = hid_get_drvdata(hdev);
742
743	if ((hdata->device_flags & RMI_DEVICE)
744	    && test_bit(RMI_STARTED, &hdata->flags)) {
745		clear_bit(RMI_STARTED, &hdata->flags);
746		cancel_work_sync(&hdata->reset_work);
747		rmi_unregister_transport_device(&hdata->xport);
748	}
749
750	hid_hw_stop(hdev);
751}
752
753static const struct hid_device_id rmi_id[] = {
754	{ HID_USB_DEVICE(USB_VENDOR_ID_RAZER, USB_DEVICE_ID_RAZER_BLADE_14),
755		.driver_data = RMI_DEVICE_HAS_PHYS_BUTTONS },
756	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_X1_COVER) },
757	{ HID_USB_DEVICE(USB_VENDOR_ID_PRIMAX, USB_DEVICE_ID_PRIMAX_REZEL) },
758	{ HID_USB_DEVICE(USB_VENDOR_ID_SYNAPTICS, USB_DEVICE_ID_SYNAPTICS_ACER_SWITCH5),
759		.driver_data = RMI_DEVICE_OUTPUT_SET_REPORT },
760	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_RMI, HID_ANY_ID, HID_ANY_ID) },
761	{ }
762};
763MODULE_DEVICE_TABLE(hid, rmi_id);
764
765static struct hid_driver rmi_driver = {
766	.name = "hid-rmi",
767	.id_table		= rmi_id,
768	.probe			= rmi_probe,
769	.remove			= rmi_remove,
770	.event			= rmi_event,
771	.raw_event		= rmi_raw_event,
772	.report			= rmi_report,
773	.input_mapping		= rmi_input_mapping,
774	.input_configured	= rmi_input_configured,
775	.suspend		= pm_ptr(rmi_suspend),
776	.resume			= pm_ptr(rmi_post_resume),
777	.reset_resume		= pm_ptr(rmi_post_resume),
 
 
778};
779
780module_hid_driver(rmi_driver);
781
782MODULE_AUTHOR("Andrew Duggan <aduggan@synaptics.com>");
783MODULE_DESCRIPTION("RMI HID driver");
784MODULE_LICENSE("GPL");
v4.17
 
  1/*
  2 *  Copyright (c) 2013 Andrew Duggan <aduggan@synaptics.com>
  3 *  Copyright (c) 2013 Synaptics Incorporated
  4 *  Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@gmail.com>
  5 *  Copyright (c) 2014 Red Hat, Inc
  6 *
  7 * This program is free software; you can redistribute it and/or modify it
  8 * under the terms of the GNU General Public License as published by the Free
  9 * Software Foundation; either version 2 of the License, or (at your option)
 10 * any later version.
 11 */
 12
 13#include <linux/kernel.h>
 14#include <linux/hid.h>
 15#include <linux/input.h>
 16#include <linux/input/mt.h>
 17#include <linux/irq.h>
 18#include <linux/irqdomain.h>
 19#include <linux/module.h>
 20#include <linux/pm.h>
 21#include <linux/slab.h>
 22#include <linux/wait.h>
 23#include <linux/sched.h>
 24#include <linux/rmi.h>
 25#include "hid-ids.h"
 26
 27#define RMI_MOUSE_REPORT_ID		0x01 /* Mouse emulation Report */
 28#define RMI_WRITE_REPORT_ID		0x09 /* Output Report */
 29#define RMI_READ_ADDR_REPORT_ID		0x0a /* Output Report */
 30#define RMI_READ_DATA_REPORT_ID		0x0b /* Input Report */
 31#define RMI_ATTN_REPORT_ID		0x0c /* Input Report */
 32#define RMI_SET_RMI_MODE_REPORT_ID	0x0f /* Feature Report */
 33
 34/* flags */
 35#define RMI_READ_REQUEST_PENDING	0
 36#define RMI_READ_DATA_PENDING		1
 37#define RMI_STARTED			2
 38
 39/* device flags */
 40#define RMI_DEVICE			BIT(0)
 41#define RMI_DEVICE_HAS_PHYS_BUTTONS	BIT(1)
 
 42
 43/*
 44 * retrieve the ctrl registers
 45 * the ctrl register has a size of 20 but a fw bug split it into 16 + 4,
 46 * and there is no way to know if the first 20 bytes are here or not.
 47 * We use only the first 12 bytes, so get only them.
 48 */
 49#define RMI_F11_CTRL_REG_COUNT		12
 50
 51enum rmi_mode_type {
 52	RMI_MODE_OFF			= 0,
 53	RMI_MODE_ATTN_REPORTS		= 1,
 54	RMI_MODE_NO_PACKED_ATTN_REPORTS	= 2,
 55};
 56
 57/**
 58 * struct rmi_data - stores information for hid communication
 59 *
 60 * @page_mutex: Locks current page to avoid changing pages in unexpected ways.
 61 * @page: Keeps track of the current virtual page
 62 * @xport: transport device to be registered with the RMI4 core.
 63 *
 64 * @wait: Used for waiting for read data
 65 *
 66 * @writeReport: output buffer when writing RMI registers
 67 * @readReport: input buffer when reading RMI registers
 68 *
 69 * @input_report_size: size of an input report (advertised by HID)
 70 * @output_report_size: size of an output report (advertised by HID)
 71 *
 72 * @flags: flags for the current device (started, reading, etc...)
 73 *
 74 * @reset_work: worker which will be called in case of a mouse report
 75 * @hdev: pointer to the struct hid_device
 76 *
 77 * @device_flags: flags which describe the device
 78 *
 79 * @domain: the IRQ domain allocated for this RMI4 device
 80 * @rmi_irq: the irq that will be used to generate events to rmi-core
 81 */
 82struct rmi_data {
 83	struct mutex page_mutex;
 84	int page;
 85	struct rmi_transport_dev xport;
 86
 87	wait_queue_head_t wait;
 88
 89	u8 *writeReport;
 90	u8 *readReport;
 91
 92	u32 input_report_size;
 93	u32 output_report_size;
 94
 95	unsigned long flags;
 96
 97	struct work_struct reset_work;
 98	struct hid_device *hdev;
 99
100	unsigned long device_flags;
101
102	struct irq_domain *domain;
103	int rmi_irq;
104};
105
106#define RMI_PAGE(addr) (((addr) >> 8) & 0xff)
107
108static int rmi_write_report(struct hid_device *hdev, u8 *report, int len);
109
110/**
111 * rmi_set_page - Set RMI page
112 * @hdev: The pointer to the hid_device struct
113 * @page: The new page address.
114 *
115 * RMI devices have 16-bit addressing, but some of the physical
116 * implementations (like SMBus) only have 8-bit addressing. So RMI implements
117 * a page address at 0xff of every page so we can reliable page addresses
118 * every 256 registers.
119 *
120 * The page_mutex lock must be held when this function is entered.
121 *
122 * Returns zero on success, non-zero on failure.
123 */
124static int rmi_set_page(struct hid_device *hdev, u8 page)
125{
126	struct rmi_data *data = hid_get_drvdata(hdev);
127	int retval;
128
129	data->writeReport[0] = RMI_WRITE_REPORT_ID;
130	data->writeReport[1] = 1;
131	data->writeReport[2] = 0xFF;
132	data->writeReport[4] = page;
133
134	retval = rmi_write_report(hdev, data->writeReport,
135			data->output_report_size);
136	if (retval != data->output_report_size) {
137		dev_err(&hdev->dev,
138			"%s: set page failed: %d.", __func__, retval);
139		return retval;
140	}
141
142	data->page = page;
143	return 0;
144}
145
146static int rmi_set_mode(struct hid_device *hdev, u8 mode)
147{
148	int ret;
149	const u8 txbuf[2] = {RMI_SET_RMI_MODE_REPORT_ID, mode};
150	u8 *buf;
151
152	buf = kmemdup(txbuf, sizeof(txbuf), GFP_KERNEL);
153	if (!buf)
154		return -ENOMEM;
155
156	ret = hid_hw_raw_request(hdev, RMI_SET_RMI_MODE_REPORT_ID, buf,
157			sizeof(txbuf), HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
158	kfree(buf);
159	if (ret < 0) {
160		dev_err(&hdev->dev, "unable to set rmi mode to %d (%d)\n", mode,
161			ret);
162		return ret;
163	}
164
165	return 0;
166}
167
168static int rmi_write_report(struct hid_device *hdev, u8 *report, int len)
169{
 
170	int ret;
171
172	ret = hid_hw_output_report(hdev, (void *)report, len);
 
 
 
 
 
 
 
 
 
173	if (ret < 0) {
174		dev_err(&hdev->dev, "failed to write hid report (%d)\n", ret);
175		return ret;
176	}
177
178	return ret;
179}
180
181static int rmi_hid_read_block(struct rmi_transport_dev *xport, u16 addr,
182		void *buf, size_t len)
183{
184	struct rmi_data *data = container_of(xport, struct rmi_data, xport);
185	struct hid_device *hdev = data->hdev;
186	int ret;
187	int bytes_read;
188	int bytes_needed;
189	int retries;
190	int read_input_count;
191
192	mutex_lock(&data->page_mutex);
193
194	if (RMI_PAGE(addr) != data->page) {
195		ret = rmi_set_page(hdev, RMI_PAGE(addr));
196		if (ret < 0)
197			goto exit;
198	}
199
200	for (retries = 5; retries > 0; retries--) {
201		data->writeReport[0] = RMI_READ_ADDR_REPORT_ID;
202		data->writeReport[1] = 0; /* old 1 byte read count */
203		data->writeReport[2] = addr & 0xFF;
204		data->writeReport[3] = (addr >> 8) & 0xFF;
205		data->writeReport[4] = len  & 0xFF;
206		data->writeReport[5] = (len >> 8) & 0xFF;
207
208		set_bit(RMI_READ_REQUEST_PENDING, &data->flags);
209
210		ret = rmi_write_report(hdev, data->writeReport,
211						data->output_report_size);
212		if (ret != data->output_report_size) {
213			clear_bit(RMI_READ_REQUEST_PENDING, &data->flags);
214			dev_err(&hdev->dev,
215				"failed to write request output report (%d)\n",
216				ret);
217			goto exit;
218		}
219
220		bytes_read = 0;
221		bytes_needed = len;
222		while (bytes_read < len) {
223			if (!wait_event_timeout(data->wait,
224				test_bit(RMI_READ_DATA_PENDING, &data->flags),
225					msecs_to_jiffies(1000))) {
226				hid_warn(hdev, "%s: timeout elapsed\n",
227					 __func__);
228				ret = -EAGAIN;
229				break;
230			}
231
232			read_input_count = data->readReport[1];
233			memcpy(buf + bytes_read, &data->readReport[2],
234				read_input_count < bytes_needed ?
235					read_input_count : bytes_needed);
236
237			bytes_read += read_input_count;
238			bytes_needed -= read_input_count;
239			clear_bit(RMI_READ_DATA_PENDING, &data->flags);
240		}
241
242		if (ret >= 0) {
243			ret = 0;
244			break;
245		}
246	}
247
248exit:
249	clear_bit(RMI_READ_REQUEST_PENDING, &data->flags);
250	mutex_unlock(&data->page_mutex);
251	return ret;
252}
253
254static int rmi_hid_write_block(struct rmi_transport_dev *xport, u16 addr,
255		const void *buf, size_t len)
256{
257	struct rmi_data *data = container_of(xport, struct rmi_data, xport);
258	struct hid_device *hdev = data->hdev;
259	int ret;
260
261	mutex_lock(&data->page_mutex);
262
263	if (RMI_PAGE(addr) != data->page) {
264		ret = rmi_set_page(hdev, RMI_PAGE(addr));
265		if (ret < 0)
266			goto exit;
267	}
268
269	data->writeReport[0] = RMI_WRITE_REPORT_ID;
270	data->writeReport[1] = len;
271	data->writeReport[2] = addr & 0xFF;
272	data->writeReport[3] = (addr >> 8) & 0xFF;
273	memcpy(&data->writeReport[4], buf, len);
274
275	ret = rmi_write_report(hdev, data->writeReport,
276					data->output_report_size);
277	if (ret < 0) {
278		dev_err(&hdev->dev,
279			"failed to write request output report (%d)\n",
280			ret);
281		goto exit;
282	}
283	ret = 0;
284
285exit:
286	mutex_unlock(&data->page_mutex);
287	return ret;
288}
289
290static int rmi_reset_attn_mode(struct hid_device *hdev)
291{
292	struct rmi_data *data = hid_get_drvdata(hdev);
293	struct rmi_device *rmi_dev = data->xport.rmi_dev;
294	int ret;
295
296	ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
297	if (ret)
298		return ret;
299
300	if (test_bit(RMI_STARTED, &data->flags))
301		ret = rmi_dev->driver->reset_handler(rmi_dev);
302
303	return ret;
304}
305
306static void rmi_reset_work(struct work_struct *work)
307{
308	struct rmi_data *hdata = container_of(work, struct rmi_data,
309						reset_work);
310
311	/* switch the device to RMI if we receive a generic mouse report */
312	rmi_reset_attn_mode(hdata->hdev);
313}
314
315static int rmi_input_event(struct hid_device *hdev, u8 *data, int size)
316{
317	struct rmi_data *hdata = hid_get_drvdata(hdev);
318	struct rmi_device *rmi_dev = hdata->xport.rmi_dev;
319	unsigned long flags;
320
321	if (!(test_bit(RMI_STARTED, &hdata->flags)))
322		return 0;
323
 
 
324	local_irq_save(flags);
325
326	rmi_set_attn_data(rmi_dev, data[1], &data[2], size - 2);
327
328	generic_handle_irq(hdata->rmi_irq);
329
330	local_irq_restore(flags);
331
332	return 1;
333}
334
335static int rmi_read_data_event(struct hid_device *hdev, u8 *data, int size)
336{
337	struct rmi_data *hdata = hid_get_drvdata(hdev);
338
339	if (!test_bit(RMI_READ_REQUEST_PENDING, &hdata->flags)) {
340		hid_dbg(hdev, "no read request pending\n");
341		return 0;
342	}
343
344	memcpy(hdata->readReport, data, size < hdata->input_report_size ?
345			size : hdata->input_report_size);
346	set_bit(RMI_READ_DATA_PENDING, &hdata->flags);
347	wake_up(&hdata->wait);
348
349	return 1;
350}
351
352static int rmi_check_sanity(struct hid_device *hdev, u8 *data, int size)
353{
354	int valid_size = size;
355	/*
356	 * On the Dell XPS 13 9333, the bus sometimes get confused and fills
357	 * the report with a sentinel value "ff". Synaptics told us that such
358	 * behavior does not comes from the touchpad itself, so we filter out
359	 * such reports here.
360	 */
361
362	while ((data[valid_size - 1] == 0xff) && valid_size > 0)
363		valid_size--;
364
365	return valid_size;
366}
367
368static int rmi_raw_event(struct hid_device *hdev,
369		struct hid_report *report, u8 *data, int size)
370{
371	struct rmi_data *hdata = hid_get_drvdata(hdev);
372
373	if (!(hdata->device_flags & RMI_DEVICE))
374		return 0;
375
376	size = rmi_check_sanity(hdev, data, size);
377	if (size < 2)
378		return 0;
379
380	switch (data[0]) {
381	case RMI_READ_DATA_REPORT_ID:
382		return rmi_read_data_event(hdev, data, size);
383	case RMI_ATTN_REPORT_ID:
384		return rmi_input_event(hdev, data, size);
385	default:
386		return 1;
387	}
388
389	return 0;
390}
391
392static int rmi_event(struct hid_device *hdev, struct hid_field *field,
393			struct hid_usage *usage, __s32 value)
394{
395	struct rmi_data *data = hid_get_drvdata(hdev);
396
397	if ((data->device_flags & RMI_DEVICE) &&
398	    (field->application == HID_GD_POINTER ||
399	    field->application == HID_GD_MOUSE)) {
400		if (data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS) {
401			if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
402				return 0;
403
404			if ((usage->hid == HID_GD_X || usage->hid == HID_GD_Y)
405			    && !value)
406				return 1;
407		}
408
409		schedule_work(&data->reset_work);
410		return 1;
411	}
412
413	return 0;
414}
415
416#ifdef CONFIG_PM
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
417static int rmi_suspend(struct hid_device *hdev, pm_message_t message)
418{
419	struct rmi_data *data = hid_get_drvdata(hdev);
420	struct rmi_device *rmi_dev = data->xport.rmi_dev;
421	int ret;
422
423	if (!(data->device_flags & RMI_DEVICE))
424		return 0;
425
426	ret = rmi_driver_suspend(rmi_dev, false);
427	if (ret) {
428		hid_warn(hdev, "Failed to suspend device: %d\n", ret);
429		return ret;
430	}
431
432	return 0;
433}
434
435static int rmi_post_resume(struct hid_device *hdev)
436{
437	struct rmi_data *data = hid_get_drvdata(hdev);
438	struct rmi_device *rmi_dev = data->xport.rmi_dev;
439	int ret;
440
441	if (!(data->device_flags & RMI_DEVICE))
442		return 0;
443
444	/* Make sure the HID device is ready to receive events */
445	ret = hid_hw_open(hdev);
446	if (ret)
447		return ret;
448
449	ret = rmi_reset_attn_mode(hdev);
450	if (ret)
451		goto out;
452
453	ret = rmi_driver_resume(rmi_dev, false);
454	if (ret) {
455		hid_warn(hdev, "Failed to resume device: %d\n", ret);
456		goto out;
457	}
458
459out:
460	hid_hw_close(hdev);
461	return ret;
462}
463#endif /* CONFIG_PM */
464
465static int rmi_hid_reset(struct rmi_transport_dev *xport, u16 reset_addr)
466{
467	struct rmi_data *data = container_of(xport, struct rmi_data, xport);
468	struct hid_device *hdev = data->hdev;
469
470	return rmi_reset_attn_mode(hdev);
471}
472
473static int rmi_input_configured(struct hid_device *hdev, struct hid_input *hi)
474{
475	struct rmi_data *data = hid_get_drvdata(hdev);
476	struct input_dev *input = hi->input;
477	int ret = 0;
478
479	if (!(data->device_flags & RMI_DEVICE))
480		return 0;
481
482	data->xport.input = input;
483
484	hid_dbg(hdev, "Opening low level driver\n");
485	ret = hid_hw_open(hdev);
486	if (ret)
487		return ret;
488
489	/* Allow incoming hid reports */
490	hid_device_io_start(hdev);
491
492	ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
493	if (ret < 0) {
494		dev_err(&hdev->dev, "failed to set rmi mode\n");
495		goto exit;
496	}
497
498	ret = rmi_set_page(hdev, 0);
499	if (ret < 0) {
500		dev_err(&hdev->dev, "failed to set page select to 0.\n");
501		goto exit;
502	}
503
504	ret = rmi_register_transport_device(&data->xport);
505	if (ret < 0) {
506		dev_err(&hdev->dev, "failed to register transport driver\n");
507		goto exit;
508	}
509
510	set_bit(RMI_STARTED, &data->flags);
511
512exit:
513	hid_device_io_stop(hdev);
514	hid_hw_close(hdev);
515	return ret;
516}
517
518static int rmi_input_mapping(struct hid_device *hdev,
519		struct hid_input *hi, struct hid_field *field,
520		struct hid_usage *usage, unsigned long **bit, int *max)
521{
522	struct rmi_data *data = hid_get_drvdata(hdev);
523
524	/*
525	 * we want to make HID ignore the advertised HID collection
526	 * for RMI deivces
527	 */
528	if (data->device_flags & RMI_DEVICE) {
529		if ((data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS) &&
530		    ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON))
531			return 0;
532
533		return -1;
534	}
535
536	return 0;
537}
538
539static int rmi_check_valid_report_id(struct hid_device *hdev, unsigned type,
540		unsigned id, struct hid_report **report)
541{
542	int i;
543
544	*report = hdev->report_enum[type].report_id_hash[id];
545	if (*report) {
546		for (i = 0; i < (*report)->maxfield; i++) {
547			unsigned app = (*report)->field[i]->application;
548			if ((app & HID_USAGE_PAGE) >= HID_UP_MSVENDOR)
549				return 1;
550		}
551	}
552
553	return 0;
554}
555
556static struct rmi_device_platform_data rmi_hid_pdata = {
557	.sensor_pdata = {
558		.sensor_type = rmi_sensor_touchpad,
559		.axis_align.flip_y = true,
560		.dribble = RMI_REG_STATE_ON,
561		.palm_detect = RMI_REG_STATE_OFF,
562	},
563};
564
565static const struct rmi_transport_ops hid_rmi_ops = {
566	.write_block	= rmi_hid_write_block,
567	.read_block	= rmi_hid_read_block,
568	.reset		= rmi_hid_reset,
569};
570
571static void rmi_irq_teardown(void *data)
572{
573	struct rmi_data *hdata = data;
574	struct irq_domain *domain = hdata->domain;
575
576	if (!domain)
577		return;
578
579	irq_dispose_mapping(irq_find_mapping(domain, 0));
580
581	irq_domain_remove(domain);
582	hdata->domain = NULL;
583	hdata->rmi_irq = 0;
584}
585
586static int rmi_irq_map(struct irq_domain *h, unsigned int virq,
587		       irq_hw_number_t hw_irq_num)
588{
589	irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq);
590
591	return 0;
592}
593
594static const struct irq_domain_ops rmi_irq_ops = {
595	.map = rmi_irq_map,
596};
597
598static int rmi_setup_irq_domain(struct hid_device *hdev)
599{
600	struct rmi_data *hdata = hid_get_drvdata(hdev);
601	int ret;
602
603	hdata->domain = irq_domain_create_linear(hdev->dev.fwnode, 1,
604						 &rmi_irq_ops, hdata);
605	if (!hdata->domain)
606		return -ENOMEM;
607
608	ret = devm_add_action_or_reset(&hdev->dev, &rmi_irq_teardown, hdata);
609	if (ret)
610		return ret;
611
612	hdata->rmi_irq = irq_create_mapping(hdata->domain, 0);
613	if (hdata->rmi_irq <= 0) {
614		hid_err(hdev, "Can't allocate an IRQ\n");
615		return hdata->rmi_irq < 0 ? hdata->rmi_irq : -ENXIO;
616	}
617
618	return 0;
619}
620
621static int rmi_probe(struct hid_device *hdev, const struct hid_device_id *id)
622{
623	struct rmi_data *data = NULL;
624	int ret;
625	size_t alloc_size;
626	struct hid_report *input_report;
627	struct hid_report *output_report;
628	struct hid_report *feature_report;
629
630	data = devm_kzalloc(&hdev->dev, sizeof(struct rmi_data), GFP_KERNEL);
631	if (!data)
632		return -ENOMEM;
633
634	INIT_WORK(&data->reset_work, rmi_reset_work);
635	data->hdev = hdev;
636
637	hid_set_drvdata(hdev, data);
638
639	hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
 
640
641	ret = hid_parse(hdev);
642	if (ret) {
643		hid_err(hdev, "parse failed\n");
644		return ret;
645	}
646
647	if (id->driver_data)
648		data->device_flags = id->driver_data;
649
650	/*
651	 * Check for the RMI specific report ids. If they are misisng
652	 * simply return and let the events be processed by hid-input
653	 */
654	if (!rmi_check_valid_report_id(hdev, HID_FEATURE_REPORT,
655	    RMI_SET_RMI_MODE_REPORT_ID, &feature_report)) {
656		hid_dbg(hdev, "device does not have set mode feature report\n");
657		goto start;
658	}
659
660	if (!rmi_check_valid_report_id(hdev, HID_INPUT_REPORT,
661	    RMI_ATTN_REPORT_ID, &input_report)) {
662		hid_dbg(hdev, "device does not have attention input report\n");
663		goto start;
664	}
665
666	data->input_report_size = hid_report_len(input_report);
667
668	if (!rmi_check_valid_report_id(hdev, HID_OUTPUT_REPORT,
669	    RMI_WRITE_REPORT_ID, &output_report)) {
670		hid_dbg(hdev,
671			"device does not have rmi write output report\n");
672		goto start;
673	}
674
675	data->output_report_size = hid_report_len(output_report);
676
677	data->device_flags |= RMI_DEVICE;
678	alloc_size = data->output_report_size + data->input_report_size;
679
680	data->writeReport = devm_kzalloc(&hdev->dev, alloc_size, GFP_KERNEL);
681	if (!data->writeReport) {
682		hid_err(hdev, "failed to allocate buffer for HID reports\n");
683		return -ENOMEM;
684	}
685
686	data->readReport = data->writeReport + data->output_report_size;
687
688	init_waitqueue_head(&data->wait);
689
690	mutex_init(&data->page_mutex);
691
692	ret = rmi_setup_irq_domain(hdev);
693	if (ret) {
694		hid_err(hdev, "failed to allocate IRQ domain\n");
695		return ret;
696	}
697
698	if (data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS)
699		rmi_hid_pdata.f30_data.disable = true;
700
701	data->xport.dev = hdev->dev.parent;
702	data->xport.pdata = rmi_hid_pdata;
703	data->xport.pdata.irq = data->rmi_irq;
704	data->xport.proto_name = "hid";
705	data->xport.ops = &hid_rmi_ops;
706
707start:
708	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
709	if (ret) {
710		hid_err(hdev, "hw start failed\n");
711		return ret;
712	}
713
714	return 0;
715}
716
717static void rmi_remove(struct hid_device *hdev)
718{
719	struct rmi_data *hdata = hid_get_drvdata(hdev);
720
721	if (hdata->device_flags & RMI_DEVICE) {
 
722		clear_bit(RMI_STARTED, &hdata->flags);
723		cancel_work_sync(&hdata->reset_work);
724		rmi_unregister_transport_device(&hdata->xport);
725	}
726
727	hid_hw_stop(hdev);
728}
729
730static const struct hid_device_id rmi_id[] = {
731	{ HID_USB_DEVICE(USB_VENDOR_ID_RAZER, USB_DEVICE_ID_RAZER_BLADE_14),
732		.driver_data = RMI_DEVICE_HAS_PHYS_BUTTONS },
733	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_X1_COVER) },
734	{ HID_USB_DEVICE(USB_VENDOR_ID_PRIMAX, USB_DEVICE_ID_PRIMAX_REZEL) },
 
 
735	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_RMI, HID_ANY_ID, HID_ANY_ID) },
736	{ }
737};
738MODULE_DEVICE_TABLE(hid, rmi_id);
739
740static struct hid_driver rmi_driver = {
741	.name = "hid-rmi",
742	.id_table		= rmi_id,
743	.probe			= rmi_probe,
744	.remove			= rmi_remove,
745	.event			= rmi_event,
746	.raw_event		= rmi_raw_event,
 
747	.input_mapping		= rmi_input_mapping,
748	.input_configured	= rmi_input_configured,
749#ifdef CONFIG_PM
750	.suspend		= rmi_suspend,
751	.resume			= rmi_post_resume,
752	.reset_resume		= rmi_post_resume,
753#endif
754};
755
756module_hid_driver(rmi_driver);
757
758MODULE_AUTHOR("Andrew Duggan <aduggan@synaptics.com>");
759MODULE_DESCRIPTION("RMI HID driver");
760MODULE_LICENSE("GPL");