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 /** 51 * spi_flash_do_alloc - Allocate a new spi flash structure 52 * 53 * The structure is allocated and cleared with default values for 54 * read, write and erase, which the caller can modify. The caller must set 55 * up size, page_size and sector_size. 56 * 57 * Use the helper macro spi_flash_alloc() to call this. 58 * 59 * @offset: Offset of struct spi_slave within slave structure 60 * @size: Size of slave structure 61 * @spi: SPI slave 62 * @name: Name of SPI flash device 63 */ 64 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi, 65 const char *name); 66 67 /** 68 * spi_flash_alloc - Allocate a new SPI flash structure 69 * 70 * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This 71 * structure must contain a member 'struct spi_flash *flash'. 72 * @spi: SPI slave 73 * @name: Name of SPI flash device 74 */ 75 #define spi_flash_alloc(_struct, spi, name) \ 76 spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \ 77 spi, name) 78 79 /** 80 * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data 81 * 82 * @spi: SPI slave 83 * @name: Name of SPI flash device 84 */ 85 #define spi_flash_alloc_base(spi, name) \ 86 spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name) 87 88 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 89 unsigned int max_hz, unsigned int spi_mode); 90 void spi_flash_free(struct spi_flash *flash); 91 92 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 93 size_t len, void *buf) 94 { 95 return flash->read(flash, offset, len, buf); 96 } 97 98 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 99 size_t len, const void *buf) 100 { 101 return flash->write(flash, offset, len, buf); 102 } 103 104 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 105 size_t len) 106 { 107 return flash->erase(flash, offset, len); 108 } 109 110 void spi_boot(void) __noreturn; 111 112 #endif /* _SPI_FLASH_H_ */ 113