spi_flash.h 5.88 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
2
/*
3
 * Common SPI flash Interface
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
4
5
 *
 * Copyright (C) 2008 Atmel Corporation
6
 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
7
 */
8

Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
9
10
11
#ifndef _SPI_FLASH_H_
#define _SPI_FLASH_H_

12
#include <linux/types.h>
13
#include <linux/mtd/spi-nor.h>
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
14

15
16
struct udevice;

17
18
19
20
21
22
23
24
25
26
27
28
29
30
/* by default ENV use the same parameters than SF command */
#ifndef CONFIG_ENV_SPI_BUS
# define CONFIG_ENV_SPI_BUS	CONFIG_SF_DEFAULT_BUS
#endif
#ifndef CONFIG_ENV_SPI_CS
# define CONFIG_ENV_SPI_CS	CONFIG_SF_DEFAULT_CS
#endif
#ifndef CONFIG_ENV_SPI_MAX_HZ
# define CONFIG_ENV_SPI_MAX_HZ	CONFIG_SF_DEFAULT_SPEED
#endif
#ifndef CONFIG_ENV_SPI_MODE
# define CONFIG_ENV_SPI_MODE	CONFIG_SF_DEFAULT_MODE
#endif

31
struct spi_slave;
32

33
34
35
36
37
struct dm_spi_flash_ops {
	int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
	int (*write)(struct udevice *dev, u32 offset, size_t len,
		     const void *buf);
	int (*erase)(struct udevice *dev, u32 offset, size_t len);
38
39
40
41
42
43
44
45
46
47
48
49
50
	/**
	 * get_sw_write_prot() - Check state of software write-protect feature
	 *
	 * SPI flash chips can lock a region of the flash defined by a
	 * 'protected area'. This function checks if this protected area is
	 * defined.
	 *
	 * @dev:	SPI flash device
	 * @return 0 if no region is write-protected, 1 if a region is
	 *	write-protected, -ENOSYS if the driver does not implement this,
	 *	other -ve value on error
	 */
	int (*get_sw_write_prot)(struct udevice *dev);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
51
52
};

53
54
55
/* Access the serial operations for a device */
#define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)

56
#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/**
 * spi_flash_read_dm() - Read data from SPI flash
 *
 * @dev:	SPI flash device
 * @offset:	Offset into device in bytes to read from
 * @len:	Number of bytes to read
 * @buf:	Buffer to put the data that is read
 * @return 0 if OK, -ve on error
 */
int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);

/**
 * spi_flash_write_dm() - Write data to SPI flash
 *
 * @dev:	SPI flash device
 * @offset:	Offset into device in bytes to write to
 * @len:	Number of bytes to write
 * @buf:	Buffer containing bytes to write
 * @return 0 if OK, -ve on error
 */
int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
		       const void *buf);

/**
 * spi_flash_erase_dm() - Erase blocks of the SPI flash
 *
 * Note that @len must be a muiltiple of the flash sector size.
 *
 * @dev:	SPI flash device
 * @offset:	Offset into device in bytes to start erasing
 * @len:	Number of bytes to erase
 * @return 0 if OK, -ve on error
 */
int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);

92
93
94
95
96
97
98
99
100
101
102
103
104
105
/**
 * spl_flash_get_sw_write_prot() - Check state of software write-protect feature
 *
 * SPI flash chips can lock a region of the flash defined by a
 * 'protected area'. This function checks if this protected area is
 * defined.
 *
 * @dev:	SPI flash device
 * @return 0 if no region is write-protected, 1 if a region is
 *	write-protected, -ENOSYS if the driver does not implement this,
 *	other -ve value on error
 */
int spl_flash_get_sw_write_prot(struct udevice *dev);

106
107
108
109
110
111
112
113
114
115
116
117
/**
 * spi_flash_std_probe() - Probe a SPI flash device
 *
 * This is the standard internal method for probing a SPI flash device to
 * determine its type. It can be used in chip-specific drivers which need to
 * do this, typically with of-platdata
 *
 * @dev: SPI-flash device to probe
 * @return 0 if OK, -ve on error
 */
int spi_flash_std_probe(struct udevice *dev);

118
119
120
121
122
123
124
125
126
int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
			   unsigned int max_hz, unsigned int spi_mode,
			   struct udevice **devp);

/* Compatibility function - this is the old U-Boot API */
struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
				  unsigned int max_hz, unsigned int spi_mode);

/* Compatibility function - this is the old U-Boot API */
Heinrich Schuchardt's avatar
Heinrich Schuchardt committed
127
128
129
static inline void spi_flash_free(struct spi_flash *flash)
{
}
130
131

static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
132
				 size_t len, void *buf)
133
{
134
	return spi_flash_read_dm(flash->dev, offset, len, buf);
135
136
137
}

static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
138
				  size_t len, const void *buf)
139
{
140
	return spi_flash_write_dm(flash->dev, offset, len, buf);
141
142
143
}

static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
144
				  size_t len)
145
{
146
	return spi_flash_erase_dm(flash->dev, offset, len);
147
148
149
150
151
}

struct sandbox_state;

int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
152
			 struct udevice *bus, ofnode node, const char *spec);
153
154
155
156

void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);

#else
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
157
158
struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
		unsigned int max_hz, unsigned int spi_mode);
159

Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
160
161
162
163
164
void spi_flash_free(struct spi_flash *flash);

static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
		size_t len, void *buf)
{
165
166
167
	struct mtd_info *mtd = &flash->mtd;
	size_t retlen;

168
169
170
	if (!len)
		return 0;

171
	return mtd->_read(mtd, offset, len, &retlen, buf);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
172
173
174
175
176
}

static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
		size_t len, const void *buf)
{
177
178
179
	struct mtd_info *mtd = &flash->mtd;
	size_t retlen;

180
181
182
	if (!len)
		return 0;

183
	return mtd->_write(mtd, offset, len, &retlen, buf);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
184
185
186
187
188
}

static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
		size_t len)
{
189
190
191
192
193
194
195
196
	struct mtd_info *mtd = &flash->mtd;
	struct erase_info instr;

	if (offset % mtd->erasesize || len % mtd->erasesize) {
		printf("SF: Erase offset/length not multiple of erase size\n");
		return -EINVAL;
	}

197
198
199
	if (!len)
		return 0;

200
201
202
203
204
	memset(&instr, 0, sizeof(instr));
	instr.addr = offset;
	instr.len = len;

	return mtd->_erase(mtd, &instr);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
205
}
206
#endif
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
207

208
209
210
static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
					bool prot)
{
211
	if (!flash->flash_lock || !flash->flash_unlock)
212
213
214
215
216
217
218
219
		return -EOPNOTSUPP;

	if (prot)
		return flash->flash_lock(flash, ofs, len);
	else
		return flash->flash_unlock(flash, ofs, len);
}

Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
220
#endif /* _SPI_FLASH_H_ */