]>
git.ipfire.org Git - thirdparty/u-boot.git/blob - include/spi_flash.h
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 <linux/types.h>
13 #include <linux/mtd/spi-nor.h>
19 struct dm_spi_flash_ops
{
20 int (*read
)(struct udevice
*dev
, u32 offset
, size_t len
, void *buf
);
21 int (*write
)(struct udevice
*dev
, u32 offset
, size_t len
,
23 int (*erase
)(struct udevice
*dev
, u32 offset
, size_t len
);
25 * get_sw_write_prot() - Check state of software write-protect feature
27 * SPI flash chips can lock a region of the flash defined by a
28 * 'protected area'. This function checks if this protected area is
31 * @dev: SPI flash device
32 * @return 0 if no region is write-protected, 1 if a region is
33 * write-protected, -ENOSYS if the driver does not implement this,
34 * other -ve value on error
36 int (*get_sw_write_prot
)(struct udevice
*dev
);
39 /* Access the serial operations for a device */
40 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
42 #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
44 * spi_flash_read_dm() - Read data from SPI flash
46 * @dev: SPI flash device
47 * @offset: Offset into device in bytes to read from
48 * @len: Number of bytes to read
49 * @buf: Buffer to put the data that is read
50 * Return: 0 if OK, -ve on error
52 int spi_flash_read_dm(struct udevice
*dev
, u32 offset
, size_t len
, void *buf
);
55 * spi_flash_write_dm() - Write data to SPI flash
57 * @dev: SPI flash device
58 * @offset: Offset into device in bytes to write to
59 * @len: Number of bytes to write
60 * @buf: Buffer containing bytes to write
61 * Return: 0 if OK, -ve on error
63 int spi_flash_write_dm(struct udevice
*dev
, u32 offset
, size_t len
,
67 * spi_flash_erase_dm() - Erase blocks of the SPI flash
69 * Note that @len must be a muiltiple of the flash sector size.
71 * @dev: SPI flash device
72 * @offset: Offset into device in bytes to start erasing
73 * @len: Number of bytes to erase
74 * Return: 0 if OK, -ve on error
76 int spi_flash_erase_dm(struct udevice
*dev
, u32 offset
, size_t len
);
79 * spl_flash_get_sw_write_prot() - Check state of software write-protect feature
81 * SPI flash chips can lock a region of the flash defined by a
82 * 'protected area'. This function checks if this protected area is
85 * @dev: SPI flash device
86 * Return: 0 if no region is write-protected, 1 if a region is
87 * write-protected, -ENOSYS if the driver does not implement this,
88 * other -ve value on error
90 int spl_flash_get_sw_write_prot(struct udevice
*dev
);
93 * spi_flash_std_probe() - Probe a SPI flash device
95 * This is the standard internal method for probing a SPI flash device to
96 * determine its type. It can be used in chip-specific drivers which need to
97 * do this, typically with of-platdata
99 * @dev: SPI-flash device to probe
100 * Return: 0 if OK, -ve on error
102 int spi_flash_std_probe(struct udevice
*dev
);
104 int spi_flash_probe_bus_cs(unsigned int busnum
, unsigned int cs
,
105 struct udevice
**devp
);
107 /* Compatibility function - this is the old U-Boot API */
108 struct spi_flash
*spi_flash_probe(unsigned int bus
, unsigned int cs
,
109 unsigned int max_hz
, unsigned int spi_mode
);
111 /* Compatibility function - this is the old U-Boot API */
112 static inline void spi_flash_free(struct spi_flash
*flash
)
116 static inline int spi_flash_read(struct spi_flash
*flash
, u32 offset
,
117 size_t len
, void *buf
)
119 return spi_flash_read_dm(flash
->dev
, offset
, len
, buf
);
122 static inline int spi_flash_write(struct spi_flash
*flash
, u32 offset
,
123 size_t len
, const void *buf
)
125 return spi_flash_write_dm(flash
->dev
, offset
, len
, buf
);
128 static inline int spi_flash_erase(struct spi_flash
*flash
, u32 offset
,
131 return spi_flash_erase_dm(flash
->dev
, offset
, len
);
134 struct sandbox_state
;
136 int sandbox_sf_bind_emul(struct sandbox_state
*state
, int busnum
, int cs
,
137 struct udevice
*bus
, ofnode node
, const char *spec
);
139 void sandbox_sf_unbind_emul(struct sandbox_state
*state
, int busnum
, int cs
);
142 struct spi_flash
*spi_flash_probe(unsigned int bus
, unsigned int cs
,
143 unsigned int max_hz
, unsigned int spi_mode
);
145 void spi_flash_free(struct spi_flash
*flash
);
147 static inline int spi_flash_read(struct spi_flash
*flash
, u32 offset
,
148 size_t len
, void *buf
)
150 struct mtd_info
*mtd
= &flash
->mtd
;
156 return mtd
->_read(mtd
, offset
, len
, &retlen
, buf
);
159 static inline int spi_flash_write(struct spi_flash
*flash
, u32 offset
,
160 size_t len
, const void *buf
)
162 struct mtd_info
*mtd
= &flash
->mtd
;
168 return mtd
->_write(mtd
, offset
, len
, &retlen
, buf
);
171 static inline int spi_flash_erase(struct spi_flash
*flash
, u32 offset
,
174 struct mtd_info
*mtd
= &flash
->mtd
;
175 struct erase_info instr
;
177 if (offset
% mtd
->erasesize
|| len
% mtd
->erasesize
) {
178 printf("SF: Erase offset/length not multiple of erase size\n");
185 memset(&instr
, 0, sizeof(instr
));
189 return mtd
->_erase(mtd
, &instr
);
193 static inline int spi_flash_protect(struct spi_flash
*flash
, u32 ofs
, u32 len
,
196 if (!flash
->flash_lock
|| !flash
->flash_unlock
)
200 return flash
->flash_lock(flash
, ofs
, len
);
202 return flash
->flash_unlock(flash
, ofs
, len
);
205 #endif /* _SPI_FLASH_H_ */