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>
20 /* SST specific macros */
21 #ifdef CONFIG_SPI_FLASH_SST
22 # define SST_WP 0x01 /* Supports AAI word program */
23 # define CMD_SST_BP 0x02 /* Byte Program */
24 # define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */
28 struct spi_slave *spi;
32 /* Total flash size */
34 /* Write (page) size */
36 /* Erase (sector) size */
38 #ifdef CONFIG_SPI_FLASH_BAR
43 /* Current flash bank */
46 /* Poll cmd - for flash erase/program */
49 void *memory_map; /* Address of read-only SPI flash access */
50 int (*read)(struct spi_flash *flash, u32 offset,
51 size_t len, void *buf);
52 int (*write)(struct spi_flash *flash, u32 offset,
53 size_t len, const void *buf);
54 int (*erase)(struct spi_flash *flash, u32 offset,
59 * spi_flash_do_alloc - Allocate a new spi flash structure
61 * The structure is allocated and cleared with default values for
62 * read, write and erase, which the caller can modify. The caller must set
63 * up size, page_size and sector_size.
65 * Use the helper macro spi_flash_alloc() to call this.
67 * @offset: Offset of struct spi_slave within slave structure
68 * @size: Size of slave structure
70 * @name: Name of SPI flash device
72 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi,
76 * spi_flash_alloc - Allocate a new SPI flash structure
78 * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This
79 * structure must contain a member 'struct spi_flash *flash'.
81 * @name: Name of SPI flash device
83 #define spi_flash_alloc(_struct, spi, name) \
84 spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \
88 * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data
91 * @name: Name of SPI flash device
93 #define spi_flash_alloc_base(spi, name) \
94 spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name)
96 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
97 unsigned int max_hz, unsigned int spi_mode);
98 void spi_flash_free(struct spi_flash *flash);
100 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
101 size_t len, void *buf)
103 return flash->read(flash, offset, len, buf);
106 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
107 size_t len, const void *buf)
109 return flash->write(flash, offset, len, buf);
112 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
115 return flash->erase(flash, offset, len);
118 void spi_boot(void) __noreturn;
120 #endif /* _SPI_FLASH_H_ */