xref: /freebsd/sys/contrib/device-tree/Bindings/pinctrl/pinctrl.yaml (revision e67e85659c0de33e617e5fbf1028c6e8b49eee53)
1*e67e8565SEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2*e67e8565SEmmanuel Vadot%YAML 1.2
3*e67e8565SEmmanuel Vadot---
4*e67e8565SEmmanuel Vadot$id: http://devicetree.org/schemas/pinctrl/pinctrl.yaml#
5*e67e8565SEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6*e67e8565SEmmanuel Vadot
7*e67e8565SEmmanuel Vadottitle: Pin controller device
8*e67e8565SEmmanuel Vadot
9*e67e8565SEmmanuel Vadotmaintainers:
10*e67e8565SEmmanuel Vadot  - Linus Walleij <linus.walleij@linaro.org>
11*e67e8565SEmmanuel Vadot  - Rafał Miłecki <rafal@milecki.pl>
12*e67e8565SEmmanuel Vadot
13*e67e8565SEmmanuel Vadotdescription: |
14*e67e8565SEmmanuel Vadot  Pin controller devices should contain the pin configuration nodes that client
15*e67e8565SEmmanuel Vadot  devices reference.
16*e67e8565SEmmanuel Vadot
17*e67e8565SEmmanuel Vadot  The contents of each of those pin configuration child nodes is defined
18*e67e8565SEmmanuel Vadot  entirely by the binding for the individual pin controller device. There
19*e67e8565SEmmanuel Vadot  exists no common standard for this content. The pinctrl framework only
20*e67e8565SEmmanuel Vadot  provides generic helper bindings that the pin controller driver can use.
21*e67e8565SEmmanuel Vadot
22*e67e8565SEmmanuel Vadot  The pin configuration nodes need not be direct children of the pin controller
23*e67e8565SEmmanuel Vadot  device; they may be grandchildren, for example. Whether this is legal, and
24*e67e8565SEmmanuel Vadot  whether there is any interaction between the child and intermediate parent
25*e67e8565SEmmanuel Vadot  nodes, is again defined entirely by the binding for the individual pin
26*e67e8565SEmmanuel Vadot  controller device.
27*e67e8565SEmmanuel Vadot
28*e67e8565SEmmanuel Vadotproperties:
29*e67e8565SEmmanuel Vadot  $nodename:
30*e67e8565SEmmanuel Vadot    pattern: "^(pinctrl|pinmux)(@[0-9a-f]+)?$"
31*e67e8565SEmmanuel Vadot
32*e67e8565SEmmanuel Vadot  "#pinctrl-cells":
33*e67e8565SEmmanuel Vadot    description: >
34*e67e8565SEmmanuel Vadot      Number of pin control cells in addition to the index within the pin
35*e67e8565SEmmanuel Vadot      controller device instance.
36*e67e8565SEmmanuel Vadot
37*e67e8565SEmmanuel Vadot  pinctrl-use-default:
38*e67e8565SEmmanuel Vadot    type: boolean
39*e67e8565SEmmanuel Vadot    description: >
40*e67e8565SEmmanuel Vadot      Indicates that the OS can use the boot default pin configuration. This
41*e67e8565SEmmanuel Vadot      allows using an OS that does not have a driver for the pin controller.
42*e67e8565SEmmanuel Vadot      This property can be set either globally for the pin controller or in
43*e67e8565SEmmanuel Vadot      child nodes for individual pin group control.
44*e67e8565SEmmanuel Vadot
45*e67e8565SEmmanuel VadotadditionalProperties: true
46