1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Azoteq IQS7222A/B/C Capacitive Touch Controller
5 * Copyright (C) 2022 Jeff LaBundy <jeff@labundy.com>
8 #include <linux/bits.h>
9 #include <linux/delay.h>
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/gpio/consumer.h>
13 #include <linux/i2c.h>
14 #include <linux/input.h>
15 #include <linux/interrupt.h>
16 #include <linux/kernel.h>
17 #include <linux/ktime.h>
18 #include <linux/module.h>
19 #include <linux/of_device.h>
20 #include <linux/property.h>
21 #include <linux/slab.h>
22 #include <asm/unaligned.h>
24 #define IQS7222_PROD_NUM 0x00
25 #define IQS7222_PROD_NUM_A 840
26 #define IQS7222_PROD_NUM_B 698
27 #define IQS7222_PROD_NUM_C 863
29 #define IQS7222_SYS_STATUS 0x10
30 #define IQS7222_SYS_STATUS_RESET BIT(3)
31 #define IQS7222_SYS_STATUS_ATI_ERROR BIT(1)
32 #define IQS7222_SYS_STATUS_ATI_ACTIVE BIT(0)
34 #define IQS7222_CHAN_SETUP_0_REF_MODE_MASK GENMASK(15, 14)
35 #define IQS7222_CHAN_SETUP_0_REF_MODE_FOLLOW BIT(15)
36 #define IQS7222_CHAN_SETUP_0_REF_MODE_REF BIT(14)
37 #define IQS7222_CHAN_SETUP_0_CHAN_EN BIT(8)
39 #define IQS7222_SLDR_SETUP_0_CHAN_CNT_MASK GENMASK(2, 0)
40 #define IQS7222_SLDR_SETUP_2_RES_MASK GENMASK(15, 8)
41 #define IQS7222_SLDR_SETUP_2_RES_SHIFT 8
42 #define IQS7222_SLDR_SETUP_2_TOP_SPEED_MASK GENMASK(7, 0)
44 #define IQS7222_GPIO_SETUP_0_GPIO_EN BIT(0)
46 #define IQS7222_SYS_SETUP 0xD0
47 #define IQS7222_SYS_SETUP_INTF_MODE_MASK GENMASK(7, 6)
48 #define IQS7222_SYS_SETUP_INTF_MODE_TOUCH BIT(7)
49 #define IQS7222_SYS_SETUP_INTF_MODE_EVENT BIT(6)
50 #define IQS7222_SYS_SETUP_PWR_MODE_MASK GENMASK(5, 4)
51 #define IQS7222_SYS_SETUP_PWR_MODE_AUTO IQS7222_SYS_SETUP_PWR_MODE_MASK
52 #define IQS7222_SYS_SETUP_REDO_ATI BIT(2)
53 #define IQS7222_SYS_SETUP_ACK_RESET BIT(0)
55 #define IQS7222_EVENT_MASK_ATI BIT(12)
56 #define IQS7222_EVENT_MASK_SLDR BIT(10)
57 #define IQS7222_EVENT_MASK_TOUCH BIT(1)
58 #define IQS7222_EVENT_MASK_PROX BIT(0)
60 #define IQS7222_COMMS_HOLD BIT(0)
61 #define IQS7222_COMMS_ERROR 0xEEEE
62 #define IQS7222_COMMS_RETRY_MS 50
63 #define IQS7222_COMMS_TIMEOUT_MS 100
64 #define IQS7222_RESET_TIMEOUT_MS 250
65 #define IQS7222_ATI_TIMEOUT_MS 2000
67 #define IQS7222_MAX_COLS_STAT 8
68 #define IQS7222_MAX_COLS_CYCLE 3
69 #define IQS7222_MAX_COLS_GLBL 3
70 #define IQS7222_MAX_COLS_BTN 3
71 #define IQS7222_MAX_COLS_CHAN 6
72 #define IQS7222_MAX_COLS_FILT 2
73 #define IQS7222_MAX_COLS_SLDR 11
74 #define IQS7222_MAX_COLS_GPIO 3
75 #define IQS7222_MAX_COLS_SYS 13
77 #define IQS7222_MAX_CHAN 20
78 #define IQS7222_MAX_SLDR 2
80 #define IQS7222_NUM_RETRIES 5
81 #define IQS7222_REG_OFFSET 0x100
83 enum iqs7222_reg_key_id {
86 IQS7222_REG_KEY_TOUCH,
87 IQS7222_REG_KEY_DEBOUNCE,
89 IQS7222_REG_KEY_AXIAL,
90 IQS7222_REG_KEY_WHEEL,
91 IQS7222_REG_KEY_NO_WHEEL,
92 IQS7222_REG_KEY_RESERVED
95 enum iqs7222_reg_grp_id {
98 IQS7222_REG_GRP_CYCLE,
101 IQS7222_REG_GRP_CHAN,
102 IQS7222_REG_GRP_SLDR,
103 IQS7222_REG_GRP_GPIO,
108 static const char * const iqs7222_reg_grp_names[IQS7222_NUM_REG_GRPS] = {
109 [IQS7222_REG_GRP_CYCLE] = "cycle",
110 [IQS7222_REG_GRP_CHAN] = "channel",
111 [IQS7222_REG_GRP_SLDR] = "slider",
112 [IQS7222_REG_GRP_GPIO] = "gpio",
115 static const unsigned int iqs7222_max_cols[IQS7222_NUM_REG_GRPS] = {
116 [IQS7222_REG_GRP_STAT] = IQS7222_MAX_COLS_STAT,
117 [IQS7222_REG_GRP_CYCLE] = IQS7222_MAX_COLS_CYCLE,
118 [IQS7222_REG_GRP_GLBL] = IQS7222_MAX_COLS_GLBL,
119 [IQS7222_REG_GRP_BTN] = IQS7222_MAX_COLS_BTN,
120 [IQS7222_REG_GRP_CHAN] = IQS7222_MAX_COLS_CHAN,
121 [IQS7222_REG_GRP_FILT] = IQS7222_MAX_COLS_FILT,
122 [IQS7222_REG_GRP_SLDR] = IQS7222_MAX_COLS_SLDR,
123 [IQS7222_REG_GRP_GPIO] = IQS7222_MAX_COLS_GPIO,
124 [IQS7222_REG_GRP_SYS] = IQS7222_MAX_COLS_SYS,
127 static const unsigned int iqs7222_gpio_links[] = { 2, 5, 6, };
129 struct iqs7222_event_desc {
134 enum iqs7222_reg_key_id reg_key;
137 static const struct iqs7222_event_desc iqs7222_kp_events[] = {
139 .name = "event-prox",
140 .enable = IQS7222_EVENT_MASK_PROX,
141 .reg_key = IQS7222_REG_KEY_PROX,
144 .name = "event-touch",
145 .enable = IQS7222_EVENT_MASK_TOUCH,
146 .reg_key = IQS7222_REG_KEY_TOUCH,
150 static const struct iqs7222_event_desc iqs7222_sl_events[] = {
151 { .name = "event-press", },
157 .reg_key = IQS7222_REG_KEY_TAP,
160 .name = "event-swipe-pos",
161 .mask = BIT(5) | BIT(1),
164 .reg_key = IQS7222_REG_KEY_AXIAL,
167 .name = "event-swipe-neg",
168 .mask = BIT(5) | BIT(1),
169 .val = BIT(5) | BIT(1),
171 .reg_key = IQS7222_REG_KEY_AXIAL,
174 .name = "event-flick-pos",
175 .mask = BIT(5) | BIT(2),
178 .reg_key = IQS7222_REG_KEY_AXIAL,
181 .name = "event-flick-neg",
182 .mask = BIT(5) | BIT(2),
183 .val = BIT(5) | BIT(2),
185 .reg_key = IQS7222_REG_KEY_AXIAL,
189 struct iqs7222_reg_grp_desc {
195 struct iqs7222_dev_desc {
205 struct iqs7222_reg_grp_desc reg_grps[IQS7222_NUM_REG_GRPS];
208 static const struct iqs7222_dev_desc iqs7222_devs[] = {
210 .prod_num = IQS7222_PROD_NUM_A,
213 .sldr_res = U8_MAX * 16,
219 [IQS7222_REG_GRP_STAT] = {
220 .base = IQS7222_SYS_STATUS,
224 [IQS7222_REG_GRP_CYCLE] = {
229 [IQS7222_REG_GRP_GLBL] = {
234 [IQS7222_REG_GRP_BTN] = {
239 [IQS7222_REG_GRP_CHAN] = {
244 [IQS7222_REG_GRP_FILT] = {
249 [IQS7222_REG_GRP_SLDR] = {
254 [IQS7222_REG_GRP_GPIO] = {
259 [IQS7222_REG_GRP_SYS] = {
260 .base = IQS7222_SYS_SETUP,
267 .prod_num = IQS7222_PROD_NUM_B,
273 [IQS7222_REG_GRP_STAT] = {
274 .base = IQS7222_SYS_STATUS,
278 [IQS7222_REG_GRP_CYCLE] = {
283 [IQS7222_REG_GRP_GLBL] = {
288 [IQS7222_REG_GRP_BTN] = {
293 [IQS7222_REG_GRP_CHAN] = {
298 [IQS7222_REG_GRP_FILT] = {
303 [IQS7222_REG_GRP_SYS] = {
304 .base = IQS7222_SYS_SETUP,
311 .prod_num = IQS7222_PROD_NUM_B,
315 [IQS7222_REG_GRP_STAT] = {
316 .base = IQS7222_SYS_STATUS,
320 [IQS7222_REG_GRP_CYCLE] = {
325 [IQS7222_REG_GRP_GLBL] = {
330 [IQS7222_REG_GRP_BTN] = {
335 [IQS7222_REG_GRP_CHAN] = {
340 [IQS7222_REG_GRP_FILT] = {
345 [IQS7222_REG_GRP_SYS] = {
346 .base = IQS7222_SYS_SETUP,
353 .prod_num = IQS7222_PROD_NUM_C,
358 .wheel_enable = BIT(3),
362 [IQS7222_REG_GRP_STAT] = {
363 .base = IQS7222_SYS_STATUS,
367 [IQS7222_REG_GRP_CYCLE] = {
372 [IQS7222_REG_GRP_GLBL] = {
377 [IQS7222_REG_GRP_BTN] = {
382 [IQS7222_REG_GRP_CHAN] = {
387 [IQS7222_REG_GRP_FILT] = {
392 [IQS7222_REG_GRP_SLDR] = {
397 [IQS7222_REG_GRP_GPIO] = {
402 [IQS7222_REG_GRP_SYS] = {
403 .base = IQS7222_SYS_SETUP,
410 .prod_num = IQS7222_PROD_NUM_C,
415 .wheel_enable = BIT(3),
419 [IQS7222_REG_GRP_STAT] = {
420 .base = IQS7222_SYS_STATUS,
424 [IQS7222_REG_GRP_CYCLE] = {
429 [IQS7222_REG_GRP_GLBL] = {
434 [IQS7222_REG_GRP_BTN] = {
439 [IQS7222_REG_GRP_CHAN] = {
444 [IQS7222_REG_GRP_FILT] = {
449 [IQS7222_REG_GRP_SLDR] = {
454 [IQS7222_REG_GRP_GPIO] = {
459 [IQS7222_REG_GRP_SYS] = {
460 .base = IQS7222_SYS_SETUP,
468 struct iqs7222_prop_desc {
470 enum iqs7222_reg_grp_id reg_grp;
471 enum iqs7222_reg_key_id reg_key;
482 static const struct iqs7222_prop_desc iqs7222_props[] = {
484 .name = "azoteq,conv-period",
485 .reg_grp = IQS7222_REG_GRP_CYCLE,
489 .label = "conversion period",
492 .name = "azoteq,conv-frac",
493 .reg_grp = IQS7222_REG_GRP_CYCLE,
497 .label = "conversion frequency fractional divider",
500 .name = "azoteq,rx-float-inactive",
501 .reg_grp = IQS7222_REG_GRP_CYCLE,
508 .name = "azoteq,dead-time-enable",
509 .reg_grp = IQS7222_REG_GRP_CYCLE,
515 .name = "azoteq,tx-freq-fosc",
516 .reg_grp = IQS7222_REG_GRP_CYCLE,
522 .name = "azoteq,vbias-enable",
523 .reg_grp = IQS7222_REG_GRP_CYCLE,
529 .name = "azoteq,sense-mode",
530 .reg_grp = IQS7222_REG_GRP_CYCLE,
535 .label = "sensing mode",
538 .name = "azoteq,iref-enable",
539 .reg_grp = IQS7222_REG_GRP_CYCLE,
545 .name = "azoteq,iref-level",
546 .reg_grp = IQS7222_REG_GRP_CYCLE,
550 .label = "current reference level",
553 .name = "azoteq,iref-trim",
554 .reg_grp = IQS7222_REG_GRP_CYCLE,
558 .label = "current reference trim",
561 .name = "azoteq,max-counts",
562 .reg_grp = IQS7222_REG_GRP_GLBL,
566 .label = "maximum counts",
569 .name = "azoteq,auto-mode",
570 .reg_grp = IQS7222_REG_GRP_GLBL,
574 .label = "number of conversions",
577 .name = "azoteq,ati-frac-div-fine",
578 .reg_grp = IQS7222_REG_GRP_GLBL,
582 .label = "ATI fine fractional divider",
585 .name = "azoteq,ati-frac-div-coarse",
586 .reg_grp = IQS7222_REG_GRP_GLBL,
590 .label = "ATI coarse fractional divider",
593 .name = "azoteq,ati-comp-select",
594 .reg_grp = IQS7222_REG_GRP_GLBL,
598 .label = "ATI compensation selection",
601 .name = "azoteq,ati-band",
602 .reg_grp = IQS7222_REG_GRP_CHAN,
609 .name = "azoteq,global-halt",
610 .reg_grp = IQS7222_REG_GRP_CHAN,
616 .name = "azoteq,invert-enable",
617 .reg_grp = IQS7222_REG_GRP_CHAN,
623 .name = "azoteq,dual-direction",
624 .reg_grp = IQS7222_REG_GRP_CHAN,
630 .name = "azoteq,samp-cap-double",
631 .reg_grp = IQS7222_REG_GRP_CHAN,
637 .name = "azoteq,vref-half",
638 .reg_grp = IQS7222_REG_GRP_CHAN,
644 .name = "azoteq,proj-bias",
645 .reg_grp = IQS7222_REG_GRP_CHAN,
649 .label = "projected bias current",
652 .name = "azoteq,ati-target",
653 .reg_grp = IQS7222_REG_GRP_CHAN,
658 .label = "ATI target",
661 .name = "azoteq,ati-base",
662 .reg_grp = IQS7222_REG_GRP_CHAN,
670 .name = "azoteq,ati-mode",
671 .reg_grp = IQS7222_REG_GRP_CHAN,
679 .name = "azoteq,ati-frac-div-fine",
680 .reg_grp = IQS7222_REG_GRP_CHAN,
684 .label = "ATI fine fractional divider",
687 .name = "azoteq,ati-frac-mult-coarse",
688 .reg_grp = IQS7222_REG_GRP_CHAN,
692 .label = "ATI coarse fractional multiplier",
695 .name = "azoteq,ati-frac-div-coarse",
696 .reg_grp = IQS7222_REG_GRP_CHAN,
700 .label = "ATI coarse fractional divider",
703 .name = "azoteq,ati-comp-div",
704 .reg_grp = IQS7222_REG_GRP_CHAN,
708 .label = "ATI compensation divider",
711 .name = "azoteq,ati-comp-select",
712 .reg_grp = IQS7222_REG_GRP_CHAN,
716 .label = "ATI compensation selection",
719 .name = "azoteq,debounce-exit",
720 .reg_grp = IQS7222_REG_GRP_BTN,
721 .reg_key = IQS7222_REG_KEY_DEBOUNCE,
725 .label = "debounce exit factor",
728 .name = "azoteq,debounce-enter",
729 .reg_grp = IQS7222_REG_GRP_BTN,
730 .reg_key = IQS7222_REG_KEY_DEBOUNCE,
734 .label = "debounce entrance factor",
737 .name = "azoteq,thresh",
738 .reg_grp = IQS7222_REG_GRP_BTN,
739 .reg_key = IQS7222_REG_KEY_PROX,
744 .label = "threshold",
747 .name = "azoteq,thresh",
748 .reg_grp = IQS7222_REG_GRP_BTN,
749 .reg_key = IQS7222_REG_KEY_TOUCH,
753 .label = "threshold",
756 .name = "azoteq,hyst",
757 .reg_grp = IQS7222_REG_GRP_BTN,
758 .reg_key = IQS7222_REG_KEY_TOUCH,
762 .label = "hysteresis",
765 .name = "azoteq,lta-beta-lp",
766 .reg_grp = IQS7222_REG_GRP_FILT,
770 .label = "low-power mode long-term average beta",
773 .name = "azoteq,lta-beta-np",
774 .reg_grp = IQS7222_REG_GRP_FILT,
778 .label = "normal-power mode long-term average beta",
781 .name = "azoteq,counts-beta-lp",
782 .reg_grp = IQS7222_REG_GRP_FILT,
786 .label = "low-power mode counts beta",
789 .name = "azoteq,counts-beta-np",
790 .reg_grp = IQS7222_REG_GRP_FILT,
794 .label = "normal-power mode counts beta",
797 .name = "azoteq,lta-fast-beta-lp",
798 .reg_grp = IQS7222_REG_GRP_FILT,
802 .label = "low-power mode long-term average fast beta",
805 .name = "azoteq,lta-fast-beta-np",
806 .reg_grp = IQS7222_REG_GRP_FILT,
810 .label = "normal-power mode long-term average fast beta",
813 .name = "azoteq,lower-cal",
814 .reg_grp = IQS7222_REG_GRP_SLDR,
818 .label = "lower calibration",
821 .name = "azoteq,static-beta",
822 .reg_grp = IQS7222_REG_GRP_SLDR,
823 .reg_key = IQS7222_REG_KEY_NO_WHEEL,
829 .name = "azoteq,bottom-beta",
830 .reg_grp = IQS7222_REG_GRP_SLDR,
831 .reg_key = IQS7222_REG_KEY_NO_WHEEL,
835 .label = "bottom beta",
838 .name = "azoteq,static-beta",
839 .reg_grp = IQS7222_REG_GRP_SLDR,
840 .reg_key = IQS7222_REG_KEY_WHEEL,
846 .name = "azoteq,bottom-beta",
847 .reg_grp = IQS7222_REG_GRP_SLDR,
848 .reg_key = IQS7222_REG_KEY_WHEEL,
852 .label = "bottom beta",
855 .name = "azoteq,bottom-speed",
856 .reg_grp = IQS7222_REG_GRP_SLDR,
860 .label = "bottom speed",
863 .name = "azoteq,upper-cal",
864 .reg_grp = IQS7222_REG_GRP_SLDR,
868 .label = "upper calibration",
871 .name = "azoteq,gesture-max-ms",
872 .reg_grp = IQS7222_REG_GRP_SLDR,
873 .reg_key = IQS7222_REG_KEY_TAP,
878 .label = "maximum gesture time",
881 .name = "azoteq,gesture-min-ms",
882 .reg_grp = IQS7222_REG_GRP_SLDR,
883 .reg_key = IQS7222_REG_KEY_TAP,
888 .label = "minimum gesture time",
891 .name = "azoteq,gesture-dist",
892 .reg_grp = IQS7222_REG_GRP_SLDR,
893 .reg_key = IQS7222_REG_KEY_AXIAL,
898 .label = "gesture distance",
901 .name = "azoteq,gesture-max-ms",
902 .reg_grp = IQS7222_REG_GRP_SLDR,
903 .reg_key = IQS7222_REG_KEY_AXIAL,
908 .label = "maximum gesture time",
911 .name = "drive-open-drain",
912 .reg_grp = IQS7222_REG_GRP_GPIO,
918 .name = "azoteq,timeout-ati-ms",
919 .reg_grp = IQS7222_REG_GRP_SYS,
924 .label = "ATI error timeout",
927 .name = "azoteq,rate-ati-ms",
928 .reg_grp = IQS7222_REG_GRP_SYS,
932 .label = "ATI report rate",
935 .name = "azoteq,timeout-np-ms",
936 .reg_grp = IQS7222_REG_GRP_SYS,
940 .label = "normal-power mode timeout",
943 .name = "azoteq,rate-np-ms",
944 .reg_grp = IQS7222_REG_GRP_SYS,
949 .label = "normal-power mode report rate",
952 .name = "azoteq,timeout-lp-ms",
953 .reg_grp = IQS7222_REG_GRP_SYS,
957 .label = "low-power mode timeout",
960 .name = "azoteq,rate-lp-ms",
961 .reg_grp = IQS7222_REG_GRP_SYS,
966 .label = "low-power mode report rate",
969 .name = "azoteq,timeout-ulp-ms",
970 .reg_grp = IQS7222_REG_GRP_SYS,
974 .label = "ultra-low-power mode timeout",
977 .name = "azoteq,rate-ulp-ms",
978 .reg_grp = IQS7222_REG_GRP_SYS,
983 .label = "ultra-low-power mode report rate",
987 struct iqs7222_private {
988 const struct iqs7222_dev_desc *dev_desc;
989 struct gpio_desc *reset_gpio;
990 struct gpio_desc *irq_gpio;
991 struct i2c_client *client;
992 struct input_dev *keypad;
993 unsigned int kp_type[IQS7222_MAX_CHAN][ARRAY_SIZE(iqs7222_kp_events)];
994 unsigned int kp_code[IQS7222_MAX_CHAN][ARRAY_SIZE(iqs7222_kp_events)];
995 unsigned int sl_code[IQS7222_MAX_SLDR][ARRAY_SIZE(iqs7222_sl_events)];
996 unsigned int sl_axis[IQS7222_MAX_SLDR];
997 u16 cycle_setup[IQS7222_MAX_CHAN / 2][IQS7222_MAX_COLS_CYCLE];
998 u16 glbl_setup[IQS7222_MAX_COLS_GLBL];
999 u16 btn_setup[IQS7222_MAX_CHAN][IQS7222_MAX_COLS_BTN];
1000 u16 chan_setup[IQS7222_MAX_CHAN][IQS7222_MAX_COLS_CHAN];
1001 u16 filt_setup[IQS7222_MAX_COLS_FILT];
1002 u16 sldr_setup[IQS7222_MAX_SLDR][IQS7222_MAX_COLS_SLDR];
1003 u16 gpio_setup[ARRAY_SIZE(iqs7222_gpio_links)][IQS7222_MAX_COLS_GPIO];
1004 u16 sys_setup[IQS7222_MAX_COLS_SYS];
1007 static u16 *iqs7222_setup(struct iqs7222_private *iqs7222,
1008 enum iqs7222_reg_grp_id reg_grp, int row)
1011 case IQS7222_REG_GRP_CYCLE:
1012 return iqs7222->cycle_setup[row];
1014 case IQS7222_REG_GRP_GLBL:
1015 return iqs7222->glbl_setup;
1017 case IQS7222_REG_GRP_BTN:
1018 return iqs7222->btn_setup[row];
1020 case IQS7222_REG_GRP_CHAN:
1021 return iqs7222->chan_setup[row];
1023 case IQS7222_REG_GRP_FILT:
1024 return iqs7222->filt_setup;
1026 case IQS7222_REG_GRP_SLDR:
1027 return iqs7222->sldr_setup[row];
1029 case IQS7222_REG_GRP_GPIO:
1030 return iqs7222->gpio_setup[row];
1032 case IQS7222_REG_GRP_SYS:
1033 return iqs7222->sys_setup;
1040 static int iqs7222_irq_poll(struct iqs7222_private *iqs7222, u16 timeout_ms)
1042 ktime_t irq_timeout = ktime_add_ms(ktime_get(), timeout_ms);
1046 usleep_range(1000, 1100);
1048 ret = gpiod_get_value_cansleep(iqs7222->irq_gpio);
1053 } while (ktime_compare(ktime_get(), irq_timeout) < 0);
1058 static int iqs7222_hard_reset(struct iqs7222_private *iqs7222)
1060 struct i2c_client *client = iqs7222->client;
1063 if (!iqs7222->reset_gpio)
1066 gpiod_set_value_cansleep(iqs7222->reset_gpio, 1);
1067 usleep_range(1000, 1100);
1069 gpiod_set_value_cansleep(iqs7222->reset_gpio, 0);
1071 error = iqs7222_irq_poll(iqs7222, IQS7222_RESET_TIMEOUT_MS);
1073 dev_err(&client->dev, "Failed to reset device: %d\n", error);
1078 static int iqs7222_force_comms(struct iqs7222_private *iqs7222)
1080 u8 msg_buf[] = { 0xFF, };
1084 * The device cannot communicate until it asserts its interrupt (RDY)
1085 * pin. Attempts to do so while RDY is deasserted return an ACK; how-
1086 * ever all write data is ignored, and all read data returns 0xEE.
1088 * Unsolicited communication must be preceded by a special force com-
1089 * munication command, after which the device eventually asserts its
1090 * RDY pin and agrees to communicate.
1092 * Regardless of whether communication is forced or the result of an
1093 * interrupt, the device automatically deasserts its RDY pin once it
1094 * detects an I2C stop condition, or a timeout expires.
1096 ret = gpiod_get_value_cansleep(iqs7222->irq_gpio);
1102 ret = i2c_master_send(iqs7222->client, msg_buf, sizeof(msg_buf));
1103 if (ret < (int)sizeof(msg_buf)) {
1108 * The datasheet states that the host must wait to retry any
1109 * failed attempt to communicate over I2C.
1111 msleep(IQS7222_COMMS_RETRY_MS);
1115 return iqs7222_irq_poll(iqs7222, IQS7222_COMMS_TIMEOUT_MS);
1118 static int iqs7222_read_burst(struct iqs7222_private *iqs7222,
1119 u16 reg, void *val, u16 num_val)
1121 u8 reg_buf[sizeof(__be16)];
1123 struct i2c_client *client = iqs7222->client;
1124 struct i2c_msg msg[] = {
1126 .addr = client->addr,
1128 .len = reg > U8_MAX ? sizeof(reg) : sizeof(u8),
1132 .addr = client->addr,
1134 .len = num_val * sizeof(__le16),
1140 put_unaligned_be16(reg, reg_buf);
1145 * The following loop protects against an edge case in which the RDY
1146 * pin is automatically deasserted just as the read is initiated. In
1147 * that case, the read must be retried using forced communication.
1149 for (i = 0; i < IQS7222_NUM_RETRIES; i++) {
1150 ret = iqs7222_force_comms(iqs7222);
1154 ret = i2c_transfer(client->adapter, msg, ARRAY_SIZE(msg));
1155 if (ret < (int)ARRAY_SIZE(msg)) {
1159 msleep(IQS7222_COMMS_RETRY_MS);
1163 if (get_unaligned_le16(msg[1].buf) == IQS7222_COMMS_ERROR) {
1173 * The following delay ensures the device has deasserted the RDY pin
1174 * following the I2C stop condition.
1176 usleep_range(50, 100);
1179 dev_err(&client->dev,
1180 "Failed to read from address 0x%04X: %d\n", reg, ret);
1185 static int iqs7222_read_word(struct iqs7222_private *iqs7222, u16 reg, u16 *val)
1190 error = iqs7222_read_burst(iqs7222, reg, &val_buf, 1);
1194 *val = le16_to_cpu(val_buf);
1199 static int iqs7222_write_burst(struct iqs7222_private *iqs7222,
1200 u16 reg, const void *val, u16 num_val)
1202 int reg_len = reg > U8_MAX ? sizeof(reg) : sizeof(u8);
1203 int val_len = num_val * sizeof(__le16);
1204 int msg_len = reg_len + val_len;
1206 struct i2c_client *client = iqs7222->client;
1209 msg_buf = kzalloc(msg_len, GFP_KERNEL);
1214 put_unaligned_be16(reg, msg_buf);
1218 memcpy(msg_buf + reg_len, val, val_len);
1221 * The following loop protects against an edge case in which the RDY
1222 * pin is automatically asserted just before the force communication
1225 * In that case, the subsequent I2C stop condition tricks the device
1226 * into preemptively deasserting the RDY pin and the command must be
1229 for (i = 0; i < IQS7222_NUM_RETRIES; i++) {
1230 ret = iqs7222_force_comms(iqs7222);
1234 ret = i2c_master_send(client, msg_buf, msg_len);
1235 if (ret < msg_len) {
1239 msleep(IQS7222_COMMS_RETRY_MS);
1249 usleep_range(50, 100);
1252 dev_err(&client->dev,
1253 "Failed to write to address 0x%04X: %d\n", reg, ret);
1258 static int iqs7222_write_word(struct iqs7222_private *iqs7222, u16 reg, u16 val)
1260 __le16 val_buf = cpu_to_le16(val);
1262 return iqs7222_write_burst(iqs7222, reg, &val_buf, 1);
1265 static int iqs7222_ati_trigger(struct iqs7222_private *iqs7222)
1267 struct i2c_client *client = iqs7222->client;
1268 ktime_t ati_timeout;
1274 * The reserved fields of the system setup register may have changed
1275 * as a result of other registers having been written. As such, read
1276 * the register's latest value to avoid unexpected behavior when the
1277 * register is written in the loop that follows.
1279 error = iqs7222_read_word(iqs7222, IQS7222_SYS_SETUP, &sys_setup);
1283 sys_setup &= ~IQS7222_SYS_SETUP_INTF_MODE_MASK;
1284 sys_setup &= ~IQS7222_SYS_SETUP_PWR_MODE_MASK;
1286 for (i = 0; i < IQS7222_NUM_RETRIES; i++) {
1288 * Trigger ATI from streaming and normal-power modes so that
1289 * the RDY pin continues to be asserted during ATI.
1291 error = iqs7222_write_word(iqs7222, IQS7222_SYS_SETUP,
1293 IQS7222_SYS_SETUP_REDO_ATI);
1297 ati_timeout = ktime_add_ms(ktime_get(), IQS7222_ATI_TIMEOUT_MS);
1300 error = iqs7222_irq_poll(iqs7222,
1301 IQS7222_COMMS_TIMEOUT_MS);
1305 error = iqs7222_read_word(iqs7222, IQS7222_SYS_STATUS,
1310 if (sys_status & IQS7222_SYS_STATUS_RESET)
1313 if (sys_status & IQS7222_SYS_STATUS_ATI_ERROR)
1316 if (sys_status & IQS7222_SYS_STATUS_ATI_ACTIVE)
1320 * Use stream-in-touch mode if either slider reports
1321 * absolute position.
1323 sys_setup |= test_bit(EV_ABS, iqs7222->keypad->evbit)
1324 ? IQS7222_SYS_SETUP_INTF_MODE_TOUCH
1325 : IQS7222_SYS_SETUP_INTF_MODE_EVENT;
1326 sys_setup |= IQS7222_SYS_SETUP_PWR_MODE_AUTO;
1328 return iqs7222_write_word(iqs7222, IQS7222_SYS_SETUP,
1330 } while (ktime_compare(ktime_get(), ati_timeout) < 0);
1332 dev_err(&client->dev,
1333 "ATI attempt %d of %d failed with status 0x%02X, %s\n",
1334 i + 1, IQS7222_NUM_RETRIES, (u8)sys_status,
1335 i + 1 < IQS7222_NUM_RETRIES ? "retrying" : "stopping");
1341 static int iqs7222_dev_init(struct iqs7222_private *iqs7222, int dir)
1343 const struct iqs7222_dev_desc *dev_desc = iqs7222->dev_desc;
1344 int comms_offset = dev_desc->comms_offset;
1348 * Acknowledge reset before writing any registers in case the device
1349 * suffers a spurious reset during initialization. Because this step
1350 * may change the reserved fields of the second filter beta register,
1351 * its cache must be updated.
1353 * Writing the second filter beta register, in turn, may clobber the
1354 * system status register. As such, the filter beta register pair is
1355 * written first to protect against this hazard.
1358 u16 reg = dev_desc->reg_grps[IQS7222_REG_GRP_FILT].base + 1;
1361 error = iqs7222_write_word(iqs7222, IQS7222_SYS_SETUP,
1362 iqs7222->sys_setup[0] |
1363 IQS7222_SYS_SETUP_ACK_RESET);
1367 error = iqs7222_read_word(iqs7222, reg, &filt_setup);
1371 iqs7222->filt_setup[1] &= GENMASK(7, 0);
1372 iqs7222->filt_setup[1] |= (filt_setup & ~GENMASK(7, 0));
1376 * Take advantage of the stop-bit disable function, if available, to
1377 * save the trouble of having to reopen a communication window after
1378 * each burst read or write.
1383 error = iqs7222_read_word(iqs7222,
1384 IQS7222_SYS_SETUP + comms_offset,
1389 error = iqs7222_write_word(iqs7222,
1390 IQS7222_SYS_SETUP + comms_offset,
1391 comms_setup | IQS7222_COMMS_HOLD);
1396 for (i = 0; i < IQS7222_NUM_REG_GRPS; i++) {
1397 int num_row = dev_desc->reg_grps[i].num_row;
1398 int num_col = dev_desc->reg_grps[i].num_col;
1399 u16 reg = dev_desc->reg_grps[i].base;
1406 val = iqs7222_setup(iqs7222, i, 0);
1410 val_buf = kcalloc(num_col, sizeof(__le16), GFP_KERNEL);
1414 for (j = 0; j < num_row; j++) {
1417 error = iqs7222_read_burst(iqs7222, reg,
1419 for (k = 0; k < num_col; k++)
1420 val[k] = le16_to_cpu(val_buf[k]);
1424 for (k = 0; k < num_col; k++)
1425 val_buf[k] = cpu_to_le16(val[k]);
1426 error = iqs7222_write_burst(iqs7222, reg,
1437 reg += IQS7222_REG_OFFSET;
1438 val += iqs7222_max_cols[i];
1450 error = iqs7222_read_word(iqs7222,
1451 IQS7222_SYS_SETUP + comms_offset,
1456 error = iqs7222_write_word(iqs7222,
1457 IQS7222_SYS_SETUP + comms_offset,
1458 comms_setup & ~IQS7222_COMMS_HOLD);
1466 return iqs7222_ati_trigger(iqs7222);
1469 static int iqs7222_dev_info(struct iqs7222_private *iqs7222)
1471 struct i2c_client *client = iqs7222->client;
1472 bool prod_num_valid = false;
1476 error = iqs7222_read_burst(iqs7222, IQS7222_PROD_NUM, dev_id,
1477 ARRAY_SIZE(dev_id));
1481 for (i = 0; i < ARRAY_SIZE(iqs7222_devs); i++) {
1482 if (le16_to_cpu(dev_id[0]) != iqs7222_devs[i].prod_num)
1485 prod_num_valid = true;
1487 if (le16_to_cpu(dev_id[1]) < iqs7222_devs[i].fw_major)
1490 if (le16_to_cpu(dev_id[2]) < iqs7222_devs[i].fw_minor)
1493 iqs7222->dev_desc = &iqs7222_devs[i];
1498 dev_err(&client->dev, "Unsupported firmware revision: %u.%u\n",
1499 le16_to_cpu(dev_id[1]), le16_to_cpu(dev_id[2]));
1501 dev_err(&client->dev, "Unrecognized product number: %u\n",
1502 le16_to_cpu(dev_id[0]));
1507 static int iqs7222_gpio_select(struct iqs7222_private *iqs7222,
1508 struct fwnode_handle *child_node,
1509 int child_enable, u16 child_link)
1511 const struct iqs7222_dev_desc *dev_desc = iqs7222->dev_desc;
1512 struct i2c_client *client = iqs7222->client;
1513 int num_gpio = dev_desc->reg_grps[IQS7222_REG_GRP_GPIO].num_row;
1514 int error, count, i;
1515 unsigned int gpio_sel[ARRAY_SIZE(iqs7222_gpio_links)];
1520 if (!fwnode_property_present(child_node, "azoteq,gpio-select"))
1523 count = fwnode_property_count_u32(child_node, "azoteq,gpio-select");
1524 if (count > num_gpio) {
1525 dev_err(&client->dev, "Invalid number of %s GPIOs\n",
1526 fwnode_get_name(child_node));
1528 } else if (count < 0) {
1529 dev_err(&client->dev, "Failed to count %s GPIOs: %d\n",
1530 fwnode_get_name(child_node), count);
1534 error = fwnode_property_read_u32_array(child_node,
1535 "azoteq,gpio-select",
1538 dev_err(&client->dev, "Failed to read %s GPIOs: %d\n",
1539 fwnode_get_name(child_node), error);
1543 for (i = 0; i < count; i++) {
1546 if (gpio_sel[i] >= num_gpio) {
1547 dev_err(&client->dev, "Invalid %s GPIO: %u\n",
1548 fwnode_get_name(child_node), gpio_sel[i]);
1552 gpio_setup = iqs7222->gpio_setup[gpio_sel[i]];
1554 if (gpio_setup[2] && child_link != gpio_setup[2]) {
1555 dev_err(&client->dev,
1556 "Conflicting GPIO %u event types\n",
1561 gpio_setup[0] |= IQS7222_GPIO_SETUP_0_GPIO_EN;
1562 gpio_setup[1] |= child_enable;
1563 gpio_setup[2] = child_link;
1569 static int iqs7222_parse_props(struct iqs7222_private *iqs7222,
1570 struct fwnode_handle *reg_grp_node,
1572 enum iqs7222_reg_grp_id reg_grp,
1573 enum iqs7222_reg_key_id reg_key)
1575 u16 *setup = iqs7222_setup(iqs7222, reg_grp, reg_grp_index);
1576 struct i2c_client *client = iqs7222->client;
1582 for (i = 0; i < ARRAY_SIZE(iqs7222_props); i++) {
1583 const char *name = iqs7222_props[i].name;
1584 int reg_offset = iqs7222_props[i].reg_offset;
1585 int reg_shift = iqs7222_props[i].reg_shift;
1586 int reg_width = iqs7222_props[i].reg_width;
1587 int val_pitch = iqs7222_props[i].val_pitch ? : 1;
1588 int val_min = iqs7222_props[i].val_min;
1589 int val_max = iqs7222_props[i].val_max;
1590 bool invert = iqs7222_props[i].invert;
1591 const char *label = iqs7222_props[i].label ? : name;
1595 if (iqs7222_props[i].reg_grp != reg_grp ||
1596 iqs7222_props[i].reg_key != reg_key)
1600 * Boolean register fields are one bit wide; they are forcibly
1601 * reset to provide a means to undo changes by a bootloader if
1604 * Scalar fields, on the other hand, are left untouched unless
1605 * their corresponding properties are present.
1607 if (reg_width == 1) {
1609 setup[reg_offset] |= BIT(reg_shift);
1611 setup[reg_offset] &= ~BIT(reg_shift);
1614 if (!fwnode_property_present(reg_grp_node, name))
1617 if (reg_width == 1) {
1619 setup[reg_offset] &= ~BIT(reg_shift);
1621 setup[reg_offset] |= BIT(reg_shift);
1626 error = fwnode_property_read_u32(reg_grp_node, name, &val);
1628 dev_err(&client->dev, "Failed to read %s %s: %d\n",
1629 fwnode_get_name(reg_grp_node), label, error);
1634 val_max = GENMASK(reg_width - 1, 0) * val_pitch;
1636 if (val < val_min || val > val_max) {
1637 dev_err(&client->dev, "Invalid %s %s: %u\n",
1638 fwnode_get_name(reg_grp_node), label, val);
1642 setup[reg_offset] &= ~GENMASK(reg_shift + reg_width - 1,
1644 setup[reg_offset] |= (val / val_pitch << reg_shift);
1650 static int iqs7222_parse_event(struct iqs7222_private *iqs7222,
1651 struct fwnode_handle *event_node,
1653 enum iqs7222_reg_grp_id reg_grp,
1654 enum iqs7222_reg_key_id reg_key,
1655 u16 event_enable, u16 event_link,
1656 unsigned int *event_type,
1657 unsigned int *event_code)
1659 struct i2c_client *client = iqs7222->client;
1662 error = iqs7222_parse_props(iqs7222, event_node, reg_grp_index,
1667 error = iqs7222_gpio_select(iqs7222, event_node, event_enable,
1672 error = fwnode_property_read_u32(event_node, "linux,code", event_code);
1673 if (error == -EINVAL) {
1676 dev_err(&client->dev, "Failed to read %s code: %d\n",
1677 fwnode_get_name(event_node), error);
1682 input_set_capability(iqs7222->keypad, EV_KEY, *event_code);
1686 error = fwnode_property_read_u32(event_node, "linux,input-type",
1688 if (error == -EINVAL) {
1689 *event_type = EV_KEY;
1691 dev_err(&client->dev, "Failed to read %s input type: %d\n",
1692 fwnode_get_name(event_node), error);
1694 } else if (*event_type != EV_KEY && *event_type != EV_SW) {
1695 dev_err(&client->dev, "Invalid %s input type: %d\n",
1696 fwnode_get_name(event_node), *event_type);
1700 input_set_capability(iqs7222->keypad, *event_type, *event_code);
1705 static int iqs7222_parse_cycle(struct iqs7222_private *iqs7222,
1706 struct fwnode_handle *cycle_node, int cycle_index)
1708 u16 *cycle_setup = iqs7222->cycle_setup[cycle_index];
1709 struct i2c_client *client = iqs7222->client;
1710 unsigned int pins[9];
1711 int error, count, i;
1714 * Each channel shares a cycle with one other channel; the mapping of
1715 * channels to cycles is fixed. Properties defined for a cycle impact
1716 * both channels tied to the cycle.
1718 * Unlike channels which are restricted to a select range of CRx pins
1719 * based on channel number, any cycle can claim any of the device's 9
1720 * CTx pins (CTx0-8).
1722 if (!fwnode_property_present(cycle_node, "azoteq,tx-enable"))
1725 count = fwnode_property_count_u32(cycle_node, "azoteq,tx-enable");
1727 dev_err(&client->dev, "Failed to count %s CTx pins: %d\n",
1728 fwnode_get_name(cycle_node), count);
1730 } else if (count > ARRAY_SIZE(pins)) {
1731 dev_err(&client->dev, "Invalid number of %s CTx pins\n",
1732 fwnode_get_name(cycle_node));
1736 error = fwnode_property_read_u32_array(cycle_node, "azoteq,tx-enable",
1739 dev_err(&client->dev, "Failed to read %s CTx pins: %d\n",
1740 fwnode_get_name(cycle_node), error);
1744 cycle_setup[1] &= ~GENMASK(7 + ARRAY_SIZE(pins) - 1, 7);
1746 for (i = 0; i < count; i++) {
1748 dev_err(&client->dev, "Invalid %s CTx pin: %u\n",
1749 fwnode_get_name(cycle_node), pins[i]);
1753 cycle_setup[1] |= BIT(pins[i] + 7);
1759 static int iqs7222_parse_chan(struct iqs7222_private *iqs7222,
1760 struct fwnode_handle *chan_node, int chan_index)
1762 const struct iqs7222_dev_desc *dev_desc = iqs7222->dev_desc;
1763 struct i2c_client *client = iqs7222->client;
1764 int num_chan = dev_desc->reg_grps[IQS7222_REG_GRP_CHAN].num_row;
1765 int ext_chan = rounddown(num_chan, 10);
1767 u16 *chan_setup = iqs7222->chan_setup[chan_index];
1768 u16 *sys_setup = iqs7222->sys_setup;
1771 if (dev_desc->allow_offset &&
1772 fwnode_property_present(chan_node, "azoteq,ulp-allow"))
1773 sys_setup[dev_desc->allow_offset] &= ~BIT(chan_index);
1775 chan_setup[0] |= IQS7222_CHAN_SETUP_0_CHAN_EN;
1778 * The reference channel function allows for differential measurements
1779 * and is only available in the case of IQS7222A or IQS7222C.
1781 if (dev_desc->reg_grps[IQS7222_REG_GRP_CHAN].num_col > 4 &&
1782 fwnode_property_present(chan_node, "azoteq,ref-select")) {
1785 error = fwnode_property_read_u32(chan_node, "azoteq,ref-select",
1788 dev_err(&client->dev,
1789 "Failed to read %s reference channel: %d\n",
1790 fwnode_get_name(chan_node), error);
1794 if (val >= ext_chan) {
1795 dev_err(&client->dev,
1796 "Invalid %s reference channel: %u\n",
1797 fwnode_get_name(chan_node), val);
1801 ref_setup = iqs7222->chan_setup[val];
1804 * Configure the current channel as a follower of the selected
1805 * reference channel.
1807 chan_setup[0] |= IQS7222_CHAN_SETUP_0_REF_MODE_FOLLOW;
1808 chan_setup[4] = val * 42 + 1048;
1810 error = fwnode_property_read_u32(chan_node, "azoteq,ref-weight",
1813 if (val > U16_MAX) {
1814 dev_err(&client->dev,
1815 "Invalid %s reference weight: %u\n",
1816 fwnode_get_name(chan_node), val);
1820 chan_setup[5] = val;
1821 } else if (error != -EINVAL) {
1822 dev_err(&client->dev,
1823 "Failed to read %s reference weight: %d\n",
1824 fwnode_get_name(chan_node), error);
1829 * Configure the selected channel as a reference channel which
1830 * serves the current channel.
1832 ref_setup[0] |= IQS7222_CHAN_SETUP_0_REF_MODE_REF;
1833 ref_setup[5] |= BIT(chan_index);
1835 ref_setup[4] = dev_desc->touch_link;
1836 if (fwnode_property_present(chan_node, "azoteq,use-prox"))
1840 if (fwnode_property_present(chan_node, "azoteq,rx-enable")) {
1842 * Each channel can claim up to 4 CRx pins. The first half of
1843 * the channels can use CRx0-3, while the second half can use
1846 unsigned int pins[4];
1849 count = fwnode_property_count_u32(chan_node,
1850 "azoteq,rx-enable");
1852 dev_err(&client->dev,
1853 "Failed to count %s CRx pins: %d\n",
1854 fwnode_get_name(chan_node), count);
1856 } else if (count > ARRAY_SIZE(pins)) {
1857 dev_err(&client->dev,
1858 "Invalid number of %s CRx pins\n",
1859 fwnode_get_name(chan_node));
1863 error = fwnode_property_read_u32_array(chan_node,
1867 dev_err(&client->dev,
1868 "Failed to read %s CRx pins: %d\n",
1869 fwnode_get_name(chan_node), error);
1873 chan_setup[0] &= ~GENMASK(4 + ARRAY_SIZE(pins) - 1, 4);
1875 for (i = 0; i < count; i++) {
1876 int min_crx = chan_index < ext_chan / 2 ? 0 : 4;
1878 if (pins[i] < min_crx || pins[i] > min_crx + 3) {
1879 dev_err(&client->dev,
1880 "Invalid %s CRx pin: %u\n",
1881 fwnode_get_name(chan_node), pins[i]);
1885 chan_setup[0] |= BIT(pins[i] + 4 - min_crx);
1889 for (i = 0; i < ARRAY_SIZE(iqs7222_kp_events); i++) {
1890 const char *event_name = iqs7222_kp_events[i].name;
1891 u16 event_enable = iqs7222_kp_events[i].enable;
1892 struct fwnode_handle *event_node;
1894 event_node = fwnode_get_named_child_node(chan_node, event_name);
1898 error = fwnode_property_read_u32(event_node,
1899 "azoteq,timeout-press-ms",
1903 * The IQS7222B employs a global pair of press timeout
1904 * registers as opposed to channel-specific registers.
1906 u16 *setup = dev_desc->reg_grps
1907 [IQS7222_REG_GRP_BTN].num_col > 2 ?
1908 &iqs7222->btn_setup[chan_index][2] :
1911 if (val > U8_MAX * 500) {
1912 dev_err(&client->dev,
1913 "Invalid %s press timeout: %u\n",
1914 fwnode_get_name(event_node), val);
1915 fwnode_handle_put(event_node);
1919 *setup &= ~(U8_MAX << i * 8);
1920 *setup |= (val / 500 << i * 8);
1921 } else if (error != -EINVAL) {
1922 dev_err(&client->dev,
1923 "Failed to read %s press timeout: %d\n",
1924 fwnode_get_name(event_node), error);
1925 fwnode_handle_put(event_node);
1929 error = iqs7222_parse_event(iqs7222, event_node, chan_index,
1930 IQS7222_REG_GRP_BTN,
1931 iqs7222_kp_events[i].reg_key,
1933 dev_desc->touch_link - (i ? 0 : 2),
1934 &iqs7222->kp_type[chan_index][i],
1935 &iqs7222->kp_code[chan_index][i]);
1936 fwnode_handle_put(event_node);
1940 if (!dev_desc->event_offset)
1943 sys_setup[dev_desc->event_offset] |= event_enable;
1947 * The following call handles a special pair of properties that apply
1948 * to a channel node, but reside within the button (event) group.
1950 return iqs7222_parse_props(iqs7222, chan_node, chan_index,
1951 IQS7222_REG_GRP_BTN,
1952 IQS7222_REG_KEY_DEBOUNCE);
1955 static int iqs7222_parse_sldr(struct iqs7222_private *iqs7222,
1956 struct fwnode_handle *sldr_node, int sldr_index)
1958 const struct iqs7222_dev_desc *dev_desc = iqs7222->dev_desc;
1959 struct i2c_client *client = iqs7222->client;
1960 int num_chan = dev_desc->reg_grps[IQS7222_REG_GRP_CHAN].num_row;
1961 int ext_chan = rounddown(num_chan, 10);
1962 int count, error, reg_offset, i;
1963 u16 *event_mask = &iqs7222->sys_setup[dev_desc->event_offset];
1964 u16 *sldr_setup = iqs7222->sldr_setup[sldr_index];
1965 unsigned int chan_sel[4], val;
1968 * Each slider can be spread across 3 to 4 channels. It is possible to
1969 * select only 2 channels, but doing so prevents the slider from using
1970 * the specified resolution.
1972 count = fwnode_property_count_u32(sldr_node, "azoteq,channel-select");
1974 dev_err(&client->dev, "Failed to count %s channels: %d\n",
1975 fwnode_get_name(sldr_node), count);
1977 } else if (count < 3 || count > ARRAY_SIZE(chan_sel)) {
1978 dev_err(&client->dev, "Invalid number of %s channels\n",
1979 fwnode_get_name(sldr_node));
1983 error = fwnode_property_read_u32_array(sldr_node,
1984 "azoteq,channel-select",
1987 dev_err(&client->dev, "Failed to read %s channels: %d\n",
1988 fwnode_get_name(sldr_node), error);
1993 * Resolution and top speed, if small enough, are packed into a single
1994 * register. Otherwise, each occupies its own register and the rest of
1995 * the slider-related register addresses are offset by one.
1997 reg_offset = dev_desc->sldr_res < U16_MAX ? 0 : 1;
1999 sldr_setup[0] |= count;
2000 sldr_setup[3 + reg_offset] &= ~GENMASK(ext_chan - 1, 0);
2002 for (i = 0; i < ARRAY_SIZE(chan_sel); i++) {
2003 sldr_setup[5 + reg_offset + i] = 0;
2007 if (chan_sel[i] >= ext_chan) {
2008 dev_err(&client->dev, "Invalid %s channel: %u\n",
2009 fwnode_get_name(sldr_node), chan_sel[i]);
2014 * The following fields indicate which channels participate in
2015 * the slider, as well as each channel's relative placement.
2017 sldr_setup[3 + reg_offset] |= BIT(chan_sel[i]);
2018 sldr_setup[5 + reg_offset + i] = chan_sel[i] * 42 + 1080;
2021 sldr_setup[4 + reg_offset] = dev_desc->touch_link;
2022 if (fwnode_property_present(sldr_node, "azoteq,use-prox"))
2023 sldr_setup[4 + reg_offset] -= 2;
2025 error = fwnode_property_read_u32(sldr_node, "azoteq,slider-size", &val);
2027 if (val > dev_desc->sldr_res) {
2028 dev_err(&client->dev, "Invalid %s size: %u\n",
2029 fwnode_get_name(sldr_node), val);
2034 sldr_setup[3] = val;
2036 sldr_setup[2] &= ~IQS7222_SLDR_SETUP_2_RES_MASK;
2037 sldr_setup[2] |= (val / 16 <<
2038 IQS7222_SLDR_SETUP_2_RES_SHIFT);
2040 } else if (error != -EINVAL) {
2041 dev_err(&client->dev, "Failed to read %s size: %d\n",
2042 fwnode_get_name(sldr_node), error);
2046 if (!(reg_offset ? sldr_setup[3]
2047 : sldr_setup[2] & IQS7222_SLDR_SETUP_2_RES_MASK)) {
2048 dev_err(&client->dev, "Undefined %s size\n",
2049 fwnode_get_name(sldr_node));
2053 error = fwnode_property_read_u32(sldr_node, "azoteq,top-speed", &val);
2055 if (val > (reg_offset ? U16_MAX : U8_MAX * 4)) {
2056 dev_err(&client->dev, "Invalid %s top speed: %u\n",
2057 fwnode_get_name(sldr_node), val);
2062 sldr_setup[2] = val;
2064 sldr_setup[2] &= ~IQS7222_SLDR_SETUP_2_TOP_SPEED_MASK;
2065 sldr_setup[2] |= (val / 4);
2067 } else if (error != -EINVAL) {
2068 dev_err(&client->dev, "Failed to read %s top speed: %d\n",
2069 fwnode_get_name(sldr_node), error);
2073 error = fwnode_property_read_u32(sldr_node, "linux,axis", &val);
2075 u16 sldr_max = sldr_setup[3] - 1;
2078 sldr_max = sldr_setup[2];
2080 sldr_max &= IQS7222_SLDR_SETUP_2_RES_MASK;
2081 sldr_max >>= IQS7222_SLDR_SETUP_2_RES_SHIFT;
2083 sldr_max = sldr_max * 16 - 1;
2086 input_set_abs_params(iqs7222->keypad, val, 0, sldr_max, 0, 0);
2087 iqs7222->sl_axis[sldr_index] = val;
2088 } else if (error != -EINVAL) {
2089 dev_err(&client->dev, "Failed to read %s axis: %d\n",
2090 fwnode_get_name(sldr_node), error);
2094 if (dev_desc->wheel_enable) {
2095 sldr_setup[0] &= ~dev_desc->wheel_enable;
2096 if (iqs7222->sl_axis[sldr_index] == ABS_WHEEL)
2097 sldr_setup[0] |= dev_desc->wheel_enable;
2101 * The absence of a register offset makes it safe to assume the device
2102 * supports gestures, each of which is first disabled until explicitly
2106 for (i = 0; i < ARRAY_SIZE(iqs7222_sl_events); i++)
2107 sldr_setup[9] &= ~iqs7222_sl_events[i].enable;
2109 for (i = 0; i < ARRAY_SIZE(iqs7222_sl_events); i++) {
2110 const char *event_name = iqs7222_sl_events[i].name;
2111 struct fwnode_handle *event_node;
2112 enum iqs7222_reg_key_id reg_key;
2114 event_node = fwnode_get_named_child_node(sldr_node, event_name);
2119 reg_key = IQS7222_REG_KEY_RESERVED;
2121 reg_key = iqs7222_sl_events[i].reg_key;
2124 * The press/release event does not expose a direct GPIO link,
2125 * but one can be emulated by tying each of the participating
2126 * channels to the same GPIO.
2128 error = iqs7222_parse_event(iqs7222, event_node, sldr_index,
2129 IQS7222_REG_GRP_SLDR, reg_key,
2130 i ? iqs7222_sl_events[i].enable
2131 : sldr_setup[3 + reg_offset],
2132 i ? 1568 + sldr_index * 30
2133 : sldr_setup[4 + reg_offset],
2135 &iqs7222->sl_code[sldr_index][i]);
2136 fwnode_handle_put(event_node);
2141 sldr_setup[9] |= iqs7222_sl_events[i].enable;
2143 if (!dev_desc->event_offset)
2147 * The press/release event is determined based on whether the
2148 * coordinate field reports 0xFFFF and solely relies on touch
2149 * or proximity interrupts to be unmasked.
2151 if (i && !reg_offset)
2152 *event_mask |= (IQS7222_EVENT_MASK_SLDR << sldr_index);
2153 else if (sldr_setup[4 + reg_offset] == dev_desc->touch_link)
2154 *event_mask |= IQS7222_EVENT_MASK_TOUCH;
2156 *event_mask |= IQS7222_EVENT_MASK_PROX;
2160 * The following call handles a special pair of properties that shift
2161 * to make room for a wheel enable control in the case of IQS7222C.
2163 return iqs7222_parse_props(iqs7222, sldr_node, sldr_index,
2164 IQS7222_REG_GRP_SLDR,
2165 dev_desc->wheel_enable ?
2166 IQS7222_REG_KEY_WHEEL :
2167 IQS7222_REG_KEY_NO_WHEEL);
2170 static int (*iqs7222_parse_extra[IQS7222_NUM_REG_GRPS])
2171 (struct iqs7222_private *iqs7222,
2172 struct fwnode_handle *reg_grp_node,
2173 int reg_grp_index) = {
2174 [IQS7222_REG_GRP_CYCLE] = iqs7222_parse_cycle,
2175 [IQS7222_REG_GRP_CHAN] = iqs7222_parse_chan,
2176 [IQS7222_REG_GRP_SLDR] = iqs7222_parse_sldr,
2179 static int iqs7222_parse_reg_grp(struct iqs7222_private *iqs7222,
2180 enum iqs7222_reg_grp_id reg_grp,
2183 struct i2c_client *client = iqs7222->client;
2184 struct fwnode_handle *reg_grp_node;
2187 if (iqs7222_reg_grp_names[reg_grp]) {
2188 char reg_grp_name[16];
2190 snprintf(reg_grp_name, sizeof(reg_grp_name), "%s-%d",
2191 iqs7222_reg_grp_names[reg_grp], reg_grp_index);
2193 reg_grp_node = device_get_named_child_node(&client->dev,
2196 reg_grp_node = fwnode_handle_get(dev_fwnode(&client->dev));
2202 error = iqs7222_parse_props(iqs7222, reg_grp_node, reg_grp_index,
2203 reg_grp, IQS7222_REG_KEY_NONE);
2205 if (!error && iqs7222_parse_extra[reg_grp])
2206 error = iqs7222_parse_extra[reg_grp](iqs7222, reg_grp_node,
2209 fwnode_handle_put(reg_grp_node);
2214 static int iqs7222_parse_all(struct iqs7222_private *iqs7222)
2216 const struct iqs7222_dev_desc *dev_desc = iqs7222->dev_desc;
2217 const struct iqs7222_reg_grp_desc *reg_grps = dev_desc->reg_grps;
2218 u16 *sys_setup = iqs7222->sys_setup;
2221 if (dev_desc->allow_offset)
2222 sys_setup[dev_desc->allow_offset] = U16_MAX;
2224 if (dev_desc->event_offset)
2225 sys_setup[dev_desc->event_offset] = IQS7222_EVENT_MASK_ATI;
2227 for (i = 0; i < reg_grps[IQS7222_REG_GRP_GPIO].num_row; i++) {
2228 u16 *gpio_setup = iqs7222->gpio_setup[i];
2230 gpio_setup[0] &= ~IQS7222_GPIO_SETUP_0_GPIO_EN;
2234 if (reg_grps[IQS7222_REG_GRP_GPIO].num_row == 1)
2238 * The IQS7222C exposes multiple GPIO and must be informed
2239 * as to which GPIO this group represents.
2241 for (j = 0; j < ARRAY_SIZE(iqs7222_gpio_links); j++)
2242 gpio_setup[0] &= ~BIT(iqs7222_gpio_links[j]);
2244 gpio_setup[0] |= BIT(iqs7222_gpio_links[i]);
2247 for (i = 0; i < reg_grps[IQS7222_REG_GRP_CHAN].num_row; i++) {
2248 u16 *chan_setup = iqs7222->chan_setup[i];
2250 chan_setup[0] &= ~IQS7222_CHAN_SETUP_0_REF_MODE_MASK;
2251 chan_setup[0] &= ~IQS7222_CHAN_SETUP_0_CHAN_EN;
2256 for (i = 0; i < reg_grps[IQS7222_REG_GRP_SLDR].num_row; i++) {
2257 u16 *sldr_setup = iqs7222->sldr_setup[i];
2259 sldr_setup[0] &= ~IQS7222_SLDR_SETUP_0_CHAN_CNT_MASK;
2262 for (i = 0; i < IQS7222_NUM_REG_GRPS; i++) {
2263 for (j = 0; j < reg_grps[i].num_row; j++) {
2264 error = iqs7222_parse_reg_grp(iqs7222, i, j);
2273 static int iqs7222_report(struct iqs7222_private *iqs7222)
2275 const struct iqs7222_dev_desc *dev_desc = iqs7222->dev_desc;
2276 struct i2c_client *client = iqs7222->client;
2277 int num_chan = dev_desc->reg_grps[IQS7222_REG_GRP_CHAN].num_row;
2278 int num_stat = dev_desc->reg_grps[IQS7222_REG_GRP_STAT].num_col;
2280 __le16 status[IQS7222_MAX_COLS_STAT];
2282 error = iqs7222_read_burst(iqs7222, IQS7222_SYS_STATUS, status,
2287 if (le16_to_cpu(status[0]) & IQS7222_SYS_STATUS_RESET) {
2288 dev_err(&client->dev, "Unexpected device reset\n");
2289 return iqs7222_dev_init(iqs7222, WRITE);
2292 if (le16_to_cpu(status[0]) & IQS7222_SYS_STATUS_ATI_ERROR) {
2293 dev_err(&client->dev, "Unexpected ATI error\n");
2294 return iqs7222_ati_trigger(iqs7222);
2297 if (le16_to_cpu(status[0]) & IQS7222_SYS_STATUS_ATI_ACTIVE)
2300 for (i = 0; i < num_chan; i++) {
2301 u16 *chan_setup = iqs7222->chan_setup[i];
2303 if (!(chan_setup[0] & IQS7222_CHAN_SETUP_0_CHAN_EN))
2306 for (j = 0; j < ARRAY_SIZE(iqs7222_kp_events); j++) {
2308 * Proximity state begins at offset 2 and spills into
2309 * offset 3 for devices with more than 16 channels.
2311 * Touch state begins at the first offset immediately
2312 * following proximity state.
2314 int k = 2 + j * (num_chan > 16 ? 2 : 1);
2315 u16 state = le16_to_cpu(status[k + i / 16]);
2317 if (!iqs7222->kp_type[i][j])
2320 input_event(iqs7222->keypad,
2321 iqs7222->kp_type[i][j],
2322 iqs7222->kp_code[i][j],
2323 !!(state & BIT(i % 16)));
2327 for (i = 0; i < dev_desc->reg_grps[IQS7222_REG_GRP_SLDR].num_row; i++) {
2328 u16 *sldr_setup = iqs7222->sldr_setup[i];
2329 u16 sldr_pos = le16_to_cpu(status[4 + i]);
2330 u16 state = le16_to_cpu(status[6 + i]);
2332 if (!(sldr_setup[0] & IQS7222_SLDR_SETUP_0_CHAN_CNT_MASK))
2335 if (sldr_pos < dev_desc->sldr_res)
2336 input_report_abs(iqs7222->keypad, iqs7222->sl_axis[i],
2339 input_report_key(iqs7222->keypad, iqs7222->sl_code[i][0],
2340 sldr_pos < dev_desc->sldr_res);
2343 * A maximum resolution indicates the device does not support
2344 * gestures, in which case the remaining fields are ignored.
2346 if (dev_desc->sldr_res == U16_MAX)
2349 if (!(le16_to_cpu(status[1]) & IQS7222_EVENT_MASK_SLDR << i))
2353 * Skip the press/release event, as it does not have separate
2354 * status fields and is handled separately.
2356 for (j = 1; j < ARRAY_SIZE(iqs7222_sl_events); j++) {
2357 u16 mask = iqs7222_sl_events[j].mask;
2358 u16 val = iqs7222_sl_events[j].val;
2360 input_report_key(iqs7222->keypad,
2361 iqs7222->sl_code[i][j],
2362 (state & mask) == val);
2365 input_sync(iqs7222->keypad);
2367 for (j = 1; j < ARRAY_SIZE(iqs7222_sl_events); j++)
2368 input_report_key(iqs7222->keypad,
2369 iqs7222->sl_code[i][j], 0);
2372 input_sync(iqs7222->keypad);
2377 static irqreturn_t iqs7222_irq(int irq, void *context)
2379 struct iqs7222_private *iqs7222 = context;
2381 return iqs7222_report(iqs7222) ? IRQ_NONE : IRQ_HANDLED;
2384 static int iqs7222_probe(struct i2c_client *client)
2386 struct iqs7222_private *iqs7222;
2387 unsigned long irq_flags;
2390 iqs7222 = devm_kzalloc(&client->dev, sizeof(*iqs7222), GFP_KERNEL);
2394 i2c_set_clientdata(client, iqs7222);
2395 iqs7222->client = client;
2397 iqs7222->keypad = devm_input_allocate_device(&client->dev);
2398 if (!iqs7222->keypad)
2401 iqs7222->keypad->name = client->name;
2402 iqs7222->keypad->id.bustype = BUS_I2C;
2405 * The RDY pin behaves as an interrupt, but must also be polled ahead
2406 * of unsolicited I2C communication. As such, it is first opened as a
2407 * GPIO and then passed to gpiod_to_irq() to register the interrupt.
2409 iqs7222->irq_gpio = devm_gpiod_get(&client->dev, "irq", GPIOD_IN);
2410 if (IS_ERR(iqs7222->irq_gpio)) {
2411 error = PTR_ERR(iqs7222->irq_gpio);
2412 dev_err(&client->dev, "Failed to request IRQ GPIO: %d\n",
2417 iqs7222->reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
2419 if (IS_ERR(iqs7222->reset_gpio)) {
2420 error = PTR_ERR(iqs7222->reset_gpio);
2421 dev_err(&client->dev, "Failed to request reset GPIO: %d\n",
2426 error = iqs7222_hard_reset(iqs7222);
2430 error = iqs7222_dev_info(iqs7222);
2434 error = iqs7222_dev_init(iqs7222, READ);
2438 error = iqs7222_parse_all(iqs7222);
2442 error = iqs7222_dev_init(iqs7222, WRITE);
2446 error = iqs7222_report(iqs7222);
2450 error = input_register_device(iqs7222->keypad);
2452 dev_err(&client->dev, "Failed to register device: %d\n", error);
2456 irq = gpiod_to_irq(iqs7222->irq_gpio);
2460 irq_flags = gpiod_is_active_low(iqs7222->irq_gpio) ? IRQF_TRIGGER_LOW
2461 : IRQF_TRIGGER_HIGH;
2462 irq_flags |= IRQF_ONESHOT;
2464 error = devm_request_threaded_irq(&client->dev, irq, NULL, iqs7222_irq,
2465 irq_flags, client->name, iqs7222);
2467 dev_err(&client->dev, "Failed to request IRQ: %d\n", error);
2472 static const struct of_device_id iqs7222_of_match[] = {
2473 { .compatible = "azoteq,iqs7222a" },
2474 { .compatible = "azoteq,iqs7222b" },
2475 { .compatible = "azoteq,iqs7222c" },
2478 MODULE_DEVICE_TABLE(of, iqs7222_of_match);
2480 static struct i2c_driver iqs7222_i2c_driver = {
2483 .of_match_table = iqs7222_of_match,
2485 .probe_new = iqs7222_probe,
2487 module_i2c_driver(iqs7222_i2c_driver);
2489 MODULE_AUTHOR("Jeff LaBundy <jeff@labundy.com>");
2490 MODULE_DESCRIPTION("Azoteq IQS7222A/B/C Capacitive Touch Controller");
2491 MODULE_LICENSE("GPL");