1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Common SPI flash Interface
5 * Copyright (C) 2008 Atmel Corporation
6 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
12 #include <linux/types.h>
13 #include <linux/mtd/spi-nor.h>
17 /* by default ENV use the same parameters than SF command */
18 #ifndef CONFIG_ENV_SPI_BUS
19 # define CONFIG_ENV_SPI_BUS CONFIG_SF_DEFAULT_BUS
21 #ifndef CONFIG_ENV_SPI_CS
22 # define CONFIG_ENV_SPI_CS CONFIG_SF_DEFAULT_CS
24 #ifndef CONFIG_ENV_SPI_MAX_HZ
25 # define CONFIG_ENV_SPI_MAX_HZ CONFIG_SF_DEFAULT_SPEED
27 #ifndef CONFIG_ENV_SPI_MODE
28 # define CONFIG_ENV_SPI_MODE CONFIG_SF_DEFAULT_MODE
33 struct dm_spi_flash_ops {
34 int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
35 int (*write)(struct udevice *dev, u32 offset, size_t len,
37 int (*erase)(struct udevice *dev, u32 offset, size_t len);
40 /* Access the serial operations for a device */
41 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
43 #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
45 * spi_flash_read_dm() - Read data from SPI flash
47 * @dev: SPI flash device
48 * @offset: Offset into device in bytes to read from
49 * @len: Number of bytes to read
50 * @buf: Buffer to put the data that is read
51 * @return 0 if OK, -ve on error
53 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
56 * spi_flash_write_dm() - Write data to SPI flash
58 * @dev: SPI flash device
59 * @offset: Offset into device in bytes to write to
60 * @len: Number of bytes to write
61 * @buf: Buffer containing bytes to write
62 * @return 0 if OK, -ve on error
64 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
68 * spi_flash_erase_dm() - Erase blocks of the SPI flash
70 * Note that @len must be a muiltiple of the flash sector size.
72 * @dev: SPI flash device
73 * @offset: Offset into device in bytes to start erasing
74 * @len: Number of bytes to erase
75 * @return 0 if OK, -ve on error
77 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
80 * spi_flash_std_probe() - Probe a SPI flash device
82 * This is the standard internal method for probing a SPI flash device to
83 * determine its type. It can be used in chip-specific drivers which need to
84 * do this, typically with of-platdata
86 * @dev: SPI-flash device to probe
87 * @return 0 if OK, -ve on error
89 int spi_flash_std_probe(struct udevice *dev);
91 int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
92 unsigned int max_hz, unsigned int spi_mode,
93 struct udevice **devp);
95 /* Compatibility function - this is the old U-Boot API */
96 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
97 unsigned int max_hz, unsigned int spi_mode);
99 /* Compatibility function - this is the old U-Boot API */
100 static inline void spi_flash_free(struct spi_flash *flash)
104 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
105 size_t len, void *buf)
107 return spi_flash_read_dm(flash->dev, offset, len, buf);
110 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
111 size_t len, const void *buf)
113 return spi_flash_write_dm(flash->dev, offset, len, buf);
116 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
119 return spi_flash_erase_dm(flash->dev, offset, len);
122 struct sandbox_state;
124 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
125 struct udevice *bus, ofnode node, const char *spec);
127 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
130 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
131 unsigned int max_hz, unsigned int spi_mode);
133 void spi_flash_free(struct spi_flash *flash);
135 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
136 size_t len, void *buf)
138 struct mtd_info *mtd = &flash->mtd;
141 return mtd->_read(mtd, offset, len, &retlen, buf);
144 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
145 size_t len, const void *buf)
147 struct mtd_info *mtd = &flash->mtd;
150 return mtd->_write(mtd, offset, len, &retlen, buf);
153 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
156 struct mtd_info *mtd = &flash->mtd;
157 struct erase_info instr;
159 if (offset % mtd->erasesize || len % mtd->erasesize) {
160 printf("SF: Erase offset/length not multiple of erase size\n");
164 memset(&instr, 0, sizeof(instr));
168 return mtd->_erase(mtd, &instr);
172 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
175 if (!flash->flash_lock || !flash->flash_unlock)
179 return flash->flash_lock(flash, ofs, len);
181 return flash->flash_unlock(flash, ofs, len);
184 #endif /* _SPI_FLASH_H_ */