blob: e8dc6468f8bc7410a00db14a3dbe507f5a1f1879 [file] [log] [blame]
Sascha Hauer34f6e152008-09-02 17:16:59 +02001/*
2 * Copyright 2004-2007 Freescale Semiconductor, Inc. All Rights Reserved.
3 * Copyright 2008 Sascha Hauer, kernel@pengutronix.de
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17 * MA 02110-1301, USA.
18 */
19
20#include <linux/delay.h>
21#include <linux/slab.h>
22#include <linux/init.h>
23#include <linux/module.h>
24#include <linux/mtd/mtd.h>
25#include <linux/mtd/nand.h>
26#include <linux/mtd/partitions.h>
27#include <linux/interrupt.h>
28#include <linux/device.h>
29#include <linux/platform_device.h>
30#include <linux/clk.h>
31#include <linux/err.h>
32#include <linux/io.h>
33
34#include <asm/mach/flash.h>
35#include <mach/mxc_nand.h>
Sascha Hauer94671142009-10-05 12:14:21 +020036#include <mach/hardware.h>
Sascha Hauer34f6e152008-09-02 17:16:59 +020037
38#define DRIVER_NAME "mxc_nand"
39
Sascha Hauer94671142009-10-05 12:14:21 +020040#define nfc_is_v21() (cpu_is_mx25() || cpu_is_mx35())
Ivo Claryssea47bfd22010-04-08 16:16:51 +020041#define nfc_is_v1() (cpu_is_mx31() || cpu_is_mx27() || cpu_is_mx21())
Sascha Hauer94671142009-10-05 12:14:21 +020042
Sascha Hauer34f6e152008-09-02 17:16:59 +020043/* Addresses for NFC registers */
44#define NFC_BUF_SIZE 0xE00
45#define NFC_BUF_ADDR 0xE04
46#define NFC_FLASH_ADDR 0xE06
47#define NFC_FLASH_CMD 0xE08
48#define NFC_CONFIG 0xE0A
49#define NFC_ECC_STATUS_RESULT 0xE0C
50#define NFC_RSLTMAIN_AREA 0xE0E
51#define NFC_RSLTSPARE_AREA 0xE10
52#define NFC_WRPROT 0xE12
Sascha Hauer94671142009-10-05 12:14:21 +020053#define NFC_V1_UNLOCKSTART_BLKADDR 0xe14
54#define NFC_V1_UNLOCKEND_BLKADDR 0xe16
55#define NFC_V21_UNLOCKSTART_BLKADDR 0xe20
56#define NFC_V21_UNLOCKEND_BLKADDR 0xe22
Sascha Hauer34f6e152008-09-02 17:16:59 +020057#define NFC_NF_WRPRST 0xE18
58#define NFC_CONFIG1 0xE1A
59#define NFC_CONFIG2 0xE1C
60
Sascha Hauer34f6e152008-09-02 17:16:59 +020061/* Set INT to 0, FCMD to 1, rest to 0 in NFC_CONFIG2 Register
62 * for Command operation */
63#define NFC_CMD 0x1
64
65/* Set INT to 0, FADD to 1, rest to 0 in NFC_CONFIG2 Register
66 * for Address operation */
67#define NFC_ADDR 0x2
68
69/* Set INT to 0, FDI to 1, rest to 0 in NFC_CONFIG2 Register
70 * for Input operation */
71#define NFC_INPUT 0x4
72
73/* Set INT to 0, FDO to 001, rest to 0 in NFC_CONFIG2 Register
74 * for Data Output operation */
75#define NFC_OUTPUT 0x8
76
77/* Set INT to 0, FD0 to 010, rest to 0 in NFC_CONFIG2 Register
78 * for Read ID operation */
79#define NFC_ID 0x10
80
81/* Set INT to 0, FDO to 100, rest to 0 in NFC_CONFIG2 Register
82 * for Read Status operation */
83#define NFC_STATUS 0x20
84
85/* Set INT to 1, rest to 0 in NFC_CONFIG2 Register for Read
86 * Status operation */
87#define NFC_INT 0x8000
88
89#define NFC_SP_EN (1 << 2)
90#define NFC_ECC_EN (1 << 3)
91#define NFC_INT_MSK (1 << 4)
92#define NFC_BIG (1 << 5)
93#define NFC_RST (1 << 6)
94#define NFC_CE (1 << 7)
95#define NFC_ONE_CYCLE (1 << 8)
96
97struct mxc_nand_host {
98 struct mtd_info mtd;
99 struct nand_chip nand;
100 struct mtd_partition *parts;
101 struct device *dev;
102
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200103 void *spare0;
104 void *main_area0;
105 void *main_area1;
106
107 void __iomem *base;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200108 void __iomem *regs;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200109 int status_request;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200110 struct clk *clk;
111 int clk_act;
112 int irq;
113
114 wait_queue_head_t irq_waitq;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200115
116 uint8_t *data_buf;
117 unsigned int buf_start;
118 int spare_len;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200119};
120
Sascha Hauer34f6e152008-09-02 17:16:59 +0200121/* OOB placement block for use with hardware ecc generation */
Sascha Hauer94671142009-10-05 12:14:21 +0200122static struct nand_ecclayout nandv1_hw_eccoob_smallpage = {
Sascha Hauer34f6e152008-09-02 17:16:59 +0200123 .eccbytes = 5,
124 .eccpos = {6, 7, 8, 9, 10},
Sascha Hauer8c1fd892009-10-21 10:22:01 +0200125 .oobfree = {{0, 5}, {12, 4}, }
Sascha Hauer34f6e152008-09-02 17:16:59 +0200126};
127
Sascha Hauer94671142009-10-05 12:14:21 +0200128static struct nand_ecclayout nandv1_hw_eccoob_largepage = {
Vladimir Barinovbd3fd622009-05-25 13:06:17 +0400129 .eccbytes = 20,
130 .eccpos = {6, 7, 8, 9, 10, 22, 23, 24, 25, 26,
131 38, 39, 40, 41, 42, 54, 55, 56, 57, 58},
132 .oobfree = {{2, 4}, {11, 10}, {27, 10}, {43, 10}, {59, 5}, }
Sascha Hauer34f6e152008-09-02 17:16:59 +0200133};
134
Sascha Hauer94671142009-10-05 12:14:21 +0200135/* OOB description for 512 byte pages with 16 byte OOB */
136static struct nand_ecclayout nandv2_hw_eccoob_smallpage = {
137 .eccbytes = 1 * 9,
138 .eccpos = {
139 7, 8, 9, 10, 11, 12, 13, 14, 15
140 },
141 .oobfree = {
142 {.offset = 0, .length = 5}
143 }
144};
145
146/* OOB description for 2048 byte pages with 64 byte OOB */
147static struct nand_ecclayout nandv2_hw_eccoob_largepage = {
148 .eccbytes = 4 * 9,
149 .eccpos = {
150 7, 8, 9, 10, 11, 12, 13, 14, 15,
151 23, 24, 25, 26, 27, 28, 29, 30, 31,
152 39, 40, 41, 42, 43, 44, 45, 46, 47,
153 55, 56, 57, 58, 59, 60, 61, 62, 63
154 },
155 .oobfree = {
156 {.offset = 2, .length = 4},
157 {.offset = 16, .length = 7},
158 {.offset = 32, .length = 7},
159 {.offset = 48, .length = 7}
160 }
161};
162
Sascha Hauer34f6e152008-09-02 17:16:59 +0200163#ifdef CONFIG_MTD_PARTITIONS
164static const char *part_probes[] = { "RedBoot", "cmdlinepart", NULL };
165#endif
166
167static irqreturn_t mxc_nfc_irq(int irq, void *dev_id)
168{
169 struct mxc_nand_host *host = dev_id;
170
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200171 disable_irq_nosync(irq);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200172
173 wake_up(&host->irq_waitq);
174
175 return IRQ_HANDLED;
176}
177
178/* This function polls the NANDFC to wait for the basic operation to
179 * complete by checking the INT bit of config2 register.
180 */
Sascha Hauerc110eaf2009-10-21 16:01:02 +0200181static void wait_op_done(struct mxc_nand_host *host, int useirq)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200182{
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200183 uint16_t tmp;
184 int max_retries = 8000;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200185
186 if (useirq) {
187 if ((readw(host->regs + NFC_CONFIG2) & NFC_INT) == 0) {
188
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200189 enable_irq(host->irq);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200190
191 wait_event(host->irq_waitq,
192 readw(host->regs + NFC_CONFIG2) & NFC_INT);
193
194 tmp = readw(host->regs + NFC_CONFIG2);
195 tmp &= ~NFC_INT;
196 writew(tmp, host->regs + NFC_CONFIG2);
197 }
198 } else {
199 while (max_retries-- > 0) {
200 if (readw(host->regs + NFC_CONFIG2) & NFC_INT) {
201 tmp = readw(host->regs + NFC_CONFIG2);
202 tmp &= ~NFC_INT;
203 writew(tmp, host->regs + NFC_CONFIG2);
204 break;
205 }
206 udelay(1);
207 }
Roel Kluin43950a62009-06-04 16:24:59 +0200208 if (max_retries < 0)
Sascha Hauer62465492009-06-04 15:57:20 +0200209 DEBUG(MTD_DEBUG_LEVEL0, "%s: INT not set\n",
210 __func__);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200211 }
212}
213
214/* This function issues the specified command to the NAND device and
215 * waits for completion. */
216static void send_cmd(struct mxc_nand_host *host, uint16_t cmd, int useirq)
217{
218 DEBUG(MTD_DEBUG_LEVEL3, "send_cmd(host, 0x%x, %d)\n", cmd, useirq);
219
220 writew(cmd, host->regs + NFC_FLASH_CMD);
221 writew(NFC_CMD, host->regs + NFC_CONFIG2);
222
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200223 if (cpu_is_mx21() && (cmd == NAND_CMD_RESET)) {
224 int max_retries = 100;
225 /* Reset completion is indicated by NFC_CONFIG2 */
226 /* being set to 0 */
227 while (max_retries-- > 0) {
228 if (readw(host->regs + NFC_CONFIG2) == 0) {
229 break;
230 }
231 udelay(1);
232 }
233 if (max_retries < 0)
234 DEBUG(MTD_DEBUG_LEVEL0, "%s: RESET failed\n",
235 __func__);
236 } else {
237 /* Wait for operation to complete */
238 wait_op_done(host, useirq);
239 }
Sascha Hauer34f6e152008-09-02 17:16:59 +0200240}
241
242/* This function sends an address (or partial address) to the
243 * NAND device. The address is used to select the source/destination for
244 * a NAND command. */
245static void send_addr(struct mxc_nand_host *host, uint16_t addr, int islast)
246{
247 DEBUG(MTD_DEBUG_LEVEL3, "send_addr(host, 0x%x %d)\n", addr, islast);
248
249 writew(addr, host->regs + NFC_FLASH_ADDR);
250 writew(NFC_ADDR, host->regs + NFC_CONFIG2);
251
252 /* Wait for operation to complete */
Sascha Hauerc110eaf2009-10-21 16:01:02 +0200253 wait_op_done(host, islast);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200254}
255
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200256static void send_page(struct mtd_info *mtd, unsigned int ops)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200257{
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200258 struct nand_chip *nand_chip = mtd->priv;
259 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauerc5d23f12009-06-04 17:25:53 +0200260 int bufs, i;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200261
Sascha Hauer94671142009-10-05 12:14:21 +0200262 if (nfc_is_v1() && mtd->writesize > 512)
Sascha Hauerc5d23f12009-06-04 17:25:53 +0200263 bufs = 4;
264 else
265 bufs = 1;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200266
Sascha Hauerc5d23f12009-06-04 17:25:53 +0200267 for (i = 0; i < bufs; i++) {
268
269 /* NANDFC buffer 0 is used for page read/write */
270 writew(i, host->regs + NFC_BUF_ADDR);
271
272 writew(ops, host->regs + NFC_CONFIG2);
273
274 /* Wait for operation to complete */
Sascha Hauerc110eaf2009-10-21 16:01:02 +0200275 wait_op_done(host, true);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200276 }
Sascha Hauer34f6e152008-09-02 17:16:59 +0200277}
278
279/* Request the NANDFC to perform a read of the NAND device ID. */
280static void send_read_id(struct mxc_nand_host *host)
281{
282 struct nand_chip *this = &host->nand;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200283
284 /* NANDFC buffer 0 is used for device ID output */
285 writew(0x0, host->regs + NFC_BUF_ADDR);
286
Sascha Hauer34f6e152008-09-02 17:16:59 +0200287 writew(NFC_ID, host->regs + NFC_CONFIG2);
288
289 /* Wait for operation to complete */
Sascha Hauerc110eaf2009-10-21 16:01:02 +0200290 wait_op_done(host, true);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200291
292 if (this->options & NAND_BUSWIDTH_16) {
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200293 void __iomem *main_buf = host->main_area0;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200294 /* compress the ID info */
295 writeb(readb(main_buf + 2), main_buf + 1);
296 writeb(readb(main_buf + 4), main_buf + 2);
297 writeb(readb(main_buf + 6), main_buf + 3);
298 writeb(readb(main_buf + 8), main_buf + 4);
299 writeb(readb(main_buf + 10), main_buf + 5);
300 }
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200301 memcpy(host->data_buf, host->main_area0, 16);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200302}
303
304/* This function requests the NANDFC to perform a read of the
305 * NAND device status and returns the current status. */
306static uint16_t get_dev_status(struct mxc_nand_host *host)
307{
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200308 void __iomem *main_buf = host->main_area1;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200309 uint32_t store;
Sascha Hauerf06368f2009-10-05 17:18:42 +0200310 uint16_t ret;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200311 /* Issue status request to NAND device */
312
313 /* store the main area1 first word, later do recovery */
314 store = readl(main_buf);
315 /* NANDFC buffer 1 is used for device status to prevent
316 * corruption of read/write buffer on status requests. */
317 writew(1, host->regs + NFC_BUF_ADDR);
318
Sascha Hauer34f6e152008-09-02 17:16:59 +0200319 writew(NFC_STATUS, host->regs + NFC_CONFIG2);
320
321 /* Wait for operation to complete */
Sascha Hauerc110eaf2009-10-21 16:01:02 +0200322 wait_op_done(host, true);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200323
324 /* Status is placed in first word of main buffer */
325 /* get status, then recovery area 1 data */
326 ret = readw(main_buf);
327 writel(store, main_buf);
328
329 return ret;
330}
331
332/* This functions is used by upper layer to checks if device is ready */
333static int mxc_nand_dev_ready(struct mtd_info *mtd)
334{
335 /*
336 * NFC handles R/B internally. Therefore, this function
337 * always returns status as ready.
338 */
339 return 1;
340}
341
342static void mxc_nand_enable_hwecc(struct mtd_info *mtd, int mode)
343{
344 /*
345 * If HW ECC is enabled, we turn it on during init. There is
346 * no need to enable again here.
347 */
348}
349
350static int mxc_nand_correct_data(struct mtd_info *mtd, u_char *dat,
351 u_char *read_ecc, u_char *calc_ecc)
352{
353 struct nand_chip *nand_chip = mtd->priv;
354 struct mxc_nand_host *host = nand_chip->priv;
355
356 /*
357 * 1-Bit errors are automatically corrected in HW. No need for
358 * additional correction. 2-Bit errors cannot be corrected by
359 * HW ECC, so we need to return failure
360 */
361 uint16_t ecc_status = readw(host->regs + NFC_ECC_STATUS_RESULT);
362
363 if (((ecc_status & 0x3) == 2) || ((ecc_status >> 2) == 2)) {
364 DEBUG(MTD_DEBUG_LEVEL0,
365 "MXC_NAND: HWECC uncorrectable 2-bit ECC error\n");
366 return -1;
367 }
368
369 return 0;
370}
371
372static int mxc_nand_calculate_ecc(struct mtd_info *mtd, const u_char *dat,
373 u_char *ecc_code)
374{
375 return 0;
376}
377
378static u_char mxc_nand_read_byte(struct mtd_info *mtd)
379{
380 struct nand_chip *nand_chip = mtd->priv;
381 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200382 uint8_t ret;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200383
384 /* Check for status request */
385 if (host->status_request)
386 return get_dev_status(host) & 0xFF;
387
Sascha Hauerf8f96082009-06-04 17:12:26 +0200388 ret = *(uint8_t *)(host->data_buf + host->buf_start);
389 host->buf_start++;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200390
391 return ret;
392}
393
394static uint16_t mxc_nand_read_word(struct mtd_info *mtd)
395{
396 struct nand_chip *nand_chip = mtd->priv;
397 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200398 uint16_t ret;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200399
Sascha Hauerf8f96082009-06-04 17:12:26 +0200400 ret = *(uint16_t *)(host->data_buf + host->buf_start);
401 host->buf_start += 2;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200402
403 return ret;
404}
405
406/* Write data of length len to buffer buf. The data to be
407 * written on NAND Flash is first copied to RAMbuffer. After the Data Input
408 * Operation by the NFC, the data is written to NAND Flash */
409static void mxc_nand_write_buf(struct mtd_info *mtd,
410 const u_char *buf, int len)
411{
412 struct nand_chip *nand_chip = mtd->priv;
413 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200414 u16 col = host->buf_start;
415 int n = mtd->oobsize + mtd->writesize - col;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200416
Sascha Hauerf8f96082009-06-04 17:12:26 +0200417 n = min(n, len);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200418
Sascha Hauerf8f96082009-06-04 17:12:26 +0200419 memcpy(host->data_buf + col, buf, n);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200420
Sascha Hauerf8f96082009-06-04 17:12:26 +0200421 host->buf_start += n;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200422}
423
424/* Read the data buffer from the NAND Flash. To read the data from NAND
425 * Flash first the data output cycle is initiated by the NFC, which copies
426 * the data to RAMbuffer. This data of length len is then copied to buffer buf.
427 */
428static void mxc_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
429{
430 struct nand_chip *nand_chip = mtd->priv;
431 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200432 u16 col = host->buf_start;
433 int n = mtd->oobsize + mtd->writesize - col;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200434
Sascha Hauerf8f96082009-06-04 17:12:26 +0200435 n = min(n, len);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200436
Sascha Hauerf8f96082009-06-04 17:12:26 +0200437 memcpy(buf, host->data_buf + col, len);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200438
Sascha Hauerf8f96082009-06-04 17:12:26 +0200439 host->buf_start += len;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200440}
441
442/* Used by the upper layer to verify the data in NAND Flash
443 * with the data in the buf. */
444static int mxc_nand_verify_buf(struct mtd_info *mtd,
445 const u_char *buf, int len)
446{
447 return -EFAULT;
448}
449
450/* This function is used by upper layer for select and
451 * deselect of the NAND chip */
452static void mxc_nand_select_chip(struct mtd_info *mtd, int chip)
453{
454 struct nand_chip *nand_chip = mtd->priv;
455 struct mxc_nand_host *host = nand_chip->priv;
456
Sascha Hauer34f6e152008-09-02 17:16:59 +0200457 switch (chip) {
458 case -1:
459 /* Disable the NFC clock */
460 if (host->clk_act) {
461 clk_disable(host->clk);
462 host->clk_act = 0;
463 }
464 break;
465 case 0:
466 /* Enable the NFC clock */
467 if (!host->clk_act) {
468 clk_enable(host->clk);
469 host->clk_act = 1;
470 }
471 break;
472
473 default:
474 break;
475 }
476}
477
Sascha Hauerf8f96082009-06-04 17:12:26 +0200478/*
479 * Function to transfer data to/from spare area.
480 */
481static void copy_spare(struct mtd_info *mtd, bool bfrom)
482{
483 struct nand_chip *this = mtd->priv;
484 struct mxc_nand_host *host = this->priv;
485 u16 i, j;
486 u16 n = mtd->writesize >> 9;
487 u8 *d = host->data_buf + mtd->writesize;
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200488 u8 *s = host->spare0;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200489 u16 t = host->spare_len;
490
491 j = (mtd->oobsize / n >> 1) << 1;
492
493 if (bfrom) {
494 for (i = 0; i < n - 1; i++)
495 memcpy(d + i * j, s + i * t, j);
496
497 /* the last section */
498 memcpy(d + i * j, s + i * t, mtd->oobsize - i * j);
499 } else {
500 for (i = 0; i < n - 1; i++)
501 memcpy(&s[i * t], &d[i * j], j);
502
503 /* the last section */
504 memcpy(&s[i * t], &d[i * j], mtd->oobsize - i * j);
505 }
506}
507
Sascha Hauera3e65b62009-06-02 11:47:59 +0200508static void mxc_do_addr_cycle(struct mtd_info *mtd, int column, int page_addr)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200509{
510 struct nand_chip *nand_chip = mtd->priv;
511 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200512
513 /* Write out column address, if necessary */
514 if (column != -1) {
515 /*
516 * MXC NANDFC can only perform full page+spare or
517 * spare-only read/write. When the upper layers
518 * layers perform a read/write buf operation,
Daniel Mack3ad2f3f2010-02-03 08:01:28 +0800519 * we will used the saved column address to index into
Sascha Hauer34f6e152008-09-02 17:16:59 +0200520 * the full page.
521 */
522 send_addr(host, 0, page_addr == -1);
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200523 if (mtd->writesize > 512)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200524 /* another col addr cycle for 2k page */
525 send_addr(host, 0, false);
526 }
527
528 /* Write out page address, if necessary */
529 if (page_addr != -1) {
530 /* paddr_0 - p_addr_7 */
531 send_addr(host, (page_addr & 0xff), false);
532
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200533 if (mtd->writesize > 512) {
Vladimir Barinovbd3fd622009-05-25 13:06:17 +0400534 if (mtd->size >= 0x10000000) {
535 /* paddr_8 - paddr_15 */
536 send_addr(host, (page_addr >> 8) & 0xff, false);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200537 send_addr(host, (page_addr >> 16) & 0xff, true);
Vladimir Barinovbd3fd622009-05-25 13:06:17 +0400538 } else
539 /* paddr_8 - paddr_15 */
540 send_addr(host, (page_addr >> 8) & 0xff, true);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200541 } else {
542 /* One more address cycle for higher density devices */
543 if (mtd->size >= 0x4000000) {
544 /* paddr_8 - paddr_15 */
545 send_addr(host, (page_addr >> 8) & 0xff, false);
546 send_addr(host, (page_addr >> 16) & 0xff, true);
547 } else
548 /* paddr_8 - paddr_15 */
549 send_addr(host, (page_addr >> 8) & 0xff, true);
550 }
551 }
Sascha Hauera3e65b62009-06-02 11:47:59 +0200552}
Sascha Hauer34f6e152008-09-02 17:16:59 +0200553
Ivo Claryssed4840182010-04-08 16:14:44 +0200554static void preset(struct mtd_info *mtd)
555{
556 struct nand_chip *nand_chip = mtd->priv;
557 struct mxc_nand_host *host = nand_chip->priv;
558 uint16_t tmp;
559
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200560 /* enable interrupt, disable spare enable */
Ivo Claryssed4840182010-04-08 16:14:44 +0200561 tmp = readw(host->regs + NFC_CONFIG1);
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200562 tmp &= ~NFC_INT_MSK;
Ivo Claryssed4840182010-04-08 16:14:44 +0200563 tmp &= ~NFC_SP_EN;
564 if (nand_chip->ecc.mode == NAND_ECC_HW) {
565 tmp |= NFC_ECC_EN;
566 } else {
567 tmp &= ~NFC_ECC_EN;
568 }
569 writew(tmp, host->regs + NFC_CONFIG1);
570 /* preset operation */
571
572 /* Unlock the internal RAM Buffer */
573 writew(0x2, host->regs + NFC_CONFIG);
574
575 /* Blocks to be unlocked */
576 if (nfc_is_v21()) {
577 writew(0x0, host->regs + NFC_V21_UNLOCKSTART_BLKADDR);
578 writew(0xffff, host->regs + NFC_V21_UNLOCKEND_BLKADDR);
579 } else if (nfc_is_v1()) {
580 writew(0x0, host->regs + NFC_V1_UNLOCKSTART_BLKADDR);
581 writew(0x4000, host->regs + NFC_V1_UNLOCKEND_BLKADDR);
582 } else
583 BUG();
584
585 /* Unlock Block Command for given address range */
586 writew(0x4, host->regs + NFC_WRPROT);
587}
588
Sascha Hauer34f6e152008-09-02 17:16:59 +0200589/* Used by the upper layer to write command to NAND Flash for
590 * different operations to be carried out on NAND Flash */
591static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
592 int column, int page_addr)
593{
594 struct nand_chip *nand_chip = mtd->priv;
595 struct mxc_nand_host *host = nand_chip->priv;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200596
597 DEBUG(MTD_DEBUG_LEVEL3,
598 "mxc_nand_command (cmd = 0x%x, col = 0x%x, page = 0x%x)\n",
599 command, column, page_addr);
600
601 /* Reset command state information */
602 host->status_request = false;
603
604 /* Command pre-processing step */
Sascha Hauer34f6e152008-09-02 17:16:59 +0200605 switch (command) {
Ivo Claryssed4840182010-04-08 16:14:44 +0200606 case NAND_CMD_RESET:
Ivo Claryssed4840182010-04-08 16:14:44 +0200607 preset(mtd);
Eric Bénard6a8cfcf2010-06-10 16:03:04 +0200608 send_cmd(host, command, false);
Ivo Claryssed4840182010-04-08 16:14:44 +0200609 break;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200610
Sascha Hauer34f6e152008-09-02 17:16:59 +0200611 case NAND_CMD_STATUS:
Sascha Hauerf8f96082009-06-04 17:12:26 +0200612 host->buf_start = 0;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200613 host->status_request = true;
Sascha Hauer89121a62009-06-04 17:18:01 +0200614
615 send_cmd(host, command, true);
616 mxc_do_addr_cycle(mtd, column, page_addr);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200617 break;
618
Sascha Hauer34f6e152008-09-02 17:16:59 +0200619 case NAND_CMD_READ0:
Sascha Hauer34f6e152008-09-02 17:16:59 +0200620 case NAND_CMD_READOOB:
Sascha Hauer89121a62009-06-04 17:18:01 +0200621 if (command == NAND_CMD_READ0)
622 host->buf_start = column;
623 else
624 host->buf_start = column + mtd->writesize;
Sascha Hauerf8f96082009-06-04 17:12:26 +0200625
Sascha Hauer6c499392010-05-28 10:02:17 +0200626 command = NAND_CMD_READ0; /* only READ0 is valid */
Sascha Hauer89121a62009-06-04 17:18:01 +0200627
628 send_cmd(host, command, false);
629 mxc_do_addr_cycle(mtd, column, page_addr);
630
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200631 if (mtd->writesize > 512)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200632 send_cmd(host, NAND_CMD_READSTART, true);
Sascha Hauerc5d23f12009-06-04 17:25:53 +0200633
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200634 send_page(mtd, NFC_OUTPUT);
Sascha Hauer89121a62009-06-04 17:18:01 +0200635
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200636 memcpy(host->data_buf, host->main_area0, mtd->writesize);
Sascha Hauer89121a62009-06-04 17:18:01 +0200637 copy_spare(mtd, true);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200638 break;
639
Sascha Hauer34f6e152008-09-02 17:16:59 +0200640 case NAND_CMD_SEQIN:
Sascha Hauer6c499392010-05-28 10:02:17 +0200641 if (column >= mtd->writesize)
642 /* call ourself to read a page */
643 mxc_nand_command(mtd, NAND_CMD_READ0, 0, page_addr);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200644
Sascha Hauer6c499392010-05-28 10:02:17 +0200645 host->buf_start = column;
Sascha Hauer89121a62009-06-04 17:18:01 +0200646
647 send_cmd(host, command, false);
648 mxc_do_addr_cycle(mtd, column, page_addr);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200649 break;
650
651 case NAND_CMD_PAGEPROG:
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200652 memcpy(host->main_area0, host->data_buf, mtd->writesize);
Sascha Hauerf8f96082009-06-04 17:12:26 +0200653 copy_spare(mtd, false);
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200654 send_page(mtd, NFC_INPUT);
Sascha Hauer89121a62009-06-04 17:18:01 +0200655 send_cmd(host, command, true);
656 mxc_do_addr_cycle(mtd, column, page_addr);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200657 break;
658
Sascha Hauer34f6e152008-09-02 17:16:59 +0200659 case NAND_CMD_READID:
Sascha Hauer89121a62009-06-04 17:18:01 +0200660 send_cmd(host, command, true);
661 mxc_do_addr_cycle(mtd, column, page_addr);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200662 send_read_id(host);
Sascha Hauer94671142009-10-05 12:14:21 +0200663 host->buf_start = column;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200664 break;
665
Sascha Hauer89121a62009-06-04 17:18:01 +0200666 case NAND_CMD_ERASE1:
Sascha Hauer34f6e152008-09-02 17:16:59 +0200667 case NAND_CMD_ERASE2:
Sascha Hauer89121a62009-06-04 17:18:01 +0200668 send_cmd(host, command, false);
669 mxc_do_addr_cycle(mtd, column, page_addr);
670
Sascha Hauer34f6e152008-09-02 17:16:59 +0200671 break;
672 }
673}
674
Sascha Hauerf1372052009-10-21 14:25:27 +0200675/*
676 * The generic flash bbt decriptors overlap with our ecc
677 * hardware, so define some i.MX specific ones.
678 */
679static uint8_t bbt_pattern[] = { 'B', 'b', 't', '0' };
680static uint8_t mirror_pattern[] = { '1', 't', 'b', 'B' };
681
682static struct nand_bbt_descr bbt_main_descr = {
683 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
684 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
685 .offs = 0,
686 .len = 4,
687 .veroffs = 4,
688 .maxblocks = 4,
689 .pattern = bbt_pattern,
690};
691
692static struct nand_bbt_descr bbt_mirror_descr = {
693 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
694 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
695 .offs = 0,
696 .len = 4,
697 .veroffs = 4,
698 .maxblocks = 4,
699 .pattern = mirror_pattern,
700};
701
Sascha Hauer34f6e152008-09-02 17:16:59 +0200702static int __init mxcnd_probe(struct platform_device *pdev)
703{
704 struct nand_chip *this;
705 struct mtd_info *mtd;
706 struct mxc_nand_platform_data *pdata = pdev->dev.platform_data;
707 struct mxc_nand_host *host;
708 struct resource *res;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200709 int err = 0, nr_parts = 0;
Sascha Hauer94671142009-10-05 12:14:21 +0200710 struct nand_ecclayout *oob_smallpage, *oob_largepage;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200711
712 /* Allocate memory for MTD device structure and private data */
Sascha Hauerf8f96082009-06-04 17:12:26 +0200713 host = kzalloc(sizeof(struct mxc_nand_host) + NAND_MAX_PAGESIZE +
714 NAND_MAX_OOBSIZE, GFP_KERNEL);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200715 if (!host)
716 return -ENOMEM;
717
Sascha Hauerf8f96082009-06-04 17:12:26 +0200718 host->data_buf = (uint8_t *)(host + 1);
Sascha Hauerf8f96082009-06-04 17:12:26 +0200719
Sascha Hauer34f6e152008-09-02 17:16:59 +0200720 host->dev = &pdev->dev;
721 /* structures must be linked */
722 this = &host->nand;
723 mtd = &host->mtd;
724 mtd->priv = this;
725 mtd->owner = THIS_MODULE;
David Brownell87f39f02009-03-26 00:42:50 -0700726 mtd->dev.parent = &pdev->dev;
Sascha Hauer1fbff0a2009-10-21 16:06:27 +0200727 mtd->name = DRIVER_NAME;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200728
729 /* 50 us command delay time */
730 this->chip_delay = 5;
731
732 this->priv = host;
733 this->dev_ready = mxc_nand_dev_ready;
734 this->cmdfunc = mxc_nand_command;
735 this->select_chip = mxc_nand_select_chip;
736 this->read_byte = mxc_nand_read_byte;
737 this->read_word = mxc_nand_read_word;
738 this->write_buf = mxc_nand_write_buf;
739 this->read_buf = mxc_nand_read_buf;
740 this->verify_buf = mxc_nand_verify_buf;
741
Sascha Hauere65fb002009-02-16 14:29:10 +0100742 host->clk = clk_get(&pdev->dev, "nfc");
Vladimir Barinov8541c112009-04-23 15:47:22 +0400743 if (IS_ERR(host->clk)) {
744 err = PTR_ERR(host->clk);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200745 goto eclk;
Vladimir Barinov8541c112009-04-23 15:47:22 +0400746 }
Sascha Hauer34f6e152008-09-02 17:16:59 +0200747
748 clk_enable(host->clk);
749 host->clk_act = 1;
750
751 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
752 if (!res) {
753 err = -ENODEV;
754 goto eres;
755 }
756
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200757 host->base = ioremap(res->start, resource_size(res));
758 if (!host->base) {
Vladimir Barinov8541c112009-04-23 15:47:22 +0400759 err = -ENOMEM;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200760 goto eres;
761 }
762
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200763 host->main_area0 = host->base;
764 host->main_area1 = host->base + 0x200;
Sascha Hauer94671142009-10-05 12:14:21 +0200765
766 if (nfc_is_v21()) {
767 host->regs = host->base + 0x1000;
768 host->spare0 = host->base + 0x1000;
769 host->spare_len = 64;
770 oob_smallpage = &nandv2_hw_eccoob_smallpage;
771 oob_largepage = &nandv2_hw_eccoob_largepage;
Ivo Claryssed4840182010-04-08 16:14:44 +0200772 this->ecc.bytes = 9;
Sascha Hauer94671142009-10-05 12:14:21 +0200773 } else if (nfc_is_v1()) {
774 host->regs = host->base;
775 host->spare0 = host->base + 0x800;
776 host->spare_len = 16;
777 oob_smallpage = &nandv1_hw_eccoob_smallpage;
778 oob_largepage = &nandv1_hw_eccoob_largepage;
Sascha Hauer94671142009-10-05 12:14:21 +0200779 this->ecc.bytes = 3;
780 } else
781 BUG();
Sascha Hauer34f6e152008-09-02 17:16:59 +0200782
Sascha Hauer13e1add2009-10-21 10:39:05 +0200783 this->ecc.size = 512;
Sascha Hauer94671142009-10-05 12:14:21 +0200784 this->ecc.layout = oob_smallpage;
Sascha Hauer13e1add2009-10-21 10:39:05 +0200785
786 if (pdata->hw_ecc) {
787 this->ecc.calculate = mxc_nand_calculate_ecc;
788 this->ecc.hwctl = mxc_nand_enable_hwecc;
789 this->ecc.correct = mxc_nand_correct_data;
790 this->ecc.mode = NAND_ECC_HW;
Sascha Hauer13e1add2009-10-21 10:39:05 +0200791 } else {
792 this->ecc.mode = NAND_ECC_SOFT;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200793 }
794
Sascha Hauer34f6e152008-09-02 17:16:59 +0200795 /* NAND bus width determines access funtions used by upper layer */
Sascha Hauer13e1add2009-10-21 10:39:05 +0200796 if (pdata->width == 2)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200797 this->options |= NAND_BUSWIDTH_16;
Sascha Hauer13e1add2009-10-21 10:39:05 +0200798
Sascha Hauerf1372052009-10-21 14:25:27 +0200799 if (pdata->flash_bbt) {
800 this->bbt_td = &bbt_main_descr;
801 this->bbt_md = &bbt_mirror_descr;
802 /* update flash based bbt */
803 this->options |= NAND_USE_FLASH_BBT;
Sascha Hauer34f6e152008-09-02 17:16:59 +0200804 }
805
Ivo Claryssed4840182010-04-08 16:14:44 +0200806 init_waitqueue_head(&host->irq_waitq);
807
808 host->irq = platform_get_irq(pdev, 0);
809
Ivo Claryssea47bfd22010-04-08 16:16:51 +0200810 err = request_irq(host->irq, mxc_nfc_irq, IRQF_DISABLED, DRIVER_NAME, host);
Ivo Claryssed4840182010-04-08 16:14:44 +0200811 if (err)
812 goto eirq;
813
Vladimir Barinovbd3fd622009-05-25 13:06:17 +0400814 /* first scan to find the device and get the page size */
David Woodhouse5e81e882010-02-26 18:32:56 +0000815 if (nand_scan_ident(mtd, 1, NULL)) {
Vladimir Barinovbd3fd622009-05-25 13:06:17 +0400816 err = -ENXIO;
817 goto escan;
818 }
Sascha Hauer34f6e152008-09-02 17:16:59 +0200819
Sascha Hauer2d69c7f2009-10-05 11:24:02 +0200820 if (mtd->writesize == 2048)
Sascha Hauer94671142009-10-05 12:14:21 +0200821 this->ecc.layout = oob_largepage;
Vladimir Barinovbd3fd622009-05-25 13:06:17 +0400822
823 /* second phase scan */
824 if (nand_scan_tail(mtd)) {
Sascha Hauer34f6e152008-09-02 17:16:59 +0200825 err = -ENXIO;
826 goto escan;
827 }
828
829 /* Register the partitions */
830#ifdef CONFIG_MTD_PARTITIONS
831 nr_parts =
832 parse_mtd_partitions(mtd, part_probes, &host->parts, 0);
833 if (nr_parts > 0)
834 add_mtd_partitions(mtd, host->parts, nr_parts);
835 else
836#endif
837 {
838 pr_info("Registering %s as whole device\n", mtd->name);
839 add_mtd_device(mtd);
840 }
841
842 platform_set_drvdata(pdev, host);
843
844 return 0;
845
846escan:
Magnus Liljab258fd82009-05-08 21:57:47 +0200847 free_irq(host->irq, host);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200848eirq:
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200849 iounmap(host->base);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200850eres:
851 clk_put(host->clk);
852eclk:
853 kfree(host);
854
855 return err;
856}
857
Uwe Kleine-König51eeb872009-12-07 09:44:05 +0000858static int __devexit mxcnd_remove(struct platform_device *pdev)
Sascha Hauer34f6e152008-09-02 17:16:59 +0200859{
860 struct mxc_nand_host *host = platform_get_drvdata(pdev);
861
862 clk_put(host->clk);
863
864 platform_set_drvdata(pdev, NULL);
865
866 nand_release(&host->mtd);
Magnus Liljab258fd82009-05-08 21:57:47 +0200867 free_irq(host->irq, host);
Sascha Hauerc6de7e12009-10-05 11:14:35 +0200868 iounmap(host->base);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200869 kfree(host);
870
871 return 0;
872}
873
Sascha Hauer34f6e152008-09-02 17:16:59 +0200874static struct platform_driver mxcnd_driver = {
875 .driver = {
876 .name = DRIVER_NAME,
Eric Bénard04dd0d32010-06-17 20:59:04 +0200877 },
Uwe Kleine-Königdaa0f152009-11-24 22:07:08 +0100878 .remove = __devexit_p(mxcnd_remove),
Sascha Hauer34f6e152008-09-02 17:16:59 +0200879};
880
881static int __init mxc_nd_init(void)
882{
Vladimir Barinov8541c112009-04-23 15:47:22 +0400883 return platform_driver_probe(&mxcnd_driver, mxcnd_probe);
Sascha Hauer34f6e152008-09-02 17:16:59 +0200884}
885
886static void __exit mxc_nd_cleanup(void)
887{
888 /* Unregister the device structure */
889 platform_driver_unregister(&mxcnd_driver);
890}
891
892module_init(mxc_nd_init);
893module_exit(mxc_nd_cleanup);
894
895MODULE_AUTHOR("Freescale Semiconductor, Inc.");
896MODULE_DESCRIPTION("MXC NAND MTD driver");
897MODULE_LICENSE("GPL");