1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * SPI flash internal definitions
5 * Copyright (C) 2008 Atmel Corporation
6 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
9 #ifndef _SF_INTERNAL_H_
10 #define _SF_INTERNAL_H_
12 #include <linux/types.h>
13 #include <linux/compiler.h>
15 #define SPI_NOR_MAX_ID_LEN 6
16 #define SPI_NOR_MAX_ADDR_WIDTH 4
19 #if !CONFIG_IS_ENABLED(SPI_FLASH_TINY)
24 * This array stores the ID bytes.
25 * The first three bytes are the JEDIC ID.
26 * JEDEC ID zero means "no ID" (mostly older chips).
28 u8 id[SPI_NOR_MAX_ID_LEN];
31 /* The size listed here is what works with SPINOR_OP_SE, which isn't
32 * necessarily called a "sector" by the vendor.
34 unsigned int sector_size;
41 #define SECT_4K BIT(0) /* SPINOR_OP_BE_4K works uniformly */
42 #define SPI_NOR_NO_ERASE BIT(1) /* No erase command needed */
43 #define SST_WRITE BIT(2) /* use SST byte programming */
44 #define SPI_NOR_NO_FR BIT(3) /* Can't do fastread */
45 #define SECT_4K_PMC BIT(4) /* SPINOR_OP_BE_4K_PMC works uniformly */
46 #define SPI_NOR_DUAL_READ BIT(5) /* Flash supports Dual Read */
47 #define SPI_NOR_QUAD_READ BIT(6) /* Flash supports Quad Read */
48 #define USE_FSR BIT(7) /* use flag status register */
49 #define SPI_NOR_HAS_LOCK BIT(8) /* Flash supports lock/unlock via SR */
50 #define SPI_NOR_HAS_TB BIT(9) /*
51 * Flash SR has Top/Bottom (TB) protect
52 * bit. Must be used with
55 #define SPI_S3AN BIT(10) /*
56 * Xilinx Spartan 3AN In-System Flash
57 * (MFR cannot be used for probing
58 * because it has the same value as
61 #define SPI_NOR_4B_OPCODES BIT(11) /*
62 * Use dedicated 4byte address op codes
63 * to support memory size above 128Mib.
65 #define NO_CHIP_ERASE BIT(12) /* Chip does not support chip erase */
66 #define SPI_NOR_SKIP_SFDP BIT(13) /* Skip parsing of SFDP tables */
67 #define USE_CLSR BIT(14) /* use CLSR command */
68 #define SPI_NOR_HAS_SST26LOCK BIT(15) /* Flash supports lock/unlock via BPR */
69 #define SPI_NOR_OCTAL_READ BIT(16) /* Flash supports Octal Read */
72 extern const struct flash_info spi_nor_ids[];
74 #define JEDEC_MFR(info) ((info)->id[0])
75 #define JEDEC_ID(info) (((info)->id[1]) << 8 | ((info)->id[2]))
77 /* Get software write-protect value (BP bits) */
78 int spi_flash_cmd_get_sw_write_prot(struct spi_flash *flash);
81 #if CONFIG_IS_ENABLED(SPI_FLASH_MTD)
82 int spi_flash_mtd_register(struct spi_flash *flash);
83 void spi_flash_mtd_unregister(void);
85 #endif /* _SF_INTERNAL_H_ */