drivers/mtd/spi/sf_internal.h

   1 /*
   2  * SPI flash internal definitions
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   6  *
   7  * SPDX-License-Identifier:     GPL-2.0+
   8  */
   9
  10 #ifndef _SF_INTERNAL_H_
  11 #define _SF_INTERNAL_H_
  12
  13 #include <linux/types.h>
  14 #include <linux/compiler.h>
  15
  16 /* Dual SPI flash memories - see SPI_COMM_DUAL_... */
  17 enum spi_dual_flash {
  18         SF_SINGLE_FLASH = 0,
  19         SF_DUAL_STACKED_FLASH   = BIT(0),
  20         SF_DUAL_PARALLEL_FLASH  = BIT(1),
  21 };
  22
  23 /* sf param flags */
  24 enum {
  25 #ifndef CONFIG_SPI_FLASH_USE_4K_SECTORS
  26         SECT_4K         = 0,
  27 #else
  28         SECT_4K         = BIT(0),
  29 #endif
  30         SECT_32K        = BIT(1),
  31         E_FSR           = BIT(2),
  32         SST_WR          = BIT(3),
  33         WR_QPP          = BIT(4),
  34         RD_QUAD         = BIT(5),
  35         RD_DUAL         = BIT(6),
  36         RD_QUADIO       = BIT(7),
  37         RD_DUALIO       = BIT(8),
  38 };
  39 #define RD_FULL         RD_QUAD | RD_DUAL | RD_QUADIO | RD_DUALIO
  40
  41 enum spi_nor_option_flags {
  42         SNOR_F_SST_WR           = BIT(0),
  43         SNOR_F_USE_FSR          = BIT(1),
  44 };
  45
  46 #define SPI_FLASH_3B_ADDR_LEN           3
  47 #define SPI_FLASH_CMD_LEN               (1 + SPI_FLASH_3B_ADDR_LEN)
  48 #define SPI_FLASH_16MB_BOUN             0x1000000
  49
  50 /* CFI Manufacture ID's */
  51 #define SPI_FLASH_CFI_MFR_SPANSION      0x01
  52 #define SPI_FLASH_CFI_MFR_STMICRO       0x20
  53 #define SPI_FLASH_CFI_MFR_MACRONIX      0xc2
  54 #define SPI_FLASH_CFI_MFR_SST           0xbf
  55 #define SPI_FLASH_CFI_MFR_WINBOND       0xef
  56 #define SPI_FLASH_CFI_MFR_ATMEL         0x1f
  57
  58 /* Erase commands */
  59 #define CMD_ERASE_4K                    0x20
  60 #define CMD_ERASE_32K                   0x52
  61 #define CMD_ERASE_CHIP                  0xc7
  62 #define CMD_ERASE_64K                   0xd8
  63
  64 /* Write commands */
  65 #define CMD_WRITE_STATUS                0x01
  66 #define CMD_PAGE_PROGRAM                0x02
  67 #define CMD_WRITE_DISABLE               0x04
  68 #define CMD_WRITE_ENABLE                0x06
  69 #define CMD_QUAD_PAGE_PROGRAM           0x32
  70 #define CMD_WRITE_EVCR                  0x61
  71
  72 /* Read commands */
  73 #define CMD_READ_ARRAY_SLOW             0x03
  74 #define CMD_READ_ARRAY_FAST             0x0b
  75 #define CMD_READ_DUAL_OUTPUT_FAST       0x3b
  76 #define CMD_READ_DUAL_IO_FAST           0xbb
  77 #define CMD_READ_QUAD_OUTPUT_FAST       0x6b
  78 #define CMD_READ_QUAD_IO_FAST           0xeb
  79 #define CMD_READ_ID                     0x9f
  80 #define CMD_READ_STATUS                 0x05
  81 #define CMD_READ_STATUS1                0x35
  82 #define CMD_READ_CONFIG                 0x35
  83 #define CMD_FLAG_STATUS                 0x70
  84 #define CMD_READ_EVCR                   0x65
  85
  86 /* Bank addr access commands */
  87 #ifdef CONFIG_SPI_FLASH_BAR
  88 # define CMD_BANKADDR_BRWR              0x17
  89 # define CMD_BANKADDR_BRRD              0x16
  90 # define CMD_EXTNADDR_WREAR             0xC5
  91 # define CMD_EXTNADDR_RDEAR             0xC8
  92 #endif
  93
  94 /* Common status */
  95 #define STATUS_WIP                      BIT(0)
  96 #define STATUS_QEB_WINSPAN              BIT(1)
  97 #define STATUS_QEB_MXIC                 BIT(6)
  98 #define STATUS_PEC                      BIT(7)
  99 #define STATUS_QEB_MICRON               BIT(7)
 100 #define SR_BP0                          BIT(2)  /* Block protect 0 */
 101 #define SR_BP1                          BIT(3)  /* Block protect 1 */
 102 #define SR_BP2                          BIT(4)  /* Block protect 2 */
 103
 104 /* Flash timeout values */
 105 #define SPI_FLASH_PROG_TIMEOUT          (2 * CONFIG_SYS_HZ)
 106 #define SPI_FLASH_PAGE_ERASE_TIMEOUT    (5 * CONFIG_SYS_HZ)
 107 #define SPI_FLASH_SECTOR_ERASE_TIMEOUT  (10 * CONFIG_SYS_HZ)
 108
 109 /* SST specific */
 110 #ifdef CONFIG_SPI_FLASH_SST
 111 # define CMD_SST_BP             0x02    /* Byte Program */
 112 # define CMD_SST_AAI_WP         0xAD    /* Auto Address Incr Word Program */
 113
 114 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
 115                 const void *buf);
 116 int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
 117                 const void *buf);
 118 #endif
 119
 120 #ifdef CONFIG_SPI_FLASH_SPANSION
 121 /* Used for Spansion S25FS-S family flash only. */
 122 #define CMD_SPANSION_RDAR       0x65 /* Read any device register */
 123 #define CMD_SPANSION_WRAR       0x71 /* Write any device register */
 124 #endif
 125 /**
 126  * struct spi_flash_params - SPI/QSPI flash device params structure
 127  *
 128  * @name:               Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
 129  * @jedec:              Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
 130  * @ext_jedec:          Device ext_jedec ID
 131  * @sector_size:        Isn't necessarily a sector size from vendor,
 132  *                      the size listed here is what works with CMD_ERASE_64K
 133  * @nr_sectors:         No.of sectors on this device
 134  * @flags:              Important param, for flash specific behaviour
 135  */
 136 struct spi_flash_params {
 137         const char *name;
 138         u32 jedec;
 139         u16 ext_jedec;
 140         u32 sector_size;
 141         u32 nr_sectors;
 142         u16 flags;
 143 };
 144
 145 extern const struct spi_flash_params spi_flash_params_table[];
 146
 147 /* Send a single-byte command to the device and read the response */
 148 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
 149
 150 /*
 151  * Send a multi-byte command to the device and read the response. Used
 152  * for flash array reads, etc.
 153  */
 154 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
 155                 size_t cmd_len, void *data, size_t data_len);
 156
 157 /*
 158  * Send a multi-byte command to the device followed by (optional)
 159  * data. Used for programming the flash array, etc.
 160  */
 161 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
 162                 const void *data, size_t data_len);
 163
 164
 165 /* Flash erase(sectors) operation, support all possible erase commands */
 166 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len);
 167
 168 /* Lock stmicro spi flash region */
 169 int stm_lock(struct spi_flash *flash, u32 ofs, size_t len);
 170
 171 /* Unlock stmicro spi flash region */
 172 int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len);
 173
 174 /* Check if a stmicro spi flash region is completely locked */
 175 int stm_is_locked(struct spi_flash *flash, u32 ofs, size_t len);
 176
 177 /* Enable writing on the SPI flash */
 178 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
 179 {
 180         return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
 181 }
 182
 183 /* Disable writing on the SPI flash */
 184 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
 185 {
 186         return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
 187 }
 188
 189 /*
 190  * Used for spi_flash write operation
 191  * - SPI claim
 192  * - spi_flash_cmd_write_enable
 193  * - spi_flash_cmd_write
 194  * - spi_flash_cmd_wait_ready
 195  * - SPI release
 196  */
 197 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
 198                 size_t cmd_len, const void *buf, size_t buf_len);
 199
 200 /*
 201  * Flash write operation, support all possible write commands.
 202  * Write the requested data out breaking it up into multiple write
 203  * commands as needed per the write size.
 204  */
 205 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
 206                 size_t len, const void *buf);
 207
 208 /*
 209  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
 210  * bus. Used as common part of the ->read() operation.
 211  */
 212 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
 213                 size_t cmd_len, void *data, size_t data_len);
 214
 215 /* Flash read operation, support all possible read commands */
 216 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
 217                 size_t len, void *data);
 218
 219 #ifdef CONFIG_SPI_FLASH_MTD
 220 int spi_flash_mtd_register(struct spi_flash *flash);
 221 void spi_flash_mtd_unregister(void);
 222 #endif
 223
 224 /**
 225  * spi_flash_scan - scan the SPI FLASH
 226  * @flash:      the spi flash structure
 227  *
 228  * The drivers can use this fuction to scan the SPI FLASH.
 229  * In the scanning, it will try to get all the necessary information to
 230  * fill the spi_flash{}.
 231  *
 232  * Return: 0 for success, others for failure.
 233  */
 234 int spi_flash_scan(struct spi_flash *flash);
 235
 236 #endif /* _SF_INTERNAL_H_ */