Merge tag 'armsoc-drivers' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / mtd / denali-nand.txt
1 * Denali NAND controller
2
3 Required properties:
4   - compatible : should be one of the following:
5       "altr,socfpga-denali-nand"            - for Altera SOCFPGA
6       "socionext,uniphier-denali-nand-v5a"  - for Socionext UniPhier (v5a)
7       "socionext,uniphier-denali-nand-v5b"  - for Socionext UniPhier (v5b)
8   - reg : should contain registers location and length for data and reg.
9   - reg-names: Should contain the reg names "nand_data" and "denali_reg"
10   - #address-cells: should be 1. The cell encodes the chip select connection.
11   - #size-cells : should be 0.
12   - interrupts : The interrupt number.
13   - clocks: should contain phandle of the controller core clock, the bus
14     interface clock, and the ECC circuit clock.
15   - clock-names: should contain "nand", "nand_x", "ecc"
16
17 Optional properties:
18   - resets: may contain phandles to the controller core reset, the register
19     reset
20   - reset-names: may contain "nand", "reg"
21
22 Sub-nodes:
23   Sub-nodes represent available NAND chips.
24
25   Required properties:
26     - reg: should contain the bank ID of the controller to which each chip
27       select is connected.
28
29   Optional properties:
30     - nand-ecc-step-size: see nand-controller.yaml for details.
31       If present, the value must be
32         512        for "altr,socfpga-denali-nand"
33         1024       for "socionext,uniphier-denali-nand-v5a"
34         1024       for "socionext,uniphier-denali-nand-v5b"
35     - nand-ecc-strength: see nand-controller.yaml for details. Valid values are:
36         8, 15      for "altr,socfpga-denali-nand"
37         8, 16, 24  for "socionext,uniphier-denali-nand-v5a"
38         8, 16      for "socionext,uniphier-denali-nand-v5b"
39     - nand-ecc-maximize: see nand-controller.yaml for details
40
41 The chip nodes may optionally contain sub-nodes describing partitions of the
42 address space. See partition.txt for more detail.
43
44 Examples:
45
46 nand: nand@ff900000 {
47         #address-cells = <1>;
48         #size-cells = <0>;
49         compatible = "altr,socfpga-denali-nand";
50         reg = <0xff900000 0x20>, <0xffb80000 0x1000>;
51         reg-names = "nand_data", "denali_reg";
52         clocks = <&nand_clk>, <&nand_x_clk>, <&nand_ecc_clk>;
53         clock-names = "nand", "nand_x", "ecc";
54         resets = <&nand_rst>, <&nand_reg_rst>;
55         reset-names = "nand", "reg";
56         interrupts = <0 144 4>;
57
58         nand@0 {
59                 reg = <0>;
60         }
61 };