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