mtd_dataflash.c 24.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * Atmel AT45xxx DataFlash MTD driver for lightweight SPI framework
 *
 * Largely derived from at91_dataflash.c:
 *  Copyright (C) 2003-2005 SAN People (Pty) Ltd
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
*/
#include <linux/module.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/delay.h>
#include <linux/device.h>
17
#include <linux/mutex.h>
18
#include <linux/err.h>
19
#include <linux/math64.h>
20 21
#include <linux/of.h>
#include <linux/of_device.h>
22

23 24 25 26 27 28 29 30 31 32 33 34
#include <linux/spi/spi.h>
#include <linux/spi/flash.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/partitions.h>

/*
 * DataFlash is a kind of SPI flash.  Most AT45 chips have two buffers in
 * each chip, which may be used for double buffered I/O; but this driver
 * doesn't (yet) use these for any kind of i/o overlap or prefetching.
 *
 * Sometimes DataFlash is packaged in MMC-format cards, although the
35
 * MMC stack can't (yet?) distinguish between MMC and DataFlash
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
 * protocols during enumeration.
 */

/* reads can bypass the buffers */
#define OP_READ_CONTINUOUS	0xE8
#define OP_READ_PAGE		0xD2

/* group B requests can run even while status reports "busy" */
#define OP_READ_STATUS		0xD7	/* group B */

/* move data between host and buffer */
#define OP_READ_BUFFER1		0xD4	/* group B */
#define OP_READ_BUFFER2		0xD6	/* group B */
#define OP_WRITE_BUFFER1	0x84	/* group B */
#define OP_WRITE_BUFFER2	0x87	/* group B */

/* erasing flash */
#define OP_ERASE_PAGE		0x81
#define OP_ERASE_BLOCK		0x50

/* move data between buffer and flash */
#define OP_TRANSFER_BUF1	0x53
#define OP_TRANSFER_BUF2	0x55
#define OP_MREAD_BUFFER1	0xD4
#define OP_MREAD_BUFFER2	0xD6
#define OP_MWERASE_BUFFER1	0x83
#define OP_MWERASE_BUFFER2	0x86
#define OP_MWRITE_BUFFER1	0x88	/* sector must be pre-erased */
#define OP_MWRITE_BUFFER2	0x89	/* sector must be pre-erased */

/* write to buffer, then write-erase to flash */
#define OP_PROGRAM_VIA_BUF1	0x82
#define OP_PROGRAM_VIA_BUF2	0x85

/* compare buffer to flash */
#define OP_COMPARE_BUF1		0x60
#define OP_COMPARE_BUF2		0x61

/* read flash to buffer, then write-erase to flash */
#define OP_REWRITE_VIA_BUF1	0x58
#define OP_REWRITE_VIA_BUF2	0x59

/* newer chips report JEDEC manufacturer and device IDs; chip
 * serial number and OTP bits; and per-sector writeprotect.
 */
#define OP_READ_ID		0x9F
#define OP_READ_SECURITY	0x77
D
David Brownell 已提交
83 84
#define OP_WRITE_SECURITY_REVC	0x9A
#define OP_WRITE_SECURITY	0x9B	/* revision D */
85 86 87


struct dataflash {
88
	uint8_t			command[4];
89 90 91 92 93
	char			name[24];

	unsigned short		page_offset;	/* offset in flash address */
	unsigned int		page_size;	/* of bytes per page */

94
	struct mutex		lock;
95 96 97 98 99
	struct spi_device	*spi;

	struct mtd_info		mtd;
};

100 101 102 103 104 105 106 107
#ifdef CONFIG_OF
static const struct of_device_id dataflash_dt_ids[] = {
	{ .compatible = "atmel,at45", },
	{ .compatible = "atmel,dataflash", },
	{ /* sentinel */ }
};
#endif

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
/* ......................................................................... */

/*
 * Return the status of the DataFlash device.
 */
static inline int dataflash_status(struct spi_device *spi)
{
	/* NOTE:  at45db321c over 25 MHz wants to write
	 * a dummy byte after the opcode...
	 */
	return spi_w8r8(spi, OP_READ_STATUS);
}

/*
 * Poll the DataFlash device until it is READY.
 * This usually takes 5-20 msec or so; more for sector erase.
 */
