blob: 45bc1433b28d58a9ed7d2b23a33a82bffa3fa0cd [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");
Kyungmin Parkf6272482006-12-22 16:02:50 +0900330 return ctrl;
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 Park211ac752007-02-07 12:15:01 +0900336 printk(KERN_ERR "onenand_wait: ECC error = 0x%04x\n", ecc);
Kyungmin Parkb3c9f8b2007-01-05 19:16:04 +0900337 if (ecc & ONENAND_ECC_2BIT_ALL) {
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900338 mtd->ecc_stats.failed++;
Kyungmin Parkb3c9f8b2007-01-05 19:16:04 +0900339 return ecc;
340 } else if (ecc & ONENAND_ECC_1BIT_ALL)
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900341 mtd->ecc_stats.corrected++;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100342 }
Adrian Hunter9d032802007-01-10 07:51:26 +0200343 } else if (state == FL_READING) {
344 printk(KERN_ERR "onenand_wait: read timeout! ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
345 return -EIO;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100346 }
347
348 return 0;
349}
350
Kyungmin Park2c221202006-11-16 11:23:48 +0900351/*
352 * onenand_interrupt - [DEFAULT] onenand interrupt handler
353 * @param irq onenand interrupt number
354 * @param dev_id interrupt data
355 *
356 * complete the work
357 */
358static irqreturn_t onenand_interrupt(int irq, void *data)
359{
360 struct onenand_chip *this = (struct onenand_chip *) data;
361
362 /* To handle shared interrupt */
363 if (!this->complete.done)
364 complete(&this->complete);
365
366 return IRQ_HANDLED;
367}
368
369/*
370 * onenand_interrupt_wait - [DEFAULT] wait until the command is done
371 * @param mtd MTD device structure
372 * @param state state to select the max. timeout value
373 *
374 * Wait for command done.
375 */
376static int onenand_interrupt_wait(struct mtd_info *mtd, int state)
377{
378 struct onenand_chip *this = mtd->priv;
379
Kyungmin Park2c221202006-11-16 11:23:48 +0900380 wait_for_completion(&this->complete);
381
382 return onenand_wait(mtd, state);
383}
384
385/*
386 * onenand_try_interrupt_wait - [DEFAULT] try interrupt wait
387 * @param mtd MTD device structure
388 * @param state state to select the max. timeout value
389 *
390 * Try interrupt based wait (It is used one-time)
391 */
392static int onenand_try_interrupt_wait(struct mtd_info *mtd, int state)
393{
394 struct onenand_chip *this = mtd->priv;
395 unsigned long remain, timeout;
396
397 /* We use interrupt wait first */
398 this->wait = onenand_interrupt_wait;
399
Kyungmin Park2c221202006-11-16 11:23:48 +0900400 timeout = msecs_to_jiffies(100);
401 remain = wait_for_completion_timeout(&this->complete, timeout);
402 if (!remain) {
403 printk(KERN_INFO "OneNAND: There's no interrupt. "
404 "We use the normal wait\n");
405
406 /* Release the irq */
407 free_irq(this->irq, this);
David Woodhousec9ac5972006-11-30 08:17:38 +0000408
Kyungmin Park2c221202006-11-16 11:23:48 +0900409 this->wait = onenand_wait;
410 }
411
412 return onenand_wait(mtd, state);
413}
414
415/*
416 * onenand_setup_wait - [OneNAND Interface] setup onenand wait method
417 * @param mtd MTD device structure
418 *
419 * There's two method to wait onenand work
420 * 1. polling - read interrupt status register
421 * 2. interrupt - use the kernel interrupt method
422 */
423static void onenand_setup_wait(struct mtd_info *mtd)
424{
425 struct onenand_chip *this = mtd->priv;
426 int syscfg;
427
428 init_completion(&this->complete);
429
430 if (this->irq <= 0) {
431 this->wait = onenand_wait;
432 return;
433 }
434
435 if (request_irq(this->irq, &onenand_interrupt,
436 IRQF_SHARED, "onenand", this)) {
437 /* If we can't get irq, use the normal wait */
438 this->wait = onenand_wait;
439 return;
440 }
441
442 /* Enable interrupt */
443 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
444 syscfg |= ONENAND_SYS_CFG1_IOBE;
445 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
446
447 this->wait = onenand_try_interrupt_wait;
448}
449
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100450/**
451 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
452 * @param mtd MTD data structure
453 * @param area BufferRAM area
454 * @return offset given area
455 *
456 * Return BufferRAM offset given area
457 */
458static inline int onenand_bufferram_offset(struct mtd_info *mtd, int area)
459{
460 struct onenand_chip *this = mtd->priv;
461
462 if (ONENAND_CURRENT_BUFFERRAM(this)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900463 /* Note: the 'this->writesize' is a real page size */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100464 if (area == ONENAND_DATARAM)
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900465 return this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100466 if (area == ONENAND_SPARERAM)
467 return mtd->oobsize;
468 }
469
470 return 0;
471}
472
473/**
474 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area
475 * @param mtd MTD data structure
476 * @param area BufferRAM area
477 * @param buffer the databuffer to put/get data
478 * @param offset offset to read from or write to
479 * @param count number of bytes to read/write
480 *
481 * Read the BufferRAM area
482 */
483static int onenand_read_bufferram(struct mtd_info *mtd, int area,
484 unsigned char *buffer, int offset, size_t count)
485{
486 struct onenand_chip *this = mtd->priv;
487 void __iomem *bufferram;
488
489 bufferram = this->base + area;
490
491 bufferram += onenand_bufferram_offset(mtd, area);
492
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300493 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
494 unsigned short word;
495
496 /* Align with word(16-bit) size */
497 count--;
498
499 /* Read word and save byte */
500 word = this->read_word(bufferram + offset + count);
501 buffer[count] = (word & 0xff);
502 }
503
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100504 memcpy(buffer, bufferram + offset, count);
505
506 return 0;
507}
508
509/**
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100510 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode
511 * @param mtd MTD data structure
512 * @param area BufferRAM area
513 * @param buffer the databuffer to put/get data
514 * @param offset offset to read from or write to
515 * @param count number of bytes to read/write
516 *
517 * Read the BufferRAM area with Sync. Burst Mode
518 */
519static int onenand_sync_read_bufferram(struct mtd_info *mtd, int area,
520 unsigned char *buffer, int offset, size_t count)
521{
522 struct onenand_chip *this = mtd->priv;
523 void __iomem *bufferram;
524
525 bufferram = this->base + area;
526
527 bufferram += onenand_bufferram_offset(mtd, area);
528
529 this->mmcontrol(mtd, ONENAND_SYS_CFG1_SYNC_READ);
530
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300531 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
532 unsigned short word;
533
534 /* Align with word(16-bit) size */
535 count--;
536
537 /* Read word and save byte */
538 word = this->read_word(bufferram + offset + count);
539 buffer[count] = (word & 0xff);
540 }
541
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100542 memcpy(buffer, bufferram + offset, count);
543
544 this->mmcontrol(mtd, 0);
545
546 return 0;
547}
548
549/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100550 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area
551 * @param mtd MTD data structure
552 * @param area BufferRAM area
553 * @param buffer the databuffer to put/get data
554 * @param offset offset to read from or write to
555 * @param count number of bytes to read/write
556 *
557 * Write the BufferRAM area
558 */
559static int onenand_write_bufferram(struct mtd_info *mtd, int area,
560 const unsigned char *buffer, int offset, size_t count)
561{
562 struct onenand_chip *this = mtd->priv;
563 void __iomem *bufferram;
564
565 bufferram = this->base + area;
566
567 bufferram += onenand_bufferram_offset(mtd, area);
568
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300569 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
570 unsigned short word;
571 int byte_offset;
572
573 /* Align with word(16-bit) size */
574 count--;
575
576 /* Calculate byte access offset */
577 byte_offset = offset + count;
578
579 /* Read word and save byte */
580 word = this->read_word(bufferram + byte_offset);
581 word = (word & ~0xff) | buffer[count];
582 this->write_word(word, bufferram + byte_offset);
583 }
584
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100585 memcpy(bufferram + offset, buffer, count);
586
587 return 0;
588}
589
590/**
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900591 * onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode
592 * @param mtd MTD data structure
593 * @param addr address to check
594 * @return blockpage address
595 *
596 * Get blockpage address at 2x program mode
597 */
598static int onenand_get_2x_blockpage(struct mtd_info *mtd, loff_t addr)
599{
600 struct onenand_chip *this = mtd->priv;
601 int blockpage, block, page;
602
603 /* Calculate the even block number */
604 block = (int) (addr >> this->erase_shift) & ~1;
605 /* Is it the odd plane? */
606 if (addr & this->writesize)
607 block++;
608 page = (int) (addr >> (this->page_shift + 1)) & this->page_mask;
609 blockpage = (block << 7) | page;
610
611 return blockpage;
612}
613
614/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100615 * onenand_check_bufferram - [GENERIC] Check BufferRAM information
616 * @param mtd MTD data structure
617 * @param addr address to check
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000618 * @return 1 if there are valid data, otherwise 0
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100619 *
620 * Check bufferram if there is data we required
621 */
622static int onenand_check_bufferram(struct mtd_info *mtd, loff_t addr)
623{
624 struct onenand_chip *this = mtd->priv;
Adrian Huntercde36b32007-02-08 10:28:08 +0200625 int blockpage, found = 0;
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900626 unsigned int i;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000627
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900628 if (ONENAND_IS_2PLANE(this))
629 blockpage = onenand_get_2x_blockpage(mtd, addr);
630 else
631 blockpage = (int) (addr >> this->page_shift);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100632
633 /* Is there valid data? */
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900634 i = ONENAND_CURRENT_BUFFERRAM(this);
635 if (this->bufferram[i].blockpage == blockpage)
Adrian Huntercde36b32007-02-08 10:28:08 +0200636 found = 1;
637 else {
638 /* Check another BufferRAM */
639 i = ONENAND_NEXT_BUFFERRAM(this);
640 if (this->bufferram[i].blockpage == blockpage) {
641 ONENAND_SET_NEXT_BUFFERRAM(this);
642 found = 1;
643 }
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900644 }
645
Adrian Huntercde36b32007-02-08 10:28:08 +0200646 if (found && ONENAND_IS_DDP(this)) {
647 /* Select DataRAM for DDP */
648 int block = (int) (addr >> this->erase_shift);
649 int value = onenand_bufferram_address(this, block);
650 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
651 }
652
653 return found;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100654}
655
656/**
657 * onenand_update_bufferram - [GENERIC] Update BufferRAM information
658 * @param mtd MTD data structure
659 * @param addr address to update
660 * @param valid valid flag
661 *
662 * Update BufferRAM information
663 */
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900664static void onenand_update_bufferram(struct mtd_info *mtd, loff_t addr,
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100665 int valid)
666{
667 struct onenand_chip *this = mtd->priv;
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900668 int blockpage;
669 unsigned int i;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000670
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900671 if (ONENAND_IS_2PLANE(this))
672 blockpage = onenand_get_2x_blockpage(mtd, addr);
673 else
674 blockpage = (int) (addr >> this->page_shift);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100675
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900676 /* Invalidate another BufferRAM */
677 i = ONENAND_NEXT_BUFFERRAM(this);
Kyungmin Park5b4246f2007-02-02 09:39:21 +0900678 if (this->bufferram[i].blockpage == blockpage)
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900679 this->bufferram[i].blockpage = -1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100680
681 /* Update BufferRAM */
682 i = ONENAND_CURRENT_BUFFERRAM(this);
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900683 if (valid)
684 this->bufferram[i].blockpage = blockpage;
685 else
686 this->bufferram[i].blockpage = -1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100687}
688
689/**
Adrian Hunter480b9df2007-02-07 13:55:19 +0200690 * onenand_invalidate_bufferram - [GENERIC] Invalidate BufferRAM information
691 * @param mtd MTD data structure
692 * @param addr start address to invalidate
693 * @param len length to invalidate
694 *
695 * Invalidate BufferRAM information
696 */
697static void onenand_invalidate_bufferram(struct mtd_info *mtd, loff_t addr,
698 unsigned int len)
699{
700 struct onenand_chip *this = mtd->priv;
701 int i;
702 loff_t end_addr = addr + len;
703
704 /* Invalidate BufferRAM */
705 for (i = 0; i < MAX_BUFFERRAM; i++) {
706 loff_t buf_addr = this->bufferram[i].blockpage << this->page_shift;
707 if (buf_addr >= addr && buf_addr < end_addr)
708 this->bufferram[i].blockpage = -1;
709 }
710}
711
712/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100713 * onenand_get_device - [GENERIC] Get chip for selected access
714 * @param mtd MTD device structure
715 * @param new_state the state which is requested
716 *
717 * Get the device and lock it for exclusive access
718 */
Kyungmin Parka41371e2005-09-29 03:55:31 +0100719static int onenand_get_device(struct mtd_info *mtd, int new_state)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100720{
721 struct onenand_chip *this = mtd->priv;
722 DECLARE_WAITQUEUE(wait, current);
723
724 /*
725 * Grab the lock and see if the device is available
726 */
727 while (1) {
728 spin_lock(&this->chip_lock);
729 if (this->state == FL_READY) {
730 this->state = new_state;
731 spin_unlock(&this->chip_lock);
732 break;
733 }
Kyungmin Parka41371e2005-09-29 03:55:31 +0100734 if (new_state == FL_PM_SUSPENDED) {
735 spin_unlock(&this->chip_lock);
736 return (this->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
737 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100738 set_current_state(TASK_UNINTERRUPTIBLE);
739 add_wait_queue(&this->wq, &wait);
740 spin_unlock(&this->chip_lock);
741 schedule();
742 remove_wait_queue(&this->wq, &wait);
743 }
Kyungmin Parka41371e2005-09-29 03:55:31 +0100744
745 return 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100746}
747
748/**
749 * onenand_release_device - [GENERIC] release chip
750 * @param mtd MTD device structure
751 *
752 * Deselect, release chip lock and wake up anyone waiting on the device
753 */
754static void onenand_release_device(struct mtd_info *mtd)
755{
756 struct onenand_chip *this = mtd->priv;
757
758 /* Release the chip */
759 spin_lock(&this->chip_lock);
760 this->state = FL_READY;
761 wake_up(&this->wq);
762 spin_unlock(&this->chip_lock);
763}
764
765/**
Thomas Gleixner9223a452006-05-23 17:21:03 +0200766 * onenand_read - [MTD Interface] Read data from flash
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100767 * @param mtd MTD device structure
768 * @param from offset to read from
769 * @param len number of bytes to read
770 * @param retlen pointer to variable to store the number of read bytes
771 * @param buf the databuffer to put data
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100772 *
Thomas Gleixner9223a452006-05-23 17:21:03 +0200773 * Read with ecc
774*/
775static int onenand_read(struct mtd_info *mtd, loff_t from, size_t len,
776 size_t *retlen, u_char *buf)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100777{
778 struct onenand_chip *this = mtd->priv;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900779 struct mtd_ecc_stats stats;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100780 int read = 0, column;
781 int thislen;
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200782 int ret = 0, boundary = 0;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900783 int writesize = this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100784
Thomas Gleixner9223a452006-05-23 17:21:03 +0200785 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100786
787 /* Do not allow reads past end of device */
788 if ((from + len) > mtd->size) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900789 printk(KERN_ERR "onenand_read: Attempt read beyond end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100790 *retlen = 0;
791 return -EINVAL;
792 }
793
794 /* Grab the lock and see if the device is available */
795 onenand_get_device(mtd, FL_READING);
796
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900797 stats = mtd->ecc_stats;
Artem Bityutskiy61a7e192006-12-26 16:41:24 +0900798
Adrian Huntera8de85d2007-01-04 09:51:26 +0200799 /* Read-while-load method */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100800
Adrian Huntera8de85d2007-01-04 09:51:26 +0200801 /* Do first load to bufferRAM */
802 if (read < len) {
803 if (!onenand_check_bufferram(mtd, from)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900804 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200805 ret = this->wait(mtd, FL_READING);
806 onenand_update_bufferram(mtd, from, !ret);
807 }
808 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100809
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900810 thislen = min_t(int, writesize, len - read);
811 column = from & (writesize - 1);
812 if (column + thislen > writesize)
813 thislen = writesize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100814
Adrian Huntera8de85d2007-01-04 09:51:26 +0200815 while (!ret) {
816 /* If there is more to load then start next load */
817 from += thislen;
818 if (read + thislen < len) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900819 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200820 /*
821 * Chip boundary handling in DDP
822 * Now we issued chip 1 read and pointed chip 1
823 * bufferam so we have to point chip 0 bufferam.
824 */
Kyungmin Park738d61f2007-01-15 17:09:14 +0900825 if (ONENAND_IS_DDP(this) &&
826 unlikely(from == (this->chipsize >> 1))) {
827 this->write_word(ONENAND_DDP_CHIP0, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200828 boundary = 1;
829 } else
830 boundary = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +0200831 ONENAND_SET_PREV_BUFFERRAM(this);
832 }
833 /* While load is going, read from last bufferRAM */
834 this->read_bufferram(mtd, ONENAND_DATARAM, buf, column, thislen);
835 /* See if we are done */
836 read += thislen;
837 if (read == len)
838 break;
839 /* Set up for next read from bufferRAM */
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200840 if (unlikely(boundary))
Kyungmin Park738d61f2007-01-15 17:09:14 +0900841 this->write_word(ONENAND_DDP_CHIP1, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200842 ONENAND_SET_NEXT_BUFFERRAM(this);
843 buf += thislen;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900844 thislen = min_t(int, writesize, len - read);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200845 column = 0;
846 cond_resched();
847 /* Now wait for load */
848 ret = this->wait(mtd, FL_READING);
849 onenand_update_bufferram(mtd, from, !ret);
850 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100851
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100852 /* Deselect and wake up anyone waiting on the device */
853 onenand_release_device(mtd);
854
855 /*
856 * Return success, if no ECC failures, else -EBADMSG
857 * fs driver will take care of that, because
858 * retlen == desired len and result == -EBADMSG
859 */
860 *retlen = read;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900861
862 if (mtd->ecc_stats.failed - stats.failed)
863 return -EBADMSG;
864
Adrian Huntera8de85d2007-01-04 09:51:26 +0200865 if (ret)
866 return ret;
867
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900868 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100869}
870
871/**
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200872 * onenand_transfer_auto_oob - [Internal] oob auto-placement transfer
873 * @param mtd MTD device structure
874 * @param buf destination address
875 * @param column oob offset to read from
876 * @param thislen oob length to read
877 */
878static int onenand_transfer_auto_oob(struct mtd_info *mtd, uint8_t *buf, int column,
879 int thislen)
880{
881 struct onenand_chip *this = mtd->priv;
882 struct nand_oobfree *free;
883 int readcol = column;
884 int readend = column + thislen;
885 int lastgap = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +0900886 unsigned int i;
Kyungmin Park470bc842007-03-09 10:08:11 +0900887 uint8_t *oob_buf = this->oob_buf;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200888
Kyungmin Parkad286342007-03-23 10:19:52 +0900889 free = this->ecclayout->oobfree;
890 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200891 if (readcol >= lastgap)
892 readcol += free->offset - lastgap;
893 if (readend >= lastgap)
894 readend += free->offset - lastgap;
895 lastgap = free->offset + free->length;
896 }
Kyungmin Park4f4fad22007-02-02 09:22:21 +0900897 this->read_bufferram(mtd, ONENAND_SPARERAM, oob_buf, 0, mtd->oobsize);
Kyungmin Parkad286342007-03-23 10:19:52 +0900898 free = this->ecclayout->oobfree;
899 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200900 int free_end = free->offset + free->length;
901 if (free->offset < readend && free_end > readcol) {
902 int st = max_t(int,free->offset,readcol);
903 int ed = min_t(int,free_end,readend);
904 int n = ed - st;
905 memcpy(buf, oob_buf + st, n);
906 buf += n;
Adrian Hunterc36c46d2007-03-23 17:16:22 +0900907 } else if (column == 0)
Kyungmin Park5bc399e2007-03-09 09:41:07 +0900908 break;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200909 }
910 return 0;
911}
912
913/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200914 * onenand_do_read_oob - [MTD Interface] OneNAND read out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100915 * @param mtd MTD device structure
916 * @param from offset to read from
917 * @param len number of bytes to read
918 * @param retlen pointer to variable to store the number of read bytes
919 * @param buf the databuffer to put data
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200920 * @param mode operation mode
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100921 *
922 * OneNAND read out-of-band data from the spare area
923 */
Kyungmin Park12f77c92007-08-30 09:36:05 +0900924static int onenand_do_read_oob(struct mtd_info *mtd, loff_t from,
925 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100926{
927 struct onenand_chip *this = mtd->priv;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200928 int read = 0, thislen, column, oobsize;
Kyungmin Park12f77c92007-08-30 09:36:05 +0900929 size_t len = ops->ooblen;
930 mtd_oob_mode_t mode = ops->mode;
931 u_char *buf = ops->oobbuf;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100932 int ret = 0;
933
Kyungmin Park12f77c92007-08-30 09:36:05 +0900934 from += ops->ooboffs;
935
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100936 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read_oob: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
937
938 /* Initialize return length value */
Kyungmin Park12f77c92007-08-30 09:36:05 +0900939 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100940
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200941 if (mode == MTD_OOB_AUTO)
942 oobsize = this->ecclayout->oobavail;
943 else
944 oobsize = mtd->oobsize;
945
946 column = from & (mtd->oobsize - 1);
947
948 if (unlikely(column >= oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900949 printk(KERN_ERR "onenand_read_oob: Attempted to start read outside oob\n");
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200950 return -EINVAL;
951 }
952
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100953 /* Do not allow reads past end of device */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200954 if (unlikely(from >= mtd->size ||
955 column + len > ((mtd->size >> this->page_shift) -
956 (from >> this->page_shift)) * oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900957 printk(KERN_ERR "onenand_read_oob: Attempted to read beyond end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100958 return -EINVAL;
959 }
960
961 /* Grab the lock and see if the device is available */
962 onenand_get_device(mtd, FL_READING);
963
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100964 while (read < len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +0900965 cond_resched();
966
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200967 thislen = oobsize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100968 thislen = min_t(int, thislen, len);
969
970 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
971
972 onenand_update_bufferram(mtd, from, 0);
973
974 ret = this->wait(mtd, FL_READING);
975 /* First copy data and check return value for ECC handling */
976
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200977 if (mode == MTD_OOB_AUTO)
978 onenand_transfer_auto_oob(mtd, buf, column, thislen);
979 else
980 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100981
Kyungmin Parkf6272482006-12-22 16:02:50 +0900982 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900983 printk(KERN_ERR "onenand_read_oob: read failed = 0x%x\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +0900984 break;
Kyungmin Parkf6272482006-12-22 16:02:50 +0900985 }
986
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100987 read += thislen;
988
989 if (read == len)
990 break;
991
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100992 buf += thislen;
993
994 /* Read more? */
995 if (read < len) {
996 /* Page size */
Joern Engel28318772006-05-22 23:18:05 +0200997 from += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100998 column = 0;
999 }
1000 }
1001
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001002 /* Deselect and wake up anyone waiting on the device */
1003 onenand_release_device(mtd);
1004
Kyungmin Park12f77c92007-08-30 09:36:05 +09001005 ops->oobretlen = read;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001006 return ret;
1007}
1008
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001009/**
1010 * onenand_read_oob - [MTD Interface] NAND write data and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001011 * @param mtd: MTD device structure
1012 * @param from: offset to read from
1013 * @param ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001014 */
1015static int onenand_read_oob(struct mtd_info *mtd, loff_t from,
1016 struct mtd_oob_ops *ops)
1017{
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001018 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001019 case MTD_OOB_PLACE:
1020 case MTD_OOB_AUTO:
1021 break;
1022 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001023 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001024 default:
1025 return -EINVAL;
1026 }
Kyungmin Park12f77c92007-08-30 09:36:05 +09001027 return onenand_do_read_oob(mtd, from, ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001028}
1029
Kyungmin Park211ac752007-02-07 12:15:01 +09001030/**
1031 * onenand_bbt_wait - [DEFAULT] wait until the command is done
1032 * @param mtd MTD device structure
1033 * @param state state to select the max. timeout value
1034 *
1035 * Wait for command done.
1036 */
1037static int onenand_bbt_wait(struct mtd_info *mtd, int state)
1038{
1039 struct onenand_chip *this = mtd->priv;
1040 unsigned long timeout;
1041 unsigned int interrupt;
1042 unsigned int ctrl;
1043
1044 /* The 20 msec is enough */
1045 timeout = jiffies + msecs_to_jiffies(20);
1046 while (time_before(jiffies, timeout)) {
1047 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1048 if (interrupt & ONENAND_INT_MASTER)
1049 break;
1050 }
1051 /* To get correct interrupt status in timeout case */
1052 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1053 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
1054
1055 if (ctrl & ONENAND_CTRL_ERROR) {
1056 printk(KERN_DEBUG "onenand_bbt_wait: controller error = 0x%04x\n", ctrl);
1057 /* Initial bad block case */
1058 if (ctrl & ONENAND_CTRL_LOAD)
1059 return ONENAND_BBT_READ_ERROR;
1060 return ONENAND_BBT_READ_FATAL_ERROR;
1061 }
1062
1063 if (interrupt & ONENAND_INT_READ) {
1064 int ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS);
1065 if (ecc & ONENAND_ECC_2BIT_ALL)
1066 return ONENAND_BBT_READ_ERROR;
1067 } else {
1068 printk(KERN_ERR "onenand_bbt_wait: read timeout!"
1069 "ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
1070 return ONENAND_BBT_READ_FATAL_ERROR;
1071 }
1072
1073 return 0;
1074}
1075
1076/**
1077 * onenand_bbt_read_oob - [MTD Interface] OneNAND read out-of-band for bbt scan
1078 * @param mtd MTD device structure
1079 * @param from offset to read from
Kyungmin Parke3da8062007-02-15 09:36:39 +09001080 * @param ops oob operation description structure
Kyungmin Park211ac752007-02-07 12:15:01 +09001081 *
1082 * OneNAND read out-of-band data from the spare area for bbt scan
1083 */
1084int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
1085 struct mtd_oob_ops *ops)
1086{
1087 struct onenand_chip *this = mtd->priv;
1088 int read = 0, thislen, column;
1089 int ret = 0;
1090 size_t len = ops->ooblen;
1091 u_char *buf = ops->oobbuf;
1092
Andrew Morton5785bdd2007-02-17 16:02:05 -08001093 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 +09001094
1095 /* Initialize return value */
1096 ops->oobretlen = 0;
1097
1098 /* Do not allow reads past end of device */
1099 if (unlikely((from + len) > mtd->size)) {
1100 printk(KERN_ERR "onenand_bbt_read_oob: Attempt read beyond end of device\n");
1101 return ONENAND_BBT_READ_FATAL_ERROR;
1102 }
1103
1104 /* Grab the lock and see if the device is available */
1105 onenand_get_device(mtd, FL_READING);
1106
1107 column = from & (mtd->oobsize - 1);
1108
1109 while (read < len) {
1110 cond_resched();
1111
1112 thislen = mtd->oobsize - column;
1113 thislen = min_t(int, thislen, len);
1114
1115 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
1116
1117 onenand_update_bufferram(mtd, from, 0);
1118
1119 ret = onenand_bbt_wait(mtd, FL_READING);
1120 if (ret)
1121 break;
1122
1123 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
1124 read += thislen;
1125 if (read == len)
1126 break;
1127
1128 buf += thislen;
1129
1130 /* Read more? */
1131 if (read < len) {
1132 /* Update Page size */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001133 from += this->writesize;
Kyungmin Park211ac752007-02-07 12:15:01 +09001134 column = 0;
1135 }
1136 }
1137
1138 /* Deselect and wake up anyone waiting on the device */
1139 onenand_release_device(mtd);
1140
1141 ops->oobretlen = read;
1142 return ret;
1143}
1144
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001145#ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
1146/**
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001147 * onenand_verify_oob - [GENERIC] verify the oob contents after a write
1148 * @param mtd MTD device structure
1149 * @param buf the databuffer to verify
1150 * @param to offset to read from
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001151 *
1152 */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001153static int onenand_verify_oob(struct mtd_info *mtd, const u_char *buf, loff_t to)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001154{
1155 struct onenand_chip *this = mtd->priv;
Kyungmin Park91014e92007-02-12 10:34:39 +09001156 char oobbuf[64];
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001157 int status, i;
1158
1159 this->command(mtd, ONENAND_CMD_READOOB, to, mtd->oobsize);
1160 onenand_update_bufferram(mtd, to, 0);
1161 status = this->wait(mtd, FL_READING);
1162 if (status)
1163 return status;
1164
Kyungmin Park91014e92007-02-12 10:34:39 +09001165 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
1166 for (i = 0; i < mtd->oobsize; i++)
1167 if (buf[i] != 0xFF && buf[i] != oobbuf[i])
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001168 return -EBADMSG;
1169
1170 return 0;
1171}
1172
1173/**
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001174 * onenand_verify - [GENERIC] verify the chip contents after a write
1175 * @param mtd MTD device structure
1176 * @param buf the databuffer to verify
1177 * @param addr offset to read from
1178 * @param len number of bytes to read and compare
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001179 *
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001180 */
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001181static int onenand_verify(struct mtd_info *mtd, const u_char *buf, loff_t addr, size_t len)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001182{
1183 struct onenand_chip *this = mtd->priv;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001184 void __iomem *dataram;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001185 int ret = 0;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001186 int thislen, column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001187
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001188 while (len != 0) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001189 thislen = min_t(int, this->writesize, len);
1190 column = addr & (this->writesize - 1);
1191 if (column + thislen > this->writesize)
1192 thislen = this->writesize - column;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001193
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001194 this->command(mtd, ONENAND_CMD_READ, addr, this->writesize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001195
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001196 onenand_update_bufferram(mtd, addr, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001197
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001198 ret = this->wait(mtd, FL_READING);
1199 if (ret)
1200 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001201
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001202 onenand_update_bufferram(mtd, addr, 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001203
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001204 dataram = this->base + ONENAND_DATARAM;
1205 dataram += onenand_bufferram_offset(mtd, ONENAND_DATARAM);
1206
1207 if (memcmp(buf, dataram + column, thislen))
1208 return -EBADMSG;
1209
1210 len -= thislen;
1211 buf += thislen;
1212 addr += thislen;
1213 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001214
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001215 return 0;
1216}
1217#else
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001218#define onenand_verify(...) (0)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001219#define onenand_verify_oob(...) (0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001220#endif
1221
Kyungmin Park60d84f92006-12-22 16:21:54 +09001222#define NOTALIGNED(x) ((x & (this->subpagesize - 1)) != 0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001223
1224/**
Thomas Gleixner9223a452006-05-23 17:21:03 +02001225 * onenand_write - [MTD Interface] write buffer to FLASH
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001226 * @param mtd MTD device structure
1227 * @param to offset to write to
1228 * @param len number of bytes to write
1229 * @param retlen pointer to variable to store the number of written bytes
1230 * @param buf the data to write
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001231 *
Thomas Gleixner9223a452006-05-23 17:21:03 +02001232 * Write with ECC
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001233 */
Thomas Gleixner9223a452006-05-23 17:21:03 +02001234static int onenand_write(struct mtd_info *mtd, loff_t to, size_t len,
1235 size_t *retlen, const u_char *buf)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001236{
1237 struct onenand_chip *this = mtd->priv;
1238 int written = 0;
1239 int ret = 0;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001240 int column, subpage;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001241
Thomas Gleixner9223a452006-05-23 17:21:03 +02001242 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001243
1244 /* Initialize retlen, in case of early exit */
1245 *retlen = 0;
1246
1247 /* Do not allow writes past end of device */
1248 if (unlikely((to + len) > mtd->size)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001249 printk(KERN_ERR "onenand_write: Attempt write to past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001250 return -EINVAL;
1251 }
1252
1253 /* Reject writes, which are not page aligned */
1254 if (unlikely(NOTALIGNED(to)) || unlikely(NOTALIGNED(len))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001255 printk(KERN_ERR "onenand_write: Attempt to write not page aligned data\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001256 return -EINVAL;
1257 }
1258
Kyungmin Park60d84f92006-12-22 16:21:54 +09001259 column = to & (mtd->writesize - 1);
Kyungmin Park60d84f92006-12-22 16:21:54 +09001260
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001261 /* Grab the lock and see if the device is available */
1262 onenand_get_device(mtd, FL_WRITING);
1263
1264 /* Loop until all data write */
1265 while (written < len) {
Adrian Hunter81f38e12007-02-07 10:55:23 +09001266 int thislen = min_t(int, mtd->writesize - column, len - written);
Kyungmin Park60d84f92006-12-22 16:21:54 +09001267 u_char *wbuf = (u_char *) buf;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001268
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001269 cond_resched();
1270
Adrian Hunter81f38e12007-02-07 10:55:23 +09001271 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, thislen);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001272
Kyungmin Park60d84f92006-12-22 16:21:54 +09001273 /* Partial page write */
Adrian Hunter81f38e12007-02-07 10:55:23 +09001274 subpage = thislen < mtd->writesize;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001275 if (subpage) {
Kyungmin Park60d84f92006-12-22 16:21:54 +09001276 memset(this->page_buf, 0xff, mtd->writesize);
Adrian Hunter81f38e12007-02-07 10:55:23 +09001277 memcpy(this->page_buf + column, buf, thislen);
Kyungmin Park60d84f92006-12-22 16:21:54 +09001278 wbuf = this->page_buf;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001279 }
1280
Adrian Hunter81f38e12007-02-07 10:55:23 +09001281 this->write_bufferram(mtd, ONENAND_DATARAM, wbuf, 0, mtd->writesize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001282 this->write_bufferram(mtd, ONENAND_SPARERAM, ffchars, 0, mtd->oobsize);
1283
Joern Engel28318772006-05-22 23:18:05 +02001284 this->command(mtd, ONENAND_CMD_PROG, to, mtd->writesize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001285
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001286 ret = this->wait(mtd, FL_WRITING);
Adrian Hunter81f38e12007-02-07 10:55:23 +09001287
1288 /* In partial page write we don't update bufferram */
1289 onenand_update_bufferram(mtd, to, !ret && !subpage);
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001290 if (ONENAND_IS_2PLANE(this)) {
1291 ONENAND_SET_BUFFERRAM1(this);
1292 onenand_update_bufferram(mtd, to + this->writesize, !ret && !subpage);
1293 }
Adrian Hunter81f38e12007-02-07 10:55:23 +09001294
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001295 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001296 printk(KERN_ERR "onenand_write: write filaed %d\n", ret);
Kyungmin Park60d84f92006-12-22 16:21:54 +09001297 break;
1298 }
1299
1300 /* Only check verify write turn on */
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001301 ret = onenand_verify(mtd, (u_char *) wbuf, to, thislen);
Kyungmin Park60d84f92006-12-22 16:21:54 +09001302 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001303 printk(KERN_ERR "onenand_write: verify failed %d\n", ret);
Kyungmin Park60d84f92006-12-22 16:21:54 +09001304 break;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001305 }
1306
1307 written += thislen;
Adrian Hunter81f38e12007-02-07 10:55:23 +09001308
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001309 if (written == len)
1310 break;
1311
Kyungmin Park60d84f92006-12-22 16:21:54 +09001312 column = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001313 to += thislen;
1314 buf += thislen;
1315 }
1316
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001317 /* Deselect and wake up anyone waiting on the device */
1318 onenand_release_device(mtd);
1319
1320 *retlen = written;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001321
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001322 return ret;
1323}
1324
1325/**
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001326 * onenand_fill_auto_oob - [Internal] oob auto-placement transfer
1327 * @param mtd MTD device structure
1328 * @param oob_buf oob buffer
1329 * @param buf source address
1330 * @param column oob offset to write to
1331 * @param thislen oob length to write
1332 */
1333static int onenand_fill_auto_oob(struct mtd_info *mtd, u_char *oob_buf,
1334 const u_char *buf, int column, int thislen)
1335{
1336 struct onenand_chip *this = mtd->priv;
1337 struct nand_oobfree *free;
1338 int writecol = column;
1339 int writeend = column + thislen;
1340 int lastgap = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09001341 unsigned int i;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001342
Kyungmin Parkad286342007-03-23 10:19:52 +09001343 free = this->ecclayout->oobfree;
1344 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001345 if (writecol >= lastgap)
1346 writecol += free->offset - lastgap;
1347 if (writeend >= lastgap)
1348 writeend += free->offset - lastgap;
1349 lastgap = free->offset + free->length;
1350 }
Kyungmin Parkad286342007-03-23 10:19:52 +09001351 free = this->ecclayout->oobfree;
1352 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001353 int free_end = free->offset + free->length;
1354 if (free->offset < writeend && free_end > writecol) {
1355 int st = max_t(int,free->offset,writecol);
1356 int ed = min_t(int,free_end,writeend);
1357 int n = ed - st;
1358 memcpy(oob_buf + st, buf, n);
1359 buf += n;
Adrian Hunterc36c46d2007-03-23 17:16:22 +09001360 } else if (column == 0)
Kyungmin Park5bc399e2007-03-09 09:41:07 +09001361 break;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001362 }
1363 return 0;
1364}
1365
1366/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001367 * onenand_do_write_oob - [Internal] OneNAND write out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001368 * @param mtd MTD device structure
1369 * @param to offset to write to
1370 * @param len number of bytes to write
1371 * @param retlen pointer to variable to store the number of written bytes
1372 * @param buf the data to write
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001373 * @param mode operation mode
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001374 *
1375 * OneNAND write out-of-band
1376 */
Kyungmin Park12f77c92007-08-30 09:36:05 +09001377static int onenand_do_write_oob(struct mtd_info *mtd, loff_t to,
1378 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001379{
1380 struct onenand_chip *this = mtd->priv;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001381 int column, ret = 0, oobsize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001382 int written = 0;
Kyungmin Park91014e92007-02-12 10:34:39 +09001383 u_char *oobbuf;
Kyungmin Park12f77c92007-08-30 09:36:05 +09001384 size_t len = ops->ooblen;
1385 const u_char *buf = ops->oobbuf;
1386 mtd_oob_mode_t mode = ops->mode;
1387
1388 to += ops->ooboffs;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001389
1390 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write_oob: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
1391
1392 /* Initialize retlen, in case of early exit */
Kyungmin Park12f77c92007-08-30 09:36:05 +09001393 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001394
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001395 if (mode == MTD_OOB_AUTO)
1396 oobsize = this->ecclayout->oobavail;
1397 else
1398 oobsize = mtd->oobsize;
1399
1400 column = to & (mtd->oobsize - 1);
1401
1402 if (unlikely(column >= oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001403 printk(KERN_ERR "onenand_write_oob: Attempted to start write outside oob\n");
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001404 return -EINVAL;
1405 }
1406
Adrian Hunter52e42002007-02-06 09:15:39 +09001407 /* For compatibility with NAND: Do not allow write past end of page */
Kyungmin Park91014e92007-02-12 10:34:39 +09001408 if (unlikely(column + len > oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001409 printk(KERN_ERR "onenand_write_oob: "
Adrian Hunter52e42002007-02-06 09:15:39 +09001410 "Attempt to write past end of page\n");
1411 return -EINVAL;
1412 }
1413
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001414 /* Do not allow reads past end of device */
1415 if (unlikely(to >= mtd->size ||
1416 column + len > ((mtd->size >> this->page_shift) -
1417 (to >> this->page_shift)) * oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001418 printk(KERN_ERR "onenand_write_oob: Attempted to write past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001419 return -EINVAL;
1420 }
1421
1422 /* Grab the lock and see if the device is available */
1423 onenand_get_device(mtd, FL_WRITING);
1424
Kyungmin Park470bc842007-03-09 10:08:11 +09001425 oobbuf = this->oob_buf;
Kyungmin Park91014e92007-02-12 10:34:39 +09001426
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001427 /* Loop until all data write */
1428 while (written < len) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001429 int thislen = min_t(int, oobsize, len - written);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001430
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001431 cond_resched();
1432
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001433 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, mtd->oobsize);
1434
Kyungmin Park34c10602006-05-12 17:02:46 +03001435 /* We send data to spare ram with oobsize
1436 * to prevent byte access */
Kyungmin Park91014e92007-02-12 10:34:39 +09001437 memset(oobbuf, 0xff, mtd->oobsize);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001438 if (mode == MTD_OOB_AUTO)
Kyungmin Park91014e92007-02-12 10:34:39 +09001439 onenand_fill_auto_oob(mtd, oobbuf, buf, column, thislen);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001440 else
Kyungmin Park91014e92007-02-12 10:34:39 +09001441 memcpy(oobbuf + column, buf, thislen);
1442 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001443
1444 this->command(mtd, ONENAND_CMD_PROGOOB, to, mtd->oobsize);
1445
1446 onenand_update_bufferram(mtd, to, 0);
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001447 if (ONENAND_IS_2PLANE(this)) {
1448 ONENAND_SET_BUFFERRAM1(this);
1449 onenand_update_bufferram(mtd, to + this->writesize, 0);
1450 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001451
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001452 ret = this->wait(mtd, FL_WRITING);
1453 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001454 printk(KERN_ERR "onenand_write_oob: write failed %d\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001455 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001456 }
1457
Kyungmin Park91014e92007-02-12 10:34:39 +09001458 ret = onenand_verify_oob(mtd, oobbuf, to);
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001459 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001460 printk(KERN_ERR "onenand_write_oob: verify failed %d\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001461 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001462 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001463
1464 written += thislen;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001465 if (written == len)
1466 break;
1467
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001468 to += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001469 buf += thislen;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001470 column = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001471 }
1472
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001473 /* Deselect and wake up anyone waiting on the device */
1474 onenand_release_device(mtd);
1475
Kyungmin Park12f77c92007-08-30 09:36:05 +09001476 ops->oobretlen = written;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001477
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001478 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001479}
1480
1481/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001482 * onenand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001483 * @param mtd: MTD device structure
1484 * @param to: offset to write
1485 * @param ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001486 */
1487static int onenand_write_oob(struct mtd_info *mtd, loff_t to,
1488 struct mtd_oob_ops *ops)
1489{
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001490 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001491 case MTD_OOB_PLACE:
1492 case MTD_OOB_AUTO:
1493 break;
1494 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001495 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001496 default:
1497 return -EINVAL;
1498 }
Kyungmin Park12f77c92007-08-30 09:36:05 +09001499 return onenand_do_write_oob(mtd, to, ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001500}
1501
1502/**
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001503 * onenand_block_checkbad - [GENERIC] Check if a block is marked bad
1504 * @param mtd MTD device structure
1505 * @param ofs offset from device start
1506 * @param getchip 0, if the chip is already selected
1507 * @param allowbbt 1, if its allowed to access the bbt area
1508 *
1509 * Check, if the block is bad. Either by reading the bad block table or
1510 * calling of the scan function.
1511 */
1512static int onenand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip, int allowbbt)
1513{
1514 struct onenand_chip *this = mtd->priv;
1515 struct bbm_info *bbm = this->bbm;
1516
1517 /* Return info from the table */
1518 return bbm->isbad_bbt(mtd, ofs, allowbbt);
1519}
1520
1521/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001522 * onenand_erase - [MTD Interface] erase block(s)
1523 * @param mtd MTD device structure
1524 * @param instr erase instruction
1525 *
1526 * Erase one ore more blocks
1527 */
1528static int onenand_erase(struct mtd_info *mtd, struct erase_info *instr)
1529{
1530 struct onenand_chip *this = mtd->priv;
1531 unsigned int block_size;
1532 loff_t addr;
1533 int len;
1534 int ret = 0;
1535
1536 DEBUG(MTD_DEBUG_LEVEL3, "onenand_erase: start = 0x%08x, len = %i\n", (unsigned int) instr->addr, (unsigned int) instr->len);
1537
1538 block_size = (1 << this->erase_shift);
1539
1540 /* Start address must align on block boundary */
1541 if (unlikely(instr->addr & (block_size - 1))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001542 printk(KERN_ERR "onenand_erase: Unaligned address\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001543 return -EINVAL;
1544 }
1545
1546 /* Length must align on block boundary */
1547 if (unlikely(instr->len & (block_size - 1))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001548 printk(KERN_ERR "onenand_erase: Length not block aligned\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001549 return -EINVAL;
1550 }
1551
1552 /* Do not allow erase past end of device */
1553 if (unlikely((instr->len + instr->addr) > mtd->size)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001554 printk(KERN_ERR "onenand_erase: Erase past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001555 return -EINVAL;
1556 }
1557
1558 instr->fail_addr = 0xffffffff;
1559
1560 /* Grab the lock and see if the device is available */
1561 onenand_get_device(mtd, FL_ERASING);
1562
1563 /* Loop throught the pages */
1564 len = instr->len;
1565 addr = instr->addr;
1566
1567 instr->state = MTD_ERASING;
1568
1569 while (len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001570 cond_resched();
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001571
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001572 /* Check if we have a bad block, we do not erase bad blocks */
1573 if (onenand_block_checkbad(mtd, addr, 0, 0)) {
1574 printk (KERN_WARNING "onenand_erase: attempt to erase a bad block at addr 0x%08x\n", (unsigned int) addr);
1575 instr->state = MTD_ERASE_FAILED;
1576 goto erase_exit;
1577 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001578
1579 this->command(mtd, ONENAND_CMD_ERASE, addr, block_size);
1580
Adrian Hunter480b9df2007-02-07 13:55:19 +02001581 onenand_invalidate_bufferram(mtd, addr, block_size);
1582
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001583 ret = this->wait(mtd, FL_ERASING);
1584 /* Check, if it is write protected */
1585 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001586 printk(KERN_ERR "onenand_erase: Failed erase, block %d\n", (unsigned) (addr >> this->erase_shift));
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001587 instr->state = MTD_ERASE_FAILED;
1588 instr->fail_addr = addr;
1589 goto erase_exit;
1590 }
1591
1592 len -= block_size;
1593 addr += block_size;
1594 }
1595
1596 instr->state = MTD_ERASE_DONE;
1597
1598erase_exit:
1599
1600 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
1601 /* Do call back function */
1602 if (!ret)
1603 mtd_erase_callback(instr);
1604
1605 /* Deselect and wake up anyone waiting on the device */
1606 onenand_release_device(mtd);
1607
1608 return ret;
1609}
1610
1611/**
1612 * onenand_sync - [MTD Interface] sync
1613 * @param mtd MTD device structure
1614 *
1615 * Sync is actually a wait for chip ready function
1616 */
1617static void onenand_sync(struct mtd_info *mtd)
1618{
1619 DEBUG(MTD_DEBUG_LEVEL3, "onenand_sync: called\n");
1620
1621 /* Grab the lock and see if the device is available */
1622 onenand_get_device(mtd, FL_SYNCING);
1623
1624 /* Release it and go back */
1625 onenand_release_device(mtd);
1626}
1627
1628/**
1629 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
1630 * @param mtd MTD device structure
1631 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001632 *
1633 * Check whether the block is bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001634 */
1635static int onenand_block_isbad(struct mtd_info *mtd, loff_t ofs)
1636{
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001637 /* Check for invalid offset */
1638 if (ofs > mtd->size)
1639 return -EINVAL;
1640
1641 return onenand_block_checkbad(mtd, ofs, 1, 0);
1642}
1643
1644/**
1645 * onenand_default_block_markbad - [DEFAULT] mark a block bad
1646 * @param mtd MTD device structure
1647 * @param ofs offset from device start
1648 *
1649 * This is the default implementation, which can be overridden by
1650 * a hardware specific driver.
1651 */
1652static int onenand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
1653{
1654 struct onenand_chip *this = mtd->priv;
1655 struct bbm_info *bbm = this->bbm;
1656 u_char buf[2] = {0, 0};
Kyungmin Park12f77c92007-08-30 09:36:05 +09001657 struct mtd_oob_ops ops = {
1658 .mode = MTD_OOB_PLACE,
1659 .ooblen = 2,
1660 .oobbuf = buf,
1661 .ooboffs = 0,
1662 };
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001663 int block;
1664
1665 /* Get block number */
1666 block = ((int) ofs) >> bbm->bbt_erase_shift;
1667 if (bbm->bbt)
1668 bbm->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
1669
1670 /* We write two bytes, so we dont have to mess with 16 bit access */
1671 ofs += mtd->oobsize + (bbm->badblockpos & ~0x01);
Kyungmin Park12f77c92007-08-30 09:36:05 +09001672 return onenand_do_write_oob(mtd, ofs, &ops);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001673}
1674
1675/**
1676 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
1677 * @param mtd MTD device structure
1678 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001679 *
1680 * Mark the block as bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001681 */
1682static int onenand_block_markbad(struct mtd_info *mtd, loff_t ofs)
1683{
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001684 struct onenand_chip *this = mtd->priv;
1685 int ret;
1686
1687 ret = onenand_block_isbad(mtd, ofs);
1688 if (ret) {
1689 /* If it was bad already, return success and do nothing */
1690 if (ret > 0)
1691 return 0;
1692 return ret;
1693 }
1694
1695 return this->block_markbad(mtd, ofs);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001696}
1697
1698/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09001699 * onenand_do_lock_cmd - [OneNAND Interface] Lock or unlock block(s)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001700 * @param mtd MTD device structure
1701 * @param ofs offset relative to mtd start
Kyungmin Park08f782b2006-11-16 11:29:39 +09001702 * @param len number of bytes to lock or unlock
Kyungmin Parke3da8062007-02-15 09:36:39 +09001703 * @param cmd lock or unlock command
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001704 *
Kyungmin Park08f782b2006-11-16 11:29:39 +09001705 * Lock or unlock one or more blocks
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001706 */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001707static int onenand_do_lock_cmd(struct mtd_info *mtd, loff_t ofs, size_t len, int cmd)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001708{
1709 struct onenand_chip *this = mtd->priv;
1710 int start, end, block, value, status;
Kyungmin Park08f782b2006-11-16 11:29:39 +09001711 int wp_status_mask;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001712
1713 start = ofs >> this->erase_shift;
1714 end = len >> this->erase_shift;
1715
Kyungmin Park08f782b2006-11-16 11:29:39 +09001716 if (cmd == ONENAND_CMD_LOCK)
1717 wp_status_mask = ONENAND_WP_LS;
1718 else
1719 wp_status_mask = ONENAND_WP_US;
1720
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001721 /* Continuous lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001722 if (this->options & ONENAND_HAS_CONT_LOCK) {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001723 /* Set start block address */
1724 this->write_word(start, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1725 /* Set end block address */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001726 this->write_word(start + end - 1, this->base + ONENAND_REG_END_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001727 /* Write lock command */
1728 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001729
1730 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001731 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001732
1733 /* Sanity check */
1734 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1735 & ONENAND_CTRL_ONGO)
1736 continue;
1737
1738 /* Check lock status */
1739 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001740 if (!(status & wp_status_mask))
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001741 printk(KERN_ERR "wp status = 0x%x\n", status);
1742
1743 return 0;
1744 }
1745
1746 /* Block lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001747 for (block = start; block < start + end; block++) {
Kyungmin Park20ba89a2005-12-16 11:17:29 +09001748 /* Set block address */
1749 value = onenand_block_address(this, block);
1750 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1751 /* Select DataRAM for DDP */
1752 value = onenand_bufferram_address(this, block);
1753 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001754 /* Set start block address */
1755 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001756 /* Write lock command */
1757 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001758
1759 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001760 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001761
1762 /* Sanity check */
1763 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1764 & ONENAND_CTRL_ONGO)
1765 continue;
1766
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001767 /* Check lock status */
1768 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001769 if (!(status & wp_status_mask))
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001770 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1771 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001772
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001773 return 0;
1774}
1775
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001776/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09001777 * onenand_lock - [MTD Interface] Lock block(s)
1778 * @param mtd MTD device structure
1779 * @param ofs offset relative to mtd start
1780 * @param len number of bytes to unlock
1781 *
1782 * Lock one or more blocks
1783 */
1784static int onenand_lock(struct mtd_info *mtd, loff_t ofs, size_t len)
1785{
1786 return onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_LOCK);
1787}
1788
Kyungmin Park08f782b2006-11-16 11:29:39 +09001789/**
1790 * onenand_unlock - [MTD Interface] Unlock block(s)
1791 * @param mtd MTD device structure
1792 * @param ofs offset relative to mtd start
1793 * @param len number of bytes to unlock
1794 *
1795 * Unlock one or more blocks
1796 */
1797static int onenand_unlock(struct mtd_info *mtd, loff_t ofs, size_t len)
1798{
1799 return onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
1800}
1801
1802/**
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001803 * onenand_check_lock_status - [OneNAND Interface] Check lock status
1804 * @param this onenand chip data structure
1805 *
1806 * Check lock status
1807 */
1808static void onenand_check_lock_status(struct onenand_chip *this)
1809{
1810 unsigned int value, block, status;
1811 unsigned int end;
1812
1813 end = this->chipsize >> this->erase_shift;
1814 for (block = 0; block < end; block++) {
1815 /* Set block address */
1816 value = onenand_block_address(this, block);
1817 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1818 /* Select DataRAM for DDP */
1819 value = onenand_bufferram_address(this, block);
1820 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
1821 /* Set start block address */
1822 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1823
1824 /* Check lock status */
1825 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
1826 if (!(status & ONENAND_WP_US))
1827 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1828 }
1829}
1830
1831/**
1832 * onenand_unlock_all - [OneNAND Interface] unlock all blocks
1833 * @param mtd MTD device structure
1834 *
1835 * Unlock all blocks
1836 */
1837static int onenand_unlock_all(struct mtd_info *mtd)
1838{
1839 struct onenand_chip *this = mtd->priv;
1840
1841 if (this->options & ONENAND_HAS_UNLOCK_ALL) {
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09001842 /* Set start block address */
1843 this->write_word(0, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001844 /* Write unlock command */
1845 this->command(mtd, ONENAND_CMD_UNLOCK_ALL, 0, 0);
1846
1847 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001848 this->wait(mtd, FL_LOCKING);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001849
1850 /* Sanity check */
1851 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1852 & ONENAND_CTRL_ONGO)
1853 continue;
1854
1855 /* Workaround for all block unlock in DDP */
Kyungmin Park738d61f2007-01-15 17:09:14 +09001856 if (ONENAND_IS_DDP(this)) {
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001857 /* 1st block on another chip */
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09001858 loff_t ofs = this->chipsize >> 1;
1859 size_t len = mtd->erasesize;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001860
1861 onenand_unlock(mtd, ofs, len);
1862 }
1863
1864 onenand_check_lock_status(this);
1865
1866 return 0;
1867 }
1868
Kyungmin Park08f782b2006-11-16 11:29:39 +09001869 onenand_unlock(mtd, 0x0, this->chipsize);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001870
1871 return 0;
1872}
1873
Kyungmin Park493c6462006-05-12 17:03:07 +03001874#ifdef CONFIG_MTD_ONENAND_OTP
1875
1876/* Interal OTP operation */
1877typedef int (*otp_op_t)(struct mtd_info *mtd, loff_t form, size_t len,
1878 size_t *retlen, u_char *buf);
1879
1880/**
1881 * do_otp_read - [DEFAULT] Read OTP block area
1882 * @param mtd MTD device structure
1883 * @param from The offset to read
1884 * @param len number of bytes to read
1885 * @param retlen pointer to variable to store the number of readbytes
1886 * @param buf the databuffer to put/get data
1887 *
1888 * Read OTP block area.
1889 */
1890static int do_otp_read(struct mtd_info *mtd, loff_t from, size_t len,
1891 size_t *retlen, u_char *buf)
1892{
1893 struct onenand_chip *this = mtd->priv;
1894 int ret;
1895
1896 /* Enter OTP access mode */
1897 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
1898 this->wait(mtd, FL_OTPING);
1899
1900 ret = mtd->read(mtd, from, len, retlen, buf);
1901
1902 /* Exit OTP access mode */
1903 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
1904 this->wait(mtd, FL_RESETING);
1905
1906 return ret;
1907}
1908
1909/**
1910 * do_otp_write - [DEFAULT] Write OTP block area
1911 * @param mtd MTD device structure
1912 * @param from The offset to write
1913 * @param len number of bytes to write
1914 * @param retlen pointer to variable to store the number of write bytes
1915 * @param buf the databuffer to put/get data
1916 *
1917 * Write OTP block area.
1918 */
1919static int do_otp_write(struct mtd_info *mtd, loff_t from, size_t len,
1920 size_t *retlen, u_char *buf)
1921{
1922 struct onenand_chip *this = mtd->priv;
1923 unsigned char *pbuf = buf;
1924 int ret;
1925
1926 /* Force buffer page aligned */
Joern Engel28318772006-05-22 23:18:05 +02001927 if (len < mtd->writesize) {
Kyungmin Park493c6462006-05-12 17:03:07 +03001928 memcpy(this->page_buf, buf, len);
Joern Engel28318772006-05-22 23:18:05 +02001929 memset(this->page_buf + len, 0xff, mtd->writesize - len);
Kyungmin Park493c6462006-05-12 17:03:07 +03001930 pbuf = this->page_buf;
Joern Engel28318772006-05-22 23:18:05 +02001931 len = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03001932 }
1933
1934 /* Enter OTP access mode */
1935 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
1936 this->wait(mtd, FL_OTPING);
1937
1938 ret = mtd->write(mtd, from, len, retlen, pbuf);
1939
1940 /* Exit OTP access mode */
1941 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
1942 this->wait(mtd, FL_RESETING);
1943
1944 return ret;
1945}
1946
1947/**
1948 * do_otp_lock - [DEFAULT] Lock OTP block area
1949 * @param mtd MTD device structure
1950 * @param from The offset to lock
1951 * @param len number of bytes to lock
1952 * @param retlen pointer to variable to store the number of lock bytes
1953 * @param buf the databuffer to put/get data
1954 *
1955 * Lock OTP block area.
1956 */
1957static int do_otp_lock(struct mtd_info *mtd, loff_t from, size_t len,
1958 size_t *retlen, u_char *buf)
1959{
1960 struct onenand_chip *this = mtd->priv;
Kyungmin Park12f77c92007-08-30 09:36:05 +09001961 struct mtd_oob_ops ops = {
1962 .mode = MTD_OOB_PLACE,
1963 .ooblen = len,
1964 .oobbuf = buf,
1965 .ooboffs = 0,
1966 };
Kyungmin Park493c6462006-05-12 17:03:07 +03001967 int ret;
1968
1969 /* Enter OTP access mode */
1970 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
1971 this->wait(mtd, FL_OTPING);
1972
Kyungmin Park12f77c92007-08-30 09:36:05 +09001973 ret = onenand_do_write_oob(mtd, from, &ops);
1974
1975 *retlen = ops.oobretlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03001976
1977 /* Exit OTP access mode */
1978 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
1979 this->wait(mtd, FL_RESETING);
1980
1981 return ret;
1982}
1983
1984/**
1985 * onenand_otp_walk - [DEFAULT] Handle OTP operation
1986 * @param mtd MTD device structure
1987 * @param from The offset to read/write
1988 * @param len number of bytes to read/write
1989 * @param retlen pointer to variable to store the number of read bytes
1990 * @param buf the databuffer to put/get data
1991 * @param action do given action
1992 * @param mode specify user and factory
1993 *
1994 * Handle OTP operation.
1995 */
1996static int onenand_otp_walk(struct mtd_info *mtd, loff_t from, size_t len,
1997 size_t *retlen, u_char *buf,
1998 otp_op_t action, int mode)
1999{
2000 struct onenand_chip *this = mtd->priv;
2001 int otp_pages;
2002 int density;
2003 int ret = 0;
2004
2005 *retlen = 0;
2006
2007 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2008 if (density < ONENAND_DEVICE_DENSITY_512Mb)
2009 otp_pages = 20;
2010 else
2011 otp_pages = 10;
2012
2013 if (mode == MTD_OTP_FACTORY) {
Joern Engel28318772006-05-22 23:18:05 +02002014 from += mtd->writesize * otp_pages;
Kyungmin Park493c6462006-05-12 17:03:07 +03002015 otp_pages = 64 - otp_pages;
2016 }
2017
2018 /* Check User/Factory boundary */
Joern Engel28318772006-05-22 23:18:05 +02002019 if (((mtd->writesize * otp_pages) - (from + len)) < 0)
Kyungmin Park493c6462006-05-12 17:03:07 +03002020 return 0;
2021
2022 while (len > 0 && otp_pages > 0) {
2023 if (!action) { /* OTP Info functions */
2024 struct otp_info *otpinfo;
2025
2026 len -= sizeof(struct otp_info);
2027 if (len <= 0)
2028 return -ENOSPC;
2029
2030 otpinfo = (struct otp_info *) buf;
2031 otpinfo->start = from;
Joern Engel28318772006-05-22 23:18:05 +02002032 otpinfo->length = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002033 otpinfo->locked = 0;
2034
Joern Engel28318772006-05-22 23:18:05 +02002035 from += mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002036 buf += sizeof(struct otp_info);
2037 *retlen += sizeof(struct otp_info);
2038 } else {
2039 size_t tmp_retlen;
2040 int size = len;
2041
2042 ret = action(mtd, from, len, &tmp_retlen, buf);
2043
2044 buf += size;
2045 len -= size;
2046 *retlen += size;
2047
2048 if (ret < 0)
2049 return ret;
2050 }
2051 otp_pages--;
2052 }
2053
2054 return 0;
2055}
2056
2057/**
2058 * onenand_get_fact_prot_info - [MTD Interface] Read factory OTP info
2059 * @param mtd MTD device structure
2060 * @param buf the databuffer to put/get data
2061 * @param len number of bytes to read
2062 *
2063 * Read factory OTP info.
2064 */
2065static int onenand_get_fact_prot_info(struct mtd_info *mtd,
2066 struct otp_info *buf, size_t len)
2067{
2068 size_t retlen;
2069 int ret;
2070
2071 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_FACTORY);
2072
2073 return ret ? : retlen;
2074}
2075
2076/**
2077 * onenand_read_fact_prot_reg - [MTD Interface] Read factory OTP area
2078 * @param mtd MTD device structure
2079 * @param from The offset to read
2080 * @param len number of bytes to read
2081 * @param retlen pointer to variable to store the number of read bytes
2082 * @param buf the databuffer to put/get data
2083 *
2084 * Read factory OTP area.
2085 */
2086static int onenand_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
2087 size_t len, size_t *retlen, u_char *buf)
2088{
2089 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_FACTORY);
2090}
2091
2092/**
2093 * onenand_get_user_prot_info - [MTD Interface] Read user OTP info
2094 * @param mtd MTD device structure
2095 * @param buf the databuffer to put/get data
2096 * @param len number of bytes to read
2097 *
2098 * Read user OTP info.
2099 */
2100static int onenand_get_user_prot_info(struct mtd_info *mtd,
2101 struct otp_info *buf, size_t len)
2102{
2103 size_t retlen;
2104 int ret;
2105
2106 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_USER);
2107
2108 return ret ? : retlen;
2109}
2110
2111/**
2112 * onenand_read_user_prot_reg - [MTD Interface] Read user OTP area
2113 * @param mtd MTD device structure
2114 * @param from The offset to read
2115 * @param len number of bytes to read
2116 * @param retlen pointer to variable to store the number of read bytes
2117 * @param buf the databuffer to put/get data
2118 *
2119 * Read user OTP area.
2120 */
2121static int onenand_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
2122 size_t len, size_t *retlen, u_char *buf)
2123{
2124 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_USER);
2125}
2126
2127/**
2128 * onenand_write_user_prot_reg - [MTD Interface] Write user OTP area
2129 * @param mtd MTD device structure
2130 * @param from The offset to write
2131 * @param len number of bytes to write
2132 * @param retlen pointer to variable to store the number of write bytes
2133 * @param buf the databuffer to put/get data
2134 *
2135 * Write user OTP area.
2136 */
2137static int onenand_write_user_prot_reg(struct mtd_info *mtd, loff_t from,
2138 size_t len, size_t *retlen, u_char *buf)
2139{
2140 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_write, MTD_OTP_USER);
2141}
2142
2143/**
2144 * onenand_lock_user_prot_reg - [MTD Interface] Lock user OTP area
2145 * @param mtd MTD device structure
2146 * @param from The offset to lock
2147 * @param len number of bytes to unlock
2148 *
2149 * Write lock mark on spare area in page 0 in OTP block
2150 */
2151static int onenand_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
2152 size_t len)
2153{
2154 unsigned char oob_buf[64];
2155 size_t retlen;
2156 int ret;
2157
2158 memset(oob_buf, 0xff, mtd->oobsize);
2159 /*
2160 * Note: OTP lock operation
2161 * OTP block : 0xXXFC
2162 * 1st block : 0xXXF3 (If chip support)
2163 * Both : 0xXXF0 (If chip support)
2164 */
2165 oob_buf[ONENAND_OTP_LOCK_OFFSET] = 0xFC;
2166
2167 /*
2168 * Write lock mark to 8th word of sector0 of page0 of the spare0.
2169 * We write 16 bytes spare area instead of 2 bytes.
2170 */
2171 from = 0;
2172 len = 16;
2173
2174 ret = onenand_otp_walk(mtd, from, len, &retlen, oob_buf, do_otp_lock, MTD_OTP_USER);
2175
2176 return ret ? : retlen;
2177}
2178#endif /* CONFIG_MTD_ONENAND_OTP */
2179
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002180/**
Kyungmin Park75384b02007-01-18 11:10:57 +09002181 * onenand_check_features - Check and set OneNAND features
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002182 * @param mtd MTD data structure
2183 *
Kyungmin Park75384b02007-01-18 11:10:57 +09002184 * Check and set OneNAND features
2185 * - lock scheme
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002186 * - two plane
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002187 */
Kyungmin Park75384b02007-01-18 11:10:57 +09002188static void onenand_check_features(struct mtd_info *mtd)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002189{
2190 struct onenand_chip *this = mtd->priv;
2191 unsigned int density, process;
2192
2193 /* Lock scheme depends on density and process */
2194 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2195 process = this->version_id >> ONENAND_VERSION_PROCESS_SHIFT;
2196
2197 /* Lock scheme */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002198 switch (density) {
2199 case ONENAND_DEVICE_DENSITY_4Gb:
2200 this->options |= ONENAND_HAS_2PLANE;
2201
2202 case ONENAND_DEVICE_DENSITY_2Gb:
2203 /* 2Gb DDP don't have 2 plane */
2204 if (!ONENAND_IS_DDP(this))
2205 this->options |= ONENAND_HAS_2PLANE;
2206 this->options |= ONENAND_HAS_UNLOCK_ALL;
2207
2208 case ONENAND_DEVICE_DENSITY_1Gb:
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002209 /* A-Die has all block unlock */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002210 if (process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002211 this->options |= ONENAND_HAS_UNLOCK_ALL;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002212 break;
2213
2214 default:
2215 /* Some OneNAND has continuous lock scheme */
2216 if (!process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002217 this->options |= ONENAND_HAS_CONT_LOCK;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002218 break;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002219 }
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002220
2221 if (this->options & ONENAND_HAS_CONT_LOCK)
2222 printk(KERN_DEBUG "Lock scheme is Continuous Lock\n");
2223 if (this->options & ONENAND_HAS_UNLOCK_ALL)
2224 printk(KERN_DEBUG "Chip support all block unlock\n");
2225 if (this->options & ONENAND_HAS_2PLANE)
2226 printk(KERN_DEBUG "Chip has 2 plane\n");
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002227}
2228
2229/**
Kyungmin Parke3da8062007-02-15 09:36:39 +09002230 * onenand_print_device_info - Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002231 * @param device device ID
Kyungmin Parke3da8062007-02-15 09:36:39 +09002232 * @param version version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002233 *
Kyungmin Parke3da8062007-02-15 09:36:39 +09002234 * Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002235 */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002236static void onenand_print_device_info(int device, int version)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002237{
2238 int vcc, demuxed, ddp, density;
2239
2240 vcc = device & ONENAND_DEVICE_VCC_MASK;
2241 demuxed = device & ONENAND_DEVICE_IS_DEMUX;
2242 ddp = device & ONENAND_DEVICE_IS_DDP;
2243 density = device >> ONENAND_DEVICE_DENSITY_SHIFT;
2244 printk(KERN_INFO "%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
2245 demuxed ? "" : "Muxed ",
2246 ddp ? "(DDP)" : "",
2247 (16 << density),
2248 vcc ? "2.65/3.3" : "1.8",
2249 device);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002250 printk(KERN_DEBUG "OneNAND version = 0x%04x\n", version);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002251}
2252
2253static const struct onenand_manufacturers onenand_manuf_ids[] = {
2254 {ONENAND_MFR_SAMSUNG, "Samsung"},
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002255};
2256
2257/**
2258 * onenand_check_maf - Check manufacturer ID
2259 * @param manuf manufacturer ID
2260 *
2261 * Check manufacturer ID
2262 */
2263static int onenand_check_maf(int manuf)
2264{
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002265 int size = ARRAY_SIZE(onenand_manuf_ids);
2266 char *name;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002267 int i;
2268
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002269 for (i = 0; i < size; i++)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002270 if (manuf == onenand_manuf_ids[i].id)
2271 break;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002272
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002273 if (i < size)
2274 name = onenand_manuf_ids[i].name;
2275 else
2276 name = "Unknown";
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002277
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002278 printk(KERN_DEBUG "OneNAND Manufacturer: %s (0x%0x)\n", name, manuf);
2279
2280 return (i == size);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002281}
2282
2283/**
2284 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
2285 * @param mtd MTD device structure
2286 *
2287 * OneNAND detection method:
Michael Opdenacker59c51592007-05-09 08:57:56 +02002288 * Compare the values from command with ones from register
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002289 */
2290static int onenand_probe(struct mtd_info *mtd)
2291{
2292 struct onenand_chip *this = mtd->priv;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002293 int bram_maf_id, bram_dev_id, maf_id, dev_id, ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002294 int density;
Kyungmin Park47e777e2006-09-25 23:53:28 +00002295 int syscfg;
2296
2297 /* Save system configuration 1 */
2298 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
2299 /* Clear Sync. Burst Read mode to read BootRAM */
2300 this->write_word((syscfg & ~ONENAND_SYS_CFG1_SYNC_READ), this->base + ONENAND_REG_SYS_CFG1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002301
2302 /* Send the command for reading device ID from BootRAM */
2303 this->write_word(ONENAND_CMD_READID, this->base + ONENAND_BOOTRAM);
2304
2305 /* Read manufacturer and device IDs from BootRAM */
2306 bram_maf_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x0);
2307 bram_dev_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x2);
2308
Kyungmin Park47e777e2006-09-25 23:53:28 +00002309 /* Reset OneNAND to read default register values */
2310 this->write_word(ONENAND_CMD_RESET, this->base + ONENAND_BOOTRAM);
2311 /* Wait reset */
2312 this->wait(mtd, FL_RESETING);
2313
2314 /* Restore system configuration 1 */
2315 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
2316
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002317 /* Check manufacturer ID */
2318 if (onenand_check_maf(bram_maf_id))
2319 return -ENXIO;
2320
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002321 /* Read manufacturer and device IDs from Register */
2322 maf_id = this->read_word(this->base + ONENAND_REG_MANUFACTURER_ID);
2323 dev_id = this->read_word(this->base + ONENAND_REG_DEVICE_ID);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09002324 ver_id = this->read_word(this->base + ONENAND_REG_VERSION_ID);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002325
2326 /* Check OneNAND device */
2327 if (maf_id != bram_maf_id || dev_id != bram_dev_id)
2328 return -ENXIO;
2329
2330 /* Flash device information */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002331 onenand_print_device_info(dev_id, ver_id);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002332 this->device_id = dev_id;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002333 this->version_id = ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002334
2335 density = dev_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2336 this->chipsize = (16 << density) << 20;
Kyungmin Park83a36832005-09-29 04:53:16 +01002337 /* Set density mask. it is used for DDP */
Kyungmin Park738d61f2007-01-15 17:09:14 +09002338 if (ONENAND_IS_DDP(this))
2339 this->density_mask = (1 << (density + 6));
2340 else
2341 this->density_mask = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002342
2343 /* OneNAND page size & block size */
2344 /* The data buffer size is equal to page size */
Joern Engel28318772006-05-22 23:18:05 +02002345 mtd->writesize = this->read_word(this->base + ONENAND_REG_DATA_BUFFER_SIZE);
2346 mtd->oobsize = mtd->writesize >> 5;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09002347 /* Pages per a block are always 64 in OneNAND */
Joern Engel28318772006-05-22 23:18:05 +02002348 mtd->erasesize = mtd->writesize << 6;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002349
2350 this->erase_shift = ffs(mtd->erasesize) - 1;
Joern Engel28318772006-05-22 23:18:05 +02002351 this->page_shift = ffs(mtd->writesize) - 1;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09002352 this->page_mask = (1 << (this->erase_shift - this->page_shift)) - 1;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002353 /* It's real page size */
2354 this->writesize = mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002355
2356 /* REVIST: Multichip handling */
2357
2358 mtd->size = this->chipsize;
2359
Kyungmin Park75384b02007-01-18 11:10:57 +09002360 /* Check OneNAND features */
2361 onenand_check_features(mtd);
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002362
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002363 /*
2364 * We emulate the 4KiB page and 256KiB erase block size
2365 * But oobsize is still 64 bytes.
2366 * It is only valid if you turn on 2X program support,
2367 * Otherwise it will be ignored by compiler.
2368 */
2369 if (ONENAND_IS_2PLANE(this)) {
2370 mtd->writesize <<= 1;
2371 mtd->erasesize <<= 1;
2372 }
2373
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002374 return 0;
2375}
2376
Kyungmin Parka41371e2005-09-29 03:55:31 +01002377/**
2378 * onenand_suspend - [MTD Interface] Suspend the OneNAND flash
2379 * @param mtd MTD device structure
2380 */
2381static int onenand_suspend(struct mtd_info *mtd)
2382{
2383 return onenand_get_device(mtd, FL_PM_SUSPENDED);
2384}
2385
2386/**
2387 * onenand_resume - [MTD Interface] Resume the OneNAND flash
2388 * @param mtd MTD device structure
2389 */
2390static void onenand_resume(struct mtd_info *mtd)
2391{
2392 struct onenand_chip *this = mtd->priv;
2393
2394 if (this->state == FL_PM_SUSPENDED)
2395 onenand_release_device(mtd);
2396 else
2397 printk(KERN_ERR "resume() called for the chip which is not"
2398 "in suspended state\n");
2399}
2400
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002401/**
2402 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
2403 * @param mtd MTD device structure
2404 * @param maxchips Number of chips to scan for
2405 *
2406 * This fills out all the not initialized function pointers
2407 * with the defaults.
2408 * The flash ID is read and the mtd/chip structures are
2409 * filled with the appropriate values.
2410 */
2411int onenand_scan(struct mtd_info *mtd, int maxchips)
2412{
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002413 int i;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002414 struct onenand_chip *this = mtd->priv;
2415
2416 if (!this->read_word)
2417 this->read_word = onenand_readw;
2418 if (!this->write_word)
2419 this->write_word = onenand_writew;
2420
2421 if (!this->command)
2422 this->command = onenand_command;
2423 if (!this->wait)
Kyungmin Park2c221202006-11-16 11:23:48 +09002424 onenand_setup_wait(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002425
2426 if (!this->read_bufferram)
2427 this->read_bufferram = onenand_read_bufferram;
2428 if (!this->write_bufferram)
2429 this->write_bufferram = onenand_write_bufferram;
2430
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002431 if (!this->block_markbad)
2432 this->block_markbad = onenand_default_block_markbad;
2433 if (!this->scan_bbt)
2434 this->scan_bbt = onenand_default_bbt;
2435
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002436 if (onenand_probe(mtd))
2437 return -ENXIO;
2438
Kyungmin Park52b0eea2005-09-03 07:07:19 +01002439 /* Set Sync. Burst Read after probing */
2440 if (this->mmcontrol) {
2441 printk(KERN_INFO "OneNAND Sync. Burst Read support\n");
2442 this->read_bufferram = onenand_sync_read_bufferram;
2443 }
2444
Kyungmin Park532a37c2005-12-16 11:17:29 +09002445 /* Allocate buffers, if necessary */
2446 if (!this->page_buf) {
Kyungmin Park470bc842007-03-09 10:08:11 +09002447 this->page_buf = kzalloc(mtd->writesize, GFP_KERNEL);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002448 if (!this->page_buf) {
2449 printk(KERN_ERR "onenand_scan(): Can't allocate page_buf\n");
2450 return -ENOMEM;
2451 }
2452 this->options |= ONENAND_PAGEBUF_ALLOC;
2453 }
Kyungmin Park470bc842007-03-09 10:08:11 +09002454 if (!this->oob_buf) {
2455 this->oob_buf = kzalloc(mtd->oobsize, GFP_KERNEL);
2456 if (!this->oob_buf) {
2457 printk(KERN_ERR "onenand_scan(): Can't allocate oob_buf\n");
2458 if (this->options & ONENAND_PAGEBUF_ALLOC) {
2459 this->options &= ~ONENAND_PAGEBUF_ALLOC;
2460 kfree(this->page_buf);
2461 }
2462 return -ENOMEM;
2463 }
2464 this->options |= ONENAND_OOBBUF_ALLOC;
2465 }
Kyungmin Park532a37c2005-12-16 11:17:29 +09002466
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002467 this->state = FL_READY;
2468 init_waitqueue_head(&this->wq);
2469 spin_lock_init(&this->chip_lock);
2470
Kyungmin Park60d84f92006-12-22 16:21:54 +09002471 /*
2472 * Allow subpage writes up to oobsize.
2473 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002474 switch (mtd->oobsize) {
2475 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002476 this->ecclayout = &onenand_oob_64;
Kyungmin Park60d84f92006-12-22 16:21:54 +09002477 mtd->subpage_sft = 2;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002478 break;
2479
2480 case 32:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002481 this->ecclayout = &onenand_oob_32;
Kyungmin Park60d84f92006-12-22 16:21:54 +09002482 mtd->subpage_sft = 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002483 break;
2484
2485 default:
2486 printk(KERN_WARNING "No OOB scheme defined for oobsize %d\n",
2487 mtd->oobsize);
Kyungmin Park60d84f92006-12-22 16:21:54 +09002488 mtd->subpage_sft = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002489 /* To prevent kernel oops */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002490 this->ecclayout = &onenand_oob_32;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002491 break;
2492 }
2493
Kyungmin Park60d84f92006-12-22 16:21:54 +09002494 this->subpagesize = mtd->writesize >> mtd->subpage_sft;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002495
2496 /*
2497 * The number of bytes available for a client to place data into
2498 * the out of band area
2499 */
2500 this->ecclayout->oobavail = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09002501 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES &&
2502 this->ecclayout->oobfree[i].length; i++)
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002503 this->ecclayout->oobavail +=
2504 this->ecclayout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03002505 mtd->oobavail = this->ecclayout->oobavail;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002506
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002507 mtd->ecclayout = this->ecclayout;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002508
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002509 /* Fill in remaining MTD driver data */
2510 mtd->type = MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02002511 mtd->flags = MTD_CAP_NANDFLASH;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002512 mtd->erase = onenand_erase;
2513 mtd->point = NULL;
2514 mtd->unpoint = NULL;
2515 mtd->read = onenand_read;
2516 mtd->write = onenand_write;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002517 mtd->read_oob = onenand_read_oob;
2518 mtd->write_oob = onenand_write_oob;
Kyungmin Park493c6462006-05-12 17:03:07 +03002519#ifdef CONFIG_MTD_ONENAND_OTP
2520 mtd->get_fact_prot_info = onenand_get_fact_prot_info;
2521 mtd->read_fact_prot_reg = onenand_read_fact_prot_reg;
2522 mtd->get_user_prot_info = onenand_get_user_prot_info;
2523 mtd->read_user_prot_reg = onenand_read_user_prot_reg;
2524 mtd->write_user_prot_reg = onenand_write_user_prot_reg;
2525 mtd->lock_user_prot_reg = onenand_lock_user_prot_reg;
2526#endif
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002527 mtd->sync = onenand_sync;
Kyungmin Park08f782b2006-11-16 11:29:39 +09002528 mtd->lock = onenand_lock;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002529 mtd->unlock = onenand_unlock;
Kyungmin Parka41371e2005-09-29 03:55:31 +01002530 mtd->suspend = onenand_suspend;
2531 mtd->resume = onenand_resume;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002532 mtd->block_isbad = onenand_block_isbad;
2533 mtd->block_markbad = onenand_block_markbad;
2534 mtd->owner = THIS_MODULE;
2535
2536 /* Unlock whole block */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002537 onenand_unlock_all(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002538
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002539 return this->scan_bbt(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002540}
2541
2542/**
2543 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
2544 * @param mtd MTD device structure
2545 */
2546void onenand_release(struct mtd_info *mtd)
2547{
Kyungmin Park532a37c2005-12-16 11:17:29 +09002548 struct onenand_chip *this = mtd->priv;
2549
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002550#ifdef CONFIG_MTD_PARTITIONS
2551 /* Deregister partitions */
2552 del_mtd_partitions (mtd);
2553#endif
2554 /* Deregister the device */
2555 del_mtd_device (mtd);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002556
2557 /* Free bad block table memory, if allocated */
Adrian Hunterf00b0042007-01-22 17:01:01 +09002558 if (this->bbm) {
2559 struct bbm_info *bbm = this->bbm;
2560 kfree(bbm->bbt);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002561 kfree(this->bbm);
Adrian Hunterf00b0042007-01-22 17:01:01 +09002562 }
Kyungmin Park470bc842007-03-09 10:08:11 +09002563 /* Buffers allocated by onenand_scan */
Kyungmin Park532a37c2005-12-16 11:17:29 +09002564 if (this->options & ONENAND_PAGEBUF_ALLOC)
2565 kfree(this->page_buf);
Kyungmin Park470bc842007-03-09 10:08:11 +09002566 if (this->options & ONENAND_OOBBUF_ALLOC)
2567 kfree(this->oob_buf);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002568}
2569
2570EXPORT_SYMBOL_GPL(onenand_scan);
2571EXPORT_SYMBOL_GPL(onenand_release);
2572
2573MODULE_LICENSE("GPL");
2574MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
2575MODULE_DESCRIPTION("Generic OneNAND flash driver code");