2 * Copyright (c) 2011-2016 Synaptics Incorporated
3 * Copyright (c) 2011 Unixphere
5 * This driver provides the core support for a single RMI4-based device.
7 * The RMI4 specification can be found here (URL split for line length):
9 * http://www.synaptics.com/sites/default/files/
10 * 511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License version 2 as published by
14 * the Free Software Foundation.
17 #include <linux/bitmap.h>
18 #include <linux/delay.h>
20 #include <linux/irq.h>
21 #include <linux/kconfig.h>
23 #include <linux/slab.h>
25 #include <uapi/linux/input.h>
26 #include <linux/rmi.h>
28 #include "rmi_driver.h"
30 #define HAS_NONSTANDARD_PDT_MASK 0x40
31 #define RMI4_MAX_PAGE 0xff
32 #define RMI4_PAGE_SIZE 0x100
33 #define RMI4_PAGE_MASK 0xFF00
35 #define RMI_DEVICE_RESET_CMD 0x01
36 #define DEFAULT_RESET_DELAY_MS 100
38 void rmi_free_function_list(struct rmi_device *rmi_dev)
40 struct rmi_function *fn, *tmp;
41 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
43 rmi_dbg(RMI_DEBUG_CORE, &rmi_dev->dev, "Freeing function list\n");
45 devm_kfree(&rmi_dev->dev, data->irq_memory);
46 data->irq_memory = NULL;
47 data->irq_status = NULL;
48 data->fn_irq_bits = NULL;
49 data->current_irq_mask = NULL;
50 data->new_irq_mask = NULL;
52 data->f01_container = NULL;
53 data->f34_container = NULL;
55 /* Doing it in the reverse order so F01 will be removed last */
56 list_for_each_entry_safe_reverse(fn, tmp,
57 &data->function_list, node) {
59 rmi_unregister_function(fn);
63 static int reset_one_function(struct rmi_function *fn)
65 struct rmi_function_handler *fh;
68 if (!fn || !fn->dev.driver)
71 fh = to_rmi_function_handler(fn->dev.driver);
73 retval = fh->reset(fn);
75 dev_err(&fn->dev, "Reset failed with code %d.\n",
82 static int configure_one_function(struct rmi_function *fn)
84 struct rmi_function_handler *fh;
87 if (!fn || !fn->dev.driver)
90 fh = to_rmi_function_handler(fn->dev.driver);
92 retval = fh->config(fn);
94 dev_err(&fn->dev, "Config failed with code %d.\n",
101 static int rmi_driver_process_reset_requests(struct rmi_device *rmi_dev)
103 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
104 struct rmi_function *entry;
107 list_for_each_entry(entry, &data->function_list, node) {
108 retval = reset_one_function(entry);
116 static int rmi_driver_process_config_requests(struct rmi_device *rmi_dev)
118 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
119 struct rmi_function *entry;
122 list_for_each_entry(entry, &data->function_list, node) {
123 retval = configure_one_function(entry);
131 static void process_one_interrupt(struct rmi_driver_data *data,
132 struct rmi_function *fn)
134 struct rmi_function_handler *fh;
136 if (!fn || !fn->dev.driver)
139 fh = to_rmi_function_handler(fn->dev.driver);
141 bitmap_and(data->fn_irq_bits, data->irq_status, fn->irq_mask,
143 if (!bitmap_empty(data->fn_irq_bits, data->irq_count))
144 fh->attention(fn, data->fn_irq_bits);
148 static int rmi_process_interrupt_requests(struct rmi_device *rmi_dev)
150 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
151 struct device *dev = &rmi_dev->dev;
152 struct rmi_function *entry;
158 if (!data->attn_data.data) {
159 error = rmi_read_block(rmi_dev,
160 data->f01_container->fd.data_base_addr + 1,
161 data->irq_status, data->num_of_irq_regs);
163 dev_err(dev, "Failed to read irqs, code=%d\n", error);
168 mutex_lock(&data->irq_mutex);
169 bitmap_and(data->irq_status, data->irq_status, data->current_irq_mask,
172 * At this point, irq_status has all bits that are set in the
173 * interrupt status register and are enabled.
175 mutex_unlock(&data->irq_mutex);
178 * It would be nice to be able to use irq_chip to handle these
179 * nested IRQs. Unfortunately, most of the current customers for
180 * this driver are using older kernels (3.0.x) that don't support
181 * the features required for that. Once they've shifted to more
182 * recent kernels (say, 3.3 and higher), this should be switched to
185 list_for_each_entry(entry, &data->function_list, node)
186 process_one_interrupt(data, entry);
189 input_sync(data->input);
194 void rmi_set_attn_data(struct rmi_device *rmi_dev, unsigned long irq_status,
195 void *data, size_t size)
197 struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
198 struct rmi4_attn_data attn_data;
201 if (!drvdata->enabled)
204 fifo_data = kmemdup(data, size, GFP_ATOMIC);
208 attn_data.irq_status = irq_status;
209 attn_data.size = size;
210 attn_data.data = fifo_data;
212 kfifo_put(&drvdata->attn_fifo, attn_data);
214 EXPORT_SYMBOL_GPL(rmi_set_attn_data);
216 static irqreturn_t rmi_irq_fn(int irq, void *dev_id)
218 struct rmi_device *rmi_dev = dev_id;
219 struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
220 struct rmi4_attn_data attn_data = {0};
223 count = kfifo_get(&drvdata->attn_fifo, &attn_data);
225 *(drvdata->irq_status) = attn_data.irq_status;
226 drvdata->attn_data = attn_data;
229 ret = rmi_process_interrupt_requests(rmi_dev);
231 rmi_dbg(RMI_DEBUG_CORE, &rmi_dev->dev,
232 "Failed to process interrupt request: %d\n", ret);
235 kfree(attn_data.data);
237 if (!kfifo_is_empty(&drvdata->attn_fifo))
238 return rmi_irq_fn(irq, dev_id);
243 static int rmi_irq_init(struct rmi_device *rmi_dev)
245 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
246 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
247 int irq_flags = irq_get_trigger_type(pdata->irq);
251 irq_flags = IRQF_TRIGGER_LOW;
253 ret = devm_request_threaded_irq(&rmi_dev->dev, pdata->irq, NULL,
254 rmi_irq_fn, irq_flags | IRQF_ONESHOT,
255 dev_name(rmi_dev->xport->dev),
258 dev_err(&rmi_dev->dev, "Failed to register interrupt %d\n",
264 data->enabled = true;
269 static int suspend_one_function(struct rmi_function *fn)
271 struct rmi_function_handler *fh;
274 if (!fn || !fn->dev.driver)
277 fh = to_rmi_function_handler(fn->dev.driver);
279 retval = fh->suspend(fn);
281 dev_err(&fn->dev, "Suspend failed with code %d.\n",
288 static int rmi_suspend_functions(struct rmi_device *rmi_dev)
290 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
291 struct rmi_function *entry;
294 list_for_each_entry(entry, &data->function_list, node) {
295 retval = suspend_one_function(entry);
303 static int resume_one_function(struct rmi_function *fn)
305 struct rmi_function_handler *fh;
308 if (!fn || !fn->dev.driver)
311 fh = to_rmi_function_handler(fn->dev.driver);
313 retval = fh->resume(fn);
315 dev_err(&fn->dev, "Resume failed with code %d.\n",
322 static int rmi_resume_functions(struct rmi_device *rmi_dev)
324 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
325 struct rmi_function *entry;
328 list_for_each_entry(entry, &data->function_list, node) {
329 retval = resume_one_function(entry);
337 int rmi_enable_sensor(struct rmi_device *rmi_dev)
341 retval = rmi_driver_process_config_requests(rmi_dev);
345 return rmi_process_interrupt_requests(rmi_dev);
349 * rmi_driver_set_input_params - set input device id and other data.
351 * @rmi_dev: Pointer to an RMI device
352 * @input: Pointer to input device
355 static int rmi_driver_set_input_params(struct rmi_device *rmi_dev,
356 struct input_dev *input)
358 input->name = SYNAPTICS_INPUT_DEVICE_NAME;
359 input->id.vendor = SYNAPTICS_VENDOR_ID;
360 input->id.bustype = BUS_RMI;
364 static void rmi_driver_set_input_name(struct rmi_device *rmi_dev,
365 struct input_dev *input)
367 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
368 char *device_name = rmi_f01_get_product_ID(data->f01_container);
371 name = devm_kasprintf(&rmi_dev->dev, GFP_KERNEL,
372 "Synaptics %s", device_name);
379 static int rmi_driver_set_irq_bits(struct rmi_device *rmi_dev,
383 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
384 struct device *dev = &rmi_dev->dev;
386 mutex_lock(&data->irq_mutex);
387 bitmap_or(data->new_irq_mask,
388 data->current_irq_mask, mask, data->irq_count);
390 error = rmi_write_block(rmi_dev,
391 data->f01_container->fd.control_base_addr + 1,
392 data->new_irq_mask, data->num_of_irq_regs);
394 dev_err(dev, "%s: Failed to change enabled interrupts!",
398 bitmap_copy(data->current_irq_mask, data->new_irq_mask,
399 data->num_of_irq_regs);
402 mutex_unlock(&data->irq_mutex);
406 static int rmi_driver_clear_irq_bits(struct rmi_device *rmi_dev,
410 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
411 struct device *dev = &rmi_dev->dev;
413 mutex_lock(&data->irq_mutex);
414 bitmap_andnot(data->new_irq_mask,
415 data->current_irq_mask, mask, data->irq_count);
417 error = rmi_write_block(rmi_dev,
418 data->f01_container->fd.control_base_addr + 1,
419 data->new_irq_mask, data->num_of_irq_regs);
421 dev_err(dev, "%s: Failed to change enabled interrupts!",
425 bitmap_copy(data->current_irq_mask, data->new_irq_mask,
426 data->num_of_irq_regs);
429 mutex_unlock(&data->irq_mutex);
433 static int rmi_driver_reset_handler(struct rmi_device *rmi_dev)
435 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
439 * Can get called before the driver is fully ready to deal with
442 if (!data || !data->f01_container) {
443 dev_warn(&rmi_dev->dev,
444 "Not ready to handle reset yet!\n");
448 error = rmi_read_block(rmi_dev,
449 data->f01_container->fd.control_base_addr + 1,
450 data->current_irq_mask, data->num_of_irq_regs);
452 dev_err(&rmi_dev->dev, "%s: Failed to read current IRQ mask.\n",
457 error = rmi_driver_process_reset_requests(rmi_dev);
461 error = rmi_driver_process_config_requests(rmi_dev);
468 static int rmi_read_pdt_entry(struct rmi_device *rmi_dev,
469 struct pdt_entry *entry, u16 pdt_address)
471 u8 buf[RMI_PDT_ENTRY_SIZE];
474 error = rmi_read_block(rmi_dev, pdt_address, buf, RMI_PDT_ENTRY_SIZE);
476 dev_err(&rmi_dev->dev, "Read PDT entry at %#06x failed, code: %d.\n",
481 entry->page_start = pdt_address & RMI4_PAGE_MASK;
482 entry->query_base_addr = buf[0];
483 entry->command_base_addr = buf[1];
484 entry->control_base_addr = buf[2];
485 entry->data_base_addr = buf[3];
486 entry->interrupt_source_count = buf[4] & RMI_PDT_INT_SOURCE_COUNT_MASK;
487 entry->function_version = (buf[4] & RMI_PDT_FUNCTION_VERSION_MASK) >> 5;
488 entry->function_number = buf[5];
493 static void rmi_driver_copy_pdt_to_fd(const struct pdt_entry *pdt,
494 struct rmi_function_descriptor *fd)
496 fd->query_base_addr = pdt->query_base_addr + pdt->page_start;
497 fd->command_base_addr = pdt->command_base_addr + pdt->page_start;
498 fd->control_base_addr = pdt->control_base_addr + pdt->page_start;
499 fd->data_base_addr = pdt->data_base_addr + pdt->page_start;
500 fd->function_number = pdt->function_number;
501 fd->interrupt_source_count = pdt->interrupt_source_count;
502 fd->function_version = pdt->function_version;
505 #define RMI_SCAN_CONTINUE 0
506 #define RMI_SCAN_DONE 1
508 static int rmi_scan_pdt_page(struct rmi_device *rmi_dev,
512 int (*callback)(struct rmi_device *rmi_dev,
514 const struct pdt_entry *entry))
516 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
517 struct pdt_entry pdt_entry;
518 u16 page_start = RMI4_PAGE_SIZE * page;
519 u16 pdt_start = page_start + PDT_START_SCAN_LOCATION;
520 u16 pdt_end = page_start + PDT_END_SCAN_LOCATION;
525 for (addr = pdt_start; addr >= pdt_end; addr -= RMI_PDT_ENTRY_SIZE) {
526 error = rmi_read_pdt_entry(rmi_dev, &pdt_entry, addr);
530 if (RMI4_END_OF_PDT(pdt_entry.function_number))
533 retval = callback(rmi_dev, ctx, &pdt_entry);
534 if (retval != RMI_SCAN_CONTINUE)
539 * Count number of empty PDT pages. If a gap of two pages
540 * or more is found, stop scanning.
542 if (addr == pdt_start)
547 return (data->bootloader_mode || *empty_pages >= 2) ?
548 RMI_SCAN_DONE : RMI_SCAN_CONTINUE;
551 int rmi_scan_pdt(struct rmi_device *rmi_dev, void *ctx,
552 int (*callback)(struct rmi_device *rmi_dev,
553 void *ctx, const struct pdt_entry *entry))
557 int retval = RMI_SCAN_DONE;
559 for (page = 0; page <= RMI4_MAX_PAGE; page++) {
560 retval = rmi_scan_pdt_page(rmi_dev, page, &empty_pages,
562 if (retval != RMI_SCAN_CONTINUE)
566 return retval < 0 ? retval : 0;
569 int rmi_read_register_desc(struct rmi_device *d, u16 addr,
570 struct rmi_register_descriptor *rdesc)
573 u8 size_presence_reg;
575 int presense_offset = 1;
584 * The first register of the register descriptor is the size of
585 * the register descriptor's presense register.
587 ret = rmi_read(d, addr, &size_presence_reg);
592 if (size_presence_reg < 0 || size_presence_reg > 35)
595 memset(buf, 0, sizeof(buf));
598 * The presence register contains the size of the register structure
599 * and a bitmap which identified which packet registers are present
600 * for this particular register type (ie query, control, or data).
602 ret = rmi_read_block(d, addr, buf, size_presence_reg);
609 rdesc->struct_size = buf[1] | (buf[2] << 8);
611 rdesc->struct_size = buf[0];
614 for (i = presense_offset; i < size_presence_reg; i++) {
615 for (b = 0; b < 8; b++) {
616 if (buf[i] & (0x1 << b))
617 bitmap_set(rdesc->presense_map, map_offset, 1);
622 rdesc->num_registers = bitmap_weight(rdesc->presense_map,
623 RMI_REG_DESC_PRESENSE_BITS);
625 rdesc->registers = devm_kzalloc(&d->dev, rdesc->num_registers *
626 sizeof(struct rmi_register_desc_item),
628 if (!rdesc->registers)
632 * Allocate a temporary buffer to hold the register structure.
633 * I'm not using devm_kzalloc here since it will not be retained
634 * after exiting this function
636 struct_buf = kzalloc(rdesc->struct_size, GFP_KERNEL);
641 * The register structure contains information about every packet
642 * register of this type. This includes the size of the packet
643 * register and a bitmap of all subpackets contained in the packet
646 ret = rmi_read_block(d, addr, struct_buf, rdesc->struct_size);
648 goto free_struct_buff;
650 reg = find_first_bit(rdesc->presense_map, RMI_REG_DESC_PRESENSE_BITS);
651 for (i = 0; i < rdesc->num_registers; i++) {
652 struct rmi_register_desc_item *item = &rdesc->registers[i];
653 int reg_size = struct_buf[offset];
657 reg_size = struct_buf[offset] |
658 (struct_buf[offset + 1] << 8);
663 reg_size = struct_buf[offset] |
664 (struct_buf[offset + 1] << 8) |
665 (struct_buf[offset + 2] << 16) |
666 (struct_buf[offset + 3] << 24);
671 item->reg_size = reg_size;
676 for (b = 0; b < 7; b++) {
677 if (struct_buf[offset] & (0x1 << b))
678 bitmap_set(item->subpacket_map,
682 } while (struct_buf[offset++] & 0x80);
684 item->num_subpackets = bitmap_weight(item->subpacket_map,
685 RMI_REG_DESC_SUBPACKET_BITS);
687 rmi_dbg(RMI_DEBUG_CORE, &d->dev,
688 "%s: reg: %d reg size: %ld subpackets: %d\n", __func__,
689 item->reg, item->reg_size, item->num_subpackets);
691 reg = find_next_bit(rdesc->presense_map,
692 RMI_REG_DESC_PRESENSE_BITS, reg + 1);
700 const struct rmi_register_desc_item *rmi_get_register_desc_item(
701 struct rmi_register_descriptor *rdesc, u16 reg)
703 const struct rmi_register_desc_item *item;
706 for (i = 0; i < rdesc->num_registers; i++) {
707 item = &rdesc->registers[i];
708 if (item->reg == reg)
715 size_t rmi_register_desc_calc_size(struct rmi_register_descriptor *rdesc)
717 const struct rmi_register_desc_item *item;
721 for (i = 0; i < rdesc->num_registers; i++) {
722 item = &rdesc->registers[i];
723 size += item->reg_size;
728 /* Compute the register offset relative to the base address */
729 int rmi_register_desc_calc_reg_offset(
730 struct rmi_register_descriptor *rdesc, u16 reg)
732 const struct rmi_register_desc_item *item;
736 for (i = 0; i < rdesc->num_registers; i++) {
737 item = &rdesc->registers[i];
738 if (item->reg == reg)
745 bool rmi_register_desc_has_subpacket(const struct rmi_register_desc_item *item,
748 return find_next_bit(item->subpacket_map, RMI_REG_DESC_PRESENSE_BITS,
749 subpacket) == subpacket;
752 static int rmi_check_bootloader_mode(struct rmi_device *rmi_dev,
753 const struct pdt_entry *pdt)
755 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
759 if (pdt->function_number == 0x34 && pdt->function_version > 1) {
760 ret = rmi_read(rmi_dev, pdt->data_base_addr, &status);
762 dev_err(&rmi_dev->dev,
763 "Failed to read F34 status: %d.\n", ret);
768 data->bootloader_mode = true;
769 } else if (pdt->function_number == 0x01) {
770 ret = rmi_read(rmi_dev, pdt->data_base_addr, &status);
772 dev_err(&rmi_dev->dev,
773 "Failed to read F01 status: %d.\n", ret);
778 data->bootloader_mode = true;
784 static int rmi_count_irqs(struct rmi_device *rmi_dev,
785 void *ctx, const struct pdt_entry *pdt)
787 int *irq_count = ctx;
790 *irq_count += pdt->interrupt_source_count;
792 ret = rmi_check_bootloader_mode(rmi_dev, pdt);
796 return RMI_SCAN_CONTINUE;
799 int rmi_initial_reset(struct rmi_device *rmi_dev, void *ctx,
800 const struct pdt_entry *pdt)
804 if (pdt->function_number == 0x01) {
805 u16 cmd_addr = pdt->page_start + pdt->command_base_addr;
806 u8 cmd_buf = RMI_DEVICE_RESET_CMD;
807 const struct rmi_device_platform_data *pdata =
808 rmi_get_platform_data(rmi_dev);
810 if (rmi_dev->xport->ops->reset) {
811 error = rmi_dev->xport->ops->reset(rmi_dev->xport,
816 return RMI_SCAN_DONE;
819 rmi_dbg(RMI_DEBUG_CORE, &rmi_dev->dev, "Sending reset\n");
820 error = rmi_write_block(rmi_dev, cmd_addr, &cmd_buf, 1);
822 dev_err(&rmi_dev->dev,
823 "Initial reset failed. Code = %d.\n", error);
827 mdelay(pdata->reset_delay_ms ?: DEFAULT_RESET_DELAY_MS);
829 return RMI_SCAN_DONE;
832 /* F01 should always be on page 0. If we don't find it there, fail. */
833 return pdt->page_start == 0 ? RMI_SCAN_CONTINUE : -ENODEV;
836 static int rmi_create_function(struct rmi_device *rmi_dev,
837 void *ctx, const struct pdt_entry *pdt)
839 struct device *dev = &rmi_dev->dev;
840 struct rmi_driver_data *data = dev_get_drvdata(dev);
841 int *current_irq_count = ctx;
842 struct rmi_function *fn;
846 rmi_dbg(RMI_DEBUG_CORE, dev, "Initializing F%02X.\n",
847 pdt->function_number);
849 fn = kzalloc(sizeof(struct rmi_function) +
850 BITS_TO_LONGS(data->irq_count) * sizeof(unsigned long),
853 dev_err(dev, "Failed to allocate memory for F%02X\n",
854 pdt->function_number);
858 INIT_LIST_HEAD(&fn->node);
859 rmi_driver_copy_pdt_to_fd(pdt, &fn->fd);
861 fn->rmi_dev = rmi_dev;
863 fn->num_of_irqs = pdt->interrupt_source_count;
864 fn->irq_pos = *current_irq_count;
865 *current_irq_count += fn->num_of_irqs;
867 for (i = 0; i < fn->num_of_irqs; i++)
868 set_bit(fn->irq_pos + i, fn->irq_mask);
870 error = rmi_register_function(fn);
874 if (pdt->function_number == 0x01)
875 data->f01_container = fn;
876 else if (pdt->function_number == 0x34)
877 data->f34_container = fn;
879 list_add_tail(&fn->node, &data->function_list);
881 return RMI_SCAN_CONTINUE;
884 put_device(&fn->dev);
888 void rmi_enable_irq(struct rmi_device *rmi_dev, bool clear_wake)
890 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
891 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
892 int irq = pdata->irq;
896 mutex_lock(&data->enabled_mutex);
902 data->enabled = true;
903 if (clear_wake && device_may_wakeup(rmi_dev->xport->dev)) {
904 retval = disable_irq_wake(irq);
906 dev_warn(&rmi_dev->dev,
907 "Failed to disable irq for wake: %d\n",
912 * Call rmi_process_interrupt_requests() after enabling irq,
913 * otherwise we may lose interrupt on edge-triggered systems.
915 irq_flags = irq_get_trigger_type(pdata->irq);
916 if (irq_flags & IRQ_TYPE_EDGE_BOTH)
917 rmi_process_interrupt_requests(rmi_dev);
920 mutex_unlock(&data->enabled_mutex);
923 void rmi_disable_irq(struct rmi_device *rmi_dev, bool enable_wake)
925 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
926 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
927 struct rmi4_attn_data attn_data = {0};
928 int irq = pdata->irq;
931 mutex_lock(&data->enabled_mutex);
936 data->enabled = false;
938 if (enable_wake && device_may_wakeup(rmi_dev->xport->dev)) {
939 retval = enable_irq_wake(irq);
941 dev_warn(&rmi_dev->dev,
942 "Failed to enable irq for wake: %d\n",
946 /* make sure the fifo is clean */
947 while (!kfifo_is_empty(&data->attn_fifo)) {
948 count = kfifo_get(&data->attn_fifo, &attn_data);
950 kfree(attn_data.data);
954 mutex_unlock(&data->enabled_mutex);
957 int rmi_driver_suspend(struct rmi_device *rmi_dev, bool enable_wake)
961 retval = rmi_suspend_functions(rmi_dev);
963 dev_warn(&rmi_dev->dev, "Failed to suspend functions: %d\n",
966 rmi_disable_irq(rmi_dev, enable_wake);
969 EXPORT_SYMBOL_GPL(rmi_driver_suspend);
971 int rmi_driver_resume(struct rmi_device *rmi_dev, bool clear_wake)
975 rmi_enable_irq(rmi_dev, clear_wake);
977 retval = rmi_resume_functions(rmi_dev);
979 dev_warn(&rmi_dev->dev, "Failed to suspend functions: %d\n",
984 EXPORT_SYMBOL_GPL(rmi_driver_resume);
986 static int rmi_driver_remove(struct device *dev)
988 struct rmi_device *rmi_dev = to_rmi_device(dev);
990 rmi_disable_irq(rmi_dev, false);
992 rmi_f34_remove_sysfs(rmi_dev);
993 rmi_free_function_list(rmi_dev);
999 static int rmi_driver_of_probe(struct device *dev,
1000 struct rmi_device_platform_data *pdata)
1004 retval = rmi_of_property_read_u32(dev, &pdata->reset_delay_ms,
1005 "syna,reset-delay-ms", 1);
1012 static inline int rmi_driver_of_probe(struct device *dev,
1013 struct rmi_device_platform_data *pdata)
1019 int rmi_probe_interrupts(struct rmi_driver_data *data)
1021 struct rmi_device *rmi_dev = data->rmi_dev;
1022 struct device *dev = &rmi_dev->dev;
1028 * We need to count the IRQs and allocate their storage before scanning
1029 * the PDT and creating the function entries, because adding a new
1030 * function can trigger events that result in the IRQ related storage
1033 rmi_dbg(RMI_DEBUG_CORE, dev, "%s: Counting IRQs.\n", __func__);
1035 data->bootloader_mode = false;
1037 retval = rmi_scan_pdt(rmi_dev, &irq_count, rmi_count_irqs);
1039 dev_err(dev, "IRQ counting failed with code %d.\n", retval);
1043 if (data->bootloader_mode)
1044 dev_warn(dev, "Device in bootloader mode.\n");
1046 data->irq_count = irq_count;
1047 data->num_of_irq_regs = (data->irq_count + 7) / 8;
1049 size = BITS_TO_LONGS(data->irq_count) * sizeof(unsigned long);
1050 data->irq_memory = devm_kzalloc(dev, size * 4, GFP_KERNEL);
1051 if (!data->irq_memory) {
1052 dev_err(dev, "Failed to allocate memory for irq masks.\n");
1056 data->irq_status = data->irq_memory + size * 0;
1057 data->fn_irq_bits = data->irq_memory + size * 1;
1058 data->current_irq_mask = data->irq_memory + size * 2;
1059 data->new_irq_mask = data->irq_memory + size * 3;
1064 int rmi_init_functions(struct rmi_driver_data *data)
1066 struct rmi_device *rmi_dev = data->rmi_dev;
1067 struct device *dev = &rmi_dev->dev;
1072 rmi_dbg(RMI_DEBUG_CORE, dev, "%s: Creating functions.\n", __func__);
1073 retval = rmi_scan_pdt(rmi_dev, &irq_count, rmi_create_function);
1075 dev_err(dev, "Function creation failed with code %d.\n",
1077 goto err_destroy_functions;
1080 if (!data->f01_container) {
1081 dev_err(dev, "Missing F01 container!\n");
1083 goto err_destroy_functions;
1086 retval = rmi_read_block(rmi_dev,
1087 data->f01_container->fd.control_base_addr + 1,
1088 data->current_irq_mask, data->num_of_irq_regs);
1090 dev_err(dev, "%s: Failed to read current IRQ mask.\n",
1092 goto err_destroy_functions;
1097 err_destroy_functions:
1098 rmi_free_function_list(rmi_dev);
1102 static int rmi_driver_probe(struct device *dev)
1104 struct rmi_driver *rmi_driver;
1105 struct rmi_driver_data *data;
1106 struct rmi_device_platform_data *pdata;
1107 struct rmi_device *rmi_dev;
1110 rmi_dbg(RMI_DEBUG_CORE, dev, "%s: Starting probe.\n",
1113 if (!rmi_is_physical_device(dev)) {
1114 rmi_dbg(RMI_DEBUG_CORE, dev, "Not a physical device.\n");
1118 rmi_dev = to_rmi_device(dev);
1119 rmi_driver = to_rmi_driver(dev->driver);
1120 rmi_dev->driver = rmi_driver;
1122 pdata = rmi_get_platform_data(rmi_dev);
1124 if (rmi_dev->xport->dev->of_node) {
1125 retval = rmi_driver_of_probe(rmi_dev->xport->dev, pdata);
1130 data = devm_kzalloc(dev, sizeof(struct rmi_driver_data), GFP_KERNEL);
1134 INIT_LIST_HEAD(&data->function_list);
1135 data->rmi_dev = rmi_dev;
1136 dev_set_drvdata(&rmi_dev->dev, data);
1139 * Right before a warm boot, the sensor might be in some unusual state,
1140 * such as F54 diagnostics, or F34 bootloader mode after a firmware
1141 * or configuration update. In order to clear the sensor to a known
1142 * state and/or apply any updates, we issue a initial reset to clear any
1143 * previous settings and force it into normal operation.
1145 * We have to do this before actually building the PDT because
1146 * the reflash updates (if any) might cause various registers to move
1149 * For a number of reasons, this initial reset may fail to return
1150 * within the specified time, but we'll still be able to bring up the
1151 * driver normally after that failure. This occurs most commonly in
1152 * a cold boot situation (where then firmware takes longer to come up
1153 * than from a warm boot) and the reset_delay_ms in the platform data
1154 * has been set too short to accommodate that. Since the sensor will
1155 * eventually come up and be usable, we don't want to just fail here
1156 * and leave the customer's device unusable. So we warn them, and
1157 * continue processing.
1159 retval = rmi_scan_pdt(rmi_dev, NULL, rmi_initial_reset);
1161 dev_warn(dev, "RMI initial reset failed! Continuing in spite of this.\n");
1163 retval = rmi_read(rmi_dev, PDT_PROPERTIES_LOCATION, &data->pdt_props);
1166 * we'll print out a warning and continue since
1167 * failure to get the PDT properties is not a cause to fail
1169 dev_warn(dev, "Could not read PDT properties from %#06x (code %d). Assuming 0x00.\n",
1170 PDT_PROPERTIES_LOCATION, retval);
1173 mutex_init(&data->irq_mutex);
1174 mutex_init(&data->enabled_mutex);
1176 retval = rmi_probe_interrupts(data);
1180 if (rmi_dev->xport->input) {
1182 * The transport driver already has an input device.
1183 * In some cases it is preferable to reuse the transport
1184 * devices input device instead of creating a new one here.
1185 * One example is some HID touchpads report "pass-through"
1186 * button events are not reported by rmi registers.
1188 data->input = rmi_dev->xport->input;
1190 data->input = devm_input_allocate_device(dev);
1192 dev_err(dev, "%s: Failed to allocate input device.\n",
1197 rmi_driver_set_input_params(rmi_dev, data->input);
1198 data->input->phys = devm_kasprintf(dev, GFP_KERNEL,
1199 "%s/input0", dev_name(dev));
1202 retval = rmi_init_functions(data);
1206 retval = rmi_f34_create_sysfs(rmi_dev);
1211 rmi_driver_set_input_name(rmi_dev, data->input);
1212 if (!rmi_dev->xport->input) {
1213 if (input_register_device(data->input)) {
1214 dev_err(dev, "%s: Failed to register input device.\n",
1216 goto err_destroy_functions;
1221 retval = rmi_irq_init(rmi_dev);
1223 goto err_destroy_functions;
1225 if (data->f01_container->dev.driver)
1226 /* Driver already bound, so enable ATTN now. */
1227 return rmi_enable_sensor(rmi_dev);
1231 err_destroy_functions:
1232 rmi_free_function_list(rmi_dev);
1234 return retval < 0 ? retval : 0;
1237 static struct rmi_driver rmi_physical_driver = {
1239 .owner = THIS_MODULE,
1240 .name = "rmi4_physical",
1241 .bus = &rmi_bus_type,
1242 .probe = rmi_driver_probe,
1243 .remove = rmi_driver_remove,
1245 .reset_handler = rmi_driver_reset_handler,
1246 .clear_irq_bits = rmi_driver_clear_irq_bits,
1247 .set_irq_bits = rmi_driver_set_irq_bits,
1248 .set_input_params = rmi_driver_set_input_params,
1251 bool rmi_is_physical_driver(struct device_driver *drv)
1253 return drv == &rmi_physical_driver.driver;
1256 int __init rmi_register_physical_driver(void)
1260 error = driver_register(&rmi_physical_driver.driver);
1262 pr_err("%s: driver register failed, code=%d.\n", __func__,
1270 void __exit rmi_unregister_physical_driver(void)
1272 driver_unregister(&rmi_physical_driver.driver);