static int dataflash_waitready(struct spi_device *spi)
{
	int	status;

	for (;;) {
		status = dataflash_status(spi);
		if (status < 0) {
132
			pr_debug("%s: status %d?\n",
133
					dev_name(&spi->dev), status);
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
			status = 0;
		}

		if (status & (1 << 7))	/* RDY/nBSY */
			return status;

		msleep(3);
	}
}

/* ......................................................................... */

/*
 * Erase pages of flash.
 */
static int dataflash_erase(struct mtd_info *mtd, struct erase_info *instr)
{
151
	struct dataflash	*priv = mtd->priv;
152
	struct spi_device	*spi = priv->spi;
153
	struct spi_transfer	x = { .tx_dma = 0, };
154 155
	struct spi_message	msg;
	unsigned		blocksize = priv->page_size << 3;
156
	uint8_t			*command;
157
	uint32_t		rem;
158

159
	pr_debug("%s: erase addr=0x%llx len 0x%llx\n",
160 161
	      dev_name(&spi->dev), (long long)instr->addr,
	      (long long)instr->len);
162

163 164 165 166 167
	div_u64_rem(instr->len, priv->page_size, &rem);
	if (rem)
		return -EINVAL;
	div_u64_rem(instr->addr, priv->page_size, &rem);
	if (rem)
168 169
		return -EINVAL;

170 171 172 173 174
	spi_message_init(&msg);

	x.tx_buf = command = priv->command;
	x.len = 4;
	spi_message_add_tail(&x, &msg);
175

176
	mutex_lock(&priv->lock);
177 178 179 180 181 182 183 184
	while (instr->len > 0) {
		unsigned int	pageaddr;
		int		status;
		int		do_block;

		/* Calculate flash page address; use block erase (for speed) if
		 * we're at a block boundary and need to erase the whole block.
		 */
185
		pageaddr = div_u64(instr->addr, priv->page_size);
186
		do_block = (pageaddr & 0x7) == 0 && instr->len >= blocksize;
187 188 189
		pageaddr = pageaddr << priv->page_offset;

		command[0] = do_block ? OP_ERASE_BLOCK : OP_ERASE_PAGE;
190 191
		command[1] = (uint8_t)(pageaddr >> 16);
		command[2] = (uint8_t)(pageaddr >> 8);
192 193
		command[3] = 0;

194
		pr_debug("ERASE %s: (%x) %x %x %x [%i]\n",
195 196 197 198 199 200 201 202 203
			do_block ? "block" : "page",
			command[0], command[1], command[2], command[3],
			pageaddr);

		status = spi_sync(spi, &msg);
		(void) dataflash_waitready(spi);

		if (status < 0) {
			printk(KERN_ERR "%s: erase %x, err %d\n",
204
				dev_name(&spi->dev), pageaddr, status);
205 206 207 208 209 210 211 212 213 214 215 216 217 218
			/* REVISIT:  can retry instr->retries times; or
			 * giveup and instr->fail_addr = instr->addr;
			 */
			continue;
		}

		if (do_block) {
			instr->addr += blocksize;
			instr->len -= blocksize;
		} else {
			instr->addr += priv->page_size;
			instr->len -= priv->page_size;
		}
	}
219
	mutex_unlock(&priv->lock);
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

	/* Inform MTD subsystem that erase is complete */
	instr->state = MTD_ERASE_DONE;
	mtd_erase_callback(instr);

	return 0;
}

/*
 * Read from the DataFlash device.
 *   from   : Start offset in flash device
 *   len    : Amount to read
 *   retlen : About of data actually read
 *   buf    : Buffer containing the data
 */
