1d25ce7d2SHaavard Skinnemoen /* 2*a5e8199aSJagannadha Sutradharudu Teki * Common SPI flash Interface 3d25ce7d2SHaavard Skinnemoen * 4d25ce7d2SHaavard Skinnemoen * Copyright (C) 2008 Atmel Corporation 5*a5e8199aSJagannadha Sutradharudu Teki * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. 6d25ce7d2SHaavard Skinnemoen * 7d25ce7d2SHaavard Skinnemoen * See file CREDITS for list of people who contributed to this 8d25ce7d2SHaavard Skinnemoen * project. 9d25ce7d2SHaavard Skinnemoen * 10d25ce7d2SHaavard Skinnemoen * This program is free software; you can redistribute it and/or 11d25ce7d2SHaavard Skinnemoen * modify it under the terms of the GNU General Public License 12d25ce7d2SHaavard Skinnemoen * version 2 as published by the Free Software Foundation. 13d25ce7d2SHaavard Skinnemoen */ 14*a5e8199aSJagannadha Sutradharudu Teki 15d25ce7d2SHaavard Skinnemoen #ifndef _SPI_FLASH_H_ 16d25ce7d2SHaavard Skinnemoen #define _SPI_FLASH_H_ 17d25ce7d2SHaavard Skinnemoen 18d25ce7d2SHaavard Skinnemoen #include <spi.h> 19e06ab654SMike Frysinger #include <linux/types.h> 2032b11273SChristian Riesch #include <linux/compiler.h> 21d25ce7d2SHaavard Skinnemoen 227ab35d92SJagannadha Sutradharudu Teki /** 237ab35d92SJagannadha Sutradharudu Teki * struct spi_flash - SPI flash structure 247ab35d92SJagannadha Sutradharudu Teki * 257ab35d92SJagannadha Sutradharudu Teki * @spi: SPI slave 267ab35d92SJagannadha Sutradharudu Teki * @name: Name of SPI flash 277ab35d92SJagannadha Sutradharudu Teki * @size: Total flash size 287ab35d92SJagannadha Sutradharudu Teki * @page_size: Write (page) size 297ab35d92SJagannadha Sutradharudu Teki * @sector_size: Sector size 307ab35d92SJagannadha Sutradharudu Teki * @erase_size: Erase size 317ab35d92SJagannadha Sutradharudu Teki * @bank_read_cmd: Bank read cmd 327ab35d92SJagannadha Sutradharudu Teki * @bank_write_cmd: Bank write cmd 337ab35d92SJagannadha Sutradharudu Teki * @bank_curr: Current flash bank 347ab35d92SJagannadha Sutradharudu Teki * @poll_cmd: Poll cmd - for flash erase/program 357ab35d92SJagannadha Sutradharudu Teki * @erase_cmd: Erase cmd 4K, 32K, 64K 367ab35d92SJagannadha Sutradharudu Teki * @memory_map: Address of read-only SPI flash access 377ab35d92SJagannadha Sutradharudu Teki * @read: Flash read ops: Read len bytes at offset into buf 387ab35d92SJagannadha Sutradharudu Teki * Supported cmds: Fast Array Read 397ab35d92SJagannadha Sutradharudu Teki * @write: Flash write ops: Write len bytes from buf into offeset 407ab35d92SJagannadha Sutradharudu Teki * Supported cmds: Page Program 417ab35d92SJagannadha Sutradharudu Teki * @erase: Flash erase ops: Erase len bytes from offset 427ab35d92SJagannadha Sutradharudu Teki * Supported cmds: Sector erase 4K, 32K, 64K 437ab35d92SJagannadha Sutradharudu Teki * return 0 - Sucess, 1 - Failure 447ab35d92SJagannadha Sutradharudu Teki */ 45d25ce7d2SHaavard Skinnemoen struct spi_flash { 46d25ce7d2SHaavard Skinnemoen struct spi_slave *spi; 47d25ce7d2SHaavard Skinnemoen const char *name; 48d25ce7d2SHaavard Skinnemoen 49d25ce7d2SHaavard Skinnemoen u32 size; 50d4aa5009SMike Frysinger u32 page_size; 514e6a5158SRichard Retanubun u32 sector_size; 52f4f51a8fSJagannadha Sutradharudu Teki u32 erase_size; 531dcd6d03SJagannadha Sutradharudu Teki #ifdef CONFIG_SPI_FLASH_BAR 54cf6b11dcSJagannadha Sutradharudu Teki u8 bank_read_cmd; 55cf6b11dcSJagannadha Sutradharudu Teki u8 bank_write_cmd; 56e612ddf5SJagannadha Sutradharudu Teki u8 bank_curr; 571dcd6d03SJagannadha Sutradharudu Teki #endif 58615a1561SJagannadha Sutradharudu Teki u8 poll_cmd; 59f4f51a8fSJagannadha Sutradharudu Teki u8 erase_cmd; 60615a1561SJagannadha Sutradharudu Teki 617ab35d92SJagannadha Sutradharudu Teki void *memory_map; 627ab35d92SJagannadha Sutradharudu Teki int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf); 637ab35d92SJagannadha Sutradharudu Teki int (*write)(struct spi_flash *flash, u32 offset, size_t len, 647ab35d92SJagannadha Sutradharudu Teki const void *buf); 657ab35d92SJagannadha Sutradharudu Teki int (*erase)(struct spi_flash *flash, u32 offset, size_t len); 66d25ce7d2SHaavard Skinnemoen }; 67d25ce7d2SHaavard Skinnemoen 68d25ce7d2SHaavard Skinnemoen struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 69d25ce7d2SHaavard Skinnemoen unsigned int max_hz, unsigned int spi_mode); 70d25ce7d2SHaavard Skinnemoen void spi_flash_free(struct spi_flash *flash); 71d25ce7d2SHaavard Skinnemoen 72d25ce7d2SHaavard Skinnemoen static inline int spi_flash_read(struct spi_flash *flash, u32 offset, 73d25ce7d2SHaavard Skinnemoen size_t len, void *buf) 74d25ce7d2SHaavard Skinnemoen { 75d25ce7d2SHaavard Skinnemoen return flash->read(flash, offset, len, buf); 76d25ce7d2SHaavard Skinnemoen } 77d25ce7d2SHaavard Skinnemoen 78d25ce7d2SHaavard Skinnemoen static inline int spi_flash_write(struct spi_flash *flash, u32 offset, 79d25ce7d2SHaavard Skinnemoen size_t len, const void *buf) 80d25ce7d2SHaavard Skinnemoen { 81d25ce7d2SHaavard Skinnemoen return flash->write(flash, offset, len, buf); 82d25ce7d2SHaavard Skinnemoen } 83d25ce7d2SHaavard Skinnemoen 84d25ce7d2SHaavard Skinnemoen static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, 85d25ce7d2SHaavard Skinnemoen size_t len) 86d25ce7d2SHaavard Skinnemoen { 87d25ce7d2SHaavard Skinnemoen return flash->erase(flash, offset, len); 88d25ce7d2SHaavard Skinnemoen } 89d25ce7d2SHaavard Skinnemoen 9032b11273SChristian Riesch void spi_boot(void) __noreturn; 9132b11273SChristian Riesch 92d25ce7d2SHaavard Skinnemoen #endif /* _SPI_FLASH_H_ */ 93