]>
git.ipfire.org Git - thirdparty/u-boot.git/blob - include/spi_flash.h
2 * Common SPI flash Interface
4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
7 * See file CREDITS for list of people who contributed to this
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * version 2 as published by the Free Software Foundation.
18 #include <dm.h> /* Because we dereference struct udevice here */
19 #include <linux/types.h>
21 #ifndef CONFIG_SF_DEFAULT_SPEED
22 # define CONFIG_SF_DEFAULT_SPEED 1000000
24 #ifndef CONFIG_SF_DEFAULT_MODE
25 # define CONFIG_SF_DEFAULT_MODE SPI_MODE_3
27 #ifndef CONFIG_SF_DEFAULT_CS
28 # define CONFIG_SF_DEFAULT_CS 0
30 #ifndef CONFIG_SF_DEFAULT_BUS
31 # define CONFIG_SF_DEFAULT_BUS 0
37 * struct spi_flash - SPI flash structure
40 * @dev: SPI flash device
41 * @name: Name of SPI flash
42 * @dual_flash: Indicates dual flash memories - dual stacked, parallel
43 * @shift: Flash shift useful in dual parallel
44 * @flags: Indication of spi flash flags
45 * @size: Total flash size
46 * @page_size: Write (page) size
47 * @sector_size: Sector size
48 * @erase_size: Erase size
49 * @bank_read_cmd: Bank read cmd
50 * @bank_write_cmd: Bank write cmd
51 * @bank_curr: Current flash bank
52 * @erase_cmd: Erase cmd 4K, 32K, 64K
53 * @read_cmd: Read cmd - Array Fast, Extn read and quad read.
54 * @write_cmd: Write cmd - page and quad program.
55 * @dummy_byte: Dummy cycles for read operation.
56 * @memory_map: Address of read-only SPI flash access
57 * @flash_lock: lock a region of the SPI Flash
58 * @flash_unlock: unlock a region of the SPI Flash
59 * @flash_is_locked: check if a region of the SPI Flash is completely locked
60 * @read: Flash read ops: Read len bytes at offset into buf
61 * Supported cmds: Fast Array Read
62 * @write: Flash write ops: Write len bytes from buf into offset
63 * Supported cmds: Page Program
64 * @erase: Flash erase ops: Erase len bytes from offset
65 * Supported cmds: Sector erase 4K, 32K, 64K
66 * return 0 - Success, 1 - Failure
69 struct spi_slave
*spi
;
70 #ifdef CONFIG_DM_SPI_FLASH
82 #ifdef CONFIG_SPI_FLASH_BAR
94 int (*flash_lock
)(struct spi_flash
*flash
, u32 ofs
, size_t len
);
95 int (*flash_unlock
)(struct spi_flash
*flash
, u32 ofs
, size_t len
);
96 int (*flash_is_locked
)(struct spi_flash
*flash
, u32 ofs
, size_t len
);
97 #ifndef CONFIG_DM_SPI_FLASH
99 * These are not strictly needed for driver model, but keep them here
100 * while the transition is in progress.
102 * Normally each driver would provide its own operations, but for
103 * SPI flash most chips use the same algorithms. One approach is
104 * to create a 'common' SPI flash device which knows how to talk
105 * to most devices, and then allow other drivers to be used instead
106 * if required, perhaps with a way of scanning through the list to
107 * find the driver that matches the device.
109 int (*read
)(struct spi_flash
*flash
, u32 offset
, size_t len
, void *buf
);
110 int (*write
)(struct spi_flash
*flash
, u32 offset
, size_t len
,
112 int (*erase
)(struct spi_flash
*flash
, u32 offset
, size_t len
);
116 struct dm_spi_flash_ops
{
117 int (*read
)(struct udevice
*dev
, u32 offset
, size_t len
, void *buf
);
118 int (*write
)(struct udevice
*dev
, u32 offset
, size_t len
,
120 int (*erase
)(struct udevice
*dev
, u32 offset
, size_t len
);
123 /* Access the serial operations for a device */
124 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
126 #ifdef CONFIG_DM_SPI_FLASH
128 * spi_flash_read_dm() - Read data from SPI flash
130 * @dev: SPI flash device
131 * @offset: Offset into device in bytes to read from
132 * @len: Number of bytes to read
133 * @buf: Buffer to put the data that is read
134 * @return 0 if OK, -ve on error
136 int spi_flash_read_dm(struct udevice
*dev
, u32 offset
, size_t len
, void *buf
);
139 * spi_flash_write_dm() - Write data to SPI flash
141 * @dev: SPI flash device
142 * @offset: Offset into device in bytes to write to
143 * @len: Number of bytes to write
144 * @buf: Buffer containing bytes to write
145 * @return 0 if OK, -ve on error
147 int spi_flash_write_dm(struct udevice
*dev
, u32 offset
, size_t len
,
151 * spi_flash_erase_dm() - Erase blocks of the SPI flash
153 * Note that @len must be a muiltiple of the flash sector size.
155 * @dev: SPI flash device
156 * @offset: Offset into device in bytes to start erasing
157 * @len: Number of bytes to erase
158 * @return 0 if OK, -ve on error
160 int spi_flash_erase_dm(struct udevice
*dev
, u32 offset
, size_t len
);
162 int spi_flash_probe_bus_cs(unsigned int busnum
, unsigned int cs
,
163 unsigned int max_hz
, unsigned int spi_mode
,
164 struct udevice
**devp
);
166 /* Compatibility function - this is the old U-Boot API */
167 struct spi_flash
*spi_flash_probe(unsigned int bus
, unsigned int cs
,
168 unsigned int max_hz
, unsigned int spi_mode
);
170 /* Compatibility function - this is the old U-Boot API */
171 void spi_flash_free(struct spi_flash
*flash
);
173 static inline int spi_flash_read(struct spi_flash
*flash
, u32 offset
,
174 size_t len
, void *buf
)
176 return spi_flash_read_dm(flash
->dev
, offset
, len
, buf
);
179 static inline int spi_flash_write(struct spi_flash
*flash
, u32 offset
,
180 size_t len
, const void *buf
)
182 return spi_flash_write_dm(flash
->dev
, offset
, len
, buf
);
185 static inline int spi_flash_erase(struct spi_flash
*flash
, u32 offset
,
188 return spi_flash_erase_dm(flash
->dev
, offset
, len
);
191 struct sandbox_state
;
193 int sandbox_sf_bind_emul(struct sandbox_state
*state
, int busnum
, int cs
,
194 struct udevice
*bus
, int of_offset
, const char *spec
);
196 void sandbox_sf_unbind_emul(struct sandbox_state
*state
, int busnum
, int cs
);
199 struct spi_flash
*spi_flash_probe(unsigned int bus
, unsigned int cs
,
200 unsigned int max_hz
, unsigned int spi_mode
);
203 * Set up a new SPI flash from an fdt node
205 * @param blob Device tree blob
206 * @param slave_node Pointer to this SPI slave node in the device tree
207 * @param spi_node Cached pointer to the SPI interface this node belongs
209 * @return 0 if ok, -1 on error
211 struct spi_flash
*spi_flash_probe_fdt(const void *blob
, int slave_node
,
214 void spi_flash_free(struct spi_flash
*flash
);
216 static inline int spi_flash_read(struct spi_flash
*flash
, u32 offset
,
217 size_t len
, void *buf
)
219 return flash
->read(flash
, offset
, len
, buf
);
222 static inline int spi_flash_write(struct spi_flash
*flash
, u32 offset
,
223 size_t len
, const void *buf
)
225 return flash
->write(flash
, offset
, len
, buf
);
228 static inline int spi_flash_erase(struct spi_flash
*flash
, u32 offset
,
231 return flash
->erase(flash
, offset
, len
);
235 static inline int spi_flash_protect(struct spi_flash
*flash
, u32 ofs
, u32 len
,
238 if (!flash
->flash_lock
|| !flash
->flash_unlock
)
242 return flash
->flash_lock(flash
, ofs
, len
);
244 return flash
->flash_unlock(flash
, ofs
, len
);
247 void spi_boot(void) __noreturn
;
248 void spi_spl_load_image(uint32_t offs
, unsigned int size
, void *vdst
);
250 #endif /* _SPI_FLASH_H_ */