static int dataflash_read(struct mtd_info *mtd, loff_t from, size_t len,
			       size_t *retlen, u_char *buf)
{
238
	struct dataflash	*priv = mtd->priv;
239 240 241
	struct spi_transfer	x[2] = { { .tx_dma = 0, }, };
	struct spi_message	msg;
	unsigned int		addr;
242
	uint8_t			*command;
243 244
	int			status;

245 246
	pr_debug("%s: read 0x%x..0x%x\n", dev_name(&priv->spi->dev),
			(unsigned)from, (unsigned)(from + len));
247 248 249 250 251 252 253

	/* Calculate flash page/byte address */
	addr = (((unsigned)from / priv->page_size) << priv->page_offset)
		+ ((unsigned)from % priv->page_size);

	command = priv->command;

254
	pr_debug("READ: (%x) %x %x %x\n",
255 256
		command[0], command[1], command[2], command[3]);

257 258
	spi_message_init(&msg);

259 260
	x[0].tx_buf = command;
	x[0].len = 8;
261 262
	spi_message_add_tail(&x[0], &msg);

263 264
	x[1].rx_buf = buf;
	x[1].len = len;
265
	spi_message_add_tail(&x[1], &msg);
266

267
	mutex_lock(&priv->lock);
268 269 270 271 272 273

	/* Continuous read, max clock = f(car) which may be less than
	 * the peak rate available.  Some chips support commands with
	 * fewer "don't care" bytes.  Both buffers stay unchanged.
	 */
	command[0] = OP_READ_CONTINUOUS;
274 275 276
	command[1] = (uint8_t)(addr >> 16);
	command[2] = (uint8_t)(addr >> 8);
	command[3] = (uint8_t)(addr >> 0);
277 278 279
	/* plus 4 "don't care" bytes */

	status = spi_sync(priv->spi, &msg);
280
	mutex_unlock(&priv->lock);
281 282 283 284 285

	if (status >= 0) {
		*retlen = msg.actual_length - 8;
		status = 0;
	} else
286
		pr_debug("%s: read %x..%x --> %d\n",
287
			dev_name(&priv->spi->dev),
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
			(unsigned)from, (unsigned)(from + len),
			status);
	return status;
}

/*
 * Write to the DataFlash device.
 *   to     : Start offset in flash device
 *   len    : Amount to write
 *   retlen : Amount of data actually written
 *   buf    : Buffer containing the data
 */
static int dataflash_write(struct mtd_info *mtd, loff_t to, size_t len,
				size_t * retlen, const u_char * buf)
{
303
	struct dataflash	*priv = mtd->priv;
304 305 306 307 308 309 310
	struct spi_device	*spi = priv->spi;
	struct spi_transfer	x[2] = { { .tx_dma = 0, }, };
	struct spi_message	msg;
	unsigned int		pageaddr, addr, offset, writelen;
	size_t			remaining = len;
	u_char			*writebuf = (u_char *) buf;
	int			status = -EINVAL;
311
	uint8_t			*command;
312

313
	pr_debug("%s: write 0x%x..0x%x\n",
314
		dev_name(&spi->dev), (unsigned)to, (unsigned)(to + len));
315

316 317
	spi_message_init(&msg);

318 319
	x[0].tx_buf = command = priv->command;
	x[0].len = 4;
320
	spi_message_add_tail(&x[0], &msg);
321 322 323 324 325 326 327 328

	pageaddr = ((unsigned)to / priv->page_size);
	offset = ((unsigned)to % priv->page_size);
	if (offset + len > priv->page_size)
		writelen = priv->page_size - offset;
	else
		writelen = len;

329
	mutex_lock(&priv->lock);
330
	while (remaining > 0) {
331
		pr_debug("write @ %i:%i len=%i\n",
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
			pageaddr, offset, writelen);

		/* REVISIT:
		 * (a) each page in a sector must be rewritten at least
		 *     once every 10K sibling erase/program operations.
		 * (b) for pages that are already erased, we could
		 *     use WRITE+MWRITE not PROGRAM for ~30% speedup.
		 * (c) WRITE to buffer could be done while waiting for
		 *     a previous MWRITE/MWERASE to complete ...
		 * (d) error handling here seems to be mostly missing.
		 *
		 * Two persistent bits per page, plus a per-sector counter,
		 * could support (a) and (b) ... we might consider using
		 * the second half of sector zero, which is just one block,
		 * to track that state.  (On AT91, that sector should also
		 * support boot-from-DataFlash.)
		 */

		addr = pageaddr << priv->page_offset;

		/* (1) Maybe transfer partial page to Buffer1 */
		if (writelen != priv->page_size) {
			command[0] = OP_TRANSFER_BUF1;
			command[1] = (addr & 0x00FF0000) >> 16;
			command[2] = (addr & 0x0000FF00) >> 8;
			command[3] = 0;

359
			pr_debug("TRANSFER: (%x) %x %x %x\n",
360 361 362 363
				command[0], command[1], command[2], command[3]);

			status = spi_sync(spi, &msg);
			if (status < 0)
364
				pr_debug("%s: xfer %u -> %d\n",
365
					dev_name(&spi->dev), addr, status);
366 367 368 369 370 371 372 373 374 375 376

			(void) dataflash_waitready(priv->spi);
		}

		/* (2) Program full page via Buffer1 */
		addr += offset;
		command[0] = OP_PROGRAM_VIA_BUF1;
		command[1] = (addr & 0x00FF0000) >> 16;
		command[2] = (addr & 0x0000FF00) >> 8;
		command[3] = (addr & 0x000000FF);

377
		pr_debug("PROGRAM: (%x) %x %x %x\n",
378 379 380 381
			command[0], command[1], command[2], command[3]);

		x[1].tx_buf = writebuf;
		x[1].len = writelen;
382
		spi_message_add_tail(x + 1, &msg);
383
		status = spi_sync(spi, &msg);
384
		spi_transfer_del(x + 1);
385
		if (status < 0)
386
			pr_debug("%s: pgm %u/%u -> %d\n",
387
				dev_name(&spi->dev), addr, writelen, status);
388 389 390

		(void) dataflash_waitready(priv->spi);

391

392
#ifdef CONFIG_MTD_DATAFLASH_WRITE_VERIFY
393 394 395 396 397 398 399 400

		/* (3) Compare to Buffer1 */
		addr = pageaddr << priv->page_offset;
		command[0] = OP_COMPARE_BUF1;
		command[1] = (addr & 0x00FF0000) >> 16;
		command[2] = (addr & 0x0000FF00) >> 8;
		command[3] = 0;

401
		pr_debug("COMPARE: (%x) %x %x %x\n",
402 403 404 405
			command[0], command[1], command[2], command[3]);

		status = spi_sync(spi, &msg);
		if (status < 0)
406
			pr_debug("%s: compare %u -> %d\n",
407
				dev_name(&spi->dev), addr, status);
408 409 410 411

		status = dataflash_waitready(priv->spi);

		/* Check result of the compare operation */
412
		if (status & (1 << 6)) {
413
			printk(KERN_ERR "%s: compare page %u, err %d\n",
414
				dev_name(&spi->dev), pageaddr, status);
415 416 417 418 419 420
			remaining = 0;
			status = -EIO;
			break;
		} else
			status = 0;

421
#endif	/* CONFIG_MTD_DATAFLASH_WRITE_VERIFY */
422 423 424 425 426 427 428 429 430 431 432 433

		remaining = remaining - writelen;
		pageaddr++;
		offset = 0;
		writebuf += writelen;
		*retlen += writelen;

		if (remaining > priv->page_size)
			writelen = priv->page_size;
		else
			writelen = remaining;
	}
434
	mutex_unlock(&priv->lock);
435 436 437 438 439 440

	return status;
}

