2 * SPI flash internal definitions
4 * Copyright (C) 2008 Atmel Corporation
7 /* Common parameters -- kind of high, but they should only occur when there
8 * is a problem (and well your system already is broken), so err on the side
9 * of caution in case we're dealing with slower SPI buses and/or processors.
11 #define SPI_FLASH_PROG_TIMEOUT (2 * CONFIG_SYS_HZ)
12 #define SPI_FLASH_PAGE_ERASE_TIMEOUT (5 * CONFIG_SYS_HZ)
13 #define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ)
16 #define CMD_READ_ID 0x9f
18 #define CMD_READ_ARRAY_SLOW 0x03
19 #define CMD_READ_ARRAY_FAST 0x0b
21 #define CMD_WRITE_STATUS 0x01
22 #define CMD_PAGE_PROGRAM 0x02
23 #define CMD_WRITE_DISABLE 0x04
24 #define CMD_READ_STATUS 0x05
25 #define CMD_FLAG_STATUS 0x70
26 #define CMD_WRITE_ENABLE 0x06
27 #define CMD_ERASE_4K 0x20
28 #define CMD_ERASE_32K 0x52
29 #define CMD_ERASE_64K 0xd8
30 #define CMD_ERASE_CHIP 0xc7
32 #define SPI_FLASH_16MB_BOUN 0x1000000
34 /* Manufacture ID's */
35 #define SPI_FLASH_SPANSION_IDCODE0 0x01
36 #define SPI_FLASH_STMICRO_IDCODE0 0x20
37 #define SPI_FLASH_WINBOND_IDCODE0 0xef
39 #ifdef CONFIG_SPI_FLASH_BAR
40 /* Bank addr access commands */
41 # define CMD_BANKADDR_BRWR 0x17
42 # define CMD_BANKADDR_BRRD 0x16
43 # define CMD_EXTNADDR_WREAR 0xC5
44 # define CMD_EXTNADDR_RDEAR 0xC8
48 #define STATUS_WIP 0x01
49 #define STATUS_PEC 0x80
51 /* Send a single-byte command to the device and read the response */
52 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
55 * Send a multi-byte command to the device and read the response. Used
56 * for flash array reads, etc.
58 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
59 size_t cmd_len, void *data, size_t data_len);
61 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
62 size_t len, void *data);
65 * Send a multi-byte command to the device followed by (optional)
66 * data. Used for programming the flash array, etc.
68 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
69 const void *data, size_t data_len);
72 * Write the requested data out breaking it up into multiple write
73 * commands as needed per the write size.
75 int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
76 size_t len, const void *buf);
79 * Enable writing on the SPI flash.
81 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
83 return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
87 * Disable writing on the SPI flash.
89 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
91 return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
94 /* Program the status register. */
95 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
97 #ifdef CONFIG_SPI_FLASH_BAR
98 /* Program the bank address register */
99 int spi_flash_cmd_bankaddr_write(struct spi_flash *flash, u8 bank_sel);
101 /* Configure the BAR - discover the bank cmds */
102 int spi_flash_bank_config(struct spi_flash *flash, u8 idcode0);
106 * Same as spi_flash_cmd_read() except it also claims/releases the SPI
107 * bus. Used as common part of the ->read() operation.
109 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
110 size_t cmd_len, void *data, size_t data_len);
112 * Used for spi_flash write operation
114 * - spi_flash_cmd_write_enable
115 * - spi_flash_cmd_write
116 * - spi_flash_cmd_wait_ready
119 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
120 size_t cmd_len, const void *buf, size_t buf_len);
123 * Send the read status command to the device and wait for the wip
124 * (write-in-progress) bit to clear itself.
126 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
129 int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len);
131 /* Manufacturer-specific probe functions */
132 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
133 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
134 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
135 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
136 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
137 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
138 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
139 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);
140 struct spi_flash *spi_flash_probe_gigadevice(struct spi_slave *spi, u8 *idcode);