blob: c38bf9c54a11fe7c7a6d5b0b57d79c402981c8de [file] [log] [blame]
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001/*
2 * linux/drivers/mtd/onenand/onenand_base.c
3 *
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05304 * Copyright © 2005-2009 Samsung Electronics
5 * Copyright © 2007 Nokia Corporation
6 *
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01007 * Kyungmin Park <kyungmin.park@samsung.com>
8 *
Adrian Hunter81280d52007-02-15 09:47:29 +09009 * Credits:
10 * Adrian Hunter <ext-adrian.hunter@nokia.com>:
11 * auto-placement support, read-while load support, various fixes
Adrian Hunter81280d52007-02-15 09:47:29 +090012 *
Rohit Hagargundgi5988af22009-05-12 13:46:57 -070013 * Vishak G <vishak.g at samsung.com>, Rohit Hagargundgi <h.rohit at samsung.com>
14 * Flex-OneNAND support
Amul Kumar Saha3cf60252009-10-21 17:00:05 +053015 * Amul Kumar Saha <amul.saha at samsung.com>
16 * OTP support
Rohit Hagargundgi5988af22009-05-12 13:46:57 -070017 *
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010018 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License version 2 as
20 * published by the Free Software Foundation.
21 */
22
23#include <linux/kernel.h>
24#include <linux/module.h>
Amul Sahac90173f2009-06-16 11:24:01 +053025#include <linux/moduleparam.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090026#include <linux/slab.h>
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010027#include <linux/init.h>
Andrew Morton015953d2005-11-08 21:34:28 -080028#include <linux/sched.h>
Richard Purdie6c77fd62008-02-06 10:18:22 +000029#include <linux/delay.h>
Kyungmin Park2c221202006-11-16 11:23:48 +090030#include <linux/interrupt.h>
Andrew Morton015953d2005-11-08 21:34:28 -080031#include <linux/jiffies.h>
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010032#include <linux/mtd/mtd.h>
33#include <linux/mtd/onenand.h>
34#include <linux/mtd/partitions.h>
35
36#include <asm/io.h>
37
Mika Korhonen72073022009-10-23 07:50:43 +020038/*
39 * Multiblock erase if number of blocks to erase is 2 or more.
40 * Maximum number of blocks for simultaneous erase is 64.
41 */
42#define MB_ERASE_MIN_BLK_COUNT 2
43#define MB_ERASE_MAX_BLK_COUNT 64
44
Rohit Hagargundgi5988af22009-05-12 13:46:57 -070045/* Default Flex-OneNAND boundary and lock respectively */
46static int flex_bdry[MAX_DIES * 2] = { -1, 0, -1, 0 };
47
Amul Sahac90173f2009-06-16 11:24:01 +053048module_param_array(flex_bdry, int, NULL, 0400);
49MODULE_PARM_DESC(flex_bdry, "SLC Boundary information for Flex-OneNAND"
50 "Syntax:flex_bdry=DIE_BDRY,LOCK,..."
51 "DIE_BDRY: SLC boundary of the die"
52 "LOCK: Locking information for SLC boundary"
53 " : 0->Set boundary in unlocked status"
54 " : 1->Set boundary in locked status");
55
Amul Kumar Saha3cf60252009-10-21 17:00:05 +053056/* Default OneNAND/Flex-OneNAND OTP options*/
57static int otp;
58
59module_param(otp, int, 0400);
60MODULE_PARM_DESC(otp, "Corresponding behaviour of OneNAND in OTP"
61 "Syntax : otp=LOCK_TYPE"
62 "LOCK_TYPE : Keys issued, for specific OTP Lock type"
63 " : 0 -> Default (No Blocks Locked)"
64 " : 1 -> OTP Block lock"
65 " : 2 -> 1st Block lock"
66 " : 3 -> BOTH OTP Block and 1st Block lock");
67
Rohit Hagargundgi5988af22009-05-12 13:46:57 -070068/**
69 * onenand_oob_128 - oob info for Flex-Onenand with 4KB page
70 * For now, we expose only 64 out of 80 ecc bytes
71 */
72static struct nand_ecclayout onenand_oob_128 = {
73 .eccbytes = 64,
74 .eccpos = {
75 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
76 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
77 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,
78 54, 55, 56, 57, 58, 59, 60, 61, 62, 63,
79 70, 71, 72, 73, 74, 75, 76, 77, 78, 79,
80 86, 87, 88, 89, 90, 91, 92, 93, 94, 95,
81 102, 103, 104, 105
82 },
83 .oobfree = {
84 {2, 4}, {18, 4}, {34, 4}, {50, 4},
85 {66, 4}, {82, 4}, {98, 4}, {114, 4}
86 }
87};
88
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010089/**
90 * onenand_oob_64 - oob info for large (2KB) page
91 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020092static struct nand_ecclayout onenand_oob_64 = {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010093 .eccbytes = 20,
94 .eccpos = {
95 8, 9, 10, 11, 12,
96 24, 25, 26, 27, 28,
97 40, 41, 42, 43, 44,
98 56, 57, 58, 59, 60,
99 },
100 .oobfree = {
101 {2, 3}, {14, 2}, {18, 3}, {30, 2},
Jarkko Lavinend9777f12006-05-12 17:02:35 +0300102 {34, 3}, {46, 2}, {50, 3}, {62, 2}
103 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100104};
105
106/**
107 * onenand_oob_32 - oob info for middle (1KB) page
108 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200109static struct nand_ecclayout onenand_oob_32 = {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100110 .eccbytes = 10,
111 .eccpos = {
112 8, 9, 10, 11, 12,
113 24, 25, 26, 27, 28,
114 },
115 .oobfree = { {2, 3}, {14, 2}, {18, 3}, {30, 2} }
116};
117
118static const unsigned char ffchars[] = {
119 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
120 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 16 */
121 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
122 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 32 */
123 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
124 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 48 */
125 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
126 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 64 */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700127 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
128 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 80 */
129 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
130 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 96 */
131 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
132 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 112 */
133 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
134 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 128 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100135};
136
137/**
138 * onenand_readw - [OneNAND Interface] Read OneNAND register
139 * @param addr address to read
140 *
141 * Read OneNAND register
142 */
143static unsigned short onenand_readw(void __iomem *addr)
144{
145 return readw(addr);
146}
147
148/**
149 * onenand_writew - [OneNAND Interface] Write OneNAND register with value
150 * @param value value to write
151 * @param addr address to write
152 *
153 * Write OneNAND register with value
154 */
155static void onenand_writew(unsigned short value, void __iomem *addr)
156{
157 writew(value, addr);
158}
159
160/**
161 * onenand_block_address - [DEFAULT] Get block address
Kyungmin Park83a36832005-09-29 04:53:16 +0100162 * @param this onenand chip data structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100163 * @param block the block
164 * @return translated block address if DDP, otherwise same
165 *
166 * Setup Start Address 1 Register (F100h)
167 */
Kyungmin Park83a36832005-09-29 04:53:16 +0100168static int onenand_block_address(struct onenand_chip *this, int block)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100169{
Kyungmin Park738d61f2007-01-15 17:09:14 +0900170 /* Device Flash Core select, NAND Flash Block Address */
171 if (block & this->density_mask)
172 return ONENAND_DDP_CHIP1 | (block ^ this->density_mask);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100173
174 return block;
175}
176
177/**
178 * onenand_bufferram_address - [DEFAULT] Get bufferram address
Kyungmin Park83a36832005-09-29 04:53:16 +0100179 * @param this onenand chip data structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100180 * @param block the block
181 * @return set DBS value if DDP, otherwise 0
182 *
183 * Setup Start Address 2 Register (F101h) for DDP
184 */
Kyungmin Park83a36832005-09-29 04:53:16 +0100185static int onenand_bufferram_address(struct onenand_chip *this, int block)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100186{
Kyungmin Park738d61f2007-01-15 17:09:14 +0900187 /* Device BufferRAM Select */
188 if (block & this->density_mask)
189 return ONENAND_DDP_CHIP1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100190
Kyungmin Park738d61f2007-01-15 17:09:14 +0900191 return ONENAND_DDP_CHIP0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100192}
193
194/**
195 * onenand_page_address - [DEFAULT] Get page address
196 * @param page the page address
197 * @param sector the sector address
198 * @return combined page and sector address
199 *
200 * Setup Start Address 8 Register (F107h)
201 */
202static int onenand_page_address(int page, int sector)
203{
204 /* Flash Page Address, Flash Sector Address */
205 int fpa, fsa;
206
207 fpa = page & ONENAND_FPA_MASK;
208 fsa = sector & ONENAND_FSA_MASK;
209
210 return ((fpa << ONENAND_FPA_SHIFT) | fsa);
211}
212
213/**
214 * onenand_buffer_address - [DEFAULT] Get buffer address
215 * @param dataram1 DataRAM index
216 * @param sectors the sector address
217 * @param count the number of sectors
218 * @return the start buffer value
219 *
220 * Setup Start Buffer Register (F200h)
221 */
222static int onenand_buffer_address(int dataram1, int sectors, int count)
223{
224 int bsa, bsc;
225
226 /* BufferRAM Sector Address */
227 bsa = sectors & ONENAND_BSA_MASK;
228
229 if (dataram1)
230 bsa |= ONENAND_BSA_DATARAM1; /* DataRAM1 */
231 else
232 bsa |= ONENAND_BSA_DATARAM0; /* DataRAM0 */
233
234 /* BufferRAM Sector Count */
235 bsc = count & ONENAND_BSC_MASK;
236
237 return ((bsa << ONENAND_BSA_SHIFT) | bsc);
238}
239
240/**
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700241 * flexonenand_block- For given address return block number
242 * @param this - OneNAND device structure
243 * @param addr - Address for which block number is needed
244 */
245static unsigned flexonenand_block(struct onenand_chip *this, loff_t addr)
246{
247 unsigned boundary, blk, die = 0;
248
249 if (ONENAND_IS_DDP(this) && addr >= this->diesize[0]) {
250 die = 1;
251 addr -= this->diesize[0];
252 }
253
254 boundary = this->boundary[die];
255
256 blk = addr >> (this->erase_shift - 1);
257 if (blk > boundary)
258 blk = (blk + boundary + 1) >> 1;
259
260 blk += die ? this->density_mask : 0;
261 return blk;
262}
263
264inline unsigned onenand_block(struct onenand_chip *this, loff_t addr)
265{
266 if (!FLEXONENAND(this))
267 return addr >> this->erase_shift;
268 return flexonenand_block(this, addr);
269}
270
271/**
272 * flexonenand_addr - Return address of the block
273 * @this: OneNAND device structure
274 * @block: Block number on Flex-OneNAND
275 *
276 * Return address of the block
277 */
278static loff_t flexonenand_addr(struct onenand_chip *this, int block)
279{
280 loff_t ofs = 0;
281 int die = 0, boundary;
282
283 if (ONENAND_IS_DDP(this) && block >= this->density_mask) {
284 block -= this->density_mask;
285 die = 1;
286 ofs = this->diesize[0];
287 }
288
289 boundary = this->boundary[die];
290 ofs += (loff_t)block << (this->erase_shift - 1);
291 if (block > (boundary + 1))
292 ofs += (loff_t)(block - boundary - 1) << (this->erase_shift - 1);
293 return ofs;
294}
295
296loff_t onenand_addr(struct onenand_chip *this, int block)
297{
298 if (!FLEXONENAND(this))
299 return (loff_t)block << this->erase_shift;
300 return flexonenand_addr(this, block);
301}
302EXPORT_SYMBOL(onenand_addr);
303
304/**
Kyungmin Parke71f04f2007-12-11 11:23:45 +0900305 * onenand_get_density - [DEFAULT] Get OneNAND density
306 * @param dev_id OneNAND device ID
307 *
308 * Get OneNAND density from device ID
309 */
310static inline int onenand_get_density(int dev_id)
311{
312 int density = dev_id >> ONENAND_DEVICE_DENSITY_SHIFT;
313 return (density & ONENAND_DEVICE_DENSITY_MASK);
314}
315
316/**
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700317 * flexonenand_region - [Flex-OneNAND] Return erase region of addr
318 * @param mtd MTD device structure
319 * @param addr address whose erase region needs to be identified
320 */
321int flexonenand_region(struct mtd_info *mtd, loff_t addr)
322{
323 int i;
324
325 for (i = 0; i < mtd->numeraseregions; i++)
326 if (addr < mtd->eraseregions[i].offset)
327 break;
328 return i - 1;
329}
330EXPORT_SYMBOL(flexonenand_region);
331
332/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100333 * onenand_command - [DEFAULT] Send command to OneNAND device
334 * @param mtd MTD device structure
335 * @param cmd the command to be sent
336 * @param addr offset to read from or write to
337 * @param len number of bytes to read or write
338 *
339 * Send command to OneNAND device. This function is used for middle/large page
340 * devices (1KB/2KB Bytes per page)
341 */
342static int onenand_command(struct mtd_info *mtd, int cmd, loff_t addr, size_t len)
343{
344 struct onenand_chip *this = mtd->priv;
Kyungmin Parkb21b72c2007-12-11 11:13:18 +0900345 int value, block, page;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100346
347 /* Address translation */
348 switch (cmd) {
349 case ONENAND_CMD_UNLOCK:
350 case ONENAND_CMD_LOCK:
351 case ONENAND_CMD_LOCK_TIGHT:
Kyungmin Park28b79ff2006-09-26 09:45:28 +0000352 case ONENAND_CMD_UNLOCK_ALL:
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100353 block = -1;
354 page = -1;
355 break;
356
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700357 case FLEXONENAND_CMD_PI_ACCESS:
358 /* addr contains die index */
359 block = addr * this->density_mask;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100360 page = -1;
361 break;
362
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700363 case ONENAND_CMD_ERASE:
Mika Korhonen72073022009-10-23 07:50:43 +0200364 case ONENAND_CMD_MULTIBLOCK_ERASE:
365 case ONENAND_CMD_ERASE_VERIFY:
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700366 case ONENAND_CMD_BUFFERRAM:
367 case ONENAND_CMD_OTP_ACCESS:
368 block = onenand_block(this, addr);
369 page = -1;
370 break;
371
372 case FLEXONENAND_CMD_READ_PI:
373 cmd = ONENAND_CMD_READ;
374 block = addr * this->density_mask;
375 page = 0;
376 break;
377
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100378 default:
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700379 block = onenand_block(this, addr);
Rohit Hassan Sathyanarayan42b0aab2010-07-23 12:29:25 +0530380 if (FLEXONENAND(this))
381 page = (int) (addr - onenand_addr(this, block))>>\
382 this->page_shift;
383 else
384 page = (int) (addr >> this->page_shift);
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900385 if (ONENAND_IS_2PLANE(this)) {
386 /* Make the even block number */
387 block &= ~1;
388 /* Is it the odd plane? */
389 if (addr & this->writesize)
390 block++;
391 page >>= 1;
392 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100393 page &= this->page_mask;
394 break;
395 }
396
397 /* NOTE: The setting order of the registers is very important! */
398 if (cmd == ONENAND_CMD_BUFFERRAM) {
399 /* Select DataRAM for DDP */
Kyungmin Park83a36832005-09-29 04:53:16 +0100400 value = onenand_bufferram_address(this, block);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100401 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
402
Kyungmin Park8a8f6322010-12-02 09:24:16 +0900403 if (ONENAND_IS_2PLANE(this) || ONENAND_IS_4KB_PAGE(this))
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900404 /* It is always BufferRAM0 */
405 ONENAND_SET_BUFFERRAM0(this);
406 else
407 /* Switch to the next data buffer */
408 ONENAND_SET_NEXT_BUFFERRAM(this);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100409
410 return 0;
411 }
412
413 if (block != -1) {
414 /* Write 'DFS, FBA' of Flash */
Kyungmin Park83a36832005-09-29 04:53:16 +0100415 value = onenand_block_address(this, block);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100416 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
Kyungmin Park3cecf692006-05-12 17:02:51 +0300417
Kyungmin Parkb21b72c2007-12-11 11:13:18 +0900418 /* Select DataRAM for DDP */
419 value = onenand_bufferram_address(this, block);
420 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100421 }
422
423 if (page != -1) {
Kyungmin Park60d84f92006-12-22 16:21:54 +0900424 /* Now we use page size operation */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700425 int sectors = 0, count = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100426 int dataram;
427
428 switch (cmd) {
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700429 case FLEXONENAND_CMD_RECOVER_LSB:
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100430 case ONENAND_CMD_READ:
431 case ONENAND_CMD_READOOB:
Kyungmin Park8a8f6322010-12-02 09:24:16 +0900432 if (ONENAND_IS_4KB_PAGE(this))
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700433 /* It is always BufferRAM0 */
434 dataram = ONENAND_SET_BUFFERRAM0(this);
435 else
436 dataram = ONENAND_SET_NEXT_BUFFERRAM(this);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100437 break;
438
439 default:
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900440 if (ONENAND_IS_2PLANE(this) && cmd == ONENAND_CMD_PROG)
441 cmd = ONENAND_CMD_2X_PROG;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100442 dataram = ONENAND_CURRENT_BUFFERRAM(this);
443 break;
444 }
445
446 /* Write 'FPA, FSA' of Flash */
447 value = onenand_page_address(page, sectors);
448 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS8);
449
450 /* Write 'BSA, BSC' of DataRAM */
451 value = onenand_buffer_address(dataram, sectors, count);
452 this->write_word(value, this->base + ONENAND_REG_START_BUFFER);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100453 }
454
455 /* Interrupt clear */
456 this->write_word(ONENAND_INT_CLEAR, this->base + ONENAND_REG_INTERRUPT);
457
458 /* Write command */
459 this->write_word(cmd, this->base + ONENAND_REG_COMMAND);
460
461 return 0;
462}
463
464/**
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700465 * onenand_read_ecc - return ecc status
466 * @param this onenand chip structure
467 */
468static inline int onenand_read_ecc(struct onenand_chip *this)
469{
470 int ecc, i, result = 0;
471
Kyungmin Park6a88c472010-04-28 17:46:45 +0200472 if (!FLEXONENAND(this) && !ONENAND_IS_4KB_PAGE(this))
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700473 return this->read_word(this->base + ONENAND_REG_ECC_STATUS);
474
475 for (i = 0; i < 4; i++) {
Kyungmin Park6a88c472010-04-28 17:46:45 +0200476 ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS + i*2);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700477 if (likely(!ecc))
478 continue;
479 if (ecc & FLEXONENAND_UNCORRECTABLE_ERROR)
480 return ONENAND_ECC_2BIT_ALL;
481 else
482 result = ONENAND_ECC_1BIT_ALL;
483 }
484
485 return result;
486}
487
488/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100489 * onenand_wait - [DEFAULT] wait until the command is done
490 * @param mtd MTD device structure
491 * @param state state to select the max. timeout value
492 *
493 * Wait for command done. This applies to all OneNAND command
494 * Read can take up to 30us, erase up to 2ms and program up to 350us
495 * according to general OneNAND specs
496 */
497static int onenand_wait(struct mtd_info *mtd, int state)
498{
499 struct onenand_chip * this = mtd->priv;
500 unsigned long timeout;
501 unsigned int flags = ONENAND_INT_MASTER;
502 unsigned int interrupt = 0;
Kyungmin Park2fd32d42006-12-29 11:51:40 +0900503 unsigned int ctrl;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100504
505 /* The 20 msec is enough */
506 timeout = jiffies + msecs_to_jiffies(20);
507 while (time_before(jiffies, timeout)) {
508 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
509
510 if (interrupt & flags)
511 break;
512
Mika Korhonen72073022009-10-23 07:50:43 +0200513 if (state != FL_READING && state != FL_PREPARING_ERASE)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100514 cond_resched();
515 }
516 /* To get correct interrupt status in timeout case */
517 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
518
519 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
520
Kyungmin Park83973b82008-05-29 14:52:40 +0900521 /*
522 * In the Spec. it checks the controller status first
523 * However if you get the correct information in case of
524 * power off recovery (POR) test, it should read ECC status first
525 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100526 if (interrupt & ONENAND_INT_READ) {
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700527 int ecc = onenand_read_ecc(this);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900528 if (ecc) {
Kyungmin Parkb3c9f8b2007-01-05 19:16:04 +0900529 if (ecc & ONENAND_ECC_2BIT_ALL) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +0530530 printk(KERN_ERR "%s: ECC error = 0x%04x\n",
531 __func__, ecc);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900532 mtd->ecc_stats.failed++;
Adrian Hunter30a7eb22007-10-12 10:19:38 +0300533 return -EBADMSG;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300534 } else if (ecc & ONENAND_ECC_1BIT_ALL) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +0530535 printk(KERN_DEBUG "%s: correctable ECC error = 0x%04x\n",
536 __func__, ecc);
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +0900537 mtd->ecc_stats.corrected++;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +0300538 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100539 }
Adrian Hunter9d032802007-01-10 07:51:26 +0200540 } else if (state == FL_READING) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +0530541 printk(KERN_ERR "%s: read timeout! ctrl=0x%04x intr=0x%04x\n",
542 __func__, ctrl, interrupt);
Adrian Hunter9d032802007-01-10 07:51:26 +0200543 return -EIO;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100544 }
545
Mika Korhonen72073022009-10-23 07:50:43 +0200546 if (state == FL_PREPARING_ERASE && !(interrupt & ONENAND_INT_ERASE)) {
547 printk(KERN_ERR "%s: mb erase timeout! ctrl=0x%04x intr=0x%04x\n",
548 __func__, ctrl, interrupt);
549 return -EIO;
550 }
551
552 if (!(interrupt & ONENAND_INT_MASTER)) {
553 printk(KERN_ERR "%s: timeout! ctrl=0x%04x intr=0x%04x\n",
554 __func__, ctrl, interrupt);
555 return -EIO;
556 }
557
Kyungmin Park83973b82008-05-29 14:52:40 +0900558 /* If there's controller error, it's a real error */
559 if (ctrl & ONENAND_CTRL_ERROR) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +0530560 printk(KERN_ERR "%s: controller error = 0x%04x\n",
561 __func__, ctrl);
Kyungmin Park83973b82008-05-29 14:52:40 +0900562 if (ctrl & ONENAND_CTRL_LOCK)
Amul Kumar Saha297758f2009-10-02 16:59:11 +0530563 printk(KERN_ERR "%s: it's locked error.\n", __func__);
Kyungmin Park83973b82008-05-29 14:52:40 +0900564 return -EIO;
565 }
566
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100567 return 0;
568}
569
Kyungmin Park2c221202006-11-16 11:23:48 +0900570/*
571 * onenand_interrupt - [DEFAULT] onenand interrupt handler
572 * @param irq onenand interrupt number
573 * @param dev_id interrupt data
574 *
575 * complete the work
576 */
577static irqreturn_t onenand_interrupt(int irq, void *data)
578{
Jeff Garzik06efcad2007-10-19 03:10:11 -0400579 struct onenand_chip *this = data;
Kyungmin Park2c221202006-11-16 11:23:48 +0900580
581 /* To handle shared interrupt */
582 if (!this->complete.done)
583 complete(&this->complete);
584
585 return IRQ_HANDLED;
586}
587
588/*
589 * onenand_interrupt_wait - [DEFAULT] wait until the command is done
590 * @param mtd MTD device structure
591 * @param state state to select the max. timeout value
592 *
593 * Wait for command done.
594 */
595static int onenand_interrupt_wait(struct mtd_info *mtd, int state)
596{
597 struct onenand_chip *this = mtd->priv;
598
Kyungmin Park2c221202006-11-16 11:23:48 +0900599 wait_for_completion(&this->complete);
600
601 return onenand_wait(mtd, state);
602}
603
604/*
605 * onenand_try_interrupt_wait - [DEFAULT] try interrupt wait
606 * @param mtd MTD device structure
607 * @param state state to select the max. timeout value
608 *
609 * Try interrupt based wait (It is used one-time)
610 */
611static int onenand_try_interrupt_wait(struct mtd_info *mtd, int state)
612{
613 struct onenand_chip *this = mtd->priv;
614 unsigned long remain, timeout;
615
616 /* We use interrupt wait first */
617 this->wait = onenand_interrupt_wait;
618
Kyungmin Park2c221202006-11-16 11:23:48 +0900619 timeout = msecs_to_jiffies(100);
620 remain = wait_for_completion_timeout(&this->complete, timeout);
621 if (!remain) {
622 printk(KERN_INFO "OneNAND: There's no interrupt. "
623 "We use the normal wait\n");
624
625 /* Release the irq */
626 free_irq(this->irq, this);
David Woodhousec9ac5972006-11-30 08:17:38 +0000627
Kyungmin Park2c221202006-11-16 11:23:48 +0900628 this->wait = onenand_wait;
629 }
630
631 return onenand_wait(mtd, state);
632}
633
634/*
635 * onenand_setup_wait - [OneNAND Interface] setup onenand wait method
636 * @param mtd MTD device structure
637 *
638 * There's two method to wait onenand work
639 * 1. polling - read interrupt status register
640 * 2. interrupt - use the kernel interrupt method
641 */
642static void onenand_setup_wait(struct mtd_info *mtd)
643{
644 struct onenand_chip *this = mtd->priv;
645 int syscfg;
646
647 init_completion(&this->complete);
648
649 if (this->irq <= 0) {
650 this->wait = onenand_wait;
651 return;
652 }
653
654 if (request_irq(this->irq, &onenand_interrupt,
655 IRQF_SHARED, "onenand", this)) {
656 /* If we can't get irq, use the normal wait */
657 this->wait = onenand_wait;
658 return;
659 }
660
661 /* Enable interrupt */
662 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
663 syscfg |= ONENAND_SYS_CFG1_IOBE;
664 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
665
666 this->wait = onenand_try_interrupt_wait;
667}
668
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100669/**
670 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
671 * @param mtd MTD data structure
672 * @param area BufferRAM area
673 * @return offset given area
674 *
675 * Return BufferRAM offset given area
676 */
677static inline int onenand_bufferram_offset(struct mtd_info *mtd, int area)
678{
679 struct onenand_chip *this = mtd->priv;
680
681 if (ONENAND_CURRENT_BUFFERRAM(this)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900682 /* Note: the 'this->writesize' is a real page size */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100683 if (area == ONENAND_DATARAM)
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900684 return this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100685 if (area == ONENAND_SPARERAM)
686 return mtd->oobsize;
687 }
688
689 return 0;
690}
691
692/**
693 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area
694 * @param mtd MTD data structure
695 * @param area BufferRAM area
696 * @param buffer the databuffer to put/get data
697 * @param offset offset to read from or write to
698 * @param count number of bytes to read/write
699 *
700 * Read the BufferRAM area
701 */
702static int onenand_read_bufferram(struct mtd_info *mtd, int area,
703 unsigned char *buffer, int offset, size_t count)
704{
705 struct onenand_chip *this = mtd->priv;
706 void __iomem *bufferram;
707
708 bufferram = this->base + area;
709
710 bufferram += onenand_bufferram_offset(mtd, area);
711
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300712 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
713 unsigned short word;
714
715 /* Align with word(16-bit) size */
716 count--;
717
718 /* Read word and save byte */
719 word = this->read_word(bufferram + offset + count);
720 buffer[count] = (word & 0xff);
721 }
722
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100723 memcpy(buffer, bufferram + offset, count);
724
725 return 0;
726}
727
728/**
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100729 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode
730 * @param mtd MTD data structure
731 * @param area BufferRAM area
732 * @param buffer the databuffer to put/get data
733 * @param offset offset to read from or write to
734 * @param count number of bytes to read/write
735 *
736 * Read the BufferRAM area with Sync. Burst Mode
737 */
738static int onenand_sync_read_bufferram(struct mtd_info *mtd, int area,
739 unsigned char *buffer, int offset, size_t count)
740{
741 struct onenand_chip *this = mtd->priv;
742 void __iomem *bufferram;
743
744 bufferram = this->base + area;
745
746 bufferram += onenand_bufferram_offset(mtd, area);
747
748 this->mmcontrol(mtd, ONENAND_SYS_CFG1_SYNC_READ);
749
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300750 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
751 unsigned short word;
752
753 /* Align with word(16-bit) size */
754 count--;
755
756 /* Read word and save byte */
757 word = this->read_word(bufferram + offset + count);
758 buffer[count] = (word & 0xff);
759 }
760
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100761 memcpy(buffer, bufferram + offset, count);
762
763 this->mmcontrol(mtd, 0);
764
765 return 0;
766}
767
768/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100769 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area
770 * @param mtd MTD data structure
771 * @param area BufferRAM area
772 * @param buffer the databuffer to put/get data
773 * @param offset offset to read from or write to
774 * @param count number of bytes to read/write
775 *
776 * Write the BufferRAM area
777 */
778static int onenand_write_bufferram(struct mtd_info *mtd, int area,
779 const unsigned char *buffer, int offset, size_t count)
780{
781 struct onenand_chip *this = mtd->priv;
782 void __iomem *bufferram;
783
784 bufferram = this->base + area;
785
786 bufferram += onenand_bufferram_offset(mtd, area);
787
Kyungmin Park9c01f87d2006-05-12 17:02:31 +0300788 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
789 unsigned short word;
790 int byte_offset;
791
792 /* Align with word(16-bit) size */
793 count--;
794
795 /* Calculate byte access offset */
796 byte_offset = offset + count;
797
798 /* Read word and save byte */
799 word = this->read_word(bufferram + byte_offset);
800 word = (word & ~0xff) | buffer[count];
801 this->write_word(word, bufferram + byte_offset);
802 }
803
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100804 memcpy(bufferram + offset, buffer, count);
805
806 return 0;
807}
808
809/**
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900810 * onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode
811 * @param mtd MTD data structure
812 * @param addr address to check
813 * @return blockpage address
814 *
815 * Get blockpage address at 2x program mode
816 */
817static int onenand_get_2x_blockpage(struct mtd_info *mtd, loff_t addr)
818{
819 struct onenand_chip *this = mtd->priv;
820 int blockpage, block, page;
821
822 /* Calculate the even block number */
823 block = (int) (addr >> this->erase_shift) & ~1;
824 /* Is it the odd plane? */
825 if (addr & this->writesize)
826 block++;
827 page = (int) (addr >> (this->page_shift + 1)) & this->page_mask;
828 blockpage = (block << 7) | page;
829
830 return blockpage;
831}
832
833/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100834 * onenand_check_bufferram - [GENERIC] Check BufferRAM information
835 * @param mtd MTD data structure
836 * @param addr address to check
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000837 * @return 1 if there are valid data, otherwise 0
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100838 *
839 * Check bufferram if there is data we required
840 */
841static int onenand_check_bufferram(struct mtd_info *mtd, loff_t addr)
842{
843 struct onenand_chip *this = mtd->priv;
Adrian Huntercde36b32007-02-08 10:28:08 +0200844 int blockpage, found = 0;
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900845 unsigned int i;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000846
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900847 if (ONENAND_IS_2PLANE(this))
848 blockpage = onenand_get_2x_blockpage(mtd, addr);
849 else
850 blockpage = (int) (addr >> this->page_shift);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100851
852 /* Is there valid data? */
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900853 i = ONENAND_CURRENT_BUFFERRAM(this);
854 if (this->bufferram[i].blockpage == blockpage)
Adrian Huntercde36b32007-02-08 10:28:08 +0200855 found = 1;
856 else {
857 /* Check another BufferRAM */
858 i = ONENAND_NEXT_BUFFERRAM(this);
859 if (this->bufferram[i].blockpage == blockpage) {
860 ONENAND_SET_NEXT_BUFFERRAM(this);
861 found = 1;
862 }
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900863 }
864
Adrian Huntercde36b32007-02-08 10:28:08 +0200865 if (found && ONENAND_IS_DDP(this)) {
866 /* Select DataRAM for DDP */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -0700867 int block = onenand_block(this, addr);
Adrian Huntercde36b32007-02-08 10:28:08 +0200868 int value = onenand_bufferram_address(this, block);
869 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
870 }
871
872 return found;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100873}
874
875/**
876 * onenand_update_bufferram - [GENERIC] Update BufferRAM information
877 * @param mtd MTD data structure
878 * @param addr address to update
879 * @param valid valid flag
880 *
881 * Update BufferRAM information
882 */
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900883static void onenand_update_bufferram(struct mtd_info *mtd, loff_t addr,
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100884 int valid)
885{
886 struct onenand_chip *this = mtd->priv;
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900887 int blockpage;
888 unsigned int i;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +0000889
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900890 if (ONENAND_IS_2PLANE(this))
891 blockpage = onenand_get_2x_blockpage(mtd, addr);
892 else
893 blockpage = (int) (addr >> this->page_shift);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100894
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900895 /* Invalidate another BufferRAM */
896 i = ONENAND_NEXT_BUFFERRAM(this);
Kyungmin Park5b4246f2007-02-02 09:39:21 +0900897 if (this->bufferram[i].blockpage == blockpage)
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900898 this->bufferram[i].blockpage = -1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100899
900 /* Update BufferRAM */
901 i = ONENAND_CURRENT_BUFFERRAM(this);
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +0900902 if (valid)
903 this->bufferram[i].blockpage = blockpage;
904 else
905 this->bufferram[i].blockpage = -1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100906}
907
908/**
Adrian Hunter480b9df2007-02-07 13:55:19 +0200909 * onenand_invalidate_bufferram - [GENERIC] Invalidate BufferRAM information
910 * @param mtd MTD data structure
911 * @param addr start address to invalidate
912 * @param len length to invalidate
913 *
914 * Invalidate BufferRAM information
915 */
916static void onenand_invalidate_bufferram(struct mtd_info *mtd, loff_t addr,
917 unsigned int len)
918{
919 struct onenand_chip *this = mtd->priv;
920 int i;
921 loff_t end_addr = addr + len;
922
923 /* Invalidate BufferRAM */
924 for (i = 0; i < MAX_BUFFERRAM; i++) {
925 loff_t buf_addr = this->bufferram[i].blockpage << this->page_shift;
926 if (buf_addr >= addr && buf_addr < end_addr)
927 this->bufferram[i].blockpage = -1;
928 }
929}
930
931/**
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100932 * onenand_get_device - [GENERIC] Get chip for selected access
933 * @param mtd MTD device structure
934 * @param new_state the state which is requested
935 *
936 * Get the device and lock it for exclusive access
937 */
Kyungmin Parka41371e2005-09-29 03:55:31 +0100938static int onenand_get_device(struct mtd_info *mtd, int new_state)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100939{
940 struct onenand_chip *this = mtd->priv;
941 DECLARE_WAITQUEUE(wait, current);
942
943 /*
944 * Grab the lock and see if the device is available
945 */
946 while (1) {
947 spin_lock(&this->chip_lock);
948 if (this->state == FL_READY) {
949 this->state = new_state;
950 spin_unlock(&this->chip_lock);
951 break;
952 }
Kyungmin Parka41371e2005-09-29 03:55:31 +0100953 if (new_state == FL_PM_SUSPENDED) {
954 spin_unlock(&this->chip_lock);
955 return (this->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
956 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100957 set_current_state(TASK_UNINTERRUPTIBLE);
958 add_wait_queue(&this->wq, &wait);
959 spin_unlock(&this->chip_lock);
960 schedule();
961 remove_wait_queue(&this->wq, &wait);
962 }
Kyungmin Parka41371e2005-09-29 03:55:31 +0100963
964 return 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100965}
966
967/**
968 * onenand_release_device - [GENERIC] release chip
969 * @param mtd MTD device structure
970 *
971 * Deselect, release chip lock and wake up anyone waiting on the device
972 */
973static void onenand_release_device(struct mtd_info *mtd)
974{
975 struct onenand_chip *this = mtd->priv;
976
977 /* Release the chip */
978 spin_lock(&this->chip_lock);
979 this->state = FL_READY;
980 wake_up(&this->wq);
981 spin_unlock(&this->chip_lock);
982}
983
984/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +0900985 * onenand_transfer_auto_oob - [Internal] oob auto-placement transfer
986 * @param mtd MTD device structure
987 * @param buf destination address
988 * @param column oob offset to read from
989 * @param thislen oob length to read
990 */
991static int onenand_transfer_auto_oob(struct mtd_info *mtd, uint8_t *buf, int column,
992 int thislen)
993{
994 struct onenand_chip *this = mtd->priv;
995 struct nand_oobfree *free;
996 int readcol = column;
997 int readend = column + thislen;
998 int lastgap = 0;
999 unsigned int i;
1000 uint8_t *oob_buf = this->oob_buf;
1001
1002 free = this->ecclayout->oobfree;
1003 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
1004 if (readcol >= lastgap)
1005 readcol += free->offset - lastgap;
1006 if (readend >= lastgap)
1007 readend += free->offset - lastgap;
1008 lastgap = free->offset + free->length;
1009 }
1010 this->read_bufferram(mtd, ONENAND_SPARERAM, oob_buf, 0, mtd->oobsize);
1011 free = this->ecclayout->oobfree;
1012 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
1013 int free_end = free->offset + free->length;
1014 if (free->offset < readend && free_end > readcol) {
1015 int st = max_t(int,free->offset,readcol);
1016 int ed = min_t(int,free_end,readend);
1017 int n = ed - st;
1018 memcpy(buf, oob_buf + st, n);
1019 buf += n;
1020 } else if (column == 0)
1021 break;
1022 }
1023 return 0;
1024}
1025
1026/**
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001027 * onenand_recover_lsb - [Flex-OneNAND] Recover LSB page data
1028 * @param mtd MTD device structure
1029 * @param addr address to recover
1030 * @param status return value from onenand_wait / onenand_bbt_wait
1031 *
1032 * MLC NAND Flash cell has paired pages - LSB page and MSB page. LSB page has
1033 * lower page address and MSB page has higher page address in paired pages.
1034 * If power off occurs during MSB page program, the paired LSB page data can
1035 * become corrupt. LSB page recovery read is a way to read LSB page though page
1036 * data are corrupted. When uncorrectable error occurs as a result of LSB page
1037 * read after power up, issue LSB page recovery read.
1038 */
1039static int onenand_recover_lsb(struct mtd_info *mtd, loff_t addr, int status)
1040{
1041 struct onenand_chip *this = mtd->priv;
1042 int i;
1043
1044 /* Recovery is only for Flex-OneNAND */
1045 if (!FLEXONENAND(this))
1046 return status;
1047
1048 /* check if we failed due to uncorrectable error */
1049 if (status != -EBADMSG && status != ONENAND_BBT_READ_ECC_ERROR)
1050 return status;
1051
1052 /* check if address lies in MLC region */
1053 i = flexonenand_region(mtd, addr);
1054 if (mtd->eraseregions[i].erasesize < (1 << this->erase_shift))
1055 return status;
1056
1057 /* We are attempting to reread, so decrement stats.failed
1058 * which was incremented by onenand_wait due to read failure
1059 */
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301060 printk(KERN_INFO "%s: Attempting to recover from uncorrectable read\n",
1061 __func__);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001062 mtd->ecc_stats.failed--;
1063
1064 /* Issue the LSB page recovery command */
1065 this->command(mtd, FLEXONENAND_CMD_RECOVER_LSB, addr, this->writesize);
1066 return this->wait(mtd, FL_READING);
1067}
1068
1069/**
1070 * onenand_mlc_read_ops_nolock - MLC OneNAND read main and/or out-of-band
1071 * @param mtd MTD device structure
1072 * @param from offset to read from
1073 * @param ops: oob operation description structure
1074 *
1075 * MLC OneNAND / Flex-OneNAND has 4KB page size and 4KB dataram.
1076 * So, read-while-load is not present.
1077 */
1078static int onenand_mlc_read_ops_nolock(struct mtd_info *mtd, loff_t from,
1079 struct mtd_oob_ops *ops)
1080{
1081 struct onenand_chip *this = mtd->priv;
1082 struct mtd_ecc_stats stats;
1083 size_t len = ops->len;
1084 size_t ooblen = ops->ooblen;
1085 u_char *buf = ops->datbuf;
1086 u_char *oobbuf = ops->oobbuf;
1087 int read = 0, column, thislen;
1088 int oobread = 0, oobcolumn, thisooblen, oobsize;
1089 int ret = 0;
1090 int writesize = this->writesize;
1091
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301092 DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08x, len = %i\n",
David Woodhouse80327472009-10-05 08:30:04 +01001093 __func__, (unsigned int) from, (int) len);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001094
1095 if (ops->mode == MTD_OOB_AUTO)
1096 oobsize = this->ecclayout->oobavail;
1097 else
1098 oobsize = mtd->oobsize;
1099
1100 oobcolumn = from & (mtd->oobsize - 1);
1101
1102 /* Do not allow reads past end of device */
1103 if (from + len > mtd->size) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301104 printk(KERN_ERR "%s: Attempt read beyond end of device\n",
1105 __func__);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001106 ops->retlen = 0;
1107 ops->oobretlen = 0;
1108 return -EINVAL;
1109 }
1110
1111 stats = mtd->ecc_stats;
1112
1113 while (read < len) {
1114 cond_resched();
1115
1116 thislen = min_t(int, writesize, len - read);
1117
1118 column = from & (writesize - 1);
1119 if (column + thislen > writesize)
1120 thislen = writesize - column;
1121
1122 if (!onenand_check_bufferram(mtd, from)) {
1123 this->command(mtd, ONENAND_CMD_READ, from, writesize);
1124
1125 ret = this->wait(mtd, FL_READING);
1126 if (unlikely(ret))
1127 ret = onenand_recover_lsb(mtd, from, ret);
1128 onenand_update_bufferram(mtd, from, !ret);
1129 if (ret == -EBADMSG)
1130 ret = 0;
1131 }
1132
1133 this->read_bufferram(mtd, ONENAND_DATARAM, buf, column, thislen);
1134 if (oobbuf) {
1135 thisooblen = oobsize - oobcolumn;
1136 thisooblen = min_t(int, thisooblen, ooblen - oobread);
1137
1138 if (ops->mode == MTD_OOB_AUTO)
1139 onenand_transfer_auto_oob(mtd, oobbuf, oobcolumn, thisooblen);
1140 else
1141 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, oobcolumn, thisooblen);
1142 oobread += thisooblen;
1143 oobbuf += thisooblen;
1144 oobcolumn = 0;
1145 }
1146
1147 read += thislen;
1148 if (read == len)
1149 break;
1150
1151 from += thislen;
1152 buf += thislen;
1153 }
1154
1155 /*
1156 * Return success, if no ECC failures, else -EBADMSG
1157 * fs driver will take care of that, because
1158 * retlen == desired len and result == -EBADMSG
1159 */
1160 ops->retlen = read;
1161 ops->oobretlen = oobread;
1162
1163 if (ret)
1164 return ret;
1165
1166 if (mtd->ecc_stats.failed - stats.failed)
1167 return -EBADMSG;
1168
1169 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1170}
1171
1172/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001173 * onenand_read_ops_nolock - [OneNAND Interface] OneNAND read main and/or out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001174 * @param mtd MTD device structure
1175 * @param from offset to read from
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001176 * @param ops: oob operation description structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001177 *
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001178 * OneNAND read main and/or out-of-band data
1179 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001180static int onenand_read_ops_nolock(struct mtd_info *mtd, loff_t from,
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001181 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001182{
1183 struct onenand_chip *this = mtd->priv;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09001184 struct mtd_ecc_stats stats;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001185 size_t len = ops->len;
1186 size_t ooblen = ops->ooblen;
1187 u_char *buf = ops->datbuf;
1188 u_char *oobbuf = ops->oobbuf;
1189 int read = 0, column, thislen;
1190 int oobread = 0, oobcolumn, thisooblen, oobsize;
Adrian Hunter0fc2cce2007-01-09 17:55:21 +02001191 int ret = 0, boundary = 0;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001192 int writesize = this->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001193
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301194 DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08x, len = %i\n",
1195 __func__, (unsigned int) from, (int) len);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001196
1197 if (ops->mode == MTD_OOB_AUTO)
1198 oobsize = this->ecclayout->oobavail;
1199 else
1200 oobsize = mtd->oobsize;
1201
1202 oobcolumn = from & (mtd->oobsize - 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001203
1204 /* Do not allow reads past end of device */
1205 if ((from + len) > mtd->size) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301206 printk(KERN_ERR "%s: Attempt read beyond end of device\n",
1207 __func__);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001208 ops->retlen = 0;
1209 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001210 return -EINVAL;
1211 }
1212
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09001213 stats = mtd->ecc_stats;
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001214
Adrian Huntera8de85d2007-01-04 09:51:26 +02001215 /* Read-while-load method */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001216
Adrian Huntera8de85d2007-01-04 09:51:26 +02001217 /* Do first load to bufferRAM */
1218 if (read < len) {
1219 if (!onenand_check_bufferram(mtd, from)) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001220 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Huntera8de85d2007-01-04 09:51:26 +02001221 ret = this->wait(mtd, FL_READING);
1222 onenand_update_bufferram(mtd, from, !ret);
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001223 if (ret == -EBADMSG)
1224 ret = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +02001225 }
1226 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001227
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001228 thislen = min_t(int, writesize, len - read);
1229 column = from & (writesize - 1);
1230 if (column + thislen > writesize)
1231 thislen = writesize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001232
Adrian Huntera8de85d2007-01-04 09:51:26 +02001233 while (!ret) {
1234 /* If there is more to load then start next load */
1235 from += thislen;
1236 if (read + thislen < len) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001237 this->command(mtd, ONENAND_CMD_READ, from, writesize);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +02001238 /*
1239 * Chip boundary handling in DDP
1240 * Now we issued chip 1 read and pointed chip 1
Mika Korhonen492e1502009-06-09 21:52:35 +03001241 * bufferram so we have to point chip 0 bufferram.
Adrian Hunter0fc2cce2007-01-09 17:55:21 +02001242 */
Kyungmin Park738d61f2007-01-15 17:09:14 +09001243 if (ONENAND_IS_DDP(this) &&
1244 unlikely(from == (this->chipsize >> 1))) {
1245 this->write_word(ONENAND_DDP_CHIP0, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Hunter0fc2cce2007-01-09 17:55:21 +02001246 boundary = 1;
1247 } else
1248 boundary = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +02001249 ONENAND_SET_PREV_BUFFERRAM(this);
1250 }
1251 /* While load is going, read from last bufferRAM */
1252 this->read_bufferram(mtd, ONENAND_DATARAM, buf, column, thislen);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001253
1254 /* Read oob area if needed */
1255 if (oobbuf) {
1256 thisooblen = oobsize - oobcolumn;
1257 thisooblen = min_t(int, thisooblen, ooblen - oobread);
1258
1259 if (ops->mode == MTD_OOB_AUTO)
1260 onenand_transfer_auto_oob(mtd, oobbuf, oobcolumn, thisooblen);
1261 else
1262 this->read_bufferram(mtd, ONENAND_SPARERAM, oobbuf, oobcolumn, thisooblen);
1263 oobread += thisooblen;
1264 oobbuf += thisooblen;
1265 oobcolumn = 0;
1266 }
1267
Adrian Huntera8de85d2007-01-04 09:51:26 +02001268 /* See if we are done */
1269 read += thislen;
1270 if (read == len)
1271 break;
1272 /* Set up for next read from bufferRAM */
Adrian Hunter0fc2cce2007-01-09 17:55:21 +02001273 if (unlikely(boundary))
Kyungmin Park738d61f2007-01-15 17:09:14 +09001274 this->write_word(ONENAND_DDP_CHIP1, this->base + ONENAND_REG_START_ADDRESS2);
Adrian Huntera8de85d2007-01-04 09:51:26 +02001275 ONENAND_SET_NEXT_BUFFERRAM(this);
1276 buf += thislen;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001277 thislen = min_t(int, writesize, len - read);
Adrian Huntera8de85d2007-01-04 09:51:26 +02001278 column = 0;
1279 cond_resched();
1280 /* Now wait for load */
1281 ret = this->wait(mtd, FL_READING);
1282 onenand_update_bufferram(mtd, from, !ret);
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001283 if (ret == -EBADMSG)
1284 ret = 0;
Adrian Huntera8de85d2007-01-04 09:51:26 +02001285 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001286
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001287 /*
1288 * Return success, if no ECC failures, else -EBADMSG
1289 * fs driver will take care of that, because
1290 * retlen == desired len and result == -EBADMSG
1291 */
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001292 ops->retlen = read;
1293 ops->oobretlen = oobread;
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09001294
Adrian Huntera8de85d2007-01-04 09:51:26 +02001295 if (ret)
1296 return ret;
1297
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001298 if (mtd->ecc_stats.failed - stats.failed)
1299 return -EBADMSG;
1300
Kyungmin Parkf4f91ac2006-11-16 12:03:56 +09001301 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001302}
1303
1304/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001305 * onenand_read_oob_nolock - [MTD Interface] OneNAND read out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001306 * @param mtd MTD device structure
1307 * @param from offset to read from
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001308 * @param ops: oob operation description structure
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001309 *
1310 * OneNAND read out-of-band data from the spare area
1311 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001312static int onenand_read_oob_nolock(struct mtd_info *mtd, loff_t from,
Kyungmin Park12f77c92007-08-30 09:36:05 +09001313 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001314{
1315 struct onenand_chip *this = mtd->priv;
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001316 struct mtd_ecc_stats stats;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001317 int read = 0, thislen, column, oobsize;
Kyungmin Park12f77c92007-08-30 09:36:05 +09001318 size_t len = ops->ooblen;
1319 mtd_oob_mode_t mode = ops->mode;
1320 u_char *buf = ops->oobbuf;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001321 int ret = 0, readcmd;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001322
Kyungmin Park12f77c92007-08-30 09:36:05 +09001323 from += ops->ooboffs;
1324
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301325 DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08x, len = %i\n",
1326 __func__, (unsigned int) from, (int) len);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001327
1328 /* Initialize return length value */
Kyungmin Park12f77c92007-08-30 09:36:05 +09001329 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001330
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001331 if (mode == MTD_OOB_AUTO)
1332 oobsize = this->ecclayout->oobavail;
1333 else
1334 oobsize = mtd->oobsize;
1335
1336 column = from & (mtd->oobsize - 1);
1337
1338 if (unlikely(column >= oobsize)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301339 printk(KERN_ERR "%s: Attempted to start read outside oob\n",
1340 __func__);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001341 return -EINVAL;
1342 }
1343
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001344 /* Do not allow reads past end of device */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001345 if (unlikely(from >= mtd->size ||
1346 column + len > ((mtd->size >> this->page_shift) -
1347 (from >> this->page_shift)) * oobsize)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301348 printk(KERN_ERR "%s: Attempted to read beyond end of device\n",
1349 __func__);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001350 return -EINVAL;
1351 }
1352
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001353 stats = mtd->ecc_stats;
1354
Kyungmin Park8a8f6322010-12-02 09:24:16 +09001355 readcmd = ONENAND_IS_4KB_PAGE(this) ? ONENAND_CMD_READ : ONENAND_CMD_READOOB;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001356
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001357 while (read < len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09001358 cond_resched();
1359
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001360 thislen = oobsize - column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001361 thislen = min_t(int, thislen, len);
1362
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001363 this->command(mtd, readcmd, from, mtd->oobsize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001364
1365 onenand_update_bufferram(mtd, from, 0);
1366
1367 ret = this->wait(mtd, FL_READING);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001368 if (unlikely(ret))
1369 ret = onenand_recover_lsb(mtd, from, ret);
1370
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001371 if (ret && ret != -EBADMSG) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301372 printk(KERN_ERR "%s: read failed = 0x%x\n",
1373 __func__, ret);
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001374 break;
1375 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001376
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001377 if (mode == MTD_OOB_AUTO)
1378 onenand_transfer_auto_oob(mtd, buf, column, thislen);
1379 else
1380 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001381
1382 read += thislen;
1383
1384 if (read == len)
1385 break;
1386
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001387 buf += thislen;
1388
1389 /* Read more? */
1390 if (read < len) {
1391 /* Page size */
Joern Engel28318772006-05-22 23:18:05 +02001392 from += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001393 column = 0;
1394 }
1395 }
1396
Kyungmin Park12f77c92007-08-30 09:36:05 +09001397 ops->oobretlen = read;
Adrian Hunter5f4d47d2007-11-06 09:17:25 +02001398
1399 if (ret)
1400 return ret;
1401
1402 if (mtd->ecc_stats.failed - stats.failed)
1403 return -EBADMSG;
1404
1405 return 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001406}
1407
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001408/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001409 * onenand_read - [MTD Interface] Read data from flash
1410 * @param mtd MTD device structure
1411 * @param from offset to read from
1412 * @param len number of bytes to read
1413 * @param retlen pointer to variable to store the number of read bytes
1414 * @param buf the databuffer to put data
1415 *
1416 * Read with ecc
1417*/
1418static int onenand_read(struct mtd_info *mtd, loff_t from, size_t len,
1419 size_t *retlen, u_char *buf)
1420{
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001421 struct onenand_chip *this = mtd->priv;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001422 struct mtd_oob_ops ops = {
1423 .len = len,
1424 .ooblen = 0,
1425 .datbuf = buf,
1426 .oobbuf = NULL,
1427 };
1428 int ret;
1429
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001430 onenand_get_device(mtd, FL_READING);
Kyungmin Park8a8f6322010-12-02 09:24:16 +09001431 ret = ONENAND_IS_4KB_PAGE(this) ?
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001432 onenand_mlc_read_ops_nolock(mtd, from, &ops) :
1433 onenand_read_ops_nolock(mtd, from, &ops);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001434 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001435
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001436 *retlen = ops.retlen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001437 return ret;
1438}
1439
1440/**
1441 * onenand_read_oob - [MTD Interface] Read main and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09001442 * @param mtd: MTD device structure
1443 * @param from: offset to read from
1444 * @param ops: oob operation description structure
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001445
1446 * Read main and/or out-of-band
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001447 */
1448static int onenand_read_oob(struct mtd_info *mtd, loff_t from,
1449 struct mtd_oob_ops *ops)
1450{
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001451 struct onenand_chip *this = mtd->priv;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001452 int ret;
1453
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001454 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001455 case MTD_OOB_PLACE:
1456 case MTD_OOB_AUTO:
1457 break;
1458 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09001459 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001460 default:
1461 return -EINVAL;
1462 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001463
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001464 onenand_get_device(mtd, FL_READING);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001465 if (ops->datbuf)
Kyungmin Park8a8f6322010-12-02 09:24:16 +09001466 ret = ONENAND_IS_4KB_PAGE(this) ?
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001467 onenand_mlc_read_ops_nolock(mtd, from, ops) :
1468 onenand_read_ops_nolock(mtd, from, ops);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001469 else
1470 ret = onenand_read_oob_nolock(mtd, from, ops);
1471 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001472
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001473 return ret;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001474}
1475
Kyungmin Park211ac752007-02-07 12:15:01 +09001476/**
1477 * onenand_bbt_wait - [DEFAULT] wait until the command is done
1478 * @param mtd MTD device structure
1479 * @param state state to select the max. timeout value
1480 *
1481 * Wait for command done.
1482 */
1483static int onenand_bbt_wait(struct mtd_info *mtd, int state)
1484{
1485 struct onenand_chip *this = mtd->priv;
1486 unsigned long timeout;
1487 unsigned int interrupt;
1488 unsigned int ctrl;
1489
1490 /* The 20 msec is enough */
1491 timeout = jiffies + msecs_to_jiffies(20);
1492 while (time_before(jiffies, timeout)) {
1493 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1494 if (interrupt & ONENAND_INT_MASTER)
1495 break;
1496 }
1497 /* To get correct interrupt status in timeout case */
1498 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1499 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
1500
Kyungmin Park211ac752007-02-07 12:15:01 +09001501 if (interrupt & ONENAND_INT_READ) {
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001502 int ecc = onenand_read_ecc(this);
Kyungmin Park83973b82008-05-29 14:52:40 +09001503 if (ecc & ONENAND_ECC_2BIT_ALL) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301504 printk(KERN_WARNING "%s: ecc error = 0x%04x, "
1505 "controller error 0x%04x\n",
1506 __func__, ecc, ctrl);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001507 return ONENAND_BBT_READ_ECC_ERROR;
Kyungmin Park83973b82008-05-29 14:52:40 +09001508 }
Kyungmin Park211ac752007-02-07 12:15:01 +09001509 } else {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301510 printk(KERN_ERR "%s: read timeout! ctrl=0x%04x intr=0x%04x\n",
1511 __func__, ctrl, interrupt);
Kyungmin Park211ac752007-02-07 12:15:01 +09001512 return ONENAND_BBT_READ_FATAL_ERROR;
1513 }
1514
Kyungmin Park83973b82008-05-29 14:52:40 +09001515 /* Initial bad block case: 0x2400 or 0x0400 */
1516 if (ctrl & ONENAND_CTRL_ERROR) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301517 printk(KERN_DEBUG "%s: controller error = 0x%04x\n",
1518 __func__, ctrl);
Kyungmin Park83973b82008-05-29 14:52:40 +09001519 return ONENAND_BBT_READ_ERROR;
1520 }
1521
Kyungmin Park211ac752007-02-07 12:15:01 +09001522 return 0;
1523}
1524
1525/**
1526 * onenand_bbt_read_oob - [MTD Interface] OneNAND read out-of-band for bbt scan
1527 * @param mtd MTD device structure
1528 * @param from offset to read from
Kyungmin Parke3da8062007-02-15 09:36:39 +09001529 * @param ops oob operation description structure
Kyungmin Park211ac752007-02-07 12:15:01 +09001530 *
1531 * OneNAND read out-of-band data from the spare area for bbt scan
1532 */
1533int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
1534 struct mtd_oob_ops *ops)
1535{
1536 struct onenand_chip *this = mtd->priv;
1537 int read = 0, thislen, column;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001538 int ret = 0, readcmd;
Kyungmin Park211ac752007-02-07 12:15:01 +09001539 size_t len = ops->ooblen;
1540 u_char *buf = ops->oobbuf;
1541
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301542 DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08x, len = %zi\n",
1543 __func__, (unsigned int) from, len);
Kyungmin Park211ac752007-02-07 12:15:01 +09001544
1545 /* Initialize return value */
1546 ops->oobretlen = 0;
1547
1548 /* Do not allow reads past end of device */
1549 if (unlikely((from + len) > mtd->size)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301550 printk(KERN_ERR "%s: Attempt read beyond end of device\n",
1551 __func__);
Kyungmin Park211ac752007-02-07 12:15:01 +09001552 return ONENAND_BBT_READ_FATAL_ERROR;
1553 }
1554
1555 /* Grab the lock and see if the device is available */
1556 onenand_get_device(mtd, FL_READING);
1557
1558 column = from & (mtd->oobsize - 1);
1559
Kyungmin Park8a8f6322010-12-02 09:24:16 +09001560 readcmd = ONENAND_IS_4KB_PAGE(this) ? ONENAND_CMD_READ : ONENAND_CMD_READOOB;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001561
Kyungmin Park211ac752007-02-07 12:15:01 +09001562 while (read < len) {
1563 cond_resched();
1564
1565 thislen = mtd->oobsize - column;
1566 thislen = min_t(int, thislen, len);
1567
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001568 this->command(mtd, readcmd, from, mtd->oobsize);
Kyungmin Park211ac752007-02-07 12:15:01 +09001569
1570 onenand_update_bufferram(mtd, from, 0);
1571
Kyungmin Park31bb9992009-05-12 13:46:57 -07001572 ret = this->bbt_wait(mtd, FL_READING);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001573 if (unlikely(ret))
1574 ret = onenand_recover_lsb(mtd, from, ret);
1575
Kyungmin Park211ac752007-02-07 12:15:01 +09001576 if (ret)
1577 break;
1578
1579 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
1580 read += thislen;
1581 if (read == len)
1582 break;
1583
1584 buf += thislen;
1585
1586 /* Read more? */
1587 if (read < len) {
1588 /* Update Page size */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001589 from += this->writesize;
Kyungmin Park211ac752007-02-07 12:15:01 +09001590 column = 0;
1591 }
1592 }
1593
1594 /* Deselect and wake up anyone waiting on the device */
1595 onenand_release_device(mtd);
1596
1597 ops->oobretlen = read;
1598 return ret;
1599}
1600
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001601#ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
1602/**
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001603 * onenand_verify_oob - [GENERIC] verify the oob contents after a write
1604 * @param mtd MTD device structure
1605 * @param buf the databuffer to verify
1606 * @param to offset to read from
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001607 */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001608static int onenand_verify_oob(struct mtd_info *mtd, const u_char *buf, loff_t to)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001609{
1610 struct onenand_chip *this = mtd->priv;
Kyungmin Park69d79182007-12-14 14:47:21 +09001611 u_char *oob_buf = this->oob_buf;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001612 int status, i, readcmd;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001613
Kyungmin Park8a8f6322010-12-02 09:24:16 +09001614 readcmd = ONENAND_IS_4KB_PAGE(this) ? ONENAND_CMD_READ : ONENAND_CMD_READOOB;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07001615
1616 this->command(mtd, readcmd, to, mtd->oobsize);
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001617 onenand_update_bufferram(mtd, to, 0);
1618 status = this->wait(mtd, FL_READING);
1619 if (status)
1620 return status;
1621
Kyungmin Park69d79182007-12-14 14:47:21 +09001622 this->read_bufferram(mtd, ONENAND_SPARERAM, oob_buf, 0, mtd->oobsize);
Kyungmin Park91014e92007-02-12 10:34:39 +09001623 for (i = 0; i < mtd->oobsize; i++)
Kyungmin Park69d79182007-12-14 14:47:21 +09001624 if (buf[i] != 0xFF && buf[i] != oob_buf[i])
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001625 return -EBADMSG;
1626
1627 return 0;
1628}
1629
1630/**
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001631 * onenand_verify - [GENERIC] verify the chip contents after a write
1632 * @param mtd MTD device structure
1633 * @param buf the databuffer to verify
1634 * @param addr offset to read from
1635 * @param len number of bytes to read and compare
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001636 */
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001637static int onenand_verify(struct mtd_info *mtd, const u_char *buf, loff_t addr, size_t len)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001638{
1639 struct onenand_chip *this = mtd->priv;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001640 int ret = 0;
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001641 int thislen, column;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001642
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001643 while (len != 0) {
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001644 thislen = min_t(int, this->writesize, len);
1645 column = addr & (this->writesize - 1);
1646 if (column + thislen > this->writesize)
1647 thislen = this->writesize - column;
Kyungmin Park60d84f92006-12-22 16:21:54 +09001648
Kyungmin Parkee9745f2007-06-30 13:57:49 +09001649 this->command(mtd, ONENAND_CMD_READ, addr, this->writesize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001650
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001651 onenand_update_bufferram(mtd, addr, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001652
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001653 ret = this->wait(mtd, FL_READING);
1654 if (ret)
1655 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001656
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001657 onenand_update_bufferram(mtd, addr, 1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001658
Kyungmin Park3328dc32010-04-28 17:46:47 +02001659 this->read_bufferram(mtd, ONENAND_DATARAM, this->verify_buf, 0, mtd->writesize);
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001660
Kyungmin Park3328dc32010-04-28 17:46:47 +02001661 if (memcmp(buf, this->verify_buf, thislen))
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001662 return -EBADMSG;
1663
1664 len -= thislen;
1665 buf += thislen;
1666 addr += thislen;
1667 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00001668
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001669 return 0;
1670}
1671#else
Adrian Hunter8b29c0b2007-01-25 14:06:33 +09001672#define onenand_verify(...) (0)
Kyungmin Park8e6ec692006-05-12 17:02:41 +03001673#define onenand_verify_oob(...) (0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001674#endif
1675
Kyungmin Park60d84f92006-12-22 16:21:54 +09001676#define NOTALIGNED(x) ((x & (this->subpagesize - 1)) != 0)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001677
Richard Purdie6c77fd62008-02-06 10:18:22 +00001678static void onenand_panic_wait(struct mtd_info *mtd)
1679{
1680 struct onenand_chip *this = mtd->priv;
1681 unsigned int interrupt;
1682 int i;
1683
1684 for (i = 0; i < 2000; i++) {
1685 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
1686 if (interrupt & ONENAND_INT_MASTER)
1687 break;
1688 udelay(10);
1689 }
1690}
1691
1692/**
1693 * onenand_panic_write - [MTD Interface] write buffer to FLASH in a panic context
1694 * @param mtd MTD device structure
1695 * @param to offset to write to
1696 * @param len number of bytes to write
1697 * @param retlen pointer to variable to store the number of written bytes
1698 * @param buf the data to write
1699 *
1700 * Write with ECC
1701 */
1702static int onenand_panic_write(struct mtd_info *mtd, loff_t to, size_t len,
1703 size_t *retlen, const u_char *buf)
1704{
1705 struct onenand_chip *this = mtd->priv;
1706 int column, subpage;
1707 int written = 0;
1708 int ret = 0;
1709
1710 if (this->state == FL_PM_SUSPENDED)
1711 return -EBUSY;
1712
1713 /* Wait for any existing operation to clear */
1714 onenand_panic_wait(mtd);
1715
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301716 DEBUG(MTD_DEBUG_LEVEL3, "%s: to = 0x%08x, len = %i\n",
1717 __func__, (unsigned int) to, (int) len);
Richard Purdie6c77fd62008-02-06 10:18:22 +00001718
1719 /* Initialize retlen, in case of early exit */
1720 *retlen = 0;
1721
1722 /* Do not allow writes past end of device */
1723 if (unlikely((to + len) > mtd->size)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301724 printk(KERN_ERR "%s: Attempt write to past end of device\n",
1725 __func__);
Richard Purdie6c77fd62008-02-06 10:18:22 +00001726 return -EINVAL;
1727 }
1728
1729 /* Reject writes, which are not page aligned */
Roel Kluinb73d7e432008-02-16 18:14:35 +01001730 if (unlikely(NOTALIGNED(to) || NOTALIGNED(len))) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301731 printk(KERN_ERR "%s: Attempt to write not page aligned data\n",
1732 __func__);
Richard Purdie6c77fd62008-02-06 10:18:22 +00001733 return -EINVAL;
1734 }
1735
1736 column = to & (mtd->writesize - 1);
1737
1738 /* Loop until all data write */
1739 while (written < len) {
1740 int thislen = min_t(int, mtd->writesize - column, len - written);
1741 u_char *wbuf = (u_char *) buf;
1742
1743 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, thislen);
1744
1745 /* Partial page write */
1746 subpage = thislen < mtd->writesize;
1747 if (subpage) {
1748 memset(this->page_buf, 0xff, mtd->writesize);
1749 memcpy(this->page_buf + column, buf, thislen);
1750 wbuf = this->page_buf;
1751 }
1752
1753 this->write_bufferram(mtd, ONENAND_DATARAM, wbuf, 0, mtd->writesize);
1754 this->write_bufferram(mtd, ONENAND_SPARERAM, ffchars, 0, mtd->oobsize);
1755
1756 this->command(mtd, ONENAND_CMD_PROG, to, mtd->writesize);
1757
1758 onenand_panic_wait(mtd);
1759
1760 /* In partial page write we don't update bufferram */
1761 onenand_update_bufferram(mtd, to, !ret && !subpage);
1762 if (ONENAND_IS_2PLANE(this)) {
1763 ONENAND_SET_BUFFERRAM1(this);
1764 onenand_update_bufferram(mtd, to + this->writesize, !ret && !subpage);
1765 }
1766
1767 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301768 printk(KERN_ERR "%s: write failed %d\n", __func__, ret);
Richard Purdie6c77fd62008-02-06 10:18:22 +00001769 break;
1770 }
1771
1772 written += thislen;
1773
1774 if (written == len)
1775 break;
1776
1777 column = 0;
1778 to += thislen;
1779 buf += thislen;
1780 }
1781
1782 *retlen = written;
1783 return ret;
1784}
1785
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001786/**
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001787 * onenand_fill_auto_oob - [Internal] oob auto-placement transfer
1788 * @param mtd MTD device structure
1789 * @param oob_buf oob buffer
1790 * @param buf source address
1791 * @param column oob offset to write to
1792 * @param thislen oob length to write
1793 */
1794static int onenand_fill_auto_oob(struct mtd_info *mtd, u_char *oob_buf,
1795 const u_char *buf, int column, int thislen)
1796{
1797 struct onenand_chip *this = mtd->priv;
1798 struct nand_oobfree *free;
1799 int writecol = column;
1800 int writeend = column + thislen;
1801 int lastgap = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09001802 unsigned int i;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001803
Kyungmin Parkad286342007-03-23 10:19:52 +09001804 free = this->ecclayout->oobfree;
1805 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001806 if (writecol >= lastgap)
1807 writecol += free->offset - lastgap;
1808 if (writeend >= lastgap)
1809 writeend += free->offset - lastgap;
1810 lastgap = free->offset + free->length;
1811 }
Kyungmin Parkad286342007-03-23 10:19:52 +09001812 free = this->ecclayout->oobfree;
1813 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES && free->length; i++, free++) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001814 int free_end = free->offset + free->length;
1815 if (free->offset < writeend && free_end > writecol) {
1816 int st = max_t(int,free->offset,writecol);
1817 int ed = min_t(int,free_end,writeend);
1818 int n = ed - st;
1819 memcpy(oob_buf + st, buf, n);
1820 buf += n;
Adrian Hunterc36c46d2007-03-23 17:16:22 +09001821 } else if (column == 0)
Kyungmin Park5bc399e2007-03-09 09:41:07 +09001822 break;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02001823 }
1824 return 0;
1825}
1826
1827/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001828 * onenand_write_ops_nolock - [OneNAND Interface] write main and/or out-of-band
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001829 * @param mtd MTD device structure
1830 * @param to offset to write to
1831 * @param ops oob operation description structure
1832 *
1833 * Write main and/or oob with ECC
1834 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03001835static int onenand_write_ops_nolock(struct mtd_info *mtd, loff_t to,
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001836 struct mtd_oob_ops *ops)
1837{
1838 struct onenand_chip *this = mtd->priv;
Kyungmin Park9ce96902008-11-17 17:54:28 +09001839 int written = 0, column, thislen = 0, subpage = 0;
1840 int prev = 0, prevlen = 0, prev_subpage = 0, first = 1;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001841 int oobwritten = 0, oobcolumn, thisooblen, oobsize;
1842 size_t len = ops->len;
1843 size_t ooblen = ops->ooblen;
1844 const u_char *buf = ops->datbuf;
1845 const u_char *oob = ops->oobbuf;
1846 u_char *oobbuf;
Roman Tereshonkovac80dac2010-11-03 12:55:21 +02001847 int ret = 0, cmd;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001848
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301849 DEBUG(MTD_DEBUG_LEVEL3, "%s: to = 0x%08x, len = %i\n",
1850 __func__, (unsigned int) to, (int) len);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001851
1852 /* Initialize retlen, in case of early exit */
1853 ops->retlen = 0;
1854 ops->oobretlen = 0;
1855
1856 /* Do not allow writes past end of device */
1857 if (unlikely((to + len) > mtd->size)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301858 printk(KERN_ERR "%s: Attempt write to past end of device\n",
1859 __func__);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001860 return -EINVAL;
1861 }
1862
1863 /* Reject writes, which are not page aligned */
Roel Kluinb73d7e432008-02-16 18:14:35 +01001864 if (unlikely(NOTALIGNED(to) || NOTALIGNED(len))) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301865 printk(KERN_ERR "%s: Attempt to write not page aligned data\n",
1866 __func__);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001867 return -EINVAL;
1868 }
1869
Kyungmin Park9ce96902008-11-17 17:54:28 +09001870 /* Check zero length */
1871 if (!len)
1872 return 0;
1873
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001874 if (ops->mode == MTD_OOB_AUTO)
1875 oobsize = this->ecclayout->oobavail;
1876 else
1877 oobsize = mtd->oobsize;
1878
1879 oobcolumn = to & (mtd->oobsize - 1);
1880
1881 column = to & (mtd->writesize - 1);
1882
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001883 /* Loop until all data write */
Kyungmin Park9ce96902008-11-17 17:54:28 +09001884 while (1) {
1885 if (written < len) {
1886 u_char *wbuf = (u_char *) buf;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001887
Kyungmin Park9ce96902008-11-17 17:54:28 +09001888 thislen = min_t(int, mtd->writesize - column, len - written);
1889 thisooblen = min_t(int, oobsize - oobcolumn, ooblen - oobwritten);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001890
Kyungmin Park9ce96902008-11-17 17:54:28 +09001891 cond_resched();
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001892
Kyungmin Park9ce96902008-11-17 17:54:28 +09001893 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, thislen);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001894
Kyungmin Park9ce96902008-11-17 17:54:28 +09001895 /* Partial page write */
1896 subpage = thislen < mtd->writesize;
1897 if (subpage) {
1898 memset(this->page_buf, 0xff, mtd->writesize);
1899 memcpy(this->page_buf + column, buf, thislen);
1900 wbuf = this->page_buf;
1901 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001902
Kyungmin Park9ce96902008-11-17 17:54:28 +09001903 this->write_bufferram(mtd, ONENAND_DATARAM, wbuf, 0, mtd->writesize);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001904
Kyungmin Park9ce96902008-11-17 17:54:28 +09001905 if (oob) {
1906 oobbuf = this->oob_buf;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001907
Kyungmin Park9ce96902008-11-17 17:54:28 +09001908 /* We send data to spare ram with oobsize
1909 * to prevent byte access */
1910 memset(oobbuf, 0xff, mtd->oobsize);
1911 if (ops->mode == MTD_OOB_AUTO)
1912 onenand_fill_auto_oob(mtd, oobbuf, oob, oobcolumn, thisooblen);
1913 else
1914 memcpy(oobbuf + oobcolumn, oob, thisooblen);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001915
Kyungmin Park9ce96902008-11-17 17:54:28 +09001916 oobwritten += thisooblen;
1917 oob += thisooblen;
1918 oobcolumn = 0;
1919 } else
1920 oobbuf = (u_char *) ffchars;
1921
1922 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001923 } else
Kyungmin Park9ce96902008-11-17 17:54:28 +09001924 ONENAND_SET_NEXT_BUFFERRAM(this);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001925
Kyungmin Park9ce96902008-11-17 17:54:28 +09001926 /*
Mika Korhonen492e1502009-06-09 21:52:35 +03001927 * 2 PLANE, MLC, and Flex-OneNAND do not support
1928 * write-while-program feature.
Kyungmin Park9ce96902008-11-17 17:54:28 +09001929 */
Kyungmin Park6a88c472010-04-28 17:46:45 +02001930 if (!ONENAND_IS_2PLANE(this) && !ONENAND_IS_4KB_PAGE(this) && !first) {
Kyungmin Park9ce96902008-11-17 17:54:28 +09001931 ONENAND_SET_PREV_BUFFERRAM(this);
1932
1933 ret = this->wait(mtd, FL_WRITING);
1934
1935 /* In partial page write we don't update bufferram */
1936 onenand_update_bufferram(mtd, prev, !ret && !prev_subpage);
1937 if (ret) {
1938 written -= prevlen;
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301939 printk(KERN_ERR "%s: write failed %d\n",
1940 __func__, ret);
Kyungmin Park9ce96902008-11-17 17:54:28 +09001941 break;
1942 }
1943
1944 if (written == len) {
1945 /* Only check verify write turn on */
1946 ret = onenand_verify(mtd, buf - len, to - len, len);
1947 if (ret)
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301948 printk(KERN_ERR "%s: verify failed %d\n",
1949 __func__, ret);
Kyungmin Park9ce96902008-11-17 17:54:28 +09001950 break;
1951 }
1952
1953 ONENAND_SET_NEXT_BUFFERRAM(this);
1954 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001955
Roman Tereshonkovac80dac2010-11-03 12:55:21 +02001956 this->ongoing = 0;
1957 cmd = ONENAND_CMD_PROG;
1958
1959 /* Exclude 1st OTP and OTP blocks for cache program feature */
1960 if (ONENAND_IS_CACHE_PROGRAM(this) &&
1961 likely(onenand_block(this, to) != 0) &&
1962 ONENAND_IS_4KB_PAGE(this) &&
1963 ((written + thislen) < len)) {
1964 cmd = ONENAND_CMD_2X_CACHE_PROG;
1965 this->ongoing = 1;
1966 }
1967
1968 this->command(mtd, cmd, to, mtd->writesize);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001969
Kyungmin Park9ce96902008-11-17 17:54:28 +09001970 /*
1971 * 2 PLANE, MLC, and Flex-OneNAND wait here
1972 */
Kyungmin Park6a88c472010-04-28 17:46:45 +02001973 if (ONENAND_IS_2PLANE(this) || ONENAND_IS_4KB_PAGE(this)) {
Kyungmin Park9ce96902008-11-17 17:54:28 +09001974 ret = this->wait(mtd, FL_WRITING);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001975
Kyungmin Park9ce96902008-11-17 17:54:28 +09001976 /* In partial page write we don't update bufferram */
1977 onenand_update_bufferram(mtd, to, !ret && !subpage);
1978 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301979 printk(KERN_ERR "%s: write failed %d\n",
1980 __func__, ret);
Kyungmin Park9ce96902008-11-17 17:54:28 +09001981 break;
1982 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001983
Kyungmin Park9ce96902008-11-17 17:54:28 +09001984 /* Only check verify write turn on */
1985 ret = onenand_verify(mtd, buf, to, thislen);
1986 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05301987 printk(KERN_ERR "%s: verify failed %d\n",
1988 __func__, ret);
Kyungmin Park9ce96902008-11-17 17:54:28 +09001989 break;
1990 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001991
Kyungmin Park9ce96902008-11-17 17:54:28 +09001992 written += thislen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001993
Kyungmin Park9ce96902008-11-17 17:54:28 +09001994 if (written == len)
1995 break;
1996
1997 } else
1998 written += thislen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09001999
2000 column = 0;
Kyungmin Park9ce96902008-11-17 17:54:28 +09002001 prev_subpage = subpage;
2002 prev = to;
2003 prevlen = thislen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002004 to += thislen;
2005 buf += thislen;
Kyungmin Park9ce96902008-11-17 17:54:28 +09002006 first = 0;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002007 }
2008
Kyungmin Park9ce96902008-11-17 17:54:28 +09002009 /* In error case, clear all bufferrams */
2010 if (written != len)
2011 onenand_invalidate_bufferram(mtd, 0, -1);
2012
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002013 ops->retlen = written;
Kyungmin Park9ce96902008-11-17 17:54:28 +09002014 ops->oobretlen = oobwritten;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002015
2016 return ret;
2017}
2018
2019
2020/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002021 * onenand_write_oob_nolock - [Internal] OneNAND write out-of-band
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002022 * @param mtd MTD device structure
2023 * @param to offset to write to
2024 * @param len number of bytes to write
2025 * @param retlen pointer to variable to store the number of written bytes
2026 * @param buf the data to write
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002027 * @param mode operation mode
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002028 *
2029 * OneNAND write out-of-band
2030 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002031static int onenand_write_oob_nolock(struct mtd_info *mtd, loff_t to,
2032 struct mtd_oob_ops *ops)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002033{
2034 struct onenand_chip *this = mtd->priv;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002035 int column, ret = 0, oobsize;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002036 int written = 0, oobcmd;
Kyungmin Park91014e92007-02-12 10:34:39 +09002037 u_char *oobbuf;
Kyungmin Park12f77c92007-08-30 09:36:05 +09002038 size_t len = ops->ooblen;
2039 const u_char *buf = ops->oobbuf;
2040 mtd_oob_mode_t mode = ops->mode;
2041
2042 to += ops->ooboffs;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002043
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302044 DEBUG(MTD_DEBUG_LEVEL3, "%s: to = 0x%08x, len = %i\n",
2045 __func__, (unsigned int) to, (int) len);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002046
2047 /* Initialize retlen, in case of early exit */
Kyungmin Park12f77c92007-08-30 09:36:05 +09002048 ops->oobretlen = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002049
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002050 if (mode == MTD_OOB_AUTO)
2051 oobsize = this->ecclayout->oobavail;
2052 else
2053 oobsize = mtd->oobsize;
2054
2055 column = to & (mtd->oobsize - 1);
2056
2057 if (unlikely(column >= oobsize)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302058 printk(KERN_ERR "%s: Attempted to start write outside oob\n",
2059 __func__);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002060 return -EINVAL;
2061 }
2062
Adrian Hunter52e42002007-02-06 09:15:39 +09002063 /* For compatibility with NAND: Do not allow write past end of page */
Kyungmin Park91014e92007-02-12 10:34:39 +09002064 if (unlikely(column + len > oobsize)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302065 printk(KERN_ERR "%s: Attempt to write past end of page\n",
2066 __func__);
Adrian Hunter52e42002007-02-06 09:15:39 +09002067 return -EINVAL;
2068 }
2069
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002070 /* Do not allow reads past end of device */
2071 if (unlikely(to >= mtd->size ||
2072 column + len > ((mtd->size >> this->page_shift) -
2073 (to >> this->page_shift)) * oobsize)) {
David Woodhouse80327472009-10-05 08:30:04 +01002074 printk(KERN_ERR "%s: Attempted to write past end of device\n",
2075 __func__);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002076 return -EINVAL;
2077 }
2078
Kyungmin Park470bc842007-03-09 10:08:11 +09002079 oobbuf = this->oob_buf;
Kyungmin Park91014e92007-02-12 10:34:39 +09002080
Kyungmin Park8a8f6322010-12-02 09:24:16 +09002081 oobcmd = ONENAND_IS_4KB_PAGE(this) ? ONENAND_CMD_PROG : ONENAND_CMD_PROGOOB;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002082
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002083 /* Loop until all data write */
2084 while (written < len) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002085 int thislen = min_t(int, oobsize, len - written);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002086
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09002087 cond_resched();
2088
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002089 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, mtd->oobsize);
2090
Kyungmin Park34c10602006-05-12 17:02:46 +03002091 /* We send data to spare ram with oobsize
2092 * to prevent byte access */
Kyungmin Park91014e92007-02-12 10:34:39 +09002093 memset(oobbuf, 0xff, mtd->oobsize);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002094 if (mode == MTD_OOB_AUTO)
Kyungmin Park91014e92007-02-12 10:34:39 +09002095 onenand_fill_auto_oob(mtd, oobbuf, buf, column, thislen);
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002096 else
Kyungmin Park91014e92007-02-12 10:34:39 +09002097 memcpy(oobbuf + column, buf, thislen);
2098 this->write_bufferram(mtd, ONENAND_SPARERAM, oobbuf, 0, mtd->oobsize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002099
Kyungmin Park8a8f6322010-12-02 09:24:16 +09002100 if (ONENAND_IS_4KB_PAGE(this)) {
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002101 /* Set main area of DataRAM to 0xff*/
2102 memset(this->page_buf, 0xff, mtd->writesize);
2103 this->write_bufferram(mtd, ONENAND_DATARAM,
2104 this->page_buf, 0, mtd->writesize);
2105 }
2106
2107 this->command(mtd, oobcmd, to, mtd->oobsize);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002108
2109 onenand_update_bufferram(mtd, to, 0);
Kyungmin Parkee9745f2007-06-30 13:57:49 +09002110 if (ONENAND_IS_2PLANE(this)) {
2111 ONENAND_SET_BUFFERRAM1(this);
2112 onenand_update_bufferram(mtd, to + this->writesize, 0);
2113 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002114
Kyungmin Park8e6ec692006-05-12 17:02:41 +03002115 ret = this->wait(mtd, FL_WRITING);
2116 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302117 printk(KERN_ERR "%s: write failed %d\n", __func__, ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09002118 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03002119 }
2120
Kyungmin Park91014e92007-02-12 10:34:39 +09002121 ret = onenand_verify_oob(mtd, oobbuf, to);
Kyungmin Park8e6ec692006-05-12 17:02:41 +03002122 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302123 printk(KERN_ERR "%s: verify failed %d\n",
2124 __func__, ret);
Kyungmin Park5b4246f2007-02-02 09:39:21 +09002125 break;
Kyungmin Park8e6ec692006-05-12 17:02:41 +03002126 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002127
2128 written += thislen;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002129 if (written == len)
2130 break;
2131
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002132 to += mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002133 buf += thislen;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002134 column = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002135 }
2136
Kyungmin Park12f77c92007-08-30 09:36:05 +09002137 ops->oobretlen = written;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002138
Kyungmin Park8e6ec692006-05-12 17:02:41 +03002139 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002140}
2141
2142/**
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002143 * onenand_write - [MTD Interface] write buffer to FLASH
2144 * @param mtd MTD device structure
2145 * @param to offset to write to
2146 * @param len number of bytes to write
2147 * @param retlen pointer to variable to store the number of written bytes
2148 * @param buf the data to write
2149 *
2150 * Write with ECC
2151 */
2152static int onenand_write(struct mtd_info *mtd, loff_t to, size_t len,
2153 size_t *retlen, const u_char *buf)
2154{
2155 struct mtd_oob_ops ops = {
2156 .len = len,
2157 .ooblen = 0,
2158 .datbuf = (u_char *) buf,
2159 .oobbuf = NULL,
2160 };
2161 int ret;
2162
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002163 onenand_get_device(mtd, FL_WRITING);
2164 ret = onenand_write_ops_nolock(mtd, to, &ops);
2165 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002166
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002167 *retlen = ops.retlen;
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002168 return ret;
2169}
2170
2171/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002172 * onenand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Kyungmin Parke3da8062007-02-15 09:36:39 +09002173 * @param mtd: MTD device structure
2174 * @param to: offset to write
2175 * @param ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002176 */
2177static int onenand_write_oob(struct mtd_info *mtd, loff_t to,
2178 struct mtd_oob_ops *ops)
2179{
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002180 int ret;
2181
Kyungmin Park4f4fad22007-02-02 09:22:21 +09002182 switch (ops->mode) {
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002183 case MTD_OOB_PLACE:
2184 case MTD_OOB_AUTO:
2185 break;
2186 case MTD_OOB_RAW:
Kyungmin Park4f4fad22007-02-02 09:22:21 +09002187 /* Not implemented yet */
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02002188 default:
2189 return -EINVAL;
2190 }
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002191
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002192 onenand_get_device(mtd, FL_WRITING);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002193 if (ops->datbuf)
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002194 ret = onenand_write_ops_nolock(mtd, to, ops);
2195 else
2196 ret = onenand_write_oob_nolock(mtd, to, ops);
2197 onenand_release_device(mtd);
Kyungmin Parkd15057b2007-09-06 10:06:12 +09002198
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002199 return ret;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002200}
2201
2202/**
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002203 * onenand_block_isbad_nolock - [GENERIC] Check if a block is marked bad
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002204 * @param mtd MTD device structure
2205 * @param ofs offset from device start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002206 * @param allowbbt 1, if its allowed to access the bbt area
2207 *
2208 * Check, if the block is bad. Either by reading the bad block table or
2209 * calling of the scan function.
2210 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002211static int onenand_block_isbad_nolock(struct mtd_info *mtd, loff_t ofs, int allowbbt)
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002212{
2213 struct onenand_chip *this = mtd->priv;
2214 struct bbm_info *bbm = this->bbm;
2215
2216 /* Return info from the table */
2217 return bbm->isbad_bbt(mtd, ofs, allowbbt);
2218}
2219
Mika Korhonen72073022009-10-23 07:50:43 +02002220
2221static int onenand_multiblock_erase_verify(struct mtd_info *mtd,
2222 struct erase_info *instr)
2223{
2224 struct onenand_chip *this = mtd->priv;
2225 loff_t addr = instr->addr;
2226 int len = instr->len;
2227 unsigned int block_size = (1 << this->erase_shift);
2228 int ret = 0;
2229
2230 while (len) {
2231 this->command(mtd, ONENAND_CMD_ERASE_VERIFY, addr, block_size);
2232 ret = this->wait(mtd, FL_VERIFYING_ERASE);
2233 if (ret) {
2234 printk(KERN_ERR "%s: Failed verify, block %d\n",
2235 __func__, onenand_block(this, addr));
2236 instr->state = MTD_ERASE_FAILED;
2237 instr->fail_addr = addr;
2238 return -1;
2239 }
2240 len -= block_size;
2241 addr += block_size;
2242 }
2243 return 0;
2244}
2245
2246/**
2247 * onenand_multiblock_erase - [Internal] erase block(s) using multiblock erase
2248 * @param mtd MTD device structure
2249 * @param instr erase instruction
2250 * @param region erase region
2251 *
2252 * Erase one or more blocks up to 64 block at a time
2253 */
2254static int onenand_multiblock_erase(struct mtd_info *mtd,
2255 struct erase_info *instr,
2256 unsigned int block_size)
2257{
2258 struct onenand_chip *this = mtd->priv;
2259 loff_t addr = instr->addr;
2260 int len = instr->len;
2261 int eb_count = 0;
2262 int ret = 0;
2263 int bdry_block = 0;
2264
2265 instr->state = MTD_ERASING;
2266
2267 if (ONENAND_IS_DDP(this)) {
2268 loff_t bdry_addr = this->chipsize >> 1;
2269 if (addr < bdry_addr && (addr + len) > bdry_addr)
2270 bdry_block = bdry_addr >> this->erase_shift;
2271 }
2272
2273 /* Pre-check bbs */
2274 while (len) {
2275 /* Check if we have a bad block, we do not erase bad blocks */
2276 if (onenand_block_isbad_nolock(mtd, addr, 0)) {
2277 printk(KERN_WARNING "%s: attempt to erase a bad block "
2278 "at addr 0x%012llx\n",
2279 __func__, (unsigned long long) addr);
2280 instr->state = MTD_ERASE_FAILED;
2281 return -EIO;
2282 }
2283 len -= block_size;
2284 addr += block_size;
2285 }
2286
2287 len = instr->len;
2288 addr = instr->addr;
2289
2290 /* loop over 64 eb batches */
2291 while (len) {
2292 struct erase_info verify_instr = *instr;
2293 int max_eb_count = MB_ERASE_MAX_BLK_COUNT;
2294
2295 verify_instr.addr = addr;
2296 verify_instr.len = 0;
2297
2298 /* do not cross chip boundary */
2299 if (bdry_block) {
2300 int this_block = (addr >> this->erase_shift);
2301
2302 if (this_block < bdry_block) {
2303 max_eb_count = min(max_eb_count,
2304 (bdry_block - this_block));
2305 }
2306 }
2307
2308 eb_count = 0;
2309
2310 while (len > block_size && eb_count < (max_eb_count - 1)) {
2311 this->command(mtd, ONENAND_CMD_MULTIBLOCK_ERASE,
2312 addr, block_size);
2313 onenand_invalidate_bufferram(mtd, addr, block_size);
2314
2315 ret = this->wait(mtd, FL_PREPARING_ERASE);
2316 if (ret) {
2317 printk(KERN_ERR "%s: Failed multiblock erase, "
2318 "block %d\n", __func__,
2319 onenand_block(this, addr));
2320 instr->state = MTD_ERASE_FAILED;
2321 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
2322 return -EIO;
2323 }
2324
2325 len -= block_size;
2326 addr += block_size;
2327 eb_count++;
2328 }
2329
2330 /* last block of 64-eb series */
2331 cond_resched();
2332 this->command(mtd, ONENAND_CMD_ERASE, addr, block_size);
2333 onenand_invalidate_bufferram(mtd, addr, block_size);
2334
2335 ret = this->wait(mtd, FL_ERASING);
2336 /* Check if it is write protected */
2337 if (ret) {
2338 printk(KERN_ERR "%s: Failed erase, block %d\n",
2339 __func__, onenand_block(this, addr));
2340 instr->state = MTD_ERASE_FAILED;
2341 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
2342 return -EIO;
2343 }
2344
2345 len -= block_size;
2346 addr += block_size;
2347 eb_count++;
2348
2349 /* verify */
2350 verify_instr.len = eb_count * block_size;
2351 if (onenand_multiblock_erase_verify(mtd, &verify_instr)) {
2352 instr->state = verify_instr.state;
2353 instr->fail_addr = verify_instr.fail_addr;
2354 return -EIO;
2355 }
2356
2357 }
2358 return 0;
2359}
2360
2361
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002362/**
Mika Korhonen73885ae2009-10-23 07:50:42 +02002363 * onenand_block_by_block_erase - [Internal] erase block(s) using regular erase
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002364 * @param mtd MTD device structure
2365 * @param instr erase instruction
Mika Korhonen73885ae2009-10-23 07:50:42 +02002366 * @param region erase region
2367 * @param block_size erase block size
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002368 *
Mika Korhonen73885ae2009-10-23 07:50:42 +02002369 * Erase one or more blocks one block at a time
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002370 */
Mika Korhonen73885ae2009-10-23 07:50:42 +02002371static int onenand_block_by_block_erase(struct mtd_info *mtd,
2372 struct erase_info *instr,
2373 struct mtd_erase_region_info *region,
2374 unsigned int block_size)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002375{
2376 struct onenand_chip *this = mtd->priv;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002377 loff_t addr = instr->addr;
Mika Korhonen73885ae2009-10-23 07:50:42 +02002378 int len = instr->len;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002379 loff_t region_end = 0;
Mika Korhonen73885ae2009-10-23 07:50:42 +02002380 int ret = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002381
Mika Korhonen73885ae2009-10-23 07:50:42 +02002382 if (region) {
2383 /* region is set for Flex-OneNAND */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002384 region_end = region->offset + region->erasesize * region->numblocks;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002385 }
2386
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002387 instr->state = MTD_ERASING;
2388
Mika Korhonen73885ae2009-10-23 07:50:42 +02002389 /* Loop through the blocks */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002390 while (len) {
Artem Bityutskiy61a7e192006-12-26 16:41:24 +09002391 cond_resched();
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002392
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002393 /* Check if we have a bad block, we do not erase bad blocks */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002394 if (onenand_block_isbad_nolock(mtd, addr, 0)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302395 printk(KERN_WARNING "%s: attempt to erase a bad block "
2396 "at addr 0x%012llx\n",
2397 __func__, (unsigned long long) addr);
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002398 instr->state = MTD_ERASE_FAILED;
Mika Korhonen73885ae2009-10-23 07:50:42 +02002399 return -EIO;
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002400 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002401
2402 this->command(mtd, ONENAND_CMD_ERASE, addr, block_size);
2403
Adrian Hunter480b9df2007-02-07 13:55:19 +02002404 onenand_invalidate_bufferram(mtd, addr, block_size);
2405
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002406 ret = this->wait(mtd, FL_ERASING);
2407 /* Check, if it is write protected */
2408 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302409 printk(KERN_ERR "%s: Failed erase, block %d\n",
2410 __func__, onenand_block(this, addr));
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002411 instr->state = MTD_ERASE_FAILED;
2412 instr->fail_addr = addr;
Mika Korhonen73885ae2009-10-23 07:50:42 +02002413 return -EIO;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002414 }
2415
2416 len -= block_size;
2417 addr += block_size;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002418
2419 if (addr == region_end) {
2420 if (!len)
2421 break;
2422 region++;
2423
2424 block_size = region->erasesize;
2425 region_end = region->offset + region->erasesize * region->numblocks;
2426
2427 if (len & (block_size - 1)) {
2428 /* FIXME: This should be handled at MTD partitioning level. */
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302429 printk(KERN_ERR "%s: Unaligned address\n",
2430 __func__);
Mika Korhonen73885ae2009-10-23 07:50:42 +02002431 return -EIO;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002432 }
2433 }
Mika Korhonen73885ae2009-10-23 07:50:42 +02002434 }
2435 return 0;
2436}
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002437
Mika Korhonen73885ae2009-10-23 07:50:42 +02002438/**
2439 * onenand_erase - [MTD Interface] erase block(s)
2440 * @param mtd MTD device structure
2441 * @param instr erase instruction
2442 *
2443 * Erase one or more blocks
2444 */
2445static int onenand_erase(struct mtd_info *mtd, struct erase_info *instr)
2446{
2447 struct onenand_chip *this = mtd->priv;
2448 unsigned int block_size;
2449 loff_t addr = instr->addr;
2450 loff_t len = instr->len;
2451 int ret = 0;
2452 struct mtd_erase_region_info *region = NULL;
2453 loff_t region_offset = 0;
2454
2455 DEBUG(MTD_DEBUG_LEVEL3, "%s: start=0x%012llx, len=%llu\n", __func__,
2456 (unsigned long long) instr->addr, (unsigned long long) instr->len);
2457
2458 /* Do not allow erase past end of device */
2459 if (unlikely((len + addr) > mtd->size)) {
2460 printk(KERN_ERR "%s: Erase past end of device\n", __func__);
2461 return -EINVAL;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002462 }
2463
Mika Korhonen73885ae2009-10-23 07:50:42 +02002464 if (FLEXONENAND(this)) {
2465 /* Find the eraseregion of this address */
2466 int i = flexonenand_region(mtd, addr);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002467
Mika Korhonen73885ae2009-10-23 07:50:42 +02002468 region = &mtd->eraseregions[i];
2469 block_size = region->erasesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002470
Mika Korhonen73885ae2009-10-23 07:50:42 +02002471 /* Start address within region must align on block boundary.
2472 * Erase region's start offset is always block start address.
2473 */
2474 region_offset = region->offset;
2475 } else
2476 block_size = 1 << this->erase_shift;
2477
2478 /* Start address must align on block boundary */
2479 if (unlikely((addr - region_offset) & (block_size - 1))) {
2480 printk(KERN_ERR "%s: Unaligned address\n", __func__);
2481 return -EINVAL;
2482 }
2483
2484 /* Length must align on block boundary */
2485 if (unlikely(len & (block_size - 1))) {
2486 printk(KERN_ERR "%s: Length not block aligned\n", __func__);
2487 return -EINVAL;
2488 }
2489
2490 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
2491
2492 /* Grab the lock and see if the device is available */
2493 onenand_get_device(mtd, FL_ERASING);
2494
Mika Korhonen72073022009-10-23 07:50:43 +02002495 if (region || instr->len < MB_ERASE_MIN_BLK_COUNT * block_size) {
2496 /* region is set for Flex-OneNAND (no mb erase) */
2497 ret = onenand_block_by_block_erase(mtd, instr,
2498 region, block_size);
2499 } else {
2500 ret = onenand_multiblock_erase(mtd, instr, block_size);
2501 }
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002502
2503 /* Deselect and wake up anyone waiting on the device */
2504 onenand_release_device(mtd);
2505
Adrian Hunter3cd3a862007-10-12 10:34:01 +03002506 /* Do call back function */
Mika Korhonen73885ae2009-10-23 07:50:42 +02002507 if (!ret) {
2508 instr->state = MTD_ERASE_DONE;
Adrian Hunter3cd3a862007-10-12 10:34:01 +03002509 mtd_erase_callback(instr);
Mika Korhonen73885ae2009-10-23 07:50:42 +02002510 }
Adrian Hunter3cd3a862007-10-12 10:34:01 +03002511
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002512 return ret;
2513}
2514
2515/**
2516 * onenand_sync - [MTD Interface] sync
2517 * @param mtd MTD device structure
2518 *
2519 * Sync is actually a wait for chip ready function
2520 */
2521static void onenand_sync(struct mtd_info *mtd)
2522{
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302523 DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002524
2525 /* Grab the lock and see if the device is available */
2526 onenand_get_device(mtd, FL_SYNCING);
2527
2528 /* Release it and go back */
2529 onenand_release_device(mtd);
2530}
2531
2532/**
2533 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
2534 * @param mtd MTD device structure
2535 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002536 *
2537 * Check whether the block is bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002538 */
2539static int onenand_block_isbad(struct mtd_info *mtd, loff_t ofs)
2540{
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002541 int ret;
2542
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002543 /* Check for invalid offset */
2544 if (ofs > mtd->size)
2545 return -EINVAL;
2546
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002547 onenand_get_device(mtd, FL_READING);
2548 ret = onenand_block_isbad_nolock(mtd, ofs, 0);
2549 onenand_release_device(mtd);
2550 return ret;
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002551}
2552
2553/**
2554 * onenand_default_block_markbad - [DEFAULT] mark a block bad
2555 * @param mtd MTD device structure
2556 * @param ofs offset from device start
2557 *
2558 * This is the default implementation, which can be overridden by
2559 * a hardware specific driver.
2560 */
2561static int onenand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
2562{
2563 struct onenand_chip *this = mtd->priv;
2564 struct bbm_info *bbm = this->bbm;
2565 u_char buf[2] = {0, 0};
Kyungmin Park12f77c92007-08-30 09:36:05 +09002566 struct mtd_oob_ops ops = {
2567 .mode = MTD_OOB_PLACE,
2568 .ooblen = 2,
2569 .oobbuf = buf,
2570 .ooboffs = 0,
2571 };
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002572 int block;
2573
2574 /* Get block number */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002575 block = onenand_block(this, ofs);
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002576 if (bbm->bbt)
2577 bbm->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
2578
Mika Korhonen492e1502009-06-09 21:52:35 +03002579 /* We write two bytes, so we don't have to mess with 16-bit access */
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002580 ofs += mtd->oobsize + (bbm->badblockpos & ~0x01);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002581 /* FIXME : What to do when marking SLC block in partition
2582 * with MLC erasesize? For now, it is not advisable to
2583 * create partitions containing both SLC and MLC regions.
2584 */
2585 return onenand_write_oob_nolock(mtd, ofs, &ops);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002586}
2587
2588/**
2589 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
2590 * @param mtd MTD device structure
2591 * @param ofs offset relative to mtd start
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002592 *
2593 * Mark the block as bad
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002594 */
2595static int onenand_block_markbad(struct mtd_info *mtd, loff_t ofs)
2596{
Kyungmin Parkcdc00132005-09-03 07:15:48 +01002597 struct onenand_chip *this = mtd->priv;
2598 int ret;
2599
2600 ret = onenand_block_isbad(mtd, ofs);
2601 if (ret) {
2602 /* If it was bad already, return success and do nothing */
2603 if (ret > 0)
2604 return 0;
2605 return ret;
2606 }
2607
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03002608 onenand_get_device(mtd, FL_WRITING);
2609 ret = this->block_markbad(mtd, ofs);
2610 onenand_release_device(mtd);
2611 return ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002612}
2613
2614/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09002615 * onenand_do_lock_cmd - [OneNAND Interface] Lock or unlock block(s)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002616 * @param mtd MTD device structure
2617 * @param ofs offset relative to mtd start
Kyungmin Park08f782b2006-11-16 11:29:39 +09002618 * @param len number of bytes to lock or unlock
Kyungmin Parke3da8062007-02-15 09:36:39 +09002619 * @param cmd lock or unlock command
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002620 *
Kyungmin Park08f782b2006-11-16 11:29:39 +09002621 * Lock or unlock one or more blocks
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002622 */
Kyungmin Park08f782b2006-11-16 11:29:39 +09002623static int onenand_do_lock_cmd(struct mtd_info *mtd, loff_t ofs, size_t len, int cmd)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002624{
2625 struct onenand_chip *this = mtd->priv;
2626 int start, end, block, value, status;
Kyungmin Park08f782b2006-11-16 11:29:39 +09002627 int wp_status_mask;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002628
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002629 start = onenand_block(this, ofs);
2630 end = onenand_block(this, ofs + len) - 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002631
Kyungmin Park08f782b2006-11-16 11:29:39 +09002632 if (cmd == ONENAND_CMD_LOCK)
2633 wp_status_mask = ONENAND_WP_LS;
2634 else
2635 wp_status_mask = ONENAND_WP_US;
2636
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002637 /* Continuous lock scheme */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002638 if (this->options & ONENAND_HAS_CONT_LOCK) {
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002639 /* Set start block address */
2640 this->write_word(start, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
2641 /* Set end block address */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002642 this->write_word(end, this->base + ONENAND_REG_END_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09002643 /* Write lock command */
2644 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002645
2646 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09002647 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002648
2649 /* Sanity check */
2650 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
2651 & ONENAND_CTRL_ONGO)
2652 continue;
2653
2654 /* Check lock status */
2655 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09002656 if (!(status & wp_status_mask))
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302657 printk(KERN_ERR "%s: wp status = 0x%x\n",
2658 __func__, status);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002659
2660 return 0;
2661 }
2662
2663 /* Block lock scheme */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002664 for (block = start; block < end + 1; block++) {
Kyungmin Park20ba89a2005-12-16 11:17:29 +09002665 /* Set block address */
2666 value = onenand_block_address(this, block);
2667 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
2668 /* Select DataRAM for DDP */
2669 value = onenand_bufferram_address(this, block);
2670 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002671 /* Set start block address */
2672 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09002673 /* Write lock command */
2674 this->command(mtd, cmd, 0, 0);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002675
2676 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09002677 this->wait(mtd, FL_LOCKING);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002678
2679 /* Sanity check */
2680 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
2681 & ONENAND_CTRL_ONGO)
2682 continue;
2683
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002684 /* Check lock status */
2685 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park08f782b2006-11-16 11:29:39 +09002686 if (!(status & wp_status_mask))
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302687 printk(KERN_ERR "%s: block = %d, wp status = 0x%x\n",
2688 __func__, block, status);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002689 }
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00002690
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01002691 return 0;
2692}
2693
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002694/**
Kyungmin Park08f782b2006-11-16 11:29:39 +09002695 * onenand_lock - [MTD Interface] Lock block(s)
2696 * @param mtd MTD device structure
2697 * @param ofs offset relative to mtd start
2698 * @param len number of bytes to unlock
2699 *
2700 * Lock one or more blocks
2701 */
Adrian Hunter69423d92008-12-10 13:37:21 +00002702static int onenand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
Kyungmin Park08f782b2006-11-16 11:29:39 +09002703{
Adrian Hunter34627f02007-10-12 10:19:26 +03002704 int ret;
2705
2706 onenand_get_device(mtd, FL_LOCKING);
2707 ret = onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_LOCK);
2708 onenand_release_device(mtd);
2709 return ret;
Kyungmin Park08f782b2006-11-16 11:29:39 +09002710}
2711
Kyungmin Park08f782b2006-11-16 11:29:39 +09002712/**
2713 * onenand_unlock - [MTD Interface] Unlock block(s)
2714 * @param mtd MTD device structure
2715 * @param ofs offset relative to mtd start
2716 * @param len number of bytes to unlock
2717 *
2718 * Unlock one or more blocks
2719 */
Adrian Hunter69423d92008-12-10 13:37:21 +00002720static int onenand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
Kyungmin Park08f782b2006-11-16 11:29:39 +09002721{
Adrian Hunter34627f02007-10-12 10:19:26 +03002722 int ret;
2723
2724 onenand_get_device(mtd, FL_LOCKING);
2725 ret = onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
2726 onenand_release_device(mtd);
2727 return ret;
Kyungmin Park08f782b2006-11-16 11:29:39 +09002728}
2729
2730/**
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002731 * onenand_check_lock_status - [OneNAND Interface] Check lock status
2732 * @param this onenand chip data structure
2733 *
2734 * Check lock status
2735 */
Kyungmin Park66a10502008-02-13 15:55:38 +09002736static int onenand_check_lock_status(struct onenand_chip *this)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002737{
2738 unsigned int value, block, status;
2739 unsigned int end;
2740
2741 end = this->chipsize >> this->erase_shift;
2742 for (block = 0; block < end; block++) {
2743 /* Set block address */
2744 value = onenand_block_address(this, block);
2745 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
2746 /* Select DataRAM for DDP */
2747 value = onenand_bufferram_address(this, block);
2748 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
2749 /* Set start block address */
2750 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
2751
2752 /* Check lock status */
2753 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
Kyungmin Park66a10502008-02-13 15:55:38 +09002754 if (!(status & ONENAND_WP_US)) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05302755 printk(KERN_ERR "%s: block = %d, wp status = 0x%x\n",
2756 __func__, block, status);
Kyungmin Park66a10502008-02-13 15:55:38 +09002757 return 0;
2758 }
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002759 }
Kyungmin Park66a10502008-02-13 15:55:38 +09002760
2761 return 1;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002762}
2763
2764/**
2765 * onenand_unlock_all - [OneNAND Interface] unlock all blocks
2766 * @param mtd MTD device structure
2767 *
2768 * Unlock all blocks
2769 */
Kyungmin Park66a10502008-02-13 15:55:38 +09002770static void onenand_unlock_all(struct mtd_info *mtd)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002771{
2772 struct onenand_chip *this = mtd->priv;
Kyungmin Park66a10502008-02-13 15:55:38 +09002773 loff_t ofs = 0;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002774 loff_t len = mtd->size;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002775
2776 if (this->options & ONENAND_HAS_UNLOCK_ALL) {
Kyungmin Park10b7a2b2007-01-12 05:45:34 +09002777 /* Set start block address */
2778 this->write_word(0, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002779 /* Write unlock command */
2780 this->command(mtd, ONENAND_CMD_UNLOCK_ALL, 0, 0);
2781
2782 /* There's no return value */
Kyungmin Park08f782b2006-11-16 11:29:39 +09002783 this->wait(mtd, FL_LOCKING);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002784
2785 /* Sanity check */
2786 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
2787 & ONENAND_CTRL_ONGO)
2788 continue;
2789
Kyungmin Park31bb9992009-05-12 13:46:57 -07002790 /* Don't check lock status */
2791 if (this->options & ONENAND_SKIP_UNLOCK_CHECK)
2792 return;
2793
Kyungmin Park66a10502008-02-13 15:55:38 +09002794 /* Check lock status */
2795 if (onenand_check_lock_status(this))
2796 return;
2797
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002798 /* Workaround for all block unlock in DDP */
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07002799 if (ONENAND_IS_DDP(this) && !FLEXONENAND(this)) {
Kyungmin Park66a10502008-02-13 15:55:38 +09002800 /* All blocks on another chip */
2801 ofs = this->chipsize >> 1;
2802 len = this->chipsize >> 1;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002803 }
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002804 }
2805
Kyungmin Park66a10502008-02-13 15:55:38 +09002806 onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00002807}
2808
Kyungmin Park493c6462006-05-12 17:03:07 +03002809#ifdef CONFIG_MTD_ONENAND_OTP
2810
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05302811/**
2812 * onenand_otp_command - Send OTP specific command to OneNAND device
2813 * @param mtd MTD device structure
2814 * @param cmd the command to be sent
2815 * @param addr offset to read from or write to
2816 * @param len number of bytes to read or write
2817 */
2818static int onenand_otp_command(struct mtd_info *mtd, int cmd, loff_t addr,
2819 size_t len)
2820{
2821 struct onenand_chip *this = mtd->priv;
2822 int value, block, page;
2823
2824 /* Address translation */
2825 switch (cmd) {
2826 case ONENAND_CMD_OTP_ACCESS:
2827 block = (int) (addr >> this->erase_shift);
2828 page = -1;
2829 break;
2830
2831 default:
2832 block = (int) (addr >> this->erase_shift);
2833 page = (int) (addr >> this->page_shift);
2834
2835 if (ONENAND_IS_2PLANE(this)) {
2836 /* Make the even block number */
2837 block &= ~1;
2838 /* Is it the odd plane? */
2839 if (addr & this->writesize)
2840 block++;
2841 page >>= 1;
2842 }
2843 page &= this->page_mask;
2844 break;
2845 }
2846
2847 if (block != -1) {
2848 /* Write 'DFS, FBA' of Flash */
2849 value = onenand_block_address(this, block);
2850 this->write_word(value, this->base +
2851 ONENAND_REG_START_ADDRESS1);
2852 }
2853
2854 if (page != -1) {
2855 /* Now we use page size operation */
2856 int sectors = 4, count = 4;
2857 int dataram;
2858
2859 switch (cmd) {
2860 default:
2861 if (ONENAND_IS_2PLANE(this) && cmd == ONENAND_CMD_PROG)
2862 cmd = ONENAND_CMD_2X_PROG;
2863 dataram = ONENAND_CURRENT_BUFFERRAM(this);
2864 break;
2865 }
2866
2867 /* Write 'FPA, FSA' of Flash */
2868 value = onenand_page_address(page, sectors);
2869 this->write_word(value, this->base +
2870 ONENAND_REG_START_ADDRESS8);
2871
2872 /* Write 'BSA, BSC' of DataRAM */
2873 value = onenand_buffer_address(dataram, sectors, count);
2874 this->write_word(value, this->base + ONENAND_REG_START_BUFFER);
2875 }
2876
2877 /* Interrupt clear */
2878 this->write_word(ONENAND_INT_CLEAR, this->base + ONENAND_REG_INTERRUPT);
2879
2880 /* Write command */
2881 this->write_word(cmd, this->base + ONENAND_REG_COMMAND);
2882
2883 return 0;
2884}
2885
2886/**
2887 * onenand_otp_write_oob_nolock - [Internal] OneNAND write out-of-band, specific to OTP
2888 * @param mtd MTD device structure
2889 * @param to offset to write to
2890 * @param len number of bytes to write
2891 * @param retlen pointer to variable to store the number of written bytes
2892 * @param buf the data to write
2893 *
2894 * OneNAND write out-of-band only for OTP
2895 */
2896static int onenand_otp_write_oob_nolock(struct mtd_info *mtd, loff_t to,
2897 struct mtd_oob_ops *ops)
2898{
2899 struct onenand_chip *this = mtd->priv;
2900 int column, ret = 0, oobsize;
2901 int written = 0;
2902 u_char *oobbuf;
2903 size_t len = ops->ooblen;
2904 const u_char *buf = ops->oobbuf;
2905 int block, value, status;
2906
2907 to += ops->ooboffs;
2908
2909 /* Initialize retlen, in case of early exit */
2910 ops->oobretlen = 0;
2911
2912 oobsize = mtd->oobsize;
2913
2914 column = to & (mtd->oobsize - 1);
2915
2916 oobbuf = this->oob_buf;
2917
2918 /* Loop until all data write */
2919 while (written < len) {
2920 int thislen = min_t(int, oobsize, len - written);
2921
2922 cond_resched();
2923
2924 block = (int) (to >> this->erase_shift);
2925 /*
2926 * Write 'DFS, FBA' of Flash
2927 * Add: F100h DQ=DFS, FBA
2928 */
2929
2930 value = onenand_block_address(this, block);
2931 this->write_word(value, this->base +
2932 ONENAND_REG_START_ADDRESS1);
2933
2934 /*
2935 * Select DataRAM for DDP
2936 * Add: F101h DQ=DBS
2937 */
2938
2939 value = onenand_bufferram_address(this, block);
2940 this->write_word(value, this->base +
2941 ONENAND_REG_START_ADDRESS2);
2942 ONENAND_SET_NEXT_BUFFERRAM(this);
2943
2944 /*
2945 * Enter OTP access mode
2946 */
2947 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
2948 this->wait(mtd, FL_OTPING);
2949
2950 /* We send data to spare ram with oobsize
2951 * to prevent byte access */
2952 memcpy(oobbuf + column, buf, thislen);
2953
2954 /*
2955 * Write Data into DataRAM
2956 * Add: 8th Word
2957 * in sector0/spare/page0
2958 * DQ=XXFCh
2959 */
2960 this->write_bufferram(mtd, ONENAND_SPARERAM,
2961 oobbuf, 0, mtd->oobsize);
2962
2963 onenand_otp_command(mtd, ONENAND_CMD_PROGOOB, to, mtd->oobsize);
2964 onenand_update_bufferram(mtd, to, 0);
2965 if (ONENAND_IS_2PLANE(this)) {
2966 ONENAND_SET_BUFFERRAM1(this);
2967 onenand_update_bufferram(mtd, to + this->writesize, 0);
2968 }
2969
2970 ret = this->wait(mtd, FL_WRITING);
2971 if (ret) {
2972 printk(KERN_ERR "%s: write failed %d\n", __func__, ret);
2973 break;
2974 }
2975
2976 /* Exit OTP access mode */
2977 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
2978 this->wait(mtd, FL_RESETING);
2979
2980 status = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
2981 status &= 0x60;
2982
2983 if (status == 0x60) {
2984 printk(KERN_DEBUG "\nBLOCK\tSTATUS\n");
2985 printk(KERN_DEBUG "1st Block\tLOCKED\n");
2986 printk(KERN_DEBUG "OTP Block\tLOCKED\n");
2987 } else if (status == 0x20) {
2988 printk(KERN_DEBUG "\nBLOCK\tSTATUS\n");
2989 printk(KERN_DEBUG "1st Block\tLOCKED\n");
2990 printk(KERN_DEBUG "OTP Block\tUN-LOCKED\n");
2991 } else if (status == 0x40) {
2992 printk(KERN_DEBUG "\nBLOCK\tSTATUS\n");
2993 printk(KERN_DEBUG "1st Block\tUN-LOCKED\n");
2994 printk(KERN_DEBUG "OTP Block\tLOCKED\n");
2995 } else {
2996 printk(KERN_DEBUG "Reboot to check\n");
2997 }
2998
2999 written += thislen;
3000 if (written == len)
3001 break;
3002
3003 to += mtd->writesize;
3004 buf += thislen;
3005 column = 0;
3006 }
3007
3008 ops->oobretlen = written;
3009
3010 return ret;
3011}
3012
Mika Korhonen492e1502009-06-09 21:52:35 +03003013/* Internal OTP operation */
Kyungmin Park493c6462006-05-12 17:03:07 +03003014typedef int (*otp_op_t)(struct mtd_info *mtd, loff_t form, size_t len,
3015 size_t *retlen, u_char *buf);
3016
3017/**
3018 * do_otp_read - [DEFAULT] Read OTP block area
3019 * @param mtd MTD device structure
3020 * @param from The offset to read
3021 * @param len number of bytes to read
3022 * @param retlen pointer to variable to store the number of readbytes
3023 * @param buf the databuffer to put/get data
3024 *
3025 * Read OTP block area.
3026 */
3027static int do_otp_read(struct mtd_info *mtd, loff_t from, size_t len,
3028 size_t *retlen, u_char *buf)
3029{
3030 struct onenand_chip *this = mtd->priv;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003031 struct mtd_oob_ops ops = {
3032 .len = len,
3033 .ooblen = 0,
3034 .datbuf = buf,
3035 .oobbuf = NULL,
3036 };
Kyungmin Park493c6462006-05-12 17:03:07 +03003037 int ret;
3038
3039 /* Enter OTP access mode */
3040 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
3041 this->wait(mtd, FL_OTPING);
3042
Kyungmin Park8a8f6322010-12-02 09:24:16 +09003043 ret = ONENAND_IS_4KB_PAGE(this) ?
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003044 onenand_mlc_read_ops_nolock(mtd, from, &ops) :
3045 onenand_read_ops_nolock(mtd, from, &ops);
Kyungmin Park493c6462006-05-12 17:03:07 +03003046
3047 /* Exit OTP access mode */
3048 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
3049 this->wait(mtd, FL_RESETING);
3050
3051 return ret;
3052}
3053
3054/**
3055 * do_otp_write - [DEFAULT] Write OTP block area
3056 * @param mtd MTD device structure
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003057 * @param to The offset to write
Kyungmin Park493c6462006-05-12 17:03:07 +03003058 * @param len number of bytes to write
3059 * @param retlen pointer to variable to store the number of write bytes
3060 * @param buf the databuffer to put/get data
3061 *
3062 * Write OTP block area.
3063 */
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003064static int do_otp_write(struct mtd_info *mtd, loff_t to, size_t len,
Kyungmin Park493c6462006-05-12 17:03:07 +03003065 size_t *retlen, u_char *buf)
3066{
3067 struct onenand_chip *this = mtd->priv;
3068 unsigned char *pbuf = buf;
3069 int ret;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003070 struct mtd_oob_ops ops;
Kyungmin Park493c6462006-05-12 17:03:07 +03003071
3072 /* Force buffer page aligned */
Joern Engel28318772006-05-22 23:18:05 +02003073 if (len < mtd->writesize) {
Kyungmin Park493c6462006-05-12 17:03:07 +03003074 memcpy(this->page_buf, buf, len);
Joern Engel28318772006-05-22 23:18:05 +02003075 memset(this->page_buf + len, 0xff, mtd->writesize - len);
Kyungmin Park493c6462006-05-12 17:03:07 +03003076 pbuf = this->page_buf;
Joern Engel28318772006-05-22 23:18:05 +02003077 len = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03003078 }
3079
3080 /* Enter OTP access mode */
3081 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
3082 this->wait(mtd, FL_OTPING);
3083
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003084 ops.len = len;
3085 ops.ooblen = 0;
Kyungmin Park14370852007-10-10 13:48:14 +09003086 ops.datbuf = pbuf;
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003087 ops.oobbuf = NULL;
3088 ret = onenand_write_ops_nolock(mtd, to, &ops);
3089 *retlen = ops.retlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03003090
3091 /* Exit OTP access mode */
3092 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
3093 this->wait(mtd, FL_RESETING);
3094
3095 return ret;
3096}
3097
3098/**
3099 * do_otp_lock - [DEFAULT] Lock OTP block area
3100 * @param mtd MTD device structure
3101 * @param from The offset to lock
3102 * @param len number of bytes to lock
3103 * @param retlen pointer to variable to store the number of lock bytes
3104 * @param buf the databuffer to put/get data
3105 *
3106 * Lock OTP block area.
3107 */
3108static int do_otp_lock(struct mtd_info *mtd, loff_t from, size_t len,
3109 size_t *retlen, u_char *buf)
3110{
3111 struct onenand_chip *this = mtd->priv;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003112 struct mtd_oob_ops ops;
Kyungmin Park493c6462006-05-12 17:03:07 +03003113 int ret;
3114
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003115 if (FLEXONENAND(this)) {
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303116
3117 /* Enter OTP access mode */
3118 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
3119 this->wait(mtd, FL_OTPING);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003120 /*
3121 * For Flex-OneNAND, we write lock mark to 1st word of sector 4 of
3122 * main area of page 49.
3123 */
3124 ops.len = mtd->writesize;
3125 ops.ooblen = 0;
3126 ops.datbuf = buf;
3127 ops.oobbuf = NULL;
3128 ret = onenand_write_ops_nolock(mtd, mtd->writesize * 49, &ops);
3129 *retlen = ops.retlen;
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303130
3131 /* Exit OTP access mode */
3132 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
3133 this->wait(mtd, FL_RESETING);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003134 } else {
3135 ops.mode = MTD_OOB_PLACE;
3136 ops.ooblen = len;
3137 ops.oobbuf = buf;
3138 ops.ooboffs = 0;
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303139 ret = onenand_otp_write_oob_nolock(mtd, from, &ops);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003140 *retlen = ops.oobretlen;
3141 }
Kyungmin Park493c6462006-05-12 17:03:07 +03003142
Kyungmin Park493c6462006-05-12 17:03:07 +03003143 return ret;
3144}
3145
3146/**
3147 * onenand_otp_walk - [DEFAULT] Handle OTP operation
3148 * @param mtd MTD device structure
3149 * @param from The offset to read/write
3150 * @param len number of bytes to read/write
3151 * @param retlen pointer to variable to store the number of read bytes
3152 * @param buf the databuffer to put/get data
3153 * @param action do given action
3154 * @param mode specify user and factory
3155 *
3156 * Handle OTP operation.
3157 */
3158static int onenand_otp_walk(struct mtd_info *mtd, loff_t from, size_t len,
3159 size_t *retlen, u_char *buf,
3160 otp_op_t action, int mode)
3161{
3162 struct onenand_chip *this = mtd->priv;
3163 int otp_pages;
3164 int density;
3165 int ret = 0;
3166
3167 *retlen = 0;
3168
Kyungmin Parke71f04f2007-12-11 11:23:45 +09003169 density = onenand_get_density(this->device_id);
Kyungmin Park493c6462006-05-12 17:03:07 +03003170 if (density < ONENAND_DEVICE_DENSITY_512Mb)
3171 otp_pages = 20;
3172 else
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303173 otp_pages = 50;
Kyungmin Park493c6462006-05-12 17:03:07 +03003174
3175 if (mode == MTD_OTP_FACTORY) {
Joern Engel28318772006-05-22 23:18:05 +02003176 from += mtd->writesize * otp_pages;
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303177 otp_pages = ONENAND_PAGES_PER_BLOCK - otp_pages;
Kyungmin Park493c6462006-05-12 17:03:07 +03003178 }
3179
3180 /* Check User/Factory boundary */
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303181 if (mode == MTD_OTP_USER) {
Roel Kluin0a032a42009-12-16 01:37:17 +01003182 if (mtd->writesize * otp_pages < from + len)
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303183 return 0;
3184 } else {
Roel Kluin0a032a42009-12-16 01:37:17 +01003185 if (mtd->writesize * otp_pages < len)
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303186 return 0;
3187 }
Kyungmin Park493c6462006-05-12 17:03:07 +03003188
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003189 onenand_get_device(mtd, FL_OTPING);
Kyungmin Park493c6462006-05-12 17:03:07 +03003190 while (len > 0 && otp_pages > 0) {
3191 if (!action) { /* OTP Info functions */
3192 struct otp_info *otpinfo;
3193
3194 len -= sizeof(struct otp_info);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003195 if (len <= 0) {
3196 ret = -ENOSPC;
3197 break;
3198 }
Kyungmin Park493c6462006-05-12 17:03:07 +03003199
3200 otpinfo = (struct otp_info *) buf;
3201 otpinfo->start = from;
Joern Engel28318772006-05-22 23:18:05 +02003202 otpinfo->length = mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03003203 otpinfo->locked = 0;
3204
Joern Engel28318772006-05-22 23:18:05 +02003205 from += mtd->writesize;
Kyungmin Park493c6462006-05-12 17:03:07 +03003206 buf += sizeof(struct otp_info);
3207 *retlen += sizeof(struct otp_info);
3208 } else {
3209 size_t tmp_retlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03003210
3211 ret = action(mtd, from, len, &tmp_retlen, buf);
3212
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303213 buf += tmp_retlen;
3214 len -= tmp_retlen;
3215 *retlen += tmp_retlen;
Kyungmin Park493c6462006-05-12 17:03:07 +03003216
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003217 if (ret)
3218 break;
Kyungmin Park493c6462006-05-12 17:03:07 +03003219 }
3220 otp_pages--;
3221 }
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003222 onenand_release_device(mtd);
Kyungmin Park493c6462006-05-12 17:03:07 +03003223
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003224 return ret;
Kyungmin Park493c6462006-05-12 17:03:07 +03003225}
3226
3227/**
3228 * onenand_get_fact_prot_info - [MTD Interface] Read factory OTP info
3229 * @param mtd MTD device structure
3230 * @param buf the databuffer to put/get data
3231 * @param len number of bytes to read
3232 *
3233 * Read factory OTP info.
3234 */
3235static int onenand_get_fact_prot_info(struct mtd_info *mtd,
3236 struct otp_info *buf, size_t len)
3237{
3238 size_t retlen;
3239 int ret;
3240
3241 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_FACTORY);
3242
3243 return ret ? : retlen;
3244}
3245
3246/**
3247 * onenand_read_fact_prot_reg - [MTD Interface] Read factory OTP area
3248 * @param mtd MTD device structure
3249 * @param from The offset to read
3250 * @param len number of bytes to read
3251 * @param retlen pointer to variable to store the number of read bytes
3252 * @param buf the databuffer to put/get data
3253 *
3254 * Read factory OTP area.
3255 */
3256static int onenand_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
3257 size_t len, size_t *retlen, u_char *buf)
3258{
3259 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_FACTORY);
3260}
3261
3262/**
3263 * onenand_get_user_prot_info - [MTD Interface] Read user OTP info
3264 * @param mtd MTD device structure
3265 * @param buf the databuffer to put/get data
3266 * @param len number of bytes to read
3267 *
3268 * Read user OTP info.
3269 */
3270static int onenand_get_user_prot_info(struct mtd_info *mtd,
3271 struct otp_info *buf, size_t len)
3272{
3273 size_t retlen;
3274 int ret;
3275
3276 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_USER);
3277
3278 return ret ? : retlen;
3279}
3280
3281/**
3282 * onenand_read_user_prot_reg - [MTD Interface] Read user OTP area
3283 * @param mtd MTD device structure
3284 * @param from The offset to read
3285 * @param len number of bytes to read
3286 * @param retlen pointer to variable to store the number of read bytes
3287 * @param buf the databuffer to put/get data
3288 *
3289 * Read user OTP area.
3290 */
3291static int onenand_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
3292 size_t len, size_t *retlen, u_char *buf)
3293{
3294 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_USER);
3295}
3296
3297/**
3298 * onenand_write_user_prot_reg - [MTD Interface] Write user OTP area
3299 * @param mtd MTD device structure
3300 * @param from The offset to write
3301 * @param len number of bytes to write
3302 * @param retlen pointer to variable to store the number of write bytes
3303 * @param buf the databuffer to put/get data
3304 *
3305 * Write user OTP area.
3306 */
3307static int onenand_write_user_prot_reg(struct mtd_info *mtd, loff_t from,
3308 size_t len, size_t *retlen, u_char *buf)
3309{
3310 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_write, MTD_OTP_USER);
3311}
3312
3313/**
3314 * onenand_lock_user_prot_reg - [MTD Interface] Lock user OTP area
3315 * @param mtd MTD device structure
3316 * @param from The offset to lock
3317 * @param len number of bytes to unlock
3318 *
3319 * Write lock mark on spare area in page 0 in OTP block
3320 */
3321static int onenand_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
3322 size_t len)
3323{
Kyungmin Park69d79182007-12-14 14:47:21 +09003324 struct onenand_chip *this = mtd->priv;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003325 u_char *buf = FLEXONENAND(this) ? this->page_buf : this->oob_buf;
Kyungmin Park493c6462006-05-12 17:03:07 +03003326 size_t retlen;
3327 int ret;
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303328 unsigned int otp_lock_offset = ONENAND_OTP_LOCK_OFFSET;
Kyungmin Park493c6462006-05-12 17:03:07 +03003329
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003330 memset(buf, 0xff, FLEXONENAND(this) ? this->writesize
3331 : mtd->oobsize);
Kyungmin Park493c6462006-05-12 17:03:07 +03003332 /*
Kyungmin Park493c6462006-05-12 17:03:07 +03003333 * Write lock mark to 8th word of sector0 of page0 of the spare0.
3334 * We write 16 bytes spare area instead of 2 bytes.
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003335 * For Flex-OneNAND, we write lock mark to 1st word of sector 4 of
3336 * main area of page 49.
Kyungmin Park493c6462006-05-12 17:03:07 +03003337 */
Kyungmin Park493c6462006-05-12 17:03:07 +03003338
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003339 from = 0;
3340 len = FLEXONENAND(this) ? mtd->writesize : 16;
3341
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303342 /*
3343 * Note: OTP lock operation
3344 * OTP block : 0xXXFC XX 1111 1100
3345 * 1st block : 0xXXF3 (If chip support) XX 1111 0011
3346 * Both : 0xXXF0 (If chip support) XX 1111 0000
3347 */
3348 if (FLEXONENAND(this))
3349 otp_lock_offset = FLEXONENAND_OTP_LOCK_OFFSET;
3350
3351 /* ONENAND_OTP_AREA | ONENAND_OTP_BLOCK0 | ONENAND_OTP_AREA_BLOCK0 */
3352 if (otp == 1)
3353 buf[otp_lock_offset] = 0xFC;
3354 else if (otp == 2)
3355 buf[otp_lock_offset] = 0xF3;
3356 else if (otp == 3)
3357 buf[otp_lock_offset] = 0xF0;
3358 else if (otp != 0)
3359 printk(KERN_DEBUG "[OneNAND] Invalid option selected for OTP\n");
3360
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003361 ret = onenand_otp_walk(mtd, from, len, &retlen, buf, do_otp_lock, MTD_OTP_USER);
Kyungmin Park493c6462006-05-12 17:03:07 +03003362
3363 return ret ? : retlen;
3364}
Amul Kumar Saha3cf60252009-10-21 17:00:05 +05303365
Kyungmin Park493c6462006-05-12 17:03:07 +03003366#endif /* CONFIG_MTD_ONENAND_OTP */
3367
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003368/**
Kyungmin Park75384b02007-01-18 11:10:57 +09003369 * onenand_check_features - Check and set OneNAND features
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003370 * @param mtd MTD data structure
3371 *
Kyungmin Park75384b02007-01-18 11:10:57 +09003372 * Check and set OneNAND features
3373 * - lock scheme
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003374 * - two plane
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003375 */
Kyungmin Park75384b02007-01-18 11:10:57 +09003376static void onenand_check_features(struct mtd_info *mtd)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003377{
3378 struct onenand_chip *this = mtd->priv;
Roman Tereshonkovedb44b92010-10-11 14:47:32 +03003379 unsigned int density, process, numbufs;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003380
3381 /* Lock scheme depends on density and process */
Kyungmin Parke71f04f2007-12-11 11:23:45 +09003382 density = onenand_get_density(this->device_id);
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003383 process = this->version_id >> ONENAND_VERSION_PROCESS_SHIFT;
Roman Tereshonkovedb44b92010-10-11 14:47:32 +03003384 numbufs = this->read_word(this->base + ONENAND_REG_NUM_BUFFERS) >> 8;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003385
3386 /* Lock scheme */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003387 switch (density) {
3388 case ONENAND_DEVICE_DENSITY_4Gb:
Kyungmin Park6a88c472010-04-28 17:46:45 +02003389 if (ONENAND_IS_DDP(this))
3390 this->options |= ONENAND_HAS_2PLANE;
Roman Tereshonkovac80dac2010-11-03 12:55:21 +02003391 else if (numbufs == 1) {
Kyungmin Park6a88c472010-04-28 17:46:45 +02003392 this->options |= ONENAND_HAS_4KB_PAGE;
Roman Tereshonkovac80dac2010-11-03 12:55:21 +02003393 this->options |= ONENAND_HAS_CACHE_PROGRAM;
3394 }
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003395
3396 case ONENAND_DEVICE_DENSITY_2Gb:
Mika Korhonen492e1502009-06-09 21:52:35 +03003397 /* 2Gb DDP does not have 2 plane */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003398 if (!ONENAND_IS_DDP(this))
3399 this->options |= ONENAND_HAS_2PLANE;
3400 this->options |= ONENAND_HAS_UNLOCK_ALL;
3401
3402 case ONENAND_DEVICE_DENSITY_1Gb:
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003403 /* A-Die has all block unlock */
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003404 if (process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003405 this->options |= ONENAND_HAS_UNLOCK_ALL;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003406 break;
3407
3408 default:
3409 /* Some OneNAND has continuous lock scheme */
3410 if (!process)
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003411 this->options |= ONENAND_HAS_CONT_LOCK;
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003412 break;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003413 }
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003414
Kyungmin Park8a8f6322010-12-02 09:24:16 +09003415 /* The MLC has 4KiB pagesize. */
3416 if (ONENAND_IS_MLC(this))
3417 this->options |= ONENAND_HAS_4KB_PAGE;
3418
3419 if (ONENAND_IS_4KB_PAGE(this))
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003420 this->options &= ~ONENAND_HAS_2PLANE;
3421
3422 if (FLEXONENAND(this)) {
3423 this->options &= ~ONENAND_HAS_CONT_LOCK;
3424 this->options |= ONENAND_HAS_UNLOCK_ALL;
3425 }
3426
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003427 if (this->options & ONENAND_HAS_CONT_LOCK)
3428 printk(KERN_DEBUG "Lock scheme is Continuous Lock\n");
3429 if (this->options & ONENAND_HAS_UNLOCK_ALL)
3430 printk(KERN_DEBUG "Chip support all block unlock\n");
3431 if (this->options & ONENAND_HAS_2PLANE)
3432 printk(KERN_DEBUG "Chip has 2 plane\n");
Kyungmin Park6a88c472010-04-28 17:46:45 +02003433 if (this->options & ONENAND_HAS_4KB_PAGE)
3434 printk(KERN_DEBUG "Chip has 4KiB pagesize\n");
Roman Tereshonkovac80dac2010-11-03 12:55:21 +02003435 if (this->options & ONENAND_HAS_CACHE_PROGRAM)
3436 printk(KERN_DEBUG "Chip has cache program feature\n");
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003437}
3438
3439/**
Kyungmin Parke3da8062007-02-15 09:36:39 +09003440 * onenand_print_device_info - Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003441 * @param device device ID
Kyungmin Parke3da8062007-02-15 09:36:39 +09003442 * @param version version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003443 *
Kyungmin Parke3da8062007-02-15 09:36:39 +09003444 * Print device & version ID
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003445 */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003446static void onenand_print_device_info(int device, int version)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003447{
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003448 int vcc, demuxed, ddp, density, flexonenand;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003449
3450 vcc = device & ONENAND_DEVICE_VCC_MASK;
3451 demuxed = device & ONENAND_DEVICE_IS_DEMUX;
3452 ddp = device & ONENAND_DEVICE_IS_DDP;
Kyungmin Parke71f04f2007-12-11 11:23:45 +09003453 density = onenand_get_density(device);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003454 flexonenand = device & DEVICE_IS_FLEXONENAND;
3455 printk(KERN_INFO "%s%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
3456 demuxed ? "" : "Muxed ",
3457 flexonenand ? "Flex-" : "",
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003458 ddp ? "(DDP)" : "",
3459 (16 << density),
3460 vcc ? "2.65/3.3" : "1.8",
3461 device);
Artem Bityutskiy49dc08e2007-09-21 19:35:21 +03003462 printk(KERN_INFO "OneNAND version = 0x%04x\n", version);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003463}
3464
3465static const struct onenand_manufacturers onenand_manuf_ids[] = {
3466 {ONENAND_MFR_SAMSUNG, "Samsung"},
Adrian Hunteree8f3762009-05-05 11:04:19 +03003467 {ONENAND_MFR_NUMONYX, "Numonyx"},
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003468};
3469
3470/**
3471 * onenand_check_maf - Check manufacturer ID
3472 * @param manuf manufacturer ID
3473 *
3474 * Check manufacturer ID
3475 */
3476static int onenand_check_maf(int manuf)
3477{
Kyungmin Park37b1cc32005-12-16 11:17:29 +09003478 int size = ARRAY_SIZE(onenand_manuf_ids);
3479 char *name;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003480 int i;
3481
Kyungmin Park37b1cc32005-12-16 11:17:29 +09003482 for (i = 0; i < size; i++)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003483 if (manuf == onenand_manuf_ids[i].id)
3484 break;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003485
Kyungmin Park37b1cc32005-12-16 11:17:29 +09003486 if (i < size)
3487 name = onenand_manuf_ids[i].name;
3488 else
3489 name = "Unknown";
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003490
Kyungmin Park37b1cc32005-12-16 11:17:29 +09003491 printk(KERN_DEBUG "OneNAND Manufacturer: %s (0x%0x)\n", name, manuf);
3492
3493 return (i == size);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003494}
3495
3496/**
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003497* flexonenand_get_boundary - Reads the SLC boundary
3498* @param onenand_info - onenand info structure
3499**/
3500static int flexonenand_get_boundary(struct mtd_info *mtd)
3501{
3502 struct onenand_chip *this = mtd->priv;
3503 unsigned die, bdry;
3504 int ret, syscfg, locked;
3505
3506 /* Disable ECC */
3507 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
3508 this->write_word((syscfg | 0x0100), this->base + ONENAND_REG_SYS_CFG1);
3509
3510 for (die = 0; die < this->dies; die++) {
3511 this->command(mtd, FLEXONENAND_CMD_PI_ACCESS, die, 0);
3512 this->wait(mtd, FL_SYNCING);
3513
3514 this->command(mtd, FLEXONENAND_CMD_READ_PI, die, 0);
3515 ret = this->wait(mtd, FL_READING);
3516
3517 bdry = this->read_word(this->base + ONENAND_DATARAM);
3518 if ((bdry >> FLEXONENAND_PI_UNLOCK_SHIFT) == 3)
3519 locked = 0;
3520 else
3521 locked = 1;
3522 this->boundary[die] = bdry & FLEXONENAND_PI_MASK;
3523
3524 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
3525 ret = this->wait(mtd, FL_RESETING);
3526
3527 printk(KERN_INFO "Die %d boundary: %d%s\n", die,
3528 this->boundary[die], locked ? "(Locked)" : "(Unlocked)");
3529 }
3530
3531 /* Enable ECC */
3532 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
3533 return 0;
3534}
3535
3536/**
3537 * flexonenand_get_size - Fill up fields in onenand_chip and mtd_info
3538 * boundary[], diesize[], mtd->size, mtd->erasesize
3539 * @param mtd - MTD device structure
3540 */
3541static void flexonenand_get_size(struct mtd_info *mtd)
3542{
3543 struct onenand_chip *this = mtd->priv;
3544 int die, i, eraseshift, density;
3545 int blksperdie, maxbdry;
3546 loff_t ofs;
3547
3548 density = onenand_get_density(this->device_id);
3549 blksperdie = ((loff_t)(16 << density) << 20) >> (this->erase_shift);
3550 blksperdie >>= ONENAND_IS_DDP(this) ? 1 : 0;
3551 maxbdry = blksperdie - 1;
3552 eraseshift = this->erase_shift - 1;
3553
3554 mtd->numeraseregions = this->dies << 1;
3555
3556 /* This fills up the device boundary */
3557 flexonenand_get_boundary(mtd);
3558 die = ofs = 0;
3559 i = -1;
3560 for (; die < this->dies; die++) {
3561 if (!die || this->boundary[die-1] != maxbdry) {
3562 i++;
3563 mtd->eraseregions[i].offset = ofs;
3564 mtd->eraseregions[i].erasesize = 1 << eraseshift;
3565 mtd->eraseregions[i].numblocks =
3566 this->boundary[die] + 1;
3567 ofs += mtd->eraseregions[i].numblocks << eraseshift;
3568 eraseshift++;
3569 } else {
3570 mtd->numeraseregions -= 1;
3571 mtd->eraseregions[i].numblocks +=
3572 this->boundary[die] + 1;
3573 ofs += (this->boundary[die] + 1) << (eraseshift - 1);
3574 }
3575 if (this->boundary[die] != maxbdry) {
3576 i++;
3577 mtd->eraseregions[i].offset = ofs;
3578 mtd->eraseregions[i].erasesize = 1 << eraseshift;
3579 mtd->eraseregions[i].numblocks = maxbdry ^
3580 this->boundary[die];
3581 ofs += mtd->eraseregions[i].numblocks << eraseshift;
3582 eraseshift--;
3583 } else
3584 mtd->numeraseregions -= 1;
3585 }
3586
3587 /* Expose MLC erase size except when all blocks are SLC */
3588 mtd->erasesize = 1 << this->erase_shift;
3589 if (mtd->numeraseregions == 1)
3590 mtd->erasesize >>= 1;
3591
3592 printk(KERN_INFO "Device has %d eraseregions\n", mtd->numeraseregions);
3593 for (i = 0; i < mtd->numeraseregions; i++)
3594 printk(KERN_INFO "[offset: 0x%08x, erasesize: 0x%05x,"
3595 " numblocks: %04u]\n",
3596 (unsigned int) mtd->eraseregions[i].offset,
3597 mtd->eraseregions[i].erasesize,
3598 mtd->eraseregions[i].numblocks);
3599
3600 for (die = 0, mtd->size = 0; die < this->dies; die++) {
3601 this->diesize[die] = (loff_t)blksperdie << this->erase_shift;
3602 this->diesize[die] -= (loff_t)(this->boundary[die] + 1)
3603 << (this->erase_shift - 1);
3604 mtd->size += this->diesize[die];
3605 }
3606}
3607
3608/**
3609 * flexonenand_check_blocks_erased - Check if blocks are erased
3610 * @param mtd_info - mtd info structure
3611 * @param start - first erase block to check
3612 * @param end - last erase block to check
3613 *
3614 * Converting an unerased block from MLC to SLC
3615 * causes byte values to change. Since both data and its ECC
3616 * have changed, reads on the block give uncorrectable error.
3617 * This might lead to the block being detected as bad.
3618 *
3619 * Avoid this by ensuring that the block to be converted is
3620 * erased.
3621 */
3622static int flexonenand_check_blocks_erased(struct mtd_info *mtd, int start, int end)
3623{
3624 struct onenand_chip *this = mtd->priv;
3625 int i, ret;
3626 int block;
3627 struct mtd_oob_ops ops = {
3628 .mode = MTD_OOB_PLACE,
3629 .ooboffs = 0,
3630 .ooblen = mtd->oobsize,
3631 .datbuf = NULL,
3632 .oobbuf = this->oob_buf,
3633 };
3634 loff_t addr;
3635
3636 printk(KERN_DEBUG "Check blocks from %d to %d\n", start, end);
3637
3638 for (block = start; block <= end; block++) {
3639 addr = flexonenand_addr(this, block);
3640 if (onenand_block_isbad_nolock(mtd, addr, 0))
3641 continue;
3642
3643 /*
3644 * Since main area write results in ECC write to spare,
3645 * it is sufficient to check only ECC bytes for change.
3646 */
3647 ret = onenand_read_oob_nolock(mtd, addr, &ops);
3648 if (ret)
3649 return ret;
3650
3651 for (i = 0; i < mtd->oobsize; i++)
3652 if (this->oob_buf[i] != 0xff)
3653 break;
3654
3655 if (i != mtd->oobsize) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303656 printk(KERN_WARNING "%s: Block %d not erased.\n",
3657 __func__, block);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003658 return 1;
3659 }
3660 }
3661
3662 return 0;
3663}
3664
3665/**
3666 * flexonenand_set_boundary - Writes the SLC boundary
3667 * @param mtd - mtd info structure
3668 */
3669int flexonenand_set_boundary(struct mtd_info *mtd, int die,
3670 int boundary, int lock)
3671{
3672 struct onenand_chip *this = mtd->priv;
3673 int ret, density, blksperdie, old, new, thisboundary;
3674 loff_t addr;
3675
3676 /* Change only once for SDP Flex-OneNAND */
3677 if (die && (!ONENAND_IS_DDP(this)))
3678 return 0;
3679
3680 /* boundary value of -1 indicates no required change */
3681 if (boundary < 0 || boundary == this->boundary[die])
3682 return 0;
3683
3684 density = onenand_get_density(this->device_id);
3685 blksperdie = ((16 << density) << 20) >> this->erase_shift;
3686 blksperdie >>= ONENAND_IS_DDP(this) ? 1 : 0;
3687
3688 if (boundary >= blksperdie) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303689 printk(KERN_ERR "%s: Invalid boundary value. "
3690 "Boundary not changed.\n", __func__);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003691 return -EINVAL;
3692 }
3693
3694 /* Check if converting blocks are erased */
3695 old = this->boundary[die] + (die * this->density_mask);
3696 new = boundary + (die * this->density_mask);
3697 ret = flexonenand_check_blocks_erased(mtd, min(old, new) + 1, max(old, new));
3698 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303699 printk(KERN_ERR "%s: Please erase blocks "
3700 "before boundary change\n", __func__);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003701 return ret;
3702 }
3703
3704 this->command(mtd, FLEXONENAND_CMD_PI_ACCESS, die, 0);
3705 this->wait(mtd, FL_SYNCING);
3706
3707 /* Check is boundary is locked */
3708 this->command(mtd, FLEXONENAND_CMD_READ_PI, die, 0);
3709 ret = this->wait(mtd, FL_READING);
3710
3711 thisboundary = this->read_word(this->base + ONENAND_DATARAM);
3712 if ((thisboundary >> FLEXONENAND_PI_UNLOCK_SHIFT) != 3) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303713 printk(KERN_ERR "%s: boundary locked\n", __func__);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003714 ret = 1;
3715 goto out;
3716 }
3717
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303718 printk(KERN_INFO "Changing die %d boundary: %d%s\n",
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003719 die, boundary, lock ? "(Locked)" : "(Unlocked)");
3720
3721 addr = die ? this->diesize[0] : 0;
3722
3723 boundary &= FLEXONENAND_PI_MASK;
3724 boundary |= lock ? 0 : (3 << FLEXONENAND_PI_UNLOCK_SHIFT);
3725
3726 this->command(mtd, ONENAND_CMD_ERASE, addr, 0);
3727 ret = this->wait(mtd, FL_ERASING);
3728 if (ret) {
Mika Korhonenf369c7e2009-10-23 07:50:44 +02003729 printk(KERN_ERR "%s: Failed PI erase for Die %d\n",
3730 __func__, die);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003731 goto out;
3732 }
3733
3734 this->write_word(boundary, this->base + ONENAND_DATARAM);
3735 this->command(mtd, ONENAND_CMD_PROG, addr, 0);
3736 ret = this->wait(mtd, FL_WRITING);
3737 if (ret) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303738 printk(KERN_ERR "%s: Failed PI write for Die %d\n",
3739 __func__, die);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003740 goto out;
3741 }
3742
3743 this->command(mtd, FLEXONENAND_CMD_PI_UPDATE, die, 0);
3744 ret = this->wait(mtd, FL_WRITING);
3745out:
3746 this->write_word(ONENAND_CMD_RESET, this->base + ONENAND_REG_COMMAND);
3747 this->wait(mtd, FL_RESETING);
3748 if (!ret)
3749 /* Recalculate device size on boundary change*/
3750 flexonenand_get_size(mtd);
3751
3752 return ret;
3753}
3754
3755/**
Kyungmin Parkad0d3632010-05-28 11:03:11 +09003756 * onenand_chip_probe - [OneNAND Interface] The generic chip probe
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003757 * @param mtd MTD device structure
3758 *
3759 * OneNAND detection method:
Michael Opdenacker59c51592007-05-09 08:57:56 +02003760 * Compare the values from command with ones from register
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003761 */
Kyungmin Parkad0d3632010-05-28 11:03:11 +09003762static int onenand_chip_probe(struct mtd_info *mtd)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003763{
3764 struct onenand_chip *this = mtd->priv;
Kyungmin Parkad0d3632010-05-28 11:03:11 +09003765 int bram_maf_id, bram_dev_id, maf_id, dev_id;
Kyungmin Park47e777e2006-09-25 23:53:28 +00003766 int syscfg;
3767
3768 /* Save system configuration 1 */
3769 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
3770 /* Clear Sync. Burst Read mode to read BootRAM */
Adrian Hunteree8f3762009-05-05 11:04:19 +03003771 this->write_word((syscfg & ~ONENAND_SYS_CFG1_SYNC_READ & ~ONENAND_SYS_CFG1_SYNC_WRITE), this->base + ONENAND_REG_SYS_CFG1);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003772
3773 /* Send the command for reading device ID from BootRAM */
3774 this->write_word(ONENAND_CMD_READID, this->base + ONENAND_BOOTRAM);
3775
3776 /* Read manufacturer and device IDs from BootRAM */
3777 bram_maf_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x0);
3778 bram_dev_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x2);
3779
Kyungmin Park47e777e2006-09-25 23:53:28 +00003780 /* Reset OneNAND to read default register values */
3781 this->write_word(ONENAND_CMD_RESET, this->base + ONENAND_BOOTRAM);
3782 /* Wait reset */
3783 this->wait(mtd, FL_RESETING);
3784
3785 /* Restore system configuration 1 */
3786 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
3787
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003788 /* Check manufacturer ID */
3789 if (onenand_check_maf(bram_maf_id))
3790 return -ENXIO;
3791
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003792 /* Read manufacturer and device IDs from Register */
3793 maf_id = this->read_word(this->base + ONENAND_REG_MANUFACTURER_ID);
3794 dev_id = this->read_word(this->base + ONENAND_REG_DEVICE_ID);
3795
3796 /* Check OneNAND device */
3797 if (maf_id != bram_maf_id || dev_id != bram_dev_id)
3798 return -ENXIO;
3799
Kyungmin Parkad0d3632010-05-28 11:03:11 +09003800 return 0;
3801}
3802
3803/**
3804 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
3805 * @param mtd MTD device structure
3806 */
3807static int onenand_probe(struct mtd_info *mtd)
3808{
3809 struct onenand_chip *this = mtd->priv;
3810 int maf_id, dev_id, ver_id;
3811 int density;
3812 int ret;
3813
3814 ret = this->chip_probe(mtd);
3815 if (ret)
3816 return ret;
3817
3818 /* Read manufacturer and device IDs from Register */
3819 maf_id = this->read_word(this->base + ONENAND_REG_MANUFACTURER_ID);
3820 dev_id = this->read_word(this->base + ONENAND_REG_DEVICE_ID);
3821 ver_id = this->read_word(this->base + ONENAND_REG_VERSION_ID);
3822 this->technology = this->read_word(this->base + ONENAND_REG_TECHNOLOGY);
3823
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003824 /* Flash device information */
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003825 onenand_print_device_info(dev_id, ver_id);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003826 this->device_id = dev_id;
Kyungmin Park28b79ff2006-09-26 09:45:28 +00003827 this->version_id = ver_id;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003828
Kyungmin Parkc37cb562010-04-28 17:46:48 +02003829 /* Check OneNAND features */
3830 onenand_check_features(mtd);
3831
Kyungmin Parke71f04f2007-12-11 11:23:45 +09003832 density = onenand_get_density(dev_id);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003833 if (FLEXONENAND(this)) {
3834 this->dies = ONENAND_IS_DDP(this) ? 2 : 1;
3835 /* Maximum possible erase regions */
3836 mtd->numeraseregions = this->dies << 1;
3837 mtd->eraseregions = kzalloc(sizeof(struct mtd_erase_region_info)
3838 * (this->dies << 1), GFP_KERNEL);
3839 if (!mtd->eraseregions)
3840 return -ENOMEM;
3841 }
3842
3843 /*
3844 * For Flex-OneNAND, chipsize represents maximum possible device size.
3845 * mtd->size represents the actual device size.
3846 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003847 this->chipsize = (16 << density) << 20;
3848
3849 /* OneNAND page size & block size */
3850 /* The data buffer size is equal to page size */
Joern Engel28318772006-05-22 23:18:05 +02003851 mtd->writesize = this->read_word(this->base + ONENAND_REG_DATA_BUFFER_SIZE);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003852 /* We use the full BufferRAM */
Kyungmin Park8a8f6322010-12-02 09:24:16 +09003853 if (ONENAND_IS_4KB_PAGE(this))
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003854 mtd->writesize <<= 1;
3855
Joern Engel28318772006-05-22 23:18:05 +02003856 mtd->oobsize = mtd->writesize >> 5;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09003857 /* Pages per a block are always 64 in OneNAND */
Joern Engel28318772006-05-22 23:18:05 +02003858 mtd->erasesize = mtd->writesize << 6;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003859 /*
3860 * Flex-OneNAND SLC area has 64 pages per block.
3861 * Flex-OneNAND MLC area has 128 pages per block.
3862 * Expose MLC erase size to find erase_shift and page_mask.
3863 */
3864 if (FLEXONENAND(this))
3865 mtd->erasesize <<= 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003866
3867 this->erase_shift = ffs(mtd->erasesize) - 1;
Joern Engel28318772006-05-22 23:18:05 +02003868 this->page_shift = ffs(mtd->writesize) - 1;
Kyungmin Park9bfbc9b2007-01-31 14:25:21 +09003869 this->page_mask = (1 << (this->erase_shift - this->page_shift)) - 1;
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003870 /* Set density mask. it is used for DDP */
3871 if (ONENAND_IS_DDP(this))
3872 this->density_mask = this->chipsize >> (this->erase_shift + 1);
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003873 /* It's real page size */
3874 this->writesize = mtd->writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003875
Mika Korhonen492e1502009-06-09 21:52:35 +03003876 /* REVISIT: Multichip handling */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003877
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003878 if (FLEXONENAND(this))
3879 flexonenand_get_size(mtd);
3880 else
3881 mtd->size = this->chipsize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003882
Kyungmin Parkee9745f2007-06-30 13:57:49 +09003883 /*
3884 * We emulate the 4KiB page and 256KiB erase block size
3885 * But oobsize is still 64 bytes.
3886 * It is only valid if you turn on 2X program support,
3887 * Otherwise it will be ignored by compiler.
3888 */
3889 if (ONENAND_IS_2PLANE(this)) {
3890 mtd->writesize <<= 1;
3891 mtd->erasesize <<= 1;
3892 }
3893
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003894 return 0;
3895}
3896
Kyungmin Parka41371e2005-09-29 03:55:31 +01003897/**
3898 * onenand_suspend - [MTD Interface] Suspend the OneNAND flash
3899 * @param mtd MTD device structure
3900 */
3901static int onenand_suspend(struct mtd_info *mtd)
3902{
3903 return onenand_get_device(mtd, FL_PM_SUSPENDED);
3904}
3905
3906/**
3907 * onenand_resume - [MTD Interface] Resume the OneNAND flash
3908 * @param mtd MTD device structure
3909 */
3910static void onenand_resume(struct mtd_info *mtd)
3911{
3912 struct onenand_chip *this = mtd->priv;
3913
3914 if (this->state == FL_PM_SUSPENDED)
3915 onenand_release_device(mtd);
3916 else
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303917 printk(KERN_ERR "%s: resume() called for the chip which is not "
3918 "in suspended state\n", __func__);
Kyungmin Parka41371e2005-09-29 03:55:31 +01003919}
3920
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003921/**
3922 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
3923 * @param mtd MTD device structure
3924 * @param maxchips Number of chips to scan for
3925 *
3926 * This fills out all the not initialized function pointers
3927 * with the defaults.
3928 * The flash ID is read and the mtd/chip structures are
3929 * filled with the appropriate values.
3930 */
3931int onenand_scan(struct mtd_info *mtd, int maxchips)
3932{
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07003933 int i, ret;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003934 struct onenand_chip *this = mtd->priv;
3935
3936 if (!this->read_word)
3937 this->read_word = onenand_readw;
3938 if (!this->write_word)
3939 this->write_word = onenand_writew;
3940
3941 if (!this->command)
3942 this->command = onenand_command;
3943 if (!this->wait)
Kyungmin Park2c221202006-11-16 11:23:48 +09003944 onenand_setup_wait(mtd);
Kyungmin Park31bb9992009-05-12 13:46:57 -07003945 if (!this->bbt_wait)
3946 this->bbt_wait = onenand_bbt_wait;
3947 if (!this->unlock_all)
3948 this->unlock_all = onenand_unlock_all;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003949
Kyungmin Parkad0d3632010-05-28 11:03:11 +09003950 if (!this->chip_probe)
3951 this->chip_probe = onenand_chip_probe;
3952
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003953 if (!this->read_bufferram)
3954 this->read_bufferram = onenand_read_bufferram;
3955 if (!this->write_bufferram)
3956 this->write_bufferram = onenand_write_bufferram;
3957
Kyungmin Parkcdc00132005-09-03 07:15:48 +01003958 if (!this->block_markbad)
3959 this->block_markbad = onenand_default_block_markbad;
3960 if (!this->scan_bbt)
3961 this->scan_bbt = onenand_default_bbt;
3962
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01003963 if (onenand_probe(mtd))
3964 return -ENXIO;
3965
Kyungmin Park52b0eea2005-09-03 07:07:19 +01003966 /* Set Sync. Burst Read after probing */
3967 if (this->mmcontrol) {
3968 printk(KERN_INFO "OneNAND Sync. Burst Read support\n");
3969 this->read_bufferram = onenand_sync_read_bufferram;
3970 }
3971
Kyungmin Park532a37c2005-12-16 11:17:29 +09003972 /* Allocate buffers, if necessary */
3973 if (!this->page_buf) {
Kyungmin Park470bc842007-03-09 10:08:11 +09003974 this->page_buf = kzalloc(mtd->writesize, GFP_KERNEL);
Kyungmin Park532a37c2005-12-16 11:17:29 +09003975 if (!this->page_buf) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303976 printk(KERN_ERR "%s: Can't allocate page_buf\n",
3977 __func__);
Kyungmin Park532a37c2005-12-16 11:17:29 +09003978 return -ENOMEM;
3979 }
Kyungmin Park4a8ce0b2010-04-28 17:46:46 +02003980#ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
3981 this->verify_buf = kzalloc(mtd->writesize, GFP_KERNEL);
3982 if (!this->verify_buf) {
3983 kfree(this->page_buf);
3984 return -ENOMEM;
3985 }
3986#endif
Kyungmin Park532a37c2005-12-16 11:17:29 +09003987 this->options |= ONENAND_PAGEBUF_ALLOC;
3988 }
Kyungmin Park470bc842007-03-09 10:08:11 +09003989 if (!this->oob_buf) {
3990 this->oob_buf = kzalloc(mtd->oobsize, GFP_KERNEL);
3991 if (!this->oob_buf) {
Amul Kumar Saha297758f2009-10-02 16:59:11 +05303992 printk(KERN_ERR "%s: Can't allocate oob_buf\n",
3993 __func__);
Kyungmin Park470bc842007-03-09 10:08:11 +09003994 if (this->options & ONENAND_PAGEBUF_ALLOC) {
3995 this->options &= ~ONENAND_PAGEBUF_ALLOC;
3996 kfree(this->page_buf);
3997 }
3998 return -ENOMEM;
3999 }
4000 this->options |= ONENAND_OOBBUF_ALLOC;
4001 }
Kyungmin Park532a37c2005-12-16 11:17:29 +09004002
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004003 this->state = FL_READY;
4004 init_waitqueue_head(&this->wq);
4005 spin_lock_init(&this->chip_lock);
4006
Kyungmin Park60d84f92006-12-22 16:21:54 +09004007 /*
4008 * Allow subpage writes up to oobsize.
4009 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004010 switch (mtd->oobsize) {
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07004011 case 128:
4012 this->ecclayout = &onenand_oob_128;
4013 mtd->subpage_sft = 0;
4014 break;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004015 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004016 this->ecclayout = &onenand_oob_64;
Kyungmin Park60d84f92006-12-22 16:21:54 +09004017 mtd->subpage_sft = 2;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004018 break;
4019
4020 case 32:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004021 this->ecclayout = &onenand_oob_32;
Kyungmin Park60d84f92006-12-22 16:21:54 +09004022 mtd->subpage_sft = 1;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004023 break;
4024
4025 default:
Amul Kumar Saha297758f2009-10-02 16:59:11 +05304026 printk(KERN_WARNING "%s: No OOB scheme defined for oobsize %d\n",
4027 __func__, mtd->oobsize);
Kyungmin Park60d84f92006-12-22 16:21:54 +09004028 mtd->subpage_sft = 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004029 /* To prevent kernel oops */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004030 this->ecclayout = &onenand_oob_32;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004031 break;
4032 }
4033
Kyungmin Park60d84f92006-12-22 16:21:54 +09004034 this->subpagesize = mtd->writesize >> mtd->subpage_sft;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02004035
4036 /*
4037 * The number of bytes available for a client to place data into
4038 * the out of band area
4039 */
4040 this->ecclayout->oobavail = 0;
Kyungmin Parkad286342007-03-23 10:19:52 +09004041 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES &&
4042 this->ecclayout->oobfree[i].length; i++)
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02004043 this->ecclayout->oobavail +=
4044 this->ecclayout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03004045 mtd->oobavail = this->ecclayout->oobavail;
Adrian Huntera5e7c7b2007-01-31 17:19:28 +02004046
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004047 mtd->ecclayout = this->ecclayout;
Thomas Gleixnerd5c5e782005-11-07 11:15:51 +00004048
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004049 /* Fill in remaining MTD driver data */
Rohit Hassan Sathyanarayanc7626802010-09-27 16:02:10 +05304050 mtd->type = ONENAND_IS_MLC(this) ? MTD_MLCNANDFLASH : MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02004051 mtd->flags = MTD_CAP_NANDFLASH;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004052 mtd->erase = onenand_erase;
4053 mtd->point = NULL;
4054 mtd->unpoint = NULL;
4055 mtd->read = onenand_read;
4056 mtd->write = onenand_write;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004057 mtd->read_oob = onenand_read_oob;
4058 mtd->write_oob = onenand_write_oob;
Richard Purdie6c77fd62008-02-06 10:18:22 +00004059 mtd->panic_write = onenand_panic_write;
Kyungmin Park493c6462006-05-12 17:03:07 +03004060#ifdef CONFIG_MTD_ONENAND_OTP
4061 mtd->get_fact_prot_info = onenand_get_fact_prot_info;
4062 mtd->read_fact_prot_reg = onenand_read_fact_prot_reg;
4063 mtd->get_user_prot_info = onenand_get_user_prot_info;
4064 mtd->read_user_prot_reg = onenand_read_user_prot_reg;
4065 mtd->write_user_prot_reg = onenand_write_user_prot_reg;
4066 mtd->lock_user_prot_reg = onenand_lock_user_prot_reg;
4067#endif
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004068 mtd->sync = onenand_sync;
Kyungmin Park08f782b2006-11-16 11:29:39 +09004069 mtd->lock = onenand_lock;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004070 mtd->unlock = onenand_unlock;
Kyungmin Parka41371e2005-09-29 03:55:31 +01004071 mtd->suspend = onenand_suspend;
4072 mtd->resume = onenand_resume;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004073 mtd->block_isbad = onenand_block_isbad;
4074 mtd->block_markbad = onenand_block_markbad;
4075 mtd->owner = THIS_MODULE;
4076
4077 /* Unlock whole block */
Kyungmin Park31bb9992009-05-12 13:46:57 -07004078 this->unlock_all(mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004079
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07004080 ret = this->scan_bbt(mtd);
4081 if ((!FLEXONENAND(this)) || ret)
4082 return ret;
4083
4084 /* Change Flex-OneNAND boundaries if required */
4085 for (i = 0; i < MAX_DIES; i++)
4086 flexonenand_set_boundary(mtd, i, flex_bdry[2 * i],
4087 flex_bdry[(2 * i) + 1]);
4088
4089 return 0;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004090}
4091
4092/**
4093 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
4094 * @param mtd MTD device structure
4095 */
4096void onenand_release(struct mtd_info *mtd)
4097{
Kyungmin Park532a37c2005-12-16 11:17:29 +09004098 struct onenand_chip *this = mtd->priv;
4099
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004100#ifdef CONFIG_MTD_PARTITIONS
4101 /* Deregister partitions */
4102 del_mtd_partitions (mtd);
4103#endif
4104 /* Deregister the device */
4105 del_mtd_device (mtd);
Kyungmin Park532a37c2005-12-16 11:17:29 +09004106
4107 /* Free bad block table memory, if allocated */
Adrian Hunterf00b0042007-01-22 17:01:01 +09004108 if (this->bbm) {
4109 struct bbm_info *bbm = this->bbm;
4110 kfree(bbm->bbt);
Kyungmin Park532a37c2005-12-16 11:17:29 +09004111 kfree(this->bbm);
Adrian Hunterf00b0042007-01-22 17:01:01 +09004112 }
Kyungmin Park470bc842007-03-09 10:08:11 +09004113 /* Buffers allocated by onenand_scan */
Kyungmin Park4a8ce0b2010-04-28 17:46:46 +02004114 if (this->options & ONENAND_PAGEBUF_ALLOC) {
Kyungmin Park532a37c2005-12-16 11:17:29 +09004115 kfree(this->page_buf);
Kyungmin Park4a8ce0b2010-04-28 17:46:46 +02004116#ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
4117 kfree(this->verify_buf);
4118#endif
4119 }
Kyungmin Park470bc842007-03-09 10:08:11 +09004120 if (this->options & ONENAND_OOBBUF_ALLOC)
4121 kfree(this->oob_buf);
Rohit Hagargundgi5988af22009-05-12 13:46:57 -07004122 kfree(mtd->eraseregions);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01004123}
4124
4125EXPORT_SYMBOL_GPL(onenand_scan);
4126EXPORT_SYMBOL_GPL(onenand_release);
4127
4128MODULE_LICENSE("GPL");
4129MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
4130MODULE_DESCRIPTION("Generic OneNAND flash driver code");