Merge remote-tracking branches 'spi/topic/loopback', 'spi/topic/omap2-mcspi', 'spi...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / pinctrl / meson,pinctrl.txt
1 == Amlogic Meson pinmux controller ==
2
3 Required properties for the root node:
4  - compatible: one of "amlogic,meson8-cbus-pinctrl"
5                       "amlogic,meson8b-cbus-pinctrl"
6                       "amlogic,meson8-aobus-pinctrl"
7                       "amlogic,meson8b-aobus-pinctrl"
8                       "amlogic,meson-gxbb-periphs-pinctrl"
9                       "amlogic,meson-gxbb-aobus-pinctrl"
10                       "amlogic,meson-gxl-periphs-pinctrl"
11                       "amlogic,meson-gxl-aobus-pinctrl"
12  - reg: address and size of registers controlling irq functionality
13
14 === GPIO sub-nodes ===
15
16 The GPIO bank for the controller is represented as a sub-node and it acts as a
17 GPIO controller.
18
19 Required properties for sub-nodes are:
20  - reg: should contain address and size for mux, pull-enable, pull and
21    gpio register sets
22  - reg-names: an array of strings describing the "reg" entries. Must
23    contain "mux", "pull" and "gpio". "pull-enable" is optional and
24    when it is missing the "pull" registers are used instead
25  - gpio-controller: identifies the node as a gpio controller
26  - #gpio-cells: must be 2
27
28 === Other sub-nodes ===
29
30 Child nodes without the "gpio-controller" represent some desired
31 configuration for a pin or a group. Those nodes can be pinmux nodes or
32 configuration nodes.
33
34 Required properties for pinmux nodes are:
35  - groups: a list of pinmux groups. The list of all available groups
36    depends on the SoC and can be found in driver sources.
37  - function: the name of a function to activate for the specified set
38    of groups. The list of all available functions depends on the SoC
39    and can be found in driver sources.
40
41 Required properties for configuration nodes:
42  - pins: a list of pin names
43
44 Configuration nodes support the generic properties "bias-disable",
45 "bias-pull-up" and "bias-pull-down", described in file
46 pinctrl-bindings.txt
47
48 === Example ===
49
50         pinctrl: pinctrl@c1109880 {
51                 compatible = "amlogic,meson8-cbus-pinctrl";
52                 reg = <0xc1109880 0x10>;
53                 #address-cells = <1>;
54                 #size-cells = <1>;
55                 ranges;
56
57                 gpio: banks@c11080b0 {
58                         reg = <0xc11080b0 0x28>,
59                               <0xc11080e8 0x18>,
60                               <0xc1108120 0x18>,
61                               <0xc1108030 0x30>;
62                         reg-names = "mux", "pull", "pull-enable", "gpio";
63                         gpio-controller;
64                         #gpio-cells = <2>;
65                };
66
67                 nand {
68                         mux {
69                                 groups = "nand_io", "nand_io_ce0", "nand_io_ce1",
70                                          "nand_io_rb0", "nand_ale", "nand_cle",
71                                          "nand_wen_clk", "nand_ren_clk", "nand_dqs",
72                                          "nand_ce2", "nand_ce3";
73                                 function = "nand";
74                         };
75                 };
76         };