xref: /freebsd/sys/contrib/device-tree/Bindings/mtd/nvidia-tegra20-nand.txt (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1NVIDIA Tegra NAND Flash controller
2
3Required properties:
4- compatible: Must be one of:
5  - "nvidia,tegra20-nand"
6- reg: MMIO address range
7- interrupts: interrupt output of the NFC controller
8- clocks: Must contain an entry for each entry in clock-names.
9  See ../clocks/clock-bindings.txt for details.
10- clock-names: Must include the following entries:
11  - nand
12- resets: Must contain an entry for each entry in reset-names.
13  See ../reset/reset.txt for details.
14- reset-names: Must include the following entries:
15  - nand
16
17Optional children nodes:
18Individual NAND chips are children of the NAND controller node. Currently
19only one NAND chip supported.
20
21Required children node properties:
22- reg: An integer ranging from 1 to 6 representing the CS line to use.
23
24Optional children node properties:
25- nand-ecc-mode: String, operation mode of the NAND ecc mode. Currently only
26		 "hw" is supported.
27- nand-ecc-algo: string, algorithm of NAND ECC.
28		 Supported values with "hw" ECC mode are: "rs", "bch".
29- nand-bus-width : See nand-controller.yaml
30- nand-on-flash-bbt: See nand-controller.yaml
31- nand-ecc-strength: integer representing the number of bits to correct
32		     per ECC step (always 512). Supported strength using HW ECC
33		     modes are:
34		     - RS: 4, 6, 8
35		     - BCH: 4, 8, 14, 16
36- nand-ecc-maximize: See nand-controller.yaml
37- nand-is-boot-medium: Makes sure only ECC strengths supported by the boot ROM
38		       are chosen.
39- wp-gpios: GPIO specifier for the write protect pin.
40
41Optional child node of NAND chip nodes:
42Partitions: see partition.txt
43
44  Example:
45	nand-controller@70008000 {
46		compatible = "nvidia,tegra20-nand";
47		reg = <0x70008000 0x100>;
48		interrupts = <GIC_SPI 24 IRQ_TYPE_LEVEL_HIGH>;
49		clocks = <&tegra_car TEGRA20_CLK_NDFLASH>;
50		clock-names = "nand";
51		resets = <&tegra_car 13>;
52		reset-names = "nand";
53
54		nand@0 {
55			reg = <0>;
56			#address-cells = <1>;
57			#size-cells = <1>;
58			nand-bus-width = <8>;
59			nand-on-flash-bbt;
60			nand-ecc-algo = "bch";
61			nand-ecc-strength = <8>;
62			wp-gpios = <&gpio TEGRA_GPIO(S, 0) GPIO_ACTIVE_LOW>;
63		};
64	};
65