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