drivers: mtd: qspi: Add quad read support
[glsdk/glsdk-u-boot.git] / drivers / mtd / spi / spi_flash_internal.h
1 /*
2  * SPI flash internal definitions
3  *
4  * Copyright (C) 2008 Atmel Corporation
5  */
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.
10  */
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)
15 /* Common commands */
16 #define CMD_READ_ID                     0x9f
18 #define CMD_READ_ARRAY_SLOW             0x03
19 #define CMD_READ_ARRAY_FAST             0x0b
20 #define CMD_READ_ARRAY_QUAD            0x6b
22 #define CMD_WRITE_STATUS                0x01
23 #define CMD_PAGE_PROGRAM                0x02
24 #define CMD_WRITE_DISABLE               0x04
25 #define CMD_READ_STATUS                 0x05
26 #define CMD_READ_CONFIG                 0x35
27 #define CMD_FLAG_STATUS                 0x70
28 #define CMD_WRITE_ENABLE                0x06
29 #define CMD_ERASE_4K                    0x20
30 #define CMD_ERASE_32K                   0x52
31 #define CMD_ERASE_64K                   0xd8
32 #define CMD_ERASE_CHIP                  0xc7
34 #define SPI_FLASH_16MB_BOUN             0x1000000
36 /* Manufacture ID's */
37 #define SPI_FLASH_SPANSION_IDCODE0      0x01
38 #define SPI_FLASH_STMICRO_IDCODE0       0x20
39 #define SPI_FLASH_WINBOND_IDCODE0       0xef
41 #ifdef CONFIG_SPI_FLASH_BAR
42 /* Bank addr access commands */
43 # define CMD_BANKADDR_BRWR              0x17
44 # define CMD_BANKADDR_BRRD              0x16
45 # define CMD_EXTNADDR_WREAR             0xC5
46 # define CMD_EXTNADDR_RDEAR             0xC8
47 #endif
49 /* Common status */
50 #define STATUS_WIP                      0x01
51 #define STATUS_PEC                      0x80
53 /* Send a single-byte command to the device and read the response */
54 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
56 /*
57  * Send a multi-byte command to the device and read the response. Used
58  * for flash array reads, etc.
59  */
60 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
61                 size_t cmd_len, void *data, size_t data_len);
63 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
64                 size_t len, void *data);
66 /*
67  * Send a multi-byte command to the device followed by (optional)
68  * data. Used for programming the flash array, etc.
69  */
70 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
71                 const void *data, size_t data_len);
73 /*
74  * Write the requested data out breaking it up into multiple write
75  * commands as needed per the write size.
76  */
77 int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
78                 size_t len, const void *buf);
80 /*
81  * Enable writing on the SPI flash.
82  */
83 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
84 {
85         return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
86 }
88 /*
89  * Disable writing on the SPI flash.
90  */
91 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
92 {
93         return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
94 }
96 /* Program the status register. */
97 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
99 #ifdef CONFIG_SPI_FLASH_BAR
100 /* Program the bank address register */
101 int spi_flash_cmd_bankaddr_write(struct spi_flash *flash, u8 bank_sel);
103 /* Configure the BAR - discover the bank cmds */
104 int spi_flash_bank_config(struct spi_flash *flash, u8 idcode0);
105 #endif
107 /*
108  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
109  * bus. Used as common part of the ->read() operation.
110  */
111 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
112                 size_t cmd_len, void *data, size_t data_len);
113 /*
114  * Used for spi_flash write operation
115  * - SPI claim
116  * - spi_flash_cmd_write_enable
117  * - spi_flash_cmd_write
118  * - spi_flash_cmd_wait_ready
119  * - SPI release
120  */
121 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
122                 size_t cmd_len, const void *buf, size_t buf_len);
124 /*
125  * Send the read status command to the device and wait for the wip
126  * (write-in-progress) bit to clear itself.
127  */
128 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
130 /* Erase sectors. */
131 int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len);
133 /* Manufacturer-specific probe functions */
134 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
135 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
136 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
137 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
138 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
139 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
140 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
141 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);