spi_flash.c 26.5 KB
Newer Older
1
/*
2
 * SPI Flash Core
3
 *
4
 * Copyright (C) 2015 Jagan Teki <jteki@openedev.com>
5
 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
6 7
 * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
 * Copyright (C) 2008 Atmel Corporation
8
 *
9
 * SPDX-License-Identifier:	GPL-2.0+
10 11 12
 */

#include <common.h>
13
#include <errno.h>
14
#include <malloc.h>
15
#include <mapmem.h>
16 17
#include <spi.h>
#include <spi_flash.h>
18
#include <linux/log2.h>
19
#include <dma.h>
20

21
#include "sf_internal.h"
22

23 24
DECLARE_GLOBAL_DATA_PTR;

25 26 27 28 29 30 31 32
static void spi_flash_addr(u32 addr, u8 *cmd)
{
	/* cmd[0] is actual command */
	cmd[1] = addr >> 16;
	cmd[2] = addr >> 8;
	cmd[3] = addr >> 0;
}

33
static int read_sr(struct spi_flash *flash, u8 *rs)
34 35
{
	int ret;
36
	u8 cmd;
37

38 39
	cmd = CMD_READ_STATUS;
	ret = spi_flash_read_common(flash, &cmd, 1, rs, 1);
40
	if (ret < 0) {
41
		debug("SF: fail to read status register\n");
42 43 44 45 46 47
		return ret;
	}

	return 0;
}

48 49 50 51 52 53 54 55 56 57 58 59 60 61
static int read_fsr(struct spi_flash *flash, u8 *fsr)
{
	int ret;
	const u8 cmd = CMD_FLAG_STATUS;

	ret = spi_flash_read_common(flash, &cmd, 1, fsr, 1);
	if (ret < 0) {
		debug("SF: fail to read flag status register\n");
		return ret;
	}

	return 0;
}

62
static int write_sr(struct spi_flash *flash, u8 ws)
63 64 65 66
{
	u8 cmd;
	int ret;

67
	cmd = CMD_WRITE_STATUS;
68
	ret = spi_flash_write_common(flash, &cmd, 1, &ws, 1);
69
	if (ret < 0) {
70
		debug("SF: fail to write status register\n");
71 72 73
		return ret;
	}

74
	return 0;
75 76
}

77
#if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
78
static int read_cr(struct spi_flash *flash, u8 *rc)
79 80
{
	int ret;
81
	u8 cmd;
82

83 84
	cmd = CMD_READ_CONFIG;
	ret = spi_flash_read_common(flash, &cmd, 1, rc, 1);
85
	if (ret < 0) {
86
		debug("SF: fail to read config register\n");
87 88 89 90 91 92
		return ret;
	}

	return 0;
}

93
static int write_cr(struct spi_flash *flash, u8 wc)
94
{
95
	u8 data[2];
96 97 98
	u8 cmd;
	int ret;

99
	ret = read_sr(flash, &data[0]);
100
	if (ret < 0)
101 102
		return ret;

103 104 105 106 107 108
	cmd = CMD_WRITE_STATUS;
	data[1] = wc;
	ret = spi_flash_write_common(flash, &cmd, 1, &data, 2);
	if (ret) {
		debug("SF: fail to write config register\n");
		return ret;
109 110
	}

111
	return 0;
112 113 114
}
#endif

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
#ifdef CONFIG_SPI_FLASH_STMICRO
static int read_evcr(struct spi_flash *flash, u8 *evcr)
{
	int ret;
	const u8 cmd = CMD_READ_EVCR;

	ret = spi_flash_read_common(flash, &cmd, 1, evcr, 1);
	if (ret < 0) {
		debug("SF: error reading EVCR\n");
		return ret;
	}

	return 0;
}

static int write_evcr(struct spi_flash *flash, u8 evcr)
{
	u8 cmd;
	int ret;

	cmd = CMD_WRITE_EVCR;
	ret = spi_flash_write_common(flash, &cmd, 1, &evcr, 1);
	if (ret < 0) {
		debug("SF: error while writing EVCR register\n");
		return ret;
	}

	return 0;
}
#endif

