]>
Commit | Line | Data |
---|---|---|
d25ce7d2 | 1 | /* |
a5e8199a | 2 | * Common SPI flash Interface |
d25ce7d2 HS |
3 | * |
4 | * Copyright (C) 2008 Atmel Corporation | |
a5e8199a | 5 | * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. |
d25ce7d2 HS |
6 | * |
7 | * See file CREDITS for list of people who contributed to this | |
8 | * project. | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or | |
11 | * modify it under the terms of the GNU General Public License | |
3765b3e7 | 12 | * version 2 as published by the Free Software Foundation. |
d25ce7d2 | 13 | */ |
a5e8199a | 14 | |
d25ce7d2 HS |
15 | #ifndef _SPI_FLASH_H_ |
16 | #define _SPI_FLASH_H_ | |
17 | ||
4c2dbefd | 18 | #include <dm.h> /* Because we dereference struct udevice here */ |
e06ab654 | 19 | #include <linux/types.h> |
d25ce7d2 | 20 | |
88e34e5f NK |
21 | #ifndef CONFIG_SF_DEFAULT_SPEED |
22 | # define CONFIG_SF_DEFAULT_SPEED 1000000 | |
23 | #endif | |
24 | #ifndef CONFIG_SF_DEFAULT_MODE | |
25 | # define CONFIG_SF_DEFAULT_MODE SPI_MODE_3 | |
26 | #endif | |
27 | #ifndef CONFIG_SF_DEFAULT_CS | |
28 | # define CONFIG_SF_DEFAULT_CS 0 | |
29 | #endif | |
30 | #ifndef CONFIG_SF_DEFAULT_BUS | |
31 | # define CONFIG_SF_DEFAULT_BUS 0 | |
32 | #endif | |
33 | ||
ff0960f9 | 34 | struct spi_slave; |
33adfb5f | 35 | |
7ab35d92 JT |
36 | /** |
37 | * struct spi_flash - SPI flash structure | |
38 | * | |
39 | * @spi: SPI slave | |
40 | * @name: Name of SPI flash | |
ff0960f9 | 41 | * @dual_flash: Indicates dual flash memories - dual stacked, parallel |
056fbc73 | 42 | * @shift: Flash shift useful in dual parallel |
7ab35d92 JT |
43 | * @size: Total flash size |
44 | * @page_size: Write (page) size | |
45 | * @sector_size: Sector size | |
ff0960f9 | 46 | * @erase_size: Erase size |
7ab35d92 JT |
47 | * @bank_read_cmd: Bank read cmd |
48 | * @bank_write_cmd: Bank write cmd | |
49 | * @bank_curr: Current flash bank | |
50 | * @poll_cmd: Poll cmd - for flash erase/program | |
51 | * @erase_cmd: Erase cmd 4K, 32K, 64K | |
3163aaa6 JT |
52 | * @read_cmd: Read cmd - Array Fast, Extn read and quad read. |
53 | * @write_cmd: Write cmd - page and quad program. | |
ff0960f9 SG |
54 | * @dummy_byte: Dummy cycles for read operation. |
55 | * @memory_map: Address of read-only SPI flash access | |
7ab35d92 JT |
56 | * @read: Flash read ops: Read len bytes at offset into buf |
57 | * Supported cmds: Fast Array Read | |
801cec59 | 58 | * @write: Flash write ops: Write len bytes from buf into offset |
7ab35d92 JT |
59 | * Supported cmds: Page Program |
60 | * @erase: Flash erase ops: Erase len bytes from offset | |
61 | * Supported cmds: Sector erase 4K, 32K, 64K | |
801cec59 | 62 | * return 0 - Success, 1 - Failure |
7ab35d92 | 63 | */ |
d25ce7d2 HS |
64 | struct spi_flash { |
65 | struct spi_slave *spi; | |
d15e74f1 | 66 | #ifdef CONFIG_DM_SPI_FLASH |
4c2dbefd | 67 | struct udevice *dev; |
be7be78e | 68 | u16 flags; |
4c2dbefd | 69 | #endif |
7ab35d92 | 70 | const char *name; |
f77f4691 | 71 | u8 dual_flash; |
056fbc73 | 72 | u8 shift; |
d25ce7d2 | 73 | |
7ab35d92 JT |
74 | u32 size; |
75 | u32 page_size; | |
76 | u32 sector_size; | |
77 | u32 erase_size; | |
1dcd6d03 | 78 | #ifdef CONFIG_SPI_FLASH_BAR |
7ab35d92 JT |
79 | u8 bank_read_cmd; |
80 | u8 bank_write_cmd; | |
81 | u8 bank_curr; | |
1dcd6d03 | 82 | #endif |
7ab35d92 JT |
83 | u8 poll_cmd; |
84 | u8 erase_cmd; | |
4e09cc1e | 85 | u8 read_cmd; |
3163aaa6 | 86 | u8 write_cmd; |
ff063ed4 | 87 | u8 dummy_byte; |
615a1561 | 88 | |
7ab35d92 | 89 | void *memory_map; |
4c2dbefd SG |
90 | #ifndef CONFIG_DM_SPI_FLASH |
91 | /* | |
92 | * These are not strictly needed for driver model, but keep them here | |
d15e74f1 | 93 | * while the transition is in progress. |
4c2dbefd SG |
94 | * |
95 | * Normally each driver would provide its own operations, but for | |
96 | * SPI flash most chips use the same algorithms. One approach is | |
97 | * to create a 'common' SPI flash device which knows how to talk | |
98 | * to most devices, and then allow other drivers to be used instead | |
d15e74f1 | 99 | * if required, perhaps with a way of scanning through the list to |
4c2dbefd SG |
100 | * find the driver that matches the device. |
101 | */ | |
7ab35d92 JT |
102 | int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf); |
103 | int (*write)(struct spi_flash *flash, u32 offset, size_t len, | |
104 | const void *buf); | |
105 | int (*erase)(struct spi_flash *flash, u32 offset, size_t len); | |
4c2dbefd SG |
106 | #endif |
107 | }; | |
108 | ||
109 | struct dm_spi_flash_ops { | |
110 | int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf); | |
111 | int (*write)(struct udevice *dev, u32 offset, size_t len, | |
112 | const void *buf); | |
113 | int (*erase)(struct udevice *dev, u32 offset, size_t len); | |
d25ce7d2 HS |
114 | }; |
115 | ||
4c2dbefd SG |
116 | /* Access the serial operations for a device */ |
117 | #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops) | |
118 | ||
119 | #ifdef CONFIG_DM_SPI_FLASH | |
8d987abc SG |
120 | /** |
121 | * spi_flash_read_dm() - Read data from SPI flash | |
122 | * | |
123 | * @dev: SPI flash device | |
124 | * @offset: Offset into device in bytes to read from | |
125 | * @len: Number of bytes to read | |
126 | * @buf: Buffer to put the data that is read | |
127 | * @return 0 if OK, -ve on error | |
128 | */ | |
129 | int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); | |
130 | ||
131 | /** | |
132 | * spi_flash_write_dm() - Write data to SPI flash | |
133 | * | |
134 | * @dev: SPI flash device | |
135 | * @offset: Offset into device in bytes to write to | |
136 | * @len: Number of bytes to write | |
137 | * @buf: Buffer containing bytes to write | |
138 | * @return 0 if OK, -ve on error | |
139 | */ | |
140 | int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, | |
141 | const void *buf); | |
142 | ||
143 | /** | |
144 | * spi_flash_erase_dm() - Erase blocks of the SPI flash | |
145 | * | |
146 | * Note that @len must be a muiltiple of the flash sector size. | |
147 | * | |
148 | * @dev: SPI flash device | |
149 | * @offset: Offset into device in bytes to start erasing | |
150 | * @len: Number of bytes to erase | |
151 | * @return 0 if OK, -ve on error | |
152 | */ | |
153 | int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); | |
154 | ||
4c2dbefd SG |
155 | int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs, |
156 | unsigned int max_hz, unsigned int spi_mode, | |
157 | struct udevice **devp); | |
158 | ||
159 | /* Compatibility function - this is the old U-Boot API */ | |
160 | struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, | |
161 | unsigned int max_hz, unsigned int spi_mode); | |
162 | ||
163 | /* Compatibility function - this is the old U-Boot API */ | |
164 | void spi_flash_free(struct spi_flash *flash); | |
165 | ||
166 | int spi_flash_remove(struct udevice *flash); | |
167 | ||
168 | static inline int spi_flash_read(struct spi_flash *flash, u32 offset, | |
8d987abc | 169 | size_t len, void *buf) |
4c2dbefd | 170 | { |
8d987abc | 171 | return spi_flash_read_dm(flash->dev, offset, len, buf); |
4c2dbefd SG |
172 | } |
173 | ||
174 | static inline int spi_flash_write(struct spi_flash *flash, u32 offset, | |
8d987abc | 175 | size_t len, const void *buf) |
4c2dbefd | 176 | { |
8d987abc | 177 | return spi_flash_write_dm(flash->dev, offset, len, buf); |
4c2dbefd SG |
178 | } |
179 | ||
180 | static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, | |
8d987abc | 181 | size_t len) |
4c2dbefd | 182 | { |
8d987abc | 183 | return spi_flash_erase_dm(flash->dev, offset, len); |
4c2dbefd SG |
184 | } |
185 | ||
186 | struct sandbox_state; | |
187 | ||
188 | int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs, | |
189 | struct udevice *bus, int of_offset, const char *spec); | |
190 | ||
191 | void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs); | |
192 | ||
193 | #else | |
d25ce7d2 HS |
194 | struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, |
195 | unsigned int max_hz, unsigned int spi_mode); | |
0efc0249 SG |
196 | |
197 | /** | |
198 | * Set up a new SPI flash from an fdt node | |
199 | * | |
200 | * @param blob Device tree blob | |
201 | * @param slave_node Pointer to this SPI slave node in the device tree | |
202 | * @param spi_node Cached pointer to the SPI interface this node belongs | |
203 | * to | |
204 | * @return 0 if ok, -1 on error | |
205 | */ | |
206 | struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node, | |
207 | int spi_node); | |
208 | ||
d25ce7d2 HS |
209 | void spi_flash_free(struct spi_flash *flash); |
210 | ||
211 | static inline int spi_flash_read(struct spi_flash *flash, u32 offset, | |
212 | size_t len, void *buf) | |
213 | { | |
214 | return flash->read(flash, offset, len, buf); | |
215 | } | |
216 | ||
217 | static inline int spi_flash_write(struct spi_flash *flash, u32 offset, | |
218 | size_t len, const void *buf) | |
219 | { | |
220 | return flash->write(flash, offset, len, buf); | |
221 | } | |
222 | ||
223 | static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, | |
224 | size_t len) | |
225 | { | |
226 | return flash->erase(flash, offset, len); | |
227 | } | |
4c2dbefd | 228 | #endif |
d25ce7d2 | 229 | |
32b11273 | 230 | void spi_boot(void) __noreturn; |
1eaa742d | 231 | void spi_spl_load_image(uint32_t offs, unsigned int size, void *vdst); |
32b11273 | 232 | |
d25ce7d2 | 233 | #endif /* _SPI_FLASH_H_ */ |