4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
6 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
8 * SPDX-License-Identifier: GPL-2.0+
15 #include <spi_flash.h>
17 #include <linux/compiler.h>
18 #include <linux/log2.h>
20 #include "sf_internal.h"
22 static void spi_flash_addr(u32 addr, u8 *cmd)
24 /* cmd[0] is actual command */
30 int spi_flash_cmd_read_status(struct spi_flash *flash, u8 *rs)
35 cmd = CMD_READ_STATUS;
36 ret = spi_flash_read_common(flash, &cmd, 1, rs, 1);
38 debug("SF: fail to read status register\n");
45 static int read_fsr(struct spi_flash *flash, u8 *fsr)
48 const u8 cmd = CMD_FLAG_STATUS;
50 ret = spi_flash_read_common(flash, &cmd, 1, fsr, 1);
52 debug("SF: fail to read flag status register\n");
59 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 ws)
64 cmd = CMD_WRITE_STATUS;
65 ret = spi_flash_write_common(flash, &cmd, 1, &ws, 1);
67 debug("SF: fail to write status register\n");
74 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
75 int spi_flash_cmd_read_config(struct spi_flash *flash, u8 *rc)
80 cmd = CMD_READ_CONFIG;
81 ret = spi_flash_read_common(flash, &cmd, 1, rc, 1);
83 debug("SF: fail to read config register\n");
90 int spi_flash_cmd_write_config(struct spi_flash *flash, u8 wc)
96 ret = spi_flash_cmd_read_status(flash, &data[0]);
100 cmd = CMD_WRITE_STATUS;
102 ret = spi_flash_write_common(flash, &cmd, 1, &data, 2);
104 debug("SF: fail to write config register\n");
112 #ifdef CONFIG_SPI_FLASH_BAR
113 static int spi_flash_write_bank(struct spi_flash *flash, u32 offset)
118 bank_sel = offset / (SPI_FLASH_16MB_BOUN << flash->shift);
119 if (bank_sel == flash->bank_curr)
122 cmd = flash->bank_write_cmd;
123 ret = spi_flash_write_common(flash, &cmd, 1, &bank_sel, 1);
125 debug("SF: fail to write bank register\n");
130 flash->bank_curr = bank_sel;
131 return flash->bank_curr;
135 #ifdef CONFIG_SF_DUAL_FLASH
136 static void spi_flash_dual_flash(struct spi_flash *flash, u32 *addr)
138 switch (flash->dual_flash) {
139 case SF_DUAL_STACKED_FLASH:
140 if (*addr >= (flash->size >> 1)) {
141 *addr -= flash->size >> 1;
142 flash->spi->flags |= SPI_XFER_U_PAGE;
144 flash->spi->flags &= ~SPI_XFER_U_PAGE;
147 case SF_DUAL_PARALLEL_FLASH:
148 *addr >>= flash->shift;
151 debug("SF: Unsupported dual_flash=%d\n", flash->dual_flash);
157 static int spi_flash_sr_ready(struct spi_flash *flash)
162 ret = spi_flash_cmd_read_status(flash, &sr);
166 return !(sr & STATUS_WIP);
169 static int spi_flash_fsr_ready(struct spi_flash *flash)
174 ret = read_fsr(flash, &fsr);
178 return fsr & STATUS_PEC;
181 static int spi_flash_ready(struct spi_flash *flash)
185 sr = spi_flash_sr_ready(flash);
190 if (flash->flags & SNOR_F_USE_FSR) {
191 fsr = spi_flash_fsr_ready(flash);
199 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout)
203 timebase = get_timer(0);
205 while (get_timer(timebase) < timeout) {
206 ret = spi_flash_ready(flash);
213 printf("SF: Timeout!\n");
218 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
219 size_t cmd_len, const void *buf, size_t buf_len)
221 struct spi_slave *spi = flash->spi;
222 unsigned long timeout = SPI_FLASH_PROG_TIMEOUT;
226 timeout = SPI_FLASH_PAGE_ERASE_TIMEOUT;
228 ret = spi_claim_bus(flash->spi);
230 debug("SF: unable to claim SPI bus\n");
234 ret = spi_flash_cmd_write_enable(flash);
236 debug("SF: enabling write failed\n");
240 ret = spi_flash_cmd_write(spi, cmd, cmd_len, buf, buf_len);
242 debug("SF: write cmd failed\n");
246 ret = spi_flash_cmd_wait_ready(flash, timeout);
248 debug("SF: write %s timed out\n",
249 timeout == SPI_FLASH_PROG_TIMEOUT ?
250 "program" : "page erase");
254 spi_release_bus(spi);
259 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len)
261 u32 erase_size, erase_addr;
262 u8 cmd[SPI_FLASH_CMD_LEN];
265 erase_size = flash->erase_size;
266 if (offset % erase_size || len % erase_size) {
267 debug("SF: Erase offset/length not multiple of erase size\n");
271 if (flash->flash_is_locked) {
272 if (flash->flash_is_locked(flash, offset, len) > 0) {
273 printf("offset 0x%x is protected and cannot be erased\n",
279 cmd[0] = flash->erase_cmd;
283 #ifdef CONFIG_SF_DUAL_FLASH
284 if (flash->dual_flash > SF_SINGLE_FLASH)
285 spi_flash_dual_flash(flash, &erase_addr);
287 #ifdef CONFIG_SPI_FLASH_BAR
288 ret = spi_flash_write_bank(flash, erase_addr);
292 spi_flash_addr(erase_addr, cmd);
294 debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1],
295 cmd[2], cmd[3], erase_addr);
297 ret = spi_flash_write_common(flash, cmd, sizeof(cmd), NULL, 0);
299 debug("SF: erase failed\n");
303 offset += erase_size;
310 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
311 size_t len, const void *buf)
313 unsigned long byte_addr, page_size;
315 size_t chunk_len, actual;
316 u8 cmd[SPI_FLASH_CMD_LEN];
319 page_size = flash->page_size;
321 if (flash->flash_is_locked) {
322 if (flash->flash_is_locked(flash, offset, len) > 0) {
323 printf("offset 0x%x is protected and cannot be written\n",
329 cmd[0] = flash->write_cmd;
330 for (actual = 0; actual < len; actual += chunk_len) {
333 #ifdef CONFIG_SF_DUAL_FLASH
334 if (flash->dual_flash > SF_SINGLE_FLASH)
335 spi_flash_dual_flash(flash, &write_addr);
337 #ifdef CONFIG_SPI_FLASH_BAR
338 ret = spi_flash_write_bank(flash, write_addr);
342 byte_addr = offset % page_size;
343 chunk_len = min(len - actual, (size_t)(page_size - byte_addr));
345 if (flash->spi->max_write_size)
346 chunk_len = min(chunk_len,
347 (size_t)flash->spi->max_write_size);
349 spi_flash_addr(write_addr, cmd);
351 debug("SF: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %zu\n",
352 buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
354 ret = spi_flash_write_common(flash, cmd, sizeof(cmd),
355 buf + actual, chunk_len);
357 debug("SF: write failed\n");
367 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
368 size_t cmd_len, void *data, size_t data_len)
370 struct spi_slave *spi = flash->spi;
373 ret = spi_claim_bus(flash->spi);
375 debug("SF: unable to claim SPI bus\n");
379 ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len);
381 debug("SF: read cmd failed\n");
385 spi_release_bus(spi);
390 void __weak spi_flash_copy_mmap(void *data, void *offset, size_t len)
392 memcpy(data, offset, len);
395 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
396 size_t len, void *data)
399 u32 remain_len, read_len, read_addr;
403 /* Handle memory-mapped SPI */
404 if (flash->memory_map) {
405 ret = spi_claim_bus(flash->spi);
407 debug("SF: unable to claim SPI bus\n");
410 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP);
411 spi_flash_copy_mmap(data, flash->memory_map + offset, len);
412 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP_END);
413 spi_release_bus(flash->spi);
417 cmdsz = SPI_FLASH_CMD_LEN + flash->dummy_byte;
418 cmd = calloc(1, cmdsz);
420 debug("SF: Failed to allocate cmd\n");
424 cmd[0] = flash->read_cmd;
428 #ifdef CONFIG_SF_DUAL_FLASH
429 if (flash->dual_flash > SF_SINGLE_FLASH)
430 spi_flash_dual_flash(flash, &read_addr);
432 #ifdef CONFIG_SPI_FLASH_BAR
433 ret = spi_flash_write_bank(flash, read_addr);
436 bank_sel = flash->bank_curr;
438 remain_len = ((SPI_FLASH_16MB_BOUN << flash->shift) *
439 (bank_sel + 1)) - offset;
440 if (len < remain_len)
443 read_len = remain_len;
445 spi_flash_addr(read_addr, cmd);
447 ret = spi_flash_read_common(flash, cmd, cmdsz, data, read_len);
449 debug("SF: read failed\n");
462 #ifdef CONFIG_SPI_FLASH_SST
463 static int sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
473 debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
474 spi_w8r8(flash->spi, CMD_READ_STATUS), buf, cmd[0], offset);
476 ret = spi_flash_cmd_write_enable(flash);
480 ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), buf, 1);
484 return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
487 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
490 size_t actual, cmd_len;
494 ret = spi_claim_bus(flash->spi);
496 debug("SF: Unable to claim SPI bus\n");
500 /* If the data is not word aligned, write out leading single byte */
503 ret = sst_byte_write(flash, offset, buf);
509 ret = spi_flash_cmd_write_enable(flash);
514 cmd[0] = CMD_SST_AAI_WP;
515 cmd[1] = offset >> 16;
516 cmd[2] = offset >> 8;
519 for (; actual < len - 1; actual += 2) {
520 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
521 spi_w8r8(flash->spi, CMD_READ_STATUS), buf + actual,
524 ret = spi_flash_cmd_write(flash->spi, cmd, cmd_len,
527 debug("SF: sst word program failed\n");
531 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
540 ret = spi_flash_cmd_write_disable(flash);
542 /* If there is a single trailing byte, write it out */
543 if (!ret && actual != len)
544 ret = sst_byte_write(flash, offset, buf + actual);
547 debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
548 ret ? "failure" : "success", len, offset - actual);
550 spi_release_bus(flash->spi);
554 int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
560 ret = spi_claim_bus(flash->spi);
562 debug("SF: Unable to claim SPI bus\n");
566 for (actual = 0; actual < len; actual++) {
567 ret = sst_byte_write(flash, offset, buf + actual);
569 debug("SF: sst byte program failed\n");
576 ret = spi_flash_cmd_write_disable(flash);
578 debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
579 ret ? "failure" : "success", len, offset - actual);
581 spi_release_bus(flash->spi);
586 #ifdef CONFIG_SPI_FLASH_STMICRO
587 static void stm_get_locked_range(struct spi_flash *flash, u8 sr, loff_t *ofs,
590 u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
591 int shift = ffs(mask) - 1;
599 pow = ((sr & mask) ^ mask) >> shift;
600 *len = flash->size >> pow;
601 *ofs = flash->size - *len;
606 * Return 1 if the entire region is locked, 0 otherwise
608 static int stm_is_locked_sr(struct spi_flash *flash, u32 ofs, u32 len,
614 stm_get_locked_range(flash, sr, &lock_offs, &lock_len);
616 return (ofs + len <= lock_offs + lock_len) && (ofs >= lock_offs);
620 * Check if a region of the flash is (completely) locked. See stm_lock() for
623 * Returns 1 if entire region is locked, 0 if any portion is unlocked, and
624 * negative on errors.
626 int stm_is_locked(struct spi_flash *flash, u32 ofs, size_t len)
631 status = spi_flash_cmd_read_status(flash, &sr);
635 return stm_is_locked_sr(flash, ofs, len, sr);
639 * Lock a region of the flash. Compatible with ST Micro and similar flash.
640 * Supports only the block protection bits BP{0,1,2} in the status register
641 * (SR). Does not support these features found in newer SR bitfields:
642 * - TB: top/bottom protect - only handle TB=0 (top protect)
643 * - SEC: sector/block protect - only handle SEC=0 (block protect)
644 * - CMP: complement protect - only support CMP=0 (range is not complemented)
646 * Sample table portion for 8MB flash (Winbond w25q64fw):
648 * SEC | TB | BP2 | BP1 | BP0 | Prot Length | Protected Portion
649 * --------------------------------------------------------------------------
650 * X | X | 0 | 0 | 0 | NONE | NONE
651 * 0 | 0 | 0 | 0 | 1 | 128 KB | Upper 1/64
652 * 0 | 0 | 0 | 1 | 0 | 256 KB | Upper 1/32
653 * 0 | 0 | 0 | 1 | 1 | 512 KB | Upper 1/16
654 * 0 | 0 | 1 | 0 | 0 | 1 MB | Upper 1/8
655 * 0 | 0 | 1 | 0 | 1 | 2 MB | Upper 1/4
656 * 0 | 0 | 1 | 1 | 0 | 4 MB | Upper 1/2
657 * X | X | 1 | 1 | 1 | 8 MB | ALL
659 * Returns negative on errors, 0 on success.
661 int stm_lock(struct spi_flash *flash, u32 ofs, size_t len)
663 u8 status_old, status_new;
664 u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
665 u8 shift = ffs(mask) - 1, pow, val;
667 spi_flash_cmd_read_status(flash, &status_old);
669 /* SPI NOR always locks to the end */
670 if (ofs + len != flash->size) {
671 /* Does combined region extend to end? */
672 if (!stm_is_locked_sr(flash, ofs + len, flash->size - ofs - len,
675 len = flash->size - ofs;
679 * Need smallest pow such that:
681 * 1 / (2^pow) <= (len / size)
683 * so (assuming power-of-2 size) we do:
685 * pow = ceil(log2(size / len)) = log2(size) - floor(log2(len))
687 pow = ilog2(flash->size) - ilog2(len);
688 val = mask - (pow << shift);
692 /* Don't "lock" with no region! */
696 status_new = (status_old & ~mask) | val;
698 /* Only modify protection if it will not unlock other areas */
699 if ((status_new & mask) <= (status_old & mask))
702 spi_flash_cmd_write_status(flash, status_new);
708 * Unlock a region of the flash. See stm_lock() for more info
710 * Returns negative on errors, 0 on success.
712 int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len)
714 uint8_t status_old, status_new;
715 u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
716 u8 shift = ffs(mask) - 1, pow, val;
718 spi_flash_cmd_read_status(flash, &status_old);
720 /* Cannot unlock; would unlock larger region than requested */
721 if (stm_is_locked_sr(flash, status_old, ofs - flash->erase_size,
725 * Need largest pow such that:
727 * 1 / (2^pow) >= (len / size)
729 * so (assuming power-of-2 size) we do:
731 * pow = floor(log2(size / len)) = log2(size) - ceil(log2(len))
733 pow = ilog2(flash->size) - order_base_2(flash->size - (ofs + len));
734 if (ofs + len == flash->size) {
735 val = 0; /* fully unlocked */
737 val = mask - (pow << shift);
738 /* Some power-of-two sizes are not supported */
743 status_new = (status_old & ~mask) | val;
745 /* Only modify protection if it will not lock other areas */
746 if ((status_new & mask) >= (status_old & mask))
749 spi_flash_cmd_write_status(flash, status_new);
753 #endif /* CONFIG_SPI_FLASH_STMICRO */