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 <dm.h> /* Because we dereference struct udevice here */
13 #include <linux/types.h>
14 #include <linux/mtd/spi-nor.h>
18 struct dm_spi_flash_ops {
19 int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
20 int (*write)(struct udevice *dev, u32 offset, size_t len,
22 int (*erase)(struct udevice *dev, u32 offset, size_t len);
24 * get_sw_write_prot() - Check state of software write-protect feature
26 * SPI flash chips can lock a region of the flash defined by a
27 * 'protected area'. This function checks if this protected area is
30 * @dev: SPI flash device
31 * @return 0 if no region is write-protected, 1 if a region is
32 * write-protected, -ENOSYS if the driver does not implement this,
33 * other -ve value on error
35 int (*get_sw_write_prot)(struct udevice *dev);
38 /* Access the serial operations for a device */
39 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
41 #ifdef CONFIG_DM_SPI_FLASH
43 * spi_flash_read_dm() - Read data from SPI flash
45 * @dev: SPI flash device
46 * @offset: Offset into device in bytes to read from
47 * @len: Number of bytes to read
48 * @buf: Buffer to put the data that is read
49 * @return 0 if OK, -ve on error
51 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
54 * spi_flash_write_dm() - Write data to SPI flash
56 * @dev: SPI flash device
57 * @offset: Offset into device in bytes to write to
58 * @len: Number of bytes to write
59 * @buf: Buffer containing bytes to write
60 * @return 0 if OK, -ve on error
62 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
66 * spi_flash_erase_dm() - Erase blocks of the SPI flash
68 * Note that @len must be a muiltiple of the flash sector size.
70 * @dev: SPI flash device
71 * @offset: Offset into device in bytes to start erasing
72 * @len: Number of bytes to erase
73 * @return 0 if OK, -ve on error
75 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
78 * spl_flash_get_sw_write_prot() - Check state of software write-protect feature
80 * SPI flash chips can lock a region of the flash defined by a
81 * 'protected area'. This function checks if this protected area is
84 * @dev: SPI flash device
85 * @return 0 if no region is write-protected, 1 if a region is
86 * write-protected, -ENOSYS if the driver does not implement this,
87 * other -ve value on error
89 int spl_flash_get_sw_write_prot(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 void spi_flash_free(struct spi_flash *flash);
102 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
103 size_t len, void *buf)
105 return spi_flash_read_dm(flash->dev, offset, len, buf);
108 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
109 size_t len, const void *buf)
111 return spi_flash_write_dm(flash->dev, offset, len, buf);
114 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
117 return spi_flash_erase_dm(flash->dev, offset, len);
120 struct sandbox_state;
122 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
123 struct udevice *bus, ofnode node, const char *spec);
125 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
128 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
129 unsigned int max_hz, unsigned int spi_mode);
131 void spi_flash_free(struct spi_flash *flash);
133 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
134 size_t len, void *buf)
136 struct mtd_info *mtd = &flash->mtd;
139 return mtd->_read(mtd, offset, len, &retlen, buf);
142 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
143 size_t len, const void *buf)
145 struct mtd_info *mtd = &flash->mtd;
148 return mtd->_write(mtd, offset, len, &retlen, buf);
151 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
154 struct mtd_info *mtd = &flash->mtd;
155 struct erase_info instr;
157 if (offset % mtd->erasesize || len % mtd->erasesize) {
158 printf("SF: Erase offset/length not multiple of erase size\n");
162 memset(&instr, 0, sizeof(instr));
166 return mtd->_erase(mtd, &instr);
170 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
173 if (!flash->flash_lock || !flash->flash_unlock)
177 return flash->flash_lock(flash, ofs, len);
179 return flash->flash_unlock(flash, ofs, len);
182 #endif /* _SPI_FLASH_H_ */