Merge tag '9p-for-5.3' of git://github.com/martinetd/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / memory-controllers / ingenic,jz4780-nemc.txt
1 * Ingenic JZ4780 NAND/external memory controller (NEMC)
2
3 This file documents the device tree bindings for the NEMC external memory
4 controller in Ingenic JZ4780
5
6 Required properties:
7 - compatible: Should be set to one of:
8     "ingenic,jz4740-nemc" (JZ4740)
9     "ingenic,jz4780-nemc" (JZ4780)
10 - reg: Should specify the NEMC controller registers location and length.
11 - clocks: Clock for the NEMC controller.
12 - #address-cells: Must be set to 2.
13 - #size-cells: Must be set to 1.
14 - ranges: A set of ranges for each bank describing the physical memory layout.
15   Each should specify the following 4 integer values:
16
17     <cs number> 0 <physical address of mapping> <size of mapping>
18
19 Each child of the NEMC node describes a device connected to the NEMC.
20
21 Required child node properties:
22 - reg: Should contain at least one register specifier, given in the following
23   format:
24
25     <cs number> <offset> <size>
26
27   Multiple registers can be specified across multiple banks. This is needed,
28   for example, for packaged NAND devices with multiple dies. Such devices
29   should be grouped into a single node.
30
31 Optional child node properties:
32 - ingenic,nemc-bus-width: Specifies the bus width in bits. Defaults to 8 bits.
33 - ingenic,nemc-tAS: Address setup time in nanoseconds.
34 - ingenic,nemc-tAH: Address hold time in nanoseconds.
35 - ingenic,nemc-tBP: Burst pitch time in nanoseconds.
36 - ingenic,nemc-tAW: Access wait time in nanoseconds.
37 - ingenic,nemc-tSTRV: Static memory recovery time in nanoseconds.
38
39 If a child node references multiple banks in its "reg" property, the same value
40 for all optional parameters will be configured for all banks. If any optional
41 parameters are omitted, they will be left unchanged from whatever they are
42 configured to when the NEMC device is probed (which may be the reset value as
43 given in the hardware reference manual, or a value configured by the boot
44 loader).
45
46 Example (NEMC node with a NAND child device attached at CS1):
47
48 nemc: nemc@13410000 {
49         compatible = "ingenic,jz4780-nemc";
50         reg = <0x13410000 0x10000>;
51
52         #address-cells = <2>;
53         #size-cells = <1>;
54
55         ranges = <1 0 0x1b000000 0x1000000
56                   2 0 0x1a000000 0x1000000
57                   3 0 0x19000000 0x1000000
58                   4 0 0x18000000 0x1000000
59                   5 0 0x17000000 0x1000000
60                   6 0 0x16000000 0x1000000>;
61
62         clocks = <&cgu JZ4780_CLK_NEMC>;
63
64         nand: nand@1 {
65                 compatible = "ingenic,jz4780-nand";
66                 reg = <1 0 0x1000000>;
67
68                 ingenic,nemc-tAS = <10>;
69                 ingenic,nemc-tAH = <5>;
70                 ingenic,nemc-tBP = <10>;
71                 ingenic,nemc-tAW = <15>;
72                 ingenic,nemc-tSTRV = <100>;
73
74                 ...
75         };
76 };