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 <dm.h> /* Because we dereference struct udevice here */
13 #include <linux/types.h>
14 #include <linux/mtd/spi-nor.h>
15
16 /* by default ENV use the same parameters than SF command */
17 #ifndef CONFIG_ENV_SPI_BUS
18 # define CONFIG_ENV_SPI_BUS CONFIG_SF_DEFAULT_BUS
19 #endif
20 #ifndef CONFIG_ENV_SPI_CS
21 # define CONFIG_ENV_SPI_CS CONFIG_SF_DEFAULT_CS
22 #endif
23 #ifndef CONFIG_ENV_SPI_MAX_HZ
24 # define CONFIG_ENV_SPI_MAX_HZ CONFIG_SF_DEFAULT_SPEED
25 #endif
26 #ifndef CONFIG_ENV_SPI_MODE
27 # define CONFIG_ENV_SPI_MODE CONFIG_SF_DEFAULT_MODE
28 #endif
29
30 struct spi_slave;
31
32 struct dm_spi_flash_ops {
33 int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
34 int (*write)(struct udevice *dev, u32 offset, size_t len,
35 const void *buf);
36 int (*erase)(struct udevice *dev, u32 offset, size_t len);
37 /**
38 * get_sw_write_prot() - Check state of software write-protect feature
39 *
40 * SPI flash chips can lock a region of the flash defined by a
41 * 'protected area'. This function checks if this protected area is
42 * defined.
43 *
44 * @dev: SPI flash device
45 * @return 0 if no region is write-protected, 1 if a region is
46 * write-protected, -ENOSYS if the driver does not implement this,
47 * other -ve value on error
48 */
49 int (*get_sw_write_prot)(struct udevice *dev);
50 };
51
52 /* Access the serial operations for a device */
53 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
54
55 #ifdef CONFIG_DM_SPI_FLASH
56 /**
57 * spi_flash_read_dm() - Read data from SPI flash
58 *
59 * @dev: SPI flash device
60 * @offset: Offset into device in bytes to read from
61 * @len: Number of bytes to read
62 * @buf: Buffer to put the data that is read
63 * @return 0 if OK, -ve on error
64 */
65 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
66
67 /**
68 * spi_flash_write_dm() - Write data to SPI flash
69 *
70 * @dev: SPI flash device
71 * @offset: Offset into device in bytes to write to
72 * @len: Number of bytes to write
73 * @buf: Buffer containing bytes to write
74 * @return 0 if OK, -ve on error
75 */
76 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
77 const void *buf);
78
79 /**
80 * spi_flash_erase_dm() - Erase blocks of the SPI flash
81 *
82 * Note that @len must be a muiltiple of the flash sector size.
83 *
84 * @dev: SPI flash device
85 * @offset: Offset into device in bytes to start erasing
86 * @len: Number of bytes to erase
87 * @return 0 if OK, -ve on error
88 */
89 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
90
91 /**
92 * spl_flash_get_sw_write_prot() - Check state of software write-protect feature
93 *
94 * SPI flash chips can lock a region of the flash defined by a
95 * 'protected area'. This function checks if this protected area is
96 * defined.
97 *
98 * @dev: SPI flash device
99 * @return 0 if no region is write-protected, 1 if a region is
100 * write-protected, -ENOSYS if the driver does not implement this,
101 * other -ve value on error
102 */
103 int spl_flash_get_sw_write_prot(struct udevice *dev);
104
105 int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
106 unsigned int max_hz, unsigned int spi_mode,
107 struct udevice **devp);
108
109 /* Compatibility function - this is the old U-Boot API */
110 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
111 unsigned int max_hz, unsigned int spi_mode);
112
113 /* Compatibility function - this is the old U-Boot API */
114 void spi_flash_free(struct spi_flash *flash);
115
spi_flash_read(struct spi_flash * flash,u32 offset,size_t len,void * buf)116 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
117 size_t len, void *buf)
118 {
119 return spi_flash_read_dm(flash->dev, offset, len, buf);
120 }
121
spi_flash_write(struct spi_flash * flash,u32 offset,size_t len,const void * buf)122 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
123 size_t len, const void *buf)
124 {
125 return spi_flash_write_dm(flash->dev, offset, len, buf);
126 }
127
spi_flash_erase(struct spi_flash * flash,u32 offset,size_t len)128 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
129 size_t len)
130 {
131 return spi_flash_erase_dm(flash->dev, offset, len);
132 }
133
134 struct sandbox_state;
135
136 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
137 struct udevice *bus, ofnode node, const char *spec);
138
139 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
140
141 #else
142 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
143 unsigned int max_hz, unsigned int spi_mode);
144
145 void spi_flash_free(struct spi_flash *flash);
146
spi_flash_read(struct spi_flash * flash,u32 offset,size_t len,void * buf)147 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
148 size_t len, void *buf)
149 {
150 struct mtd_info *mtd = &flash->mtd;
151 size_t retlen;
152
153 return mtd->_read(mtd, offset, len, &retlen, buf);
154 }
155
spi_flash_write(struct spi_flash * flash,u32 offset,size_t len,const void * buf)156 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
157 size_t len, const void *buf)
158 {
159 struct mtd_info *mtd = &flash->mtd;
160 size_t retlen;
161
162 return mtd->_write(mtd, offset, len, &retlen, buf);
163 }
164
spi_flash_erase(struct spi_flash * flash,u32 offset,size_t len)165 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
166 size_t len)
167 {
168 struct mtd_info *mtd = &flash->mtd;
169 struct erase_info instr;
170
171 if (offset % mtd->erasesize || len % mtd->erasesize) {
172 printf("SF: Erase offset/length not multiple of erase size\n");
173 return -EINVAL;
174 }
175
176 memset(&instr, 0, sizeof(instr));
177 instr.addr = offset;
178 instr.len = len;
179
180 return mtd->_erase(mtd, &instr);
181 }
182 #endif
183
spi_flash_protect(struct spi_flash * flash,u32 ofs,u32 len,bool prot)184 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
185 bool prot)
186 {
187 if (!flash->flash_lock || !flash->flash_unlock)
188 return -EOPNOTSUPP;
189
190 if (prot)
191 return flash->flash_lock(flash, ofs, len);
192 else
193 return flash->flash_unlock(flash, ofs, len);
194 }
195
196 #endif /* _SPI_FLASH_H_ */
197