Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 2 | /* |
Jagannadha Sutradharudu Teki | 25dc86a | 2013-10-02 19:38:49 +0530 | [diff] [blame] | 3 | * Common SPI flash Interface |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 4 | * |
| 5 | * Copyright (C) 2008 Atmel Corporation |
Jagannadha Sutradharudu Teki | 25dc86a | 2013-10-02 19:38:49 +0530 | [diff] [blame] | 6 | * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 7 | */ |
Jagannadha Sutradharudu Teki | 25dc86a | 2013-10-02 19:38:49 +0530 | [diff] [blame] | 8 | |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 9 | #ifndef _SPI_FLASH_H_ |
| 10 | #define _SPI_FLASH_H_ |
| 11 | |
Mike Frysinger | e4c698b | 2009-11-03 11:36:39 -0500 | [diff] [blame] | 12 | #include <linux/types.h> |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 13 | #include <linux/mtd/spi-nor.h> |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 14 | |
Simon Glass | 7130b95 | 2020-07-19 10:15:40 -0600 | [diff] [blame] | 15 | struct udevice; |
| 16 | |
Simon Glass | d34b456 | 2014-10-13 23:42:04 -0600 | [diff] [blame] | 17 | struct spi_slave; |
Jagannadha Sutradharudu Teki | 20e45bc | 2013-12-23 23:34:42 +0530 | [diff] [blame] | 18 | |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 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, |
| 22 | const void *buf); |
| 23 | int (*erase)(struct udevice *dev, u32 offset, size_t len); |
Simon Glass | 61d0464 | 2021-03-15 18:11:17 +1300 | [diff] [blame] | 24 | /** |
| 25 | * get_sw_write_prot() - Check state of software write-protect feature |
| 26 | * |
| 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 |
| 29 | * defined. |
| 30 | * |
| 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 |
| 35 | */ |
| 36 | int (*get_sw_write_prot)(struct udevice *dev); |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 37 | }; |
| 38 | |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 39 | /* Access the serial operations for a device */ |
| 40 | #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops) |
| 41 | |
Lukasz Majewski | 76f44298 | 2020-06-04 23:11:53 +0800 | [diff] [blame] | 42 | #if CONFIG_IS_ENABLED(DM_SPI_FLASH) |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 43 | /** |
| 44 | * spi_flash_read_dm() - Read data from SPI flash |
| 45 | * |
| 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 |
| 51 | */ |
| 52 | int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); |
| 53 | |
| 54 | /** |
| 55 | * spi_flash_write_dm() - Write data to SPI flash |
| 56 | * |
| 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 |
| 62 | */ |
| 63 | int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, |
| 64 | const void *buf); |
| 65 | |
| 66 | /** |
| 67 | * spi_flash_erase_dm() - Erase blocks of the SPI flash |
| 68 | * |
| 69 | * Note that @len must be a muiltiple of the flash sector size. |
| 70 | * |
| 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 |
| 75 | */ |
| 76 | int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); |
| 77 | |
Simon Glass | 36eee8c | 2018-11-06 15:21:41 -0700 | [diff] [blame] | 78 | /** |
Simon Glass | 61d0464 | 2021-03-15 18:11:17 +1300 | [diff] [blame] | 79 | * spl_flash_get_sw_write_prot() - Check state of software write-protect feature |
| 80 | * |
| 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 |
| 83 | * defined. |
| 84 | * |
| 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 |
| 89 | */ |
| 90 | int spl_flash_get_sw_write_prot(struct udevice *dev); |
| 91 | |
| 92 | /** |
Simon Glass | a104b64 | 2019-12-06 21:42:50 -0700 | [diff] [blame] | 93 | * spi_flash_std_probe() - Probe a SPI flash device |
| 94 | * |
| 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 |
| 98 | * |
| 99 | * @dev: SPI-flash device to probe |
| 100 | * @return 0 if OK, -ve on error |
| 101 | */ |
| 102 | int spi_flash_std_probe(struct udevice *dev); |
| 103 | |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 104 | int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs, |
| 105 | unsigned int max_hz, unsigned int spi_mode, |
| 106 | struct udevice **devp); |
| 107 | |
| 108 | /* Compatibility function - this is the old U-Boot API */ |
| 109 | struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, |
| 110 | unsigned int max_hz, unsigned int spi_mode); |
| 111 | |
| 112 | /* Compatibility function - this is the old U-Boot API */ |
Heinrich Schuchardt | 6acba5a | 2021-03-10 18:23:57 +0100 | [diff] [blame] | 113 | static inline void spi_flash_free(struct spi_flash *flash) |
| 114 | { |
| 115 | } |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 116 | |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 117 | static inline int spi_flash_read(struct spi_flash *flash, u32 offset, |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 118 | size_t len, void *buf) |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 119 | { |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 120 | return spi_flash_read_dm(flash->dev, offset, len, buf); |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | static inline int spi_flash_write(struct spi_flash *flash, u32 offset, |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 124 | size_t len, const void *buf) |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 125 | { |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 126 | return spi_flash_write_dm(flash->dev, offset, len, buf); |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 130 | size_t len) |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 131 | { |
Simon Glass | 1c36923 | 2015-03-26 09:29:25 -0600 | [diff] [blame] | 132 | return spi_flash_erase_dm(flash->dev, offset, len); |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | struct sandbox_state; |
| 136 | |
| 137 | int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs, |
Simon Glass | f354863 | 2018-06-11 13:07:16 -0600 | [diff] [blame] | 138 | struct udevice *bus, ofnode node, const char *spec); |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 139 | |
| 140 | void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs); |
| 141 | |
| 142 | #else |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 143 | struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, |
| 144 | unsigned int max_hz, unsigned int spi_mode); |
Simon Glass | 49e9d2c | 2013-12-03 16:43:24 -0700 | [diff] [blame] | 145 | |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 146 | void spi_flash_free(struct spi_flash *flash); |
| 147 | |
| 148 | static inline int spi_flash_read(struct spi_flash *flash, u32 offset, |
| 149 | size_t len, void *buf) |
| 150 | { |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 151 | struct mtd_info *mtd = &flash->mtd; |
| 152 | size_t retlen; |
| 153 | |
Marek Behún | 375027a | 2021-10-05 15:56:01 +0200 | [diff] [blame] | 154 | if (!len) |
| 155 | return 0; |
| 156 | |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 157 | return mtd->_read(mtd, offset, len, &retlen, buf); |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | static inline int spi_flash_write(struct spi_flash *flash, u32 offset, |
| 161 | size_t len, const void *buf) |
| 162 | { |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 163 | struct mtd_info *mtd = &flash->mtd; |
| 164 | size_t retlen; |
| 165 | |
Marek Behún | 375027a | 2021-10-05 15:56:01 +0200 | [diff] [blame] | 166 | if (!len) |
| 167 | return 0; |
| 168 | |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 169 | return mtd->_write(mtd, offset, len, &retlen, buf); |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, |
| 173 | size_t len) |
| 174 | { |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 175 | struct mtd_info *mtd = &flash->mtd; |
| 176 | struct erase_info instr; |
| 177 | |
| 178 | if (offset % mtd->erasesize || len % mtd->erasesize) { |
| 179 | printf("SF: Erase offset/length not multiple of erase size\n"); |
| 180 | return -EINVAL; |
| 181 | } |
| 182 | |
Marek Behún | 375027a | 2021-10-05 15:56:01 +0200 | [diff] [blame] | 183 | if (!len) |
| 184 | return 0; |
| 185 | |
Vignesh R | 1451041 | 2019-02-05 11:29:23 +0530 | [diff] [blame] | 186 | memset(&instr, 0, sizeof(instr)); |
| 187 | instr.addr = offset; |
| 188 | instr.len = len; |
| 189 | |
| 190 | return mtd->_erase(mtd, &instr); |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 191 | } |
Simon Glass | d6eedf7 | 2014-10-13 23:42:06 -0600 | [diff] [blame] | 192 | #endif |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 193 | |
Fabio Estevam | 1cd8761 | 2015-11-05 12:43:42 -0200 | [diff] [blame] | 194 | static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len, |
| 195 | bool prot) |
| 196 | { |
Bin Meng | 66528f6 | 2015-11-13 02:46:26 -0800 | [diff] [blame] | 197 | if (!flash->flash_lock || !flash->flash_unlock) |
Fabio Estevam | 1cd8761 | 2015-11-05 12:43:42 -0200 | [diff] [blame] | 198 | return -EOPNOTSUPP; |
| 199 | |
| 200 | if (prot) |
| 201 | return flash->flash_lock(flash, ofs, len); |
| 202 | else |
| 203 | return flash->flash_unlock(flash, ofs, len); |
| 204 | } |
| 205 | |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 206 | #endif /* _SPI_FLASH_H_ */ |