bindings/input/iqs269a.yaml

1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
10   - Jeff LaBundy <jeff@labundy.com>
13   The Azoteq IQS269A is an 8-channel capacitive touch controller that features
14   additional Hall-effect and inductive sensing capabilities.
28   "#address-cells":
31   "#size-cells":
34   azoteq,hall-enable:
37       Enables Hall-effect sensing on channels 6 and 7. In this case, keycodes
38       assigned to channel 6 are ignored and keycodes assigned to channel 7 are
39       interpreted as switch codes. Refer to the datasheet for requirements im-
40       posed on channels 6 and 7 by Hall-effect sensing.
42   azoteq,suspend-mode:
50       2: Ultra-low power (channel 0 proximity sensing)
53   azoteq,clk-div:
57   azoteq,ulp-update:
60     maximum: 7
62     description: Specifies the ultra-low-power mode update rate.
64   azoteq,reseed-offset:
67       Applies an 8-count offset to all long-term averages upon either ATI or
70   azoteq,filt-str-lp-lta:
75       Specifies the long-term average filter strength during low-power mode.
77   azoteq,filt-str-lp-cnt:
82       Specifies the raw count filter strength during low-power mode.
84   azoteq,filt-str-np-lta:
89       Specifies the long-term average filter strength during normal-power mode.
91   azoteq,filt-str-np-cnt:
96       Specifies the raw count filter strength during normal-power mode.
98   azoteq,rate-np-ms:
102     description: Specifies the report rate (in ms) during normal-power mode.
104   azoteq,rate-lp-ms:
108     description: Specifies the report rate (in ms) during low-power mode.
110   azoteq,rate-ulp-ms:
115     description: Specifies the report rate (in ms) during ultra-low-power mode.
117   azoteq,timeout-pwr-ms:
123       Specifies the length of time (in ms) to wait for an event during normal-
124       power mode before transitioning to low-power mode.
126   azoteq,timeout-lta-ms:
132       Specifies the length of time (in ms) to wait before resetting the long-
136   azoteq,ati-band-disable:
140   azoteq,ati-lp-only:
142     description: Limits automatic ATI to low-power mode.
144   azoteq,ati-band-tighten:
148   azoteq,filt-disable:
152   azoteq,gpio3-select:
155     maximum: 7
158       Selects the channel for which the GPIO3 pin represents touch state.
160   azoteq,dual-direction:
163       Specifies that long-term averages are to freeze in the presence of either
167   azoteq,tx-freq:
172       Specifies the inductive sensing excitation frequency as follows (paren-
173       thesized numbers represent the frequency if 'azoteq,clk-div' is present):
179   azoteq,global-cap-increase:
183   azoteq,reseed-select:
189       long-term average) of an associated channel as follows:
195   azoteq,tracking-enable:
201   azoteq,filt-str-slider:
208   "^channel@[0-7]$":
211       Represents a single sensing channel. A channel is active if defined and
217         maximum: 7
218         description: Index of the channel.
220       azoteq,reseed-disable:
223           Prevents the channel from being reseeded if the long-term average
224           timeout (defined in 'azoteq,timeout-lta') expires.
226       azoteq,blocking-enable:
228         description: Specifies that the channel is a blocking channel.
230       azoteq,slider0-select:
232         description: Specifies that the channel participates in slider 0.
234       azoteq,slider1-select:
236         description: Specifies that the channel participates in slider 1.
238       azoteq,rx-enable:
239         $ref: /schemas/types.yaml#/definitions/uint32-array
244           maximum: 7
246           Specifies the CRX pin(s) associated with the channel. By default, only
247           the CRX pin corresponding to the channel's index is enabled (e.g. CRX0
248           for channel 0).
250       azoteq,tx-enable:
251         $ref: /schemas/types.yaml#/definitions/uint32-array
256           maximum: 7
257         default: [0, 1, 2, 3, 4, 5, 6, 7]
258         description: Specifies the TX pin(s) associated with the channel.
260       azoteq,meas-cap-decrease:
265       azoteq,rx-float-inactive:
269       azoteq,local-cap-size:
274           Specifies the capacitance to be added to the channel as follows:
276           1: Global adder (based on 'azoteq,global-cap-increase')
279       azoteq,invert-enable:
283           deep-touch events relative to their respective thresholds.
285       azoteq,proj-bias:
290           Specifies the bias current applied during projected-capacitance
297       azoteq,sense-mode:
302           Specifies the channel's sensing mode as follows:
309       azoteq,sense-freq:
314           Specifies the channel's sensing frequency as follows (parenthesized
315           numbers represent the frequency if 'azoteq,clk-div' is present):
321       azoteq,static-enable:
323         description: Enables the static front-end for the channel.
325       azoteq,ati-mode:
330           Specifies the channel's ATI mode as follows:
332           1: Semi-partial
336       azoteq,ati-base:
340         description: Specifies the channel's ATI base.
342       azoteq,ati-target:
348         description: Specifies the channel's ATI target.
350       azoteq,assoc-select:
351         $ref: /schemas/types.yaml#/definitions/uint32-array
356           maximum: 7
358           Specifies the associated channels for which the channel serves as a
359           reference channel. By default, no channels are selected.
361       azoteq,assoc-weight:
367           Specifies the channel's impact weight if it acts as an associated
368           channel (0 = 0% impact, 255 = 200% impact).
371       "^event-prox(-alt)?$":
375           Represents a proximity event reported by the channel in response to
376           a decrease in counts. Node names suffixed with '-alt' instead corre-
379           By default, the long-term average tracks an increase in counts such
383           Specify 'azoteq,dual-direction' to freeze the long-term average when
385           can be reported. Alternatively, specify 'azoteq,invert-enable' to in-
386           vert the polarity of the states reported by the channel.
388           Complementary events (e.g. event-touch and event-touch-alt) can both
389           be present and specify different key or switch codes, but not differ-
404       "^event-touch(-alt)?$":
407         description: Represents a touch event reported by the channel.
428       "^event-deep(-alt)?$":
431         description: Represents a deep-touch event reported by the channel.
453       - reg
458   - compatible
459   - reg
460   - interrupts
461   - "#address-cells"
462   - "#size-cells"
467   - |
468     #include <dt-bindings/input/input.h>
469     #include <dt-bindings/interrupt-controller/irq.h>
472             #address-cells = <1>;
473             #size-cells = <0>;
476                     #address-cells = <1>;
477                     #size-cells = <0>;
481                     interrupt-parent = <&gpio>;
484                     azoteq,hall-enable;
485                     azoteq,suspend-mode = <2>;
487                     channel@0 {
490                             event-prox {
495                     channel@1 {
497                             azoteq,slider0-select;
500                     channel@2 {
502                             azoteq,slider0-select;
505                     channel@3 {
507                             azoteq,slider0-select;
510                     channel@4 {
512                             azoteq,slider0-select;
515                     channel@5 {
517                             azoteq,slider0-select;
520                     channel@6 {
522                             azoteq,invert-enable;
523                             azoteq,static-enable;
524                             azoteq,reseed-disable;
525                             azoteq,rx-enable = <0>;
526                             azoteq,sense-freq = <0x0>;
527                             azoteq,sense-mode = <0xE>;
528                             azoteq,ati-mode = <0x0>;
529                             azoteq,ati-base = <200>;
530                             azoteq,ati-target = <320>;
533                     channel@7 {
535                             azoteq,invert-enable;
536                             azoteq,static-enable;
537                             azoteq,reseed-disable;
538                             azoteq,rx-enable = <0>, <6>;
539                             azoteq,sense-freq = <0x0>;
540                             azoteq,sense-mode = <0xE>;
541                             azoteq,ati-mode = <0x3>;
542                             azoteq,ati-base = <200>;
543                             azoteq,ati-target = <320>;
545                             event-touch {