blob: 40d8d6ff626b45a90b6581b4d53a7a3de341c30a [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/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900766 * onenand_transfer_auto_oob - [Internal] oob auto-placement transfer
767 * @param mtd MTD device structure
768 * @param buf destination address
769 * @param column oob offset to read from
770 * @param thislen oob length to read
771 */
772static int onenand_transfer_auto_oob(struct mtd_info *mtd, uint8_t *buf, int column,
773 int thislen)
774{
775 struct onenand_chip *this = mtd->priv;
776 struct nand_oobfree *free;
777 int readcol = column;
778 int readend = column + thislen;
779 int lastgap = 0;
780 unsigned int i;
781 uint8_t *oob_buf = this->oob_buf;
782
783 free = this->ecclayout->oobfree;
784 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
785 if (readcol >= lastgap)
786 readcol += free->offset - lastgap;
787 if (readend >= lastgap)
788 readend += free->offset - lastgap;
789 lastgap = free->offset + free->length;
790 }
791 this->read_bufferram(mtd, ONENAND_SPARERAM, oob_buf, 0, mtd->oobsize);
792 free = this->ecclayout->oobfree;
793 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
794 int free_end = free->offset + free->length;
795 if (free->offset < readend && free_end > readcol) {
796 int st = max_t(int,free->offset,readcol);
797 int ed = min_t(int,free_end,readend);
798 int n = ed - st;
799 memcpy(buf, oob_buf + st, n);
800 buf += n;
801 } else if (column == 0)
802 break;
803 }
804 return 0;
805}
806
807/**
808 * onenand_read_ops - [OneNAND Interface] OneNAND read main and/or out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100809 * @param mtd MTD device structure
810 * @param from offset to read from
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900811 * @param ops: oob operation description structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100812 *
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900813 * OneNAND read main and/or out-of-band data
814 */
815static int onenand_read_ops(struct mtd_info *mtd, loff_t from,
816 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100817{
818 struct onenand_chip *this = mtd->priv;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900819 struct mtd_ecc_stats stats;
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900820 size_t len = ops->len;
821 size_t ooblen = ops->ooblen;
822 u_char *buf = ops->datbuf;
823 u_char *oobbuf = ops->oobbuf;
824 int read = 0, column, thislen;
825 int oobread = 0, oobcolumn, thisooblen, oobsize;
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200826 int ret = 0, boundary = 0;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900827 int writesize = this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100828
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900829 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read_ops: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
830
831 if (ops->mode == MTD_OOB_AUTO)
832 oobsize = this->ecclayout->oobavail;
833 else
834 oobsize = mtd->oobsize;
835
836 oobcolumn = from & (mtd->oobsize - 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100837
838 /* Do not allow reads past end of device */
839 if ((from + len) > mtd->size) {
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900840 printk(KERN_ERR "onenand_read_ops: Attempt read beyond end of device\n");
841 ops->retlen = 0;
842 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100843 return -EINVAL;
844 }
845
846 /* Grab the lock and see if the device is available */
847 onenand_get_device(mtd, FL_READING);
848
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900849 stats = mtd->ecc_stats;
Artem Bityutskiy61a7e192006-12-26 16:41:24 +0900850
Adrian Huntera8de85d2007-01-04 09:51:26 +0200851 /* Read-while-load method */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100852
Adrian Huntera8de85d2007-01-04 09:51:26 +0200853 /* Do first load to bufferRAM */
854 if (read < len) {
855 if (!onenand_check_bufferram(mtd, from)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900856 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200857 ret = this->wait(mtd, FL_READING);
858 onenand_update_bufferram(mtd, from, !ret);
859 }
860 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100861
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900862 thislen = min_t(int, writesize, len - read);
863 column = from & (writesize - 1);
864 if (column + thislen > writesize)
865 thislen = writesize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100866
Adrian Huntera8de85d2007-01-04 09:51:26 +0200867 while (!ret) {
868 /* If there is more to load then start next load */
869 from += thislen;
870 if (read + thislen < len) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900871 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200872 /*
873 * Chip boundary handling in DDP
874 * Now we issued chip 1 read and pointed chip 1
875 * bufferam so we have to point chip 0 bufferam.
876 */
Kyungmin Park738d61f2007-01-15 17:09:14 +0900877 if (ONENAND_IS_DDP(this) &&
878 unlikely(from == (this->chipsize >> 1))) {
879 this->write_word(ONENAND_DDP_CHIP0, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200880 boundary = 1;
881 } else
882 boundary = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +0200883 ONENAND_SET_PREV_BUFFERRAM(this);
884 }
885 /* While load is going, read from last bufferRAM */
886 this->read_bufferram(mtd, ONENAND_DATARAM, buf, column, thislen);
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900887
888 /* Read oob area if needed */
889 if (oobbuf) {
890 thisooblen = oobsize - oobcolumn;
891 thisooblen = min_t(int, thisooblen, ooblen - oobread);
892
893 if (ops->mode == MTD_OOB_AUTO)
894 onenand_transfer_auto_oob(mtd, oobbuf, oobcolumn, thisooblen);
895 else
896 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, oobcolumn, thisooblen);
897 oobread += thisooblen;
898 oobbuf += thisooblen;
899 oobcolumn = 0;
900 }
901
Adrian Huntera8de85d2007-01-04 09:51:26 +0200902 /* See if we are done */
903 read += thislen;
904 if (read == len)
905 break;
906 /* Set up for next read from bufferRAM */
Adrian Hunter0fc2cce2007-01-09 17:55:21 +0200907 if (unlikely(boundary))
Kyungmin Park738d61f2007-01-15 17:09:14 +0900908 this->write_word(ONENAND_DDP_CHIP1, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200909 ONENAND_SET_NEXT_BUFFERRAM(this);
910 buf += thislen;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900911 thislen = min_t(int, writesize, len - read);
Adrian Huntera8de85d2007-01-04 09:51:26 +0200912 column = 0;
913 cond_resched();
914 /* Now wait for load */
915 ret = this->wait(mtd, FL_READING);
916 onenand_update_bufferram(mtd, from, !ret);
917 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100918
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100919 /* Deselect and wake up anyone waiting on the device */
920 onenand_release_device(mtd);
921
922 /*
923 * Return success, if no ECC failures, else -EBADMSG
924 * fs driver will take care of that, because
925 * retlen == desired len and result == -EBADMSG
926 */
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900927 ops->retlen = read;
928 ops->oobretlen = oobread;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900929
930 if (mtd->ecc_stats.failed - stats.failed)
931 return -EBADMSG;
932
Adrian Huntera8de85d2007-01-04 09:51:26 +0200933 if (ret)
934 return ret;
935
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900936 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100937}
938
939/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200940 * onenand_do_read_oob - [MTD Interface] OneNAND read out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100941 * @param mtd MTD device structure
942 * @param from offset to read from
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900943 * @param ops: oob operation description structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100944 *
945 * OneNAND read out-of-band data from the spare area
946 */
Kyungmin Park12f77c92007-08-30 09:36:05 +0900947static int onenand_do_read_oob(struct mtd_info *mtd, loff_t from,
948 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100949{
950 struct onenand_chip *this = mtd->priv;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200951 int read = 0, thislen, column, oobsize;
Kyungmin Park12f77c92007-08-30 09:36:05 +0900952 size_t len = ops->ooblen;
953 mtd_oob_mode_t mode = ops->mode;
954 u_char *buf = ops->oobbuf;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100955 int ret = 0;
956
Kyungmin Park12f77c92007-08-30 09:36:05 +0900957 from += ops->ooboffs;
958
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100959 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read_oob: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
960
961 /* Initialize return length value */
Kyungmin Park12f77c92007-08-30 09:36:05 +0900962 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100963
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200964 if (mode == MTD_OOB_AUTO)
965 oobsize = this->ecclayout->oobavail;
966 else
967 oobsize = mtd->oobsize;
968
969 column = from & (mtd->oobsize - 1);
970
971 if (unlikely(column >= oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900972 printk(KERN_ERR "onenand_read_oob: Attempted to start read outside oob\n");
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200973 return -EINVAL;
974 }
975
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100976 /* Do not allow reads past end of device */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200977 if (unlikely(from >= mtd->size ||
978 column + len > ((mtd->size >> this->page_shift) -
979 (from >> this->page_shift)) * oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +0900980 printk(KERN_ERR "onenand_read_oob: Attempted to read beyond end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100981 return -EINVAL;
982 }
983
984 /* Grab the lock and see if the device is available */
985 onenand_get_device(mtd, FL_READING);
986
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100987 while (read < len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +0900988 cond_resched();
989
Adrian Huntera5e7c7b2007-01-31 17:19:28 +0200990 thislen = oobsize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100991 thislen = min_t(int, thislen, len);
992
993 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
994
995 onenand_update_bufferram(mtd, from, 0);
996
997 ret = this->wait(mtd, FL_READING);
998 /* First copy data and check return value for ECC handling */
999
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001000 if (mode == MTD_OOB_AUTO)
1001 onenand_transfer_auto_oob(mtd, buf, column, thislen);
1002 else
1003 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001004
Kyungmin Parkf6272482006-12-22 16:02:50 +09001005 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001006 printk(KERN_ERR "onenand_read_oob: read failed = 0x%x\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001007 break;
Kyungmin Parkf6272482006-12-22 16:02:50 +09001008 }
1009
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001010 read += thislen;
1011
1012 if (read == len)
1013 break;
1014
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001015 buf += thislen;
1016
1017 /* Read more? */
1018 if (read < len) {
1019 /* Page size */
Joern Engel28318772006-05-22 23:18:05 +02001020 from += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001021 column = 0;
1022 }
1023 }
1024
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001025 /* Deselect and wake up anyone waiting on the device */
1026 onenand_release_device(mtd);
1027
Kyungmin Park12f77c92007-08-30 09:36:05 +09001028 ops->oobretlen = read;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001029 return ret;
1030}
1031
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001032/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001033 * onenand_read - [MTD Interface] Read data from flash
1034 * @param mtd MTD device structure
1035 * @param from offset to read from
1036 * @param len number of bytes to read
1037 * @param retlen pointer to variable to store the number of read bytes
1038 * @param buf the databuffer to put data
1039 *
1040 * Read with ecc
1041*/
1042static int onenand_read(struct mtd_info *mtd, loff_t from, size_t len,
1043 size_t *retlen, u_char *buf)
1044{
1045 struct mtd_oob_ops ops = {
1046 .len = len,
1047 .ooblen = 0,
1048 .datbuf = buf,
1049 .oobbuf = NULL,
1050 };
1051 int ret;
1052
1053 ret = onenand_read_ops(mtd, from, &ops);
1054 *retlen = ops.retlen;
1055
1056 return ret;
1057}
1058
1059/**
1060 * onenand_read_oob - [MTD Interface] Read main and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001061 * @param mtd: MTD device structure
1062 * @param from: offset to read from
1063 * @param ops: oob operation description structure
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001064
1065 * Read main and/or out-of-band
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001066 */
1067static int onenand_read_oob(struct mtd_info *mtd, loff_t from,
1068 struct mtd_oob_ops *ops)
1069{
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001070 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001071 case MTD_OOB_PLACE:
1072 case MTD_OOB_AUTO:
1073 break;
1074 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001075 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001076 default:
1077 return -EINVAL;
1078 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001079
1080 if (ops->datbuf)
1081 return onenand_read_ops(mtd, from, ops);
1082
Kyungmin Park12f77c92007-08-30 09:36:05 +09001083 return onenand_do_read_oob(mtd, from, ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001084}
1085
Kyungmin Park211ac752007-02-07 12:15:01 +09001086/**
1087 * onenand_bbt_wait - [DEFAULT] wait until the command is done
1088 * @param mtd MTD device structure
1089 * @param state state to select the max. timeout value
1090 *
1091 * Wait for command done.
1092 */
1093static int onenand_bbt_wait(struct mtd_info *mtd, int state)
1094{
1095 struct onenand_chip *this = mtd->priv;
1096 unsigned long timeout;
1097 unsigned int interrupt;
1098 unsigned int ctrl;
1099
1100 /* The 20 msec is enough */
1101 timeout = jiffies + msecs_to_jiffies(20);
1102 while (time_before(jiffies, timeout)) {
1103 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1104 if (interrupt & ONENAND_INT_MASTER)
1105 break;
1106 }
1107 /* To get correct interrupt status in timeout case */
1108 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1109 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
1110
1111 if (ctrl & ONENAND_CTRL_ERROR) {
1112 printk(KERN_DEBUG "onenand_bbt_wait: controller error = 0x%04x\n", ctrl);
1113 /* Initial bad block case */
1114 if (ctrl & ONENAND_CTRL_LOAD)
1115 return ONENAND_BBT_READ_ERROR;
1116 return ONENAND_BBT_READ_FATAL_ERROR;
1117 }
1118
1119 if (interrupt & ONENAND_INT_READ) {
1120 int ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS);
1121 if (ecc & ONENAND_ECC_2BIT_ALL)
1122 return ONENAND_BBT_READ_ERROR;
1123 } else {
1124 printk(KERN_ERR "onenand_bbt_wait: read timeout!"
1125 "ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
1126 return ONENAND_BBT_READ_FATAL_ERROR;
1127 }
1128
1129 return 0;
1130}
1131
1132/**
1133 * onenand_bbt_read_oob - [MTD Interface] OneNAND read out-of-band for bbt scan
1134 * @param mtd MTD device structure
1135 * @param from offset to read from
Kyungmin Parke3da8062007-02-15 09:36:39 +09001136 * @param ops oob operation description structure
Kyungmin Park211ac752007-02-07 12:15:01 +09001137 *
1138 * OneNAND read out-of-band data from the spare area for bbt scan
1139 */
1140int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
1141 struct mtd_oob_ops *ops)
1142{
1143 struct onenand_chip *this = mtd->priv;
1144 int read = 0, thislen, column;
1145 int ret = 0;
1146 size_t len = ops->ooblen;
1147 u_char *buf = ops->oobbuf;
1148
Andrew Morton5785bdd2007-02-17 16:02:05 -08001149 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 +09001150
1151 /* Initialize return value */
1152 ops->oobretlen = 0;
1153
1154 /* Do not allow reads past end of device */
1155 if (unlikely((from + len) > mtd->size)) {
1156 printk(KERN_ERR "onenand_bbt_read_oob: Attempt read beyond end of device\n");
1157 return ONENAND_BBT_READ_FATAL_ERROR;
1158 }
1159
1160 /* Grab the lock and see if the device is available */
1161 onenand_get_device(mtd, FL_READING);
1162
1163 column = from & (mtd->oobsize - 1);
1164
1165 while (read < len) {
1166 cond_resched();
1167
1168 thislen = mtd->oobsize - column;
1169 thislen = min_t(int, thislen, len);
1170
1171 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
1172
1173 onenand_update_bufferram(mtd, from, 0);
1174
1175 ret = onenand_bbt_wait(mtd, FL_READING);
1176 if (ret)
1177 break;
1178
1179 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
1180 read += thislen;
1181 if (read == len)
1182 break;
1183
1184 buf += thislen;
1185
1186 /* Read more? */
1187 if (read < len) {
1188 /* Update Page size */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001189 from += this->writesize;
Kyungmin Park211ac752007-02-07 12:15:01 +09001190 column = 0;
1191 }
1192 }
1193
1194 /* Deselect and wake up anyone waiting on the device */
1195 onenand_release_device(mtd);
1196
1197 ops->oobretlen = read;
1198 return ret;
1199}
1200
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001201#ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
1202/**
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001203 * onenand_verify_oob - [GENERIC] verify the oob contents after a write
1204 * @param mtd MTD device structure
1205 * @param buf the databuffer to verify
1206 * @param to offset to read from
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001207 */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001208static int onenand_verify_oob(struct mtd_info *mtd, const u_char *buf, loff_t to)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001209{
1210 struct onenand_chip *this = mtd->priv;
Kyungmin Park91014e92007-02-12 10:34:39 +09001211 char oobbuf[64];
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001212 int status, i;
1213
1214 this->command(mtd, ONENAND_CMD_READOOB, to, mtd->oobsize);
1215 onenand_update_bufferram(mtd, to, 0);
1216 status = this->wait(mtd, FL_READING);
1217 if (status)
1218 return status;
1219
Kyungmin Park91014e92007-02-12 10:34:39 +09001220 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
1221 for (i = 0; i < mtd->oobsize; i++)
1222 if (buf[i] != 0xFF && buf[i] != oobbuf[i])
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001223 return -EBADMSG;
1224
1225 return 0;
1226}
1227
1228/**
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001229 * onenand_verify - [GENERIC] verify the chip contents after a write
1230 * @param mtd MTD device structure
1231 * @param buf the databuffer to verify
1232 * @param addr offset to read from
1233 * @param len number of bytes to read and compare
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001234 */
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001235static int onenand_verify(struct mtd_info *mtd, const u_char *buf, loff_t addr, size_t len)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001236{
1237 struct onenand_chip *this = mtd->priv;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001238 void __iomem *dataram;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001239 int ret = 0;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001240 int thislen, column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001241
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001242 while (len != 0) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001243 thislen = min_t(int, this->writesize, len);
1244 column = addr & (this->writesize - 1);
1245 if (column + thislen > this->writesize)
1246 thislen = this->writesize - column;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001247
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001248 this->command(mtd, ONENAND_CMD_READ, addr, this->writesize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001249
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001250 onenand_update_bufferram(mtd, addr, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001251
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001252 ret = this->wait(mtd, FL_READING);
1253 if (ret)
1254 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001255
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001256 onenand_update_bufferram(mtd, addr, 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001257
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001258 dataram = this->base + ONENAND_DATARAM;
1259 dataram += onenand_bufferram_offset(mtd, ONENAND_DATARAM);
1260
1261 if (memcmp(buf, dataram + column, thislen))
1262 return -EBADMSG;
1263
1264 len -= thislen;
1265 buf += thislen;
1266 addr += thislen;
1267 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001268
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001269 return 0;
1270}
1271#else
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001272#define onenand_verify(...) (0)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001273#define onenand_verify_oob(...) (0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001274#endif
1275
Kyungmin Park60d84f92006-12-22 16:21:54 +09001276#define NOTALIGNED(x) ((x & (this->subpagesize - 1)) != 0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001277
1278/**
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001279 * onenand_fill_auto_oob - [Internal] oob auto-placement transfer
1280 * @param mtd MTD device structure
1281 * @param oob_buf oob buffer
1282 * @param buf source address
1283 * @param column oob offset to write to
1284 * @param thislen oob length to write
1285 */
1286static int onenand_fill_auto_oob(struct mtd_info *mtd, u_char *oob_buf,
1287 const u_char *buf, int column, int thislen)
1288{
1289 struct onenand_chip *this = mtd->priv;
1290 struct nand_oobfree *free;
1291 int writecol = column;
1292 int writeend = column + thislen;
1293 int lastgap = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09001294 unsigned int i;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001295
Kyungmin Parkad286342007-03-23 10:19:52 +09001296 free = this->ecclayout->oobfree;
1297 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001298 if (writecol >= lastgap)
1299 writecol += free->offset - lastgap;
1300 if (writeend >= lastgap)
1301 writeend += free->offset - lastgap;
1302 lastgap = free->offset + free->length;
1303 }
Kyungmin Parkad286342007-03-23 10:19:52 +09001304 free = this->ecclayout->oobfree;
1305 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001306 int free_end = free->offset + free->length;
1307 if (free->offset < writeend && free_end > writecol) {
1308 int st = max_t(int,free->offset,writecol);
1309 int ed = min_t(int,free_end,writeend);
1310 int n = ed - st;
1311 memcpy(oob_buf + st, buf, n);
1312 buf += n;
Adrian Hunterc36c46d2007-03-23 17:16:22 +09001313 } else if (column == 0)
Kyungmin Park5bc399e2007-03-09 09:41:07 +09001314 break;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001315 }
1316 return 0;
1317}
1318
1319/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001320 * onenand_write_ops - [OneNAND Interface] write main and/or out-of-band
1321 * @param mtd MTD device structure
1322 * @param to offset to write to
1323 * @param ops oob operation description structure
1324 *
1325 * Write main and/or oob with ECC
1326 */
1327static int onenand_write_ops(struct mtd_info *mtd, loff_t to,
1328 struct mtd_oob_ops *ops)
1329{
1330 struct onenand_chip *this = mtd->priv;
1331 int written = 0, column, thislen, subpage;
1332 int oobwritten = 0, oobcolumn, thisooblen, oobsize;
1333 size_t len = ops->len;
1334 size_t ooblen = ops->ooblen;
1335 const u_char *buf = ops->datbuf;
1336 const u_char *oob = ops->oobbuf;
1337 u_char *oobbuf;
1338 int ret = 0;
1339
1340 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
1341
1342 /* Initialize retlen, in case of early exit */
1343 ops->retlen = 0;
1344 ops->oobretlen = 0;
1345
1346 /* Do not allow writes past end of device */
1347 if (unlikely((to + len) > mtd->size)) {
1348 printk(KERN_ERR "onenand_write: Attempt write to past end of device\n");
1349 return -EINVAL;
1350 }
1351
1352 /* Reject writes, which are not page aligned */
1353 if (unlikely(NOTALIGNED(to)) || unlikely(NOTALIGNED(len))) {
1354 printk(KERN_ERR "onenand_write: Attempt to write not page aligned data\n");
1355 return -EINVAL;
1356 }
1357
1358 if (ops->mode == MTD_OOB_AUTO)
1359 oobsize = this->ecclayout->oobavail;
1360 else
1361 oobsize = mtd->oobsize;
1362
1363 oobcolumn = to & (mtd->oobsize - 1);
1364
1365 column = to & (mtd->writesize - 1);
1366
1367 /* Grab the lock and see if the device is available */
1368 onenand_get_device(mtd, FL_WRITING);
1369
1370 /* Loop until all data write */
1371 while (written < len) {
1372 u_char *wbuf = (u_char *) buf;
1373
1374 thislen = min_t(int, mtd->writesize - column, len - written);
1375 thisooblen = min_t(int, oobsize - oobcolumn, ooblen - oobwritten);
1376
1377 cond_resched();
1378
1379 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, thislen);
1380
1381 /* Partial page write */
1382 subpage = thislen < mtd->writesize;
1383 if (subpage) {
1384 memset(this->page_buf, 0xff, mtd->writesize);
1385 memcpy(this->page_buf + column, buf, thislen);
1386 wbuf = this->page_buf;
1387 }
1388
1389 this->write_bufferram(mtd, ONENAND_DATARAM, wbuf, 0, mtd->writesize);
1390
1391 if (oob) {
1392 oobbuf = this->oob_buf;
1393
1394 /* We send data to spare ram with oobsize
1395 * to prevent byte access */
1396 memset(oobbuf, 0xff, mtd->oobsize);
1397 if (ops->mode == MTD_OOB_AUTO)
1398 onenand_fill_auto_oob(mtd, oobbuf, oob, oobcolumn, thisooblen);
1399 else
1400 memcpy(oobbuf + oobcolumn, oob, thisooblen);
1401
1402 oobwritten += thisooblen;
1403 oob += thisooblen;
1404 oobcolumn = 0;
1405 } else
1406 oobbuf = (u_char *) ffchars;
1407
1408 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
1409
1410 this->command(mtd, ONENAND_CMD_PROG, to, mtd->writesize);
1411
1412 ret = this->wait(mtd, FL_WRITING);
1413
1414 /* In partial page write we don't update bufferram */
1415 onenand_update_bufferram(mtd, to, !ret && !subpage);
1416 if (ONENAND_IS_2PLANE(this)) {
1417 ONENAND_SET_BUFFERRAM1(this);
1418 onenand_update_bufferram(mtd, to + this->writesize, !ret && !subpage);
1419 }
1420
1421 if (ret) {
1422 printk(KERN_ERR "onenand_write: write filaed %d\n", ret);
1423 break;
1424 }
1425
1426 /* Only check verify write turn on */
1427 ret = onenand_verify(mtd, (u_char *) wbuf, to, thislen);
1428 if (ret) {
1429 printk(KERN_ERR "onenand_write: verify failed %d\n", ret);
1430 break;
1431 }
1432
1433 written += thislen;
1434
1435 if (written == len)
1436 break;
1437
1438 column = 0;
1439 to += thislen;
1440 buf += thislen;
1441 }
1442
1443 /* Deselect and wake up anyone waiting on the device */
1444 onenand_release_device(mtd);
1445
1446 ops->retlen = written;
1447
1448 return ret;
1449}
1450
1451
1452/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001453 * onenand_do_write_oob - [Internal] OneNAND write out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001454 * @param mtd MTD device structure
1455 * @param to offset to write to
1456 * @param len number of bytes to write
1457 * @param retlen pointer to variable to store the number of written bytes
1458 * @param buf the data to write
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001459 * @param mode operation mode
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001460 *
1461 * OneNAND write out-of-band
1462 */
Kyungmin Park12f77c92007-08-30 09:36:05 +09001463static int onenand_do_write_oob(struct mtd_info *mtd, loff_t to,
1464 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001465{
1466 struct onenand_chip *this = mtd->priv;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001467 int column, ret = 0, oobsize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001468 int written = 0;
Kyungmin Park91014e92007-02-12 10:34:39 +09001469 u_char *oobbuf;
Kyungmin Park12f77c92007-08-30 09:36:05 +09001470 size_t len = ops->ooblen;
1471 const u_char *buf = ops->oobbuf;
1472 mtd_oob_mode_t mode = ops->mode;
1473
1474 to += ops->ooboffs;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001475
1476 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write_oob: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
1477
1478 /* Initialize retlen, in case of early exit */
Kyungmin Park12f77c92007-08-30 09:36:05 +09001479 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001480
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001481 if (mode == MTD_OOB_AUTO)
1482 oobsize = this->ecclayout->oobavail;
1483 else
1484 oobsize = mtd->oobsize;
1485
1486 column = to & (mtd->oobsize - 1);
1487
1488 if (unlikely(column >= oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001489 printk(KERN_ERR "onenand_write_oob: Attempted to start write outside oob\n");
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001490 return -EINVAL;
1491 }
1492
Adrian Hunter52e42002007-02-06 09:15:39 +09001493 /* For compatibility with NAND: Do not allow write past end of page */
Kyungmin Park91014e92007-02-12 10:34:39 +09001494 if (unlikely(column + len > oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001495 printk(KERN_ERR "onenand_write_oob: "
Adrian Hunter52e42002007-02-06 09:15:39 +09001496 "Attempt to write past end of page\n");
1497 return -EINVAL;
1498 }
1499
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001500 /* Do not allow reads past end of device */
1501 if (unlikely(to >= mtd->size ||
1502 column + len > ((mtd->size >> this->page_shift) -
1503 (to >> this->page_shift)) * oobsize)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001504 printk(KERN_ERR "onenand_write_oob: Attempted to write past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001505 return -EINVAL;
1506 }
1507
1508 /* Grab the lock and see if the device is available */
1509 onenand_get_device(mtd, FL_WRITING);
1510
Kyungmin Park470bc842007-03-09 10:08:11 +09001511 oobbuf = this->oob_buf;
Kyungmin Park91014e92007-02-12 10:34:39 +09001512
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001513 /* Loop until all data write */
1514 while (written < len) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001515 int thislen = min_t(int, oobsize, len - written);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001516
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001517 cond_resched();
1518
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001519 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, mtd->oobsize);
1520
Kyungmin Park34c10602006-05-12 17:02:46 +03001521 /* We send data to spare ram with oobsize
1522 * to prevent byte access */
Kyungmin Park91014e92007-02-12 10:34:39 +09001523 memset(oobbuf, 0xff, mtd->oobsize);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001524 if (mode == MTD_OOB_AUTO)
Kyungmin Park91014e92007-02-12 10:34:39 +09001525 onenand_fill_auto_oob(mtd, oobbuf, buf, column, thislen);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001526 else
Kyungmin Park91014e92007-02-12 10:34:39 +09001527 memcpy(oobbuf + column, buf, thislen);
1528 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001529
1530 this->command(mtd, ONENAND_CMD_PROGOOB, to, mtd->oobsize);
1531
1532 onenand_update_bufferram(mtd, to, 0);
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001533 if (ONENAND_IS_2PLANE(this)) {
1534 ONENAND_SET_BUFFERRAM1(this);
1535 onenand_update_bufferram(mtd, to + this->writesize, 0);
1536 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001537
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001538 ret = this->wait(mtd, FL_WRITING);
1539 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001540 printk(KERN_ERR "onenand_write_oob: write failed %d\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001541 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001542 }
1543
Kyungmin Park91014e92007-02-12 10:34:39 +09001544 ret = onenand_verify_oob(mtd, oobbuf, to);
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001545 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001546 printk(KERN_ERR "onenand_write_oob: verify failed %d\n", ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09001547 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001548 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001549
1550 written += thislen;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001551 if (written == len)
1552 break;
1553
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001554 to += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001555 buf += thislen;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001556 column = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001557 }
1558
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001559 /* Deselect and wake up anyone waiting on the device */
1560 onenand_release_device(mtd);
1561
Kyungmin Park12f77c92007-08-30 09:36:05 +09001562 ops->oobretlen = written;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001563
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001564 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001565}
1566
1567/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001568 * onenand_write - [MTD Interface] write buffer to FLASH
1569 * @param mtd MTD device structure
1570 * @param to offset to write to
1571 * @param len number of bytes to write
1572 * @param retlen pointer to variable to store the number of written bytes
1573 * @param buf the data to write
1574 *
1575 * Write with ECC
1576 */
1577static int onenand_write(struct mtd_info *mtd, loff_t to, size_t len,
1578 size_t *retlen, const u_char *buf)
1579{
1580 struct mtd_oob_ops ops = {
1581 .len = len,
1582 .ooblen = 0,
1583 .datbuf = (u_char *) buf,
1584 .oobbuf = NULL,
1585 };
1586 int ret;
1587
1588 ret = onenand_write_ops(mtd, to, &ops);
1589 *retlen = ops.retlen;
1590
1591 return ret;
1592}
1593
1594/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001595 * onenand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001596 * @param mtd: MTD device structure
1597 * @param to: offset to write
1598 * @param ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001599 */
1600static int onenand_write_oob(struct mtd_info *mtd, loff_t to,
1601 struct mtd_oob_ops *ops)
1602{
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001603 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001604 case MTD_OOB_PLACE:
1605 case MTD_OOB_AUTO:
1606 break;
1607 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001608 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001609 default:
1610 return -EINVAL;
1611 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001612
1613 if (ops->datbuf)
1614 return onenand_write_ops(mtd, to, ops);
1615
Kyungmin Park12f77c92007-08-30 09:36:05 +09001616 return onenand_do_write_oob(mtd, to, ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001617}
1618
1619/**
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001620 * onenand_block_checkbad - [GENERIC] Check if a block is marked bad
1621 * @param mtd MTD device structure
1622 * @param ofs offset from device start
1623 * @param getchip 0, if the chip is already selected
1624 * @param allowbbt 1, if its allowed to access the bbt area
1625 *
1626 * Check, if the block is bad. Either by reading the bad block table or
1627 * calling of the scan function.
1628 */
1629static int onenand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip, int allowbbt)
1630{
1631 struct onenand_chip *this = mtd->priv;
1632 struct bbm_info *bbm = this->bbm;
1633
1634 /* Return info from the table */
1635 return bbm->isbad_bbt(mtd, ofs, allowbbt);
1636}
1637
1638/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001639 * onenand_erase - [MTD Interface] erase block(s)
1640 * @param mtd MTD device structure
1641 * @param instr erase instruction
1642 *
1643 * Erase one ore more blocks
1644 */
1645static int onenand_erase(struct mtd_info *mtd, struct erase_info *instr)
1646{
1647 struct onenand_chip *this = mtd->priv;
1648 unsigned int block_size;
1649 loff_t addr;
1650 int len;
1651 int ret = 0;
1652
1653 DEBUG(MTD_DEBUG_LEVEL3, "onenand_erase: start = 0x%08x, len = %i\n", (unsigned int) instr->addr, (unsigned int) instr->len);
1654
1655 block_size = (1 << this->erase_shift);
1656
1657 /* Start address must align on block boundary */
1658 if (unlikely(instr->addr & (block_size - 1))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001659 printk(KERN_ERR "onenand_erase: Unaligned address\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001660 return -EINVAL;
1661 }
1662
1663 /* Length must align on block boundary */
1664 if (unlikely(instr->len & (block_size - 1))) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001665 printk(KERN_ERR "onenand_erase: Length not block aligned\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001666 return -EINVAL;
1667 }
1668
1669 /* Do not allow erase past end of device */
1670 if (unlikely((instr->len + instr->addr) > mtd->size)) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001671 printk(KERN_ERR "onenand_erase: Erase past end of device\n");
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001672 return -EINVAL;
1673 }
1674
1675 instr->fail_addr = 0xffffffff;
1676
1677 /* Grab the lock and see if the device is available */
1678 onenand_get_device(mtd, FL_ERASING);
1679
1680 /* Loop throught the pages */
1681 len = instr->len;
1682 addr = instr->addr;
1683
1684 instr->state = MTD_ERASING;
1685
1686 while (len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001687 cond_resched();
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001688
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001689 /* Check if we have a bad block, we do not erase bad blocks */
1690 if (onenand_block_checkbad(mtd, addr, 0, 0)) {
1691 printk (KERN_WARNING "onenand_erase: attempt to erase a bad block at addr 0x%08x\n", (unsigned int) addr);
1692 instr->state = MTD_ERASE_FAILED;
1693 goto erase_exit;
1694 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001695
1696 this->command(mtd, ONENAND_CMD_ERASE, addr, block_size);
1697
Adrian Hunter480b9df2007-02-07 13:55:19 +02001698 onenand_invalidate_bufferram(mtd, addr, block_size);
1699
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001700 ret = this->wait(mtd, FL_ERASING);
1701 /* Check, if it is write protected */
1702 if (ret) {
Kyungmin Park211ac752007-02-07 12:15:01 +09001703 printk(KERN_ERR "onenand_erase: Failed erase, block %d\n", (unsigned) (addr >> this->erase_shift));
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001704 instr->state = MTD_ERASE_FAILED;
1705 instr->fail_addr = addr;
1706 goto erase_exit;
1707 }
1708
1709 len -= block_size;
1710 addr += block_size;
1711 }
1712
1713 instr->state = MTD_ERASE_DONE;
1714
1715erase_exit:
1716
1717 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
1718 /* Do call back function */
1719 if (!ret)
1720 mtd_erase_callback(instr);
1721
1722 /* Deselect and wake up anyone waiting on the device */
1723 onenand_release_device(mtd);
1724
1725 return ret;
1726}
1727
1728/**
1729 * onenand_sync - [MTD Interface] sync
1730 * @param mtd MTD device structure
1731 *
1732 * Sync is actually a wait for chip ready function
1733 */
1734static void onenand_sync(struct mtd_info *mtd)
1735{
1736 DEBUG(MTD_DEBUG_LEVEL3, "onenand_sync: called\n");
1737
1738 /* Grab the lock and see if the device is available */
1739 onenand_get_device(mtd, FL_SYNCING);
1740
1741 /* Release it and go back */
1742 onenand_release_device(mtd);
1743}
1744
1745/**
1746 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
1747 * @param mtd MTD device structure
1748 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001749 *
1750 * Check whether the block is bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001751 */
1752static int onenand_block_isbad(struct mtd_info *mtd, loff_t ofs)
1753{
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001754 /* Check for invalid offset */
1755 if (ofs > mtd->size)
1756 return -EINVAL;
1757
1758 return onenand_block_checkbad(mtd, ofs, 1, 0);
1759}
1760
1761/**
1762 * onenand_default_block_markbad - [DEFAULT] mark a block bad
1763 * @param mtd MTD device structure
1764 * @param ofs offset from device start
1765 *
1766 * This is the default implementation, which can be overridden by
1767 * a hardware specific driver.
1768 */
1769static int onenand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
1770{
1771 struct onenand_chip *this = mtd->priv;
1772 struct bbm_info *bbm = this->bbm;
1773 u_char buf[2] = {0, 0};
Kyungmin Park12f77c92007-08-30 09:36:05 +09001774 struct mtd_oob_ops ops = {
1775 .mode = MTD_OOB_PLACE,
1776 .ooblen = 2,
1777 .oobbuf = buf,
1778 .ooboffs = 0,
1779 };
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001780 int block;
1781
1782 /* Get block number */
1783 block = ((int) ofs) >> bbm->bbt_erase_shift;
1784 if (bbm->bbt)
1785 bbm->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
1786
1787 /* We write two bytes, so we dont have to mess with 16 bit access */
1788 ofs += mtd->oobsize + (bbm->badblockpos & ~0x01);
Kyungmin Park12f77c92007-08-30 09:36:05 +09001789 return onenand_do_write_oob(mtd, ofs, &ops);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001790}
1791
1792/**
1793 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
1794 * @param mtd MTD device structure
1795 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001796 *
1797 * Mark the block as bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001798 */
1799static int onenand_block_markbad(struct mtd_info *mtd, loff_t ofs)
1800{
Kyungmin Parkcdc00132005-09-03 07:15:48 +01001801 struct onenand_chip *this = mtd->priv;
1802 int ret;
1803
1804 ret = onenand_block_isbad(mtd, ofs);
1805 if (ret) {
1806 /* If it was bad already, return success and do nothing */
1807 if (ret > 0)
1808 return 0;
1809 return ret;
1810 }
1811
1812 return this->block_markbad(mtd, ofs);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001813}
1814
1815/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09001816 * onenand_do_lock_cmd - [OneNAND Interface] Lock or unlock block(s)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001817 * @param mtd MTD device structure
1818 * @param ofs offset relative to mtd start
Kyungmin Park08f782b2006-11-16 11:29:39 +09001819 * @param len number of bytes to lock or unlock
Kyungmin Parke3da8062007-02-15 09:36:39 +09001820 * @param cmd lock or unlock command
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001821 *
Kyungmin Park08f782b2006-11-16 11:29:39 +09001822 * Lock or unlock one or more blocks
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001823 */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001824static int onenand_do_lock_cmd(struct mtd_info *mtd, loff_t ofs, size_t len, int cmd)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001825{
1826 struct onenand_chip *this = mtd->priv;
1827 int start, end, block, value, status;
Kyungmin Park08f782b2006-11-16 11:29:39 +09001828 int wp_status_mask;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001829
1830 start = ofs >> this->erase_shift;
1831 end = len >> this->erase_shift;
1832
Kyungmin Park08f782b2006-11-16 11:29:39 +09001833 if (cmd == ONENAND_CMD_LOCK)
1834 wp_status_mask = ONENAND_WP_LS;
1835 else
1836 wp_status_mask = ONENAND_WP_US;
1837
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001838 /* Continuous lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001839 if (this->options & ONENAND_HAS_CONT_LOCK) {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001840 /* Set start block address */
1841 this->write_word(start, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1842 /* Set end block address */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001843 this->write_word(start + end - 1, this->base + ONENAND_REG_END_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001844 /* Write lock command */
1845 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001846
1847 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001848 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001849
1850 /* Sanity check */
1851 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1852 & ONENAND_CTRL_ONGO)
1853 continue;
1854
1855 /* Check lock status */
1856 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001857 if (!(status & wp_status_mask))
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001858 printk(KERN_ERR "wp status = 0x%x\n", status);
1859
1860 return 0;
1861 }
1862
1863 /* Block lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001864 for (block = start; block < start + end; block++) {
Kyungmin Park20ba89a2005-12-16 11:17:29 +09001865 /* Set block address */
1866 value = onenand_block_address(this, block);
1867 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1868 /* Select DataRAM for DDP */
1869 value = onenand_bufferram_address(this, block);
1870 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001871 /* Set start block address */
1872 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001873 /* Write lock command */
1874 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001875
1876 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001877 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001878
1879 /* Sanity check */
1880 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1881 & ONENAND_CTRL_ONGO)
1882 continue;
1883
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001884 /* Check lock status */
1885 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09001886 if (!(status & wp_status_mask))
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001887 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1888 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001889
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001890 return 0;
1891}
1892
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001893/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09001894 * onenand_lock - [MTD Interface] Lock block(s)
1895 * @param mtd MTD device structure
1896 * @param ofs offset relative to mtd start
1897 * @param len number of bytes to unlock
1898 *
1899 * Lock one or more blocks
1900 */
1901static int onenand_lock(struct mtd_info *mtd, loff_t ofs, size_t len)
1902{
1903 return onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_LOCK);
1904}
1905
Kyungmin Park08f782b2006-11-16 11:29:39 +09001906/**
1907 * onenand_unlock - [MTD Interface] Unlock block(s)
1908 * @param mtd MTD device structure
1909 * @param ofs offset relative to mtd start
1910 * @param len number of bytes to unlock
1911 *
1912 * Unlock one or more blocks
1913 */
1914static int onenand_unlock(struct mtd_info *mtd, loff_t ofs, size_t len)
1915{
1916 return onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
1917}
1918
1919/**
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001920 * onenand_check_lock_status - [OneNAND Interface] Check lock status
1921 * @param this onenand chip data structure
1922 *
1923 * Check lock status
1924 */
1925static void onenand_check_lock_status(struct onenand_chip *this)
1926{
1927 unsigned int value, block, status;
1928 unsigned int end;
1929
1930 end = this->chipsize >> this->erase_shift;
1931 for (block = 0; block < end; block++) {
1932 /* Set block address */
1933 value = onenand_block_address(this, block);
1934 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1935 /* Select DataRAM for DDP */
1936 value = onenand_bufferram_address(this, block);
1937 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
1938 /* Set start block address */
1939 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1940
1941 /* Check lock status */
1942 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
1943 if (!(status & ONENAND_WP_US))
1944 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1945 }
1946}
1947
1948/**
1949 * onenand_unlock_all - [OneNAND Interface] unlock all blocks
1950 * @param mtd MTD device structure
1951 *
1952 * Unlock all blocks
1953 */
1954static int onenand_unlock_all(struct mtd_info *mtd)
1955{
1956 struct onenand_chip *this = mtd->priv;
1957
1958 if (this->options & ONENAND_HAS_UNLOCK_ALL) {
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09001959 /* Set start block address */
1960 this->write_word(0, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001961 /* Write unlock command */
1962 this->command(mtd, ONENAND_CMD_UNLOCK_ALL, 0, 0);
1963
1964 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09001965 this->wait(mtd, FL_LOCKING);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001966
1967 /* Sanity check */
1968 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1969 & ONENAND_CTRL_ONGO)
1970 continue;
1971
1972 /* Workaround for all block unlock in DDP */
Kyungmin Park738d61f2007-01-15 17:09:14 +09001973 if (ONENAND_IS_DDP(this)) {
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001974 /* 1st block on another chip */
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09001975 loff_t ofs = this->chipsize >> 1;
1976 size_t len = mtd->erasesize;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001977
1978 onenand_unlock(mtd, ofs, len);
1979 }
1980
1981 onenand_check_lock_status(this);
1982
1983 return 0;
1984 }
1985
Kyungmin Park08f782b2006-11-16 11:29:39 +09001986 onenand_unlock(mtd, 0x0, this->chipsize);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00001987
1988 return 0;
1989}
1990
Kyungmin Park493c6462006-05-12 17:03:07 +03001991#ifdef CONFIG_MTD_ONENAND_OTP
1992
1993/* Interal OTP operation */
1994typedef int (*otp_op_t)(struct mtd_info *mtd, loff_t form, size_t len,
1995 size_t *retlen, u_char *buf);
1996
1997/**
1998 * do_otp_read - [DEFAULT] Read OTP block area
1999 * @param mtd MTD device structure
2000 * @param from The offset to read
2001 * @param len number of bytes to read
2002 * @param retlen pointer to variable to store the number of readbytes
2003 * @param buf the databuffer to put/get data
2004 *
2005 * Read OTP block area.
2006 */
2007static int do_otp_read(struct mtd_info *mtd, loff_t from, size_t len,
2008 size_t *retlen, u_char *buf)
2009{
2010 struct onenand_chip *this = mtd->priv;
2011 int ret;
2012
2013 /* Enter OTP access mode */
2014 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2015 this->wait(mtd, FL_OTPING);
2016
2017 ret = mtd->read(mtd, from, len, retlen, buf);
2018
2019 /* Exit OTP access mode */
2020 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2021 this->wait(mtd, FL_RESETING);
2022
2023 return ret;
2024}
2025
2026/**
2027 * do_otp_write - [DEFAULT] Write OTP block area
2028 * @param mtd MTD device structure
2029 * @param from The offset to write
2030 * @param len number of bytes to write
2031 * @param retlen pointer to variable to store the number of write bytes
2032 * @param buf the databuffer to put/get data
2033 *
2034 * Write OTP block area.
2035 */
2036static int do_otp_write(struct mtd_info *mtd, loff_t from, size_t len,
2037 size_t *retlen, u_char *buf)
2038{
2039 struct onenand_chip *this = mtd->priv;
2040 unsigned char *pbuf = buf;
2041 int ret;
2042
2043 /* Force buffer page aligned */
Joern Engel28318772006-05-22 23:18:05 +02002044 if (len < mtd->writesize) {
Kyungmin Park493c6462006-05-12 17:03:07 +03002045 memcpy(this->page_buf, buf, len);
Joern Engel28318772006-05-22 23:18:05 +02002046 memset(this->page_buf + len, 0xff, mtd->writesize - len);
Kyungmin Park493c6462006-05-12 17:03:07 +03002047 pbuf = this->page_buf;
Joern Engel28318772006-05-22 23:18:05 +02002048 len = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002049 }
2050
2051 /* Enter OTP access mode */
2052 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2053 this->wait(mtd, FL_OTPING);
2054
2055 ret = mtd->write(mtd, from, len, retlen, pbuf);
2056
2057 /* Exit OTP access mode */
2058 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2059 this->wait(mtd, FL_RESETING);
2060
2061 return ret;
2062}
2063
2064/**
2065 * do_otp_lock - [DEFAULT] Lock OTP block area
2066 * @param mtd MTD device structure
2067 * @param from The offset to lock
2068 * @param len number of bytes to lock
2069 * @param retlen pointer to variable to store the number of lock bytes
2070 * @param buf the databuffer to put/get data
2071 *
2072 * Lock OTP block area.
2073 */
2074static int do_otp_lock(struct mtd_info *mtd, loff_t from, size_t len,
2075 size_t *retlen, u_char *buf)
2076{
2077 struct onenand_chip *this = mtd->priv;
Kyungmin Park12f77c92007-08-30 09:36:05 +09002078 struct mtd_oob_ops ops = {
2079 .mode = MTD_OOB_PLACE,
2080 .ooblen = len,
2081 .oobbuf = buf,
2082 .ooboffs = 0,
2083 };
Kyungmin Park493c6462006-05-12 17:03:07 +03002084 int ret;
2085
2086 /* Enter OTP access mode */
2087 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2088 this->wait(mtd, FL_OTPING);
2089
Kyungmin Park12f77c92007-08-30 09:36:05 +09002090 ret = onenand_do_write_oob(mtd, from, &ops);
2091
2092 *retlen = ops.oobretlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03002093
2094 /* Exit OTP access mode */
2095 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2096 this->wait(mtd, FL_RESETING);
2097
2098 return ret;
2099}
2100
2101/**
2102 * onenand_otp_walk - [DEFAULT] Handle OTP operation
2103 * @param mtd MTD device structure
2104 * @param from The offset to read/write
2105 * @param len number of bytes to read/write
2106 * @param retlen pointer to variable to store the number of read bytes
2107 * @param buf the databuffer to put/get data
2108 * @param action do given action
2109 * @param mode specify user and factory
2110 *
2111 * Handle OTP operation.
2112 */
2113static int onenand_otp_walk(struct mtd_info *mtd, loff_t from, size_t len,
2114 size_t *retlen, u_char *buf,
2115 otp_op_t action, int mode)
2116{
2117 struct onenand_chip *this = mtd->priv;
2118 int otp_pages;
2119 int density;
2120 int ret = 0;
2121
2122 *retlen = 0;
2123
2124 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2125 if (density < ONENAND_DEVICE_DENSITY_512Mb)
2126 otp_pages = 20;
2127 else
2128 otp_pages = 10;
2129
2130 if (mode == MTD_OTP_FACTORY) {
Joern Engel28318772006-05-22 23:18:05 +02002131 from += mtd->writesize * otp_pages;
Kyungmin Park493c6462006-05-12 17:03:07 +03002132 otp_pages = 64 - otp_pages;
2133 }
2134
2135 /* Check User/Factory boundary */
Joern Engel28318772006-05-22 23:18:05 +02002136 if (((mtd->writesize * otp_pages) - (from + len)) < 0)
Kyungmin Park493c6462006-05-12 17:03:07 +03002137 return 0;
2138
2139 while (len > 0 && otp_pages > 0) {
2140 if (!action) { /* OTP Info functions */
2141 struct otp_info *otpinfo;
2142
2143 len -= sizeof(struct otp_info);
2144 if (len <= 0)
2145 return -ENOSPC;
2146
2147 otpinfo = (struct otp_info *) buf;
2148 otpinfo->start = from;
Joern Engel28318772006-05-22 23:18:05 +02002149 otpinfo->length = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002150 otpinfo->locked = 0;
2151
Joern Engel28318772006-05-22 23:18:05 +02002152 from += mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03002153 buf += sizeof(struct otp_info);
2154 *retlen += sizeof(struct otp_info);
2155 } else {
2156 size_t tmp_retlen;
2157 int size = len;
2158
2159 ret = action(mtd, from, len, &tmp_retlen, buf);
2160
2161 buf += size;
2162 len -= size;
2163 *retlen += size;
2164
2165 if (ret < 0)
2166 return ret;
2167 }
2168 otp_pages--;
2169 }
2170
2171 return 0;
2172}
2173
2174/**
2175 * onenand_get_fact_prot_info - [MTD Interface] Read factory OTP info
2176 * @param mtd MTD device structure
2177 * @param buf the databuffer to put/get data
2178 * @param len number of bytes to read
2179 *
2180 * Read factory OTP info.
2181 */
2182static int onenand_get_fact_prot_info(struct mtd_info *mtd,
2183 struct otp_info *buf, size_t len)
2184{
2185 size_t retlen;
2186 int ret;
2187
2188 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_FACTORY);
2189
2190 return ret ? : retlen;
2191}
2192
2193/**
2194 * onenand_read_fact_prot_reg - [MTD Interface] Read factory OTP area
2195 * @param mtd MTD device structure
2196 * @param from The offset to read
2197 * @param len number of bytes to read
2198 * @param retlen pointer to variable to store the number of read bytes
2199 * @param buf the databuffer to put/get data
2200 *
2201 * Read factory OTP area.
2202 */
2203static int onenand_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
2204 size_t len, size_t *retlen, u_char *buf)
2205{
2206 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_FACTORY);
2207}
2208
2209/**
2210 * onenand_get_user_prot_info - [MTD Interface] Read user OTP info
2211 * @param mtd MTD device structure
2212 * @param buf the databuffer to put/get data
2213 * @param len number of bytes to read
2214 *
2215 * Read user OTP info.
2216 */
2217static int onenand_get_user_prot_info(struct mtd_info *mtd,
2218 struct otp_info *buf, size_t len)
2219{
2220 size_t retlen;
2221 int ret;
2222
2223 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_USER);
2224
2225 return ret ? : retlen;
2226}
2227
2228/**
2229 * onenand_read_user_prot_reg - [MTD Interface] Read user OTP area
2230 * @param mtd MTD device structure
2231 * @param from The offset to read
2232 * @param len number of bytes to read
2233 * @param retlen pointer to variable to store the number of read bytes
2234 * @param buf the databuffer to put/get data
2235 *
2236 * Read user OTP area.
2237 */
2238static int onenand_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
2239 size_t len, size_t *retlen, u_char *buf)
2240{
2241 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_USER);
2242}
2243
2244/**
2245 * onenand_write_user_prot_reg - [MTD Interface] Write user OTP area
2246 * @param mtd MTD device structure
2247 * @param from The offset to write
2248 * @param len number of bytes to write
2249 * @param retlen pointer to variable to store the number of write bytes
2250 * @param buf the databuffer to put/get data
2251 *
2252 * Write user OTP area.
2253 */
2254static int onenand_write_user_prot_reg(struct mtd_info *mtd, loff_t from,
2255 size_t len, size_t *retlen, u_char *buf)
2256{
2257 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_write, MTD_OTP_USER);
2258}
2259
2260/**
2261 * onenand_lock_user_prot_reg - [MTD Interface] Lock user OTP area
2262 * @param mtd MTD device structure
2263 * @param from The offset to lock
2264 * @param len number of bytes to unlock
2265 *
2266 * Write lock mark on spare area in page 0 in OTP block
2267 */
2268static int onenand_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
2269 size_t len)
2270{
2271 unsigned char oob_buf[64];
2272 size_t retlen;
2273 int ret;
2274
2275 memset(oob_buf, 0xff, mtd->oobsize);
2276 /*
2277 * Note: OTP lock operation
2278 * OTP block : 0xXXFC
2279 * 1st block : 0xXXF3 (If chip support)
2280 * Both : 0xXXF0 (If chip support)
2281 */
2282 oob_buf[ONENAND_OTP_LOCK_OFFSET] = 0xFC;
2283
2284 /*
2285 * Write lock mark to 8th word of sector0 of page0 of the spare0.
2286 * We write 16 bytes spare area instead of 2 bytes.
2287 */
2288 from = 0;
2289 len = 16;
2290
2291 ret = onenand_otp_walk(mtd, from, len, &retlen, oob_buf, do_otp_lock, MTD_OTP_USER);
2292
2293 return ret ? : retlen;
2294}
2295#endif /* CONFIG_MTD_ONENAND_OTP */
2296
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002297/**
Kyungmin Park75384b02007-01-18 11:10:57 +09002298 * onenand_check_features - Check and set OneNAND features
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002299 * @param mtd MTD data structure
2300 *
Kyungmin Park75384b02007-01-18 11:10:57 +09002301 * Check and set OneNAND features
2302 * - lock scheme
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002303 * - two plane
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002304 */
Kyungmin Park75384b02007-01-18 11:10:57 +09002305static void onenand_check_features(struct mtd_info *mtd)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002306{
2307 struct onenand_chip *this = mtd->priv;
2308 unsigned int density, process;
2309
2310 /* Lock scheme depends on density and process */
2311 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2312 process = this->version_id >> ONENAND_VERSION_PROCESS_SHIFT;
2313
2314 /* Lock scheme */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002315 switch (density) {
2316 case ONENAND_DEVICE_DENSITY_4Gb:
2317 this->options |= ONENAND_HAS_2PLANE;
2318
2319 case ONENAND_DEVICE_DENSITY_2Gb:
2320 /* 2Gb DDP don't have 2 plane */
2321 if (!ONENAND_IS_DDP(this))
2322 this->options |= ONENAND_HAS_2PLANE;
2323 this->options |= ONENAND_HAS_UNLOCK_ALL;
2324
2325 case ONENAND_DEVICE_DENSITY_1Gb:
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002326 /* A-Die has all block unlock */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002327 if (process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002328 this->options |= ONENAND_HAS_UNLOCK_ALL;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002329 break;
2330
2331 default:
2332 /* Some OneNAND has continuous lock scheme */
2333 if (!process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002334 this->options |= ONENAND_HAS_CONT_LOCK;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002335 break;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002336 }
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002337
2338 if (this->options & ONENAND_HAS_CONT_LOCK)
2339 printk(KERN_DEBUG "Lock scheme is Continuous Lock\n");
2340 if (this->options & ONENAND_HAS_UNLOCK_ALL)
2341 printk(KERN_DEBUG "Chip support all block unlock\n");
2342 if (this->options & ONENAND_HAS_2PLANE)
2343 printk(KERN_DEBUG "Chip has 2 plane\n");
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002344}
2345
2346/**
Kyungmin Parke3da8062007-02-15 09:36:39 +09002347 * onenand_print_device_info - Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002348 * @param device device ID
Kyungmin Parke3da8062007-02-15 09:36:39 +09002349 * @param version version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002350 *
Kyungmin Parke3da8062007-02-15 09:36:39 +09002351 * Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002352 */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002353static void onenand_print_device_info(int device, int version)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002354{
2355 int vcc, demuxed, ddp, density;
2356
2357 vcc = device & ONENAND_DEVICE_VCC_MASK;
2358 demuxed = device & ONENAND_DEVICE_IS_DEMUX;
2359 ddp = device & ONENAND_DEVICE_IS_DDP;
2360 density = device >> ONENAND_DEVICE_DENSITY_SHIFT;
2361 printk(KERN_INFO "%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
2362 demuxed ? "" : "Muxed ",
2363 ddp ? "(DDP)" : "",
2364 (16 << density),
2365 vcc ? "2.65/3.3" : "1.8",
2366 device);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002367 printk(KERN_DEBUG "OneNAND version = 0x%04x\n", version);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002368}
2369
2370static const struct onenand_manufacturers onenand_manuf_ids[] = {
2371 {ONENAND_MFR_SAMSUNG, "Samsung"},
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002372};
2373
2374/**
2375 * onenand_check_maf - Check manufacturer ID
2376 * @param manuf manufacturer ID
2377 *
2378 * Check manufacturer ID
2379 */
2380static int onenand_check_maf(int manuf)
2381{
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002382 int size = ARRAY_SIZE(onenand_manuf_ids);
2383 char *name;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002384 int i;
2385
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002386 for (i = 0; i < size; i++)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002387 if (manuf == onenand_manuf_ids[i].id)
2388 break;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002389
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002390 if (i < size)
2391 name = onenand_manuf_ids[i].name;
2392 else
2393 name = "Unknown";
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002394
Kyungmin Park37b1cc32005-12-16 11:17:29 +09002395 printk(KERN_DEBUG "OneNAND Manufacturer: %s (0x%0x)\n", name, manuf);
2396
2397 return (i == size);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002398}
2399
2400/**
2401 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
2402 * @param mtd MTD device structure
2403 *
2404 * OneNAND detection method:
Michael Opdenacker59c51592007-05-09 08:57:56 +02002405 * Compare the values from command with ones from register
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002406 */
2407static int onenand_probe(struct mtd_info *mtd)
2408{
2409 struct onenand_chip *this = mtd->priv;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002410 int bram_maf_id, bram_dev_id, maf_id, dev_id, ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002411 int density;
Kyungmin Park47e777e2006-09-25 23:53:28 +00002412 int syscfg;
2413
2414 /* Save system configuration 1 */
2415 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
2416 /* Clear Sync. Burst Read mode to read BootRAM */
2417 this->write_word((syscfg & ~ONENAND_SYS_CFG1_SYNC_READ), this->base + ONENAND_REG_SYS_CFG1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002418
2419 /* Send the command for reading device ID from BootRAM */
2420 this->write_word(ONENAND_CMD_READID, this->base + ONENAND_BOOTRAM);
2421
2422 /* Read manufacturer and device IDs from BootRAM */
2423 bram_maf_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x0);
2424 bram_dev_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x2);
2425
Kyungmin Park47e777e2006-09-25 23:53:28 +00002426 /* Reset OneNAND to read default register values */
2427 this->write_word(ONENAND_CMD_RESET, this->base + ONENAND_BOOTRAM);
2428 /* Wait reset */
2429 this->wait(mtd, FL_RESETING);
2430
2431 /* Restore system configuration 1 */
2432 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
2433
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002434 /* Check manufacturer ID */
2435 if (onenand_check_maf(bram_maf_id))
2436 return -ENXIO;
2437
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002438 /* Read manufacturer and device IDs from Register */
2439 maf_id = this->read_word(this->base + ONENAND_REG_MANUFACTURER_ID);
2440 dev_id = this->read_word(this->base + ONENAND_REG_DEVICE_ID);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09002441 ver_id = this->read_word(this->base + ONENAND_REG_VERSION_ID);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002442
2443 /* Check OneNAND device */
2444 if (maf_id != bram_maf_id || dev_id != bram_dev_id)
2445 return -ENXIO;
2446
2447 /* Flash device information */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002448 onenand_print_device_info(dev_id, ver_id);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002449 this->device_id = dev_id;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002450 this->version_id = ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002451
2452 density = dev_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2453 this->chipsize = (16 << density) << 20;
Kyungmin Park83a36832005-09-29 04:53:16 +01002454 /* Set density mask. it is used for DDP */
Kyungmin Park738d61f2007-01-15 17:09:14 +09002455 if (ONENAND_IS_DDP(this))
2456 this->density_mask = (1 << (density + 6));
2457 else
2458 this->density_mask = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002459
2460 /* OneNAND page size & block size */
2461 /* The data buffer size is equal to page size */
Joern Engel28318772006-05-22 23:18:05 +02002462 mtd->writesize = this->read_word(this->base + ONENAND_REG_DATA_BUFFER_SIZE);
2463 mtd->oobsize = mtd->writesize >> 5;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09002464 /* Pages per a block are always 64 in OneNAND */
Joern Engel28318772006-05-22 23:18:05 +02002465 mtd->erasesize = mtd->writesize << 6;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002466
2467 this->erase_shift = ffs(mtd->erasesize) - 1;
Joern Engel28318772006-05-22 23:18:05 +02002468 this->page_shift = ffs(mtd->writesize) - 1;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09002469 this->page_mask = (1 << (this->erase_shift - this->page_shift)) - 1;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002470 /* It's real page size */
2471 this->writesize = mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002472
2473 /* REVIST: Multichip handling */
2474
2475 mtd->size = this->chipsize;
2476
Kyungmin Park75384b02007-01-18 11:10:57 +09002477 /* Check OneNAND features */
2478 onenand_check_features(mtd);
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002479
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002480 /*
2481 * We emulate the 4KiB page and 256KiB erase block size
2482 * But oobsize is still 64 bytes.
2483 * It is only valid if you turn on 2X program support,
2484 * Otherwise it will be ignored by compiler.
2485 */
2486 if (ONENAND_IS_2PLANE(this)) {
2487 mtd->writesize <<= 1;
2488 mtd->erasesize <<= 1;
2489 }
2490
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002491 return 0;
2492}
2493
Kyungmin Parka41371e2005-09-29 03:55:31 +01002494/**
2495 * onenand_suspend - [MTD Interface] Suspend the OneNAND flash
2496 * @param mtd MTD device structure
2497 */
2498static int onenand_suspend(struct mtd_info *mtd)
2499{
2500 return onenand_get_device(mtd, FL_PM_SUSPENDED);
2501}
2502
2503/**
2504 * onenand_resume - [MTD Interface] Resume the OneNAND flash
2505 * @param mtd MTD device structure
2506 */
2507static void onenand_resume(struct mtd_info *mtd)
2508{
2509 struct onenand_chip *this = mtd->priv;
2510
2511 if (this->state == FL_PM_SUSPENDED)
2512 onenand_release_device(mtd);
2513 else
2514 printk(KERN_ERR "resume() called for the chip which is not"
2515 "in suspended state\n");
2516}
2517
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002518/**
2519 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
2520 * @param mtd MTD device structure
2521 * @param maxchips Number of chips to scan for
2522 *
2523 * This fills out all the not initialized function pointers
2524 * with the defaults.
2525 * The flash ID is read and the mtd/chip structures are
2526 * filled with the appropriate values.
2527 */
2528int onenand_scan(struct mtd_info *mtd, int maxchips)
2529{
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002530 int i;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002531 struct onenand_chip *this = mtd->priv;
2532
2533 if (!this->read_word)
2534 this->read_word = onenand_readw;
2535 if (!this->write_word)
2536 this->write_word = onenand_writew;
2537
2538 if (!this->command)
2539 this->command = onenand_command;
2540 if (!this->wait)
Kyungmin Park2c221202006-11-16 11:23:48 +09002541 onenand_setup_wait(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002542
2543 if (!this->read_bufferram)
2544 this->read_bufferram = onenand_read_bufferram;
2545 if (!this->write_bufferram)
2546 this->write_bufferram = onenand_write_bufferram;
2547
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002548 if (!this->block_markbad)
2549 this->block_markbad = onenand_default_block_markbad;
2550 if (!this->scan_bbt)
2551 this->scan_bbt = onenand_default_bbt;
2552
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002553 if (onenand_probe(mtd))
2554 return -ENXIO;
2555
Kyungmin Park52b0eea2005-09-03 07:07:19 +01002556 /* Set Sync. Burst Read after probing */
2557 if (this->mmcontrol) {
2558 printk(KERN_INFO "OneNAND Sync. Burst Read support\n");
2559 this->read_bufferram = onenand_sync_read_bufferram;
2560 }
2561
Kyungmin Park532a37c2005-12-16 11:17:29 +09002562 /* Allocate buffers, if necessary */
2563 if (!this->page_buf) {
Kyungmin Park470bc842007-03-09 10:08:11 +09002564 this->page_buf = kzalloc(mtd->writesize, GFP_KERNEL);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002565 if (!this->page_buf) {
2566 printk(KERN_ERR "onenand_scan(): Can't allocate page_buf\n");
2567 return -ENOMEM;
2568 }
2569 this->options |= ONENAND_PAGEBUF_ALLOC;
2570 }
Kyungmin Park470bc842007-03-09 10:08:11 +09002571 if (!this->oob_buf) {
2572 this->oob_buf = kzalloc(mtd->oobsize, GFP_KERNEL);
2573 if (!this->oob_buf) {
2574 printk(KERN_ERR "onenand_scan(): Can't allocate oob_buf\n");
2575 if (this->options & ONENAND_PAGEBUF_ALLOC) {
2576 this->options &= ~ONENAND_PAGEBUF_ALLOC;
2577 kfree(this->page_buf);
2578 }
2579 return -ENOMEM;
2580 }
2581 this->options |= ONENAND_OOBBUF_ALLOC;
2582 }
Kyungmin Park532a37c2005-12-16 11:17:29 +09002583
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002584 this->state = FL_READY;
2585 init_waitqueue_head(&this->wq);
2586 spin_lock_init(&this->chip_lock);
2587
Kyungmin Park60d84f92006-12-22 16:21:54 +09002588 /*
2589 * Allow subpage writes up to oobsize.
2590 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002591 switch (mtd->oobsize) {
2592 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002593 this->ecclayout = &onenand_oob_64;
Kyungmin Park60d84f92006-12-22 16:21:54 +09002594 mtd->subpage_sft = 2;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002595 break;
2596
2597 case 32:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002598 this->ecclayout = &onenand_oob_32;
Kyungmin Park60d84f92006-12-22 16:21:54 +09002599 mtd->subpage_sft = 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002600 break;
2601
2602 default:
2603 printk(KERN_WARNING "No OOB scheme defined for oobsize %d\n",
2604 mtd->oobsize);
Kyungmin Park60d84f92006-12-22 16:21:54 +09002605 mtd->subpage_sft = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002606 /* To prevent kernel oops */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002607 this->ecclayout = &onenand_oob_32;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002608 break;
2609 }
2610
Kyungmin Park60d84f92006-12-22 16:21:54 +09002611 this->subpagesize = mtd->writesize >> mtd->subpage_sft;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002612
2613 /*
2614 * The number of bytes available for a client to place data into
2615 * the out of band area
2616 */
2617 this->ecclayout->oobavail = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09002618 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES &&
2619 this->ecclayout->oobfree[i].length; i++)
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002620 this->ecclayout->oobavail +=
2621 this->ecclayout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03002622 mtd->oobavail = this->ecclayout->oobavail;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002623
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002624 mtd->ecclayout = this->ecclayout;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002625
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002626 /* Fill in remaining MTD driver data */
2627 mtd->type = MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02002628 mtd->flags = MTD_CAP_NANDFLASH;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002629 mtd->erase = onenand_erase;
2630 mtd->point = NULL;
2631 mtd->unpoint = NULL;
2632 mtd->read = onenand_read;
2633 mtd->write = onenand_write;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002634 mtd->read_oob = onenand_read_oob;
2635 mtd->write_oob = onenand_write_oob;
Kyungmin Park493c6462006-05-12 17:03:07 +03002636#ifdef CONFIG_MTD_ONENAND_OTP
2637 mtd->get_fact_prot_info = onenand_get_fact_prot_info;
2638 mtd->read_fact_prot_reg = onenand_read_fact_prot_reg;
2639 mtd->get_user_prot_info = onenand_get_user_prot_info;
2640 mtd->read_user_prot_reg = onenand_read_user_prot_reg;
2641 mtd->write_user_prot_reg = onenand_write_user_prot_reg;
2642 mtd->lock_user_prot_reg = onenand_lock_user_prot_reg;
2643#endif
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002644 mtd->sync = onenand_sync;
Kyungmin Park08f782b2006-11-16 11:29:39 +09002645 mtd->lock = onenand_lock;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002646 mtd->unlock = onenand_unlock;
Kyungmin Parka41371e2005-09-29 03:55:31 +01002647 mtd->suspend = onenand_suspend;
2648 mtd->resume = onenand_resume;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002649 mtd->block_isbad = onenand_block_isbad;
2650 mtd->block_markbad = onenand_block_markbad;
2651 mtd->owner = THIS_MODULE;
2652
2653 /* Unlock whole block */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002654 onenand_unlock_all(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002655
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002656 return this->scan_bbt(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002657}
2658
2659/**
2660 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
2661 * @param mtd MTD device structure
2662 */
2663void onenand_release(struct mtd_info *mtd)
2664{
Kyungmin Park532a37c2005-12-16 11:17:29 +09002665 struct onenand_chip *this = mtd->priv;
2666
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002667#ifdef CONFIG_MTD_PARTITIONS
2668 /* Deregister partitions */
2669 del_mtd_partitions (mtd);
2670#endif
2671 /* Deregister the device */
2672 del_mtd_device (mtd);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002673
2674 /* Free bad block table memory, if allocated */
Adrian Hunterf00b0042007-01-22 17:01:01 +09002675 if (this->bbm) {
2676 struct bbm_info *bbm = this->bbm;
2677 kfree(bbm->bbt);
Kyungmin Park532a37c2005-12-16 11:17:29 +09002678 kfree(this->bbm);
Adrian Hunterf00b0042007-01-22 17:01:01 +09002679 }
Kyungmin Park470bc842007-03-09 10:08:11 +09002680 /* Buffers allocated by onenand_scan */
Kyungmin Park532a37c2005-12-16 11:17:29 +09002681 if (this->options & ONENAND_PAGEBUF_ALLOC)
2682 kfree(this->page_buf);
Kyungmin Park470bc842007-03-09 10:08:11 +09002683 if (this->options & ONENAND_OOBBUF_ALLOC)
2684 kfree(this->oob_buf);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002685}
2686
2687EXPORT_SYMBOL_GPL(onenand_scan);
2688EXPORT_SYMBOL_GPL(onenand_release);
2689
2690MODULE_LICENSE("GPL");
2691MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
2692MODULE_DESCRIPTION("Generic OneNAND flash driver code");