blob: e69694870ee1a183aebc2e79c5cce7146a4caf59 [file] [log] [blame]
Stefan Reinauer1c56d9b2012-05-10 11:27:32 -07001/*
2 * SPI flash internal definitions
3 *
4 * Copyright (C) 2008 Atmel Corporation
5 */
6
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 CONFIG_SYS_HZ 100
12#define SPI_FLASH_PROG_TIMEOUT (2 * CONFIG_SYS_HZ)
13#define SPI_FLASH_PAGE_ERASE_TIMEOUT (5 * CONFIG_SYS_HZ)
14#define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ)
15
16/* Common commands */
17#define CMD_READ_ID 0x9f
18
19#define CMD_READ_ARRAY_SLOW 0x03
20#define CMD_READ_ARRAY_FAST 0x0b
21#define CMD_READ_ARRAY_LEGACY 0xe8
22
23#define CMD_READ_STATUS 0x05
24#define CMD_WRITE_ENABLE 0x06
25
26/* Common status */
27#define STATUS_WIP 0x01
28
29/* Send a single-byte command to the device and read the response */
30int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
31
32/*
33 * Send a multi-byte command to the device and read the response. Used
34 * for flash array reads, etc.
35 */
36int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
37 size_t cmd_len, void *data, size_t data_len);
38
39int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
40 size_t len, void *data);
41
42int spi_flash_cmd_read_slow(struct spi_flash *flash, u32 offset,
43 size_t len, void *data);
44
45/*
46 * Send a multi-byte command to the device followed by (optional)
47 * data. Used for programming the flash array, etc.
48 */
49int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
50 const void *data, size_t data_len);
51
52/*
53 * Same as spi_flash_cmd_read() except it also claims/releases the SPI
54 * bus. Used as common part of the ->read() operation.
55 */
56int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
57 size_t cmd_len, void *data, size_t data_len);
58
59/* Send a command to the device and wait for some bit to clear itself. */
60int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
61 u8 cmd, u8 poll_bit);
62
63/*
64 * Send the read status command to the device and wait for the wip
65 * (write-in-progress) bit to clear itself.
66 */
67int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
68
69/* Erase sectors. */
70int spi_flash_cmd_erase(struct spi_flash *flash, u8 erase_cmd,
71 u32 offset, size_t len);
72
73/* Manufacturer-specific probe functions */
74struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
Idwer Vollering73a10182014-02-16 00:32:13 +000075struct spi_flash *spi_flash_probe_amic(struct spi_slave *spi, u8 *idcode);
Stefan Reinauer1c56d9b2012-05-10 11:27:32 -070076struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
77struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
78struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
79struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
80struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
81struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
Martin Rothbceaf7f2012-09-07 15:02:35 -060082struct spi_flash *spi_flash_probe_gigadevice(struct spi_slave *spi,
83 u8 *idcode);
Chris Douglassb34739b2014-02-14 13:51:26 -050084struct spi_flash *spi_flash_probe_adesto(struct spi_slave *spi, u8 *idcode);
Stefan Reinauer1c56d9b2012-05-10 11:27:32 -070085struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);