146
#ifdef CONFIG_SPI_FLASH_BAR
147
static int spi_flash_write_bar(struct spi_flash *flash, u32 offset)
148
{
Jagan Teki's avatar
Jagan Teki committed
149
	u8 cmd, bank_sel;
150 151
	int ret;

Jagan Teki's avatar
Jagan Teki committed
152 153 154
	bank_sel = offset / (SPI_FLASH_16MB_BOUN << flash->shift);
	if (bank_sel == flash->bank_curr)
		goto bar_end;
155 156 157 158 159 160 161

	cmd = flash->bank_write_cmd;
	ret = spi_flash_write_common(flash, &cmd, 1, &bank_sel, 1);
	if (ret < 0) {
		debug("SF: fail to write bank register\n");
		return ret;
	}
162

Jagan Teki's avatar
Jagan Teki committed
163 164 165
bar_end:
	flash->bank_curr = bank_sel;
	return flash->bank_curr;
166
}
Jagan Teki's avatar
Jagan Teki committed
167

168
static int spi_flash_read_bar(struct spi_flash *flash, u8 idcode0)
Jagan Teki's avatar
Jagan Teki committed
169 170 171 172 173
{
	u8 curr_bank = 0;
	int ret;

	if (flash->size <= SPI_FLASH_16MB_BOUN)
174
		goto bar_end;
Jagan Teki's avatar
Jagan Teki committed
175 176 177 178 179

	switch (idcode0) {
	case SPI_FLASH_CFI_MFR_SPANSION:
		flash->bank_read_cmd = CMD_BANKADDR_BRRD;
		flash->bank_write_cmd = CMD_BANKADDR_BRWR;
180
		break;
Jagan Teki's avatar
Jagan Teki committed
181 182 183 184 185 186 187 188 189 190 191 192
	default:
		flash->bank_read_cmd = CMD_EXTNADDR_RDEAR;
		flash->bank_write_cmd = CMD_EXTNADDR_WREAR;
	}

	ret = spi_flash_read_common(flash, &flash->bank_read_cmd, 1,
				    &curr_bank, 1);
	if (ret) {
		debug("SF: fail to read bank addr register\n");
		return ret;
	}

193
bar_end:
Jagan Teki's avatar
Jagan Teki committed
194 195 196
	flash->bank_curr = curr_bank;
	return 0;
}
197 198
#endif

199
#ifdef CONFIG_SF_DUAL_FLASH
200
static void spi_flash_dual(struct spi_flash *flash, u32 *addr)
201
{
202 203
	struct spi_slave *spi = flash->spi;

204 205 206 207
	switch (flash->dual_flash) {
	case SF_DUAL_STACKED_FLASH:
		if (*addr >= (flash->size >> 1)) {
			*addr -= flash->size >> 1;
208
			spi->flags |= SPI_XFER_U_PAGE;
209
		} else {
210
			spi->flags &= ~SPI_XFER_U_PAGE;
211 212
		}
		break;
213 214 215
	case SF_DUAL_PARALLEL_FLASH:
		*addr >>= flash->shift;
		break;
216 217 218 219 220
	default:
		debug("SF: Unsupported dual_flash=%d\n", flash->dual_flash);
		break;
	}
}
221
#endif
222

223
static int spi_flash_sr_ready(struct spi_flash *flash)
224
{
225
	u8 sr;
226 227
	int ret;

228
	ret = read_sr(flash, &sr);
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
	if (ret < 0)
		return ret;

	return !(sr & STATUS_WIP);
}

static int spi_flash_fsr_ready(struct spi_flash *flash)
{
	u8 fsr;
	int ret;

	ret = read_fsr(flash, &fsr);
	if (ret < 0)
		return ret;

	return fsr & STATUS_PEC;
}

static int spi_flash_ready(struct spi_flash *flash)
{
	int sr, fsr;

	sr = spi_flash_sr_ready(flash);
	if (sr < 0)
		return sr;

	fsr = 1;
	if (flash->flags & SNOR_F_USE_FSR) {
		fsr = spi_flash_fsr_ready(flash);
		if (fsr < 0)
			return fsr;
	}

	return sr && fsr;
}

265 266
static int spi_flash_cmd_wait_ready(struct spi_flash *flash,
					unsigned long timeout)
267
{
268
	int timebase, ret;
269

270
	timebase = get_timer(0);
271

272
	while (get_timer(timebase) < timeout) {
273
		ret = spi_flash_ready(flash);
274 275
		if (ret < 0)
			return ret;
276
		if (ret)
277
			return 0;
278 279
	}

280 281 282
	printf("SF: Timeout!\n");

	return -ETIMEDOUT;
283 284
}

