1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Common SPI flash Interface
4 *
5 * Copyright (C) 2008 Atmel Corporation
6 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
7 */
8
9 #ifndef _SPI_FLASH_H_
10 #define _SPI_FLASH_H_
11
12 #include <linux/types.h>
13 #include <linux/mtd/spi-nor.h>
14
15 struct udevice;
16
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
20 #endif
21 #ifndef CONFIG_ENV_SPI_CS
22 # define CONFIG_ENV_SPI_CS CONFIG_SF_DEFAULT_CS
23 #endif
24 #ifndef CONFIG_ENV_SPI_MAX_HZ
25 # define CONFIG_ENV_SPI_MAX_HZ CONFIG_SF_DEFAULT_SPEED
26 #endif
27 #ifndef CONFIG_ENV_SPI_MODE
28 # define CONFIG_ENV_SPI_MODE CONFIG_SF_DEFAULT_MODE
29 #endif
30
31 struct spi_slave;
32
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,
36 const void *buf);
37 int (*erase)(struct udevice *dev, u32 offset, size_t len);
38 };
39
40 /* Access the serial operations for a device */
41 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
42
43 #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
44 /**
45 * spi_flash_read_dm() - Read data from SPI flash
46 *
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
52 */
53 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
54
55 /**
56 * spi_flash_write_dm() - Write data to SPI flash
57 *
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
63 */
64 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
65 const void *buf);
66
67 /**
68 * spi_flash_erase_dm() - Erase blocks of the SPI flash
69 *
70 * Note that @len must be a muiltiple of the flash sector size.
71 *
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
76 */
77 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
78
79 /**
80 * spi_flash_std_probe() - Probe a SPI flash device
81 *
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
85 *
86 * @dev: SPI-flash device to probe
87 * @return 0 if OK, -ve on error
88 */
89 int spi_flash_std_probe(struct udevice *dev);
90
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);
94
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);
98
99 /* Compatibility function - this is the old U-Boot API */
100 void spi_flash_free(struct spi_flash *flash);
101
spi_flash_read(struct spi_flash * flash,u32 offset,size_t len,void * buf)102 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
103 size_t len, void *buf)
104 {
105 return spi_flash_read_dm(flash->dev, offset, len, buf);
106 }
107
spi_flash_write(struct spi_flash * flash,u32 offset,size_t len,const void * buf)108 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
109 size_t len, const void *buf)
110 {
111 return spi_flash_write_dm(flash->dev, offset, len, buf);
112 }
113
spi_flash_erase(struct spi_flash * flash,u32 offset,size_t len)114 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
115 size_t len)
116 {
117 return spi_flash_erase_dm(flash->dev, offset, len);
118 }
119
120 struct sandbox_state;
121
122 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
123 struct udevice *bus, ofnode node, const char *spec);
124
125 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
126
127 #else
128 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
129 unsigned int max_hz, unsigned int spi_mode);
130
131 void spi_flash_free(struct spi_flash *flash);
132
spi_flash_read(struct spi_flash * flash,u32 offset,size_t len,void * buf)133 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
134 size_t len, void *buf)
135 {
136 struct mtd_info *mtd = &flash->mtd;
137 size_t retlen;
138
139 return mtd->_read(mtd, offset, len, &retlen, buf);
140 }
141
spi_flash_write(struct spi_flash * flash,u32 offset,size_t len,const void * buf)142 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
143 size_t len, const void *buf)
144 {
145 struct mtd_info *mtd = &flash->mtd;
146 size_t retlen;
147
148 return mtd->_write(mtd, offset, len, &retlen, buf);
149 }
150
spi_flash_erase(struct spi_flash * flash,u32 offset,size_t len)151 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
152 size_t len)
153 {
154 struct mtd_info *mtd = &flash->mtd;
155 struct erase_info instr;
156
157 if (offset % mtd->erasesize || len % mtd->erasesize) {
158 printf("SF: Erase offset/length not multiple of erase size\n");
159 return -EINVAL;
160 }
161
162 memset(&instr, 0, sizeof(instr));
163 instr.addr = offset;
164 instr.len = len;
165
166 return mtd->_erase(mtd, &instr);
167 }
168 #endif
169
spi_flash_protect(struct spi_flash * flash,u32 ofs,u32 len,bool prot)170 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
171 bool prot)
172 {
173 if (!flash->flash_lock || !flash->flash_unlock)
174 return -EOPNOTSUPP;
175
176 if (prot)
177 return flash->flash_lock(flash, ofs, len);
178 else
179 return flash->flash_unlock(flash, ofs, len);
180 }
181
182 #endif /* _SPI_FLASH_H_ */
183