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 * @name: Name of SPI flash 41 * @dual_flash: Indicates dual flash memories - dual stacked, parallel 42 * @shift: Flash shift useful in dual parallel 43 * @size: Total flash size 44 * @page_size: Write (page) size 45 * @sector_size: Sector size 46 * @erase_size: Erase size 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 52 * @read_cmd: Read cmd - Array Fast, Extn read and quad read. 53 * @write_cmd: Write cmd - page and quad program. 54 * @dummy_byte: Dummy cycles for read operation. 55 * @memory_map: Address of read-only SPI flash access 56 * @read: Flash read ops: Read len bytes at offset into buf 57 * Supported cmds: Fast Array Read 58 * @write: Flash write ops: Write len bytes from buf into offset 59 * Supported cmds: Page Program 60 * @erase: Flash erase ops: Erase len bytes from offset 61 * Supported cmds: Sector erase 4K, 32K, 64K 62 * return 0 - Success, 1 - Failure 63 */ 64 struct spi_flash { 65 #ifdef CONFIG_DM_SPI_FLASH 66 struct spi_slave *spi; 67 struct udevice *dev; 68 #else 69 struct spi_slave *spi; 70 #endif 71 const char *name; 72 u8 dual_flash; 73 u8 shift; 74 75 u32 size; 76 u32 page_size; 77 u32 sector_size; 78 u32 erase_size; 79 #ifdef CONFIG_SPI_FLASH_BAR 80 u8 bank_read_cmd; 81 u8 bank_write_cmd; 82 u8 bank_curr; 83 #endif 84 u8 poll_cmd; 85 u8 erase_cmd; 86 u8 read_cmd; 87 u8 write_cmd; 88 u8 dummy_byte; 89 90 void *memory_map; 91 #ifndef CONFIG_DM_SPI_FLASH 92 /* 93 * These are not strictly needed for driver model, but keep them here 94 * whilt the transition is in progress. 95 * 96 * Normally each driver would provide its own operations, but for 97 * SPI flash most chips use the same algorithms. One approach is 98 * to create a 'common' SPI flash device which knows how to talk 99 * to most devices, and then allow other drivers to be used instead 100 * if requird, perhaps with a way of scanning through the list to 101 * find the driver that matches the device. 102 */ 103 int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf); 104 int (*write)(struct spi_flash *flash, u32 offset, size_t len, 105 const void *buf); 106 int (*erase)(struct spi_flash *flash, u32 offset, size_t len); 107 #endif 108 }; 109 110 struct dm_spi_flash_ops { 111 int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf); 112 int (*write)(struct udevice *dev, u32 offset, size_t len, 113 const void *buf); 114 int (*erase)(struct udevice *dev, u32 offset, size_t len); 115 }; 116 117 /* Access the serial operations for a device */ 118 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops) 119 120 #ifdef CONFIG_DM_SPI_FLASH 121 /** 122 * spi_flash_read_dm() - Read data from SPI flash 123 * 124 * @dev: SPI flash device 125 * @offset: Offset into device in bytes to read from 126 * @len: Number of bytes to read 127 * @buf: Buffer to put the data that is read 128 * @return 0 if OK, -ve on error 129 */ 130 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); 131 132 /** 133 * spi_flash_write_dm() - Write data to SPI flash 134 * 135 * @dev: SPI flash device 136 * @offset: Offset into device in bytes to write to 137 * @len: Number of bytes to write 138 * @buf: Buffer containing bytes to write 139 * @return 0 if OK, -ve on error 140 */ 141 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, 142 const void *buf); 143 144 /** 145 * spi_flash_erase_dm() - Erase blocks of the SPI flash 146 * 147 * Note that @len must be a muiltiple of the flash sector size. 148 * 149 * @dev: SPI flash device 150 * @offset: Offset into device in bytes to start erasing 151 * @len: Number of bytes to erase 152 * @return 0 if OK, -ve on error 153 */ 154 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); 155 156 int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs, 157 unsigned int max_hz, unsigned int spi_mode, 158 struct udevice **devp); 159 160 /* Compatibility function - this is the old U-Boot API */ 161 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 162 unsigned int max_hz, unsigned int spi_mode); 163 164 /* Compatibility function - this is the old U-Boot API */ 165 void spi_flash_free(struct spi_flash *flash); 166 167 int spi_flash_remove(struct udevice *flash); 168 169 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 170 size_t len, void *buf) 171 { 172 return spi_flash_read_dm(flash->dev, offset, len, buf); 173 } 174 175 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 176 size_t len, const void *buf) 177 { 178 return spi_flash_write_dm(flash->dev, offset, len, buf); 179 } 180 181 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 182 size_t len) 183 { 184 return spi_flash_erase_dm(flash->dev, offset, len); 185 } 186 187 struct sandbox_state; 188 189 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs, 190 struct udevice *bus, int of_offset, const char *spec); 191 192 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs); 193 194 #else 195 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 196 unsigned int max_hz, unsigned int spi_mode); 197 198 /** 199 * Set up a new SPI flash from an fdt node 200 * 201 * @param blob Device tree blob 202 * @param slave_node Pointer to this SPI slave node in the device tree 203 * @param spi_node Cached pointer to the SPI interface this node belongs 204 * to 205 * @return 0 if ok, -1 on error 206 */ 207 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node, 208 int spi_node); 209 210 void spi_flash_free(struct spi_flash *flash); 211 212 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 213 size_t len, void *buf) 214 { 215 return flash->read(flash, offset, len, buf); 216 } 217 218 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 219 size_t len, const void *buf) 220 { 221 return flash->write(flash, offset, len, buf); 222 } 223 224 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 225 size_t len) 226 { 227 return flash->erase(flash, offset, len); 228 } 229 #endif 230 231 void spi_boot(void) __noreturn; 232 void spi_spl_load_image(uint32_t offs, unsigned int size, void *vdst); 233 234 #endif /* _SPI_FLASH_H_ */ 235