285 286 287 288 289 290 291 292 293 294
int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
		size_t cmd_len, const void *buf, size_t buf_len)
{
	struct spi_slave *spi = flash->spi;
	unsigned long timeout = SPI_FLASH_PROG_TIMEOUT;
	int ret;

	if (buf == NULL)
		timeout = SPI_FLASH_PAGE_ERASE_TIMEOUT;

295
	ret = spi_claim_bus(spi);
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
	if (ret) {
		debug("SF: unable to claim SPI bus\n");
		return ret;
	}

	ret = spi_flash_cmd_write_enable(flash);
	if (ret < 0) {
		debug("SF: enabling write failed\n");
		return ret;
	}

	ret = spi_flash_cmd_write(spi, cmd, cmd_len, buf, buf_len);
	if (ret < 0) {
		debug("SF: write cmd failed\n");
		return ret;
	}

	ret = spi_flash_cmd_wait_ready(flash, timeout);
	if (ret < 0) {
		debug("SF: write %s timed out\n",
		      timeout == SPI_FLASH_PROG_TIMEOUT ?
			"program" : "page erase");
		return ret;
	}

	spi_release_bus(spi);

	return ret;
}

326
int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len)
327
{
328
	u32 erase_size, erase_addr;
329
	u8 cmd[SPI_FLASH_CMD_LEN];
330 331
	int ret = -1;

332
	erase_size = flash->erase_size;
333 334 335 336 337
	if (offset % erase_size || len % erase_size) {
		debug("SF: Erase offset/length not multiple of erase size\n");
		return -1;
	}

338 339 340 341 342 343
	if (flash->flash_is_locked) {
		if (flash->flash_is_locked(flash, offset, len) > 0) {
			printf("offset 0x%x is protected and cannot be erased\n",
			       offset);
			return -EINVAL;
		}
344 345
	}

346
	cmd[0] = flash->erase_cmd;
347
	while (len) {
348 349
		erase_addr = offset;

350
#ifdef CONFIG_SF_DUAL_FLASH
351
		if (flash->dual_flash > SF_SINGLE_FLASH)
352
			spi_flash_dual(flash, &erase_addr);
353
#endif
354
#ifdef CONFIG_SPI_FLASH_BAR
355
		ret = spi_flash_write_bar(flash, erase_addr);
356
		if (ret < 0)
357 358
			return ret;
#endif
359
		spi_flash_addr(erase_addr, cmd);
360 361

		debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1],
362
		      cmd[2], cmd[3], erase_addr);
363 364 365 366 367 368 369 370 371 372 373 374 375 376

		ret = spi_flash_write_common(flash, cmd, sizeof(cmd), NULL, 0);
		if (ret < 0) {
			debug("SF: erase failed\n");
			break;
		}

		offset += erase_size;
		len -= erase_size;
	}

	return ret;
}

377
int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
378 379
		size_t len, const void *buf)
{
380
	struct spi_slave *spi = flash->spi;
381
	unsigned long byte_addr, page_size;
382
	u32 write_addr;
383
	size_t chunk_len, actual;
384
	u8 cmd[SPI_FLASH_CMD_LEN];
385 386 387 388
	int ret = -1;

	page_size = flash->page_size;

389 390 391 392 393 394
	if (flash->flash_is_locked) {
		if (flash->flash_is_locked(flash, offset, len) > 0) {
			printf("offset 0x%x is protected and cannot be written\n",
			       offset);
			return -EINVAL;
		}
395 396
	}

397
	cmd[0] = flash->write_cmd;
398
	for (actual = 0; actual < len; actual += chunk_len) {
399 400
		write_addr = offset;

401
#ifdef CONFIG_SF_DUAL_FLASH
402
		if (flash->dual_flash > SF_SINGLE_FLASH)
403
			spi_flash_dual(flash, &write_addr);
404
#endif
405
#ifdef CONFIG_SPI_FLASH_BAR
406
		ret = spi_flash_write_bar(flash, write_addr);
407
		if (ret < 0)
408 409 410
			return ret;
#endif
		byte_addr = offset % page_size;
411
		chunk_len = min(len - actual, (size_t)(page_size - byte_addr));
412

413
		if (spi->max_write_size)
414
			chunk_len = min(chunk_len,
415
					(size_t)spi->max_write_size);
416

417
		spi_flash_addr(write_addr, cmd);
418

419
		debug("SF: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %zu\n",
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
		      buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);

		ret = spi_flash_write_common(flash, cmd, sizeof(cmd),
					buf + actual, chunk_len);
		if (ret < 0) {
			debug("SF: write failed\n");
			break;
		}

		offset += chunk_len;
	}

	return ret;
}

