blob: 6dd9aff8bb2d37181fb711c98f9d839f1fd52a15 [file] [log] [blame]
David Brownell1d6432f2006-01-08 13:34:22 -08001/*
2 * Atmel AT45xxx DataFlash MTD driver for lightweight SPI framework
3 *
4 * Largely derived from at91_dataflash.c:
5 * Copyright (C) 2003-2005 SAN People (Pty) Ltd
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11*/
David Brownell1d6432f2006-01-08 13:34:22 -080012#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/slab.h>
15#include <linux/delay.h>
16#include <linux/device.h>
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +010017#include <linux/mutex.h>
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -070018#include <linux/err.h>
19
David Brownell1d6432f2006-01-08 13:34:22 -080020#include <linux/spi/spi.h>
21#include <linux/spi/flash.h>
22
23#include <linux/mtd/mtd.h>
24#include <linux/mtd/partitions.h>
25
26
27/*
28 * DataFlash is a kind of SPI flash. Most AT45 chips have two buffers in
29 * each chip, which may be used for double buffered I/O; but this driver
30 * doesn't (yet) use these for any kind of i/o overlap or prefetching.
31 *
32 * Sometimes DataFlash is packaged in MMC-format cards, although the
David Brownell8c640382008-08-06 21:55:14 -070033 * MMC stack can't (yet?) distinguish between MMC and DataFlash
David Brownell1d6432f2006-01-08 13:34:22 -080034 * protocols during enumeration.
35 */
36
David Brownell1d6432f2006-01-08 13:34:22 -080037/* reads can bypass the buffers */
38#define OP_READ_CONTINUOUS 0xE8
39#define OP_READ_PAGE 0xD2
40
41/* group B requests can run even while status reports "busy" */
42#define OP_READ_STATUS 0xD7 /* group B */
43
44/* move data between host and buffer */
45#define OP_READ_BUFFER1 0xD4 /* group B */
46#define OP_READ_BUFFER2 0xD6 /* group B */
47#define OP_WRITE_BUFFER1 0x84 /* group B */
48#define OP_WRITE_BUFFER2 0x87 /* group B */
49
50/* erasing flash */
51#define OP_ERASE_PAGE 0x81
52#define OP_ERASE_BLOCK 0x50
53
54/* move data between buffer and flash */
55#define OP_TRANSFER_BUF1 0x53
56#define OP_TRANSFER_BUF2 0x55
57#define OP_MREAD_BUFFER1 0xD4
58#define OP_MREAD_BUFFER2 0xD6
59#define OP_MWERASE_BUFFER1 0x83
60#define OP_MWERASE_BUFFER2 0x86
61#define OP_MWRITE_BUFFER1 0x88 /* sector must be pre-erased */
62#define OP_MWRITE_BUFFER2 0x89 /* sector must be pre-erased */
63
64/* write to buffer, then write-erase to flash */
65#define OP_PROGRAM_VIA_BUF1 0x82
66#define OP_PROGRAM_VIA_BUF2 0x85
67
68/* compare buffer to flash */
69#define OP_COMPARE_BUF1 0x60
70#define OP_COMPARE_BUF2 0x61
71
72/* read flash to buffer, then write-erase to flash */
73#define OP_REWRITE_VIA_BUF1 0x58
74#define OP_REWRITE_VIA_BUF2 0x59
75
76/* newer chips report JEDEC manufacturer and device IDs; chip
77 * serial number and OTP bits; and per-sector writeprotect.
78 */
79#define OP_READ_ID 0x9F
80#define OP_READ_SECURITY 0x77
David Brownell34a82442008-07-30 12:35:05 -070081#define OP_WRITE_SECURITY_REVC 0x9A
82#define OP_WRITE_SECURITY 0x9B /* revision D */
David Brownell1d6432f2006-01-08 13:34:22 -080083
84
85struct dataflash {
David Woodhouse271c5c52008-06-04 17:43:22 +010086 uint8_t command[4];
David Brownell1d6432f2006-01-08 13:34:22 -080087 char name[24];
88
89 unsigned partitioned:1;
90
91 unsigned short page_offset; /* offset in flash address */
92 unsigned int page_size; /* of bytes per page */
93
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +010094 struct mutex lock;
David Brownell1d6432f2006-01-08 13:34:22 -080095 struct spi_device *spi;
96
97 struct mtd_info mtd;
98};
99
100#ifdef CONFIG_MTD_PARTITIONS
101#define mtd_has_partitions() (1)
102#else
103#define mtd_has_partitions() (0)
104#endif
105
106/* ......................................................................... */
107
108/*
109 * Return the status of the DataFlash device.
110 */
111static inline int dataflash_status(struct spi_device *spi)
112{
113 /* NOTE: at45db321c over 25 MHz wants to write
114 * a dummy byte after the opcode...
115 */
116 return spi_w8r8(spi, OP_READ_STATUS);
117}
118
119/*
120 * Poll the DataFlash device until it is READY.
121 * This usually takes 5-20 msec or so; more for sector erase.
122 */
123static int dataflash_waitready(struct spi_device *spi)
124{
125 int status;
126
127 for (;;) {
128 status = dataflash_status(spi);
129 if (status < 0) {
130 DEBUG(MTD_DEBUG_LEVEL1, "%s: status %d?\n",
131 spi->dev.bus_id, status);
132 status = 0;
133 }
134
135 if (status & (1 << 7)) /* RDY/nBSY */
136 return status;
137
138 msleep(3);
139 }
140}
141
142/* ......................................................................... */
143
144/*
145 * Erase pages of flash.
146 */
147static int dataflash_erase(struct mtd_info *mtd, struct erase_info *instr)
148{
149 struct dataflash *priv = (struct dataflash *)mtd->priv;
150 struct spi_device *spi = priv->spi;
Vitaly Wool8275c642006-01-08 13:34:28 -0800151 struct spi_transfer x = { .tx_dma = 0, };
David Brownell1d6432f2006-01-08 13:34:22 -0800152 struct spi_message msg;
153 unsigned blocksize = priv->page_size << 3;
David Woodhouse271c5c52008-06-04 17:43:22 +0100154 uint8_t *command;
David Brownell1d6432f2006-01-08 13:34:22 -0800155
156 DEBUG(MTD_DEBUG_LEVEL2, "%s: erase addr=0x%x len 0x%x\n",
157 spi->dev.bus_id,
158 instr->addr, instr->len);
159
160 /* Sanity checks */
161 if ((instr->addr + instr->len) > mtd->size
162 || (instr->len % priv->page_size) != 0
163 || (instr->addr % priv->page_size) != 0)
164 return -EINVAL;
165
Vitaly Wool8275c642006-01-08 13:34:28 -0800166 spi_message_init(&msg);
167
168 x.tx_buf = command = priv->command;
169 x.len = 4;
170 spi_message_add_tail(&x, &msg);
David Brownell1d6432f2006-01-08 13:34:22 -0800171
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100172 mutex_lock(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800173 while (instr->len > 0) {
174 unsigned int pageaddr;
175 int status;
176 int do_block;
177
178 /* Calculate flash page address; use block erase (for speed) if
179 * we're at a block boundary and need to erase the whole block.
180 */
181 pageaddr = instr->addr / priv->page_size;
David Brownell3cb4f092006-03-13 21:20:40 -0800182 do_block = (pageaddr & 0x7) == 0 && instr->len >= blocksize;
David Brownell1d6432f2006-01-08 13:34:22 -0800183 pageaddr = pageaddr << priv->page_offset;
184
185 command[0] = do_block ? OP_ERASE_BLOCK : OP_ERASE_PAGE;
David Woodhouse271c5c52008-06-04 17:43:22 +0100186 command[1] = (uint8_t)(pageaddr >> 16);
187 command[2] = (uint8_t)(pageaddr >> 8);
David Brownell1d6432f2006-01-08 13:34:22 -0800188 command[3] = 0;
189
190 DEBUG(MTD_DEBUG_LEVEL3, "ERASE %s: (%x) %x %x %x [%i]\n",
191 do_block ? "block" : "page",
192 command[0], command[1], command[2], command[3],
193 pageaddr);
194
195 status = spi_sync(spi, &msg);
196 (void) dataflash_waitready(spi);
197
198 if (status < 0) {
199 printk(KERN_ERR "%s: erase %x, err %d\n",
200 spi->dev.bus_id, pageaddr, status);
201 /* REVISIT: can retry instr->retries times; or
202 * giveup and instr->fail_addr = instr->addr;
203 */
204 continue;
205 }
206
207 if (do_block) {
208 instr->addr += blocksize;
209 instr->len -= blocksize;
210 } else {
211 instr->addr += priv->page_size;
212 instr->len -= priv->page_size;
213 }
214 }
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100215 mutex_unlock(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800216
217 /* Inform MTD subsystem that erase is complete */
218 instr->state = MTD_ERASE_DONE;
219 mtd_erase_callback(instr);
220
221 return 0;
222}
223
224/*
225 * Read from the DataFlash device.
226 * from : Start offset in flash device
227 * len : Amount to read
228 * retlen : About of data actually read
229 * buf : Buffer containing the data
230 */
231static int dataflash_read(struct mtd_info *mtd, loff_t from, size_t len,
232 size_t *retlen, u_char *buf)
233{
234 struct dataflash *priv = (struct dataflash *)mtd->priv;
235 struct spi_transfer x[2] = { { .tx_dma = 0, }, };
236 struct spi_message msg;
237 unsigned int addr;
David Woodhouse271c5c52008-06-04 17:43:22 +0100238 uint8_t *command;
David Brownell1d6432f2006-01-08 13:34:22 -0800239 int status;
240
241 DEBUG(MTD_DEBUG_LEVEL2, "%s: read 0x%x..0x%x\n",
242 priv->spi->dev.bus_id, (unsigned)from, (unsigned)(from + len));
243
244 *retlen = 0;
245
246 /* Sanity checks */
247 if (!len)
248 return 0;
249 if (from + len > mtd->size)
250 return -EINVAL;
251
252 /* Calculate flash page/byte address */
253 addr = (((unsigned)from / priv->page_size) << priv->page_offset)
254 + ((unsigned)from % priv->page_size);
255
256 command = priv->command;
257
258 DEBUG(MTD_DEBUG_LEVEL3, "READ: (%x) %x %x %x\n",
259 command[0], command[1], command[2], command[3]);
260
Vitaly Wool8275c642006-01-08 13:34:28 -0800261 spi_message_init(&msg);
262
David Brownell1d6432f2006-01-08 13:34:22 -0800263 x[0].tx_buf = command;
264 x[0].len = 8;
Vitaly Wool8275c642006-01-08 13:34:28 -0800265 spi_message_add_tail(&x[0], &msg);
266
David Brownell1d6432f2006-01-08 13:34:22 -0800267 x[1].rx_buf = buf;
268 x[1].len = len;
Vitaly Wool8275c642006-01-08 13:34:28 -0800269 spi_message_add_tail(&x[1], &msg);
David Brownell1d6432f2006-01-08 13:34:22 -0800270
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100271 mutex_lock(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800272
273 /* Continuous read, max clock = f(car) which may be less than
274 * the peak rate available. Some chips support commands with
275 * fewer "don't care" bytes. Both buffers stay unchanged.
276 */
277 command[0] = OP_READ_CONTINUOUS;
David Woodhouse271c5c52008-06-04 17:43:22 +0100278 command[1] = (uint8_t)(addr >> 16);
279 command[2] = (uint8_t)(addr >> 8);
280 command[3] = (uint8_t)(addr >> 0);
David Brownell1d6432f2006-01-08 13:34:22 -0800281 /* plus 4 "don't care" bytes */
282
283 status = spi_sync(priv->spi, &msg);
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100284 mutex_unlock(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800285
286 if (status >= 0) {
287 *retlen = msg.actual_length - 8;
288 status = 0;
289 } else
290 DEBUG(MTD_DEBUG_LEVEL1, "%s: read %x..%x --> %d\n",
291 priv->spi->dev.bus_id,
292 (unsigned)from, (unsigned)(from + len),
293 status);
294 return status;
295}
296
297/*
298 * Write to the DataFlash device.
299 * to : Start offset in flash device
300 * len : Amount to write
301 * retlen : Amount of data actually written
302 * buf : Buffer containing the data
303 */
304static int dataflash_write(struct mtd_info *mtd, loff_t to, size_t len,
305 size_t * retlen, const u_char * buf)
306{
307 struct dataflash *priv = (struct dataflash *)mtd->priv;
308 struct spi_device *spi = priv->spi;
309 struct spi_transfer x[2] = { { .tx_dma = 0, }, };
310 struct spi_message msg;
311 unsigned int pageaddr, addr, offset, writelen;
312 size_t remaining = len;
313 u_char *writebuf = (u_char *) buf;
314 int status = -EINVAL;
David Woodhouse271c5c52008-06-04 17:43:22 +0100315 uint8_t *command;
David Brownell1d6432f2006-01-08 13:34:22 -0800316
317 DEBUG(MTD_DEBUG_LEVEL2, "%s: write 0x%x..0x%x\n",
318 spi->dev.bus_id, (unsigned)to, (unsigned)(to + len));
319
320 *retlen = 0;
321
322 /* Sanity checks */
323 if (!len)
324 return 0;
325 if ((to + len) > mtd->size)
326 return -EINVAL;
327
Vitaly Wool8275c642006-01-08 13:34:28 -0800328 spi_message_init(&msg);
329
David Brownell1d6432f2006-01-08 13:34:22 -0800330 x[0].tx_buf = command = priv->command;
331 x[0].len = 4;
Vitaly Wool8275c642006-01-08 13:34:28 -0800332 spi_message_add_tail(&x[0], &msg);
David Brownell1d6432f2006-01-08 13:34:22 -0800333
334 pageaddr = ((unsigned)to / priv->page_size);
335 offset = ((unsigned)to % priv->page_size);
336 if (offset + len > priv->page_size)
337 writelen = priv->page_size - offset;
338 else
339 writelen = len;
340
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100341 mutex_lock(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800342 while (remaining > 0) {
343 DEBUG(MTD_DEBUG_LEVEL3, "write @ %i:%i len=%i\n",
344 pageaddr, offset, writelen);
345
346 /* REVISIT:
347 * (a) each page in a sector must be rewritten at least
348 * once every 10K sibling erase/program operations.
349 * (b) for pages that are already erased, we could
350 * use WRITE+MWRITE not PROGRAM for ~30% speedup.
351 * (c) WRITE to buffer could be done while waiting for
352 * a previous MWRITE/MWERASE to complete ...
353 * (d) error handling here seems to be mostly missing.
354 *
355 * Two persistent bits per page, plus a per-sector counter,
356 * could support (a) and (b) ... we might consider using
357 * the second half of sector zero, which is just one block,
358 * to track that state. (On AT91, that sector should also
359 * support boot-from-DataFlash.)
360 */
361
362 addr = pageaddr << priv->page_offset;
363
364 /* (1) Maybe transfer partial page to Buffer1 */
365 if (writelen != priv->page_size) {
366 command[0] = OP_TRANSFER_BUF1;
367 command[1] = (addr & 0x00FF0000) >> 16;
368 command[2] = (addr & 0x0000FF00) >> 8;
369 command[3] = 0;
370
371 DEBUG(MTD_DEBUG_LEVEL3, "TRANSFER: (%x) %x %x %x\n",
372 command[0], command[1], command[2], command[3]);
373
David Brownell1d6432f2006-01-08 13:34:22 -0800374 status = spi_sync(spi, &msg);
375 if (status < 0)
376 DEBUG(MTD_DEBUG_LEVEL1, "%s: xfer %u -> %d \n",
377 spi->dev.bus_id, addr, status);
378
379 (void) dataflash_waitready(priv->spi);
380 }
381
382 /* (2) Program full page via Buffer1 */
383 addr += offset;
384 command[0] = OP_PROGRAM_VIA_BUF1;
385 command[1] = (addr & 0x00FF0000) >> 16;
386 command[2] = (addr & 0x0000FF00) >> 8;
387 command[3] = (addr & 0x000000FF);
388
389 DEBUG(MTD_DEBUG_LEVEL3, "PROGRAM: (%x) %x %x %x\n",
390 command[0], command[1], command[2], command[3]);
391
392 x[1].tx_buf = writebuf;
393 x[1].len = writelen;
Vitaly Wool8275c642006-01-08 13:34:28 -0800394 spi_message_add_tail(x + 1, &msg);
David Brownell1d6432f2006-01-08 13:34:22 -0800395 status = spi_sync(spi, &msg);
Vitaly Wool8275c642006-01-08 13:34:28 -0800396 spi_transfer_del(x + 1);
David Brownell1d6432f2006-01-08 13:34:22 -0800397 if (status < 0)
398 DEBUG(MTD_DEBUG_LEVEL1, "%s: pgm %u/%u -> %d \n",
399 spi->dev.bus_id, addr, writelen, status);
400
401 (void) dataflash_waitready(priv->spi);
402
Vitaly Wool8275c642006-01-08 13:34:28 -0800403
David Brownell8c640382008-08-06 21:55:14 -0700404#ifdef CONFIG_MTD_DATAFLASH_VERIFY_WRITE
David Brownell1d6432f2006-01-08 13:34:22 -0800405
406 /* (3) Compare to Buffer1 */
407 addr = pageaddr << priv->page_offset;
408 command[0] = OP_COMPARE_BUF1;
409 command[1] = (addr & 0x00FF0000) >> 16;
410 command[2] = (addr & 0x0000FF00) >> 8;
411 command[3] = 0;
412
413 DEBUG(MTD_DEBUG_LEVEL3, "COMPARE: (%x) %x %x %x\n",
414 command[0], command[1], command[2], command[3]);
415
David Brownell1d6432f2006-01-08 13:34:22 -0800416 status = spi_sync(spi, &msg);
417 if (status < 0)
418 DEBUG(MTD_DEBUG_LEVEL1, "%s: compare %u -> %d \n",
419 spi->dev.bus_id, addr, status);
420
421 status = dataflash_waitready(priv->spi);
422
423 /* Check result of the compare operation */
Andrew Victorcccb45d2007-11-19 15:37:23 +0200424 if (status & (1 << 6)) {
David Brownell1d6432f2006-01-08 13:34:22 -0800425 printk(KERN_ERR "%s: compare page %u, err %d\n",
426 spi->dev.bus_id, pageaddr, status);
427 remaining = 0;
428 status = -EIO;
429 break;
430 } else
431 status = 0;
432
David Brownell8c640382008-08-06 21:55:14 -0700433#endif /* CONFIG_MTD_DATAFLASH_VERIFY_WRITE */
David Brownell1d6432f2006-01-08 13:34:22 -0800434
435 remaining = remaining - writelen;
436 pageaddr++;
437 offset = 0;
438 writebuf += writelen;
439 *retlen += writelen;
440
441 if (remaining > priv->page_size)
442 writelen = priv->page_size;
443 else
444 writelen = remaining;
445 }
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100446 mutex_unlock(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800447
448 return status;
449}
450
451/* ......................................................................... */
452
David Brownell34a82442008-07-30 12:35:05 -0700453#ifdef CONFIG_MTD_DATAFLASH_OTP
454
455static int dataflash_get_otp_info(struct mtd_info *mtd,
456 struct otp_info *info, size_t len)
457{
458 /* Report both blocks as identical: bytes 0..64, locked.
459 * Unless the user block changed from all-ones, we can't
460 * tell whether it's still writable; so we assume it isn't.
461 */
462 info->start = 0;
463 info->length = 64;
464 info->locked = 1;
465 return sizeof(*info);
466}
467
468static ssize_t otp_read(struct spi_device *spi, unsigned base,
469 uint8_t *buf, loff_t off, size_t len)
470{
471 struct spi_message m;
472 size_t l;
473 uint8_t *scratch;
474 struct spi_transfer t;
475 int status;
476
477 if (off > 64)
478 return -EINVAL;
479
480 if ((off + len) > 64)
481 len = 64 - off;
482 if (len == 0)
483 return len;
484
485 spi_message_init(&m);
486
487 l = 4 + base + off + len;
488 scratch = kzalloc(l, GFP_KERNEL);
489 if (!scratch)
490 return -ENOMEM;
491
492 /* OUT: OP_READ_SECURITY, 3 don't-care bytes, zeroes
493 * IN: ignore 4 bytes, data bytes 0..N (max 127)
494 */
495 scratch[0] = OP_READ_SECURITY;
496
497 memset(&t, 0, sizeof t);
498 t.tx_buf = scratch;
499 t.rx_buf = scratch;
500 t.len = l;
501 spi_message_add_tail(&t, &m);
502
503 dataflash_waitready(spi);
504
505 status = spi_sync(spi, &m);
506 if (status >= 0) {
507 memcpy(buf, scratch + 4 + base + off, len);
508 status = len;
509 }
510
511 kfree(scratch);
512 return status;
513}
514
515static int dataflash_read_fact_otp(struct mtd_info *mtd,
516 loff_t from, size_t len, size_t *retlen, u_char *buf)
517{
518 struct dataflash *priv = (struct dataflash *)mtd->priv;
519 int status;
520
521 /* 64 bytes, from 0..63 ... start at 64 on-chip */
522 mutex_lock(&priv->lock);
523 status = otp_read(priv->spi, 64, buf, from, len);
524 mutex_unlock(&priv->lock);
525
526 if (status < 0)
527 return status;
528 *retlen = status;
529 return 0;
530}
531
532static int dataflash_read_user_otp(struct mtd_info *mtd,
533 loff_t from, size_t len, size_t *retlen, u_char *buf)
534{
535 struct dataflash *priv = (struct dataflash *)mtd->priv;
536 int status;
537
538 /* 64 bytes, from 0..63 ... start at 0 on-chip */
539 mutex_lock(&priv->lock);
540 status = otp_read(priv->spi, 0, buf, from, len);
541 mutex_unlock(&priv->lock);
542
543 if (status < 0)
544 return status;
545 *retlen = status;
546 return 0;
547}
548
549static int dataflash_write_user_otp(struct mtd_info *mtd,
550 loff_t from, size_t len, size_t *retlen, u_char *buf)
551{
552 struct spi_message m;
553 const size_t l = 4 + 64;
554 uint8_t *scratch;
555 struct spi_transfer t;
556 struct dataflash *priv = (struct dataflash *)mtd->priv;
557 int status;
558
559 if (len > 64)
560 return -EINVAL;
561
562 /* Strictly speaking, we *could* truncate the write ... but
563 * let's not do that for the only write that's ever possible.
564 */
565 if ((from + len) > 64)
566 return -EINVAL;
567
568 /* OUT: OP_WRITE_SECURITY, 3 zeroes, 64 data-or-zero bytes
569 * IN: ignore all
570 */
571 scratch = kzalloc(l, GFP_KERNEL);
572 if (!scratch)
573 return -ENOMEM;
574 scratch[0] = OP_WRITE_SECURITY;
575 memcpy(scratch + 4 + from, buf, len);
576
577 spi_message_init(&m);
578
579 memset(&t, 0, sizeof t);
580 t.tx_buf = scratch;
581 t.len = l;
582 spi_message_add_tail(&t, &m);
583
584 /* Write the OTP bits, if they've not yet been written.
585 * This modifies SRAM buffer1.
586 */
587 mutex_lock(&priv->lock);
588 dataflash_waitready(priv->spi);
589 status = spi_sync(priv->spi, &m);
590 mutex_unlock(&priv->lock);
591
592 kfree(scratch);
593
594 if (status >= 0) {
595 status = 0;
596 *retlen = len;
597 }
598 return status;
599}
600
601static char *otp_setup(struct mtd_info *device, char revision)
602{
603 device->get_fact_prot_info = dataflash_get_otp_info;
604 device->read_fact_prot_reg = dataflash_read_fact_otp;
605 device->get_user_prot_info = dataflash_get_otp_info;
606 device->read_user_prot_reg = dataflash_read_user_otp;
607
608 /* rev c parts (at45db321c and at45db1281 only!) use a
609 * different write procedure; not (yet?) implemented.
610 */
611 if (revision > 'c')
612 device->write_user_prot_reg = dataflash_write_user_otp;
613
614 return ", OTP";
615}
616
617#else
618
David Brownellcf93ae02008-08-06 13:12:04 -0700619static char *otp_setup(struct mtd_info *device, char revision)
David Brownell34a82442008-07-30 12:35:05 -0700620{
621 return " (OTP)";
622}
623
624#endif
625
626/* ......................................................................... */
627
David Brownell1d6432f2006-01-08 13:34:22 -0800628/*
629 * Register DataFlash device with MTD subsystem.
630 */
631static int __devinit
David Brownell34a82442008-07-30 12:35:05 -0700632add_dataflash_otp(struct spi_device *spi, char *name,
633 int nr_pages, int pagesize, int pageoffset, char revision)
David Brownell1d6432f2006-01-08 13:34:22 -0800634{
635 struct dataflash *priv;
636 struct mtd_info *device;
637 struct flash_platform_data *pdata = spi->dev.platform_data;
David Brownell34a82442008-07-30 12:35:05 -0700638 char *otp_tag = "";
David Brownell1d6432f2006-01-08 13:34:22 -0800639
Robert P. J. Day5cbded52006-12-13 00:35:56 -0800640 priv = kzalloc(sizeof *priv, GFP_KERNEL);
David Brownell1d6432f2006-01-08 13:34:22 -0800641 if (!priv)
642 return -ENOMEM;
643
Matthias Kaehlckeec9ce522007-06-28 22:58:42 +0100644 mutex_init(&priv->lock);
David Brownell1d6432f2006-01-08 13:34:22 -0800645 priv->spi = spi;
646 priv->page_size = pagesize;
647 priv->page_offset = pageoffset;
648
649 /* name must be usable with cmdlinepart */
650 sprintf(priv->name, "spi%d.%d-%s",
651 spi->master->bus_num, spi->chip_select,
652 name);
653
654 device = &priv->mtd;
655 device->name = (pdata && pdata->name) ? pdata->name : priv->name;
656 device->size = nr_pages * pagesize;
657 device->erasesize = pagesize;
Artem B. Bityutskiy17ffc7b2006-06-22 18:15:48 +0400658 device->writesize = pagesize;
David Brownell1d6432f2006-01-08 13:34:22 -0800659 device->owner = THIS_MODULE;
660 device->type = MTD_DATAFLASH;
Haavard Skinnemoen6c33caf2006-11-29 14:26:07 +0100661 device->flags = MTD_WRITEABLE;
David Brownell1d6432f2006-01-08 13:34:22 -0800662 device->erase = dataflash_erase;
663 device->read = dataflash_read;
664 device->write = dataflash_write;
665 device->priv = priv;
666
David Brownell34a82442008-07-30 12:35:05 -0700667 if (revision >= 'c')
668 otp_tag = otp_setup(device, revision);
669
670 dev_info(&spi->dev, "%s (%d KBytes) pagesize %d bytes%s\n",
671 name, DIV_ROUND_UP(device->size, 1024),
672 pagesize, otp_tag);
David Brownell1d6432f2006-01-08 13:34:22 -0800673 dev_set_drvdata(&spi->dev, priv);
674
675 if (mtd_has_partitions()) {
676 struct mtd_partition *parts;
677 int nr_parts = 0;
678
679#ifdef CONFIG_MTD_CMDLINE_PARTS
680 static const char *part_probes[] = { "cmdlinepart", NULL, };
681
682 nr_parts = parse_mtd_partitions(device, part_probes, &parts, 0);
683#endif
684
685 if (nr_parts <= 0 && pdata && pdata->parts) {
686 parts = pdata->parts;
687 nr_parts = pdata->nr_parts;
688 }
689
690 if (nr_parts > 0) {
691 priv->partitioned = 1;
692 return add_mtd_partitions(device, parts, nr_parts);
693 }
David Brownell71117632006-01-08 13:34:29 -0800694 } else if (pdata && pdata->nr_parts)
David Brownell1d6432f2006-01-08 13:34:22 -0800695 dev_warn(&spi->dev, "ignoring %d default partitions on %s\n",
696 pdata->nr_parts, device->name);
697
698 return add_mtd_device(device) == 1 ? -ENODEV : 0;
699}
700
David Brownell34a82442008-07-30 12:35:05 -0700701static inline int __devinit
702add_dataflash(struct spi_device *spi, char *name,
703 int nr_pages, int pagesize, int pageoffset)
704{
705 return add_dataflash_otp(spi, name, nr_pages, pagesize,
706 pageoffset, 0);
707}
708
Michael Henneriche9d42222008-06-03 12:26:05 +0800709struct flash_info {
710 char *name;
711
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700712 /* JEDEC id has a high byte of zero plus three data bytes:
713 * the manufacturer id, then a two byte device id.
Michael Henneriche9d42222008-06-03 12:26:05 +0800714 */
David Woodhouse271c5c52008-06-04 17:43:22 +0100715 uint32_t jedec_id;
Michael Henneriche9d42222008-06-03 12:26:05 +0800716
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700717 /* The size listed here is what works with OP_ERASE_PAGE. */
Michael Henneriche9d42222008-06-03 12:26:05 +0800718 unsigned nr_pages;
David Woodhouse271c5c52008-06-04 17:43:22 +0100719 uint16_t pagesize;
720 uint16_t pageoffset;
Michael Henneriche9d42222008-06-03 12:26:05 +0800721
David Woodhouse271c5c52008-06-04 17:43:22 +0100722 uint16_t flags;
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700723#define SUP_POW2PS 0x0002 /* supports 2^N byte pages */
724#define IS_POW2PS 0x0001 /* uses 2^N byte pages */
Michael Henneriche9d42222008-06-03 12:26:05 +0800725};
726
727static struct flash_info __devinitdata dataflash_data [] = {
728
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700729 /*
730 * NOTE: chips with SUP_POW2PS (rev D and up) need two entries,
731 * one with IS_POW2PS and the other without. The entry with the
732 * non-2^N byte page size can't name exact chip revisions without
733 * losing backwards compatibility for cmdlinepart.
734 *
735 * These newer chips also support 128-byte security registers (with
736 * 64 bytes one-time-programmable) and software write-protection.
737 */
738 { "AT45DB011B", 0x1f2200, 512, 264, 9, SUP_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800739 { "at45db011d", 0x1f2200, 512, 256, 8, SUP_POW2PS | IS_POW2PS},
740
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700741 { "AT45DB021B", 0x1f2300, 1024, 264, 9, SUP_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800742 { "at45db021d", 0x1f2300, 1024, 256, 8, SUP_POW2PS | IS_POW2PS},
743
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700744 { "AT45DB041x", 0x1f2400, 2048, 264, 9, SUP_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800745 { "at45db041d", 0x1f2400, 2048, 256, 8, SUP_POW2PS | IS_POW2PS},
746
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700747 { "AT45DB081B", 0x1f2500, 4096, 264, 9, SUP_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800748 { "at45db081d", 0x1f2500, 4096, 256, 8, SUP_POW2PS | IS_POW2PS},
749
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700750 { "AT45DB161x", 0x1f2600, 4096, 528, 10, SUP_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800751 { "at45db161d", 0x1f2600, 4096, 512, 9, SUP_POW2PS | IS_POW2PS},
752
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700753 { "AT45DB321x", 0x1f2700, 8192, 528, 10, 0}, /* rev C */
Michael Henneriche9d42222008-06-03 12:26:05 +0800754
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700755 { "AT45DB321x", 0x1f2701, 8192, 528, 10, SUP_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800756 { "at45db321d", 0x1f2701, 8192, 512, 9, SUP_POW2PS | IS_POW2PS},
757
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700758 { "AT45DB642x", 0x1f2800, 8192, 1056, 11, SUP_POW2PS},
759 { "at45db642d", 0x1f2800, 8192, 1024, 10, SUP_POW2PS | IS_POW2PS},
Michael Henneriche9d42222008-06-03 12:26:05 +0800760};
761
762static struct flash_info *__devinit jedec_probe(struct spi_device *spi)
763{
764 int tmp;
David Woodhouse271c5c52008-06-04 17:43:22 +0100765 uint8_t code = OP_READ_ID;
766 uint8_t id[3];
767 uint32_t jedec;
Michael Henneriche9d42222008-06-03 12:26:05 +0800768 struct flash_info *info;
769 int status;
770
Michael Henneriche9d42222008-06-03 12:26:05 +0800771 /* JEDEC also defines an optional "extended device information"
772 * string for after vendor-specific data, after the three bytes
773 * we use here. Supporting some chips might require using it.
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700774 *
775 * If the vendor ID isn't Atmel's (0x1f), assume this call failed.
776 * That's not an error; only rev C and newer chips handle it, and
777 * only Atmel sells these chips.
Michael Henneriche9d42222008-06-03 12:26:05 +0800778 */
779 tmp = spi_write_then_read(spi, &code, 1, id, 3);
780 if (tmp < 0) {
781 DEBUG(MTD_DEBUG_LEVEL0, "%s: error %d reading JEDEC ID\n",
782 spi->dev.bus_id, tmp);
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700783 return ERR_PTR(tmp);
Michael Henneriche9d42222008-06-03 12:26:05 +0800784 }
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700785 if (id[0] != 0x1f)
786 return NULL;
787
Michael Henneriche9d42222008-06-03 12:26:05 +0800788 jedec = id[0];
789 jedec = jedec << 8;
790 jedec |= id[1];
791 jedec = jedec << 8;
792 jedec |= id[2];
793
794 for (tmp = 0, info = dataflash_data;
795 tmp < ARRAY_SIZE(dataflash_data);
796 tmp++, info++) {
797 if (info->jedec_id == jedec) {
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700798 DEBUG(MTD_DEBUG_LEVEL1, "%s: OTP, sector protect%s\n",
799 dev_name(&spi->dev),
800 (info->flags & SUP_POW2PS)
801 ? ", binary pagesize" : ""
802 );
Michael Henneriche9d42222008-06-03 12:26:05 +0800803 if (info->flags & SUP_POW2PS) {
804 status = dataflash_status(spi);
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700805 if (status < 0) {
806 DEBUG(MTD_DEBUG_LEVEL1,
807 "%s: status error %d\n",
808 dev_name(&spi->dev), status);
809 return ERR_PTR(status);
810 }
811 if (status & 0x1) {
812 if (info->flags & IS_POW2PS)
813 return info;
814 } else {
815 if (!(info->flags & IS_POW2PS))
816 return info;
817 }
Michael Henneriche9d42222008-06-03 12:26:05 +0800818 }
819 }
820 }
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700821
822 /*
823 * Treat other chips as errors ... we won't know the right page
824 * size (it might be binary) even when we can tell which density
825 * class is involved (legacy chip id scheme).
826 */
827 dev_warn(&spi->dev, "JEDEC id %06x not handled\n", jedec);
828 return ERR_PTR(-ENODEV);
Michael Henneriche9d42222008-06-03 12:26:05 +0800829}
830
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700831/*
832 * Detect and initialize DataFlash device, using JEDEC IDs on newer chips
833 * or else the ID code embedded in the status bits:
834 *
835 * Device Density ID code #Pages PageSize Offset
836 * AT45DB011B 1Mbit (128K) xx0011xx (0x0c) 512 264 9
837 * AT45DB021B 2Mbit (256K) xx0101xx (0x14) 1024 264 9
838 * AT45DB041B 4Mbit (512K) xx0111xx (0x1c) 2048 264 9
839 * AT45DB081B 8Mbit (1M) xx1001xx (0x24) 4096 264 9
840 * AT45DB0161B 16Mbit (2M) xx1011xx (0x2c) 4096 528 10
841 * AT45DB0321B 32Mbit (4M) xx1101xx (0x34) 8192 528 10
842 * AT45DB0642 64Mbit (8M) xx111xxx (0x3c) 8192 1056 11
843 * AT45DB1282 128Mbit (16M) xx0100xx (0x10) 16384 1056 11
844 */
David Brownell1d6432f2006-01-08 13:34:22 -0800845static int __devinit dataflash_probe(struct spi_device *spi)
846{
847 int status;
Michael Henneriche9d42222008-06-03 12:26:05 +0800848 struct flash_info *info;
849
850 /*
851 * Try to detect dataflash by JEDEC ID.
852 * If it succeeds we know we have either a C or D part.
853 * D will support power of 2 pagesize option.
David Brownell34a82442008-07-30 12:35:05 -0700854 * Both support the security register, though with different
855 * write procedures.
Michael Henneriche9d42222008-06-03 12:26:05 +0800856 */
Michael Henneriche9d42222008-06-03 12:26:05 +0800857 info = jedec_probe(spi);
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700858 if (IS_ERR(info))
859 return PTR_ERR(info);
Michael Henneriche9d42222008-06-03 12:26:05 +0800860 if (info != NULL)
David Brownell34a82442008-07-30 12:35:05 -0700861 return add_dataflash_otp(spi, info->name, info->nr_pages,
862 info->pagesize, info->pageoffset,
863 (info->flags & SUP_POW2PS) ? 'd' : 'c');
Michael Henneriche9d42222008-06-03 12:26:05 +0800864
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700865 /*
866 * Older chips support only legacy commands, identifing
867 * capacity using bits in the status byte.
868 */
David Brownell1d6432f2006-01-08 13:34:22 -0800869 status = dataflash_status(spi);
870 if (status <= 0 || status == 0xff) {
871 DEBUG(MTD_DEBUG_LEVEL1, "%s: status error %d\n",
872 spi->dev.bus_id, status);
David Brownellde4fa99262006-12-29 16:48:47 -0800873 if (status == 0 || status == 0xff)
David Brownell1d6432f2006-01-08 13:34:22 -0800874 status = -ENODEV;
875 return status;
876 }
877
878 /* if there's a device there, assume it's dataflash.
879 * board setup should have set spi->max_speed_max to
880 * match f(car) for continuous reads, mode 0 or 3.
881 */
882 switch (status & 0x3c) {
883 case 0x0c: /* 0 0 1 1 x x */
884 status = add_dataflash(spi, "AT45DB011B", 512, 264, 9);
885 break;
886 case 0x14: /* 0 1 0 1 x x */
Michael Henneriche9d42222008-06-03 12:26:05 +0800887 status = add_dataflash(spi, "AT45DB021B", 1024, 264, 9);
David Brownell1d6432f2006-01-08 13:34:22 -0800888 break;
889 case 0x1c: /* 0 1 1 1 x x */
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700890 status = add_dataflash(spi, "AT45DB041x", 2048, 264, 9);
David Brownell1d6432f2006-01-08 13:34:22 -0800891 break;
892 case 0x24: /* 1 0 0 1 x x */
893 status = add_dataflash(spi, "AT45DB081B", 4096, 264, 9);
894 break;
895 case 0x2c: /* 1 0 1 1 x x */
akpm@linux-foundation.org771999b2008-07-29 22:22:40 -0700896 status = add_dataflash(spi, "AT45DB161x", 4096, 528, 10);
David Brownell1d6432f2006-01-08 13:34:22 -0800897 break;
898 case 0x34: /* 1 1 0 1 x x */
899 status = add_dataflash(spi, "AT45DB321x", 8192, 528, 10);
900 break;
901 case 0x38: /* 1 1 1 x x x */
902 case 0x3c:
903 status = add_dataflash(spi, "AT45DB642x", 8192, 1056, 11);
904 break;
905 /* obsolete AT45DB1282 not (yet?) supported */
906 default:
907 DEBUG(MTD_DEBUG_LEVEL1, "%s: unsupported device (%x)\n",
908 spi->dev.bus_id, status & 0x3c);
909 status = -ENODEV;
910 }
911
912 if (status < 0)
913 DEBUG(MTD_DEBUG_LEVEL1, "%s: add_dataflash --> %d\n",
914 spi->dev.bus_id, status);
915
916 return status;
917}
918
919static int __devexit dataflash_remove(struct spi_device *spi)
920{
921 struct dataflash *flash = dev_get_drvdata(&spi->dev);
922 int status;
923
924 DEBUG(MTD_DEBUG_LEVEL1, "%s: remove\n", spi->dev.bus_id);
925
926 if (mtd_has_partitions() && flash->partitioned)
927 status = del_mtd_partitions(&flash->mtd);
928 else
929 status = del_mtd_device(&flash->mtd);
930 if (status == 0)
931 kfree(flash);
932 return status;
933}
934
935static struct spi_driver dataflash_driver = {
936 .driver = {
937 .name = "mtd_dataflash",
938 .bus = &spi_bus_type,
939 .owner = THIS_MODULE,
940 },
941
942 .probe = dataflash_probe,
943 .remove = __devexit_p(dataflash_remove),
944
945 /* FIXME: investigate suspend and resume... */
946};
947
948static int __init dataflash_init(void)
949{
950 return spi_register_driver(&dataflash_driver);
951}
952module_init(dataflash_init);
953
954static void __exit dataflash_exit(void)
955{
956 spi_unregister_driver(&dataflash_driver);
957}
958module_exit(dataflash_exit);
959
960
961MODULE_LICENSE("GPL");
962MODULE_AUTHOR("Andrew Victor, David Brownell");
963MODULE_DESCRIPTION("MTD DataFlash driver");