xref: /linux/Documentation/devicetree/bindings/iio/adc/fsl,imx25-gcq.yaml (revision 20c7775aecea04d8ca322039969d49dcf568e0e9) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/adc/fsl,imx25-gcq.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Freescale ADC GCQ device
8
9description:
10  This is a generic conversion queue device that can convert any of the
11  analog inputs using the ADC unit of the i.MX25.
12
13maintainers:
14  - Jonathan Cameron <jic23@kernel.org>
15
16properties:
17  compatible:
18    const: fsl,imx25-gcq
19
20  reg:
21    maxItems: 1
22
23  interrupts:
24    maxItems: 1
25
26  vref-ext-supply:
27    description:
28      The regulator supplying the ADC reference voltage.
29      Required when at least one subnode uses the this reference.
30
31  vref-xp-supply:
32    description:
33      The regulator supplying the ADC reference voltage on pin XP.
34      Required when at least one subnode uses this reference.
35
36  vref-yp-supply:
37    description:
38      The regulator supplying the ADC reference voltage on pin YP.
39      Required when at least one subnode uses this reference.
40
41  "#io-channel-cells":
42    const: 1
43
44  "#address-cells":
45    const: 1
46
47  "#size-cells":
48    const: 0
49
50required:
51  - compatible
52  - reg
53  - interrupts
54  - "#address-cells"
55  - "#size-cells"
56
57patternProperties:
58  "[a-z][a-z0-9]+@[0-9a-f]+$":
59    type: object
60    description:
61      Child nodes used to define the reference voltages used for each channel
62
63    properties:
64      reg:
65        description: |
66          Number of the analog input.
67          0: xp
68          1: yp
69          2: xn
70          3: yn
71          4: wiper
72          5: inaux0
73          6: inaux1
74          7: inaux2
75        items:
76          - minimum: 0
77            maximum: 7
78
79      fsl,adc-refp:
80        $ref: /schemas/types.yaml#/definitions/uint32
81        description: |
82          Specifies the positive reference input as defined in
83          <dt-bindings/iio/adc/fsl-imx25-gcq.h>
84          0: YP voltage reference
85          1: XP voltage reference
86          2: External voltage reference
87          3: Internal voltage reference (default)
88        minimum: 0
89        maximum: 3
90
91      fsl,adc-refn:
92        $ref: /schemas/types.yaml#/definitions/uint32
93        description: |
94          Specifies the negative reference input as defined in
95          <dt-bindings/iio/adc/fsl-imx25-gcq.h>
96          0: XN ground reference
97          1: YN ground reference
98          2: Internal ground reference
99          3: External ground reference (default)
100        minimum: 0
101        maximum: 3
102
103    required:
104      - reg
105
106    additionalProperties: false
107
108additionalProperties: false
109
110examples:
111  - |
112    #include <dt-bindings/iio/adc/fsl-imx25-gcq.h>
113    soc {
114        #address-cells = <1>;
115        #size-cells = <1>;
116        adc@50030800 {
117            compatible = "fsl,imx25-gcq";
118            reg = <0x50030800 0x60>;
119            interrupt-parent = <&tscadc>;
120            interrupts = <1>;
121            #address-cells = <1>;
122            #size-cells = <0>;
123
124            inaux@5 {
125                reg = <5>;
126                fsl,adc-refp = <MX25_ADC_REFP_INT>;
127                fsl,adc-refn = <MX25_ADC_REFN_NGND>;
128            };
129        };
130    };
131...
132