int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
		size_t cmd_len, void *data, size_t data_len)
{
	struct spi_slave *spi = flash->spi;
	int ret;

441
	ret = spi_claim_bus(spi);
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
	if (ret) {
		debug("SF: unable to claim SPI bus\n");
		return ret;
	}

	ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len);
	if (ret < 0) {
		debug("SF: read cmd failed\n");
		return ret;
	}

	spi_release_bus(spi);

	return ret;
}

458 459 460 461
/*
 * TODO: remove the weak after all the other spi_flash_copy_mmap
 * implementations removed from drivers
 */
462 463
void __weak spi_flash_copy_mmap(void *data, void *offset, size_t len)
{
464 465 466 467
#ifdef CONFIG_DMA
	if (!dma_memcpy(data, offset, len))
		return;
#endif
468 469 470
	memcpy(data, offset, len);
}

471
int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
472 473
		size_t len, void *data)
{
474
	struct spi_slave *spi = flash->spi;
475
	u8 *cmd, cmdsz;
476
	u32 remain_len, read_len, read_addr;
477
	int bank_sel = 0;
478 479 480 481
	int ret = -1;

	/* Handle memory-mapped SPI */
	if (flash->memory_map) {
482
		ret = spi_claim_bus(spi);
483 484 485 486
		if (ret) {
			debug("SF: unable to claim SPI bus\n");
			return ret;
		}
487
		spi_xfer(spi, 0, NULL, NULL, SPI_XFER_MMAP);
488
		spi_flash_copy_mmap(data, flash->memory_map + offset, len);
489 490
		spi_xfer(spi, 0, NULL, NULL, SPI_XFER_MMAP_END);
		spi_release_bus(spi);
491 492 493
		return 0;
	}

494
	cmdsz = SPI_FLASH_CMD_LEN + flash->dummy_byte;
495 496 497 498 499
	cmd = calloc(1, cmdsz);
	if (!cmd) {
		debug("SF: Failed to allocate cmd\n");
		return -ENOMEM;
	}
500

501
	cmd[0] = flash->read_cmd;
502
	while (len) {
503 504
		read_addr = offset;

505
#ifdef CONFIG_SF_DUAL_FLASH
506
		if (flash->dual_flash > SF_SINGLE_FLASH)
507
			spi_flash_dual(flash, &read_addr);
508
#endif
509
#ifdef CONFIG_SPI_FLASH_BAR
510
		ret = spi_flash_write_bar(flash, read_addr);
Jagan Teki's avatar
Jagan Teki committed
511
		if (ret < 0)
512
			return ret;
Jagan Teki's avatar
Jagan Teki committed
513
		bank_sel = flash->bank_curr;
514
#endif
515 516
		remain_len = ((SPI_FLASH_16MB_BOUN << flash->shift) *
				(bank_sel + 1)) - offset;
517 518 519 520 521
		if (len < remain_len)
			read_len = len;
		else
			read_len = remain_len;

522
		spi_flash_addr(read_addr, cmd);
523

524
		ret = spi_flash_read_common(flash, cmd, cmdsz, data, read_len);
525 526 527 528 529 530 531 532 533 534
		if (ret < 0) {
			debug("SF: read failed\n");
			break;
		}

		offset += read_len;
		len -= read_len;
		data += read_len;
	}

Marek Vasut's avatar
Marek Vasut committed
535
	free(cmd);
536 537
	return ret;
}
538 539 540 541

#ifdef CONFIG_SPI_FLASH_SST
static int sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
{
542
	struct spi_slave *spi = flash->spi;
543 544 545 546 547 548 549 550 551
	int ret;
	u8 cmd[4] = {
		CMD_SST_BP,
		offset >> 16,
		offset >> 8,
		offset,
	};

	debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
552
	      spi_w8r8(spi, CMD_READ_STATUS), buf, cmd[0], offset);
553 554 555 556 557

	ret = spi_flash_cmd_write_enable(flash);
	if (ret)
		return ret;

558
	ret = spi_flash_cmd_write(spi, cmd, sizeof(cmd), buf, 1);
559 560 561 562 563 564 565 566 567
	if (ret)
		return ret;

	return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
}

