drivers/mtd/spi-nor/core.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2005, Intec Automation Inc.
   4  * Copyright (C) 2014, Freescale Semiconductor, Inc.
   5  */
   6
   7 #ifndef __LINUX_MTD_SPI_NOR_INTERNAL_H
   8 #define __LINUX_MTD_SPI_NOR_INTERNAL_H
   9
  10 #include "sfdp.h"
  11
  12 #define SPI_NOR_MAX_ID_LEN      6
  13
  14 /* Standard SPI NOR flash operations. */
  15 #define SPI_NOR_READID_OP(naddr, ndummy, buf, len)                      \
  16         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_RDID, 0),                   \
  17                    SPI_MEM_OP_ADDR(naddr, 0, 0),                        \
  18                    SPI_MEM_OP_DUMMY(ndummy, 0),                         \
  19                    SPI_MEM_OP_DATA_IN(len, buf, 0))
  20
  21 #define SPI_NOR_WREN_OP                                                 \
  22         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_WREN, 0),                   \
  23                    SPI_MEM_OP_NO_ADDR,                                  \
  24                    SPI_MEM_OP_NO_DUMMY,                                 \
  25                    SPI_MEM_OP_NO_DATA)
  26
  27 #define SPI_NOR_WRDI_OP                                                 \
  28         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_WRDI, 0),                   \
  29                    SPI_MEM_OP_NO_ADDR,                                  \
  30                    SPI_MEM_OP_NO_DUMMY,                                 \
  31                    SPI_MEM_OP_NO_DATA)
  32
  33 #define SPI_NOR_RDSR_OP(buf)                                            \
  34         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_RDSR, 0),                   \
  35                    SPI_MEM_OP_NO_ADDR,                                  \
  36                    SPI_MEM_OP_NO_DUMMY,                                 \
  37                    SPI_MEM_OP_DATA_IN(1, buf, 0))
  38
  39 #define SPI_NOR_WRSR_OP(buf, len)                                       \
  40         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_WRSR, 0),                   \
  41                    SPI_MEM_OP_NO_ADDR,                                  \
  42                    SPI_MEM_OP_NO_DUMMY,                                 \
  43                    SPI_MEM_OP_DATA_OUT(len, buf, 0))
  44
  45 #define SPI_NOR_RDSR2_OP(buf)                                           \
  46         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_RDSR2, 0),                  \
  47                    SPI_MEM_OP_NO_ADDR,                                  \
  48                    SPI_MEM_OP_NO_DUMMY,                                 \
  49                    SPI_MEM_OP_DATA_OUT(1, buf, 0))
  50
  51 #define SPI_NOR_WRSR2_OP(buf)                                           \
  52         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_WRSR2, 0),                  \
  53                    SPI_MEM_OP_NO_ADDR,                                  \
  54                    SPI_MEM_OP_NO_DUMMY,                                 \
  55                    SPI_MEM_OP_DATA_OUT(1, buf, 0))
  56
  57 #define SPI_NOR_RDCR_OP(buf)                                            \
  58         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_RDCR, 0),                   \
  59                    SPI_MEM_OP_NO_ADDR,                                  \
  60                    SPI_MEM_OP_NO_DUMMY,                                 \
  61                    SPI_MEM_OP_DATA_IN(1, buf, 0))
  62
  63 #define SPI_NOR_EN4B_EX4B_OP(enable)                                    \
  64         SPI_MEM_OP(SPI_MEM_OP_CMD(enable ? SPINOR_OP_EN4B : SPINOR_OP_EX4B, 0), \
  65                    SPI_MEM_OP_NO_ADDR,                                  \
  66                    SPI_MEM_OP_NO_DUMMY,                                 \
  67                    SPI_MEM_OP_NO_DATA)
  68
  69 #define SPI_NOR_BRWR_OP(buf)                                            \
  70         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_BRWR, 0),                   \
  71                    SPI_MEM_OP_NO_ADDR,                                  \
  72                    SPI_MEM_OP_NO_DUMMY,                                 \
  73                    SPI_MEM_OP_DATA_OUT(1, buf, 0))
  74
  75 #define SPI_NOR_GBULK_OP                                                \
  76         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_GBULK, 0),                  \
  77                    SPI_MEM_OP_NO_ADDR,                                  \
  78                    SPI_MEM_OP_NO_DUMMY,                                 \
  79                    SPI_MEM_OP_NO_DATA)
  80
  81 #define SPI_NOR_CHIP_ERASE_OP                                           \
  82         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_CHIP_ERASE, 0),             \
  83                    SPI_MEM_OP_NO_ADDR,                                  \
  84                    SPI_MEM_OP_NO_DUMMY,                                 \
  85                    SPI_MEM_OP_NO_DATA)
  86
  87 #define SPI_NOR_SECTOR_ERASE_OP(opcode, addr_nbytes, addr)              \
  88         SPI_MEM_OP(SPI_MEM_OP_CMD(opcode, 0),                           \
  89                    SPI_MEM_OP_ADDR(addr_nbytes, addr, 0),               \
  90                    SPI_MEM_OP_NO_DUMMY,                                 \
  91                    SPI_MEM_OP_NO_DATA)
  92
  93 #define SPI_NOR_READ_OP(opcode)                                         \
  94         SPI_MEM_OP(SPI_MEM_OP_CMD(opcode, 0),                           \
  95                    SPI_MEM_OP_ADDR(3, 0, 0),                            \
  96                    SPI_MEM_OP_DUMMY(1, 0),                              \
  97                    SPI_MEM_OP_DATA_IN(2, NULL, 0))
  98
  99 #define SPI_NOR_PP_OP(opcode)                                           \
 100         SPI_MEM_OP(SPI_MEM_OP_CMD(opcode, 0),                           \
 101                    SPI_MEM_OP_ADDR(3, 0, 0),                            \
 102                    SPI_MEM_OP_NO_DUMMY,                                 \
 103                    SPI_MEM_OP_DATA_OUT(2, NULL, 0))
 104
 105 #define SPINOR_SRSTEN_OP                                                \
 106         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_SRSTEN, 0),                 \
 107                    SPI_MEM_OP_NO_DUMMY,                                 \
 108                    SPI_MEM_OP_NO_ADDR,                                  \
 109                    SPI_MEM_OP_NO_DATA)
 110
 111 #define SPINOR_SRST_OP                                                  \
 112         SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_SRST, 0),                   \
 113                    SPI_MEM_OP_NO_DUMMY,                                 \
 114                    SPI_MEM_OP_NO_ADDR,                                  \
 115                    SPI_MEM_OP_NO_DATA)
 116
 117 /* Keep these in sync with the list in debugfs.c */
 118 enum spi_nor_option_flags {
 119         SNOR_F_HAS_SR_TB        = BIT(0),
 120         SNOR_F_NO_OP_CHIP_ERASE = BIT(1),
 121         SNOR_F_BROKEN_RESET     = BIT(2),
 122         SNOR_F_4B_OPCODES       = BIT(3),
 123         SNOR_F_HAS_4BAIT        = BIT(4),
 124         SNOR_F_HAS_LOCK         = BIT(5),
 125         SNOR_F_HAS_16BIT_SR     = BIT(6),
 126         SNOR_F_NO_READ_CR       = BIT(7),
 127         SNOR_F_HAS_SR_TB_BIT6   = BIT(8),
 128         SNOR_F_HAS_4BIT_BP      = BIT(9),
 129         SNOR_F_HAS_SR_BP3_BIT6  = BIT(10),
 130         SNOR_F_IO_MODE_EN_VOLATILE = BIT(11),
 131         SNOR_F_SOFT_RESET       = BIT(12),
 132         SNOR_F_SWP_IS_VOLATILE  = BIT(13),
 133         SNOR_F_RWW              = BIT(14),
 134         SNOR_F_ECC              = BIT(15),
 135 };
 136
 137 struct spi_nor_read_command {
 138         u8                      num_mode_clocks;
 139         u8                      num_wait_states;
 140         u8                      opcode;
 141         enum spi_nor_protocol   proto;
 142 };
 143
 144 struct spi_nor_pp_command {
 145         u8                      opcode;
 146         enum spi_nor_protocol   proto;
 147 };
 148
 149 enum spi_nor_read_command_index {
 150         SNOR_CMD_READ,
 151         SNOR_CMD_READ_FAST,
 152         SNOR_CMD_READ_1_1_1_DTR,
 153
 154         /* Dual SPI */
 155         SNOR_CMD_READ_1_1_2,
 156         SNOR_CMD_READ_1_2_2,
 157         SNOR_CMD_READ_2_2_2,
 158         SNOR_CMD_READ_1_2_2_DTR,
 159
 160         /* Quad SPI */
 161         SNOR_CMD_READ_1_1_4,
 162         SNOR_CMD_READ_1_4_4,
 163         SNOR_CMD_READ_4_4_4,
 164         SNOR_CMD_READ_1_4_4_DTR,
 165
 166         /* Octal SPI */
 167         SNOR_CMD_READ_1_1_8,
 168         SNOR_CMD_READ_1_8_8,
 169         SNOR_CMD_READ_8_8_8,
 170         SNOR_CMD_READ_1_8_8_DTR,
 171         SNOR_CMD_READ_8_8_8_DTR,
 172
 173         SNOR_CMD_READ_MAX
 174 };
 175
 176 enum spi_nor_pp_command_index {
 177         SNOR_CMD_PP,
 178
 179         /* Quad SPI */
 180         SNOR_CMD_PP_1_1_4,
 181         SNOR_CMD_PP_1_4_4,
 182         SNOR_CMD_PP_4_4_4,
 183
 184         /* Octal SPI */
 185         SNOR_CMD_PP_1_1_8,
 186         SNOR_CMD_PP_1_8_8,
 187         SNOR_CMD_PP_8_8_8,
 188         SNOR_CMD_PP_8_8_8_DTR,
 189
 190         SNOR_CMD_PP_MAX
 191 };
 192
 193 /**
 194  * struct spi_nor_erase_type - Structure to describe a SPI NOR erase type
 195  * @size:               the size of the sector/block erased by the erase type.
 196  *                      JEDEC JESD216B imposes erase sizes to be a power of 2.
 197  * @size_shift:         @size is a power of 2, the shift is stored in
 198  *                      @size_shift.
 199  * @size_mask:          the size mask based on @size_shift.
 200  * @opcode:             the SPI command op code to erase the sector/block.
 201  * @idx:                Erase Type index as sorted in the Basic Flash Parameter
 202  *                      Table. It will be used to synchronize the supported
 203  *                      Erase Types with the ones identified in the SFDP
 204  *                      optional tables.
 205  */
 206 struct spi_nor_erase_type {
 207         u32     size;
 208         u32     size_shift;
 209         u32     size_mask;
 210         u8      opcode;
 211         u8      idx;
 212 };
 213
 214 /**
 215  * struct spi_nor_erase_command - Used for non-uniform erases
 216  * The structure is used to describe a list of erase commands to be executed
 217  * once we validate that the erase can be performed. The elements in the list
 218  * are run-length encoded.
 219  * @list:               for inclusion into the list of erase commands.
 220  * @count:              how many times the same erase command should be
 221  *                      consecutively used.
 222  * @size:               the size of the sector/block erased by the command.
 223  * @opcode:             the SPI command op code to erase the sector/block.
 224  */
 225 struct spi_nor_erase_command {
 226         struct list_head        list;
 227         u32                     count;
 228         u32                     size;
 229         u8                      opcode;
 230 };
 231
 232 /**
 233  * struct spi_nor_erase_region - Structure to describe a SPI NOR erase region
 234  * @offset:             the offset in the data array of erase region start.
 235  *                      LSB bits are used as a bitmask encoding flags to
 236  *                      determine if this region is overlaid, if this region is
 237  *                      the last in the SPI NOR flash memory and to indicate
 238  *                      all the supported erase commands inside this region.
 239  *                      The erase types are sorted in ascending order with the
 240  *                      smallest Erase Type size being at BIT(0).
 241  * @size:               the size of the region in bytes.
 242  */
 243 struct spi_nor_erase_region {
 244         u64             offset;
 245         u64             size;
 246 };
 247
 248 #define SNOR_ERASE_TYPE_MAX     4
 249 #define SNOR_ERASE_TYPE_MASK    GENMASK_ULL(SNOR_ERASE_TYPE_MAX - 1, 0)
 250
 251 #define SNOR_LAST_REGION        BIT(4)
 252 #define SNOR_OVERLAID_REGION    BIT(5)
 253
 254 #define SNOR_ERASE_FLAGS_MAX    6
 255 #define SNOR_ERASE_FLAGS_MASK   GENMASK_ULL(SNOR_ERASE_FLAGS_MAX - 1, 0)
 256
 257 /**
 258  * struct spi_nor_erase_map - Structure to describe the SPI NOR erase map
 259  * @regions:            array of erase regions. The regions are consecutive in
 260  *                      address space. Walking through the regions is done
 261  *                      incrementally.
 262  * @uniform_region:     a pre-allocated erase region for SPI NOR with a uniform
 263  *                      sector size (legacy implementation).
 264  * @erase_type:         an array of erase types shared by all the regions.
 265  *                      The erase types are sorted in ascending order, with the
 266  *                      smallest Erase Type size being the first member in the
 267  *                      erase_type array.
 268  * @uniform_erase_type: bitmask encoding erase types that can erase the
 269  *                      entire memory. This member is completed at init by
 270  *                      uniform and non-uniform SPI NOR flash memories if they
 271  *                      support at least one erase type that can erase the
 272  *                      entire memory.
 273  */
 274 struct spi_nor_erase_map {
 275         struct spi_nor_erase_region     *regions;
 276         struct spi_nor_erase_region     uniform_region;
 277         struct spi_nor_erase_type       erase_type[SNOR_ERASE_TYPE_MAX];
 278         u8                              uniform_erase_type;
 279 };
 280
 281 /**
 282  * struct spi_nor_locking_ops - SPI NOR locking methods
 283  * @lock:       lock a region of the SPI NOR.
 284  * @unlock:     unlock a region of the SPI NOR.
 285  * @is_locked:  check if a region of the SPI NOR is completely locked
 286  */
 287 struct spi_nor_locking_ops {
 288         int (*lock)(struct spi_nor *nor, loff_t ofs, uint64_t len);
 289         int (*unlock)(struct spi_nor *nor, loff_t ofs, uint64_t len);
 290         int (*is_locked)(struct spi_nor *nor, loff_t ofs, uint64_t len);
 291 };
 292
 293 /**
 294  * struct spi_nor_otp_organization - Structure to describe the SPI NOR OTP regions
 295  * @len:        size of one OTP region in bytes.
 296  * @base:       start address of the OTP area.
 297  * @offset:     offset between consecutive OTP regions if there are more
 298  *              than one.
 299  * @n_regions:  number of individual OTP regions.
 300  */
 301 struct spi_nor_otp_organization {
 302         size_t len;
 303         loff_t base;
 304         loff_t offset;
 305         unsigned int n_regions;
 306 };
 307
 308 /**
 309  * struct spi_nor_otp_ops - SPI NOR OTP methods
 310  * @read:       read from the SPI NOR OTP area.
 311  * @write:      write to the SPI NOR OTP area.
 312  * @lock:       lock an OTP region.
 313  * @erase:      erase an OTP region.
 314  * @is_locked:  check if an OTP region of the SPI NOR is locked.
 315  */
 316 struct spi_nor_otp_ops {
 317         int (*read)(struct spi_nor *nor, loff_t addr, size_t len, u8 *buf);
 318         int (*write)(struct spi_nor *nor, loff_t addr, size_t len,
 319                      const u8 *buf);
 320         int (*lock)(struct spi_nor *nor, unsigned int region);
 321         int (*erase)(struct spi_nor *nor, loff_t addr);
 322         int (*is_locked)(struct spi_nor *nor, unsigned int region);
 323 };
 324
 325 /**
 326  * struct spi_nor_otp - SPI NOR OTP grouping structure
 327  * @org:        OTP region organization
 328  * @ops:        OTP access ops
 329  */
 330 struct spi_nor_otp {
 331         const struct spi_nor_otp_organization *org;
 332         const struct spi_nor_otp_ops *ops;
 333 };
 334
 335 /**
 336  * struct spi_nor_flash_parameter - SPI NOR flash parameters and settings.
 337  * Includes legacy flash parameters and settings that can be overwritten
 338  * by the spi_nor_fixups hooks, or dynamically when parsing the JESD216
 339  * Serial Flash Discoverable Parameters (SFDP) tables.
 340  *
 341  * @bank_size:          the flash memory bank density in bytes.
 342  * @size:               the total flash memory density in bytes.
 343  * @writesize           Minimal writable flash unit size. Defaults to 1. Set to
 344  *                      ECC unit size for ECC-ed flashes.
 345  * @page_size:          the page size of the SPI NOR flash memory.
 346  * @addr_nbytes:        number of address bytes to send.
 347  * @addr_mode_nbytes:   number of address bytes of current address mode. Useful
 348  *                      when the flash operates with 4B opcodes but needs the
 349  *                      internal address mode for opcodes that don't have a 4B
 350  *                      opcode correspondent.
 351  * @rdsr_dummy:         dummy cycles needed for Read Status Register command
 352  *                      in octal DTR mode.
 353  * @rdsr_addr_nbytes:   dummy address bytes needed for Read Status Register
 354  *                      command in octal DTR mode.
 355  * @n_dice:             number of dice in the flash memory.
 356  * @vreg_offset:        volatile register offset for each die.
 357  * @hwcaps:             describes the read and page program hardware
 358  *                      capabilities.
 359  * @reads:              read capabilities ordered by priority: the higher index
 360  *                      in the array, the higher priority.
 361  * @page_programs:      page program capabilities ordered by priority: the
 362  *                      higher index in the array, the higher priority.
 363  * @erase_map:          the erase map parsed from the SFDP Sector Map Parameter
 364  *                      Table.
 365  * @otp:                SPI NOR OTP info.
 366  * @octal_dtr_enable:   enables SPI NOR octal DTR mode.
 367  * @quad_enable:        enables SPI NOR quad mode.
 368  * @set_4byte_addr_mode: puts the SPI NOR in 4 byte addressing mode.
 369  * @convert_addr:       converts an absolute address into something the flash
 370  *                      will understand. Particularly useful when pagesize is
 371  *                      not a power-of-2.
 372  * @setup:              (optional) configures the SPI NOR memory. Useful for
 373  *                      SPI NOR flashes that have peculiarities to the SPI NOR
 374  *                      standard e.g. different opcodes, specific address
 375  *                      calculation, page size, etc.
 376  * @ready:              (optional) flashes might use a different mechanism
 377  *                      than reading the status register to indicate they
 378  *                      are ready for a new command
 379  * @locking_ops:        SPI NOR locking methods.
 380  */
 381 struct spi_nor_flash_parameter {
 382         u64                             bank_size;
 383         u64                             size;
 384         u32                             writesize;
 385         u32                             page_size;
 386         u8                              addr_nbytes;
 387         u8                              addr_mode_nbytes;
 388         u8                              rdsr_dummy;
 389         u8                              rdsr_addr_nbytes;
 390         u8                              n_dice;
 391         u32                             *vreg_offset;
 392
 393         struct spi_nor_hwcaps           hwcaps;
 394         struct spi_nor_read_command     reads[SNOR_CMD_READ_MAX];
 395         struct spi_nor_pp_command       page_programs[SNOR_CMD_PP_MAX];
 396
 397         struct spi_nor_erase_map        erase_map;
 398         struct spi_nor_otp              otp;
 399
 400         int (*octal_dtr_enable)(struct spi_nor *nor, bool enable);
 401         int (*quad_enable)(struct spi_nor *nor);
 402         int (*set_4byte_addr_mode)(struct spi_nor *nor, bool enable);
 403         u32 (*convert_addr)(struct spi_nor *nor, u32 addr);
 404         int (*setup)(struct spi_nor *nor, const struct spi_nor_hwcaps *hwcaps);
 405         int (*ready)(struct spi_nor *nor);
 406
 407         const struct spi_nor_locking_ops *locking_ops;
 408 };
 409
 410 /**
 411  * struct spi_nor_fixups - SPI NOR fixup hooks
 412  * @default_init: called after default flash parameters init. Used to tweak
 413  *                flash parameters when information provided by the flash_info
 414  *                table is incomplete or wrong.
 415  * @post_bfpt: called after the BFPT table has been parsed
 416  * @post_sfdp: called after SFDP has been parsed (is also called for SPI NORs
 417  *             that do not support RDSFDP). Typically used to tweak various
 418  *             parameters that could not be extracted by other means (i.e.
 419  *             when information provided by the SFDP/flash_info tables are
 420  *             incomplete or wrong).
 421  * @late_init: used to initialize flash parameters that are not declared in the
 422  *             JESD216 SFDP standard, or where SFDP tables not defined at all.
 423  *             Will replace the default_init() hook.
 424  *
 425  * Those hooks can be used to tweak the SPI NOR configuration when the SFDP
 426  * table is broken or not available.
 427  */
 428 struct spi_nor_fixups {
 429         void (*default_init)(struct spi_nor *nor);
 430         int (*post_bfpt)(struct spi_nor *nor,
 431                          const struct sfdp_parameter_header *bfpt_header,
 432                          const struct sfdp_bfpt *bfpt);
 433         int (*post_sfdp)(struct spi_nor *nor);
 434         void (*late_init)(struct spi_nor *nor);
 435 };
 436
 437 /**
 438  * struct flash_info - SPI NOR flash_info entry.
 439  * @name: the name of the flash.
 440  * @id:             the flash's ID bytes. The first three bytes are the
 441  *                  JEDIC ID. JEDEC ID zero means "no ID" (mostly older chips).
 442  * @id_len:         the number of bytes of ID.
 443  * @sector_size:    the size listed here is what works with SPINOR_OP_SE, which
 444  *                  isn't necessarily called a "sector" by the vendor.
 445  * @n_sectors:      the number of sectors.
 446  * @n_banks:        the number of banks.
 447  * @page_size:      the flash's page size.
 448  * @addr_nbytes:    number of address bytes to send.
 449  *
 450  * @parse_sfdp:     true when flash supports SFDP tables. The false value has no
 451  *                  meaning. If one wants to skip the SFDP tables, one should
 452  *                  instead use the SPI_NOR_SKIP_SFDP sfdp_flag.
 453  * @flags:          flags that indicate support that is not defined by the
 454  *                  JESD216 standard in its SFDP tables. Flag meanings:
 455  *   SPI_NOR_HAS_LOCK:        flash supports lock/unlock via SR
 456  *   SPI_NOR_HAS_TB:          flash SR has Top/Bottom (TB) protect bit. Must be
 457  *                            used with SPI_NOR_HAS_LOCK.
 458  *   SPI_NOR_TB_SR_BIT6:      Top/Bottom (TB) is bit 6 of status register.
 459  *                            Must be used with SPI_NOR_HAS_TB.
 460  *   SPI_NOR_4BIT_BP:         flash SR has 4 bit fields (BP0-3) for block
 461  *                            protection.
 462  *   SPI_NOR_BP3_SR_BIT6:     BP3 is bit 6 of status register. Must be used with
 463  *                            SPI_NOR_4BIT_BP.
 464  *   SPI_NOR_SWP_IS_VOLATILE: flash has volatile software write protection bits.
 465  *                            Usually these will power-up in a write-protected
 466  *                            state.
 467  *   SPI_NOR_NO_ERASE:        no erase command needed.
 468  *   NO_CHIP_ERASE:           chip does not support chip erase.
 469  *   SPI_NOR_NO_FR:           can't do fastread.
 470  *   SPI_NOR_QUAD_PP:         flash supports Quad Input Page Program.
 471  *   SPI_NOR_RWW:             flash supports reads while write.
 472  *
 473  * @no_sfdp_flags:  flags that indicate support that can be discovered via SFDP.
 474  *                  Used when SFDP tables are not defined in the flash. These
 475  *                  flags are used together with the SPI_NOR_SKIP_SFDP flag.
 476  *   SPI_NOR_SKIP_SFDP:       skip parsing of SFDP tables.
 477  *   SECT_4K:                 SPINOR_OP_BE_4K works uniformly.
 478  *   SPI_NOR_DUAL_READ:       flash supports Dual Read.
 479  *   SPI_NOR_QUAD_READ:       flash supports Quad Read.
 480  *   SPI_NOR_OCTAL_READ:      flash supports Octal Read.
 481  *   SPI_NOR_OCTAL_DTR_READ:  flash supports octal DTR Read.
 482  *   SPI_NOR_OCTAL_DTR_PP:    flash supports Octal DTR Page Program.
 483  *
 484  * @fixup_flags:    flags that indicate support that can be discovered via SFDP
 485  *                  ideally, but can not be discovered for this particular flash
 486  *                  because the SFDP table that indicates this support is not
 487  *                  defined by the flash. In case the table for this support is
 488  *                  defined but has wrong values, one should instead use a
 489  *                  post_sfdp() hook to set the SNOR_F equivalent flag.
 490  *
 491  *   SPI_NOR_4B_OPCODES:      use dedicated 4byte address op codes to support
 492  *                            memory size above 128Mib.
 493  *   SPI_NOR_IO_MODE_EN_VOLATILE: flash enables the best available I/O mode
 494  *                            via a volatile bit.
 495  * @mfr_flags:      manufacturer private flags. Used in the manufacturer fixup
 496  *                  hooks to differentiate support between flashes of the same
 497  *                  manufacturer.
 498  * @otp_org:        flash's OTP organization.
 499  * @fixups:         part specific fixup hooks.
 500  */
 501 struct flash_info {
 502         char *name;
 503         u8 id[SPI_NOR_MAX_ID_LEN];
 504         u8 id_len;
 505         unsigned sector_size;
 506         u16 n_sectors;
 507         u16 page_size;
 508         u8 n_banks;
 509         u8 addr_nbytes;
 510
 511         bool parse_sfdp;
 512         u16 flags;
 513 #define SPI_NOR_HAS_LOCK                BIT(0)
 514 #define SPI_NOR_HAS_TB                  BIT(1)
 515 #define SPI_NOR_TB_SR_BIT6              BIT(2)
 516 #define SPI_NOR_4BIT_BP                 BIT(3)
 517 #define SPI_NOR_BP3_SR_BIT6             BIT(4)
 518 #define SPI_NOR_SWP_IS_VOLATILE         BIT(5)
 519 #define SPI_NOR_NO_ERASE                BIT(6)
 520 #define NO_CHIP_ERASE                   BIT(7)
 521 #define SPI_NOR_NO_FR                   BIT(8)
 522 #define SPI_NOR_QUAD_PP                 BIT(9)
 523 #define SPI_NOR_RWW                     BIT(10)
 524
 525         u8 no_sfdp_flags;
 526 #define SPI_NOR_SKIP_SFDP               BIT(0)
 527 #define SECT_4K                         BIT(1)
 528 #define SPI_NOR_DUAL_READ               BIT(3)
 529 #define SPI_NOR_QUAD_READ               BIT(4)
 530 #define SPI_NOR_OCTAL_READ              BIT(5)
 531 #define SPI_NOR_OCTAL_DTR_READ          BIT(6)
 532 #define SPI_NOR_OCTAL_DTR_PP            BIT(7)
 533
 534         u8 fixup_flags;
 535 #define SPI_NOR_4B_OPCODES              BIT(0)
 536 #define SPI_NOR_IO_MODE_EN_VOLATILE     BIT(1)
 537
 538         u8 mfr_flags;
 539
 540         const struct spi_nor_otp_organization otp_org;
 541         const struct spi_nor_fixups *fixups;
 542 };
 543
 544 #define SPI_NOR_ID_2ITEMS(_id) ((_id) >> 8) & 0xff, (_id) & 0xff
 545 #define SPI_NOR_ID_3ITEMS(_id) ((_id) >> 16) & 0xff, SPI_NOR_ID_2ITEMS(_id)
 546
 547 #define SPI_NOR_ID(_jedec_id, _ext_id)                                  \
 548         .id = { SPI_NOR_ID_3ITEMS(_jedec_id), SPI_NOR_ID_2ITEMS(_ext_id) }, \
 549         .id_len = !(_jedec_id) ? 0 : (3 + ((_ext_id) ? 2 : 0))
 550
 551 #define SPI_NOR_ID6(_jedec_id, _ext_id)                                 \
 552         .id = { SPI_NOR_ID_3ITEMS(_jedec_id), SPI_NOR_ID_3ITEMS(_ext_id) }, \
 553         .id_len = 6
 554
 555 #define SPI_NOR_GEOMETRY(_sector_size, _n_sectors, _n_banks)            \
 556         .sector_size = (_sector_size),                                  \
 557         .n_sectors = (_n_sectors),                                      \
 558         .page_size = 256,                                               \
 559         .n_banks = (_n_banks)
 560
 561 /* Used when the "_ext_id" is two bytes at most */
 562 #define INFO(_jedec_id, _ext_id, _sector_size, _n_sectors)              \
 563         SPI_NOR_ID((_jedec_id), (_ext_id)),                             \
 564         SPI_NOR_GEOMETRY((_sector_size), (_n_sectors), 1),
 565
 566 #define INFOB(_jedec_id, _ext_id, _sector_size, _n_sectors, _n_banks)   \
 567         SPI_NOR_ID((_jedec_id), (_ext_id)),                             \
 568         SPI_NOR_GEOMETRY((_sector_size), (_n_sectors), (_n_banks)),
 569
 570 #define INFO6(_jedec_id, _ext_id, _sector_size, _n_sectors)             \
 571         SPI_NOR_ID6((_jedec_id), (_ext_id)),                            \
 572         SPI_NOR_GEOMETRY((_sector_size), (_n_sectors), 1),
 573
 574 #define CAT25_INFO(_sector_size, _n_sectors, _page_size, _addr_nbytes)  \
 575                 .sector_size = (_sector_size),                          \
 576                 .n_sectors = (_n_sectors),                              \
 577                 .page_size = (_page_size),                              \
 578                 .n_banks = 1,                                           \
 579                 .addr_nbytes = (_addr_nbytes),                          \
 580                 .flags = SPI_NOR_NO_ERASE | SPI_NOR_NO_FR,              \
 581
 582 #define OTP_INFO(_len, _n_regions, _base, _offset)                      \
 583                 .otp_org = {                                            \
 584                         .len = (_len),                                  \
 585                         .base = (_base),                                \
 586                         .offset = (_offset),                            \
 587                         .n_regions = (_n_regions),                      \
 588                 },
 589
 590 #define PARSE_SFDP                                                      \
 591         .parse_sfdp = true,                                             \
 592
 593 #define FLAGS(_flags)                                                   \
 594                 .flags = (_flags),                                      \
 595
 596 #define NO_SFDP_FLAGS(_no_sfdp_flags)                                   \
 597                 .no_sfdp_flags = (_no_sfdp_flags),                      \
 598
 599 #define FIXUP_FLAGS(_fixup_flags)                                       \
 600                 .fixup_flags = (_fixup_flags),                          \
 601
 602 #define MFR_FLAGS(_mfr_flags)                                           \
 603                 .mfr_flags = (_mfr_flags),                              \
 604
 605 /**
 606  * struct spi_nor_manufacturer - SPI NOR manufacturer object
 607  * @name: manufacturer name
 608  * @parts: array of parts supported by this manufacturer
 609  * @nparts: number of entries in the parts array
 610  * @fixups: hooks called at various points in time during spi_nor_scan()
 611  */
 612 struct spi_nor_manufacturer {
 613         const char *name;
 614         const struct flash_info *parts;
 615         unsigned int nparts;
 616         const struct spi_nor_fixups *fixups;
 617 };
 618
 619 /**
 620  * struct sfdp - SFDP data
 621  * @num_dwords: number of entries in the dwords array
 622  * @dwords: array of double words of the SFDP data
 623  */
 624 struct sfdp {
 625         size_t  num_dwords;
 626         u32     *dwords;
 627 };
 628
 629 /* Manufacturer drivers. */
 630 extern const struct spi_nor_manufacturer spi_nor_atmel;
 631 extern const struct spi_nor_manufacturer spi_nor_catalyst;
 632 extern const struct spi_nor_manufacturer spi_nor_eon;
 633 extern const struct spi_nor_manufacturer spi_nor_esmt;
 634 extern const struct spi_nor_manufacturer spi_nor_everspin;
 635 extern const struct spi_nor_manufacturer spi_nor_fujitsu;
 636 extern const struct spi_nor_manufacturer spi_nor_gigadevice;
 637 extern const struct spi_nor_manufacturer spi_nor_intel;
 638 extern const struct spi_nor_manufacturer spi_nor_issi;
 639 extern const struct spi_nor_manufacturer spi_nor_macronix;
 640 extern const struct spi_nor_manufacturer spi_nor_micron;
 641 extern const struct spi_nor_manufacturer spi_nor_st;
 642 extern const struct spi_nor_manufacturer spi_nor_spansion;
 643 extern const struct spi_nor_manufacturer spi_nor_sst;
 644 extern const struct spi_nor_manufacturer spi_nor_winbond;
 645 extern const struct spi_nor_manufacturer spi_nor_xilinx;
 646 extern const struct spi_nor_manufacturer spi_nor_xmc;
 647
 648 extern const struct attribute_group *spi_nor_sysfs_groups[];
 649
 650 void spi_nor_spimem_setup_op(const struct spi_nor *nor,
 651                              struct spi_mem_op *op,
 652                              const enum spi_nor_protocol proto);
 653 int spi_nor_write_enable(struct spi_nor *nor);
 654 int spi_nor_write_disable(struct spi_nor *nor);
 655 int spi_nor_set_4byte_addr_mode_en4b_ex4b(struct spi_nor *nor, bool enable);
 656 int spi_nor_set_4byte_addr_mode_wren_en4b_ex4b(struct spi_nor *nor,
 657                                                bool enable);
 658 int spi_nor_set_4byte_addr_mode_brwr(struct spi_nor *nor, bool enable);
 659 int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
 660 int spi_nor_wait_till_ready(struct spi_nor *nor);
 661 int spi_nor_global_block_unlock(struct spi_nor *nor);
 662 int spi_nor_prep_and_lock(struct spi_nor *nor);
 663 void spi_nor_unlock_and_unprep(struct spi_nor *nor);
 664 int spi_nor_sr1_bit6_quad_enable(struct spi_nor *nor);
 665 int spi_nor_sr2_bit1_quad_enable(struct spi_nor *nor);
 666 int spi_nor_sr2_bit7_quad_enable(struct spi_nor *nor);
 667 int spi_nor_read_id(struct spi_nor *nor, u8 naddr, u8 ndummy, u8 *id,
 668                     enum spi_nor_protocol reg_proto);
 669 int spi_nor_read_sr(struct spi_nor *nor, u8 *sr);
 670 int spi_nor_sr_ready(struct spi_nor *nor);
 671 int spi_nor_read_cr(struct spi_nor *nor, u8 *cr);
 672 int spi_nor_write_sr(struct spi_nor *nor, const u8 *sr, size_t len);
 673 int spi_nor_write_sr_and_check(struct spi_nor *nor, u8 sr1);
 674 int spi_nor_write_16bit_cr_and_check(struct spi_nor *nor, u8 cr);
 675
 676 ssize_t spi_nor_read_data(struct spi_nor *nor, loff_t from, size_t len,
 677                           u8 *buf);
 678 ssize_t spi_nor_write_data(struct spi_nor *nor, loff_t to, size_t len,
 679                            const u8 *buf);
 680 int spi_nor_read_any_reg(struct spi_nor *nor, struct spi_mem_op *op,
 681                          enum spi_nor_protocol proto);
 682 int spi_nor_write_any_volatile_reg(struct spi_nor *nor, struct spi_mem_op *op,
 683                                    enum spi_nor_protocol proto);
 684 int spi_nor_erase_sector(struct spi_nor *nor, u32 addr);
 685
 686 int spi_nor_otp_read_secr(struct spi_nor *nor, loff_t addr, size_t len, u8 *buf);
 687 int spi_nor_otp_write_secr(struct spi_nor *nor, loff_t addr, size_t len,
 688                            const u8 *buf);
 689 int spi_nor_otp_erase_secr(struct spi_nor *nor, loff_t addr);
 690 int spi_nor_otp_lock_sr2(struct spi_nor *nor, unsigned int region);
 691 int spi_nor_otp_is_locked_sr2(struct spi_nor *nor, unsigned int region);
 692
 693 int spi_nor_hwcaps_read2cmd(u32 hwcaps);
 694 int spi_nor_hwcaps_pp2cmd(u32 hwcaps);
 695 u8 spi_nor_convert_3to4_read(u8 opcode);
 696 void spi_nor_set_read_settings(struct spi_nor_read_command *read,
 697                                u8 num_mode_clocks,
 698                                u8 num_wait_states,
 699                                u8 opcode,
 700                                enum spi_nor_protocol proto);
 701 void spi_nor_set_pp_settings(struct spi_nor_pp_command *pp, u8 opcode,
 702                              enum spi_nor_protocol proto);
 703
 704 void spi_nor_set_erase_type(struct spi_nor_erase_type *erase, u32 size,
 705                             u8 opcode);
 706 void spi_nor_mask_erase_type(struct spi_nor_erase_type *erase);
 707 struct spi_nor_erase_region *
 708 spi_nor_region_next(struct spi_nor_erase_region *region);
 709 void spi_nor_init_uniform_erase_map(struct spi_nor_erase_map *map,
 710                                     u8 erase_mask, u64 flash_size);
 711
 712 int spi_nor_post_bfpt_fixups(struct spi_nor *nor,
 713                              const struct sfdp_parameter_header *bfpt_header,
 714                              const struct sfdp_bfpt *bfpt);
 715
 716 void spi_nor_init_default_locking_ops(struct spi_nor *nor);
 717 void spi_nor_try_unlock_all(struct spi_nor *nor);
 718 void spi_nor_set_mtd_locking_ops(struct spi_nor *nor);
 719 void spi_nor_set_mtd_otp_ops(struct spi_nor *nor);
 720
 721 int spi_nor_controller_ops_read_reg(struct spi_nor *nor, u8 opcode,
 722                                     u8 *buf, size_t len);
 723 int spi_nor_controller_ops_write_reg(struct spi_nor *nor, u8 opcode,
 724                                      const u8 *buf, size_t len);
 725
 726 int spi_nor_check_sfdp_signature(struct spi_nor *nor);
 727 int spi_nor_parse_sfdp(struct spi_nor *nor);
 728
 729 static inline struct spi_nor *mtd_to_spi_nor(struct mtd_info *mtd)
 730 {
 731         return container_of(mtd, struct spi_nor, mtd);
 732 }
 733
 734 #ifdef CONFIG_DEBUG_FS
 735 void spi_nor_debugfs_register(struct spi_nor *nor);
 736 void spi_nor_debugfs_shutdown(void);
 737 #else
 738 static inline void spi_nor_debugfs_register(struct spi_nor *nor) {}
 739 static inline void spi_nor_debugfs_shutdown(void) {}
 740 #endif
 741
 742 #endif /* __LINUX_MTD_SPI_NOR_INTERNAL_H */