Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 1 | /* |
| 2 | * SPI flash internal definitions |
| 3 | * |
| 4 | * Copyright (C) 2008 Atmel Corporation |
| 5 | */ |
| 6 | |
Mike Frysinger | 01e79ae | 2009-04-02 08:11:31 -0400 | [diff] [blame] | 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) |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 13 | #define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ) |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 14 | |
| 15 | /* Common commands */ |
| 16 | #define CMD_READ_ID 0x9f |
| 17 | |
| 18 | #define CMD_READ_ARRAY_SLOW 0x03 |
| 19 | #define CMD_READ_ARRAY_FAST 0x0b |
| 20 | #define CMD_READ_ARRAY_LEGACY 0xe8 |
| 21 | |
Mike Frysinger | 37e13bc | 2011-01-10 02:20:12 -0500 | [diff] [blame] | 22 | #define CMD_READ_STATUS 0x05 |
Mike Frysinger | 53421bb | 2011-01-10 02:20:13 -0500 | [diff] [blame] | 23 | #define CMD_WRITE_ENABLE 0x06 |
Mike Frysinger | 37e13bc | 2011-01-10 02:20:12 -0500 | [diff] [blame] | 24 | |
| 25 | /* Common status */ |
| 26 | #define STATUS_WIP 0x01 |
| 27 | |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 28 | /* Send a single-byte command to the device and read the response */ |
| 29 | int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len); |
| 30 | |
| 31 | /* |
| 32 | * Send a multi-byte command to the device and read the response. Used |
| 33 | * for flash array reads, etc. |
| 34 | */ |
| 35 | int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd, |
| 36 | size_t cmd_len, void *data, size_t data_len); |
| 37 | |
Mike Frysinger | 373e7d6 | 2011-01-10 02:20:14 -0500 | [diff] [blame] | 38 | int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset, |
| 39 | size_t len, void *data); |
| 40 | |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 41 | /* |
| 42 | * Send a multi-byte command to the device followed by (optional) |
| 43 | * data. Used for programming the flash array, etc. |
| 44 | */ |
| 45 | int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len, |
| 46 | const void *data, size_t data_len); |
| 47 | |
| 48 | /* |
| 49 | * Same as spi_flash_cmd_read() except it also claims/releases the SPI |
| 50 | * bus. Used as common part of the ->read() operation. |
| 51 | */ |
| 52 | int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd, |
| 53 | size_t cmd_len, void *data, size_t data_len); |
| 54 | |
Mike Frysinger | 37e13bc | 2011-01-10 02:20:12 -0500 | [diff] [blame] | 55 | /* Send a command to the device and wait for some bit to clear itself. */ |
| 56 | int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout, |
| 57 | u8 cmd, u8 poll_bit); |
| 58 | |
| 59 | /* |
| 60 | * Send the read status command to the device and wait for the wip |
| 61 | * (write-in-progress) bit to clear itself. |
| 62 | */ |
| 63 | int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout); |
| 64 | |
Mike Frysinger | 53421bb | 2011-01-10 02:20:13 -0500 | [diff] [blame] | 65 | /* Erase sectors. */ |
| 66 | int spi_flash_cmd_erase(struct spi_flash *flash, u8 erase_cmd, |
Richard Retanubun | b0148dc | 2011-02-16 16:37:22 -0500 | [diff] [blame^] | 67 | u32 offset, size_t len); |
Mike Frysinger | 53421bb | 2011-01-10 02:20:13 -0500 | [diff] [blame] | 68 | |
Haavard Skinnemoen | 2f5bfb7 | 2008-05-16 11:10:33 +0200 | [diff] [blame] | 69 | /* Manufacturer-specific probe functions */ |
| 70 | struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode); |
| 71 | struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode); |
Chong Huang | c71e6dc | 2010-11-30 03:33:25 -0500 | [diff] [blame] | 72 | struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode); |
Prafulla Wadaskar | 0956907 | 2009-04-06 21:24:43 +0530 | [diff] [blame] | 73 | struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode); |
Mike Frysinger | f1cb7c8 | 2009-03-27 19:27:58 -0400 | [diff] [blame] | 74 | struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode); |
TsiChung Liew | 8dd593a | 2008-08-06 16:08:41 -0500 | [diff] [blame] | 75 | struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode); |
Jason McMullan | 64e5f3a | 2009-10-09 17:12:23 -0400 | [diff] [blame] | 76 | struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode); |
Reinhard Meyer | 52cb0a7 | 2010-10-05 16:56:40 +0200 | [diff] [blame] | 77 | struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode); |