183d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */ 2898e76c9SJagannadha Sutradharudu Teki /* 3898e76c9SJagannadha Sutradharudu Teki * SPI flash internal definitions 4898e76c9SJagannadha Sutradharudu Teki * 5898e76c9SJagannadha Sutradharudu Teki * Copyright (C) 2008 Atmel Corporation 6898e76c9SJagannadha Sutradharudu Teki * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. 7898e76c9SJagannadha Sutradharudu Teki */ 8898e76c9SJagannadha Sutradharudu Teki 9469146c0SJagannadha Sutradharudu Teki #ifndef _SF_INTERNAL_H_ 10469146c0SJagannadha Sutradharudu Teki #define _SF_INTERNAL_H_ 11898e76c9SJagannadha Sutradharudu Teki 12ff0960f9SSimon Glass #include <linux/types.h> 13ff0960f9SSimon Glass #include <linux/compiler.h> 14ff0960f9SSimon Glass 15c4e88623SVignesh R #define SPI_NOR_MAX_ID_LEN 6 16c4e88623SVignesh R #define SPI_NOR_MAX_ADDR_WIDTH 4 17ff0960f9SSimon Glass 18c4e88623SVignesh R struct flash_info { 19778572d7SVignesh R #if !CONFIG_IS_ENABLED(SPI_FLASH_TINY) 20c4e88623SVignesh R char *name; 21778572d7SVignesh R #endif 22f790ca7cSJagan Teki 23f790ca7cSJagan Teki /* 24f790ca7cSJagan Teki * This array stores the ID bytes. 25f790ca7cSJagan Teki * The first three bytes are the JEDIC ID. 26f790ca7cSJagan Teki * JEDEC ID zero means "no ID" (mostly older chips). 27f790ca7cSJagan Teki */ 28c4e88623SVignesh R u8 id[SPI_NOR_MAX_ID_LEN]; 29f790ca7cSJagan Teki u8 id_len; 30f790ca7cSJagan Teki 31c4e88623SVignesh R /* The size listed here is what works with SPINOR_OP_SE, which isn't 32f3bf2e5aSJagan Teki * necessarily called a "sector" by the vendor. 33f3bf2e5aSJagan Teki */ 34c4e88623SVignesh R unsigned int sector_size; 35c4e88623SVignesh R u16 n_sectors; 363632c8e5SJagan Teki 37f790ca7cSJagan Teki u16 page_size; 38c4e88623SVignesh R u16 addr_width; 39f790ca7cSJagan Teki 40ff0960f9SSimon Glass u16 flags; 41c4e88623SVignesh R #define SECT_4K BIT(0) /* SPINOR_OP_BE_4K works uniformly */ 42c4e88623SVignesh R #define SPI_NOR_NO_ERASE BIT(1) /* No erase command needed */ 43c4e88623SVignesh R #define SST_WRITE BIT(2) /* use SST byte programming */ 44c4e88623SVignesh R #define SPI_NOR_NO_FR BIT(3) /* Can't do fastread */ 45c4e88623SVignesh R #define SECT_4K_PMC BIT(4) /* SPINOR_OP_BE_4K_PMC works uniformly */ 46c4e88623SVignesh R #define SPI_NOR_DUAL_READ BIT(5) /* Flash supports Dual Read */ 47c4e88623SVignesh R #define SPI_NOR_QUAD_READ BIT(6) /* Flash supports Quad Read */ 48c4e88623SVignesh R #define USE_FSR BIT(7) /* use flag status register */ 49c4e88623SVignesh R #define SPI_NOR_HAS_LOCK BIT(8) /* Flash supports lock/unlock via SR */ 50c4e88623SVignesh R #define SPI_NOR_HAS_TB BIT(9) /* 51c4e88623SVignesh R * Flash SR has Top/Bottom (TB) protect 52c4e88623SVignesh R * bit. Must be used with 53c4e88623SVignesh R * SPI_NOR_HAS_LOCK. 54c4e88623SVignesh R */ 55c4e88623SVignesh R #define SPI_S3AN BIT(10) /* 56c4e88623SVignesh R * Xilinx Spartan 3AN In-System Flash 57c4e88623SVignesh R * (MFR cannot be used for probing 58c4e88623SVignesh R * because it has the same value as 59c4e88623SVignesh R * ATMEL flashes) 60c4e88623SVignesh R */ 61c4e88623SVignesh R #define SPI_NOR_4B_OPCODES BIT(11) /* 62c4e88623SVignesh R * Use dedicated 4byte address op codes 63c4e88623SVignesh R * to support memory size above 128Mib. 64c4e88623SVignesh R */ 65c4e88623SVignesh R #define NO_CHIP_ERASE BIT(12) /* Chip does not support chip erase */ 66c4e88623SVignesh R #define SPI_NOR_SKIP_SFDP BIT(13) /* Skip parsing of SFDP tables */ 67c4e88623SVignesh R #define USE_CLSR BIT(14) /* use CLSR command */ 68ff0960f9SSimon Glass }; 69ff0960f9SSimon Glass 70c4e88623SVignesh R extern const struct flash_info spi_nor_ids[]; 71c4e88623SVignesh R 72c4e88623SVignesh R #define JEDEC_MFR(info) ((info)->id[0]) 73c4e88623SVignesh R #define JEDEC_ID(info) (((info)->id[1]) << 8 | ((info)->id[2])) 74ff0960f9SSimon Glass 75898e76c9SJagannadha Sutradharudu Teki /* Send a single-byte command to the device and read the response */ 76898e76c9SJagannadha Sutradharudu Teki int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len); 77898e76c9SJagannadha Sutradharudu Teki 78898e76c9SJagannadha Sutradharudu Teki /* 79898e76c9SJagannadha Sutradharudu Teki * Send a multi-byte command to the device and read the response. Used 80898e76c9SJagannadha Sutradharudu Teki * for flash array reads, etc. 81898e76c9SJagannadha Sutradharudu Teki */ 82898e76c9SJagannadha Sutradharudu Teki int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd, 83898e76c9SJagannadha Sutradharudu Teki size_t cmd_len, void *data, size_t data_len); 84898e76c9SJagannadha Sutradharudu Teki 85898e76c9SJagannadha Sutradharudu Teki /* 86898e76c9SJagannadha Sutradharudu Teki * Send a multi-byte command to the device followed by (optional) 87898e76c9SJagannadha Sutradharudu Teki * data. Used for programming the flash array, etc. 88898e76c9SJagannadha Sutradharudu Teki */ 89898e76c9SJagannadha Sutradharudu Teki int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len, 90898e76c9SJagannadha Sutradharudu Teki const void *data, size_t data_len); 91898e76c9SJagannadha Sutradharudu Teki 92898e76c9SJagannadha Sutradharudu Teki 93a58986caSSimon Glass /* Get software write-protect value (BP bits) */ 94a58986caSSimon Glass int spi_flash_cmd_get_sw_write_prot(struct spi_flash *flash); 95a58986caSSimon Glass 96*591e1cf0SChin-Ting Kuo int spi_flash_wlock_by_host_ctrl(struct spi_flash *flash, 97*591e1cf0SChin-Ting Kuo u32 offset, size_t len); 98*591e1cf0SChin-Ting Kuo int spi_flash_wunlock_by_host_ctrl(struct spi_flash *flash, 99*591e1cf0SChin-Ting Kuo u32 offset, size_t len); 100*591e1cf0SChin-Ting Kuo int spi_nor_ctrl_wlock(struct spi_slave *slave, u32 offset, size_t len); 101*591e1cf0SChin-Ting Kuo int spi_nor_ctrl_wunlock(struct spi_slave *slave, u32 offset, size_t len); 102898e76c9SJagannadha Sutradharudu Teki 1039fe6d871SDaniel Schwierzeck #ifdef CONFIG_SPI_FLASH_MTD 1049fe6d871SDaniel Schwierzeck int spi_flash_mtd_register(struct spi_flash *flash); 1059fe6d871SDaniel Schwierzeck void spi_flash_mtd_unregister(void); 1069fe6d871SDaniel Schwierzeck #endif 107469146c0SJagannadha Sutradharudu Teki #endif /* _SF_INTERNAL_H_ */ 108