xref: /openbmc/u-boot/include/spi_flash.h (revision 977a39e6)
1 /*
2  * Interface to SPI flash
3  *
4  * Copyright (C) 2008 Atmel Corporation
5  *
6  * See file CREDITS for list of people who contributed to this
7  * project.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * version 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23 #ifndef _SPI_FLASH_H_
24 #define _SPI_FLASH_H_
25 
26 #include <spi.h>
27 #include <linux/types.h>
28 #include <linux/compiler.h>
29 
30 struct spi_flash {
31 	struct spi_slave *spi;
32 
33 	const char	*name;
34 
35 	/* Total flash size */
36 	u32		size;
37 	/* Write (page) size */
38 	u32		page_size;
39 	/* Erase (sector) size */
40 	u32		sector_size;
41 
42 	int		(*read)(struct spi_flash *flash, u32 offset,
43 				size_t len, void *buf);
44 	int		(*write)(struct spi_flash *flash, u32 offset,
45 				size_t len, const void *buf);
46 	int		(*erase)(struct spi_flash *flash, u32 offset,
47 				size_t len);
48 };
49 
50 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
51 		unsigned int max_hz, unsigned int spi_mode);
52 void spi_flash_free(struct spi_flash *flash);
53 
54 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
55 		size_t len, void *buf)
56 {
57 	return flash->read(flash, offset, len, buf);
58 }
59 
60 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
61 		size_t len, const void *buf)
62 {
63 	return flash->write(flash, offset, len, buf);
64 }
65 
66 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
67 		size_t len)
68 {
69 	return flash->erase(flash, offset, len);
70 }
71 
72 void spi_boot(void) __noreturn;
73 
74 #endif /* _SPI_FLASH_H_ */
75