projects / u-boot.git / blame
| Commit | Line | Data |
|---|---|---|
| d25ce7d2 | 1 | /* |
| a5e8199a | 2 | * Common SPI flash Interface |
| d25ce7d2 HS |
3 | * |
| 4 | * Copyright (C) 2008 Atmel Corporation | |
| a5e8199a | 5 | * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. |
| d25ce7d2 HS |
6 | * |
| 7 | * See file CREDITS for list of people who contributed to this | |
| 8 | * project. | |
| 9 | * | |
| 10 | * This program is free software; you can redistribute it and/or | |
| 11 | * modify it under the terms of the GNU General Public License | |
| 3765b3e7 | 12 | * version 2 as published by the Free Software Foundation. |
| d25ce7d2 | 13 | */ |
| a5e8199a | 14 | |
| d25ce7d2 HS |
15 | #ifndef _SPI_FLASH_H_ |
| 16 | #define _SPI_FLASH_H_ | |
| 17 | ||
| 18 | #include <spi.h> | |
| e06ab654 | 19 | #include <linux/types.h> |
| 32b11273 | 20 | #include <linux/compiler.h> |
| d25ce7d2 | 21 | |
| 7ab35d92 JT |
22 | /** |
| 23 | * struct spi_flash - SPI flash structure | |
| 24 | * | |
| 25 | * @spi: SPI slave | |
| 26 | * @name: Name of SPI flash | |
| 27 | * @size: Total flash size | |
| 28 | * @page_size: Write (page) size | |
| 29 | * @sector_size: Sector size | |
| ce22b922 | 30 | * @erase_size: Erase size |
| 7ab35d92 JT |
31 | * @bank_read_cmd: Bank read cmd |
| 32 | * @bank_write_cmd: Bank write cmd | |
| 33 | * @bank_curr: Current flash bank | |
| 34 | * @poll_cmd: Poll cmd - for flash erase/program | |
| 35 | * @erase_cmd: Erase cmd 4K, 32K, 64K | |
| ce22b922 | 36 | * @memory_map: Address of read-only SPI flash access |
| 7ab35d92 JT |
37 | * @read: Flash read ops: Read len bytes at offset into buf |
| 38 | * Supported cmds: Fast Array Read | |
| 39 | * @write: Flash write ops: Write len bytes from buf into offeset | |
| 40 | * Supported cmds: Page Program | |
| 41 | * @erase: Flash erase ops: Erase len bytes from offset | |
| 42 | * Supported cmds: Sector erase 4K, 32K, 64K | |
| 43 | * return 0 - Sucess, 1 - Failure | |
| 44 | */ | |
| d25ce7d2 HS |
45 | struct spi_flash { |
| 46 | struct spi_slave *spi; | |
| 7ab35d92 | 47 | const char *name; |
| d25ce7d2 | 48 | |
| 7ab35d92 JT |
49 | u32 size; |
| 50 | u32 page_size; | |
| 51 | u32 sector_size; | |
| 52 | u32 erase_size; | |
| 1dcd6d03 | 53 | #ifdef CONFIG_SPI_FLASH_BAR |
| 7ab35d92 JT |
54 | u8 bank_read_cmd; |
| 55 | u8 bank_write_cmd; | |
| 56 | u8 bank_curr; | |
| 1dcd6d03 | 57 | #endif |
| 7ab35d92 JT |
58 | u8 poll_cmd; |
| 59 | u8 erase_cmd; | |
| 615a1561 | 60 | |
| 7ab35d92 JT |
61 | void *memory_map; |
| 62 | int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf); | |
| 63 | int (*write)(struct spi_flash *flash, u32 offset, size_t len, | |
| 64 | const void *buf); | |
| 65 | int (*erase)(struct spi_flash *flash, u32 offset, size_t len); | |
| d25ce7d2 HS |
66 | }; |
| 67 | ||
| 68 | struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, | |
| 69 | unsigned int max_hz, unsigned int spi_mode); | |
| 70 | void spi_flash_free(struct spi_flash *flash); | |
| 71 | ||
| 72 | static inline int spi_flash_read(struct spi_flash *flash, u32 offset, | |
| 73 | size_t len, void *buf) | |
| 74 | { | |
| 75 | return flash->read(flash, offset, len, buf); | |
| 76 | } | |
| 77 | ||
| 78 | static inline int spi_flash_write(struct spi_flash *flash, u32 offset, | |
| 79 | size_t len, const void *buf) | |
| 80 | { | |
| 81 | return flash->write(flash, offset, len, buf); | |
| 82 | } | |
| 83 | ||
| 84 | static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, | |
| 85 | size_t len) | |
| 86 | { | |
| 87 | return flash->erase(flash, offset, len); | |
| 88 | } | |
| 89 | ||
| 32b11273 CR |
90 | void spi_boot(void) __noreturn; |
| 91 | ||
| d25ce7d2 | 92 | #endif /* _SPI_FLASH_H_ */ |