2 * Interface to SPI flash
4 * Copyright (C) 2008 Atmel Corporation
6 * See file CREDITS for list of people who contributed to this
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.
17 #include <linux/types.h>
18 #include <linux/compiler.h>
21 #define SECT_4K (1 << 1)
22 #define SECT_32K (1 << 2)
23 #define E_FSR (1 << 3)
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 */
33 * struct spi_flash - SPI flash structure
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
56 struct spi_slave *spi;
63 #ifdef CONFIG_SPI_FLASH_BAR
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,
75 int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
79 * spi_flash_do_alloc - Allocate a new spi flash structure
81 * The structure is allocated and cleared with default values for
82 * read, write and erase, which the caller can modify. The caller must set
83 * up size, page_size and sector_size.
85 * Use the helper macro spi_flash_alloc() to call this.
87 * @offset: Offset of struct spi_slave within slave structure
88 * @size: Size of slave structure
90 * @name: Name of SPI flash device
92 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi,
96 * spi_flash_alloc - Allocate a new SPI flash structure
98 * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This
99 * structure must contain a member 'struct spi_flash *flash'.
101 * @name: Name of SPI flash device
103 #define spi_flash_alloc(_struct, spi, name) \
104 spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \
108 * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data
111 * @name: Name of SPI flash device
113 #define spi_flash_alloc_base(spi, name) \
114 spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name)
116 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
117 unsigned int max_hz, unsigned int spi_mode);
118 void spi_flash_free(struct spi_flash *flash);
120 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
121 size_t len, void *buf)
123 return flash->read(flash, offset, len, buf);
126 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
127 size_t len, const void *buf)
129 return flash->write(flash, offset, len, buf);
132 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
135 return flash->erase(flash, offset, len);
138 void spi_boot(void) __noreturn;
140 #endif /* _SPI_FLASH_H_ */