2 * (C) Copyright 2006-2008
3 * Stefan Roese, DENX Software Engineering, sr@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
11 #include <linux/mtd/nand_ecc.h>
13 static int nand_ecc_pos
[] = CONFIG_SYS_NAND_ECCPOS
;
14 static nand_info_t mtd
;
15 static struct nand_chip nand_chip
;
17 #define ECCSTEPS (CONFIG_SYS_NAND_PAGE_SIZE / \
18 CONFIG_SYS_NAND_ECCSIZE)
19 #define ECCTOTAL (ECCSTEPS * CONFIG_SYS_NAND_ECCBYTES)
22 #if (CONFIG_SYS_NAND_PAGE_SIZE <= 512)
24 * NAND command for small page NAND devices (512)
26 static int nand_command(int block
, int page
, uint32_t offs
,
29 struct nand_chip
*this = mtd
.priv
;
30 int page_addr
= page
+ block
* CONFIG_SYS_NAND_PAGE_COUNT
;
32 while (!this->dev_ready(&mtd
))
35 /* Begin command latch cycle */
36 this->cmd_ctrl(&mtd
, cmd
, NAND_CTRL_CLE
| NAND_CTRL_CHANGE
);
37 /* Set ALE and clear CLE to start address cycle */
39 this->cmd_ctrl(&mtd
, offs
, NAND_CTRL_ALE
| NAND_CTRL_CHANGE
);
40 this->cmd_ctrl(&mtd
, page_addr
& 0xff, NAND_CTRL_ALE
); /* A[16:9] */
41 this->cmd_ctrl(&mtd
, (page_addr
>> 8) & 0xff,
42 NAND_CTRL_ALE
); /* A[24:17] */
43 #ifdef CONFIG_SYS_NAND_4_ADDR_CYCLE
44 /* One more address cycle for devices > 32MiB */
45 this->cmd_ctrl(&mtd
, (page_addr
>> 16) & 0x0f,
46 NAND_CTRL_ALE
); /* A[28:25] */
48 /* Latch in address */
49 this->cmd_ctrl(&mtd
, NAND_CMD_NONE
, NAND_NCE
| NAND_CTRL_CHANGE
);
52 * Wait a while for the data to be ready
54 while (!this->dev_ready(&mtd
))
61 * NAND command for large page NAND devices (2k)
63 static int nand_command(int block
, int page
, uint32_t offs
,
66 struct nand_chip
*this = mtd
.priv
;
67 int page_addr
= page
+ block
* CONFIG_SYS_NAND_PAGE_COUNT
;
68 void (*hwctrl
)(struct mtd_info
*mtd
, int cmd
,
69 unsigned int ctrl
) = this->cmd_ctrl
;
71 while (!this->dev_ready(&mtd
))
74 /* Emulate NAND_CMD_READOOB */
75 if (cmd
== NAND_CMD_READOOB
) {
76 offs
+= CONFIG_SYS_NAND_PAGE_SIZE
;
80 /* Shift the offset from byte addressing to word addressing. */
81 if (this->options
& NAND_BUSWIDTH_16
)
84 /* Begin command latch cycle */
85 hwctrl(&mtd
, cmd
, NAND_CTRL_CLE
| NAND_CTRL_CHANGE
);
86 /* Set ALE and clear CLE to start address cycle */
88 hwctrl(&mtd
, offs
& 0xff,
89 NAND_CTRL_ALE
| NAND_CTRL_CHANGE
); /* A[7:0] */
90 hwctrl(&mtd
, (offs
>> 8) & 0xff, NAND_CTRL_ALE
); /* A[11:9] */
92 hwctrl(&mtd
, (page_addr
& 0xff), NAND_CTRL_ALE
); /* A[19:12] */
93 hwctrl(&mtd
, ((page_addr
>> 8) & 0xff),
94 NAND_CTRL_ALE
); /* A[27:20] */
95 #ifdef CONFIG_SYS_NAND_5_ADDR_CYCLE
96 /* One more address cycle for devices > 128MiB */
97 hwctrl(&mtd
, (page_addr
>> 16) & 0x0f,
98 NAND_CTRL_ALE
); /* A[31:28] */
100 /* Latch in address */
101 hwctrl(&mtd
, NAND_CMD_READSTART
,
102 NAND_CTRL_CLE
| NAND_CTRL_CHANGE
);
103 hwctrl(&mtd
, NAND_CMD_NONE
, NAND_NCE
| NAND_CTRL_CHANGE
);
106 * Wait a while for the data to be ready
108 while (!this->dev_ready(&mtd
))
115 static int nand_is_bad_block(int block
)
117 struct nand_chip
*this = mtd
.priv
;
119 nand_command(block
, 0, CONFIG_SYS_NAND_BAD_BLOCK_POS
,
123 * Read one byte (or two if it's a 16 bit chip).
125 if (this->options
& NAND_BUSWIDTH_16
) {
126 if (readw(this->IO_ADDR_R
) != 0xffff)
129 if (readb(this->IO_ADDR_R
) != 0xff)
136 #if defined(CONFIG_SYS_NAND_HW_ECC_OOBFIRST)
137 static int nand_read_page(int block
, int page
, uchar
*dst
)
139 struct nand_chip
*this = mtd
.priv
;
140 u_char ecc_calc
[ECCTOTAL
];
141 u_char ecc_code
[ECCTOTAL
];
142 u_char oob_data
[CONFIG_SYS_NAND_OOBSIZE
];
144 int eccsize
= CONFIG_SYS_NAND_ECCSIZE
;
145 int eccbytes
= CONFIG_SYS_NAND_ECCBYTES
;
146 int eccsteps
= ECCSTEPS
;
149 nand_command(block
, page
, 0, NAND_CMD_READOOB
);
150 this->read_buf(&mtd
, oob_data
, CONFIG_SYS_NAND_OOBSIZE
);
151 nand_command(block
, page
, 0, NAND_CMD_READ0
);
153 /* Pick the ECC bytes out of the oob data */
154 for (i
= 0; i
< ECCTOTAL
; i
++)
155 ecc_code
[i
] = oob_data
[nand_ecc_pos
[i
]];
158 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
159 this->ecc
.hwctl(&mtd
, NAND_ECC_READ
);
160 this->read_buf(&mtd
, p
, eccsize
);
161 this->ecc
.calculate(&mtd
, p
, &ecc_calc
[i
]);
162 this->ecc
.correct(&mtd
, p
, &ecc_code
[i
], &ecc_calc
[i
]);
168 static int nand_read_page(int block
, int page
, void *dst
)
170 struct nand_chip
*this = mtd
.priv
;
171 u_char ecc_calc
[ECCTOTAL
];
172 u_char ecc_code
[ECCTOTAL
];
173 u_char oob_data
[CONFIG_SYS_NAND_OOBSIZE
];
175 int eccsize
= CONFIG_SYS_NAND_ECCSIZE
;
176 int eccbytes
= CONFIG_SYS_NAND_ECCBYTES
;
177 int eccsteps
= ECCSTEPS
;
180 nand_command(block
, page
, 0, NAND_CMD_READ0
);
182 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
183 if (this->ecc
.mode
!= NAND_ECC_SOFT
)
184 this->ecc
.hwctl(&mtd
, NAND_ECC_READ
);
185 this->read_buf(&mtd
, p
, eccsize
);
186 this->ecc
.calculate(&mtd
, p
, &ecc_calc
[i
]);
188 this->read_buf(&mtd
, oob_data
, CONFIG_SYS_NAND_OOBSIZE
);
190 /* Pick the ECC bytes out of the oob data */
191 for (i
= 0; i
< ECCTOTAL
; i
++)
192 ecc_code
[i
] = oob_data
[nand_ecc_pos
[i
]];
197 for (i
= 0 ; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
198 /* No chance to do something with the possible error message
199 * from correct_data(). We just hope that all possible errors
200 * are corrected by this routine.
202 this->ecc
.correct(&mtd
, p
, &ecc_code
[i
], &ecc_calc
[i
]);
209 int nand_spl_load_image(uint32_t offs
, unsigned int size
, void *dst
)
211 unsigned int block
, lastblock
;
215 * offs has to be aligned to a page address!
217 block
= offs
/ CONFIG_SYS_NAND_BLOCK_SIZE
;
218 lastblock
= (offs
+ size
- 1) / CONFIG_SYS_NAND_BLOCK_SIZE
;
219 page
= (offs
% CONFIG_SYS_NAND_BLOCK_SIZE
) / CONFIG_SYS_NAND_PAGE_SIZE
;
221 while (block
<= lastblock
) {
222 if (!nand_is_bad_block(block
)) {
226 while (page
< CONFIG_SYS_NAND_PAGE_COUNT
) {
227 nand_read_page(block
, page
, dst
);
228 dst
+= CONFIG_SYS_NAND_PAGE_SIZE
;
243 /* nand_init() - initialize data to make nand usable by SPL */
247 * Init board specific nand support
249 mtd
.priv
= &nand_chip
;
250 nand_chip
.IO_ADDR_R
= nand_chip
.IO_ADDR_W
=
251 (void __iomem
*)CONFIG_SYS_NAND_BASE
;
252 board_nand_init(&nand_chip
);
254 #ifdef CONFIG_SPL_NAND_SOFTECC
255 if (nand_chip
.ecc
.mode
== NAND_ECC_SOFT
) {
256 nand_chip
.ecc
.calculate
= nand_calculate_ecc
;
257 nand_chip
.ecc
.correct
= nand_correct_data
;
261 if (nand_chip
.select_chip
)
262 nand_chip
.select_chip(&mtd
, 0);
265 /* Unselect after operation */
266 void nand_deselect(void)
268 if (nand_chip
.select_chip
)
269 nand_chip
.select_chip(&mtd
, -1);