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 #ifndef _SPI_FLASH_H_ 14 #define _SPI_FLASH_H_ 15 16 #include <spi.h> 17 #include <linux/types.h> 18 #include <linux/compiler.h> 19 20 /* SECT flags */ 21 #define SECT_4K (1 << 1) 22 #define SECT_32K (1 << 2) 23 #define E_FSR (1 << 3) 24 25 /* SST specific macros */ 26 #ifdef CONFIG_SPI_FLASH_SST 27 # define SST_WP 0x01 /* Supports AAI word program */ 28 # define CMD_SST_BP 0x02 /* Byte Program */ 29 # define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */ 30 #endif 31 32 struct spi_flash { 33 struct spi_slave *spi; 34 35 const char *name; 36 37 /* Total flash size */ 38 u32 size; 39 /* Write (page) size */ 40 u32 page_size; 41 /* Sector size */ 42 u32 sector_size; 43 /* Erase size */ 44 u32 erase_size; 45 #ifdef CONFIG_SPI_FLASH_BAR 46 /* Bank read cmd */ 47 u8 bank_read_cmd; 48 /* Bank write cmd */ 49 u8 bank_write_cmd; 50 /* Current flash bank */ 51 u8 bank_curr; 52 #endif 53 /* Poll cmd - for flash erase/program */ 54 u8 poll_cmd; 55 /* Erase cmd 4K, 32K, 64K */ 56 u8 erase_cmd; 57 58 void *memory_map; /* Address of read-only SPI flash access */ 59 int (*read)(struct spi_flash *flash, u32 offset, 60 size_t len, void *buf); 61 int (*write)(struct spi_flash *flash, u32 offset, 62 size_t len, const void *buf); 63 int (*erase)(struct spi_flash *flash, u32 offset, 64 size_t len); 65 }; 66 67 /** 68 * spi_flash_do_alloc - Allocate a new spi flash structure 69 * 70 * The structure is allocated and cleared with default values for 71 * read, write and erase, which the caller can modify. The caller must set 72 * up size, page_size and sector_size. 73 * 74 * Use the helper macro spi_flash_alloc() to call this. 75 * 76 * @offset: Offset of struct spi_slave within slave structure 77 * @size: Size of slave structure 78 * @spi: SPI slave 79 * @name: Name of SPI flash device 80 */ 81 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi, 82 const char *name); 83 84 /** 85 * spi_flash_alloc - Allocate a new SPI flash structure 86 * 87 * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This 88 * structure must contain a member 'struct spi_flash *flash'. 89 * @spi: SPI slave 90 * @name: Name of SPI flash device 91 */ 92 #define spi_flash_alloc(_struct, spi, name) \ 93 spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \ 94 spi, name) 95 96 /** 97 * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data 98 * 99 * @spi: SPI slave 100 * @name: Name of SPI flash device 101 */ 102 #define spi_flash_alloc_base(spi, name) \ 103 spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name) 104 105 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 106 unsigned int max_hz, unsigned int spi_mode); 107 void spi_flash_free(struct spi_flash *flash); 108 109 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 110 size_t len, void *buf) 111 { 112 return flash->read(flash, offset, len, buf); 113 } 114 115 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 116 size_t len, const void *buf) 117 { 118 return flash->write(flash, offset, len, buf); 119 } 120 121 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 122 size_t len) 123 { 124 return flash->erase(flash, offset, len); 125 } 126 127 void spi_boot(void) __noreturn; 128 129 #endif /* _SPI_FLASH_H_ */ 130