1 // SPDX-License-Identifier: GPL-2.0-or-later
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
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>
17 #include <linux/slab.h>
18 #include <linux/wait.h>
19 #include <linux/sched.h>
20 #include <linux/rmi.h>
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 */
31 #define RMI_READ_REQUEST_PENDING 0
32 #define RMI_READ_DATA_PENDING 1
36 #define RMI_DEVICE BIT(0)
37 #define RMI_DEVICE_HAS_PHYS_BUTTONS BIT(1)
38 #define RMI_DEVICE_OUTPUT_SET_REPORT BIT(2)
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.
46 #define RMI_F11_CTRL_REG_COUNT 12
50 RMI_MODE_ATTN_REPORTS = 1,
51 RMI_MODE_NO_PACKED_ATTN_REPORTS = 2,
55 * struct rmi_data - stores information for hid communication
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.
61 * @wait: Used for waiting for read data
63 * @writeReport: output buffer when writing RMI registers
64 * @readReport: input buffer when reading RMI registers
66 * @input_report_size: size of an input report (advertised by HID)
67 * @output_report_size: size of an output report (advertised by HID)
69 * @flags: flags for the current device (started, reading, etc...)
71 * @reset_work: worker which will be called in case of a mouse report
72 * @hdev: pointer to the struct hid_device
74 * @device_flags: flags which describe the device
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
80 struct mutex page_mutex;
82 struct rmi_transport_dev xport;
84 wait_queue_head_t wait;
89 u32 input_report_size;
90 u32 output_report_size;
94 struct work_struct reset_work;
95 struct hid_device *hdev;
97 unsigned long device_flags;
99 struct irq_domain *domain;
103 #define RMI_PAGE(addr) (((addr) >> 8) & 0xff)
105 static int rmi_write_report(struct hid_device *hdev, u8 *report, int len);
108 * rmi_set_page - Set RMI page
109 * @hdev: The pointer to the hid_device struct
110 * @page: The new page address.
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.
117 * The page_mutex lock must be held when this function is entered.
119 * Returns zero on success, non-zero on failure.
121 static int rmi_set_page(struct hid_device *hdev, u8 page)
123 struct rmi_data *data = hid_get_drvdata(hdev);
126 data->writeReport[0] = RMI_WRITE_REPORT_ID;
127 data->writeReport[1] = 1;
128 data->writeReport[2] = 0xFF;
129 data->writeReport[4] = page;
131 retval = rmi_write_report(hdev, data->writeReport,
132 data->output_report_size);
133 if (retval != data->output_report_size) {
135 "%s: set page failed: %d.", __func__, retval);
143 static int rmi_set_mode(struct hid_device *hdev, u8 mode)
146 const u8 txbuf[2] = {RMI_SET_RMI_MODE_REPORT_ID, mode};
149 buf = kmemdup(txbuf, sizeof(txbuf), GFP_KERNEL);
153 ret = hid_hw_raw_request(hdev, RMI_SET_RMI_MODE_REPORT_ID, buf,
154 sizeof(txbuf), HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
157 dev_err(&hdev->dev, "unable to set rmi mode to %d (%d)\n", mode,
165 static int rmi_write_report(struct hid_device *hdev, u8 *report, int len)
167 struct rmi_data *data = hid_get_drvdata(hdev);
170 if (data->device_flags & RMI_DEVICE_OUTPUT_SET_REPORT) {
172 * Talk to device by using SET_REPORT requests instead.
174 ret = hid_hw_raw_request(hdev, report[0], report,
175 len, HID_OUTPUT_REPORT, HID_REQ_SET_REPORT);
177 ret = hid_hw_output_report(hdev, (void *)report, len);
181 dev_err(&hdev->dev, "failed to write hid report (%d)\n", ret);
188 static int rmi_hid_read_block(struct rmi_transport_dev *xport, u16 addr,
189 void *buf, size_t len)
191 struct rmi_data *data = container_of(xport, struct rmi_data, xport);
192 struct hid_device *hdev = data->hdev;
197 int read_input_count;
199 mutex_lock(&data->page_mutex);
201 if (RMI_PAGE(addr) != data->page) {
202 ret = rmi_set_page(hdev, RMI_PAGE(addr));
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;
215 set_bit(RMI_READ_REQUEST_PENDING, &data->flags);
217 ret = rmi_write_report(hdev, data->writeReport,
218 data->output_report_size);
219 if (ret != data->output_report_size) {
221 "failed to write request output report (%d)\n",
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",
238 read_input_count = data->readReport[1];
239 memcpy(buf + bytes_read, &data->readReport[2],
240 min(read_input_count, bytes_needed));
242 bytes_read += read_input_count;
243 bytes_needed -= read_input_count;
244 clear_bit(RMI_READ_DATA_PENDING, &data->flags);
254 clear_bit(RMI_READ_REQUEST_PENDING, &data->flags);
255 mutex_unlock(&data->page_mutex);
259 static int rmi_hid_write_block(struct rmi_transport_dev *xport, u16 addr,
260 const void *buf, size_t len)
262 struct rmi_data *data = container_of(xport, struct rmi_data, xport);
263 struct hid_device *hdev = data->hdev;
266 mutex_lock(&data->page_mutex);
268 if (RMI_PAGE(addr) != data->page) {
269 ret = rmi_set_page(hdev, RMI_PAGE(addr));
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);
280 ret = rmi_write_report(hdev, data->writeReport,
281 data->output_report_size);
284 "failed to write request output report (%d)\n",
291 mutex_unlock(&data->page_mutex);
295 static int rmi_reset_attn_mode(struct hid_device *hdev)
297 struct rmi_data *data = hid_get_drvdata(hdev);
298 struct rmi_device *rmi_dev = data->xport.rmi_dev;
301 ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
305 if (test_bit(RMI_STARTED, &data->flags))
306 ret = rmi_dev->driver->reset_handler(rmi_dev);
311 static void rmi_reset_work(struct work_struct *work)
313 struct rmi_data *hdata = container_of(work, struct rmi_data,
316 /* switch the device to RMI if we receive a generic mouse report */
317 rmi_reset_attn_mode(hdata->hdev);
320 static int rmi_input_event(struct hid_device *hdev, u8 *data, int size)
322 struct rmi_data *hdata = hid_get_drvdata(hdev);
323 struct rmi_device *rmi_dev = hdata->xport.rmi_dev;
326 if (!(test_bit(RMI_STARTED, &hdata->flags)))
329 pm_wakeup_event(hdev->dev.parent, 0);
331 local_irq_save(flags);
333 rmi_set_attn_data(rmi_dev, data[1], &data[2], size - 2);
335 generic_handle_irq(hdata->rmi_irq);
337 local_irq_restore(flags);
342 static int rmi_read_data_event(struct hid_device *hdev, u8 *data, int size)
344 struct rmi_data *hdata = hid_get_drvdata(hdev);
346 if (!test_bit(RMI_READ_REQUEST_PENDING, &hdata->flags)) {
347 hid_dbg(hdev, "no read request pending\n");
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);
358 static int rmi_check_sanity(struct hid_device *hdev, u8 *data, int size)
360 int valid_size = size;
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
368 while ((data[valid_size - 1] == 0xff) && valid_size > 0)
374 static int rmi_raw_event(struct hid_device *hdev,
375 struct hid_report *report, u8 *data, int size)
377 struct rmi_data *hdata = hid_get_drvdata(hdev);
379 if (!(hdata->device_flags & RMI_DEVICE))
382 size = rmi_check_sanity(hdev, data, size);
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);
398 static int rmi_event(struct hid_device *hdev, struct hid_field *field,
399 struct hid_usage *usage, __s32 value)
401 struct rmi_data *data = hid_get_drvdata(hdev);
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)
410 if ((usage->hid == HID_GD_X || usage->hid == HID_GD_Y)
415 schedule_work(&data->reset_work);
422 static void rmi_report(struct hid_device *hid, struct hid_report *report)
424 struct hid_field *field = report->field[0];
426 if (!(hid->claimed & HID_CLAIMED_INPUT))
429 switch (report->id) {
430 case RMI_READ_DATA_REPORT_ID:
431 case RMI_ATTN_REPORT_ID:
435 if (field && field->hidinput && field->hidinput->input)
436 input_sync(field->hidinput->input);
440 static int rmi_suspend(struct hid_device *hdev, pm_message_t message)
442 struct rmi_data *data = hid_get_drvdata(hdev);
443 struct rmi_device *rmi_dev = data->xport.rmi_dev;
446 if (!(data->device_flags & RMI_DEVICE))
449 ret = rmi_driver_suspend(rmi_dev, false);
451 hid_warn(hdev, "Failed to suspend device: %d\n", ret);
458 static int rmi_post_resume(struct hid_device *hdev)
460 struct rmi_data *data = hid_get_drvdata(hdev);
461 struct rmi_device *rmi_dev = data->xport.rmi_dev;
464 if (!(data->device_flags & RMI_DEVICE))
467 /* Make sure the HID device is ready to receive events */
468 ret = hid_hw_open(hdev);
472 ret = rmi_reset_attn_mode(hdev);
476 ret = rmi_driver_resume(rmi_dev, false);
478 hid_warn(hdev, "Failed to resume device: %d\n", ret);
486 #endif /* CONFIG_PM */
488 static int rmi_hid_reset(struct rmi_transport_dev *xport, u16 reset_addr)
490 struct rmi_data *data = container_of(xport, struct rmi_data, xport);
491 struct hid_device *hdev = data->hdev;
493 return rmi_reset_attn_mode(hdev);
496 static int rmi_input_configured(struct hid_device *hdev, struct hid_input *hi)
498 struct rmi_data *data = hid_get_drvdata(hdev);
499 struct input_dev *input = hi->input;
502 if (!(data->device_flags & RMI_DEVICE))
505 data->xport.input = input;
507 hid_dbg(hdev, "Opening low level driver\n");
508 ret = hid_hw_open(hdev);
512 /* Allow incoming hid reports */
513 hid_device_io_start(hdev);
515 ret = rmi_set_mode(hdev, RMI_MODE_ATTN_REPORTS);
517 dev_err(&hdev->dev, "failed to set rmi mode\n");
521 ret = rmi_set_page(hdev, 0);
523 dev_err(&hdev->dev, "failed to set page select to 0.\n");
527 ret = rmi_register_transport_device(&data->xport);
529 dev_err(&hdev->dev, "failed to register transport driver\n");
533 set_bit(RMI_STARTED, &data->flags);
536 hid_device_io_stop(hdev);
541 static int rmi_input_mapping(struct hid_device *hdev,
542 struct hid_input *hi, struct hid_field *field,
543 struct hid_usage *usage, unsigned long **bit, int *max)
545 struct rmi_data *data = hid_get_drvdata(hdev);
548 * we want to make HID ignore the advertised HID collection
551 if (data->device_flags & RMI_DEVICE) {
552 if ((data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS) &&
553 ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON))
562 static int rmi_check_valid_report_id(struct hid_device *hdev, unsigned type,
563 unsigned id, struct hid_report **report)
567 *report = hdev->report_enum[type].report_id_hash[id];
569 for (i = 0; i < (*report)->maxfield; i++) {
570 unsigned app = (*report)->field[i]->application;
571 if ((app & HID_USAGE_PAGE) >= HID_UP_MSVENDOR)
579 static struct rmi_device_platform_data rmi_hid_pdata = {
581 .sensor_type = rmi_sensor_touchpad,
582 .axis_align.flip_y = true,
583 .dribble = RMI_REG_STATE_ON,
584 .palm_detect = RMI_REG_STATE_OFF,
588 static const struct rmi_transport_ops hid_rmi_ops = {
589 .write_block = rmi_hid_write_block,
590 .read_block = rmi_hid_read_block,
591 .reset = rmi_hid_reset,
594 static void rmi_irq_teardown(void *data)
596 struct rmi_data *hdata = data;
597 struct irq_domain *domain = hdata->domain;
602 irq_dispose_mapping(irq_find_mapping(domain, 0));
604 irq_domain_remove(domain);
605 hdata->domain = NULL;
609 static int rmi_irq_map(struct irq_domain *h, unsigned int virq,
610 irq_hw_number_t hw_irq_num)
612 irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq);
617 static const struct irq_domain_ops rmi_irq_ops = {
621 static int rmi_setup_irq_domain(struct hid_device *hdev)
623 struct rmi_data *hdata = hid_get_drvdata(hdev);
626 hdata->domain = irq_domain_create_linear(hdev->dev.fwnode, 1,
627 &rmi_irq_ops, hdata);
631 ret = devm_add_action_or_reset(&hdev->dev, &rmi_irq_teardown, hdata);
635 hdata->rmi_irq = irq_create_mapping(hdata->domain, 0);
636 if (hdata->rmi_irq <= 0) {
637 hid_err(hdev, "Can't allocate an IRQ\n");
638 return hdata->rmi_irq < 0 ? hdata->rmi_irq : -ENXIO;
644 static int rmi_probe(struct hid_device *hdev, const struct hid_device_id *id)
646 struct rmi_data *data = NULL;
649 struct hid_report *input_report;
650 struct hid_report *output_report;
651 struct hid_report *feature_report;
653 data = devm_kzalloc(&hdev->dev, sizeof(struct rmi_data), GFP_KERNEL);
657 INIT_WORK(&data->reset_work, rmi_reset_work);
660 hid_set_drvdata(hdev, data);
662 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
663 hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
665 ret = hid_parse(hdev);
667 hid_err(hdev, "parse failed\n");
672 data->device_flags = id->driver_data;
675 * Check for the RMI specific report ids. If they are misisng
676 * simply return and let the events be processed by hid-input
678 if (!rmi_check_valid_report_id(hdev, HID_FEATURE_REPORT,
679 RMI_SET_RMI_MODE_REPORT_ID, &feature_report)) {
680 hid_dbg(hdev, "device does not have set mode feature report\n");
684 if (!rmi_check_valid_report_id(hdev, HID_INPUT_REPORT,
685 RMI_ATTN_REPORT_ID, &input_report)) {
686 hid_dbg(hdev, "device does not have attention input report\n");
690 data->input_report_size = hid_report_len(input_report);
692 if (!rmi_check_valid_report_id(hdev, HID_OUTPUT_REPORT,
693 RMI_WRITE_REPORT_ID, &output_report)) {
695 "device does not have rmi write output report\n");
699 data->output_report_size = hid_report_len(output_report);
701 data->device_flags |= RMI_DEVICE;
702 alloc_size = data->output_report_size + data->input_report_size;
704 data->writeReport = devm_kzalloc(&hdev->dev, alloc_size, GFP_KERNEL);
705 if (!data->writeReport) {
706 hid_err(hdev, "failed to allocate buffer for HID reports\n");
710 data->readReport = data->writeReport + data->output_report_size;
712 init_waitqueue_head(&data->wait);
714 mutex_init(&data->page_mutex);
716 ret = rmi_setup_irq_domain(hdev);
718 hid_err(hdev, "failed to allocate IRQ domain\n");
722 if (data->device_flags & RMI_DEVICE_HAS_PHYS_BUTTONS)
723 rmi_hid_pdata.gpio_data.disable = true;
725 data->xport.dev = hdev->dev.parent;
726 data->xport.pdata = rmi_hid_pdata;
727 data->xport.pdata.irq = data->rmi_irq;
728 data->xport.proto_name = "hid";
729 data->xport.ops = &hid_rmi_ops;
732 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
734 hid_err(hdev, "hw start failed\n");
741 static void rmi_remove(struct hid_device *hdev)
743 struct rmi_data *hdata = hid_get_drvdata(hdev);
745 if ((hdata->device_flags & RMI_DEVICE)
746 && test_bit(RMI_STARTED, &hdata->flags)) {
747 clear_bit(RMI_STARTED, &hdata->flags);
748 cancel_work_sync(&hdata->reset_work);
749 rmi_unregister_transport_device(&hdata->xport);
755 static const struct hid_device_id rmi_id[] = {
756 { HID_USB_DEVICE(USB_VENDOR_ID_RAZER, USB_DEVICE_ID_RAZER_BLADE_14),
757 .driver_data = RMI_DEVICE_HAS_PHYS_BUTTONS },
758 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_X1_COVER) },
759 { HID_USB_DEVICE(USB_VENDOR_ID_PRIMAX, USB_DEVICE_ID_PRIMAX_REZEL) },
760 { HID_USB_DEVICE(USB_VENDOR_ID_SYNAPTICS, USB_DEVICE_ID_SYNAPTICS_ACER_SWITCH5),
761 .driver_data = RMI_DEVICE_OUTPUT_SET_REPORT },
762 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_RMI, HID_ANY_ID, HID_ANY_ID) },
765 MODULE_DEVICE_TABLE(hid, rmi_id);
767 static struct hid_driver rmi_driver = {
771 .remove = rmi_remove,
773 .raw_event = rmi_raw_event,
774 .report = rmi_report,
775 .input_mapping = rmi_input_mapping,
776 .input_configured = rmi_input_configured,
778 .suspend = rmi_suspend,
779 .resume = rmi_post_resume,
780 .reset_resume = rmi_post_resume,
784 module_hid_driver(rmi_driver);
786 MODULE_AUTHOR("Andrew Duggan <aduggan@synaptics.com>");
787 MODULE_DESCRIPTION("RMI HID driver");
788 MODULE_LICENSE("GPL");