1== Amlogic Meson pinmux controller ==
2
3Required properties for the root node:
4 - compatible: one of "amlogic,meson8-cbus-pinctrl"
5		      "amlogic,meson8b-cbus-pinctrl"
6		      "amlogic,meson8m2-cbus-pinctrl"
7		      "amlogic,meson8-aobus-pinctrl"
8		      "amlogic,meson8b-aobus-pinctrl"
9		      "amlogic,meson8m2-aobus-pinctrl"
10		      "amlogic,meson-gxbb-periphs-pinctrl"
11		      "amlogic,meson-gxbb-aobus-pinctrl"
12		      "amlogic,meson-gxl-periphs-pinctrl"
13		      "amlogic,meson-gxl-aobus-pinctrl"
14		      "amlogic,meson-axg-periphs-pinctrl"
15		      "amlogic,meson-axg-aobus-pinctrl"
16		      "amlogic,meson-g12a-periphs-pinctrl"
17		      "amlogic,meson-g12a-aobus-pinctrl"
18		      "amlogic,meson-a1-periphs-pinctrl"
19 - reg: address and size of registers controlling irq functionality
20
21=== GPIO sub-nodes ===
22
23The GPIO bank for the controller is represented as a sub-node and it acts as a
24GPIO controller.
25
26Required properties for sub-nodes are:
27 - reg: should contain a list of address and size, one tuple for each entry
28   in reg-names.
29 - reg-names: an array of strings describing the "reg" entries.
30   Must contain "mux" and "gpio".
31   May contain "pull", "pull-enable" and "ds" when appropriate.
32 - gpio-controller: identifies the node as a gpio controller
33 - #gpio-cells: must be 2
34
35=== Other sub-nodes ===
36
37Child nodes without the "gpio-controller" represent some desired
38configuration for a pin or a group. Those nodes can be pinmux nodes or
39configuration nodes.
40
41Required properties for pinmux nodes are:
42 - groups: a list of pinmux groups. The list of all available groups
43   depends on the SoC and can be found in driver sources.
44 - function: the name of a function to activate for the specified set
45   of groups. The list of all available functions depends on the SoC
46   and can be found in driver sources.
47
48Required properties for configuration nodes:
49 - pins: a list of pin names
50
51Configuration nodes support the following generic properties, as
52described in file pinctrl-bindings.txt:
53 - "bias-disable"
54 - "bias-pull-up"
55 - "bias-pull-down"
56 - "output-enable"
57 - "output-disable"
58 - "output-low"
59 - "output-high"
60
61Optional properties :
62 - drive-strength-microamp: Drive strength for the specified pins in uA.
63			    This property is only valid for G12A and newer.
64
65=== Example ===
66
67	pinctrl: pinctrl@c1109880 {
68		compatible = "amlogic,meson8-cbus-pinctrl";
69		reg = <0xc1109880 0x10>;
70		#address-cells = <1>;
71		#size-cells = <1>;
72		ranges;
73
74		gpio: banks@c11080b0 {
75			reg = <0xc11080b0 0x28>,
76			      <0xc11080e8 0x18>,
77			      <0xc1108120 0x18>,
78			      <0xc1108030 0x30>;
79			reg-names = "mux", "pull", "pull-enable", "gpio";
80			gpio-controller;
81			#gpio-cells = <2>;
82               };
83
84		nand {
85			mux {
86				groups = "nand_io", "nand_io_ce0", "nand_io_ce1",
87					 "nand_io_rb0", "nand_ale", "nand_cle",
88					 "nand_wen_clk", "nand_ren_clk", "nand_dqs",
89					 "nand_ce2", "nand_ce3";
90				function = "nand";
91			};
92		};
93	};
94