1 /* 2 * Common SPI flash Interface 3 * 4 * Copyright (C) 2008 Atmel Corporation 5 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. 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 12 * version 2 as published by the Free Software Foundation. 13 */ 14 15 #ifndef _SPI_FLASH_H_ 16 #define _SPI_FLASH_H_ 17 18 #include <dm.h> /* Because we dereference struct udevice here */ 19 #include <linux/types.h> 20 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 34 struct spi_slave; 35 36 /** 37 * struct spi_flash - SPI flash structure 38 * 39 * @spi: SPI slave 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 67 */ 68 struct spi_flash { 69 struct spi_slave *spi; 70 #ifdef CONFIG_DM_SPI_FLASH 71 struct udevice *dev; 72 #endif 73 const char *name; 74 u8 dual_flash; 75 u8 shift; 76 u16 flags; 77 78 u32 size; 79 u32 page_size; 80 u32 sector_size; 81 u32 erase_size; 82 #ifdef CONFIG_SPI_FLASH_BAR 83 u8 bank_read_cmd; 84 u8 bank_write_cmd; 85 u8 bank_curr; 86 #endif 87 u8 erase_cmd; 88 u8 read_cmd; 89 u8 write_cmd; 90 u8 dummy_byte; 91 92 void *memory_map; 93 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 98 /* 99 * These are not strictly needed for driver model, but keep them here 100 * while the transition is in progress. 101 * 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. 108 */ 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, 111 const void *buf); 112 int (*erase)(struct spi_flash *flash, u32 offset, size_t len); 113 #endif 114 }; 115 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, 119 const void *buf); 120 int (*erase)(struct udevice *dev, u32 offset, size_t len); 121 }; 122 123 /* Access the serial operations for a device */ 124 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops) 125 126 #ifdef CONFIG_DM_SPI_FLASH 127 /** 128 * spi_flash_read_dm() - Read data from SPI flash 129 * 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 135 */ 136 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); 137 138 /** 139 * spi_flash_write_dm() - Write data to SPI flash 140 * 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 146 */ 147 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, 148 const void *buf); 149 150 /** 151 * spi_flash_erase_dm() - Erase blocks of the SPI flash 152 * 153 * Note that @len must be a muiltiple of the flash sector size. 154 * 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 159 */ 160 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); 161 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); 165 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); 169 170 /* Compatibility function - this is the old U-Boot API */ 171 void spi_flash_free(struct spi_flash *flash); 172 173 int spi_flash_remove(struct udevice *flash); 174 175 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 176 size_t len, void *buf) 177 { 178 return spi_flash_read_dm(flash->dev, offset, len, buf); 179 } 180 181 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 182 size_t len, const void *buf) 183 { 184 return spi_flash_write_dm(flash->dev, offset, len, buf); 185 } 186 187 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 188 size_t len) 189 { 190 return spi_flash_erase_dm(flash->dev, offset, len); 191 } 192 193 struct sandbox_state; 194 195 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs, 196 struct udevice *bus, int of_offset, const char *spec); 197 198 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs); 199 200 #else 201 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 202 unsigned int max_hz, unsigned int spi_mode); 203 204 /** 205 * Set up a new SPI flash from an fdt node 206 * 207 * @param blob Device tree blob 208 * @param slave_node Pointer to this SPI slave node in the device tree 209 * @param spi_node Cached pointer to the SPI interface this node belongs 210 * to 211 * @return 0 if ok, -1 on error 212 */ 213 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node, 214 int spi_node); 215 216 void spi_flash_free(struct spi_flash *flash); 217 218 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 219 size_t len, void *buf) 220 { 221 return flash->read(flash, offset, len, buf); 222 } 223 224 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 225 size_t len, const void *buf) 226 { 227 return flash->write(flash, offset, len, buf); 228 } 229 230 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 231 size_t len) 232 { 233 return flash->erase(flash, offset, len); 234 } 235 #endif 236 237 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len, 238 bool prot) 239 { 240 if (!flash->flash_lock || !flash->flash_unlock) 241 return -EOPNOTSUPP; 242 243 if (prot) 244 return flash->flash_lock(flash, ofs, len); 245 else 246 return flash->flash_unlock(flash, ofs, len); 247 } 248 249 void spi_boot(void) __noreturn; 250 void spi_spl_load_image(uint32_t offs, unsigned int size, void *vdst); 251 252 #endif /* _SPI_FLASH_H_ */ 253