xref: /linux/Documentation/devicetree/bindings/pinctrl/pincfg-node.yaml (revision 7d1f84f1b94e79cb95d974ab3ec54cb3a4d64f5b)
1# SPDX-License-Identifier: GPL-2.0-only
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/pinctrl/pincfg-node.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Generic Pin Configuration Node
8
9maintainers:
10  - Linus Walleij <linusw@kernel.org>
11
12description:
13  Many data items that are represented in a pin configuration node are common
14  and generic. Pin control bindings should use the properties defined below
15  where they are applicable; not all of these properties are relevant or useful
16  for all hardware or binding structures. Each individual binding document
17  should state which of these generic properties, if any, are used, and the
18  structure of the DT nodes that contain these properties.
19
20properties:
21  bias-disable:
22    type: boolean
23    description: disable any pin bias
24
25  bias-high-impedance:
26    type: boolean
27    description: high impedance mode ("third-state", "floating")
28
29  bias-bus-hold:
30    type: boolean
31    description: latch weakly
32
33  bias-pull-up:
34    oneOf:
35      - type: boolean
36      - $ref: /schemas/types.yaml#/definitions/uint32
37    description: pull up the pin. Takes as optional argument on hardware
38      supporting it the pull strength in Ohm.
39
40  bias-pull-down:
41    oneOf:
42      - type: boolean
43      - $ref: /schemas/types.yaml#/definitions/uint32
44    description: pull down the pin. Takes as optional argument on hardware
45      supporting it the pull strength in Ohm.
46
47  bias-pull-pin-default:
48    oneOf:
49      - type: boolean
50      - $ref: /schemas/types.yaml#/definitions/uint32
51    description: use pin-default pull state. Takes as optional argument on
52      hardware supporting it the pull strength in Ohm.
53
54  drive-push-pull:
55    oneOf:
56      - type: boolean
57      - $ref: /schemas/types.yaml#/definitions/uint32
58        enum: [ 0, 1 ]
59        deprecated: true
60    description: drive actively high and low
61
62  drive-open-drain:
63    oneOf:
64      - type: boolean
65      - $ref: /schemas/types.yaml#/definitions/uint32
66        const: 1    # No known cases of 0
67        deprecated: true
68    description: drive with open drain
69
70  drive-open-source:
71    type: boolean
72    description: drive with open source
73
74  drive-strength:
75    $ref: /schemas/types.yaml#/definitions/uint32
76    description: sink or source at most X mA
77
78  drive-strength-microamp:
79    description: sink or source at most X uA
80
81  input-enable:
82    type: boolean
83    description: enable input on pin (no effect on output, such as
84      enabling an input buffer)
85
86  input-disable:
87    type: boolean
88    description: disable input on pin (no effect on output, such as
89      disabling an input buffer)
90
91  input-schmitt-enable:
92    type: boolean
93    description: enable schmitt-trigger mode
94
95  input-schmitt-disable:
96    type: boolean
97    description: disable schmitt-trigger mode
98
99  input-schmitt-microvolt:
100    description: threshold strength for schmitt-trigger
101
102  input-debounce:
103    $ref: /schemas/types.yaml#/definitions/uint32-array
104    description: Takes the debounce time in usec as argument or 0 to disable
105      debouncing
106
107  input-debounce-ns:
108    description: Takes the debounce time in nsec as argument or 0 to disable
109      debouncing
110
111  power-source:
112    $ref: /schemas/types.yaml#/definitions/uint32
113    description: select between different power supplies
114
115  low-power-enable:
116    type: boolean
117    description: enable low power mode
118
119  low-power-disable:
120    type: boolean
121    description: disable low power mode
122
123  output-disable:
124    type: boolean
125    description: disable output on a pin (such as disable an output buffer)
126
127  output-enable:
128    type: boolean
129    description: enable output on a pin without actively driving it
130      (such as enabling an output buffer)
131
132  output-impedance-ohms:
133    description: set the output impedance of a pin to at most X ohms
134
135  output-low:
136    type: boolean
137    description: set the pin to output mode with low level
138
139  output-high:
140    type: boolean
141    description: set the pin to output mode with high level
142
143  sleep-hardware-state:
144    type: boolean
145    description: indicate this is sleep related state which will be
146      programmed into the registers for the sleep state.
147
148  slew-rate:
149    $ref: /schemas/types.yaml#/definitions/uint32
150    description: set the slew rate
151
152  skew-delay:
153    $ref: /schemas/types.yaml#/definitions/uint32
154    description:
155      this affects the expected clock skew on input pins
156      and the delay before latching a value to an output
157      pin. Typically indicates how many double-inverters are
158      used to delay the signal.
159
160  skew-delay-input-ps:
161    description:
162      this affects the expected clock skew in ps on an input pin.
163
164  skew-delay-output-ps:
165    description:
166      this affects the expected delay in ps before latching a value to
167      an output pin.
168
169  input-threshold-voltage-microvolt:
170    description: Specifies the input voltage level of the pin in microvolts.
171      This defines the reference for  VIH (Input High Voltage) and VIL
172      (Input Low Voltage) thresholds for proper signal detection.
173
174allOf:
175  - if:
176      required:
177        - skew-delay
178    then:
179      properties:
180        skew-delay-input-ps: false
181        skew-delay-output-ps: false
182
183  - if:
184      required:
185        - input-disable
186    then:
187      properties:
188        input-enable: false
189        input-threshold-voltage-microvolt: false
190
191  - if:
192      required:
193        - output-disable
194    then:
195      properties:
196        output-enable: false
197        output-impedance-ohms: false
198
199  - if:
200      required:
201        - output-low
202    then:
203      properties:
204        output-high: false
205
206  - if:
207      required:
208        - low-power-enable
209    then:
210      properties:
211        low-power-disable: false
212
213  - if:
214      required:
215        - input-schmitt-disable
216    then:
217      properties:
218        input-schmitt-enable: false
219        input-schmitt-microvolt: false
220
221  - if:
222      required:
223        - input-debounce
224    then:
225      properties:
226        input-debounce-ns: false
227
228  - if:
229      required:
230        - drive-strength
231    then:
232      properties:
233        drive-strength-microamp: false
234
235  - if:
236      anyOf:
237        - required:
238            - drive-open-source
239        - required:
240            - drive-open-drain
241        - required:
242            - drive-push-pull
243    then:
244      oneOf:
245        - required:
246            - drive-open-source
247        - required:
248            - drive-open-drain
249        - required:
250            - drive-push-pull
251
252  - if:
253      anyOf:
254        - required:
255            - bias-disable
256        - required:
257            - bias-bus-hold
258        - required:
259            - bias-pull-up
260        - required:
261            - bias-pull-down
262        - required:
263            - bias-pull-pin-default
264    then:
265      oneOf:
266        - required:
267            - bias-disable
268        - required:
269            - bias-bus-hold
270        - required:
271            - bias-pull-up
272        - required:
273            - bias-pull-down
274        - required:
275            - bias-pull-pin-default
276
277additionalProperties: true
278