drivers/mtd/spi/sf_internal.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * SPI flash internal definitions
   4  *
   5  * Copyright (C) 2008 Atmel Corporation
   6  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   7  */
   8
   9 #ifndef _SF_INTERNAL_H_
  10 #define _SF_INTERNAL_H_
  11
  12 #include <linux/types.h>
  13 #include <linux/compiler.h>
  14
  15 #define SPI_NOR_MAX_ID_LEN      6
  16 #define SPI_NOR_MAX_ADDR_WIDTH  4
  17
  18 struct flash_info {
  19         char            *name;
  20
  21         /*
  22          * This array stores the ID bytes.
  23          * The first three bytes are the JEDIC ID.
  24          * JEDEC ID zero means "no ID" (mostly older chips).
  25          */
  26         u8              id[SPI_NOR_MAX_ID_LEN];
  27         u8              id_len;
  28
  29         /* The size listed here is what works with SPINOR_OP_SE, which isn't
  30          * necessarily called a "sector" by the vendor.
  31          */
  32         unsigned int    sector_size;
  33         u16             n_sectors;
  34
  35         u16             page_size;
  36         u16             addr_width;
  37
  38         u16             flags;
  39 #define SECT_4K                 BIT(0)  /* SPINOR_OP_BE_4K works uniformly */
  40 #define SPI_NOR_NO_ERASE        BIT(1)  /* No erase command needed */
  41 #define SST_WRITE               BIT(2)  /* use SST byte programming */
  42 #define SPI_NOR_NO_FR           BIT(3)  /* Can't do fastread */
  43 #define SECT_4K_PMC             BIT(4)  /* SPINOR_OP_BE_4K_PMC works uniformly */
  44 #define SPI_NOR_DUAL_READ       BIT(5)  /* Flash supports Dual Read */
  45 #define SPI_NOR_QUAD_READ       BIT(6)  /* Flash supports Quad Read */
  46 #define USE_FSR                 BIT(7)  /* use flag status register */
  47 #define SPI_NOR_HAS_LOCK        BIT(8)  /* Flash supports lock/unlock via SR */
  48 #define SPI_NOR_HAS_TB          BIT(9)  /*
  49                                          * Flash SR has Top/Bottom (TB) protect
  50                                          * bit. Must be used with
  51                                          * SPI_NOR_HAS_LOCK.
  52                                          */
  53 #define SPI_S3AN                BIT(10) /*
  54                                          * Xilinx Spartan 3AN In-System Flash
  55                                          * (MFR cannot be used for probing
  56                                          * because it has the same value as
  57                                          * ATMEL flashes)
  58                                          */
  59 #define SPI_NOR_4B_OPCODES      BIT(11) /*
  60                                          * Use dedicated 4byte address op codes
  61                                          * to support memory size above 128Mib.
  62                                          */
  63 #define NO_CHIP_ERASE           BIT(12) /* Chip does not support chip erase */
  64 #define SPI_NOR_SKIP_SFDP       BIT(13) /* Skip parsing of SFDP tables */
  65 #define USE_CLSR                BIT(14) /* use CLSR command */
  66 };
  67
  68 extern const struct flash_info spi_nor_ids[];
  69
  70 #define JEDEC_MFR(info) ((info)->id[0])
  71 #define JEDEC_ID(info)          (((info)->id[1]) << 8 | ((info)->id[2]))
  72
  73 /* Send a single-byte command to the device and read the response */
  74 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
  75
  76 /*
  77  * Send a multi-byte command to the device and read the response. Used
  78  * for flash array reads, etc.
  79  */
  80 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  81                 size_t cmd_len, void *data, size_t data_len);
  82
  83 /*
  84  * Send a multi-byte command to the device followed by (optional)
  85  * data. Used for programming the flash array, etc.
  86  */
  87 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  88                 const void *data, size_t data_len);
  89
  90
  91 /* Get software write-protect value (BP bits) */
  92 int spi_flash_cmd_get_sw_write_prot(struct spi_flash *flash);
  93
  94
  95 #ifdef CONFIG_SPI_FLASH_MTD
  96 int spi_flash_mtd_register(struct spi_flash *flash);
  97 void spi_flash_mtd_unregister(void);
  98 #endif
  99 #endif /* _SF_INTERNAL_H_ */