1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2011-2016 Synaptics Incorporated
4 * Copyright (c) 2011 Unixphere
6 * This driver provides the core support for a single RMI4-based device.
8 * The RMI4 specification can be found here (URL split for line length):
10 * http://www.synaptics.com/sites/default/files/
11 * 511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
14 #include <linux/bitmap.h>
15 #include <linux/delay.h>
17 #include <linux/irq.h>
19 #include <linux/slab.h>
21 #include <linux/irqdomain.h>
22 #include <uapi/linux/input.h>
23 #include <linux/rmi.h>
25 #include "rmi_driver.h"
27 #define HAS_NONSTANDARD_PDT_MASK 0x40
28 #define RMI4_MAX_PAGE 0xff
29 #define RMI4_PAGE_SIZE 0x100
30 #define RMI4_PAGE_MASK 0xFF00
32 #define RMI_DEVICE_RESET_CMD 0x01
33 #define DEFAULT_RESET_DELAY_MS 100
35 void rmi_free_function_list(struct rmi_device *rmi_dev)
37 struct rmi_function *fn, *tmp;
38 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
40 rmi_dbg(RMI_DEBUG_CORE, &rmi_dev->dev, "Freeing function list\n");
42 /* Doing it in the reverse order so F01 will be removed last */
43 list_for_each_entry_safe_reverse(fn, tmp,
44 &data->function_list, node) {
46 rmi_unregister_function(fn);
49 devm_kfree(&rmi_dev->dev, data->irq_memory);
50 data->irq_memory = NULL;
51 data->irq_status = NULL;
52 data->fn_irq_bits = NULL;
53 data->current_irq_mask = NULL;
54 data->new_irq_mask = NULL;
56 data->f01_container = NULL;
57 data->f34_container = NULL;
60 static int reset_one_function(struct rmi_function *fn)
62 struct rmi_function_handler *fh;
65 if (!fn || !fn->dev.driver)
68 fh = to_rmi_function_handler(fn->dev.driver);
70 retval = fh->reset(fn);
72 dev_err(&fn->dev, "Reset failed with code %d.\n",
79 static int configure_one_function(struct rmi_function *fn)
81 struct rmi_function_handler *fh;
84 if (!fn || !fn->dev.driver)
87 fh = to_rmi_function_handler(fn->dev.driver);
89 retval = fh->config(fn);
91 dev_err(&fn->dev, "Config failed with code %d.\n",
98 static int rmi_driver_process_reset_requests(struct rmi_device *rmi_dev)
100 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
101 struct rmi_function *entry;
104 list_for_each_entry(entry, &data->function_list, node) {
105 retval = reset_one_function(entry);
113 static int rmi_driver_process_config_requests(struct rmi_device *rmi_dev)
115 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
116 struct rmi_function *entry;
119 list_for_each_entry(entry, &data->function_list, node) {
120 retval = configure_one_function(entry);
128 static int rmi_process_interrupt_requests(struct rmi_device *rmi_dev)
130 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
131 struct device *dev = &rmi_dev->dev;
138 if (!data->attn_data.data) {
139 error = rmi_read_block(rmi_dev,
140 data->f01_container->fd.data_base_addr + 1,
141 data->irq_status, data->num_of_irq_regs);
143 dev_err(dev, "Failed to read irqs, code=%d\n", error);
148 mutex_lock(&data->irq_mutex);
149 bitmap_and(data->irq_status, data->irq_status, data->current_irq_mask,
152 * At this point, irq_status has all bits that are set in the
153 * interrupt status register and are enabled.
155 mutex_unlock(&data->irq_mutex);
157 for_each_set_bit(i, data->irq_status, data->irq_count)
158 handle_nested_irq(irq_find_mapping(data->irqdomain, i));
161 input_sync(data->input);
166 void rmi_set_attn_data(struct rmi_device *rmi_dev, unsigned long irq_status,
167 void *data, size_t size)
169 struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
170 struct rmi4_attn_data attn_data;
173 if (!drvdata->enabled)
176 fifo_data = kmemdup(data, size, GFP_ATOMIC);
180 attn_data.irq_status = irq_status;
181 attn_data.size = size;
182 attn_data.data = fifo_data;
184 kfifo_put(&drvdata->attn_fifo, attn_data);
186 EXPORT_SYMBOL_GPL(rmi_set_attn_data);
188 static irqreturn_t rmi_irq_fn(int irq, void *dev_id)
190 struct rmi_device *rmi_dev = dev_id;
191 struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
192 struct rmi4_attn_data attn_data = {0};
195 count = kfifo_get(&drvdata->attn_fifo, &attn_data);
197 *(drvdata->irq_status) = attn_data.irq_status;
198 drvdata->attn_data = attn_data;
201 ret = rmi_process_interrupt_requests(rmi_dev);
203 rmi_dbg(RMI_DEBUG_CORE, &rmi_dev->dev,
204 "Failed to process interrupt request: %d\n", ret);
207 kfree(attn_data.data);
208 attn_data.data = NULL;
211 if (!kfifo_is_empty(&drvdata->attn_fifo))
212 return rmi_irq_fn(irq, dev_id);
217 static int rmi_irq_init(struct rmi_device *rmi_dev)
219 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
220 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
221 int irq_flags = irq_get_trigger_type(pdata->irq);
225 irq_flags = IRQF_TRIGGER_LOW;
227 ret = devm_request_threaded_irq(&rmi_dev->dev, pdata->irq, NULL,
228 rmi_irq_fn, irq_flags | IRQF_ONESHOT,
229 dev_driver_string(rmi_dev->xport->dev),
232 dev_err(&rmi_dev->dev, "Failed to register interrupt %d\n",
238 data->enabled = true;
243 struct rmi_function *rmi_find_function(struct rmi_device *rmi_dev, u8 number)
245 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
246 struct rmi_function *entry;
248 list_for_each_entry(entry, &data->function_list, node) {
249 if (entry->fd.function_number == number)
256 static int suspend_one_function(struct rmi_function *fn)
258 struct rmi_function_handler *fh;
261 if (!fn || !fn->dev.driver)
264 fh = to_rmi_function_handler(fn->dev.driver);
266 retval = fh->suspend(fn);
268 dev_err(&fn->dev, "Suspend failed with code %d.\n",
275 static int rmi_suspend_functions(struct rmi_device *rmi_dev)
277 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
278 struct rmi_function *entry;
281 list_for_each_entry(entry, &data->function_list, node) {
282 retval = suspend_one_function(entry);
290 static int resume_one_function(struct rmi_function *fn)
292 struct rmi_function_handler *fh;
295 if (!fn || !fn->dev.driver)
298 fh = to_rmi_function_handler(fn->dev.driver);
300 retval = fh->resume(fn);
302 dev_err(&fn->dev, "Resume failed with code %d.\n",
309 static int rmi_resume_functions(struct rmi_device *rmi_dev)
311 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
312 struct rmi_function *entry;
315 list_for_each_entry(entry, &data->function_list, node) {
316 retval = resume_one_function(entry);
324 int rmi_enable_sensor(struct rmi_device *rmi_dev)
328 retval = rmi_driver_process_config_requests(rmi_dev);
332 return rmi_process_interrupt_requests(rmi_dev);
336 * rmi_driver_set_input_params - set input device id and other data.
338 * @rmi_dev: Pointer to an RMI device
339 * @input: Pointer to input device
342 static int rmi_driver_set_input_params(struct rmi_device *rmi_dev,
343 struct input_dev *input)
345 input->name = SYNAPTICS_INPUT_DEVICE_NAME;
346 input->id.vendor = SYNAPTICS_VENDOR_ID;
347 input->id.bustype = BUS_RMI;
351 static void rmi_driver_set_input_name(struct rmi_device *rmi_dev,
352 struct input_dev *input)
354 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
355 const char *device_name = rmi_f01_get_product_ID(data->f01_container);
358 name = devm_kasprintf(&rmi_dev->dev, GFP_KERNEL,
359 "Synaptics %s", device_name);
366 static int rmi_driver_set_irq_bits(struct rmi_device *rmi_dev,
370 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
371 struct device *dev = &rmi_dev->dev;
373 mutex_lock(&data->irq_mutex);
374 bitmap_or(data->new_irq_mask,
375 data->current_irq_mask, mask, data->irq_count);
377 error = rmi_write_block(rmi_dev,
378 data->f01_container->fd.control_base_addr + 1,
379 data->new_irq_mask, data->num_of_irq_regs);
381 dev_err(dev, "%s: Failed to change enabled interrupts!",
385 bitmap_copy(data->current_irq_mask, data->new_irq_mask,
386 data->num_of_irq_regs);
389 mutex_unlock(&data->irq_mutex);
393 static int rmi_driver_clear_irq_bits(struct rmi_device *rmi_dev,
397 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
398 struct device *dev = &rmi_dev->dev;
400 mutex_lock(&data->irq_mutex);
401 bitmap_andnot(data->new_irq_mask,
402 data->current_irq_mask, mask, data->irq_count);
404 error = rmi_write_block(rmi_dev,
405 data->f01_container->fd.control_base_addr + 1,
406 data->new_irq_mask, data->num_of_irq_regs);
408 dev_err(dev, "%s: Failed to change enabled interrupts!",
412 bitmap_copy(data->current_irq_mask, data->new_irq_mask,
413 data->num_of_irq_regs);
416 mutex_unlock(&data->irq_mutex);
420 static int rmi_driver_reset_handler(struct rmi_device *rmi_dev)
422 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
426 * Can get called before the driver is fully ready to deal with
429 if (!data || !data->f01_container) {
430 dev_warn(&rmi_dev->dev,
431 "Not ready to handle reset yet!\n");
435 error = rmi_read_block(rmi_dev,
436 data->f01_container->fd.control_base_addr + 1,
437 data->current_irq_mask, data->num_of_irq_regs);
439 dev_err(&rmi_dev->dev, "%s: Failed to read current IRQ mask.\n",
444 error = rmi_driver_process_reset_requests(rmi_dev);
448 error = rmi_driver_process_config_requests(rmi_dev);
455 static int rmi_read_pdt_entry(struct rmi_device *rmi_dev,
456 struct pdt_entry *entry, u16 pdt_address)
458 u8 buf[RMI_PDT_ENTRY_SIZE];
461 error = rmi_read_block(rmi_dev, pdt_address, buf, RMI_PDT_ENTRY_SIZE);
463 dev_err(&rmi_dev->dev, "Read PDT entry at %#06x failed, code: %d.\n",
468 entry->page_start = pdt_address & RMI4_PAGE_MASK;
469 entry->query_base_addr = buf[0];
470 entry->command_base_addr = buf[1];
471 entry->control_base_addr = buf[2];
472 entry->data_base_addr = buf[3];
473 entry->interrupt_source_count = buf[4] & RMI_PDT_INT_SOURCE_COUNT_MASK;
474 entry->function_version = (buf[4] & RMI_PDT_FUNCTION_VERSION_MASK) >> 5;
475 entry->function_number = buf[5];
480 static void rmi_driver_copy_pdt_to_fd(const struct pdt_entry *pdt,
481 struct rmi_function_descriptor *fd)
483 fd->query_base_addr = pdt->query_base_addr + pdt->page_start;
484 fd->command_base_addr = pdt->command_base_addr + pdt->page_start;
485 fd->control_base_addr = pdt->control_base_addr + pdt->page_start;
486 fd->data_base_addr = pdt->data_base_addr + pdt->page_start;
487 fd->function_number = pdt->function_number;
488 fd->interrupt_source_count = pdt->interrupt_source_count;
489 fd->function_version = pdt->function_version;
492 #define RMI_SCAN_CONTINUE 0
493 #define RMI_SCAN_DONE 1
495 static int rmi_scan_pdt_page(struct rmi_device *rmi_dev,
499 int (*callback)(struct rmi_device *rmi_dev,
501 const struct pdt_entry *entry))
503 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
504 struct pdt_entry pdt_entry;
505 u16 page_start = RMI4_PAGE_SIZE * page;
506 u16 pdt_start = page_start + PDT_START_SCAN_LOCATION;
507 u16 pdt_end = page_start + PDT_END_SCAN_LOCATION;
512 for (addr = pdt_start; addr >= pdt_end; addr -= RMI_PDT_ENTRY_SIZE) {
513 error = rmi_read_pdt_entry(rmi_dev, &pdt_entry, addr);
517 if (RMI4_END_OF_PDT(pdt_entry.function_number))
520 retval = callback(rmi_dev, ctx, &pdt_entry);
521 if (retval != RMI_SCAN_CONTINUE)
526 * Count number of empty PDT pages. If a gap of two pages
527 * or more is found, stop scanning.
529 if (addr == pdt_start)
534 return (data->bootloader_mode || *empty_pages >= 2) ?
535 RMI_SCAN_DONE : RMI_SCAN_CONTINUE;
538 int rmi_scan_pdt(struct rmi_device *rmi_dev, void *ctx,
539 int (*callback)(struct rmi_device *rmi_dev,
540 void *ctx, const struct pdt_entry *entry))
544 int retval = RMI_SCAN_DONE;
546 for (page = 0; page <= RMI4_MAX_PAGE; page++) {
547 retval = rmi_scan_pdt_page(rmi_dev, page, &empty_pages,
549 if (retval != RMI_SCAN_CONTINUE)
553 return retval < 0 ? retval : 0;
556 int rmi_read_register_desc(struct rmi_device *d, u16 addr,
557 struct rmi_register_descriptor *rdesc)
560 u8 size_presence_reg;
562 int presense_offset = 1;
571 * The first register of the register descriptor is the size of
572 * the register descriptor's presense register.
574 ret = rmi_read(d, addr, &size_presence_reg);
579 if (size_presence_reg < 0 || size_presence_reg > 35)
582 memset(buf, 0, sizeof(buf));
585 * The presence register contains the size of the register structure
586 * and a bitmap which identified which packet registers are present
587 * for this particular register type (ie query, control, or data).
589 ret = rmi_read_block(d, addr, buf, size_presence_reg);
596 rdesc->struct_size = buf[1] | (buf[2] << 8);
598 rdesc->struct_size = buf[0];
601 for (i = presense_offset; i < size_presence_reg; i++) {
602 for (b = 0; b < 8; b++) {
603 if (buf[i] & (0x1 << b))
604 bitmap_set(rdesc->presense_map, map_offset, 1);
609 rdesc->num_registers = bitmap_weight(rdesc->presense_map,
610 RMI_REG_DESC_PRESENSE_BITS);
612 rdesc->registers = devm_kcalloc(&d->dev,
613 rdesc->num_registers,
614 sizeof(struct rmi_register_desc_item),
616 if (!rdesc->registers)
620 * Allocate a temporary buffer to hold the register structure.
621 * I'm not using devm_kzalloc here since it will not be retained
622 * after exiting this function
624 struct_buf = kzalloc(rdesc->struct_size, GFP_KERNEL);
629 * The register structure contains information about every packet
630 * register of this type. This includes the size of the packet
631 * register and a bitmap of all subpackets contained in the packet
634 ret = rmi_read_block(d, addr, struct_buf, rdesc->struct_size);
636 goto free_struct_buff;
638 reg = find_first_bit(rdesc->presense_map, RMI_REG_DESC_PRESENSE_BITS);
639 for (i = 0; i < rdesc->num_registers; i++) {
640 struct rmi_register_desc_item *item = &rdesc->registers[i];
641 int reg_size = struct_buf[offset];
645 reg_size = struct_buf[offset] |
646 (struct_buf[offset + 1] << 8);
651 reg_size = struct_buf[offset] |
652 (struct_buf[offset + 1] << 8) |
653 (struct_buf[offset + 2] << 16) |
654 (struct_buf[offset + 3] << 24);
659 item->reg_size = reg_size;
664 for (b = 0; b < 7; b++) {
665 if (struct_buf[offset] & (0x1 << b))
666 bitmap_set(item->subpacket_map,
670 } while (struct_buf[offset++] & 0x80);
672 item->num_subpackets = bitmap_weight(item->subpacket_map,
673 RMI_REG_DESC_SUBPACKET_BITS);
675 rmi_dbg(RMI_DEBUG_CORE, &d->dev,
676 "%s: reg: %d reg size: %ld subpackets: %d\n", __func__,
677 item->reg, item->reg_size, item->num_subpackets);
679 reg = find_next_bit(rdesc->presense_map,
680 RMI_REG_DESC_PRESENSE_BITS, reg + 1);
688 const struct rmi_register_desc_item *rmi_get_register_desc_item(
689 struct rmi_register_descriptor *rdesc, u16 reg)
691 const struct rmi_register_desc_item *item;
694 for (i = 0; i < rdesc->num_registers; i++) {
695 item = &rdesc->registers[i];
696 if (item->reg == reg)
703 size_t rmi_register_desc_calc_size(struct rmi_register_descriptor *rdesc)
705 const struct rmi_register_desc_item *item;
709 for (i = 0; i < rdesc->num_registers; i++) {
710 item = &rdesc->registers[i];
711 size += item->reg_size;
716 /* Compute the register offset relative to the base address */
717 int rmi_register_desc_calc_reg_offset(
718 struct rmi_register_descriptor *rdesc, u16 reg)
720 const struct rmi_register_desc_item *item;
724 for (i = 0; i < rdesc->num_registers; i++) {
725 item = &rdesc->registers[i];
726 if (item->reg == reg)
733 bool rmi_register_desc_has_subpacket(const struct rmi_register_desc_item *item,
736 return find_next_bit(item->subpacket_map, RMI_REG_DESC_PRESENSE_BITS,
737 subpacket) == subpacket;
740 static int rmi_check_bootloader_mode(struct rmi_device *rmi_dev,
741 const struct pdt_entry *pdt)
743 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
747 if (pdt->function_number == 0x34 && pdt->function_version > 1) {
748 ret = rmi_read(rmi_dev, pdt->data_base_addr, &status);
750 dev_err(&rmi_dev->dev,
751 "Failed to read F34 status: %d.\n", ret);
756 data->bootloader_mode = true;
757 } else if (pdt->function_number == 0x01) {
758 ret = rmi_read(rmi_dev, pdt->data_base_addr, &status);
760 dev_err(&rmi_dev->dev,
761 "Failed to read F01 status: %d.\n", ret);
766 data->bootloader_mode = true;
772 static int rmi_count_irqs(struct rmi_device *rmi_dev,
773 void *ctx, const struct pdt_entry *pdt)
775 int *irq_count = ctx;
778 *irq_count += pdt->interrupt_source_count;
780 ret = rmi_check_bootloader_mode(rmi_dev, pdt);
784 return RMI_SCAN_CONTINUE;
787 int rmi_initial_reset(struct rmi_device *rmi_dev, void *ctx,
788 const struct pdt_entry *pdt)
792 if (pdt->function_number == 0x01) {
793 u16 cmd_addr = pdt->page_start + pdt->command_base_addr;
794 u8 cmd_buf = RMI_DEVICE_RESET_CMD;
795 const struct rmi_device_platform_data *pdata =
796 rmi_get_platform_data(rmi_dev);
798 if (rmi_dev->xport->ops->reset) {
799 error = rmi_dev->xport->ops->reset(rmi_dev->xport,
804 return RMI_SCAN_DONE;
807 rmi_dbg(RMI_DEBUG_CORE, &rmi_dev->dev, "Sending reset\n");
808 error = rmi_write_block(rmi_dev, cmd_addr, &cmd_buf, 1);
810 dev_err(&rmi_dev->dev,
811 "Initial reset failed. Code = %d.\n", error);
815 mdelay(pdata->reset_delay_ms ?: DEFAULT_RESET_DELAY_MS);
817 return RMI_SCAN_DONE;
820 /* F01 should always be on page 0. If we don't find it there, fail. */
821 return pdt->page_start == 0 ? RMI_SCAN_CONTINUE : -ENODEV;
824 static int rmi_create_function(struct rmi_device *rmi_dev,
825 void *ctx, const struct pdt_entry *pdt)
827 struct device *dev = &rmi_dev->dev;
828 struct rmi_driver_data *data = dev_get_drvdata(dev);
829 int *current_irq_count = ctx;
830 struct rmi_function *fn;
834 rmi_dbg(RMI_DEBUG_CORE, dev, "Initializing F%02X.\n",
835 pdt->function_number);
837 fn = kzalloc(sizeof(struct rmi_function) +
838 BITS_TO_LONGS(data->irq_count) * sizeof(unsigned long),
841 dev_err(dev, "Failed to allocate memory for F%02X\n",
842 pdt->function_number);
846 INIT_LIST_HEAD(&fn->node);
847 rmi_driver_copy_pdt_to_fd(pdt, &fn->fd);
849 fn->rmi_dev = rmi_dev;
851 fn->num_of_irqs = pdt->interrupt_source_count;
852 fn->irq_pos = *current_irq_count;
853 *current_irq_count += fn->num_of_irqs;
855 for (i = 0; i < fn->num_of_irqs; i++)
856 set_bit(fn->irq_pos + i, fn->irq_mask);
858 error = rmi_register_function(fn);
862 if (pdt->function_number == 0x01)
863 data->f01_container = fn;
864 else if (pdt->function_number == 0x34)
865 data->f34_container = fn;
867 list_add_tail(&fn->node, &data->function_list);
869 return RMI_SCAN_CONTINUE;
872 void rmi_enable_irq(struct rmi_device *rmi_dev, bool clear_wake)
874 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
875 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
876 int irq = pdata->irq;
880 mutex_lock(&data->enabled_mutex);
886 data->enabled = true;
887 if (clear_wake && device_may_wakeup(rmi_dev->xport->dev)) {
888 retval = disable_irq_wake(irq);
890 dev_warn(&rmi_dev->dev,
891 "Failed to disable irq for wake: %d\n",
896 * Call rmi_process_interrupt_requests() after enabling irq,
897 * otherwise we may lose interrupt on edge-triggered systems.
899 irq_flags = irq_get_trigger_type(pdata->irq);
900 if (irq_flags & IRQ_TYPE_EDGE_BOTH)
901 rmi_process_interrupt_requests(rmi_dev);
904 mutex_unlock(&data->enabled_mutex);
907 void rmi_disable_irq(struct rmi_device *rmi_dev, bool enable_wake)
909 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
910 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
911 struct rmi4_attn_data attn_data = {0};
912 int irq = pdata->irq;
915 mutex_lock(&data->enabled_mutex);
920 data->enabled = false;
922 if (enable_wake && device_may_wakeup(rmi_dev->xport->dev)) {
923 retval = enable_irq_wake(irq);
925 dev_warn(&rmi_dev->dev,
926 "Failed to enable irq for wake: %d\n",
930 /* make sure the fifo is clean */
931 while (!kfifo_is_empty(&data->attn_fifo)) {
932 count = kfifo_get(&data->attn_fifo, &attn_data);
934 kfree(attn_data.data);
938 mutex_unlock(&data->enabled_mutex);
941 int rmi_driver_suspend(struct rmi_device *rmi_dev, bool enable_wake)
945 retval = rmi_suspend_functions(rmi_dev);
947 dev_warn(&rmi_dev->dev, "Failed to suspend functions: %d\n",
950 rmi_disable_irq(rmi_dev, enable_wake);
953 EXPORT_SYMBOL_GPL(rmi_driver_suspend);
955 int rmi_driver_resume(struct rmi_device *rmi_dev, bool clear_wake)
959 rmi_enable_irq(rmi_dev, clear_wake);
961 retval = rmi_resume_functions(rmi_dev);
963 dev_warn(&rmi_dev->dev, "Failed to suspend functions: %d\n",
968 EXPORT_SYMBOL_GPL(rmi_driver_resume);
970 static int rmi_driver_remove(struct device *dev)
972 struct rmi_device *rmi_dev = to_rmi_device(dev);
973 struct rmi_driver_data *data = dev_get_drvdata(&rmi_dev->dev);
975 rmi_disable_irq(rmi_dev, false);
977 irq_domain_remove(data->irqdomain);
978 data->irqdomain = NULL;
980 rmi_f34_remove_sysfs(rmi_dev);
981 rmi_free_function_list(rmi_dev);
987 static int rmi_driver_of_probe(struct device *dev,
988 struct rmi_device_platform_data *pdata)
992 retval = rmi_of_property_read_u32(dev, &pdata->reset_delay_ms,
993 "syna,reset-delay-ms", 1);
1000 static inline int rmi_driver_of_probe(struct device *dev,
1001 struct rmi_device_platform_data *pdata)
1007 int rmi_probe_interrupts(struct rmi_driver_data *data)
1009 struct rmi_device *rmi_dev = data->rmi_dev;
1010 struct device *dev = &rmi_dev->dev;
1011 struct fwnode_handle *fwnode = rmi_dev->xport->dev->fwnode;
1017 * We need to count the IRQs and allocate their storage before scanning
1018 * the PDT and creating the function entries, because adding a new
1019 * function can trigger events that result in the IRQ related storage
1022 rmi_dbg(RMI_DEBUG_CORE, dev, "%s: Counting IRQs.\n", __func__);
1023 data->bootloader_mode = false;
1025 retval = rmi_scan_pdt(rmi_dev, &irq_count, rmi_count_irqs);
1027 dev_err(dev, "IRQ counting failed with code %d.\n", retval);
1031 if (data->bootloader_mode)
1032 dev_warn(dev, "Device in bootloader mode.\n");
1034 /* Allocate and register a linear revmap irq_domain */
1035 data->irqdomain = irq_domain_create_linear(fwnode, irq_count,
1036 &irq_domain_simple_ops,
1038 if (!data->irqdomain) {
1039 dev_err(&rmi_dev->dev, "Failed to create IRQ domain\n");
1043 data->irq_count = irq_count;
1044 data->num_of_irq_regs = (data->irq_count + 7) / 8;
1046 size = BITS_TO_LONGS(data->irq_count) * sizeof(unsigned long);
1047 data->irq_memory = devm_kcalloc(dev, size, 4, GFP_KERNEL);
1048 if (!data->irq_memory) {
1049 dev_err(dev, "Failed to allocate memory for irq masks.\n");
1053 data->irq_status = data->irq_memory + size * 0;
1054 data->fn_irq_bits = data->irq_memory + size * 1;
1055 data->current_irq_mask = data->irq_memory + size * 2;
1056 data->new_irq_mask = data->irq_memory + size * 3;
1061 int rmi_init_functions(struct rmi_driver_data *data)
1063 struct rmi_device *rmi_dev = data->rmi_dev;
1064 struct device *dev = &rmi_dev->dev;
1068 rmi_dbg(RMI_DEBUG_CORE, dev, "%s: Creating functions.\n", __func__);
1069 retval = rmi_scan_pdt(rmi_dev, &irq_count, rmi_create_function);
1071 dev_err(dev, "Function creation failed with code %d.\n",
1073 goto err_destroy_functions;
1076 if (!data->f01_container) {
1077 dev_err(dev, "Missing F01 container!\n");
1079 goto err_destroy_functions;
1082 retval = rmi_read_block(rmi_dev,
1083 data->f01_container->fd.control_base_addr + 1,
1084 data->current_irq_mask, data->num_of_irq_regs);
1086 dev_err(dev, "%s: Failed to read current IRQ mask.\n",
1088 goto err_destroy_functions;
1093 err_destroy_functions:
1094 rmi_free_function_list(rmi_dev);
1098 static int rmi_driver_probe(struct device *dev)
1100 struct rmi_driver *rmi_driver;
1101 struct rmi_driver_data *data;
1102 struct rmi_device_platform_data *pdata;
1103 struct rmi_device *rmi_dev;
1106 rmi_dbg(RMI_DEBUG_CORE, dev, "%s: Starting probe.\n",
1109 if (!rmi_is_physical_device(dev)) {
1110 rmi_dbg(RMI_DEBUG_CORE, dev, "Not a physical device.\n");
1114 rmi_dev = to_rmi_device(dev);
1115 rmi_driver = to_rmi_driver(dev->driver);
1116 rmi_dev->driver = rmi_driver;
1118 pdata = rmi_get_platform_data(rmi_dev);
1120 if (rmi_dev->xport->dev->of_node) {
1121 retval = rmi_driver_of_probe(rmi_dev->xport->dev, pdata);
1126 data = devm_kzalloc(dev, sizeof(struct rmi_driver_data), GFP_KERNEL);
1130 INIT_LIST_HEAD(&data->function_list);
1131 data->rmi_dev = rmi_dev;
1132 dev_set_drvdata(&rmi_dev->dev, data);
1135 * Right before a warm boot, the sensor might be in some unusual state,
1136 * such as F54 diagnostics, or F34 bootloader mode after a firmware
1137 * or configuration update. In order to clear the sensor to a known
1138 * state and/or apply any updates, we issue a initial reset to clear any
1139 * previous settings and force it into normal operation.
1141 * We have to do this before actually building the PDT because
1142 * the reflash updates (if any) might cause various registers to move
1145 * For a number of reasons, this initial reset may fail to return
1146 * within the specified time, but we'll still be able to bring up the
1147 * driver normally after that failure. This occurs most commonly in
1148 * a cold boot situation (where then firmware takes longer to come up
1149 * than from a warm boot) and the reset_delay_ms in the platform data
1150 * has been set too short to accommodate that. Since the sensor will
1151 * eventually come up and be usable, we don't want to just fail here
1152 * and leave the customer's device unusable. So we warn them, and
1153 * continue processing.
1155 retval = rmi_scan_pdt(rmi_dev, NULL, rmi_initial_reset);
1157 dev_warn(dev, "RMI initial reset failed! Continuing in spite of this.\n");
1159 retval = rmi_read(rmi_dev, PDT_PROPERTIES_LOCATION, &data->pdt_props);
1162 * we'll print out a warning and continue since
1163 * failure to get the PDT properties is not a cause to fail
1165 dev_warn(dev, "Could not read PDT properties from %#06x (code %d). Assuming 0x00.\n",
1166 PDT_PROPERTIES_LOCATION, retval);
1169 mutex_init(&data->irq_mutex);
1170 mutex_init(&data->enabled_mutex);
1172 retval = rmi_probe_interrupts(data);
1176 if (rmi_dev->xport->input) {
1178 * The transport driver already has an input device.
1179 * In some cases it is preferable to reuse the transport
1180 * devices input device instead of creating a new one here.
1181 * One example is some HID touchpads report "pass-through"
1182 * button events are not reported by rmi registers.
1184 data->input = rmi_dev->xport->input;
1186 data->input = devm_input_allocate_device(dev);
1188 dev_err(dev, "%s: Failed to allocate input device.\n",
1193 rmi_driver_set_input_params(rmi_dev, data->input);
1194 data->input->phys = devm_kasprintf(dev, GFP_KERNEL,
1195 "%s/input0", dev_name(dev));
1198 retval = rmi_init_functions(data);
1202 retval = rmi_f34_create_sysfs(rmi_dev);
1207 rmi_driver_set_input_name(rmi_dev, data->input);
1208 if (!rmi_dev->xport->input) {
1209 if (input_register_device(data->input)) {
1210 dev_err(dev, "%s: Failed to register input device.\n",
1212 goto err_destroy_functions;
1217 retval = rmi_irq_init(rmi_dev);
1219 goto err_destroy_functions;
1221 if (data->f01_container->dev.driver) {
1222 /* Driver already bound, so enable ATTN now. */
1223 retval = rmi_enable_sensor(rmi_dev);
1225 goto err_disable_irq;
1231 rmi_disable_irq(rmi_dev, false);
1232 err_destroy_functions:
1233 rmi_free_function_list(rmi_dev);
1238 static struct rmi_driver rmi_physical_driver = {
1240 .owner = THIS_MODULE,
1241 .name = "rmi4_physical",
1242 .bus = &rmi_bus_type,
1243 .probe = rmi_driver_probe,
1244 .remove = rmi_driver_remove,
1246 .reset_handler = rmi_driver_reset_handler,
1247 .clear_irq_bits = rmi_driver_clear_irq_bits,
1248 .set_irq_bits = rmi_driver_set_irq_bits,
1249 .set_input_params = rmi_driver_set_input_params,
1252 bool rmi_is_physical_driver(struct device_driver *drv)
1254 return drv == &rmi_physical_driver.driver;
1257 int __init rmi_register_physical_driver(void)
1261 error = driver_register(&rmi_physical_driver.driver);
1263 pr_err("%s: driver register failed, code=%d.\n", __func__,
1271 void __exit rmi_unregister_physical_driver(void)
1273 driver_unregister(&rmi_physical_driver.driver);