int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
		const void *buf)
{
568
	struct spi_slave *spi = flash->spi;
569 570 571 572
	size_t actual, cmd_len;
	int ret;
	u8 cmd[4];

573
	ret = spi_claim_bus(spi);
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
	if (ret) {
		debug("SF: Unable to claim SPI bus\n");
		return ret;
	}

	/* If the data is not word aligned, write out leading single byte */
	actual = offset % 2;
	if (actual) {
		ret = sst_byte_write(flash, offset, buf);
		if (ret)
			goto done;
	}
	offset += actual;

	ret = spi_flash_cmd_write_enable(flash);
	if (ret)
		goto done;

	cmd_len = 4;
	cmd[0] = CMD_SST_AAI_WP;
	cmd[1] = offset >> 16;
	cmd[2] = offset >> 8;
	cmd[3] = offset;

	for (; actual < len - 1; actual += 2) {
		debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
600
		      spi_w8r8(spi, CMD_READ_STATUS), buf + actual,
601 602
		      cmd[0], offset);

603
		ret = spi_flash_cmd_write(spi, cmd, cmd_len,
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
					buf + actual, 2);
		if (ret) {
			debug("SF: sst word program failed\n");
			break;
		}

		ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
		if (ret)
			break;

		cmd_len = 1;
		offset += 2;
	}

	if (!ret)
		ret = spi_flash_cmd_write_disable(flash);

	/* If there is a single trailing byte, write it out */
	if (!ret && actual != len)
		ret = sst_byte_write(flash, offset, buf + actual);

 done:
	debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
	      ret ? "failure" : "success", len, offset - actual);

629
	spi_release_bus(spi);
630 631
	return ret;
}
632 633 634 635

int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
		const void *buf)
{
636
	struct spi_slave *spi = flash->spi;
637 638 639
	size_t actual;
	int ret;

640
	ret = spi_claim_bus(spi);
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
	if (ret) {
		debug("SF: Unable to claim SPI bus\n");
		return ret;
	}

	for (actual = 0; actual < len; actual++) {
		ret = sst_byte_write(flash, offset, buf + actual);
		if (ret) {
			debug("SF: sst byte program failed\n");
			break;
		}
		offset++;
	}

	if (!ret)
		ret = spi_flash_cmd_write_disable(flash);

	debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
	      ret ? "failure" : "success", len, offset - actual);

661
	spi_release_bus(spi);
662 663
	return ret;
}
664
#endif
665

666
#if defined(CONFIG_SPI_FLASH_STMICRO) || defined(CONFIG_SPI_FLASH_SST)
667
static void stm_get_locked_range(struct spi_flash *flash, u8 sr, loff_t *ofs,
668
				 u64 *len)
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
{
	u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
	int shift = ffs(mask) - 1;
	int pow;

	if (!(sr & mask)) {
		/* No protection */
		*ofs = 0;
		*len = 0;
	} else {
		pow = ((sr & mask) ^ mask) >> shift;
		*len = flash->size >> pow;
		*ofs = flash->size - *len;
	}
}

/*
 * Return 1 if the entire region is locked, 0 otherwise
 */
688
static int stm_is_locked_sr(struct spi_flash *flash, loff_t ofs, u64 len,
689 690 691
			    u8 sr)
{
	loff_t lock_offs;
692
	u64 lock_len;
693 694 695 696 697 698 699 700 701 702 703 704 705

	stm_get_locked_range(flash, sr, &lock_offs, &lock_len);

	return (ofs + len <= lock_offs + lock_len) && (ofs >= lock_offs);
}

/*
 * Check if a region of the flash is (completely) locked. See stm_lock() for
 * more info.
 *
 * Returns 1 if entire region is locked, 0 if any portion is unlocked, and
 * negative on errors.
 */
706
int stm_is_locked(struct spi_flash *flash, u32 ofs, size_t len)
707 708 709 710
{
	int status;
	u8 sr;

711
	status = read_sr(flash, &sr);
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
	if (status < 0)
		return status;

	return stm_is_locked_sr(flash, ofs, len, sr);
}

