blob: ed9f9c061ac520e47f4cd0699c3bde05741d70b5 [file] [log] [blame]
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001/*
2 * linux/drivers/mtd/onenand/onenand_base.c
3 *
Kyungmin Park75384b02007-01-18 11:10:57 +09004 * Copyright (C) 2005-2007 Samsung Electronics
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01005 * Kyungmin Park <kyungmin.park@samsung.com>
6 *
Adrian Hunter81280d52007-02-15 09:47:29 +09007 * Credits:
8 * Adrian Hunter <ext-adrian.hunter@nokia.com>:
9 * auto-placement support, read-while load support, various fixes
10 * Copyright (C) Nokia Corporation, 2007
11 *
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010012 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
15 */
16
17#include <linux/kernel.h>
18#include <linux/module.h>
19#include <linux/init.h>
Andrew Morton015953d2005-11-08 21:34:28 -080020#include <linux/sched.h>
Kyungmin Park2c221202006-11-16 11:23:48 +090021#include <linux/interrupt.h>
Andrew Morton015953d2005-11-08 21:34:28 -080022#include <linux/jiffies.h>
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010023#include <linux/mtd/mtd.h>
24#include <linux/mtd/onenand.h>
25#include <linux/mtd/partitions.h>
26
27#include <asm/io.h>
28
29/**
30 * onenand_oob_64 - oob info for large (2KB) page
31 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020032static struct nand_ecclayout onenand_oob_64 = {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010033 .eccbytes = 20,
34 .eccpos = {
35 8, 9, 10, 11, 12,
36 24, 25, 26, 27, 28,
37 40, 41, 42, 43, 44,
38 56, 57, 58, 59, 60,
39 },
40 .oobfree = {
41 {2, 3}, {14, 2}, {18, 3}, {30, 2},
Jarkko Lavinend9777f12006-05-12 17:02:35 +030042 {34, 3}, {46, 2}, {50, 3}, {62, 2}
43 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010044};
45
46/**
47 * onenand_oob_32 - oob info for middle (1KB) page
48 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020049static struct nand_ecclayout onenand_oob_32 = {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010050 .eccbytes = 10,
51 .eccpos = {
52 8, 9, 10, 11, 12,
53 24, 25, 26, 27, 28,
54 },
55 .oobfree = { {2, 3}, {14, 2}, {18, 3}, {30, 2} }
56};
57
58static const unsigned char ffchars[] = {
59 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
60 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 16 */
61 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
62 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 32 */
63 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
64 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 48 */
65 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
66 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 64 */
67};
68
69/**
70 * onenand_readw - [OneNAND Interface] Read OneNAND register
71 * @param addr address to read
72 *
73 * Read OneNAND register
74 */
75static unsigned short onenand_readw(void __iomem *addr)
76{
77 return readw(addr);
78}
79
80/**
81 * onenand_writew - [OneNAND Interface] Write OneNAND register with value
82 * @param value value to write
83 * @param addr address to write
84 *
85 * Write OneNAND register with value
86 */
87static void onenand_writew(unsigned short value, void __iomem *addr)
88{
89 writew(value, addr);
90}
91
92/**
93 * onenand_block_address - [DEFAULT] Get block address
Kyungmin Park83a36832005-09-29 04:53:16 +010094 * @param this onenand chip data structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010095 * @param block the block
96 * @return translated block address if DDP, otherwise same
97 *
98 * Setup Start Address 1 Register (F100h)
99 */
Kyungmin Park83a36832005-09-29 04:53:16 +0100100static int onenand_block_address(struct onenand_chip *this, int block)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100101{
Kyungmin Park738d61f2007-01-15 17:09:14 +0900102 /* Device Flash Core select, NAND Flash Block Address */
103 if (block & this->density_mask)
104 return ONENAND_DDP_CHIP1 | (block ^ this->density_mask);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100105
106 return block;
107}
108
109/**
110 * onenand_bufferram_address - [DEFAULT] Get bufferram address
Kyungmin Park83a36832005-09-29 04:53:16 +0100111 * @param this onenand chip data structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100112 * @param block the block
113 * @return set DBS value if DDP, otherwise 0
114 *
115 * Setup Start Address 2 Register (F101h) for DDP
116 */
Kyungmin Park83a36832005-09-29 04:53:16 +0100117static int onenand_bufferram_address(struct onenand_chip *this, int block)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100118{
Kyungmin Park738d61f2007-01-15 17:09:14 +0900119 /* Device BufferRAM Select */
120 if (block & this->density_mask)
121 return ONENAND_DDP_CHIP1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100122
Kyungmin Park738d61f2007-01-15 17:09:14 +0900123 return ONENAND_DDP_CHIP0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100124}
125
126/**
127 * onenand_page_address - [DEFAULT] Get page address
128 * @param page the page address
129 * @param sector the sector address
130 * @return combined page and sector address
131 *
132 * Setup Start Address 8 Register (F107h)
133 */
134static int onenand_page_address(int page, int sector)
135{
136 /* Flash Page Address, Flash Sector Address */
137 int fpa, fsa;
138
139 fpa = page & ONENAND_FPA_MASK;
140 fsa = sector & ONENAND_FSA_MASK;
141
142 return ((fpa << ONENAND_FPA_SHIFT) | fsa);
143}
144
145/**
146 * onenand_buffer_address - [DEFAULT] Get buffer address
147 * @param dataram1 DataRAM index
148 * @param sectors the sector address
149 * @param count the number of sectors
150 * @return the start buffer value
151 *
152 * Setup Start Buffer Register (F200h)
153 */
154static int onenand_buffer_address(int dataram1, int sectors, int count)
155{
156 int bsa, bsc;
157
158 /* BufferRAM Sector Address */
159 bsa = sectors & ONENAND_BSA_MASK;
160
161 if (dataram1)
162 bsa |= ONENAND_BSA_DATARAM1; /* DataRAM1 */
163 else
164 bsa |= ONENAND_BSA_DATARAM0; /* DataRAM0 */
165
166 /* BufferRAM Sector Count */
167 bsc = count & ONENAND_BSC_MASK;
168
169 return ((bsa << ONENAND_BSA_SHIFT) | bsc);
170}
171
172/**
173 * onenand_command - [DEFAULT] Send command to OneNAND device
174 * @param mtd MTD device structure
175 * @param cmd the command to be sent
176 * @param addr offset to read from or write to
177 * @param len number of bytes to read or write
178 *
179 * Send command to OneNAND device. This function is used for middle/large page
180 * devices (1KB/2KB Bytes per page)
181 */
182static int onenand_command(struct mtd_info *mtd, int cmd, loff_t addr, size_t len)
183{
184 struct onenand_chip *this = mtd->priv;
Kyungmin Park493c6462006-05-12 17:03:07 +0300185 int value, readcmd = 0, block_cmd = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100186 int block, page;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100187
188 /* Address translation */
189 switch (cmd) {
190 case ONENAND_CMD_UNLOCK:
191 case ONENAND_CMD_LOCK:
192 case ONENAND_CMD_LOCK_TIGHT:
Kyungmin Park28b79ff2006-09-26 09:45:28 +0000193 case ONENAND_CMD_UNLOCK_ALL:
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100194 block = -1;
195 page = -1;
196 break;
197
198 case ONENAND_CMD_ERASE:
199 case ONENAND_CMD_BUFFERRAM:
Kyungmin Park493c6462006-05-12 17:03:07 +0300200 case ONENAND_CMD_OTP_ACCESS:
201 block_cmd = 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100202 block = (int) (addr >> this->erase_shift);
203 page = -1;
204 break;
205
206 default:
207 block = (int) (addr >> this->erase_shift);
208 page = (int) (addr >> this->page_shift);
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900209
210 if (ONENAND_IS_2PLANE(this)) {
211 /* Make the even block number */
212 block &= ~1;
213 /* Is it the odd plane? */
214 if (addr & this->writesize)
215 block++;
216 page >>= 1;
217 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100218 page &= this->page_mask;
219 break;
220 }
221
222 /* NOTE: The setting order of the registers is very important! */
223 if (cmd == ONENAND_CMD_BUFFERRAM) {
224 /* Select DataRAM for DDP */
Kyungmin Park83a36832005-09-29 04:53:16 +0100225 value = onenand_bufferram_address(this, block);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100226 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
227
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900228 if (ONENAND_IS_2PLANE(this))
229 /* It is always BufferRAM0 */
230 ONENAND_SET_BUFFERRAM0(this);
231 else
232 /* Switch to the next data buffer */
233 ONENAND_SET_NEXT_BUFFERRAM(this);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100234
235 return 0;
236 }
237
238 if (block != -1) {
239 /* Write 'DFS, FBA' of Flash */
Kyungmin Park83a36832005-09-29 04:53:16 +0100240 value = onenand_block_address(this, block);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100241 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
Kyungmin Park3cecf692006-05-12 17:02:51 +0300242
Kyungmin Park75287072006-05-12 17:03:23 +0300243 if (block_cmd) {
Kyungmin Park3cecf692006-05-12 17:02:51 +0300244 /* Select DataRAM for DDP */
245 value = onenand_bufferram_address(this, block);
246 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
247 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100248 }
249
250 if (page != -1) {
Kyungmin Park60d84f92006-12-22 16:21:54 +0900251 /* Now we use page size operation */
252 int sectors = 4, count = 4;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100253 int dataram;
254
255 switch (cmd) {
256 case ONENAND_CMD_READ:
257 case ONENAND_CMD_READOOB:
258 dataram = ONENAND_SET_NEXT_BUFFERRAM(this);
259 readcmd = 1;
260 break;
261
262 default:
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900263 if (ONENAND_IS_2PLANE(this) && cmd == ONENAND_CMD_PROG)
264 cmd = ONENAND_CMD_2X_PROG;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100265 dataram = ONENAND_CURRENT_BUFFERRAM(this);
266 break;
267 }
268
269 /* Write 'FPA, FSA' of Flash */
270 value = onenand_page_address(page, sectors);
271 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS8);
272
273 /* Write 'BSA, BSC' of DataRAM */
274 value = onenand_buffer_address(dataram, sectors, count);
275 this->write_word(value, this->base + ONENAND_REG_START_BUFFER);
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000276
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100277 if (readcmd) {
278 /* Select DataRAM for DDP */
Kyungmin Park83a36832005-09-29 04:53:16 +0100279 value = onenand_bufferram_address(this, block);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100280 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
281 }
282 }
283
284 /* Interrupt clear */
285 this->write_word(ONENAND_INT_CLEAR, this->base + ONENAND_REG_INTERRUPT);
286
287 /* Write command */
288 this->write_word(cmd, this->base + ONENAND_REG_COMMAND);
289
290 return 0;
291}
292
293/**
294 * onenand_wait - [DEFAULT] wait until the command is done
295 * @param mtd MTD device structure
296 * @param state state to select the max. timeout value
297 *
298 * Wait for command done. This applies to all OneNAND command
299 * Read can take up to 30us, erase up to 2ms and program up to 350us
300 * according to general OneNAND specs
301 */
302static int onenand_wait(struct mtd_info *mtd, int state)
303{
304 struct onenand_chip * this = mtd->priv;
305 unsigned long timeout;
306 unsigned int flags = ONENAND_INT_MASTER;
307 unsigned int interrupt = 0;
Kyungmin Park2fd32d42006-12-29 11:51:40 +0900308 unsigned int ctrl;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100309
310 /* The 20 msec is enough */
311 timeout = jiffies + msecs_to_jiffies(20);
312 while (time_before(jiffies, timeout)) {
313 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
314
315 if (interrupt & flags)
316 break;
317
318 if (state != FL_READING)
319 cond_resched();
320 }
321 /* To get correct interrupt status in timeout case */
322 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
323
324 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
325
326 if (ctrl & ONENAND_CTRL_ERROR) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900327 printk(KERN_ERR "onenand_wait: controller error = 0x%04x\n", ctrl);
Kyungmin Parkf6272482006-12-22 16:02:50 +0900328 if (ctrl & ONENAND_CTRL_LOCK)
Kyungmin Park211ac752007-02-07 12:15:01 +0900329 printk(KERN_ERR "onenand_wait: it's locked error.\n");
Adrian Hunter30a7eb22007-10-12 10:19:38 +0300330 return -EIO;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100331 }
332
333 if (interrupt & ONENAND_INT_READ) {
Kyungmin Park2fd32d42006-12-29 11:51:40 +0900334 int ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900335 if (ecc) {
Kyungmin Parkb3c9f8b2007-01-05 19:16:04 +0900336 if (ecc & ONENAND_ECC_2BIT_ALL) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300337 printk(KERN_ERR "onenand_wait: ECC error = 0x%04x\n", ecc);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900338 mtd->ecc_stats.failed++;
Adrian Hunter30a7eb22007-10-12 10:19:38 +0300339 return -EBADMSG;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300340 } else if (ecc & ONENAND_ECC_1BIT_ALL) {
341 printk(KERN_INFO "onenand_wait: correctable ECC error = 0x%04x\n", ecc);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900342 mtd->ecc_stats.corrected++;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300343 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100344 }
Adrian Hunter9d032802007-01-10 07:51:26 +0200345 } else if (state == FL_READING) {
346 printk(KERN_ERR "onenand_wait: read timeout! ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
347 return -EIO;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100348 }
349
350 return 0;
351}
352
Kyungmin Park2c221202006-11-16 11:23:48 +0900353/*
354 * onenand_interrupt - [DEFAULT] onenand interrupt handler
355 * @param irq onenand interrupt number
356 * @param dev_id interrupt data
357 *
358 * complete the work
359 */
360static irqreturn_t onenand_interrupt(int irq, void *data)
361{
Jeff Garzik06efcad2007-10-19 03:10:11 -0400362 struct onenand_chip *this = data;
Kyungmin Park2c221202006-11-16 11:23:48 +0900363
364 /* To handle shared interrupt */
365 if (!this->complete.done)
366 complete(&this->complete);
367
368 return IRQ_HANDLED;
369}
370
371/*
372 * onenand_interrupt_wait - [DEFAULT] wait until the command is done
373 * @param mtd MTD device structure
374 * @param state state to select the max. timeout value
375 *
376 * Wait for command done.
377 */
378static int onenand_interrupt_wait(struct mtd_info *mtd, int state)
379{
380 struct onenand_chip *this = mtd->priv;
381
Kyungmin Park2c221202006-11-16 11:23:48 +0900382 wait_for_completion(&this->complete);
383
384 return onenand_wait(mtd, state);
385}
386
387/*
388 * onenand_try_interrupt_wait - [DEFAULT] try interrupt wait
389 * @param mtd MTD device structure
390 * @param state state to select the max. timeout value
391 *
392 * Try interrupt based wait (It is used one-time)
393 */
394static int onenand_try_interrupt_wait(struct mtd_info *mtd, int state)
395{
396 struct onenand_chip *this = mtd->priv;
397 unsigned long remain, timeout;
398
399 /* We use interrupt wait first */
400 this->wait = onenand_interrupt_wait;
401
Kyungmin Park2c221202006-11-16 11:23:48 +0900402 timeout = msecs_to_jiffies(100);
403 remain = wait_for_completion_timeout(&this->complete, timeout);
404 if (!remain) {
405 printk(KERN_INFO "OneNAND: There's no interrupt. "
406 "We use the normal wait\n");
407
408 /* Release the irq */
409 free_irq(this->irq, this);
David Woodhousec9ac5972006-11-30 08:17:38 +0000410
Kyungmin Park2c221202006-11-16 11:23:48 +0900411 this->wait = onenand_wait;
412 }
413
414 return onenand_wait(mtd, state);
415}
416
417/*
418 * onenand_setup_wait - [OneNAND Interface] setup onenand wait method
419 * @param mtd MTD device structure
420 *
421 * There's two method to wait onenand work
422 * 1. polling - read interrupt status register
423 * 2. interrupt - use the kernel interrupt method
424 */
425static void onenand_setup_wait(struct mtd_info *mtd)
426{
427 struct onenand_chip *this = mtd->priv;
428 int syscfg;
429
430 init_completion(&this->complete);
431
432 if (this->irq <= 0) {
433 this->wait = onenand_wait;
434 return;
435 }
436
437 if (request_irq(this->irq, &onenand_interrupt,
438 IRQF_SHARED, "onenand", this)) {
439 /* If we can't get irq, use the normal wait */
440 this->wait = onenand_wait;
441 return;
442 }
443
444 /* Enable interrupt */
445 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
446 syscfg |= ONENAND_SYS_CFG1_IOBE;
447 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
448
449 this->wait = onenand_try_interrupt_wait;
450}
451
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100452/**
453 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
454 * @param mtd MTD data structure
455 * @param area BufferRAM area
456 * @return offset given area
457 *
458 * Return BufferRAM offset given area
459 */
460static inline int onenand_bufferram_offset(struct mtd_info *mtd, int area)
461{
462 struct onenand_chip *this = mtd->priv;
463
464 if (ONENAND_CURRENT_BUFFERRAM(this)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900465 /* Note: the 'this->writesize' is a real page size */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100466 if (area == ONENAND_DATARAM)
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900467 return this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100468 if (area == ONENAND_SPARERAM)
469 return mtd->oobsize;
470 }
471
472 return 0;
473}
474
475/**
476 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area
477 * @param mtd MTD data structure
478 * @param area BufferRAM area
479 * @param buffer the databuffer to put/get data
480 * @param offset offset to read from or write to
481 * @param count number of bytes to read/write
482 *
483 * Read the BufferRAM area
484 */
485static int onenand_read_bufferram(struct mtd_info *mtd, int area,
486 unsigned char *buffer, int offset, size_t count)
487{
488 struct onenand_chip *this = mtd->priv;
489 void __iomem *bufferram;
490
491 bufferram = this->base + area;
492
493 bufferram += onenand_bufferram_offset(mtd, area);
494
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300495 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
496 unsigned short word;
497
498 /* Align with word(16-bit) size */
499 count--;
500
501 /* Read word and save byte */
502 word = this->read_word(bufferram + offset + count);
503 buffer[count] = (word & 0xff);
504 }
505
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100506 memcpy(buffer, bufferram + offset, count);
507
508 return 0;
509}
510
511/**
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100512 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode
513 * @param mtd MTD data structure
514 * @param area BufferRAM area
515 * @param buffer the databuffer to put/get data
516 * @param offset offset to read from or write to
517 * @param count number of bytes to read/write
518 *
519 * Read the BufferRAM area with Sync. Burst Mode
520 */
521static int onenand_sync_read_bufferram(struct mtd_info *mtd, int area,
522 unsigned char *buffer, int offset, size_t count)
523{
524 struct onenand_chip *this = mtd->priv;
525 void __iomem *bufferram;
526
527 bufferram = this->base + area;
528
529 bufferram += onenand_bufferram_offset(mtd, area);
530
531 this->mmcontrol(mtd, ONENAND_SYS_CFG1_SYNC_READ);
532
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300533 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
534 unsigned short word;
535
536 /* Align with word(16-bit) size */
537 count--;
538
539 /* Read word and save byte */
540 word = this->read_word(bufferram + offset + count);
541 buffer[count] = (word & 0xff);
542 }
543
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100544 memcpy(buffer, bufferram + offset, count);
545
546 this->mmcontrol(mtd, 0);
547
548 return 0;
549}
550
551/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100552 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area
553 * @param mtd MTD data structure
554 * @param area BufferRAM area
555 * @param buffer the databuffer to put/get data
556 * @param offset offset to read from or write to
557 * @param count number of bytes to read/write
558 *
559 * Write the BufferRAM area
560 */
561static int onenand_write_bufferram(struct mtd_info *mtd, int area,
562 const unsigned char *buffer, int offset, size_t count)
563{
564 struct onenand_chip *this = mtd->priv;
565 void __iomem *bufferram;
566
567 bufferram = this->base + area;
568
569 bufferram += onenand_bufferram_offset(mtd, area);
570
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300571 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
572 unsigned short word;
573 int byte_offset;
574
575 /* Align with word(16-bit) size */
576 count--;
577
578 /* Calculate byte access offset */
579 byte_offset = offset + count;
580
581 /* Read word and save byte */
582 word = this->read_word(bufferram + byte_offset);
583 word = (word & ~0xff) | buffer[count];
584 this->write_word(word, bufferram + byte_offset);
585 }
586
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100587 memcpy(bufferram + offset, buffer, count);
588
589 return 0;
590}
591
592/**
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900593 * onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode
594 * @param mtd MTD data structure
595 * @param addr address to check
596 * @return blockpage address
597 *
598 * Get blockpage address at 2x program mode
599 */
600static int onenand_get_2x_blockpage(struct mtd_info *mtd, loff_t addr)
601{
602 struct onenand_chip *this = mtd->priv;
603 int blockpage, block, page;
604
605 /* Calculate the even block number */
606 block = (int) (addr >> this->erase_shift) & ~1;
607 /* Is it the odd plane? */
608 if (addr & this->writesize)
609 block++;
610 page = (int) (addr >> (this->page_shift + 1)) & this->page_mask;
611 blockpage = (block << 7) | page;
612
613 return blockpage;
614}
615
616/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100617 * onenand_check_bufferram - [GENERIC] Check BufferRAM information
618 * @param mtd MTD data structure
619 * @param addr address to check
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000620 * @return 1 if there are valid data, otherwise 0
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100621 *
622 * Check bufferram if there is data we required
623 */
624static int onenand_check_bufferram(struct mtd_info *mtd, loff_t addr)
625{
626 struct onenand_chip *this = mtd->priv;
Adrian Huntercde36b32007-02-08 10:28:08 +0200627 int blockpage, found = 0;
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900628 unsigned int i;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000629
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900630 if (ONENAND_IS_2PLANE(this))
631 blockpage = onenand_get_2x_blockpage(mtd, addr);
632 else
633 blockpage = (int) (addr >> this->page_shift);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100634
635 /* Is there valid data? */
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900636 i = ONENAND_CURRENT_BUFFERRAM(this);
637 if (this->bufferram[i].blockpage == blockpage)
Adrian Huntercde36b32007-02-08 10:28:08 +0200638 found = 1;
639 else {
640 /* Check another BufferRAM */
641 i = ONENAND_NEXT_BUFFERRAM(this);
642 if (this->bufferram[i].blockpage == blockpage) {
643 ONENAND_SET_NEXT_BUFFERRAM(this);
644 found = 1;
645 }
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900646 }
647
Adrian Huntercde36b32007-02-08 10:28:08 +0200648 if (found && ONENAND_IS_DDP(this)) {
649 /* Select DataRAM for DDP */
650 int block = (int) (addr >> this->erase_shift);
651 int value = onenand_bufferram_address(this, block);
652 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
653 }
654
655 return found;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100656}
657
658/**
659 * onenand_update_bufferram - [GENERIC] Update BufferRAM information
660 * @param mtd MTD data structure
661 * @param addr address to update
662 * @param valid valid flag
663 *
664 * Update BufferRAM information
665 */
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900666static void onenand_update_bufferram(struct mtd_info *mtd, loff_t addr,
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100667 int valid)
668{
669 struct onenand_chip *this = mtd->priv;
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900670 int blockpage;
671 unsigned int i;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000672
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900673 if (ONENAND_IS_2PLANE(this))
674 blockpage = onenand_get_2x_blockpage(mtd, addr);
675 else
676 blockpage = (int) (addr >> this->page_shift);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100677
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900678 /* Invalidate another BufferRAM */
679 i = ONENAND_NEXT_BUFFERRAM(this);
Kyungmin Park5b4246f2007-02-02 09:39:21 +0900680 if (this->bufferram[i].blockpage == blockpage)
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900681 this->bufferram[i].blockpage = -1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100682
683 /* Update BufferRAM */
684 i = ONENAND_CURRENT_BUFFERRAM(this);
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900685 if (valid)
686 this->bufferram[i].blockpage = blockpage;
687 else
688 this->bufferram[i].blockpage = -1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100689}
690
691/**
Adrian Hunter480b9df2007-02-07 13:55:19 +0200692 * onenand_invalidate_bufferram - [GENERIC] Invalidate BufferRAM information
693 * @param mtd MTD data structure
694 * @param addr start address to invalidate
695 * @param len length to invalidate
696 *
697 * Invalidate BufferRAM information
698 */
699static void onenand_invalidate_bufferram(struct mtd_info *mtd, loff_t addr,
700 unsigned int len)
701{
702 struct onenand_chip *this = mtd->priv;
703 int i;
704 loff_t end_addr = addr + len;
705
706 /* Invalidate BufferRAM */
707 for (i = 0; i < MAX_BUFFERRAM; i++) {
708 loff_t buf_addr = this->bufferram[i].blockpage << this->page_shift;
709 if (buf_addr >= addr && buf_addr < end_addr)
710 this->bufferram[i].blockpage = -1;
711 }
712}
713
714/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100715 * onenand_get_device - [GENERIC] Get chip for selected access
716 * @param mtd MTD device structure
717 * @param new_state the state which is requested
718 *
719 * Get the device and lock it for exclusive access
720 */
Kyungmin Parka41371e2005-09-29 03:55:31 +0100721static int onenand_get_device(struct mtd_info *mtd, int new_state)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100722{
723 struct onenand_chip *this = mtd->priv;
724 DECLARE_WAITQUEUE(wait, current);
725
726 /*
727 * Grab the lock and see if the device is available
728 */
729 while (1) {
730 spin_lock(&this->chip_lock);
731 if (this->state == FL_READY) {
732 this->state = new_state;
733 spin_unlock(&this->chip_lock);
734 break;
735 }
Kyungmin Parka41371e2005-09-29 03:55:31 +0100736 if (new_state == FL_PM_SUSPENDED) {
737 spin_unlock(&this->chip_lock);
738 return (this->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
739 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100740 set_current_state(TASK_UNINTERRUPTIBLE);
741 add_wait_queue(&this->wq, &wait);
742 spin_unlock(&this->chip_lock);
743 schedule();
744 remove_wait_queue(&this->wq, &wait);
745 }
Kyungmin Parka41371e2005-09-29 03:55:31 +0100746
747 return 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100748}
749
750/**
751 * onenand_release_device - [GENERIC] release chip
752 * @param mtd MTD device structure
753 *
754 * Deselect, release chip lock and wake up anyone waiting on the device
755 */
756static void onenand_release_device(struct mtd_info *mtd)
757{
758 struct onenand_chip *this = mtd->priv;
759
760 /* Release the chip */
761 spin_lock(&this->chip_lock);
762 this->state = FL_READY;
763 wake_up(&this->wq);
764 spin_unlock(&this->chip_lock);
765}
766
767/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900768 * onenand_transfer_auto_oob - [Internal] oob auto-placement transfer
769 * @param mtd MTD device structure
770 * @param buf destination address
771 * @param column oob offset to read from
772 * @param thislen oob length to read
773 */
774static int onenand_transfer_auto_oob(struct mtd_info *mtd, uint8_t *buf, int column,
775 int thislen)
776{
777 struct onenand_chip *this = mtd->priv;
778 struct nand_oobfree *free;
779 int readcol = column;
780 int readend = column + thislen;
781 int lastgap = 0;
782 unsigned int i;
783 uint8_t *oob_buf = this->oob_buf;
784
785 free = this->ecclayout->oobfree;
786 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
787 if (readcol >= lastgap)
788 readcol += free->offset - lastgap;
789 if (readend >= lastgap)
790 readend += free->offset - lastgap;
791 lastgap = free->offset + free->length;
792 }
793 this->read_bufferram(mtd, ONENAND_SPARERAM, oob_buf, 0, mtd->oobsize);
794 free = this->ecclayout->oobfree;
795 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
796 int free_end = free->offset + free->length;
797 if (free->offset < readend && free_end > readcol) {
798 int st = max_t(int,free->offset,readcol);
799 int ed = min_t(int,free_end,readend);
800 int n = ed - st;
801 memcpy(buf, oob_buf + st, n);
802 buf += n;
803 } else if (column == 0)
804 break;
805 }
806 return 0;
807}
808
809/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300810 * onenand_read_ops_nolock - [OneNAND Interface] OneNAND read main and/or out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100811 * @param mtd MTD device structure
812 * @param from offset to read from
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900813 * @param ops: oob operation description structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100814 *
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900815 * OneNAND read main and/or out-of-band data
816 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300817static int onenand_read_ops_nolock(struct mtd_info *mtd, loff_t from,
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900818 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100819{
820 struct onenand_chip *this = mtd->priv;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900821 struct mtd_ecc_stats stats;
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900822 size_t len = ops->len;
823 size_t ooblen = ops->ooblen;
824 u_char *buf = ops->datbuf;
825 u_char *oobbuf = ops->oobbuf;
826 int read = 0, column, thislen;
827 int oobread = 0, oobcolumn, thisooblen, oobsize;
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200828 int ret = 0, boundary = 0;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900829 int writesize = this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100830
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300831 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read_ops_nolock: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900832
833 if (ops->mode == MTD_OOB_AUTO)
834 oobsize = this->ecclayout->oobavail;
835 else
836 oobsize = mtd->oobsize;
837
838 oobcolumn = from & (mtd->oobsize - 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100839
840 /* Do not allow reads past end of device */
841 if ((from + len) > mtd->size) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300842 printk(KERN_ERR "onenand_read_ops_nolock: Attempt read beyond end of device\n");
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900843 ops->retlen = 0;
844 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100845 return -EINVAL;
846 }
847
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900848 stats = mtd->ecc_stats;
Artem Bityutskiy61a7e192006-12-26 16:41:24 +0900849
Adrian Huntera8de85d2007-01-04 09:51:26 +0200850 /* Read-while-load method */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100851
Adrian Huntera8de85d2007-01-04 09:51:26 +0200852 /* Do first load to bufferRAM */
853 if (read < len) {
854 if (!onenand_check_bufferram(mtd, from)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900855 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200856 ret = this->wait(mtd, FL_READING);
857 onenand_update_bufferram(mtd, from, !ret);
Adrian Hunter5f4d47d2007-11-06 09:17:25 +0200858 if (ret == -EBADMSG)
859 ret = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +0200860 }
861 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100862
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900863 thislen = min_t(int, writesize, len - read);
864 column = from & (writesize - 1);
865 if (column + thislen > writesize)
866 thislen = writesize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100867
Adrian Huntera8de85d2007-01-04 09:51:26 +0200868 while (!ret) {
869 /* If there is more to load then start next load */
870 from += thislen;
871 if (read + thislen < len) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900872 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200873 /*
874 * Chip boundary handling in DDP
875 * Now we issued chip 1 read and pointed chip 1
876 * bufferam so we have to point chip 0 bufferam.
877 */
Kyungmin Park738d61f2007-01-15 17:09:14 +0900878 if (ONENAND_IS_DDP(this) &&
879 unlikely(from == (this->chipsize >> 1))) {
880 this->write_word(ONENAND_DDP_CHIP0, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200881 boundary = 1;
882 } else
883 boundary = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +0200884 ONENAND_SET_PREV_BUFFERRAM(this);
885 }
886 /* While load is going, read from last bufferRAM */
887 this->read_bufferram(mtd, ONENAND_DATARAM, buf, column, thislen);
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900888
889 /* Read oob area if needed */
890 if (oobbuf) {
891 thisooblen = oobsize - oobcolumn;
892 thisooblen = min_t(int, thisooblen, ooblen - oobread);
893
894 if (ops->mode == MTD_OOB_AUTO)
895 onenand_transfer_auto_oob(mtd, oobbuf, oobcolumn, thisooblen);
896 else
897 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, oobcolumn, thisooblen);
898 oobread += thisooblen;
899 oobbuf += thisooblen;
900 oobcolumn = 0;
901 }
902
Adrian Huntera8de85d2007-01-04 09:51:26 +0200903 /* See if we are done */
904 read += thislen;
905 if (read == len)
906 break;
907 /* Set up for next read from bufferRAM */
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200908 if (unlikely(boundary))
Kyungmin Park738d61f2007-01-15 17:09:14 +0900909 this->write_word(ONENAND_DDP_CHIP1, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200910 ONENAND_SET_NEXT_BUFFERRAM(this);
911 buf += thislen;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900912 thislen = min_t(int, writesize, len - read);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200913 column = 0;
914 cond_resched();
915 /* Now wait for load */
916 ret = this->wait(mtd, FL_READING);
917 onenand_update_bufferram(mtd, from, !ret);
Adrian Hunter5f4d47d2007-11-06 09:17:25 +0200918 if (ret == -EBADMSG)
919 ret = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +0200920 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100921
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100922 /*
923 * Return success, if no ECC failures, else -EBADMSG
924 * fs driver will take care of that, because
925 * retlen == desired len and result == -EBADMSG
926 */
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900927 ops->retlen = read;
928 ops->oobretlen = oobread;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900929
Adrian Huntera8de85d2007-01-04 09:51:26 +0200930 if (ret)
931 return ret;
932
Adrian Hunter5f4d47d2007-11-06 09:17:25 +0200933 if (mtd->ecc_stats.failed - stats.failed)
934 return -EBADMSG;
935
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900936 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100937}
938
939/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300940 * onenand_read_oob_nolock - [MTD Interface] OneNAND read out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100941 * @param mtd MTD device structure
942 * @param from offset to read from
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900943 * @param ops: oob operation description structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100944 *
945 * OneNAND read out-of-band data from the spare area
946 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300947static int onenand_read_oob_nolock(struct mtd_info *mtd, loff_t from,
Kyungmin Park12f77c92007-08-30 09:36:05 +0900948 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100949{
950 struct onenand_chip *this = mtd->priv;
Adrian Hunter5f4d47d2007-11-06 09:17:25 +0200951 struct mtd_ecc_stats stats;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200952 int read = 0, thislen, column, oobsize;
Kyungmin Park12f77c92007-08-30 09:36:05 +0900953 size_t len = ops->ooblen;
954 mtd_oob_mode_t mode = ops->mode;
955 u_char *buf = ops->oobbuf;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100956 int ret = 0;
957
Kyungmin Park12f77c92007-08-30 09:36:05 +0900958 from += ops->ooboffs;
959
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300960 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read_oob_nolock: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100961
962 /* Initialize return length value */
Kyungmin Park12f77c92007-08-30 09:36:05 +0900963 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100964
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200965 if (mode == MTD_OOB_AUTO)
966 oobsize = this->ecclayout->oobavail;
967 else
968 oobsize = mtd->oobsize;
969
970 column = from & (mtd->oobsize - 1);
971
972 if (unlikely(column >= oobsize)) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300973 printk(KERN_ERR "onenand_read_oob_nolock: Attempted to start read outside oob\n");
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200974 return -EINVAL;
975 }
976
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100977 /* Do not allow reads past end of device */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200978 if (unlikely(from >= mtd->size ||
979 column + len > ((mtd->size >> this->page_shift) -
980 (from >> this->page_shift)) * oobsize)) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300981 printk(KERN_ERR "onenand_read_oob_nolock: Attempted to read beyond end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100982 return -EINVAL;
983 }
984
Adrian Hunter5f4d47d2007-11-06 09:17:25 +0200985 stats = mtd->ecc_stats;
986
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100987 while (read < len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +0900988 cond_resched();
989
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200990 thislen = oobsize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100991 thislen = min_t(int, thislen, len);
992
993 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
994
995 onenand_update_bufferram(mtd, from, 0);
996
997 ret = this->wait(mtd, FL_READING);
Adrian Hunter5f4d47d2007-11-06 09:17:25 +0200998 if (ret && ret != -EBADMSG) {
999 printk(KERN_ERR "onenand_read_oob_nolock: read failed = 0x%x\n", ret);
1000 break;
1001 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001002
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001003 if (mode == MTD_OOB_AUTO)
1004 onenand_transfer_auto_oob(mtd, buf, column, thislen);
1005 else
1006 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001007
1008 read += thislen;
1009
1010 if (read == len)
1011 break;
1012
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001013 buf += thislen;
1014
1015 /* Read more? */
1016 if (read < len) {
1017 /* Page size */
Joern Engel28318772006-05-22 23:18:05 +02001018 from += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001019 column = 0;
1020 }
1021 }
1022
Kyungmin Park12f77c92007-08-30 09:36:05 +09001023 ops->oobretlen = read;
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001024
1025 if (ret)
1026 return ret;
1027
1028 if (mtd->ecc_stats.failed - stats.failed)
1029 return -EBADMSG;
1030
1031 return 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001032}
1033
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001034/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001035 * onenand_read - [MTD Interface] Read data from flash
1036 * @param mtd MTD device structure
1037 * @param from offset to read from
1038 * @param len number of bytes to read
1039 * @param retlen pointer to variable to store the number of read bytes
1040 * @param buf the databuffer to put data
1041 *
1042 * Read with ecc
1043*/
1044static int onenand_read(struct mtd_info *mtd, loff_t from, size_t len,
1045 size_t *retlen, u_char *buf)
1046{
1047 struct mtd_oob_ops ops = {
1048 .len = len,
1049 .ooblen = 0,
1050 .datbuf = buf,
1051 .oobbuf = NULL,
1052 };
1053 int ret;
1054
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001055 onenand_get_device(mtd, FL_READING);
1056 ret = onenand_read_ops_nolock(mtd, from, &ops);
1057 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001058
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001059 *retlen = ops.retlen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001060 return ret;
1061}
1062
1063/**
1064 * onenand_read_oob - [MTD Interface] Read main and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001065 * @param mtd: MTD device structure
1066 * @param from: offset to read from
1067 * @param ops: oob operation description structure
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001068
1069 * Read main and/or out-of-band
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001070 */
1071static int onenand_read_oob(struct mtd_info *mtd, loff_t from,
1072 struct mtd_oob_ops *ops)
1073{
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001074 int ret;
1075
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001076 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001077 case MTD_OOB_PLACE:
1078 case MTD_OOB_AUTO:
1079 break;
1080 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001081 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001082 default:
1083 return -EINVAL;
1084 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001085
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001086 onenand_get_device(mtd, FL_READING);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001087 if (ops->datbuf)
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001088 ret = onenand_read_ops_nolock(mtd, from, ops);
1089 else
1090 ret = onenand_read_oob_nolock(mtd, from, ops);
1091 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001092
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001093 return ret;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001094}
1095
Kyungmin Park211ac752007-02-07 12:15:01 +09001096/**
1097 * onenand_bbt_wait - [DEFAULT] wait until the command is done
1098 * @param mtd MTD device structure
1099 * @param state state to select the max. timeout value
1100 *
1101 * Wait for command done.
1102 */
1103static int onenand_bbt_wait(struct mtd_info *mtd, int state)
1104{
1105 struct onenand_chip *this = mtd->priv;
1106 unsigned long timeout;
1107 unsigned int interrupt;
1108 unsigned int ctrl;
1109
1110 /* The 20 msec is enough */
1111 timeout = jiffies + msecs_to_jiffies(20);
1112 while (time_before(jiffies, timeout)) {
1113 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1114 if (interrupt & ONENAND_INT_MASTER)
1115 break;
1116 }
1117 /* To get correct interrupt status in timeout case */
1118 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1119 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
1120
1121 if (ctrl & ONENAND_CTRL_ERROR) {
1122 printk(KERN_DEBUG "onenand_bbt_wait: controller error = 0x%04x\n", ctrl);
1123 /* Initial bad block case */
1124 if (ctrl & ONENAND_CTRL_LOAD)
1125 return ONENAND_BBT_READ_ERROR;
1126 return ONENAND_BBT_READ_FATAL_ERROR;
1127 }
1128
1129 if (interrupt & ONENAND_INT_READ) {
1130 int ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS);
1131 if (ecc & ONENAND_ECC_2BIT_ALL)
1132 return ONENAND_BBT_READ_ERROR;
1133 } else {
1134 printk(KERN_ERR "onenand_bbt_wait: read timeout!"
1135 "ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
1136 return ONENAND_BBT_READ_FATAL_ERROR;
1137 }
1138
1139 return 0;
1140}
1141
1142/**
1143 * onenand_bbt_read_oob - [MTD Interface] OneNAND read out-of-band for bbt scan
1144 * @param mtd MTD device structure
1145 * @param from offset to read from
Kyungmin Parke3da8062007-02-15 09:36:39 +09001146 * @param ops oob operation description structure
Kyungmin Park211ac752007-02-07 12:15:01 +09001147 *
1148 * OneNAND read out-of-band data from the spare area for bbt scan
1149 */
1150int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
1151 struct mtd_oob_ops *ops)
1152{
1153 struct onenand_chip *this = mtd->priv;
1154 int read = 0, thislen, column;
1155 int ret = 0;
1156 size_t len = ops->ooblen;
1157 u_char *buf = ops->oobbuf;
1158
Andrew Morton5785bdd2007-02-17 16:02:05 -08001159 DEBUG(MTD_DEBUG_LEVEL3, "onenand_bbt_read_oob: from = 0x%08x, len = %zi\n", (unsigned int) from, len);
Kyungmin Park211ac752007-02-07 12:15:01 +09001160
1161 /* Initialize return value */
1162 ops->oobretlen = 0;
1163
1164 /* Do not allow reads past end of device */
1165 if (unlikely((from + len) > mtd->size)) {
1166 printk(KERN_ERR "onenand_bbt_read_oob: Attempt read beyond end of device\n");
1167 return ONENAND_BBT_READ_FATAL_ERROR;
1168 }
1169
1170 /* Grab the lock and see if the device is available */
1171 onenand_get_device(mtd, FL_READING);
1172
1173 column = from & (mtd->oobsize - 1);
1174
1175 while (read < len) {
1176 cond_resched();
1177
1178 thislen = mtd->oobsize - column;
1179 thislen = min_t(int, thislen, len);
1180
1181 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
1182
1183 onenand_update_bufferram(mtd, from, 0);
1184
1185 ret = onenand_bbt_wait(mtd, FL_READING);
1186 if (ret)
1187 break;
1188
1189 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
1190 read += thislen;
1191 if (read == len)
1192 break;
1193
1194 buf += thislen;
1195
1196 /* Read more? */
1197 if (read < len) {
1198 /* Update Page size */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001199 from += this->writesize;
Kyungmin Park211ac752007-02-07 12:15:01 +09001200 column = 0;
1201 }
1202 }
1203
1204 /* Deselect and wake up anyone waiting on the device */
1205 onenand_release_device(mtd);
1206
1207 ops->oobretlen = read;
1208 return ret;
1209}
1210
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001211#ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
1212/**
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001213 * onenand_verify_oob - [GENERIC] verify the oob contents after a write
1214 * @param mtd MTD device structure
1215 * @param buf the databuffer to verify
1216 * @param to offset to read from
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001217 */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001218static int onenand_verify_oob(struct mtd_info *mtd, const u_char *buf, loff_t to)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001219{
1220 struct onenand_chip *this = mtd->priv;
Kyungmin Park91014e92007-02-12 10:34:39 +09001221 char oobbuf[64];
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001222 int status, i;
1223
1224 this->command(mtd, ONENAND_CMD_READOOB, to, mtd->oobsize);
1225 onenand_update_bufferram(mtd, to, 0);
1226 status = this->wait(mtd, FL_READING);
1227 if (status)
1228 return status;
1229
Kyungmin Park91014e92007-02-12 10:34:39 +09001230 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
1231 for (i = 0; i < mtd->oobsize; i++)
1232 if (buf[i] != 0xFF && buf[i] != oobbuf[i])
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001233 return -EBADMSG;
1234
1235 return 0;
1236}
1237
1238/**
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001239 * onenand_verify - [GENERIC] verify the chip contents after a write
1240 * @param mtd MTD device structure
1241 * @param buf the databuffer to verify
1242 * @param addr offset to read from
1243 * @param len number of bytes to read and compare
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001244 */
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001245static int onenand_verify(struct mtd_info *mtd, const u_char *buf, loff_t addr, size_t len)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001246{
1247 struct onenand_chip *this = mtd->priv;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001248 void __iomem *dataram;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001249 int ret = 0;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001250 int thislen, column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001251
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001252 while (len != 0) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001253 thislen = min_t(int, this->writesize, len);
1254 column = addr & (this->writesize - 1);
1255 if (column + thislen > this->writesize)
1256 thislen = this->writesize - column;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001257
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001258 this->command(mtd, ONENAND_CMD_READ, addr, this->writesize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001259
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001260 onenand_update_bufferram(mtd, addr, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001261
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001262 ret = this->wait(mtd, FL_READING);
1263 if (ret)
1264 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001265
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001266 onenand_update_bufferram(mtd, addr, 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001267
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001268 dataram = this->base + ONENAND_DATARAM;
1269 dataram += onenand_bufferram_offset(mtd, ONENAND_DATARAM);
1270
1271 if (memcmp(buf, dataram + column, thislen))
1272 return -EBADMSG;
1273
1274 len -= thislen;
1275 buf += thislen;
1276 addr += thislen;
1277 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001278
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001279 return 0;
1280}
1281#else
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001282#define onenand_verify(...) (0)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001283#define onenand_verify_oob(...) (0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001284#endif
1285
Kyungmin Park60d84f92006-12-22 16:21:54 +09001286#define NOTALIGNED(x) ((x & (this->subpagesize - 1)) != 0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001287
1288/**
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001289 * onenand_fill_auto_oob - [Internal] oob auto-placement transfer
1290 * @param mtd MTD device structure
1291 * @param oob_buf oob buffer
1292 * @param buf source address
1293 * @param column oob offset to write to
1294 * @param thislen oob length to write
1295 */
1296static int onenand_fill_auto_oob(struct mtd_info *mtd, u_char *oob_buf,
1297 const u_char *buf, int column, int thislen)
1298{
1299 struct onenand_chip *this = mtd->priv;
1300 struct nand_oobfree *free;
1301 int writecol = column;
1302 int writeend = column + thislen;
1303 int lastgap = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09001304 unsigned int i;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001305
Kyungmin Parkad286342007-03-23 10:19:52 +09001306 free = this->ecclayout->oobfree;
1307 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001308 if (writecol >= lastgap)
1309 writecol += free->offset - lastgap;
1310 if (writeend >= lastgap)
1311 writeend += free->offset - lastgap;
1312 lastgap = free->offset + free->length;
1313 }
Kyungmin Parkad286342007-03-23 10:19:52 +09001314 free = this->ecclayout->oobfree;
1315 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001316 int free_end = free->offset + free->length;
1317 if (free->offset < writeend && free_end > writecol) {
1318 int st = max_t(int,free->offset,writecol);
1319 int ed = min_t(int,free_end,writeend);
1320 int n = ed - st;
1321 memcpy(oob_buf + st, buf, n);
1322 buf += n;
Adrian Hunterc36c46d2007-03-23 17:16:22 +09001323 } else if (column == 0)
Kyungmin Park5bc399e2007-03-09 09:41:07 +09001324 break;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001325 }
1326 return 0;
1327}
1328
1329/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001330 * onenand_write_ops_nolock - [OneNAND Interface] write main and/or out-of-band
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001331 * @param mtd MTD device structure
1332 * @param to offset to write to
1333 * @param ops oob operation description structure
1334 *
1335 * Write main and/or oob with ECC
1336 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001337static int onenand_write_ops_nolock(struct mtd_info *mtd, loff_t to,
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001338 struct mtd_oob_ops *ops)
1339{
1340 struct onenand_chip *this = mtd->priv;
1341 int written = 0, column, thislen, subpage;
1342 int oobwritten = 0, oobcolumn, thisooblen, oobsize;
1343 size_t len = ops->len;
1344 size_t ooblen = ops->ooblen;
1345 const u_char *buf = ops->datbuf;
1346 const u_char *oob = ops->oobbuf;
1347 u_char *oobbuf;
1348 int ret = 0;
1349
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001350 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write_ops_nolock: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001351
1352 /* Initialize retlen, in case of early exit */
1353 ops->retlen = 0;
1354 ops->oobretlen = 0;
1355
1356 /* Do not allow writes past end of device */
1357 if (unlikely((to + len) > mtd->size)) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001358 printk(KERN_ERR "onenand_write_ops_nolock: Attempt write to past end of device\n");
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001359 return -EINVAL;
1360 }
1361
1362 /* Reject writes, which are not page aligned */
1363 if (unlikely(NOTALIGNED(to)) || unlikely(NOTALIGNED(len))) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001364 printk(KERN_ERR "onenand_write_ops_nolock: Attempt to write not page aligned data\n");
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001365 return -EINVAL;
1366 }
1367
1368 if (ops->mode == MTD_OOB_AUTO)
1369 oobsize = this->ecclayout->oobavail;
1370 else
1371 oobsize = mtd->oobsize;
1372
1373 oobcolumn = to & (mtd->oobsize - 1);
1374
1375 column = to & (mtd->writesize - 1);
1376
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001377 /* Loop until all data write */
1378 while (written < len) {
1379 u_char *wbuf = (u_char *) buf;
1380
1381 thislen = min_t(int, mtd->writesize - column, len - written);
1382 thisooblen = min_t(int, oobsize - oobcolumn, ooblen - oobwritten);
1383
1384 cond_resched();
1385
1386 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, thislen);
1387
1388 /* Partial page write */
1389 subpage = thislen < mtd->writesize;
1390 if (subpage) {
1391 memset(this->page_buf, 0xff, mtd->writesize);
1392 memcpy(this->page_buf + column, buf, thislen);
1393 wbuf = this->page_buf;
1394 }
1395
1396 this->write_bufferram(mtd, ONENAND_DATARAM, wbuf, 0, mtd->writesize);
1397
1398 if (oob) {
1399 oobbuf = this->oob_buf;
1400
1401 /* We send data to spare ram with oobsize
1402 * to prevent byte access */
1403 memset(oobbuf, 0xff, mtd->oobsize);
1404 if (ops->mode == MTD_OOB_AUTO)
1405 onenand_fill_auto_oob(mtd, oobbuf, oob, oobcolumn, thisooblen);
1406 else
1407 memcpy(oobbuf + oobcolumn, oob, thisooblen);
1408
1409 oobwritten += thisooblen;
1410 oob += thisooblen;
1411 oobcolumn = 0;
1412 } else
1413 oobbuf = (u_char *) ffchars;
1414
1415 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
1416
1417 this->command(mtd, ONENAND_CMD_PROG, to, mtd->writesize);
1418
1419 ret = this->wait(mtd, FL_WRITING);
1420
1421 /* In partial page write we don't update bufferram */
1422 onenand_update_bufferram(mtd, to, !ret && !subpage);
1423 if (ONENAND_IS_2PLANE(this)) {
1424 ONENAND_SET_BUFFERRAM1(this);
1425 onenand_update_bufferram(mtd, to + this->writesize, !ret && !subpage);
1426 }
1427
1428 if (ret) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001429 printk(KERN_ERR "onenand_write_ops_nolock: write filaed %d\n", ret);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001430 break;
1431 }
1432
1433 /* Only check verify write turn on */
1434 ret = onenand_verify(mtd, (u_char *) wbuf, to, thislen);
1435 if (ret) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001436 printk(KERN_ERR "onenand_write_ops_nolock: verify failed %d\n", ret);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001437 break;
1438 }
1439
1440 written += thislen;
1441
1442 if (written == len)
1443 break;
1444
1445 column = 0;
1446 to += thislen;
1447 buf += thislen;
1448 }
1449
1450 /* Deselect and wake up anyone waiting on the device */
1451 onenand_release_device(mtd);
1452
1453 ops->retlen = written;
1454
1455 return ret;
1456}
1457
1458
1459/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001460 * onenand_write_oob_nolock - [Internal] OneNAND write out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001461 * @param mtd MTD device structure
1462 * @param to offset to write to
1463 * @param len number of bytes to write
1464 * @param retlen pointer to variable to store the number of written bytes
1465 * @param buf the data to write
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001466 * @param mode operation mode
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001467 *
1468 * OneNAND write out-of-band
1469 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001470static int onenand_write_oob_nolock(struct mtd_info *mtd, loff_t to,
1471 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001472{
1473 struct onenand_chip *this = mtd->priv;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001474 int column, ret = 0, oobsize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001475 int written = 0;
Kyungmin Park91014e92007-02-12 10:34:39 +09001476 u_char *oobbuf;
Kyungmin Park12f77c92007-08-30 09:36:05 +09001477 size_t len = ops->ooblen;
1478 const u_char *buf = ops->oobbuf;
1479 mtd_oob_mode_t mode = ops->mode;
1480
1481 to += ops->ooboffs;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001482
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001483 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write_oob_nolock: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001484
1485 /* Initialize retlen, in case of early exit */
Kyungmin Park12f77c92007-08-30 09:36:05 +09001486 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001487
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001488 if (mode == MTD_OOB_AUTO)
1489 oobsize = this->ecclayout->oobavail;
1490 else
1491 oobsize = mtd->oobsize;
1492
1493 column = to & (mtd->oobsize - 1);
1494
1495 if (unlikely(column >= oobsize)) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001496 printk(KERN_ERR "onenand_write_oob_nolock: Attempted to start write outside oob\n");
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001497 return -EINVAL;
1498 }
1499
Adrian Hunter52e42002007-02-06 09:15:39 +09001500 /* For compatibility with NAND: Do not allow write past end of page */
Kyungmin Park91014e92007-02-12 10:34:39 +09001501 if (unlikely(column + len > oobsize)) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001502 printk(KERN_ERR "onenand_write_oob_nolock: "
Adrian Hunter52e42002007-02-06 09:15:39 +09001503 "Attempt to write past end of page\n");
1504 return -EINVAL;
1505 }
1506
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001507 /* Do not allow reads past end of device */
1508 if (unlikely(to >= mtd->size ||
1509 column + len > ((mtd->size >> this->page_shift) -
1510 (to >> this->page_shift)) * oobsize)) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001511 printk(KERN_ERR "onenand_write_oob_nolock: Attempted to write past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001512 return -EINVAL;
1513 }
1514
Kyungmin Park470bc842007-03-09 10:08:11 +09001515 oobbuf = this->oob_buf;
Kyungmin Park91014e92007-02-12 10:34:39 +09001516
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001517 /* Loop until all data write */
1518 while (written < len) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001519 int thislen = min_t(int, oobsize, len - written);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001520
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001521 cond_resched();
1522
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001523 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, mtd->oobsize);
1524
Kyungmin Park34c10602006-05-12 17:02:46 +03001525 /* We send data to spare ram with oobsize
1526 * to prevent byte access */
Kyungmin Park91014e92007-02-12 10:34:39 +09001527 memset(oobbuf, 0xff, mtd->oobsize);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001528 if (mode == MTD_OOB_AUTO)
Kyungmin Park91014e92007-02-12 10:34:39 +09001529 onenand_fill_auto_oob(mtd, oobbuf, buf, column, thislen);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001530 else
Kyungmin Park91014e92007-02-12 10:34:39 +09001531 memcpy(oobbuf + column, buf, thislen);
1532 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001533
1534 this->command(mtd, ONENAND_CMD_PROGOOB, to, mtd->oobsize);
1535
1536 onenand_update_bufferram(mtd, to, 0);
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001537 if (ONENAND_IS_2PLANE(this)) {
1538 ONENAND_SET_BUFFERRAM1(this);
1539 onenand_update_bufferram(mtd, to + this->writesize, 0);
1540 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001541
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001542 ret = this->wait(mtd, FL_WRITING);
1543 if (ret) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001544 printk(KERN_ERR "onenand_write_oob_nolock: write failed %d\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001545 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001546 }
1547
Kyungmin Park91014e92007-02-12 10:34:39 +09001548 ret = onenand_verify_oob(mtd, oobbuf, to);
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001549 if (ret) {
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001550 printk(KERN_ERR "onenand_write_oob_nolock: verify failed %d\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001551 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001552 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001553
1554 written += thislen;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001555 if (written == len)
1556 break;
1557
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001558 to += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001559 buf += thislen;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001560 column = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001561 }
1562
Kyungmin Park12f77c92007-08-30 09:36:05 +09001563 ops->oobretlen = written;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001564
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001565 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001566}
1567
1568/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001569 * onenand_write - [MTD Interface] write buffer to FLASH
1570 * @param mtd MTD device structure
1571 * @param to offset to write to
1572 * @param len number of bytes to write
1573 * @param retlen pointer to variable to store the number of written bytes
1574 * @param buf the data to write
1575 *
1576 * Write with ECC
1577 */
1578static int onenand_write(struct mtd_info *mtd, loff_t to, size_t len,
1579 size_t *retlen, const u_char *buf)
1580{
1581 struct mtd_oob_ops ops = {
1582 .len = len,
1583 .ooblen = 0,
1584 .datbuf = (u_char *) buf,
1585 .oobbuf = NULL,
1586 };
1587 int ret;
1588
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001589 onenand_get_device(mtd, FL_WRITING);
1590 ret = onenand_write_ops_nolock(mtd, to, &ops);
1591 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001592
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001593 *retlen = ops.retlen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001594 return ret;
1595}
1596
1597/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001598 * onenand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001599 * @param mtd: MTD device structure
1600 * @param to: offset to write
1601 * @param ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001602 */
1603static int onenand_write_oob(struct mtd_info *mtd, loff_t to,
1604 struct mtd_oob_ops *ops)
1605{
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001606 int ret;
1607
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001608 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001609 case MTD_OOB_PLACE:
1610 case MTD_OOB_AUTO:
1611 break;
1612 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001613 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001614 default:
1615 return -EINVAL;
1616 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001617
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001618 onenand_get_device(mtd, FL_WRITING);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001619 if (ops->datbuf)
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001620 ret = onenand_write_ops_nolock(mtd, to, ops);
1621 else
1622 ret = onenand_write_oob_nolock(mtd, to, ops);
1623 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001624
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001625 return ret;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001626}
1627
1628/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001629 * onenand_block_isbad_nolock - [GENERIC] Check if a block is marked bad
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001630 * @param mtd MTD device structure
1631 * @param ofs offset from device start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001632 * @param allowbbt 1, if its allowed to access the bbt area
1633 *
1634 * Check, if the block is bad. Either by reading the bad block table or
1635 * calling of the scan function.
1636 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001637static int onenand_block_isbad_nolock(struct mtd_info *mtd, loff_t ofs, int allowbbt)
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001638{
1639 struct onenand_chip *this = mtd->priv;
1640 struct bbm_info *bbm = this->bbm;
1641
1642 /* Return info from the table */
1643 return bbm->isbad_bbt(mtd, ofs, allowbbt);
1644}
1645
1646/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001647 * onenand_erase - [MTD Interface] erase block(s)
1648 * @param mtd MTD device structure
1649 * @param instr erase instruction
1650 *
1651 * Erase one ore more blocks
1652 */
1653static int onenand_erase(struct mtd_info *mtd, struct erase_info *instr)
1654{
1655 struct onenand_chip *this = mtd->priv;
1656 unsigned int block_size;
1657 loff_t addr;
1658 int len;
1659 int ret = 0;
1660
1661 DEBUG(MTD_DEBUG_LEVEL3, "onenand_erase: start = 0x%08x, len = %i\n", (unsigned int) instr->addr, (unsigned int) instr->len);
1662
1663 block_size = (1 << this->erase_shift);
1664
1665 /* Start address must align on block boundary */
1666 if (unlikely(instr->addr & (block_size - 1))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001667 printk(KERN_ERR "onenand_erase: Unaligned address\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001668 return -EINVAL;
1669 }
1670
1671 /* Length must align on block boundary */
1672 if (unlikely(instr->len & (block_size - 1))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001673 printk(KERN_ERR "onenand_erase: Length not block aligned\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001674 return -EINVAL;
1675 }
1676
1677 /* Do not allow erase past end of device */
1678 if (unlikely((instr->len + instr->addr) > mtd->size)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001679 printk(KERN_ERR "onenand_erase: Erase past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001680 return -EINVAL;
1681 }
1682
1683 instr->fail_addr = 0xffffffff;
1684
1685 /* Grab the lock and see if the device is available */
1686 onenand_get_device(mtd, FL_ERASING);
1687
1688 /* Loop throught the pages */
1689 len = instr->len;
1690 addr = instr->addr;
1691
1692 instr->state = MTD_ERASING;
1693
1694 while (len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001695 cond_resched();
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001696
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001697 /* Check if we have a bad block, we do not erase bad blocks */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001698 if (onenand_block_isbad_nolock(mtd, addr, 0)) {
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001699 printk (KERN_WARNING "onenand_erase: attempt to erase a bad block at addr 0x%08x\n", (unsigned int) addr);
1700 instr->state = MTD_ERASE_FAILED;
1701 goto erase_exit;
1702 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001703
1704 this->command(mtd, ONENAND_CMD_ERASE, addr, block_size);
1705
Adrian Hunter480b9df2007-02-07 13:55:19 +02001706 onenand_invalidate_bufferram(mtd, addr, block_size);
1707
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001708 ret = this->wait(mtd, FL_ERASING);
1709 /* Check, if it is write protected */
1710 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001711 printk(KERN_ERR "onenand_erase: Failed erase, block %d\n", (unsigned) (addr >> this->erase_shift));
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001712 instr->state = MTD_ERASE_FAILED;
1713 instr->fail_addr = addr;
1714 goto erase_exit;
1715 }
1716
1717 len -= block_size;
1718 addr += block_size;
1719 }
1720
1721 instr->state = MTD_ERASE_DONE;
1722
1723erase_exit:
1724
1725 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001726
1727 /* Deselect and wake up anyone waiting on the device */
1728 onenand_release_device(mtd);
1729
Adrian Hunter3cd3a862007-10-12 10:34:01 +03001730 /* Do call back function */
1731 if (!ret)
1732 mtd_erase_callback(instr);
1733
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001734 return ret;
1735}
1736
1737/**
1738 * onenand_sync - [MTD Interface] sync
1739 * @param mtd MTD device structure
1740 *
1741 * Sync is actually a wait for chip ready function
1742 */
1743static void onenand_sync(struct mtd_info *mtd)
1744{
1745 DEBUG(MTD_DEBUG_LEVEL3, "onenand_sync: called\n");
1746
1747 /* Grab the lock and see if the device is available */
1748 onenand_get_device(mtd, FL_SYNCING);
1749
1750 /* Release it and go back */
1751 onenand_release_device(mtd);
1752}
1753
1754/**
1755 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
1756 * @param mtd MTD device structure
1757 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001758 *
1759 * Check whether the block is bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001760 */
1761static int onenand_block_isbad(struct mtd_info *mtd, loff_t ofs)
1762{
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001763 int ret;
1764
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001765 /* Check for invalid offset */
1766 if (ofs > mtd->size)
1767 return -EINVAL;
1768
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001769 onenand_get_device(mtd, FL_READING);
1770 ret = onenand_block_isbad_nolock(mtd, ofs, 0);
1771 onenand_release_device(mtd);
1772 return ret;
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001773}
1774
1775/**
1776 * onenand_default_block_markbad - [DEFAULT] mark a block bad
1777 * @param mtd MTD device structure
1778 * @param ofs offset from device start
1779 *
1780 * This is the default implementation, which can be overridden by
1781 * a hardware specific driver.
1782 */
1783static int onenand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
1784{
1785 struct onenand_chip *this = mtd->priv;
1786 struct bbm_info *bbm = this->bbm;
1787 u_char buf[2] = {0, 0};
Kyungmin Park12f77c92007-08-30 09:36:05 +09001788 struct mtd_oob_ops ops = {
1789 .mode = MTD_OOB_PLACE,
1790 .ooblen = 2,
1791 .oobbuf = buf,
1792 .ooboffs = 0,
1793 };
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001794 int block;
1795
1796 /* Get block number */
1797 block = ((int) ofs) >> bbm->bbt_erase_shift;
1798 if (bbm->bbt)
1799 bbm->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
1800
1801 /* We write two bytes, so we dont have to mess with 16 bit access */
1802 ofs += mtd->oobsize + (bbm->badblockpos & ~0x01);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001803 return onenand_write_oob_nolock(mtd, ofs, &ops);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001804}
1805
1806/**
1807 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
1808 * @param mtd MTD device structure
1809 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001810 *
1811 * Mark the block as bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001812 */
1813static int onenand_block_markbad(struct mtd_info *mtd, loff_t ofs)
1814{
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001815 struct onenand_chip *this = mtd->priv;
1816 int ret;
1817
1818 ret = onenand_block_isbad(mtd, ofs);
1819 if (ret) {
1820 /* If it was bad already, return success and do nothing */
1821 if (ret > 0)
1822 return 0;
1823 return ret;
1824 }
1825
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001826 onenand_get_device(mtd, FL_WRITING);
1827 ret = this->block_markbad(mtd, ofs);
1828 onenand_release_device(mtd);
1829 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001830}
1831
1832/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09001833 * onenand_do_lock_cmd - [OneNAND Interface] Lock or unlock block(s)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001834 * @param mtd MTD device structure
1835 * @param ofs offset relative to mtd start
Kyungmin Park08f782b2006-11-16 11:29:39 +09001836 * @param len number of bytes to lock or unlock
Kyungmin Parke3da8062007-02-15 09:36:39 +09001837 * @param cmd lock or unlock command
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001838 *
Kyungmin Park08f782b2006-11-16 11:29:39 +09001839 * Lock or unlock one or more blocks
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001840 */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001841static int onenand_do_lock_cmd(struct mtd_info *mtd, loff_t ofs, size_t len, int cmd)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001842{
1843 struct onenand_chip *this = mtd->priv;
1844 int start, end, block, value, status;
Kyungmin Park08f782b2006-11-16 11:29:39 +09001845 int wp_status_mask;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001846
1847 start = ofs >> this->erase_shift;
1848 end = len >> this->erase_shift;
1849
Kyungmin Park08f782b2006-11-16 11:29:39 +09001850 if (cmd == ONENAND_CMD_LOCK)
1851 wp_status_mask = ONENAND_WP_LS;
1852 else
1853 wp_status_mask = ONENAND_WP_US;
1854
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001855 /* Continuous lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001856 if (this->options & ONENAND_HAS_CONT_LOCK) {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001857 /* Set start block address */
1858 this->write_word(start, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1859 /* Set end block address */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001860 this->write_word(start + end - 1, this->base + ONENAND_REG_END_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001861 /* Write lock command */
1862 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001863
1864 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001865 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001866
1867 /* Sanity check */
1868 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1869 & ONENAND_CTRL_ONGO)
1870 continue;
1871
1872 /* Check lock status */
1873 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001874 if (!(status & wp_status_mask))
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001875 printk(KERN_ERR "wp status = 0x%x\n", status);
1876
1877 return 0;
1878 }
1879
1880 /* Block lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001881 for (block = start; block < start + end; block++) {
Kyungmin Park20ba89a2005-12-16 11:17:29 +09001882 /* Set block address */
1883 value = onenand_block_address(this, block);
1884 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1885 /* Select DataRAM for DDP */
1886 value = onenand_bufferram_address(this, block);
1887 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001888 /* Set start block address */
1889 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001890 /* Write lock command */
1891 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001892
1893 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001894 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001895
1896 /* Sanity check */
1897 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1898 & ONENAND_CTRL_ONGO)
1899 continue;
1900
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001901 /* Check lock status */
1902 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001903 if (!(status & wp_status_mask))
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001904 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1905 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001906
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001907 return 0;
1908}
1909
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001910/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09001911 * onenand_lock - [MTD Interface] Lock block(s)
1912 * @param mtd MTD device structure
1913 * @param ofs offset relative to mtd start
1914 * @param len number of bytes to unlock
1915 *
1916 * Lock one or more blocks
1917 */
1918static int onenand_lock(struct mtd_info *mtd, loff_t ofs, size_t len)
1919{
Adrian Hunter34627f02007-10-12 10:19:26 +03001920 int ret;
1921
1922 onenand_get_device(mtd, FL_LOCKING);
1923 ret = onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_LOCK);
1924 onenand_release_device(mtd);
1925 return ret;
Kyungmin Park08f782b2006-11-16 11:29:39 +09001926}
1927
Kyungmin Park08f782b2006-11-16 11:29:39 +09001928/**
1929 * onenand_unlock - [MTD Interface] Unlock block(s)
1930 * @param mtd MTD device structure
1931 * @param ofs offset relative to mtd start
1932 * @param len number of bytes to unlock
1933 *
1934 * Unlock one or more blocks
1935 */
1936static int onenand_unlock(struct mtd_info *mtd, loff_t ofs, size_t len)
1937{
Adrian Hunter34627f02007-10-12 10:19:26 +03001938 int ret;
1939
1940 onenand_get_device(mtd, FL_LOCKING);
1941 ret = onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
1942 onenand_release_device(mtd);
1943 return ret;
Kyungmin Park08f782b2006-11-16 11:29:39 +09001944}
1945
1946/**
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001947 * onenand_check_lock_status - [OneNAND Interface] Check lock status
1948 * @param this onenand chip data structure
1949 *
1950 * Check lock status
1951 */
1952static void onenand_check_lock_status(struct onenand_chip *this)
1953{
1954 unsigned int value, block, status;
1955 unsigned int end;
1956
1957 end = this->chipsize >> this->erase_shift;
1958 for (block = 0; block < end; block++) {
1959 /* Set block address */
1960 value = onenand_block_address(this, block);
1961 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1962 /* Select DataRAM for DDP */
1963 value = onenand_bufferram_address(this, block);
1964 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
1965 /* Set start block address */
1966 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1967
1968 /* Check lock status */
1969 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
1970 if (!(status & ONENAND_WP_US))
1971 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1972 }
1973}
1974
1975/**
1976 * onenand_unlock_all - [OneNAND Interface] unlock all blocks
1977 * @param mtd MTD device structure
1978 *
1979 * Unlock all blocks
1980 */
1981static int onenand_unlock_all(struct mtd_info *mtd)
1982{
1983 struct onenand_chip *this = mtd->priv;
1984
1985 if (this->options & ONENAND_HAS_UNLOCK_ALL) {
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09001986 /* Set start block address */
1987 this->write_word(0, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001988 /* Write unlock command */
1989 this->command(mtd, ONENAND_CMD_UNLOCK_ALL, 0, 0);
1990
1991 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001992 this->wait(mtd, FL_LOCKING);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001993
1994 /* Sanity check */
1995 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1996 & ONENAND_CTRL_ONGO)
1997 continue;
1998
1999 /* Workaround for all block unlock in DDP */
Kyungmin Park738d61f2007-01-15 17:09:14 +09002000 if (ONENAND_IS_DDP(this)) {
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002001 /* 1st block on another chip */
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09002002 loff_t ofs = this->chipsize >> 1;
2003 size_t len = mtd->erasesize;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002004
Adrian Hunter34627f02007-10-12 10:19:26 +03002005 onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002006 }
2007
2008 onenand_check_lock_status(this);
2009
2010 return 0;
2011 }
2012
Adrian Hunter34627f02007-10-12 10:19:26 +03002013 onenand_do_lock_cmd(mtd, 0x0, this->chipsize, ONENAND_CMD_UNLOCK);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002014
2015 return 0;
2016}
2017
Kyungmin Park493c6462006-05-12 17:03:07 +03002018#ifdef CONFIG_MTD_ONENAND_OTP
2019
2020/* Interal OTP operation */
2021typedef int (*otp_op_t)(struct mtd_info *mtd, loff_t form, size_t len,
2022 size_t *retlen, u_char *buf);
2023
2024/**
2025 * do_otp_read - [DEFAULT] Read OTP block area
2026 * @param mtd MTD device structure
2027 * @param from The offset to read
2028 * @param len number of bytes to read
2029 * @param retlen pointer to variable to store the number of readbytes
2030 * @param buf the databuffer to put/get data
2031 *
2032 * Read OTP block area.
2033 */
2034static int do_otp_read(struct mtd_info *mtd, loff_t from, size_t len,
2035 size_t *retlen, u_char *buf)
2036{
2037 struct onenand_chip *this = mtd->priv;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002038 struct mtd_oob_ops ops = {
2039 .len = len,
2040 .ooblen = 0,
2041 .datbuf = buf,
2042 .oobbuf = NULL,
2043 };
Kyungmin Park493c6462006-05-12 17:03:07 +03002044 int ret;
2045
2046 /* Enter OTP access mode */
2047 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2048 this->wait(mtd, FL_OTPING);
2049
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002050 ret = onenand_read_ops_nolock(mtd, from, &ops);
Kyungmin Park493c6462006-05-12 17:03:07 +03002051
2052 /* Exit OTP access mode */
2053 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2054 this->wait(mtd, FL_RESETING);
2055
2056 return ret;
2057}
2058
2059/**
2060 * do_otp_write - [DEFAULT] Write OTP block area
2061 * @param mtd MTD device structure
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002062 * @param to The offset to write
Kyungmin Park493c6462006-05-12 17:03:07 +03002063 * @param len number of bytes to write
2064 * @param retlen pointer to variable to store the number of write bytes
2065 * @param buf the databuffer to put/get data
2066 *
2067 * Write OTP block area.
2068 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002069static int do_otp_write(struct mtd_info *mtd, loff_t to, size_t len,
Kyungmin Park493c6462006-05-12 17:03:07 +03002070 size_t *retlen, u_char *buf)
2071{
2072 struct onenand_chip *this = mtd->priv;
2073 unsigned char *pbuf = buf;
2074 int ret;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002075 struct mtd_oob_ops ops;
Kyungmin Park493c6462006-05-12 17:03:07 +03002076
2077 /* Force buffer page aligned */
Joern Engel28318772006-05-22 23:18:05 +02002078 if (len < mtd->writesize) {
Kyungmin Park493c6462006-05-12 17:03:07 +03002079 memcpy(this->page_buf, buf, len);
Joern Engel28318772006-05-22 23:18:05 +02002080 memset(this->page_buf + len, 0xff, mtd->writesize - len);
Kyungmin Park493c6462006-05-12 17:03:07 +03002081 pbuf = this->page_buf;
Joern Engel28318772006-05-22 23:18:05 +02002082 len = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002083 }
2084
2085 /* Enter OTP access mode */
2086 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2087 this->wait(mtd, FL_OTPING);
2088
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002089 ops.len = len;
2090 ops.ooblen = 0;
Kyungmin Park14370852007-10-10 13:48:14 +09002091 ops.datbuf = pbuf;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002092 ops.oobbuf = NULL;
2093 ret = onenand_write_ops_nolock(mtd, to, &ops);
2094 *retlen = ops.retlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03002095
2096 /* Exit OTP access mode */
2097 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2098 this->wait(mtd, FL_RESETING);
2099
2100 return ret;
2101}
2102
2103/**
2104 * do_otp_lock - [DEFAULT] Lock OTP block area
2105 * @param mtd MTD device structure
2106 * @param from The offset to lock
2107 * @param len number of bytes to lock
2108 * @param retlen pointer to variable to store the number of lock bytes
2109 * @param buf the databuffer to put/get data
2110 *
2111 * Lock OTP block area.
2112 */
2113static int do_otp_lock(struct mtd_info *mtd, loff_t from, size_t len,
2114 size_t *retlen, u_char *buf)
2115{
2116 struct onenand_chip *this = mtd->priv;
Kyungmin Park12f77c92007-08-30 09:36:05 +09002117 struct mtd_oob_ops ops = {
2118 .mode = MTD_OOB_PLACE,
2119 .ooblen = len,
2120 .oobbuf = buf,
2121 .ooboffs = 0,
2122 };
Kyungmin Park493c6462006-05-12 17:03:07 +03002123 int ret;
2124
2125 /* Enter OTP access mode */
2126 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2127 this->wait(mtd, FL_OTPING);
2128
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002129 ret = onenand_write_oob_nolock(mtd, from, &ops);
Kyungmin Park12f77c92007-08-30 09:36:05 +09002130
2131 *retlen = ops.oobretlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03002132
2133 /* Exit OTP access mode */
2134 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2135 this->wait(mtd, FL_RESETING);
2136
2137 return ret;
2138}
2139
2140/**
2141 * onenand_otp_walk - [DEFAULT] Handle OTP operation
2142 * @param mtd MTD device structure
2143 * @param from The offset to read/write
2144 * @param len number of bytes to read/write
2145 * @param retlen pointer to variable to store the number of read bytes
2146 * @param buf the databuffer to put/get data
2147 * @param action do given action
2148 * @param mode specify user and factory
2149 *
2150 * Handle OTP operation.
2151 */
2152static int onenand_otp_walk(struct mtd_info *mtd, loff_t from, size_t len,
2153 size_t *retlen, u_char *buf,
2154 otp_op_t action, int mode)
2155{
2156 struct onenand_chip *this = mtd->priv;
2157 int otp_pages;
2158 int density;
2159 int ret = 0;
2160
2161 *retlen = 0;
2162
2163 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2164 if (density < ONENAND_DEVICE_DENSITY_512Mb)
2165 otp_pages = 20;
2166 else
2167 otp_pages = 10;
2168
2169 if (mode == MTD_OTP_FACTORY) {
Joern Engel28318772006-05-22 23:18:05 +02002170 from += mtd->writesize * otp_pages;
Kyungmin Park493c6462006-05-12 17:03:07 +03002171 otp_pages = 64 - otp_pages;
2172 }
2173
2174 /* Check User/Factory boundary */
Joern Engel28318772006-05-22 23:18:05 +02002175 if (((mtd->writesize * otp_pages) - (from + len)) < 0)
Kyungmin Park493c6462006-05-12 17:03:07 +03002176 return 0;
2177
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002178 onenand_get_device(mtd, FL_OTPING);
Kyungmin Park493c6462006-05-12 17:03:07 +03002179 while (len > 0 && otp_pages > 0) {
2180 if (!action) { /* OTP Info functions */
2181 struct otp_info *otpinfo;
2182
2183 len -= sizeof(struct otp_info);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002184 if (len <= 0) {
2185 ret = -ENOSPC;
2186 break;
2187 }
Kyungmin Park493c6462006-05-12 17:03:07 +03002188
2189 otpinfo = (struct otp_info *) buf;
2190 otpinfo->start = from;
Joern Engel28318772006-05-22 23:18:05 +02002191 otpinfo->length = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002192 otpinfo->locked = 0;
2193
Joern Engel28318772006-05-22 23:18:05 +02002194 from += mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002195 buf += sizeof(struct otp_info);
2196 *retlen += sizeof(struct otp_info);
2197 } else {
2198 size_t tmp_retlen;
2199 int size = len;
2200
2201 ret = action(mtd, from, len, &tmp_retlen, buf);
2202
2203 buf += size;
2204 len -= size;
2205 *retlen += size;
2206
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002207 if (ret)
2208 break;
Kyungmin Park493c6462006-05-12 17:03:07 +03002209 }
2210 otp_pages--;
2211 }
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002212 onenand_release_device(mtd);
Kyungmin Park493c6462006-05-12 17:03:07 +03002213
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002214 return ret;
Kyungmin Park493c6462006-05-12 17:03:07 +03002215}
2216
2217/**
2218 * onenand_get_fact_prot_info - [MTD Interface] Read factory OTP info
2219 * @param mtd MTD device structure
2220 * @param buf the databuffer to put/get data
2221 * @param len number of bytes to read
2222 *
2223 * Read factory OTP info.
2224 */
2225static int onenand_get_fact_prot_info(struct mtd_info *mtd,
2226 struct otp_info *buf, size_t len)
2227{
2228 size_t retlen;
2229 int ret;
2230
2231 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_FACTORY);
2232
2233 return ret ? : retlen;
2234}
2235
2236/**
2237 * onenand_read_fact_prot_reg - [MTD Interface] Read factory OTP area
2238 * @param mtd MTD device structure
2239 * @param from The offset to read
2240 * @param len number of bytes to read
2241 * @param retlen pointer to variable to store the number of read bytes
2242 * @param buf the databuffer to put/get data
2243 *
2244 * Read factory OTP area.
2245 */
2246static int onenand_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
2247 size_t len, size_t *retlen, u_char *buf)
2248{
2249 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_FACTORY);
2250}
2251
2252/**
2253 * onenand_get_user_prot_info - [MTD Interface] Read user OTP info
2254 * @param mtd MTD device structure
2255 * @param buf the databuffer to put/get data
2256 * @param len number of bytes to read
2257 *
2258 * Read user OTP info.
2259 */
2260static int onenand_get_user_prot_info(struct mtd_info *mtd,
2261 struct otp_info *buf, size_t len)
2262{
2263 size_t retlen;
2264 int ret;
2265
2266 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_USER);
2267
2268 return ret ? : retlen;
2269}
2270
2271/**
2272 * onenand_read_user_prot_reg - [MTD Interface] Read user OTP area
2273 * @param mtd MTD device structure
2274 * @param from The offset to read
2275 * @param len number of bytes to read
2276 * @param retlen pointer to variable to store the number of read bytes
2277 * @param buf the databuffer to put/get data
2278 *
2279 * Read user OTP area.
2280 */
2281static int onenand_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
2282 size_t len, size_t *retlen, u_char *buf)
2283{
2284 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_USER);
2285}
2286
2287/**
2288 * onenand_write_user_prot_reg - [MTD Interface] Write user OTP area
2289 * @param mtd MTD device structure
2290 * @param from The offset to write
2291 * @param len number of bytes to write
2292 * @param retlen pointer to variable to store the number of write bytes
2293 * @param buf the databuffer to put/get data
2294 *
2295 * Write user OTP area.
2296 */
2297static int onenand_write_user_prot_reg(struct mtd_info *mtd, loff_t from,
2298 size_t len, size_t *retlen, u_char *buf)
2299{
2300 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_write, MTD_OTP_USER);
2301}
2302
2303/**
2304 * onenand_lock_user_prot_reg - [MTD Interface] Lock user OTP area
2305 * @param mtd MTD device structure
2306 * @param from The offset to lock
2307 * @param len number of bytes to unlock
2308 *
2309 * Write lock mark on spare area in page 0 in OTP block
2310 */
2311static int onenand_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
2312 size_t len)
2313{
2314 unsigned char oob_buf[64];
2315 size_t retlen;
2316 int ret;
2317
2318 memset(oob_buf, 0xff, mtd->oobsize);
2319 /*
2320 * Note: OTP lock operation
2321 * OTP block : 0xXXFC
2322 * 1st block : 0xXXF3 (If chip support)
2323 * Both : 0xXXF0 (If chip support)
2324 */
2325 oob_buf[ONENAND_OTP_LOCK_OFFSET] = 0xFC;
2326
2327 /*
2328 * Write lock mark to 8th word of sector0 of page0 of the spare0.
2329 * We write 16 bytes spare area instead of 2 bytes.
2330 */
2331 from = 0;
2332 len = 16;
2333
2334 ret = onenand_otp_walk(mtd, from, len, &retlen, oob_buf, do_otp_lock, MTD_OTP_USER);
2335
2336 return ret ? : retlen;
2337}
2338#endif /* CONFIG_MTD_ONENAND_OTP */
2339
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002340/**
Kyungmin Park75384b02007-01-18 11:10:57 +09002341 * onenand_check_features - Check and set OneNAND features
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002342 * @param mtd MTD data structure
2343 *
Kyungmin Park75384b02007-01-18 11:10:57 +09002344 * Check and set OneNAND features
2345 * - lock scheme
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002346 * - two plane
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002347 */
Kyungmin Park75384b02007-01-18 11:10:57 +09002348static void onenand_check_features(struct mtd_info *mtd)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002349{
2350 struct onenand_chip *this = mtd->priv;
2351 unsigned int density, process;
2352
2353 /* Lock scheme depends on density and process */
2354 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2355 process = this->version_id >> ONENAND_VERSION_PROCESS_SHIFT;
2356
2357 /* Lock scheme */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002358 switch (density) {
2359 case ONENAND_DEVICE_DENSITY_4Gb:
2360 this->options |= ONENAND_HAS_2PLANE;
2361
2362 case ONENAND_DEVICE_DENSITY_2Gb:
2363 /* 2Gb DDP don't have 2 plane */
2364 if (!ONENAND_IS_DDP(this))
2365 this->options |= ONENAND_HAS_2PLANE;
2366 this->options |= ONENAND_HAS_UNLOCK_ALL;
2367
2368 case ONENAND_DEVICE_DENSITY_1Gb:
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002369 /* A-Die has all block unlock */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002370 if (process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002371 this->options |= ONENAND_HAS_UNLOCK_ALL;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002372 break;
2373
2374 default:
2375 /* Some OneNAND has continuous lock scheme */
2376 if (!process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002377 this->options |= ONENAND_HAS_CONT_LOCK;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002378 break;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002379 }
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002380
2381 if (this->options & ONENAND_HAS_CONT_LOCK)
2382 printk(KERN_DEBUG "Lock scheme is Continuous Lock\n");
2383 if (this->options & ONENAND_HAS_UNLOCK_ALL)
2384 printk(KERN_DEBUG "Chip support all block unlock\n");
2385 if (this->options & ONENAND_HAS_2PLANE)
2386 printk(KERN_DEBUG "Chip has 2 plane\n");
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002387}
2388
2389/**
Kyungmin Parke3da8062007-02-15 09:36:39 +09002390 * onenand_print_device_info - Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002391 * @param device device ID
Kyungmin Parke3da8062007-02-15 09:36:39 +09002392 * @param version version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002393 *
Kyungmin Parke3da8062007-02-15 09:36:39 +09002394 * Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002395 */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002396static void onenand_print_device_info(int device, int version)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002397{
2398 int vcc, demuxed, ddp, density;
2399
2400 vcc = device & ONENAND_DEVICE_VCC_MASK;
2401 demuxed = device & ONENAND_DEVICE_IS_DEMUX;
2402 ddp = device & ONENAND_DEVICE_IS_DDP;
2403 density = device >> ONENAND_DEVICE_DENSITY_SHIFT;
2404 printk(KERN_INFO "%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
2405 demuxed ? "" : "Muxed ",
2406 ddp ? "(DDP)" : "",
2407 (16 << density),
2408 vcc ? "2.65/3.3" : "1.8",
2409 device);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002410 printk(KERN_INFO "OneNAND version = 0x%04x\n", version);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002411}
2412
2413static const struct onenand_manufacturers onenand_manuf_ids[] = {
2414 {ONENAND_MFR_SAMSUNG, "Samsung"},
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002415};
2416
2417/**
2418 * onenand_check_maf - Check manufacturer ID
2419 * @param manuf manufacturer ID
2420 *
2421 * Check manufacturer ID
2422 */
2423static int onenand_check_maf(int manuf)
2424{
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002425 int size = ARRAY_SIZE(onenand_manuf_ids);
2426 char *name;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002427 int i;
2428
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002429 for (i = 0; i < size; i++)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002430 if (manuf == onenand_manuf_ids[i].id)
2431 break;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002432
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002433 if (i < size)
2434 name = onenand_manuf_ids[i].name;
2435 else
2436 name = "Unknown";
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002437
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002438 printk(KERN_DEBUG "OneNAND Manufacturer: %s (0x%0x)\n", name, manuf);
2439
2440 return (i == size);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002441}
2442
2443/**
2444 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
2445 * @param mtd MTD device structure
2446 *
2447 * OneNAND detection method:
Michael Opdenacker59c51592007-05-09 08:57:56 +02002448 * Compare the values from command with ones from register
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002449 */
2450static int onenand_probe(struct mtd_info *mtd)
2451{
2452 struct onenand_chip *this = mtd->priv;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002453 int bram_maf_id, bram_dev_id, maf_id, dev_id, ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002454 int density;
Kyungmin Park47e777e2006-09-25 23:53:28 +00002455 int syscfg;
2456
2457 /* Save system configuration 1 */
2458 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
2459 /* Clear Sync. Burst Read mode to read BootRAM */
2460 this->write_word((syscfg & ~ONENAND_SYS_CFG1_SYNC_READ), this->base + ONENAND_REG_SYS_CFG1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002461
2462 /* Send the command for reading device ID from BootRAM */
2463 this->write_word(ONENAND_CMD_READID, this->base + ONENAND_BOOTRAM);
2464
2465 /* Read manufacturer and device IDs from BootRAM */
2466 bram_maf_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x0);
2467 bram_dev_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x2);
2468
Kyungmin Park47e777e2006-09-25 23:53:28 +00002469 /* Reset OneNAND to read default register values */
2470 this->write_word(ONENAND_CMD_RESET, this->base + ONENAND_BOOTRAM);
2471 /* Wait reset */
2472 this->wait(mtd, FL_RESETING);
2473
2474 /* Restore system configuration 1 */
2475 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
2476
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002477 /* Check manufacturer ID */
2478 if (onenand_check_maf(bram_maf_id))
2479 return -ENXIO;
2480
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002481 /* Read manufacturer and device IDs from Register */
2482 maf_id = this->read_word(this->base + ONENAND_REG_MANUFACTURER_ID);
2483 dev_id = this->read_word(this->base + ONENAND_REG_DEVICE_ID);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09002484 ver_id = this->read_word(this->base + ONENAND_REG_VERSION_ID);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002485
2486 /* Check OneNAND device */
2487 if (maf_id != bram_maf_id || dev_id != bram_dev_id)
2488 return -ENXIO;
2489
2490 /* Flash device information */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002491 onenand_print_device_info(dev_id, ver_id);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002492 this->device_id = dev_id;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002493 this->version_id = ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002494
2495 density = dev_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2496 this->chipsize = (16 << density) << 20;
Kyungmin Park83a36832005-09-29 04:53:16 +01002497 /* Set density mask. it is used for DDP */
Kyungmin Park738d61f2007-01-15 17:09:14 +09002498 if (ONENAND_IS_DDP(this))
2499 this->density_mask = (1 << (density + 6));
2500 else
2501 this->density_mask = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002502
2503 /* OneNAND page size & block size */
2504 /* The data buffer size is equal to page size */
Joern Engel28318772006-05-22 23:18:05 +02002505 mtd->writesize = this->read_word(this->base + ONENAND_REG_DATA_BUFFER_SIZE);
2506 mtd->oobsize = mtd->writesize >> 5;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09002507 /* Pages per a block are always 64 in OneNAND */
Joern Engel28318772006-05-22 23:18:05 +02002508 mtd->erasesize = mtd->writesize << 6;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002509
2510 this->erase_shift = ffs(mtd->erasesize) - 1;
Joern Engel28318772006-05-22 23:18:05 +02002511 this->page_shift = ffs(mtd->writesize) - 1;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09002512 this->page_mask = (1 << (this->erase_shift - this->page_shift)) - 1;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002513 /* It's real page size */
2514 this->writesize = mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002515
2516 /* REVIST: Multichip handling */
2517
2518 mtd->size = this->chipsize;
2519
Kyungmin Park75384b02007-01-18 11:10:57 +09002520 /* Check OneNAND features */
2521 onenand_check_features(mtd);
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002522
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002523 /*
2524 * We emulate the 4KiB page and 256KiB erase block size
2525 * But oobsize is still 64 bytes.
2526 * It is only valid if you turn on 2X program support,
2527 * Otherwise it will be ignored by compiler.
2528 */
2529 if (ONENAND_IS_2PLANE(this)) {
2530 mtd->writesize <<= 1;
2531 mtd->erasesize <<= 1;
2532 }
2533
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002534 return 0;
2535}
2536
Kyungmin Parka41371e2005-09-29 03:55:31 +01002537/**
2538 * onenand_suspend - [MTD Interface] Suspend the OneNAND flash
2539 * @param mtd MTD device structure
2540 */
2541static int onenand_suspend(struct mtd_info *mtd)
2542{
2543 return onenand_get_device(mtd, FL_PM_SUSPENDED);
2544}
2545
2546/**
2547 * onenand_resume - [MTD Interface] Resume the OneNAND flash
2548 * @param mtd MTD device structure
2549 */
2550static void onenand_resume(struct mtd_info *mtd)
2551{
2552 struct onenand_chip *this = mtd->priv;
2553
2554 if (this->state == FL_PM_SUSPENDED)
2555 onenand_release_device(mtd);
2556 else
2557 printk(KERN_ERR "resume() called for the chip which is not"
2558 "in suspended state\n");
2559}
2560
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002561/**
2562 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
2563 * @param mtd MTD device structure
2564 * @param maxchips Number of chips to scan for
2565 *
2566 * This fills out all the not initialized function pointers
2567 * with the defaults.
2568 * The flash ID is read and the mtd/chip structures are
2569 * filled with the appropriate values.
2570 */
2571int onenand_scan(struct mtd_info *mtd, int maxchips)
2572{
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002573 int i;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002574 struct onenand_chip *this = mtd->priv;
2575
2576 if (!this->read_word)
2577 this->read_word = onenand_readw;
2578 if (!this->write_word)
2579 this->write_word = onenand_writew;
2580
2581 if (!this->command)
2582 this->command = onenand_command;
2583 if (!this->wait)
Kyungmin Park2c221202006-11-16 11:23:48 +09002584 onenand_setup_wait(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002585
2586 if (!this->read_bufferram)
2587 this->read_bufferram = onenand_read_bufferram;
2588 if (!this->write_bufferram)
2589 this->write_bufferram = onenand_write_bufferram;
2590
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002591 if (!this->block_markbad)
2592 this->block_markbad = onenand_default_block_markbad;
2593 if (!this->scan_bbt)
2594 this->scan_bbt = onenand_default_bbt;
2595
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002596 if (onenand_probe(mtd))
2597 return -ENXIO;
2598
Kyungmin Park52b0eea2005-09-03 07:07:19 +01002599 /* Set Sync. Burst Read after probing */
2600 if (this->mmcontrol) {
2601 printk(KERN_INFO "OneNAND Sync. Burst Read support\n");
2602 this->read_bufferram = onenand_sync_read_bufferram;
2603 }
2604
Kyungmin Park532a37c2005-12-16 11:17:29 +09002605 /* Allocate buffers, if necessary */
2606 if (!this->page_buf) {
Kyungmin Park470bc842007-03-09 10:08:11 +09002607 this->page_buf = kzalloc(mtd->writesize, GFP_KERNEL);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002608 if (!this->page_buf) {
2609 printk(KERN_ERR "onenand_scan(): Can't allocate page_buf\n");
2610 return -ENOMEM;
2611 }
2612 this->options |= ONENAND_PAGEBUF_ALLOC;
2613 }
Kyungmin Park470bc842007-03-09 10:08:11 +09002614 if (!this->oob_buf) {
2615 this->oob_buf = kzalloc(mtd->oobsize, GFP_KERNEL);
2616 if (!this->oob_buf) {
2617 printk(KERN_ERR "onenand_scan(): Can't allocate oob_buf\n");
2618 if (this->options & ONENAND_PAGEBUF_ALLOC) {
2619 this->options &= ~ONENAND_PAGEBUF_ALLOC;
2620 kfree(this->page_buf);
2621 }
2622 return -ENOMEM;
2623 }
2624 this->options |= ONENAND_OOBBUF_ALLOC;
2625 }
Kyungmin Park532a37c2005-12-16 11:17:29 +09002626
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002627 this->state = FL_READY;
2628 init_waitqueue_head(&this->wq);
2629 spin_lock_init(&this->chip_lock);
2630
Kyungmin Park60d84f92006-12-22 16:21:54 +09002631 /*
2632 * Allow subpage writes up to oobsize.
2633 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002634 switch (mtd->oobsize) {
2635 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002636 this->ecclayout = &onenand_oob_64;
Kyungmin Park60d84f92006-12-22 16:21:54 +09002637 mtd->subpage_sft = 2;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002638 break;
2639
2640 case 32:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002641 this->ecclayout = &onenand_oob_32;
Kyungmin Park60d84f92006-12-22 16:21:54 +09002642 mtd->subpage_sft = 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002643 break;
2644
2645 default:
2646 printk(KERN_WARNING "No OOB scheme defined for oobsize %d\n",
2647 mtd->oobsize);
Kyungmin Park60d84f92006-12-22 16:21:54 +09002648 mtd->subpage_sft = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002649 /* To prevent kernel oops */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002650 this->ecclayout = &onenand_oob_32;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002651 break;
2652 }
2653
Kyungmin Park60d84f92006-12-22 16:21:54 +09002654 this->subpagesize = mtd->writesize >> mtd->subpage_sft;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002655
2656 /*
2657 * The number of bytes available for a client to place data into
2658 * the out of band area
2659 */
2660 this->ecclayout->oobavail = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09002661 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES &&
2662 this->ecclayout->oobfree[i].length; i++)
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002663 this->ecclayout->oobavail +=
2664 this->ecclayout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03002665 mtd->oobavail = this->ecclayout->oobavail;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002666
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002667 mtd->ecclayout = this->ecclayout;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002668
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002669 /* Fill in remaining MTD driver data */
2670 mtd->type = MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02002671 mtd->flags = MTD_CAP_NANDFLASH;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002672 mtd->erase = onenand_erase;
2673 mtd->point = NULL;
2674 mtd->unpoint = NULL;
2675 mtd->read = onenand_read;
2676 mtd->write = onenand_write;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002677 mtd->read_oob = onenand_read_oob;
2678 mtd->write_oob = onenand_write_oob;
Kyungmin Park493c6462006-05-12 17:03:07 +03002679#ifdef CONFIG_MTD_ONENAND_OTP
2680 mtd->get_fact_prot_info = onenand_get_fact_prot_info;
2681 mtd->read_fact_prot_reg = onenand_read_fact_prot_reg;
2682 mtd->get_user_prot_info = onenand_get_user_prot_info;
2683 mtd->read_user_prot_reg = onenand_read_user_prot_reg;
2684 mtd->write_user_prot_reg = onenand_write_user_prot_reg;
2685 mtd->lock_user_prot_reg = onenand_lock_user_prot_reg;
2686#endif
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002687 mtd->sync = onenand_sync;
Kyungmin Park08f782b2006-11-16 11:29:39 +09002688 mtd->lock = onenand_lock;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002689 mtd->unlock = onenand_unlock;
Kyungmin Parka41371e2005-09-29 03:55:31 +01002690 mtd->suspend = onenand_suspend;
2691 mtd->resume = onenand_resume;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002692 mtd->block_isbad = onenand_block_isbad;
2693 mtd->block_markbad = onenand_block_markbad;
2694 mtd->owner = THIS_MODULE;
2695
2696 /* Unlock whole block */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002697 onenand_unlock_all(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002698
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002699 return this->scan_bbt(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002700}
2701
2702/**
2703 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
2704 * @param mtd MTD device structure
2705 */
2706void onenand_release(struct mtd_info *mtd)
2707{
Kyungmin Park532a37c2005-12-16 11:17:29 +09002708 struct onenand_chip *this = mtd->priv;
2709
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002710#ifdef CONFIG_MTD_PARTITIONS
2711 /* Deregister partitions */
2712 del_mtd_partitions (mtd);
2713#endif
2714 /* Deregister the device */
2715 del_mtd_device (mtd);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002716
2717 /* Free bad block table memory, if allocated */
Adrian Hunterf00b0042007-01-22 17:01:01 +09002718 if (this->bbm) {
2719 struct bbm_info *bbm = this->bbm;
2720 kfree(bbm->bbt);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002721 kfree(this->bbm);
Adrian Hunterf00b0042007-01-22 17:01:01 +09002722 }
Kyungmin Park470bc842007-03-09 10:08:11 +09002723 /* Buffers allocated by onenand_scan */
Kyungmin Park532a37c2005-12-16 11:17:29 +09002724 if (this->options & ONENAND_PAGEBUF_ALLOC)
2725 kfree(this->page_buf);
Kyungmin Park470bc842007-03-09 10:08:11 +09002726 if (this->options & ONENAND_OOBBUF_ALLOC)
2727 kfree(this->oob_buf);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002728}
2729
2730EXPORT_SYMBOL_GPL(onenand_scan);
2731EXPORT_SYMBOL_GPL(onenand_release);
2732
2733MODULE_LICENSE("GPL");
2734MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
2735MODULE_DESCRIPTION("Generic OneNAND flash driver code");