/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * Driver for SST serial flashes */ #include <console/console.h> #include <commonlib/helpers.h> #include <spi_flash.h> #include <spi-generic.h> #include "spi_flash_internal.h" #define CMD_SST_WREN 0x06 /* Write Enable */ #define CMD_SST_WRDI 0x04 /* Write Disable */ #define CMD_SST_RDSR 0x05 /* Read Status Register */ #define CMD_SST_WRSR 0x01 /* Write Status Register */ #define CMD_SST_EWSR 0x50 /* Enable Write Status Register */ #define CMD_SST_READ 0x03 /* Read Data Bytes */ #define CMD_SST_FAST_READ 0x0b /* Read Data Bytes at Higher Speed */ #define CMD_SST_BP 0x02 /* Byte Program */ #define CMD_SST_PP 0x02 /* Page Program */ #define CMD_SST_AAI_WP 0xAD /* Auto Address Increment Word Program */ #define CMD_SST_SE 0x20 /* Sector Erase */ #define SST_SR_WIP (1 << 0) /* Write-in-Progress */ #define SST_SR_WEL (1 << 1) /* Write enable */ #define SST_SR_BP0 (1 << 2) /* Block Protection 0 */ #define SST_SR_BP1 (1 << 3) /* Block Protection 1 */ #define SST_SR_BP2 (1 << 4) /* Block Protection 2 */ #define SST_SR_AAI (1 << 6) /* Addressing mode */ #define SST_SR_BPL (1 << 7) /* BP bits lock */ static const struct spi_flash_part_id flash_table_ai[] = { { /* SST25VF040B */ .id[0] = 0x8d, .nr_sectors_shift = 7, },{ /* SST25VF080B */ .id[0] = 0x8e, .nr_sectors_shift = 8, },{ /* SST25VF080 */ .id[0] = 0x80, .nr_sectors_shift = 8, },{ /* SST25VF016B */ .id[0] = 0x41, .nr_sectors_shift = 9, },{ /* SST25VF032B */ .id[0] = 0x4a, .nr_sectors_shift = 10, },{ /* SST25WF512 */ .id[0] = 0x01, .nr_sectors_shift = 4, },{ /* SST25WF010 */ .id[0] = 0x02, .nr_sectors_shift = 5, },{ /* SST25WF020 */ .id[0] = 0x03, .nr_sectors_shift = 6, },{ /* SST25WF040 */ .id[0] = 0x04, .nr_sectors_shift = 7, },{ /* SST25WF080 */ .id[0] = 0x05, .nr_sectors_shift = 8, },{ /* SST25WF080B */ .id[0] = 0x14, .nr_sectors_shift = 8, }, }; static const struct spi_flash_part_id flash_table_pp256[] = { { /* SST25VF064C */ .id[0] = 0x4b, .nr_sectors_shift = 11, }, }; static int sst_enable_writing(const struct spi_flash *flash) { int ret = spi_flash_cmd(&flash->spi, CMD_SST_WREN, NULL, 0); if (ret) printk(BIOS_WARNING, "SF: Enabling Write failed\n"); return ret; } static int sst_enable_writing_status(const struct spi_flash *flash) { int ret = spi_flash_cmd(&flash->spi, CMD_SST_EWSR, NULL, 0); if (ret) printk(BIOS_WARNING, "SF: Enabling Write Status failed\n"); return ret; } static int sst_disable_writing(const struct spi_flash *flash) { int ret = spi_flash_cmd(&flash->spi, CMD_SST_WRDI, NULL, 0); if (ret) printk(BIOS_WARNING, "SF: Disabling Write failed\n"); return ret; } static int sst_byte_write(const struct spi_flash *flash, u32 offset, const void *buf) { int ret; u8 cmd[4] = { CMD_SST_BP, offset >> 16, offset >> 8, offset, }; #if CONFIG(DEBUG_SPI_FLASH) printk(BIOS_SPEW, "BP[%02x]: %p => cmd = { 0x%02x 0x%06x }\n", spi_w8r8(&flash->spi, CMD_SST_RDSR), buf, cmd[0], offset); #endif ret = sst_enable_writing(flash); if (ret) return ret; ret = spi_flash_cmd_write(&flash->spi, cmd, sizeof(cmd), buf, 1); if (ret) return ret; return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT_MS); } static int sst_write_ai(const struct spi_flash *flash, u32 offset, size_t len, const void *buf) { size_t actual, cmd_len; int ret = 0; u8 cmd[4]; /* 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 = sst_enable_writing(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) { #if CONFIG(DEBUG_SPI_FLASH) printk(BIOS_SPEW, "WP[%02x]: %p => cmd = { 0x%02x 0x%06x }\n", spi_w8r8(&flash->spi, CMD_SST_RDSR), buf + actual, cmd[0], offset); #endif ret = spi_flash_cmd_write(&flash->spi, cmd, cmd_len, buf + actual, 2); if (ret) { printk(BIOS_WARNING, "SF: SST word program failed\n"); break; } ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT_MS); if (ret) break; cmd_len = 1; offset += 2; } if (!ret) ret = sst_disable_writing(flash); /* If there is a single trailing byte, write it out */ if (!ret && actual != len) ret = sst_byte_write(flash, offset, buf + actual); done: #if CONFIG(DEBUG_SPI_FLASH) printk(BIOS_SPEW, "SF: SST: program %s %zu bytes @ 0x%lx\n", ret ? "failure" : "success", len, (unsigned long)offset - actual); #endif return ret; } /* Flash powers up read-only, so clear BP# bits */ static int sst_unlock(const struct spi_flash *flash) { int ret; u8 cmd, status; ret = sst_enable_writing_status(flash); if (ret) return ret; cmd = CMD_SST_WRSR; status = 0; ret = spi_flash_cmd_write(&flash->spi, &cmd, 1, &status, 1); if (ret) printk(BIOS_WARNING, "SF: Unable to set status byte\n"); printk(BIOS_INFO, "SF: SST: status = %x\n", spi_w8r8(&flash->spi, CMD_SST_RDSR)); return ret; } static const struct spi_flash_ops_descriptor descai = { .erase_cmd = CMD_SST_SE, .status_cmd = CMD_SST_RDSR, .wren_cmd = CMD_SST_WREN, .ops = { .read = spi_flash_cmd_read, .write = sst_write_ai, .erase = spi_flash_cmd_erase, .status = spi_flash_cmd_status, }, }; const struct spi_flash_vendor_info spi_flash_sst_ai_vi = { .id = VENDOR_ID_SST, .sector_size_kib_shift = 2, .match_id_mask[0] = 0xff, .ids = flash_table_ai, .nr_part_ids = ARRAY_SIZE(flash_table_ai), .desc = &descai, .after_probe = sst_unlock, }; const struct spi_flash_vendor_info spi_flash_sst_vi = { .id = VENDOR_ID_SST, .page_size_shift = 8, .sector_size_kib_shift = 2, .match_id_mask[0] = 0xff, .ids = flash_table_pp256, .nr_part_ids = ARRAY_SIZE(flash_table_pp256), .desc = &spi_flash_pp_0x20_sector_desc, .after_probe = sst_unlock, };