blob: 3b2d555c77babb1f3b73dc96c464e9c40a509eda [file] [log] [blame]
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +02001/*
Jagannadha Sutradharudu Tekia5e81992013-10-02 19:38:49 +05302 * Common SPI flash Interface
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +02003 *
4 * Copyright (C) 2008 Atmel Corporation
Jagannadha Sutradharudu Tekia5e81992013-10-02 19:38:49 +05305 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +02006 *
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
Wolfgang Denk3765b3e2013-10-07 13:07:26 +020012 * version 2 as published by the Free Software Foundation.
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020013 */
Jagannadha Sutradharudu Tekia5e81992013-10-02 19:38:49 +053014
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020015#ifndef _SPI_FLASH_H_
16#define _SPI_FLASH_H_
17
Simon Glass4c2dbef2014-10-13 23:42:06 -060018#include <dm.h> /* Because we dereference struct udevice here */
Mike Frysingere06ab652009-11-03 11:36:39 -050019#include <linux/types.h>
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020020
Nikita Kiryanov88e34e52014-08-20 15:08:48 +030021#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
Simon Glassff0960f2014-10-13 23:42:04 -060034struct spi_slave;
Jagannadha Sutradharudu Teki33adfb52013-12-23 23:34:42 +053035
36/**
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053037 * struct spi_flash - SPI flash structure
38 *
39 * @spi: SPI slave
Jagan Teki5d69df32015-06-27 00:51:30 +053040 * @dev: SPI flash device
41 * @flags: Indication of spi flash flags
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053042 * @name: Name of SPI flash
Jagan Teki5d69df32015-06-27 00:51:30 +053043 * @dual_flash: Indicates dual flash memories - dual stacked, parallel
Jagannadha Sutradharudu Teki056fbc72014-01-07 00:11:35 +053044 * @shift: Flash shift useful in dual parallel
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053045 * @size: Total flash size
46 * @page_size: Write (page) size
47 * @sector_size: Sector size
Jagan Teki5d69df32015-06-27 00:51:30 +053048 * @erase_size: Erase size
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053049 * @bank_read_cmd: Bank read cmd
50 * @bank_write_cmd: Bank write cmd
51 * @bank_curr: Current flash bank
52 * @poll_cmd: Poll cmd - for flash erase/program
53 * @erase_cmd: Erase cmd 4K, 32K, 64K
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053054 * @read_cmd: Read cmd - Array Fast, Extn read and quad read.
55 * @write_cmd: Write cmd - page and quad program.
Jagan Teki5d69df32015-06-27 00:51:30 +053056 * @dummy_byte: Dummy cycles for read operation.
57 * @memory_map: Address of read-only SPI flash access
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053058 * @read: Flash read ops: Read len bytes at offset into buf
59 * Supported cmds: Fast Array Read
Vasili Galka801cec52014-03-04 17:24:09 +020060 * @write: Flash write ops: Write len bytes from buf into offset
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053061 * Supported cmds: Page Program
62 * @erase: Flash erase ops: Erase len bytes from offset
63 * Supported cmds: Sector erase 4K, 32K, 64K
Vasili Galka801cec52014-03-04 17:24:09 +020064 * return 0 - Success, 1 - Failure
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053065 */
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020066struct spi_flash {
Pavel Machekd15e74f2015-04-21 10:37:45 +020067 struct spi_slave *spi;
Simon Glass4c2dbef2014-10-13 23:42:06 -060068#ifdef CONFIG_DM_SPI_FLASH
Simon Glass4c2dbef2014-10-13 23:42:06 -060069 struct udevice *dev;
Bin Mengbe7be782015-04-28 13:29:54 +053070 u16 flags;
Simon Glass4c2dbef2014-10-13 23:42:06 -060071#endif
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053072 const char *name;
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +053073 u8 dual_flash;
Jagannadha Sutradharudu Teki056fbc72014-01-07 00:11:35 +053074 u8 shift;
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020075
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053076 u32 size;
77 u32 page_size;
78 u32 sector_size;
79 u32 erase_size;
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +053080#ifdef CONFIG_SPI_FLASH_BAR
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053081 u8 bank_read_cmd;
82 u8 bank_write_cmd;
83 u8 bank_curr;
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +053084#endif
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053085 u8 poll_cmd;
86 u8 erase_cmd;
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053087 u8 read_cmd;
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053088 u8 write_cmd;
Jagannadha Sutradharudu Tekiff063ed2014-01-11 16:50:45 +053089 u8 dummy_byte;
Jagannadha Sutradharudu Teki615a1562013-06-21 15:56:30 +053090
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053091 void *memory_map;
Simon Glass4c2dbef2014-10-13 23:42:06 -060092#ifndef CONFIG_DM_SPI_FLASH
93 /*
94 * These are not strictly needed for driver model, but keep them here
Pavel Machekd15e74f2015-04-21 10:37:45 +020095 * while the transition is in progress.
Simon Glass4c2dbef2014-10-13 23:42:06 -060096 *
97 * Normally each driver would provide its own operations, but for
98 * SPI flash most chips use the same algorithms. One approach is
99 * to create a 'common' SPI flash device which knows how to talk
100 * to most devices, and then allow other drivers to be used instead
Pavel Machekd15e74f2015-04-21 10:37:45 +0200101 * if required, perhaps with a way of scanning through the list to
Simon Glass4c2dbef2014-10-13 23:42:06 -0600102 * find the driver that matches the device.
103 */
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +0530104 int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf);
105 int (*write)(struct spi_flash *flash, u32 offset, size_t len,
106 const void *buf);
107 int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
Simon Glass4c2dbef2014-10-13 23:42:06 -0600108#endif
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +0200109};
110
Simon Glass4c2dbef2014-10-13 23:42:06 -0600111struct dm_spi_flash_ops {
112 int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
113 int (*write)(struct udevice *dev, u32 offset, size_t len,
114 const void *buf);
115 int (*erase)(struct udevice *dev, u32 offset, size_t len);
116};
117
118/* Access the serial operations for a device */
119#define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
120
121#ifdef CONFIG_DM_SPI_FLASH
Simon Glass8d987ab2015-03-26 09:29:25 -0600122/**
123 * spi_flash_read_dm() - Read data from SPI flash
124 *
125 * @dev: SPI flash device
126 * @offset: Offset into device in bytes to read from
127 * @len: Number of bytes to read
128 * @buf: Buffer to put the data that is read
129 * @return 0 if OK, -ve on error
130 */
131int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
132
133/**
134 * spi_flash_write_dm() - Write data to SPI flash
135 *
136 * @dev: SPI flash device
137 * @offset: Offset into device in bytes to write to
138 * @len: Number of bytes to write
139 * @buf: Buffer containing bytes to write
140 * @return 0 if OK, -ve on error
141 */
142int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
143 const void *buf);
144
145/**
146 * spi_flash_erase_dm() - Erase blocks of the SPI flash
147 *
148 * Note that @len must be a muiltiple of the flash sector size.
149 *
150 * @dev: SPI flash device
151 * @offset: Offset into device in bytes to start erasing
152 * @len: Number of bytes to erase
153 * @return 0 if OK, -ve on error
154 */
155int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
156
Simon Glass4c2dbef2014-10-13 23:42:06 -0600157int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
158 unsigned int max_hz, unsigned int spi_mode,
159 struct udevice **devp);
160
161/* Compatibility function - this is the old U-Boot API */
162struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
163 unsigned int max_hz, unsigned int spi_mode);
164
165/* Compatibility function - this is the old U-Boot API */
166void spi_flash_free(struct spi_flash *flash);
167
168int spi_flash_remove(struct udevice *flash);
169
170static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
Simon Glass8d987ab2015-03-26 09:29:25 -0600171 size_t len, void *buf)
Simon Glass4c2dbef2014-10-13 23:42:06 -0600172{
Simon Glass8d987ab2015-03-26 09:29:25 -0600173 return spi_flash_read_dm(flash->dev, offset, len, buf);
Simon Glass4c2dbef2014-10-13 23:42:06 -0600174}
175
176static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
Simon Glass8d987ab2015-03-26 09:29:25 -0600177 size_t len, const void *buf)
Simon Glass4c2dbef2014-10-13 23:42:06 -0600178{
Simon Glass8d987ab2015-03-26 09:29:25 -0600179 return spi_flash_write_dm(flash->dev, offset, len, buf);
Simon Glass4c2dbef2014-10-13 23:42:06 -0600180}
181
182static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
Simon Glass8d987ab2015-03-26 09:29:25 -0600183 size_t len)
Simon Glass4c2dbef2014-10-13 23:42:06 -0600184{
Simon Glass8d987ab2015-03-26 09:29:25 -0600185 return spi_flash_erase_dm(flash->dev, offset, len);
Simon Glass4c2dbef2014-10-13 23:42:06 -0600186}
187
188struct sandbox_state;
189
190int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
191 struct udevice *bus, int of_offset, const char *spec);
192
193void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
194
195#else
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +0200196struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
197 unsigned int max_hz, unsigned int spi_mode);
Simon Glass0efc0242013-12-03 16:43:24 -0700198
199/**
200 * Set up a new SPI flash from an fdt node
201 *
202 * @param blob Device tree blob
203 * @param slave_node Pointer to this SPI slave node in the device tree
204 * @param spi_node Cached pointer to the SPI interface this node belongs
205 * to
206 * @return 0 if ok, -1 on error
207 */
208struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
209 int spi_node);
210
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +0200211void spi_flash_free(struct spi_flash *flash);
212
213static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
214 size_t len, void *buf)
215{
216 return flash->read(flash, offset, len, buf);
217}
218
219static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
220 size_t len, const void *buf)
221{
222 return flash->write(flash, offset, len, buf);
223}
224
225static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
226 size_t len)
227{
228 return flash->erase(flash, offset, len);
229}
Simon Glass4c2dbef2014-10-13 23:42:06 -0600230#endif
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +0200231
Christian Riesch32b11272011-12-09 09:47:35 +0000232void spi_boot(void) __noreturn;
Prabhakar Kushwaha1eaa7422014-04-08 19:13:22 +0530233void spi_spl_load_image(uint32_t offs, unsigned int size, void *vdst);
Christian Riesch32b11272011-12-09 09:47:35 +0000234
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +0200235#endif /* _SPI_FLASH_H_ */