/* ......................................................................... */

D
David Brownell 已提交
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
#ifdef CONFIG_MTD_DATAFLASH_OTP

static int dataflash_get_otp_info(struct mtd_info *mtd,
		struct otp_info *info, size_t len)
{
	/* Report both blocks as identical:  bytes 0..64, locked.
	 * Unless the user block changed from all-ones, we can't
	 * tell whether it's still writable; so we assume it isn't.
	 */
	info->start = 0;
	info->length = 64;
	info->locked = 1;
	return sizeof(*info);
}

static ssize_t otp_read(struct spi_device *spi, unsigned base,
		uint8_t *buf, loff_t off, size_t len)
{
	struct spi_message	m;
	size_t			l;
	uint8_t			*scratch;
	struct spi_transfer	t;
	int			status;

	if (off > 64)
		return -EINVAL;

	if ((off + len) > 64)
		len = 64 - off;

	spi_message_init(&m);

	l = 4 + base + off + len;
	scratch = kzalloc(l, GFP_KERNEL);
	if (!scratch)
		return -ENOMEM;

	/* OUT: OP_READ_SECURITY, 3 don't-care bytes, zeroes
	 * IN:  ignore 4 bytes, data bytes 0..N (max 127)
	 */
	scratch[0] = OP_READ_SECURITY;

	memset(&t, 0, sizeof t);
	t.tx_buf = scratch;
	t.rx_buf = scratch;
	t.len = l;
	spi_message_add_tail(&t, &m);

	dataflash_waitready(spi);

	status = spi_sync(spi, &m);
	if (status >= 0) {
		memcpy(buf, scratch + 4 + base + off, len);
		status = len;
	}

	kfree(scratch);
	return status;
}

