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