Merge tag 'rtc-4.21' of git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sram / sunxi-sram.txt
1 Allwinnner SoC SRAM controllers
2 -----------------------------------------------------
3
4 The SRAM controller found on most Allwinner devices is represented by
5 a regular node for the SRAM controller itself, with sub-nodes
6 reprensenting the SRAM handled by the SRAM controller.
7
8 Controller Node
9 ---------------
10
11 Required properties:
12 - compatible : should be:
13     - "allwinner,sun4i-a10-sram-controller" (deprecated)
14     - "allwinner,sun4i-a10-system-control"
15     - "allwinner,sun5i-a13-system-control"
16     - "allwinner,sun7i-a20-system-control", "allwinner,sun4i-a10-system-control"
17     - "allwinner,sun8i-a23-system-control"
18     - "allwinner,sun8i-h3-system-control"
19     - "allwinner,sun50i-a64-sram-controller" (deprecated)
20     - "allwinner,sun50i-a64-system-control"
21     - "allwinner,sun50i-h5-system-control"
22     - "allwinner,sun50i-h6-system-control", "allwinner,sun50i-a64-system-control"
23     - "allwinner,suniv-f1c100s-system-control", "allwinner,sun4i-a10-system-control"
24 - reg : sram controller register offset + length
25
26 SRAM nodes
27 ----------
28
29 Each SRAM is described using the mmio-sram bindings documented in
30 Documentation/devicetree/bindings/sram/sram.txt
31
32 Each SRAM will have SRAM sections that are going to be handled by the
33 SRAM controller as subnodes. These sections are represented following
34 once again the representation described in the mmio-sram binding.
35
36 The valid sections compatible for A10 are:
37     - allwinner,sun4i-a10-sram-a3-a4
38     - allwinner,sun4i-a10-sram-c1
39     - allwinner,sun4i-a10-sram-d
40
41 The valid sections compatible for A13 are:
42     - allwinner,sun5i-a13-sram-a3-a4, allwinner,sun4i-a10-sram-a3-a4
43     - allwinner,sun5i-a13-sram-c1, allwinner,sun4i-a10-sram-c1
44     - allwinner,sun5i-a13-sram-d, allwinner,sun4i-a10-sram-d
45
46 The valid sections compatible for A20 are:
47     - allwinner,sun7i-a20-sram-a3-a4, allwinner,sun4i-a10-sram-a3-a4
48     - allwinner,sun7i-a20-sram-c1, allwinner,sun4i-a10-sram-c1
49     - allwinner,sun7i-a20-sram-d, allwinner,sun4i-a10-sram-d
50
51 The valid sections compatible for A23/A33 are:
52     - allwinner,sun8i-a23-sram-c1, allwinner,sun4i-a10-sram-c1
53
54 The valid sections compatible for H3 are:
55     - allwinner,sun8i-h3-sram-c1, allwinner,sun4i-a10-sram-c1
56
57 The valid sections compatible for A64 are:
58     - allwinner,sun50i-a64-sram-c
59     - allwinner,sun50i-a64-sram-c1, allwinner,sun4i-a10-sram-c1
60
61 The valid sections compatible for H5 are:
62     - allwinner,sun50i-h5-sram-c1, allwinner,sun4i-a10-sram-c1
63
64 The valid sections compatible for H6 are:
65     - allwinner,sun50i-h6-sram-c, allwinner,sun50i-a64-sram-c
66
67 The valid sections compatible for F1C100s are:
68     - allwinner,suniv-f1c100s-sram-d, allwinner,sun4i-a10-sram-d
69
70 Devices using SRAM sections
71 ---------------------------
72
73 Some devices need to request to the SRAM controller to map an SRAM for
74 their exclusive use.
75
76 The relationship between such a device and an SRAM section is
77 expressed through the allwinner,sram property, that will take a
78 phandle and an argument.
79
80 This valid values for this argument are:
81   - 0: CPU
82   - 1: Device
83
84 Example
85 -------
86 system-control@1c00000 {
87         compatible = "allwinner,sun4i-a10-system-control";
88         reg = <0x01c00000 0x30>;
89         #address-cells = <1>;
90         #size-cells = <1>;
91         ranges;
92
93         sram_a: sram@00000000 {
94                 compatible = "mmio-sram";
95                 reg = <0x00000000 0xc000>;
96                 #address-cells = <1>;
97                 #size-cells = <1>;
98                 ranges = <0 0x00000000 0xc000>;
99
100                 emac_sram: sram-section@8000 {
101                         compatible = "allwinner,sun4i-a10-sram-a3-a4";
102                         reg = <0x8000 0x4000>;
103                 };
104         };
105 };
106
107 emac: ethernet@1c0b000 {
108         compatible = "allwinner,sun4i-a10-emac";
109         ...
110
111         allwinner,sram = <&emac_sram 1>;
112 };