static int dataflash_read_fact_otp(struct mtd_info *mtd,
		loff_t from, size_t len, size_t *retlen, u_char *buf)
{
504
	struct dataflash	*priv = mtd->priv;
D
David Brownell 已提交
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
	int			status;

	/* 64 bytes, from 0..63 ... start at 64 on-chip */
	mutex_lock(&priv->lock);
	status = otp_read(priv->spi, 64, buf, from, len);
	mutex_unlock(&priv->lock);

	if (status < 0)
		return status;
	*retlen = status;
	return 0;
}

static int dataflash_read_user_otp(struct mtd_info *mtd,
		loff_t from, size_t len, size_t *retlen, u_char *buf)
{
521
	struct dataflash	*priv = mtd->priv;
D
David Brownell 已提交
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
	int			status;

	/* 64 bytes, from 0..63 ... start at 0 on-chip */
	mutex_lock(&priv->lock);
	status = otp_read(priv->spi, 0, buf, from, len);
	mutex_unlock(&priv->lock);

	if (status < 0)
		return status;
	*retlen = status;
	return 0;
}

static int dataflash_write_user_otp(struct mtd_info *mtd,
		loff_t from, size_t len, size_t *retlen, u_char *buf)
{
	struct spi_message	m;
	const size_t		l = 4 + 64;
	uint8_t			*scratch;
	struct spi_transfer	t;
542
	struct dataflash	*priv = mtd->priv;
D
David Brownell 已提交
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
	int			status;

	if (len > 64)
		return -EINVAL;

	/* Strictly speaking, we *could* truncate the write ... but
	 * let's not do that for the only write that's ever possible.
	 */
	if ((from + len) > 64)
		return -EINVAL;

	/* OUT: OP_WRITE_SECURITY, 3 zeroes, 64 data-or-zero bytes
	 * IN:  ignore all
	 */
	scratch = kzalloc(l, GFP_KERNEL);
	if (!scratch)
		return -ENOMEM;
	scratch[0] = OP_WRITE_SECURITY;
	memcpy(scratch + 4 + from, buf, len);

	spi_message_init(&m);

	memset(&t, 0, sizeof t);
	t.tx_buf = scratch;
	t.len = l;
	spi_message_add_tail(&t, &m);

	/* Write the OTP bits, if they've not yet been written.
	 * This modifies SRAM buffer1.
	 */
	mutex_lock(&priv->lock);
	dataflash_waitready(priv->spi);
	status = spi_sync(priv->spi, &m);
	mutex_unlock(&priv->lock);

	kfree(scratch);

	if (status >= 0) {
		status = 0;
		*retlen = len;
	}
	return status;
}

static char *otp_setup(struct mtd_info *device, char revision)
{
589 590 591 592
	device->_get_fact_prot_info = dataflash_get_otp_info;
	device->_read_fact_prot_reg = dataflash_read_fact_otp;
	device->_get_user_prot_info = dataflash_get_otp_info;
	device->_read_user_prot_reg = dataflash_read_user_otp;
D
David Brownell 已提交
593 594 595 596 597

	/* rev c parts (at45db321c and at45db1281 only!) use a
	 * different write procedure; not (yet?) implemented.
	 */
	if (revision > 'c')
598
		device->_write_user_prot_reg = dataflash_write_user_otp;
D
David Brownell 已提交
599 600 601 602 603 604

	return ", OTP";
}

#else

605
static char *otp_setup(struct mtd_info *device, char revision)
D
David Brownell 已提交
606 607 608 609 610 611 612 613
{
	return " (OTP)";
}

#endif

/* ......................................................................... */

614 615 616
/*
 * Register DataFlash device with MTD subsystem.
 */
617 618
static int add_dataflash_otp(struct spi_device *spi, char *name, int nr_pages,
			     int pagesize, int pageoffset, char revision)