/*
 * Lock a region of the flash. Compatible with ST Micro and similar flash.
 * Supports only the block protection bits BP{0,1,2} in the status register
 * (SR). Does not support these features found in newer SR bitfields:
 *   - TB: top/bottom protect - only handle TB=0 (top protect)
 *   - SEC: sector/block protect - only handle SEC=0 (block protect)
 *   - CMP: complement protect - only support CMP=0 (range is not complemented)
 *
 * Sample table portion for 8MB flash (Winbond w25q64fw):
 *
 *   SEC  |  TB   |  BP2  |  BP1  |  BP0  |  Prot Length  | Protected Portion
 *  --------------------------------------------------------------------------
 *    X   |   X   |   0   |   0   |   0   |  NONE         | NONE
 *    0   |   0   |   0   |   0   |   1   |  128 KB       | Upper 1/64
 *    0   |   0   |   0   |   1   |   0   |  256 KB       | Upper 1/32
 *    0   |   0   |   0   |   1   |   1   |  512 KB       | Upper 1/16
 *    0   |   0   |   1   |   0   |   0   |  1 MB         | Upper 1/8
 *    0   |   0   |   1   |   0   |   1   |  2 MB         | Upper 1/4
 *    0   |   0   |   1   |   1   |   0   |  4 MB         | Upper 1/2
 *    X   |   X   |   1   |   1   |   1   |  8 MB         | ALL
 *
 * Returns negative on errors, 0 on success.
 */
int stm_lock(struct spi_flash *flash, u32 ofs, size_t len)
{
	u8 status_old, status_new;
	u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
	u8 shift = ffs(mask) - 1, pow, val;
746
	int ret;
747

748
	ret = read_sr(flash, &status_old);
749 750
	if (ret < 0)
		return ret;
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784

	/* SPI NOR always locks to the end */
	if (ofs + len != flash->size) {
		/* Does combined region extend to end? */
		if (!stm_is_locked_sr(flash, ofs + len, flash->size - ofs - len,
				      status_old))
			return -EINVAL;
		len = flash->size - ofs;
	}

	/*
	 * Need smallest pow such that:
	 *
	 *   1 / (2^pow) <= (len / size)
	 *
	 * so (assuming power-of-2 size) we do:
	 *
	 *   pow = ceil(log2(size / len)) = log2(size) - floor(log2(len))
	 */
	pow = ilog2(flash->size) - ilog2(len);
	val = mask - (pow << shift);
	if (val & ~mask)
		return -EINVAL;

	/* Don't "lock" with no region! */
	if (!(val & mask))
		return -EINVAL;

	status_new = (status_old & ~mask) | val;

	/* Only modify protection if it will not unlock other areas */
	if ((status_new & mask) <= (status_old & mask))
		return -EINVAL;

785
	write_sr(flash, status_new);
786 787 788 789 790 791 792 793 794 795 796 797 798 799

	return 0;
}

/*
 * Unlock a region of the flash. See stm_lock() for more info
 *
 * Returns negative on errors, 0 on success.
 */
int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len)
{
	uint8_t status_old, status_new;
	u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
	u8 shift = ffs(mask) - 1, pow, val;
800
	int ret;
801

802
	ret = read_sr(flash, &status_old);
803 804
	if (ret < 0)
		return ret;
805 806

	/* Cannot unlock; would unlock larger region than requested */
807 808
	if (stm_is_locked_sr(flash, ofs - flash->erase_size, flash->erase_size,
			     status_old))
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
		return -EINVAL;
	/*
	 * Need largest pow such that:
	 *
	 *   1 / (2^pow) >= (len / size)
	 *
	 * so (assuming power-of-2 size) we do:
	 *
	 *   pow = floor(log2(size / len)) = log2(size) - ceil(log2(len))
	 */
	pow = ilog2(flash->size) - order_base_2(flash->size - (ofs + len));
	if (ofs + len == flash->size) {
		val = 0; /* fully unlocked */
	} else {
		val = mask - (pow << shift);
		/* Some power-of-two sizes are not supported */
		if (val & ~mask)
			return -EINVAL;
	}

	status_new = (status_old & ~mask) | val;

	/* Only modify protection if it will not lock other areas */
	if ((status_new & mask) >= (status_old & mask))
		return -EINVAL;

835
	write_sr(flash, status_new);
836 837 838

	return 0;
}
839
#endif
840 841 842


#ifdef CONFIG_SPI_FLASH_MACRONIX
843
static int macronix_quad_enable(struct spi_flash *flash)
844 845 846 847
{
	u8 qeb_status;
	int ret;

848
	ret = read_sr(flash, &qeb_status);
849 850 851
	if (ret < 0)
		return ret;

852 853 854
	if (qeb_status & STATUS_QEB_MXIC)
		return 0;

855
	ret = write_sr(flash, qeb_status | STATUS_QEB_MXIC);
856 857 858 859 860 861 862 863
	if (ret < 0)
		return ret;

	/* read SR and check it */
	ret = read_sr(flash, &qeb_status);
	if (!(ret >= 0 && (qeb_status & STATUS_QEB_MXIC))) {
		printf("SF: Macronix SR Quad bit not clear\n");
		return -EINVAL;
864 865 866 867 868 869 870
	}

	return ret;
}
#endif

