spi_flash.h 5.43 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
struct spi_slave;
18

19
20
21
22
23
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);
24
25
26
27
28
29
30
31
32
33
34
35
36
	/**
	 * 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
37
38
};

39
40
41
/* Access the serial operations for a device */
#define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)

42
#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
43
44
45
46
47
48
49
/**
 * 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
50
 * Return: 0 if OK, -ve on error
51
52
53
54
55
56
57
58
59
60
 */
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
61
 * Return: 0 if OK, -ve on error
62
63
64
65
66
67
68
69
70
71
72
73
 */
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
74
 * Return: 0 if OK, -ve on error
75
76
77
 */
int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);

78
79
80
81
82
83
84
85
/**
 * 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
86
 * Return: 0 if no region is write-protected, 1 if a region is
87
88
89
90
91
 *	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);

92
93
94
95
96
97
98
99
/**
 * 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
100
 * Return: 0 if OK, -ve on error
101
102
103
 */
int spi_flash_std_probe(struct udevice *dev);

104
105
106
107
108
109
110
111
int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
			   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
112
113
114
static inline void spi_flash_free(struct spi_flash *flash)
{
}
115
116

static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
117
				 size_t len, void *buf)
118
{
119
	return spi_flash_read_dm(flash->dev, offset, len, buf);
120
121
122
}

static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
123
				  size_t len, const void *buf)
124
{
125
	return spi_flash_write_dm(flash->dev, offset, len, buf);
126
127
128
}

static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
129
				  size_t len)
130
{
131
	return spi_flash_erase_dm(flash->dev, offset, len);
132
133
134
135
136
}

struct sandbox_state;

int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
137
			 struct udevice *bus, ofnode node, const char *spec);
138
139
140
141

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

#else
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
142
143
struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
		unsigned int max_hz, unsigned int spi_mode);
144

Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
145
146
147
148
149
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)
{
150
151
152
	struct mtd_info *mtd = &flash->mtd;
	size_t retlen;

153
154
155
	if (!len)
		return 0;

156
	return mtd->_read(mtd, offset, len, &retlen, buf);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
157
158
159
160
161
}

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

165
166
167
	if (!len)
		return 0;

168
	return mtd->_write(mtd, offset, len, &retlen, buf);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
169
170
171
172
173
}

static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
		size_t len)
{
174
175
176
177
178
179
180
181
	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;
	}

182
183
184
	if (!len)
		return 0;

185
186
187
188
189
	memset(&instr, 0, sizeof(instr));
	instr.addr = offset;
	instr.len = len;

	return mtd->_erase(mtd, &instr);
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
190
}
191
#endif
Haavard Skinnemoen's avatar
Haavard Skinnemoen committed
192

193
194
195
static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
					bool prot)
{
196
	if (!flash->flash_lock || !flash->flash_unlock)
197
198
199
200
201
202
203
204
		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
205
#endif /* _SPI_FLASH_H_ */