619 620 621
{
	struct dataflash		*priv;
	struct mtd_info			*device;
622
	struct mtd_part_parser_data	ppdata;
623
	struct flash_platform_data	*pdata = dev_get_platdata(&spi->dev);
D
David Brownell 已提交
624
	char				*otp_tag = "";
625
	int				err = 0;
626

627
	priv = kzalloc(sizeof *priv, GFP_KERNEL);
628 629 630
	if (!priv)
		return -ENOMEM;

631
	mutex_init(&priv->lock);
632 633 634 635 636 637 638 639 640 641 642 643 644
	priv->spi = spi;
	priv->page_size = pagesize;
	priv->page_offset = pageoffset;

	/* name must be usable with cmdlinepart */
	sprintf(priv->name, "spi%d.%d-%s",
			spi->master->bus_num, spi->chip_select,
			name);

	device = &priv->mtd;
	device->name = (pdata && pdata->name) ? pdata->name : priv->name;
	device->size = nr_pages * pagesize;
	device->erasesize = pagesize;
645
	device->writesize = pagesize;
646 647
	device->owner = THIS_MODULE;
	device->type = MTD_DATAFLASH;
648
	device->flags = MTD_WRITEABLE;
649 650 651
	device->_erase = dataflash_erase;
	device->_read = dataflash_read;
	device->_write = dataflash_write;
652 653
	device->priv = priv;

654 655
	device->dev.parent = &spi->dev;

D
David Brownell 已提交
656 657 658
	if (revision >= 'c')
		otp_tag = otp_setup(device, revision);

659 660
	dev_info(&spi->dev, "%s (%lld KBytes) pagesize %d bytes%s\n",
			name, (long long)((device->size + 1023) >> 10),
D
David Brownell 已提交
661
			pagesize, otp_tag);
662
	spi_set_drvdata(spi, priv);
663

664 665
	ppdata.of_node = spi->dev.of_node;
	err = mtd_device_parse_register(device, NULL, &ppdata,
666 667
			pdata ? pdata->parts : NULL,
			pdata ? pdata->nr_parts : 0);
668

669 670 671
	if (!err)
		return 0;

672
	spi_set_drvdata(spi, NULL);
673 674
	kfree(priv);
	return err;
675 676
}

677 678
static inline int add_dataflash(struct spi_device *spi, char *name,
				int nr_pages, int pagesize, int pageoffset)
D
David Brownell 已提交
679 680 681 682 683
{
	return add_dataflash_otp(spi, name, nr_pages, pagesize,
			pageoffset, 0);
}

684 685 686
struct flash_info {
	char		*name;

687 688
	/* JEDEC id has a high byte of zero plus three data bytes:
	 * the manufacturer id, then a two byte device id.
689
	 */
690
	uint32_t	jedec_id;
691

692
	/* The size listed here is what works with OP_ERASE_PAGE. */
693
	unsigned	nr_pages;
694 695
	uint16_t	pagesize;
	uint16_t	pageoffset;
696

697
	uint16_t	flags;
698 699
#define SUP_POW2PS	0x0002		/* supports 2^N byte pages */
#define IS_POW2PS	0x0001		/* uses 2^N byte pages */
700 701
};

702
static struct flash_info dataflash_data[] = {
703

704 705 706 707 708 709 710 711 712 713
	/*
	 * NOTE:  chips with SUP_POW2PS (rev D and up) need two entries,
	 * one with IS_POW2PS and the other without.  The entry with the
	 * non-2^N byte page size can't name exact chip revisions without
	 * losing backwards compatibility for cmdlinepart.
	 *
	 * These newer chips also support 128-byte security registers (with
	 * 64 bytes one-time-programmable) and software write-protection.
	 */
	{ "AT45DB011B",  0x1f2200, 512, 264, 9, SUP_POW2PS},
714 715
	{ "at45db011d",  0x1f2200, 512, 256, 8, SUP_POW2PS | IS_POW2PS},

716
	{ "AT45DB021B",  0x1f2300, 1024, 264, 9, SUP_POW2PS},
717 718
	{ "at45db021d",  0x1f2300, 1024, 256, 8, SUP_POW2PS | IS_POW2PS},

719
	{ "AT45DB041x",  0x1f2400, 2048, 264, 9, SUP_POW2PS},
720 721
	{ "at45db041d",  0x1f2400, 2048, 256, 8, SUP_POW2PS | IS_POW2PS},

722
	{ "AT45DB081B",  0x1f2500, 4096, 264, 9, SUP_POW2PS},
723 724
	{ "at45db081d",  0x1f2500, 4096, 256, 8, SUP_POW2PS | IS_POW2PS},

725
	{ "AT45DB161x",  0x1f2600, 4096, 528, 10, SUP_POW2PS},
726 727
	{ "at45db161d",  0x1f2600, 4096, 512, 9, SUP_POW2PS | IS_POW2PS},

728
	{ "AT45DB321x",  0x1f2700, 8192, 528, 10, 0},		/* rev C */
729

730
	{ "AT45DB321x",  0x1f2701, 8192, 528, 10, SUP_POW2PS},
731 732
	{ "at45db321d",  0x1f2701, 8192, 512, 9, SUP_POW2PS | IS_POW2PS},

733 734
	{ "AT45DB642x",  0x1f2800, 8192, 1056, 11, SUP_POW2PS},
	{ "at45db642d",  0x1f2800, 8192, 1024, 10, SUP_POW2PS | IS_POW2PS},
735 736
};