#if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
871
static int spansion_quad_enable(struct spi_flash *flash)
872 873 874 875
{
	u8 qeb_status;
	int ret;

876
	ret = read_cr(flash, &qeb_status);
877 878 879
	if (ret < 0)
		return ret;

880 881 882
	if (qeb_status & STATUS_QEB_WINSPAN)
		return 0;

883
	ret = write_cr(flash, qeb_status | STATUS_QEB_WINSPAN);
884 885 886 887 888 889 890 891
	if (ret < 0)
		return ret;

	/* read CR and check it */
	ret = read_cr(flash, &qeb_status);
	if (!(ret >= 0 && (qeb_status & STATUS_QEB_WINSPAN))) {
		printf("SF: Spansion CR Quad bit not clear\n");
		return -EINVAL;
892 893 894 895 896 897
	}

	return ret;
}
#endif

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
#ifdef CONFIG_SPI_FLASH_STMICRO
static int micron_quad_enable(struct spi_flash *flash)
{
	u8 qeb_status;
	int ret;

	ret = read_evcr(flash, &qeb_status);
	if (ret < 0)
		return ret;

	if (!(qeb_status & STATUS_QEB_MICRON))
		return 0;

	ret = write_evcr(flash, qeb_status & ~STATUS_QEB_MICRON);
	if (ret < 0)
		return ret;

	/* read EVCR and check it */
	ret = read_evcr(flash, &qeb_status);
	if (!(ret >= 0 && !(qeb_status & STATUS_QEB_MICRON))) {
		printf("SF: Micron EVCR Quad bit not clear\n");
		return -EINVAL;
	}

	return ret;
}
#endif

926
static int set_quad_mode(struct spi_flash *flash, u8 idcode0)
927 928 929 930
{
	switch (idcode0) {
#ifdef CONFIG_SPI_FLASH_MACRONIX
	case SPI_FLASH_CFI_MFR_MACRONIX:
931
		return macronix_quad_enable(flash);
932 933 934 935
#endif
#if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
	case SPI_FLASH_CFI_MFR_SPANSION:
	case SPI_FLASH_CFI_MFR_WINBOND:
936
		return spansion_quad_enable(flash);
937 938 939
#endif
#ifdef CONFIG_SPI_FLASH_STMICRO
	case SPI_FLASH_CFI_MFR_STMICRO:
940
		return micron_quad_enable(flash);
941 942 943 944 945 946 947 948 949 950
#endif
	default:
		printf("SF: Need set QEB func for %02x flash\n", idcode0);
		return -1;
	}
}

#if CONFIG_IS_ENABLED(OF_CONTROL)
int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
{
951
#ifdef CONFIG_DM_SPI_FLASH
952 953
	fdt_addr_t addr;
	fdt_size_t size;
954
	int node = flash->dev->of_offset;
955 956 957 958 959 960 961 962 963 964 965 966

	addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
	if (addr == FDT_ADDR_T_NONE) {
		debug("%s: Cannot decode address\n", __func__);
		return 0;
	}

	if (flash->size != size) {
		debug("%s: Memory map must cover entire device\n", __func__);
		return -1;
	}
	flash->memory_map = map_sysmem(addr, size);
967
#endif
968 969 970 971 972

	return 0;
}
#endif /* CONFIG_IS_ENABLED(OF_CONTROL) */

