blob: 4566feab6313be80204a183fbf1a702479c4b976 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0 */
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +02002/*
Jagannadha Sutradharudu Teki25dc86a2013-10-02 19:38:49 +05303 * Common SPI flash Interface
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +02004 *
5 * Copyright (C) 2008 Atmel Corporation
Jagannadha Sutradharudu Teki25dc86a2013-10-02 19:38:49 +05306 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +02007 */
Jagannadha Sutradharudu Teki25dc86a2013-10-02 19:38:49 +05308
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +02009#ifndef _SPI_FLASH_H_
10#define _SPI_FLASH_H_
11
Mike Frysingere4c698b2009-11-03 11:36:39 -050012#include <linux/types.h>
Vignesh R14510412019-02-05 11:29:23 +053013#include <linux/mtd/spi-nor.h>
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +020014
Simon Glass7130b952020-07-19 10:15:40 -060015struct udevice;
16
Simon Glassd34b4562014-10-13 23:42:04 -060017struct spi_slave;
Jagannadha Sutradharudu Teki20e45bc2013-12-23 23:34:42 +053018
Simon Glassd6eedf72014-10-13 23:42:06 -060019struct 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 Glass61d04642021-03-15 18:11:17 +130024 /**
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 Skinnemoen2f5bfb72008-05-16 11:10:33 +020037};
38
Simon Glassd6eedf72014-10-13 23:42:06 -060039/* Access the serial operations for a device */
40#define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
41
Lukasz Majewski76f442982020-06-04 23:11:53 +080042#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
Simon Glass1c369232015-03-26 09:29:25 -060043/**
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 */
52int 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 */
63int 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 */
76int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
77
Simon Glass36eee8c2018-11-06 15:21:41 -070078/**
Simon Glass61d04642021-03-15 18:11:17 +130079 * 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 */
90int spl_flash_get_sw_write_prot(struct udevice *dev);
91
92/**
Simon Glassa104b642019-12-06 21:42:50 -070093 * 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 */
102int spi_flash_std_probe(struct udevice *dev);
103
Simon Glassd6eedf72014-10-13 23:42:06 -0600104int 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 */
109struct 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 Schuchardt6acba5a2021-03-10 18:23:57 +0100113static inline void spi_flash_free(struct spi_flash *flash)
114{
115}
Simon Glassd6eedf72014-10-13 23:42:06 -0600116
Simon Glassd6eedf72014-10-13 23:42:06 -0600117static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
Simon Glass1c369232015-03-26 09:29:25 -0600118 size_t len, void *buf)
Simon Glassd6eedf72014-10-13 23:42:06 -0600119{
Simon Glass1c369232015-03-26 09:29:25 -0600120 return spi_flash_read_dm(flash->dev, offset, len, buf);
Simon Glassd6eedf72014-10-13 23:42:06 -0600121}
122
123static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
Simon Glass1c369232015-03-26 09:29:25 -0600124 size_t len, const void *buf)
Simon Glassd6eedf72014-10-13 23:42:06 -0600125{
Simon Glass1c369232015-03-26 09:29:25 -0600126 return spi_flash_write_dm(flash->dev, offset, len, buf);
Simon Glassd6eedf72014-10-13 23:42:06 -0600127}
128
129static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
Simon Glass1c369232015-03-26 09:29:25 -0600130 size_t len)
Simon Glassd6eedf72014-10-13 23:42:06 -0600131{
Simon Glass1c369232015-03-26 09:29:25 -0600132 return spi_flash_erase_dm(flash->dev, offset, len);
Simon Glassd6eedf72014-10-13 23:42:06 -0600133}
134
135struct sandbox_state;
136
137int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
Simon Glassf3548632018-06-11 13:07:16 -0600138 struct udevice *bus, ofnode node, const char *spec);
Simon Glassd6eedf72014-10-13 23:42:06 -0600139
140void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
141
142#else
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200143struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
144 unsigned int max_hz, unsigned int spi_mode);
Simon Glass49e9d2c2013-12-03 16:43:24 -0700145
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200146void spi_flash_free(struct spi_flash *flash);
147
148static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
149 size_t len, void *buf)
150{
Vignesh R14510412019-02-05 11:29:23 +0530151 struct mtd_info *mtd = &flash->mtd;
152 size_t retlen;
153
Marek Behún375027a2021-10-05 15:56:01 +0200154 if (!len)
155 return 0;
156
Vignesh R14510412019-02-05 11:29:23 +0530157 return mtd->_read(mtd, offset, len, &retlen, buf);
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200158}
159
160static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
161 size_t len, const void *buf)
162{
Vignesh R14510412019-02-05 11:29:23 +0530163 struct mtd_info *mtd = &flash->mtd;
164 size_t retlen;
165
Marek Behún375027a2021-10-05 15:56:01 +0200166 if (!len)
167 return 0;
168
Vignesh R14510412019-02-05 11:29:23 +0530169 return mtd->_write(mtd, offset, len, &retlen, buf);
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200170}
171
172static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
173 size_t len)
174{
Vignesh R14510412019-02-05 11:29:23 +0530175 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ún375027a2021-10-05 15:56:01 +0200183 if (!len)
184 return 0;
185
Vignesh R14510412019-02-05 11:29:23 +0530186 memset(&instr, 0, sizeof(instr));
187 instr.addr = offset;
188 instr.len = len;
189
190 return mtd->_erase(mtd, &instr);
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200191}
Simon Glassd6eedf72014-10-13 23:42:06 -0600192#endif
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200193
Fabio Estevam1cd87612015-11-05 12:43:42 -0200194static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
195 bool prot)
196{
Bin Meng66528f62015-11-13 02:46:26 -0800197 if (!flash->flash_lock || !flash->flash_unlock)
Fabio Estevam1cd87612015-11-05 12:43:42 -0200198 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 Skinnemoen2f5bfb72008-05-16 11:10:33 +0200206#endif /* _SPI_FLASH_H_ */