B
Bill Pemberton 已提交
737
static struct flash_info *jedec_probe(struct spi_device *spi)
738 739
{
	int			tmp;
740 741 742
	uint8_t			code = OP_READ_ID;
	uint8_t			id[3];
	uint32_t		jedec;
743 744 745 746 747 748
	struct flash_info	*info;
	int status;

	/* JEDEC also defines an optional "extended device information"
	 * string for after vendor-specific data, after the three bytes
	 * we use here.  Supporting some chips might require using it.
749 750 751 752
	 *
	 * If the vendor ID isn't Atmel's (0x1f), assume this call failed.
	 * That's not an error; only rev C and newer chips handle it, and
	 * only Atmel sells these chips.
753 754 755
	 */
	tmp = spi_write_then_read(spi, &code, 1, id, 3);
	if (tmp < 0) {
756
		pr_debug("%s: error %d reading JEDEC ID\n",
757
			dev_name(&spi->dev), tmp);
758
		return ERR_PTR(tmp);
759
	}
760 761 762
	if (id[0] != 0x1f)
		return NULL;

763 764 765 766 767 768 769 770 771 772
	jedec = id[0];
	jedec = jedec << 8;
	jedec |= id[1];
	jedec = jedec << 8;
	jedec |= id[2];

	for (tmp = 0, info = dataflash_data;
			tmp < ARRAY_SIZE(dataflash_data);
			tmp++, info++) {
		if (info->jedec_id == jedec) {
773
			pr_debug("%s: OTP, sector protect%s\n",
774 775 776 777
				dev_name(&spi->dev),
				(info->flags & SUP_POW2PS)
					? ", binary pagesize" : ""
				);
778 779
			if (info->flags & SUP_POW2PS) {
				status = dataflash_status(spi);
780
				if (status < 0) {
781
					pr_debug("%s: status error %d\n",
782 783 784 785 786 787 788 789 790 791
						dev_name(&spi->dev), status);
					return ERR_PTR(status);
				}
				if (status & 0x1) {
					if (info->flags & IS_POW2PS)
						return info;
				} else {
					if (!(info->flags & IS_POW2PS))
						return info;
				}
792 793
			} else
				return info;
794 795
		}
	}
796 797 798 799 800 801 802 803

	/*
	 * Treat other chips as errors ... we won't know the right page
	 * size (it might be binary) even when we can tell which density
	 * class is involved (legacy chip id scheme).
	 */
	dev_warn(&spi->dev, "JEDEC id %06x not handled\n", jedec);
	return ERR_PTR(-ENODEV);
804 805
}

806 807 808 809 810 811 812 813 814 815 816 817 818 819
/*
 * Detect and initialize DataFlash device, using JEDEC IDs on newer chips
 * or else the ID code embedded in the status bits:
 *
 *   Device      Density         ID code          #Pages PageSize  Offset
 *   AT45DB011B  1Mbit   (128K)  xx0011xx (0x0c)    512    264      9
 *   AT45DB021B  2Mbit   (256K)  xx0101xx (0x14)   1024    264      9
 *   AT45DB041B  4Mbit   (512K)  xx0111xx (0x1c)   2048    264      9
 *   AT45DB081B  8Mbit   (1M)    xx1001xx (0x24)   4096    264      9
 *   AT45DB0161B 16Mbit  (2M)    xx1011xx (0x2c)   4096    528     10
 *   AT45DB0321B 32Mbit  (4M)    xx1101xx (0x34)   8192    528     10
 *   AT45DB0642  64Mbit  (8M)    xx111xxx (0x3c)   8192   1056     11
 *   AT45DB1282  128Mbit (16M)   xx0100xx (0x10)  16384   1056     11
 */
