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_WRITE_ENABLE 0x06
26 #define CMD_ERASE_4K 0x20
27 #define CMD_ERASE_32K 0x52
28 #define CMD_ERASE_64K 0xd8
29 #define CMD_ERASE_CHIP 0xc7
31 /* Manufacture ID's */
32 #define SPI_FLASH_SPANSION_IDCODE0 0x01
33 #define SPI_FLASH_STMICRO_IDCODE0 0x20
34 #define SPI_FLASH_WINBOND_IDCODE0 0xef
36 /* Bank addr access commands */
37 #define CMD_BANKADDR_BRWR 0x17
38 #define CMD_BANKADDR_BRRD 0x16
39 #define CMD_EXTNADDR_WREAR 0xC5
40 #define CMD_EXTNADDR_RDEAR 0xC8
43 #define STATUS_WIP 0x01
45 /* Send a single-byte command to the device and read the response */
46 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
49 * Send a multi-byte command to the device and read the response. Used
50 * for flash array reads, etc.
52 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
53 size_t cmd_len, void *data, size_t data_len);
55 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
56 size_t len, void *data);
59 * Send a multi-byte command to the device followed by (optional)
60 * data. Used for programming the flash array, etc.
62 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
63 const void *data, size_t data_len);
66 * Write the requested data out breaking it up into multiple write
67 * commands as needed per the write size.
69 int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
70 size_t len, const void *buf);
73 * Enable writing on the SPI flash.
75 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
77 return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
81 * Disable writing on the SPI flash.
83 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
85 return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
88 /* Program the status register. */
89 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
91 /* Program the bank address register */
92 int spi_flash_cmd_bankaddr_write(struct spi_flash *flash, u8 bank_sel);
94 /* Configure the BAR - discover the bank cmds */
95 int spi_flash_bank_config(struct spi_flash *flash, u8 idcode0);
98 * Same as spi_flash_cmd_read() except it also claims/releases the SPI
99 * bus. Used as common part of the ->read() operation.
101 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
102 size_t cmd_len, void *data, size_t data_len);
104 /* Send a command to the device and wait for some bit to clear itself. */
105 int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
106 u8 cmd, u8 poll_bit);
109 * Send the read status command to the device and wait for the wip
110 * (write-in-progress) bit to clear itself.
112 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
115 int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len);
117 /* Manufacturer-specific probe functions */
118 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
119 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
120 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
121 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
122 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
123 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
124 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
125 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);