2671ab55398aed94c97a2893a44b1b6dac06a1a9
[platform/kernel/u-boot.git] / include / spi_flash.h
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
29 struct spi_flash {
30         struct spi_slave *spi;
31
32         const char      *name;
33
34         /* Total flash size */
35         u32             size;
36         /* Write (page) size */
37         u32             page_size;
38         /* Erase (sector) size */
39         u32             sector_size;
40
41         int             (*read)(struct spi_flash *flash, u32 offset,
42                                 size_t len, void *buf);
43         int             (*write)(struct spi_flash *flash, u32 offset,
44                                 size_t len, const void *buf);
45         int             (*erase)(struct spi_flash *flash, u32 offset,
46                                 size_t len);
47 };
48
49 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
50                 unsigned int max_hz, unsigned int spi_mode);
51 void spi_flash_free(struct spi_flash *flash);
52
53 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
54                 size_t len, void *buf)
55 {
56         return flash->read(flash, offset, len, buf);
57 }
58
59 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
60                 size_t len, const void *buf)
61 {
62         return flash->write(flash, offset, len, buf);
63 }
64
65 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
66                 size_t len)
67 {
68         return flash->erase(flash, offset, len);
69 }
70
71 #endif /* _SPI_FLASH_H_ */