drivers/mtd/spi/spi_flash_internal.h

   1 /*
   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 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)
  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
  22 #define CMD_READ_STATUS                 0x05
  23
  24 /* Common status */
  25 #define STATUS_WIP                      0x01
  26
  27 /* Send a single-byte command to the device and read the response */
  28 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
  29
  30 /*
  31  * Send a multi-byte command to the device and read the response. Used
  32  * for flash array reads, etc.
  33  */
  34 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  35                 size_t cmd_len, void *data, size_t data_len);
  36
  37 /*
  38  * Send a multi-byte command to the device followed by (optional)
  39  * data. Used for programming the flash array, etc.
  40  */
  41 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  42                 const void *data, size_t data_len);
  43
  44 /*
  45  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
  46  * bus. Used as common part of the ->read() operation.
  47  */
  48 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
  49                 size_t cmd_len, void *data, size_t data_len);
  50
  51 /* Send a command to the device and wait for some bit to clear itself. */
  52 int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
  53                            u8 cmd, u8 poll_bit);
  54
  55 /*
  56  * Send the read status command to the device and wait for the wip
  57  * (write-in-progress) bit to clear itself.
  58  */
  59 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
  60
  61 /* Manufacturer-specific probe functions */
  62 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
  63 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
  64 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
  65 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
  66 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
  67 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
  68 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
  69 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);