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 /** 33 * struct spi_flash - SPI flash structure 34 * 35 * @spi: SPI slave 36 * @name: Name of SPI flash 37 * @size: Total flash size 38 * @page_size: Write (page) size 39 * @sector_size: Sector size 40 * @erase_size: Erase size 41 * @bank_read_cmd: Bank read cmd 42 * @bank_write_cmd: Bank write cmd 43 * @bank_curr: Current flash bank 44 * @poll_cmd: Poll cmd - for flash erase/program 45 * @erase_cmd: Erase cmd 4K, 32K, 64K 46 * @memory_map: Address of read-only SPI flash access 47 * @read: Flash read ops: Read len bytes at offset into buf 48 * Supported cmds: Fast Array Read 49 * @write: Flash write ops: Write len bytes from buf into offeset 50 * Supported cmds: Page Program 51 * @erase: Flash erase ops: Erase len bytes from offset 52 * Supported cmds: Sector erase 4K, 32K, 64K 53 * return 0 - Sucess, 1 - Failure 54 */ 55 struct spi_flash { 56 struct spi_slave *spi; 57 const char *name; 58 59 u32 size; 60 u32 page_size; 61 u32 sector_size; 62 u32 erase_size; 63 #ifdef CONFIG_SPI_FLASH_BAR 64 u8 bank_read_cmd; 65 u8 bank_write_cmd; 66 u8 bank_curr; 67 #endif 68 u8 poll_cmd; 69 u8 erase_cmd; 70 71 void *memory_map; 72 int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf); 73 int (*write)(struct spi_flash *flash, u32 offset, size_t len, 74 const void *buf); 75 int (*erase)(struct spi_flash *flash, u32 offset, size_t len); 76 }; 77 78 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 79 unsigned int max_hz, unsigned int spi_mode); 80 void spi_flash_free(struct spi_flash *flash); 81 82 static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 83 size_t len, void *buf) 84 { 85 return flash->read(flash, offset, len, buf); 86 } 87 88 static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 89 size_t len, const void *buf) 90 { 91 return flash->write(flash, offset, len, buf); 92 } 93 94 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 95 size_t len) 96 { 97 return flash->erase(flash, offset, len); 98 } 99 100 void spi_boot(void) __noreturn; 101 102 #endif /* _SPI_FLASH_H_ */ 103