1 Atmel NAND flash controller bindings 1 Atmel NAND flash controller bindings
2 2
3 The NAND flash controller node should be defin 3 The NAND flash controller node should be defined under the EBI bus (see
4 Documentation/devicetree/bindings/memory-contr 4 Documentation/devicetree/bindings/memory-controllers/atmel,ebi.txt).
5 One or several NAND devices can be defined und 5 One or several NAND devices can be defined under this NAND controller.
6 The NAND controller might be connected to an E 6 The NAND controller might be connected to an ECC engine.
7 7
8 * NAND controller bindings: 8 * NAND controller bindings:
9 9
10 Required properties: 10 Required properties:
11 - compatible: should be one of the following 11 - compatible: should be one of the following
12 "atmel,at91rm9200-nand-controller" 12 "atmel,at91rm9200-nand-controller"
13 "atmel,at91sam9260-nand-controller" 13 "atmel,at91sam9260-nand-controller"
14 "atmel,at91sam9261-nand-controller" 14 "atmel,at91sam9261-nand-controller"
15 "atmel,at91sam9g45-nand-controller" 15 "atmel,at91sam9g45-nand-controller"
16 "atmel,sama5d3-nand-controller" 16 "atmel,sama5d3-nand-controller"
17 "microchip,sam9x60-nand-controller" <<
18 - ranges: empty ranges property to forward EBI 17 - ranges: empty ranges property to forward EBI ranges definitions.
19 - #address-cells: should be set to 2. 18 - #address-cells: should be set to 2.
20 - #size-cells: should be set to 1. 19 - #size-cells: should be set to 1.
21 - atmel,nfc-io: phandle to the NFC IO block. O 20 - atmel,nfc-io: phandle to the NFC IO block. Only required for sama5d3
22 controllers. 21 controllers.
23 - atmel,nfc-sram: phandle to the NFC SRAM bloc 22 - atmel,nfc-sram: phandle to the NFC SRAM block. Only required for sama5d3
24 controllers. 23 controllers.
25 24
26 Optional properties: 25 Optional properties:
27 - ecc-engine: phandle to the PMECC block. Only 26 - ecc-engine: phandle to the PMECC block. Only meaningful if the SoC embeds
28 a PMECC engine. 27 a PMECC engine.
29 28
30 * NAND device/chip bindings: 29 * NAND device/chip bindings:
31 30
32 Required properties: 31 Required properties:
33 - reg: describes the CS lines assigned to the 32 - reg: describes the CS lines assigned to the NAND device. If the NAND device
34 exposes multiple CS lines (multi-dies c 33 exposes multiple CS lines (multi-dies chips), your reg property will
35 contain X tuples of 3 entries. 34 contain X tuples of 3 entries.
36 1st entry: the CS line this NAND chip i 35 1st entry: the CS line this NAND chip is connected to
37 2nd entry: the base offset of the memor 36 2nd entry: the base offset of the memory region assigned to this
38 device (always 0) 37 device (always 0)
39 3rd entry: the memory region size (alwa 38 3rd entry: the memory region size (always 0x800000)
40 39
41 Optional properties: 40 Optional properties:
42 - rb-gpios: the GPIO(s) used to check the Read 41 - rb-gpios: the GPIO(s) used to check the Ready/Busy status of the NAND.
43 - cs-gpios: the GPIO(s) used to control the CS 42 - cs-gpios: the GPIO(s) used to control the CS line.
44 - det-gpios: the GPIO used to detect if a Smar 43 - det-gpios: the GPIO used to detect if a Smartmedia Card is present.
45 - atmel,rb: an integer identifying the native 44 - atmel,rb: an integer identifying the native Ready/Busy pin. Only meaningful
46 on sama5 SoCs. 45 on sama5 SoCs.
47 46
48 All generic properties are described in the ge !! 47 All generic properties described in
49 Documentation/devicetree/bindings/mtd/. !! 48 Documentation/devicetree/bindings/mtd/{common,nand}.txt also apply to the NAND
>> 49 device node, and NAND partitions should be defined under the NAND node as
>> 50 described in Documentation/devicetree/bindings/mtd/partition.txt.
50 51
51 * ECC engine (PMECC) bindings: 52 * ECC engine (PMECC) bindings:
52 53
53 Required properties: 54 Required properties:
54 - compatible: should be one of the following 55 - compatible: should be one of the following
55 "atmel,at91sam9g45-pmecc" 56 "atmel,at91sam9g45-pmecc"
56 "atmel,sama5d4-pmecc" 57 "atmel,sama5d4-pmecc"
57 "atmel,sama5d2-pmecc" 58 "atmel,sama5d2-pmecc"
58 "microchip,sam9x60-pmecc" <<
59 "microchip,sam9x7-pmecc", "atmel,at91s <<
60 - reg: should contain 2 register ranges. The f 59 - reg: should contain 2 register ranges. The first one is pointing to the PMECC
61 block, and the second one to the PMECC_ 60 block, and the second one to the PMECC_ERRLOC block.
62 61
63 Example: 62 Example:
64 <<
65 nfc_io: nfc-io@70000000 { <<
66 compatible = "atmel,sama5d3-nf <<
67 reg = <0x70000000 0x8000000>; <<
68 }; <<
69 63
70 pmecc: ecc-engine@ffffc070 { 64 pmecc: ecc-engine@ffffc070 {
71 compatible = "atmel,at91sam9g4 65 compatible = "atmel,at91sam9g45-pmecc";
72 reg = <0xffffc070 0x490>, 66 reg = <0xffffc070 0x490>,
73 <0xffffc500 0x100>; 67 <0xffffc500 0x100>;
74 }; 68 };
75 69
76 ebi: ebi@10000000 { 70 ebi: ebi@10000000 {
77 compatible = "atmel,sama5d3-eb 71 compatible = "atmel,sama5d3-ebi";
78 #address-cells = <2>; 72 #address-cells = <2>;
79 #size-cells = <1>; 73 #size-cells = <1>;
80 atmel,smc = <&hsmc>; 74 atmel,smc = <&hsmc>;
81 reg = <0x10000000 0x10000000 75 reg = <0x10000000 0x10000000
82 0x40000000 0x30000000>; 76 0x40000000 0x30000000>;
83 ranges = <0x0 0x0 0x10000000 0 77 ranges = <0x0 0x0 0x10000000 0x10000000
84 0x1 0x0 0x40000000 0 78 0x1 0x0 0x40000000 0x10000000
85 0x2 0x0 0x50000000 0 79 0x2 0x0 0x50000000 0x10000000
86 0x3 0x0 0x60000000 0 80 0x3 0x0 0x60000000 0x10000000>;
87 clocks = <&mck>; 81 clocks = <&mck>;
88 82
89 nand_controller: nand-controll 83 nand_controller: nand-controller {
90 compatible = "atmel,sa 84 compatible = "atmel,sama5d3-nand-controller";
91 atmel,nfc-sram = <&nfc 85 atmel,nfc-sram = <&nfc_sram>;
92 atmel,nfc-io = <&nfc_i 86 atmel,nfc-io = <&nfc_io>;
93 ecc-engine = <&pmecc>; 87 ecc-engine = <&pmecc>;
94 #address-cells = <2>; 88 #address-cells = <2>;
95 #size-cells = <1>; 89 #size-cells = <1>;
96 ranges; 90 ranges;
97 91
98 nand@3 { 92 nand@3 {
99 reg = <0x3 0x0 93 reg = <0x3 0x0 0x800000>;
100 atmel,rb = <0> 94 atmel,rb = <0>;
101 95
102 /* 96 /*
103 * Put generic 97 * Put generic NAND/MTD properties and
104 * subnodes he 98 * subnodes here.
105 */ 99 */
106 }; 100 };
107 }; 101 };
108 }; 102 };
109 103
110 ---------------------------------------------- 104 -----------------------------------------------------------------------
111 105
112 Deprecated bindings (should not be used in new 106 Deprecated bindings (should not be used in new device trees):
113 107
114 Required properties: 108 Required properties:
115 - compatible: The possible values are: 109 - compatible: The possible values are:
116 "atmel,at91rm9200-nand" 110 "atmel,at91rm9200-nand"
117 "atmel,sama5d2-nand" 111 "atmel,sama5d2-nand"
118 "atmel,sama5d4-nand" 112 "atmel,sama5d4-nand"
119 - reg : should specify localbus address and si 113 - reg : should specify localbus address and size used for the chip,
120 and hardware ECC controller if availab 114 and hardware ECC controller if available.
121 If the hardware ECC is PMECC, it shoul 115 If the hardware ECC is PMECC, it should contain address and size for
122 PMECC and PMECC Error Location control 116 PMECC and PMECC Error Location controller.
123 The PMECC lookup table address and siz 117 The PMECC lookup table address and size in ROM is optional. If not
124 specified, driver will build it in run 118 specified, driver will build it in runtime.
125 - atmel,nand-addr-offset : offset for the addr 119 - atmel,nand-addr-offset : offset for the address latch.
126 - atmel,nand-cmd-offset : offset for the comma 120 - atmel,nand-cmd-offset : offset for the command latch.
127 - #address-cells, #size-cells : Must be presen 121 - #address-cells, #size-cells : Must be present if the device has sub-nodes
128 representing partitions. 122 representing partitions.
129 123
130 - gpios : specifies the gpio pins to control t 124 - gpios : specifies the gpio pins to control the NAND device. detect is an
131 optional gpio and may be set to 0 if not pre 125 optional gpio and may be set to 0 if not present.
132 126
133 Optional properties: 127 Optional properties:
134 - atmel,nand-has-dma : boolean to support dma 128 - atmel,nand-has-dma : boolean to support dma transfer for nand read/write.
135 - nand-ecc-mode : String, operation mode of th 129 - nand-ecc-mode : String, operation mode of the NAND ecc mode, soft by default.
136 Supported values are: "none", "soft", "hw", 130 Supported values are: "none", "soft", "hw", "hw_syndrome", "hw_oob_first",
137 "soft_bch". 131 "soft_bch".
138 - atmel,has-pmecc : boolean to enable Programm 132 - atmel,has-pmecc : boolean to enable Programmable Multibit ECC hardware,
139 capable of BCH encoding and decoding, on dev 133 capable of BCH encoding and decoding, on devices where it is present.
140 - atmel,pmecc-cap : error correct capability f 134 - atmel,pmecc-cap : error correct capability for Programmable Multibit ECC
141 Controller. Supported values are: 2, 4, 8, 1 135 Controller. Supported values are: 2, 4, 8, 12, 24. If the compatible string
142 is "atmel,sama5d2-nand", 32 is also valid. 136 is "atmel,sama5d2-nand", 32 is also valid.
143 - atmel,pmecc-sector-size : sector size for EC 137 - atmel,pmecc-sector-size : sector size for ECC computation. Supported values
144 are: 512, 1024. 138 are: 512, 1024.
145 - atmel,pmecc-lookup-table-offset : includes t 139 - atmel,pmecc-lookup-table-offset : includes two offsets of lookup table in ROM
146 for different sector size. First one is for 140 for different sector size. First one is for sector size 512, the next is for
147 sector size 1024. If not specified, driver w 141 sector size 1024. If not specified, driver will build the table in runtime.
148 - nand-bus-width : 8 or 16 bus width if not pr 142 - nand-bus-width : 8 or 16 bus width if not present 8
149 - nand-on-flash-bbt: boolean to enable on flas 143 - nand-on-flash-bbt: boolean to enable on flash bbt option if not present false
150 144
151 Nand Flash Controller(NFC) is an optional sub- 145 Nand Flash Controller(NFC) is an optional sub-node
152 Required properties: 146 Required properties:
153 - compatible : "atmel,sama5d3-nfc". 147 - compatible : "atmel,sama5d3-nfc".
154 - reg : should specify the address and size us 148 - reg : should specify the address and size used for NFC command registers,
155 NFC registers and NFC SRAM. NFC SRAM a 149 NFC registers and NFC SRAM. NFC SRAM address and size can be absent
156 if don't want to use it. 150 if don't want to use it.
157 - clocks: phandle to the peripheral clock 151 - clocks: phandle to the peripheral clock
158 Optional properties: 152 Optional properties:
159 - atmel,write-by-sram: boolean to enable NFC w 153 - atmel,write-by-sram: boolean to enable NFC write by SRAM.
160 154
161 Examples: 155 Examples:
162 nand0: nand@40000000,0 { 156 nand0: nand@40000000,0 {
163 compatible = "atmel,at91rm9200-nand"; 157 compatible = "atmel,at91rm9200-nand";
164 #address-cells = <1>; 158 #address-cells = <1>;
165 #size-cells = <1>; 159 #size-cells = <1>;
166 reg = <0x40000000 0x10000000 160 reg = <0x40000000 0x10000000
167 0xffffe800 0x200 161 0xffffe800 0x200
168 >; 162 >;
169 atmel,nand-addr-offset = <21>; /* ale 163 atmel,nand-addr-offset = <21>; /* ale */
170 atmel,nand-cmd-offset = <22>; /* cle 164 atmel,nand-cmd-offset = <22>; /* cle */
171 nand-on-flash-bbt; 165 nand-on-flash-bbt;
172 nand-ecc-mode = "soft"; 166 nand-ecc-mode = "soft";
173 gpios = <&pioC 13 0 /* rdy */ 167 gpios = <&pioC 13 0 /* rdy */
174 &pioC 14 0 /* nce */ 168 &pioC 14 0 /* nce */
175 0 /* cd */ 169 0 /* cd */
176 >; 170 >;
177 partition@0 { 171 partition@0 {
178 ... 172 ...
179 }; 173 };
180 }; 174 };
181 175
182 /* for PMECC supported chips */ 176 /* for PMECC supported chips */
183 nand0: nand@40000000 { 177 nand0: nand@40000000 {
184 compatible = "atmel,at91rm9200-nand"; 178 compatible = "atmel,at91rm9200-nand";
185 #address-cells = <1>; 179 #address-cells = <1>;
186 #size-cells = <1>; 180 #size-cells = <1>;
187 reg = < 0x40000000 0x10000000 /* bus 181 reg = < 0x40000000 0x10000000 /* bus addr & size */
188 0xffffe000 0x00000600 /* PME 182 0xffffe000 0x00000600 /* PMECC addr & size */
189 0xffffe600 0x00000200 /* PME 183 0xffffe600 0x00000200 /* PMECC ERRLOC addr & size */
190 0x00100000 0x00100000 /* ROM 184 0x00100000 0x00100000 /* ROM addr & size */
191 >; 185 >;
192 atmel,nand-addr-offset = <21>; /* ale 186 atmel,nand-addr-offset = <21>; /* ale */
193 atmel,nand-cmd-offset = <22>; /* cle 187 atmel,nand-cmd-offset = <22>; /* cle */
194 nand-on-flash-bbt; 188 nand-on-flash-bbt;
195 nand-ecc-mode = "hw"; 189 nand-ecc-mode = "hw";
196 atmel,has-pmecc; /* enable PMEC 190 atmel,has-pmecc; /* enable PMECC */
197 atmel,pmecc-cap = <2>; 191 atmel,pmecc-cap = <2>;
198 atmel,pmecc-sector-size = <512>; 192 atmel,pmecc-sector-size = <512>;
199 atmel,pmecc-lookup-table-offset = <0x8 193 atmel,pmecc-lookup-table-offset = <0x8000 0x10000>;
200 gpios = <&pioD 5 0 /* rdy */ 194 gpios = <&pioD 5 0 /* rdy */
201 &pioD 4 0 /* nce */ 195 &pioD 4 0 /* nce */
202 0 /* cd */ 196 0 /* cd */
203 >; 197 >;
204 partition@0 { 198 partition@0 {
205 ... 199 ...
206 }; 200 };
207 }; 201 };
208 202
209 /* for NFC supported chips */ 203 /* for NFC supported chips */
210 nand0: nand@40000000 { 204 nand0: nand@40000000 {
211 compatible = "atmel,at91rm9200-nand"; 205 compatible = "atmel,at91rm9200-nand";
212 #address-cells = <1>; 206 #address-cells = <1>;
213 #size-cells = <1>; 207 #size-cells = <1>;
214 ranges; 208 ranges;
215 ... 209 ...
216 nfc@70000000 { 210 nfc@70000000 {
217 compatible = "atmel,sama5d3-nf 211 compatible = "atmel,sama5d3-nfc";
218 #address-cells = <1>; 212 #address-cells = <1>;
219 #size-cells = <1>; 213 #size-cells = <1>;
220 clocks = <&hsmc_clk> 214 clocks = <&hsmc_clk>
221 reg = < 215 reg = <
222 0x70000000 0x10000000 216 0x70000000 0x10000000 /* NFC Command Registers */
223 0xffffc000 0x00000070 217 0xffffc000 0x00000070 /* NFC HSMC regs */
224 0x00200000 0x00100000 218 0x00200000 0x00100000 /* NFC SRAM banks */
225 >; 219 >;
226 }; 220 };
227 }; 221 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.