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