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_slave *spi;
37 /* Total flash size */
39 /* Write (page) size */
45 #ifdef CONFIG_SPI_FLASH_BAR
50 /* Current flash bank */
53 /* Poll cmd - for flash erase/program */
55 /* Erase cmd 4K, 32K, 64K */
58 void *memory_map; /* Address of read-only SPI flash access */
59 int (*read)(struct spi_flash *flash, u32 offset,
60 size_t len, void *buf);
61 int (*write)(struct spi_flash *flash, u32 offset,
62 size_t len, const void *buf);
63 int (*erase)(struct spi_flash *flash, u32 offset,
68 * spi_flash_do_alloc - Allocate a new spi flash structure
70 * The structure is allocated and cleared with default values for
71 * read, write and erase, which the caller can modify. The caller must set
72 * up size, page_size and sector_size.
74 * Use the helper macro spi_flash_alloc() to call this.
76 * @offset: Offset of struct spi_slave within slave structure
77 * @size: Size of slave structure
79 * @name: Name of SPI flash device
81 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi,
85 * spi_flash_alloc - Allocate a new SPI flash structure
87 * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This
88 * structure must contain a member 'struct spi_flash *flash'.
90 * @name: Name of SPI flash device
92 #define spi_flash_alloc(_struct, spi, name) \
93 spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \
97 * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data
100 * @name: Name of SPI flash device
102 #define spi_flash_alloc_base(spi, name) \
103 spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name)
105 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
106 unsigned int max_hz, unsigned int spi_mode);
107 void spi_flash_free(struct spi_flash *flash);
109 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
110 size_t len, void *buf)
112 return flash->read(flash, offset, len, buf);
115 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
116 size_t len, const void *buf)
118 return flash->write(flash, offset, len, buf);
121 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
124 return flash->erase(flash, offset, len);
127 void spi_boot(void) __noreturn;
129 #endif /* _SPI_FLASH_H_ */