Merge branch 'for-4.8/hid-led' into for-linus
[cascardo/linux.git] / Documentation / devicetree / bindings / arm / hisilicon / hisilicon.txt
1 Hisilicon Platforms Device Tree Bindings
2 ----------------------------------------------------
3 Hi4511 Board
4 Required root node properties:
5         - compatible = "hisilicon,hi3620-hi4511";
6
7 Hi6220 SoC
8 Required root node properties:
9         - compatible = "hisilicon,hi6220";
10
11 HiKey Board
12 Required root node properties:
13         - compatible = "hisilicon,hi6220-hikey", "hisilicon,hi6220";
14
15 HiP01 ca9x2 Board
16 Required root node properties:
17         - compatible = "hisilicon,hip01-ca9x2";
18
19 HiP04 D01 Board
20 Required root node properties:
21         - compatible = "hisilicon,hip04-d01";
22
23 HiP05 D02 Board
24 Required root node properties:
25         - compatible = "hisilicon,hip05-d02";
26
27 HiP06 D03 Board
28 Required root node properties:
29         - compatible = "hisilicon,hip06-d03";
30
31 Hisilicon system controller
32
33 Required properties:
34 - compatible : "hisilicon,sysctrl"
35 - reg : Register address and size
36
37 Optional properties:
38 - smp-offset : offset in sysctrl for notifying slave cpu booting
39                 cpu 1, reg;
40                 cpu 2, reg + 0x4;
41                 cpu 3, reg + 0x8;
42                 If reg value is not zero, cpun exit wfi and go
43 - resume-offset : offset in sysctrl for notifying cpu0 when resume
44 - reboot-offset : offset in sysctrl for system reboot
45
46 Example:
47
48         /* for Hi3620 */
49         sysctrl: system-controller@fc802000 {
50                 compatible = "hisilicon,sysctrl";
51                 reg = <0xfc802000 0x1000>;
52                 smp-offset = <0x31c>;
53                 resume-offset = <0x308>;
54                 reboot-offset = <0x4>;
55         };
56
57 -----------------------------------------------------------------------
58 Hisilicon Hi6220 system controller
59
60 Required properties:
61 - compatible : "hisilicon,hi6220-sysctrl"
62 - reg : Register address and size
63 - #clock-cells: should be set to 1, many clock registers are defined
64   under this controller and this property must be present.
65
66 Hisilicon designs this controller as one of the system controllers,
67 its main functions are the same as Hisilicon system controller, but
68 the register offset of some core modules are different.
69
70 Example:
71         /*for Hi6220*/
72         sys_ctrl: sys_ctrl@f7030000 {
73                 compatible = "hisilicon,hi6220-sysctrl", "syscon";
74                 reg = <0x0 0xf7030000 0x0 0x2000>;
75                 #clock-cells = <1>;
76         };
77
78
79 Hisilicon Hi6220 Power Always ON domain controller
80
81 Required properties:
82 - compatible : "hisilicon,hi6220-aoctrl"
83 - reg : Register address and size
84 - #clock-cells: should be set to 1, many clock registers are defined
85   under this controller and this property must be present.
86
87 Hisilicon designs this system controller to control the power always
88 on domain for mobile platform.
89
90 Example:
91         /*for Hi6220*/
92         ao_ctrl: ao_ctrl@f7800000 {
93                 compatible = "hisilicon,hi6220-aoctrl", "syscon";
94                 reg = <0x0 0xf7800000 0x0 0x2000>;
95                 #clock-cells = <1>;
96         };
97
98
99 Hisilicon Hi6220 Media domain controller
100
101 Required properties:
102 - compatible : "hisilicon,hi6220-mediactrl"
103 - reg : Register address and size
104 - #clock-cells: should be set to 1, many clock registers are defined
105   under this controller and this property must be present.
106
107 Hisilicon designs this system controller to control the multimedia
108 domain(e.g. codec, G3D ...) for mobile platform.
109
110 Example:
111         /*for Hi6220*/
112         media_ctrl: media_ctrl@f4410000 {
113                 compatible = "hisilicon,hi6220-mediactrl", "syscon";
114                 reg = <0x0 0xf4410000 0x0 0x1000>;
115                 #clock-cells = <1>;
116         };
117
118
119 Hisilicon Hi6220 Power Management domain controller
120
121 Required properties:
122 - compatible : "hisilicon,hi6220-pmctrl"
123 - reg : Register address and size
124 - #clock-cells: should be set to 1, some clock registers are define
125   under this controller and this property must be present.
126
127 Hisilicon designs this system controller to control the power management
128 domain for mobile platform.
129
130 Example:
131         /*for Hi6220*/
132         pm_ctrl: pm_ctrl@f7032000 {
133                 compatible = "hisilicon,hi6220-pmctrl", "syscon";
134                 reg = <0x0 0xf7032000 0x0 0x1000>;
135                 #clock-cells = <1>;
136         };
137
138
139 Hisilicon Hi6220 SRAM controller
140
141 Required properties:
142 - compatible : "hisilicon,hi6220-sramctrl", "syscon"
143 - reg : Register address and size
144
145 Hisilicon's SoCs use sram for multiple purpose; on Hi6220 there have several
146 SRAM banks for power management, modem, security, etc. Further, use "syscon"
147 managing the common sram which can be shared by multiple modules.
148
149 Example:
150         /*for Hi6220*/
151         sram: sram@fff80000 {
152                 compatible = "hisilicon,hi6220-sramctrl", "syscon";
153                 reg = <0x0 0xfff80000 0x0 0x12000>;
154         };
155
156 -----------------------------------------------------------------------
157 Hisilicon HiP01 system controller
158
159 Required properties:
160 - compatible : "hisilicon,hip01-sysctrl"
161 - reg : Register address and size
162
163 The HiP01 system controller is mostly compatible with hisilicon
164 system controller,but it has some specific control registers for
165 HIP01 SoC family, such as slave core boot, and also some same
166 registers located at different offset.
167
168 Example:
169
170         /* for hip01-ca9x2 */
171         sysctrl: system-controller@10000000 {
172                 compatible = "hisilicon,hip01-sysctrl", "hisilicon,sysctrl";
173                 reg = <0x10000000 0x1000>;
174                 reboot-offset = <0x4>;
175         };
176
177 -----------------------------------------------------------------------
178 Hisilicon HiP05 PCIe-SAS system controller
179
180 Required properties:
181 - compatible : "hisilicon,pcie-sas-subctrl", "syscon";
182 - reg : Register address and size
183
184 The HiP05 PCIe-SAS system controller is shared by PCIe and SAS controllers in
185 HiP05 Soc to implement some basic configurations.
186
187 Example:
188         /* for HiP05 PCIe-SAS system */
189         pcie_sas: system_controller@0xb0000000 {
190                 compatible = "hisilicon,pcie-sas-subctrl", "syscon";
191                 reg = <0xb0000000 0x10000>;
192         };
193
194 Hisilicon HiP05 PERISUB system controller
195
196 Required properties:
197 - compatible : "hisilicon,hip05-perisubc", "syscon";
198 - reg : Register address and size
199
200 The HiP05 PERISUB system controller is shared by peripheral controllers in
201 HiP05 Soc to implement some basic configurations. The peripheral
202 controllers include mdio, ddr, iic, uart, timer and so on.
203
204 Example:
205         /* for HiP05 perisub-ctrl-c system */
206         peri_c_subctrl: syscon@80000000 {
207                 compatible = "hisilicon,hip05-perisubc", "syscon";
208                 reg = <0x0 0x80000000 0x0 0x10000>;
209         };
210 -----------------------------------------------------------------------
211 Hisilicon CPU controller
212
213 Required properties:
214 - compatible : "hisilicon,cpuctrl"
215 - reg : Register address and size
216
217 The clock registers and power registers of secondary cores are defined
218 in CPU controller, especially in HIX5HD2 SoC.
219
220 -----------------------------------------------------------------------
221 PCTRL: Peripheral misc control register
222
223 Required Properties:
224 - compatible: "hisilicon,pctrl"
225 - reg: Address and size of pctrl.
226
227 Example:
228
229         /* for Hi3620 */
230         pctrl: pctrl@fca09000 {
231                 compatible = "hisilicon,pctrl";
232                 reg = <0xfca09000 0x1000>;
233         };
234
235 -----------------------------------------------------------------------
236 Fabric:
237
238 Required Properties:
239 - compatible: "hisilicon,hip04-fabric";
240 - reg: Address and size of Fabric
241
242 -----------------------------------------------------------------------
243 Bootwrapper boot method (software protocol on SMP):
244
245 Required Properties:
246 - compatible: "hisilicon,hip04-bootwrapper";
247 - boot-method: Address and size of boot method.
248   [0]: bootwrapper physical address
249   [1]: bootwrapper size
250   [2]: relocation physical address
251   [3]: relocation size