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