B
Bill Pemberton 已提交
820
static int dataflash_probe(struct spi_device *spi)
821 822
{
	int status;
823 824 825 826 827 828
	struct flash_info	*info;

	/*
	 * Try to detect dataflash by JEDEC ID.
	 * If it succeeds we know we have either a C or D part.
	 * D will support power of 2 pagesize option.
D
David Brownell 已提交
829 830
	 * Both support the security register, though with different
	 * write procedures.
831 832
	 */
	info = jedec_probe(spi);
833 834
	if (IS_ERR(info))
		return PTR_ERR(info);
835
	if (info != NULL)
D
David Brownell 已提交
836 837 838
		return add_dataflash_otp(spi, info->name, info->nr_pages,
				info->pagesize, info->pageoffset,
				(info->flags & SUP_POW2PS) ? 'd' : 'c');
839

840 841 842 843
	/*
	 * Older chips support only legacy commands, identifing
	 * capacity using bits in the status byte.
	 */
844 845
	status = dataflash_status(spi);
	if (status <= 0 || status == 0xff) {
846
		pr_debug("%s: status error %d\n",
847
				dev_name(&spi->dev), status);
848
		if (status == 0 || status == 0xff)
849 850 851 852 853 854 855 856 857 858 859 860 861
			status = -ENODEV;
		return status;
	}

	/* if there's a device there, assume it's dataflash.
	 * board setup should have set spi->max_speed_max to
	 * match f(car) for continuous reads, mode 0 or 3.
	 */
	switch (status & 0x3c) {
	case 0x0c:	/* 0 0 1 1 x x */
		status = add_dataflash(spi, "AT45DB011B", 512, 264, 9);
		break;
	case 0x14:	/* 0 1 0 1 x x */
862
		status = add_dataflash(spi, "AT45DB021B", 1024, 264, 9);
863 864
		break;
	case 0x1c:	/* 0 1 1 1 x x */
865
		status = add_dataflash(spi, "AT45DB041x", 2048, 264, 9);
866 867 868 869 870
		break;
	case 0x24:	/* 1 0 0 1 x x */
		status = add_dataflash(spi, "AT45DB081B", 4096, 264, 9);
		break;
	case 0x2c:	/* 1 0 1 1 x x */
871
		status = add_dataflash(spi, "AT45DB161x", 4096, 528, 10);
872 873 874 875 876 877 878 879 880 881
		break;
	case 0x34:	/* 1 1 0 1 x x */
		status = add_dataflash(spi, "AT45DB321x", 8192, 528, 10);
		break;
	case 0x38:	/* 1 1 1 x x x */
	case 0x3c:
		status = add_dataflash(spi, "AT45DB642x", 8192, 1056, 11);
		break;
	/* obsolete AT45DB1282 not (yet?) supported */
	default:
882 883
		pr_debug("%s: unsupported device (%x)\n", dev_name(&spi->dev),
				status & 0x3c);
884 885 886 887
		status = -ENODEV;
	}

	if (status < 0)
888 889
		pr_debug("%s: add_dataflash --> %d\n", dev_name(&spi->dev),
				status);
890 891 892 893

	return status;
}

B
Bill Pemberton 已提交
894
static int dataflash_remove(struct spi_device *spi)
895
{
896
	struct dataflash	*flash = spi_get_drvdata(spi);
897 898
	int			status;

899
	pr_debug("%s: remove\n", dev_name(&spi->dev));
900

901
	status = mtd_device_unregister(&flash->mtd);
902
	if (status == 0) {
903
		spi_set_drvdata(spi, NULL);
904
		kfree(flash);
905
	}
906 907 908 909 910 911 912
	return status;
}

static struct spi_driver dataflash_driver = {
	.driver = {
		.name		= "mtd_dataflash",
		.owner		= THIS_MODULE,
913
		.of_match_table = of_match_ptr(dataflash_dt_ids),
914 915 916
	},

	.probe		= dataflash_probe,
B
Bill Pemberton 已提交
917
	.remove		= dataflash_remove,
918 919 920 921

	/* FIXME:  investigate suspend and resume... */
};

922
module_spi_driver(dataflash_driver);
923 924 925 926

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Andrew Victor, David Brownell");
MODULE_DESCRIPTION("MTD DataFlash driver");
927
MODULE_ALIAS("spi:mtd_dataflash");