973
int spi_flash_scan(struct spi_flash *flash)
974
{
975
	struct spi_slave *spi = flash->spi;
976
	const struct spi_flash_params *params;
Jagan Teki's avatar
Jagan Teki committed
977
	u16 jedec, ext_jedec;
978
	u8 cmd, idcode[5];
979
	int ret;
980 981 982 983 984
	static u8 spi_read_cmds_array[] = {
		CMD_READ_ARRAY_SLOW,
		CMD_READ_ARRAY_FAST,
		CMD_READ_DUAL_OUTPUT_FAST,
		CMD_READ_QUAD_OUTPUT_FAST,
985
		CMD_READ_DUAL_IO_FAST,
986
		CMD_READ_QUAD_IO_FAST };
987

Jagan Teki's avatar
Jagan Teki committed
988 989 990 991
	/* Read the ID codes */
	ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
	if (ret) {
		printf("SF: Failed to get idcodes\n");
992
		return ret;
Jagan Teki's avatar
Jagan Teki committed
993 994 995 996 997 998 999 1000 1001 1002
	}

#ifdef DEBUG
	printf("SF: Got idcodes\n");
	print_buffer(0, idcode, 1, sizeof(idcode), 0);
#endif

	jedec = idcode[1] << 8 | idcode[2];
	ext_jedec = idcode[3] << 8 | idcode[4];

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
	/* Validate params from spi_flash_params table */
	params = spi_flash_params_table;
	for (; params->name != NULL; params++) {
		if ((params->jedec >> 16) == idcode[0]) {
			if ((params->jedec & 0xFFFF) == jedec) {
				if (params->ext_jedec == 0)
					break;
				else if (params->ext_jedec == ext_jedec)
					break;
			}
		}
	}

	if (!params->name) {
		printf("SF: Unsupported flash IDs: ");
		printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
		       idcode[0], jedec, ext_jedec);
		return -EPROTONOSUPPORT;
	}

	/* Flash powers up read-only, so clear BP# bits */
1024 1025 1026
	if (idcode[0] == SPI_FLASH_CFI_MFR_ATMEL ||
	    idcode[0] == SPI_FLASH_CFI_MFR_MACRONIX ||
	    idcode[0] == SPI_FLASH_CFI_MFR_SST)
1027
		write_sr(flash, 0);
1028 1029 1030 1031

	/* Assign spi data */
	flash->name = params->name;
	flash->memory_map = spi->memory_map;
1032
	flash->dual_flash = spi->option;
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042

	/* Assign spi flash flags */
	if (params->flags & SST_WR)
		flash->flags |= SNOR_F_SST_WR;

	/* Assign spi_flash ops */
#ifndef CONFIG_DM_SPI_FLASH
	flash->write = spi_flash_cmd_write_ops;
#if defined(CONFIG_SPI_FLASH_SST)
	if (flash->flags & SNOR_F_SST_WR) {
1043
		if (spi->mode & SPI_TX_BYTE)
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
			flash->write = sst_write_bp;
		else
			flash->write = sst_write_wp;
	}
#endif
	flash->erase = spi_flash_cmd_erase_ops;
	flash->read = spi_flash_cmd_read_ops;
#endif

	/* lock hooks are flash specific - assign them based on idcode0 */
	switch (idcode[0]) {
#if defined(CONFIG_SPI_FLASH_STMICRO) || defined(CONFIG_SPI_FLASH_SST)
	case SPI_FLASH_CFI_MFR_STMICRO:
	case SPI_FLASH_CFI_MFR_SST:
		flash->flash_lock = stm_lock;
		flash->flash_unlock = stm_unlock;
		flash->flash_is_locked = stm_is_locked;
#endif
		break;
	default:
		debug("SF: Lock ops not supported for %02x flash\n", idcode[0]);
	}

	/* Compute the flash size */
	flash->shift = (flash->dual_flash & SF_DUAL_PARALLEL_FLASH) ? 1 : 0;
	/*
	 * The Spansion S25FL032P and S25FL064P have 256b pages, yet use the
	 * 0x4d00 Extended JEDEC code. The rest of the Spansion flashes with
	 * the 0x4d00 Extended JEDEC code have 512b pages. All of the others
	 * have 256b pages.
	 */
	if (ext_jedec == 0x4d00) {
		if ((jedec == 0x0215) || (jedec == 0x216))
			flash->page_size = 256;
		else
			flash->page_size = 512;
	} else {
		flash->page_size = 256;
	}
	flash->page_size <<= flash->shift;
	flash->sector_size = params->sector_size << flash->shift;
	flash->size = flash->sector_size * params->nr_sectors << flash->shift;
#ifdef CONFIG_SF_DUAL_FLASH
	if (flash->dual_flash & SF_DUAL_STACKED_FLASH)
		flash->size <<= 1;
#endif

	/* Compute erase sector and command */
	if (params->flags & SECT_4K) {
		flash->erase_cmd = CMD_ERASE_4K;
		flash->erase_size = 4096 << flash->shift;
	} else if (params->flags & SECT_32K) {
		flash->erase_cmd = CMD_ERASE_32K;
		flash->erase_size = 32768 << flash->shift;
	} else {
		flash->erase_cmd = CMD_ERASE_64K;
		flash->erase_size = flash->sector_size;
	}

	/* Now erase size becomes valid sector size */
	flash->sector_size = flash->erase_size;

	/* Look for the fastest read cmd */