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 #define CMD_WRITE_ENABLE                0x06
  24
  25 /* Common status */
  26 #define STATUS_WIP                      0x01
  27
  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
  38 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
  39                 size_t len, void *data);
  40
  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  * Enable writing on the SPI flash.
  50  */
  51 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
  52 {
  53         return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
  54 }
  55
  56 /*
  57  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
  58  * bus. Used as common part of the ->read() operation.
  59  */
  60 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
  61                 size_t cmd_len, void *data, size_t data_len);
  62
  63 /* Send a command to the device and wait for some bit to clear itself. */
  64 int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
  65                            u8 cmd, u8 poll_bit);
  66
  67 /*
  68  * Send the read status command to the device and wait for the wip
  69  * (write-in-progress) bit to clear itself.
  70  */
  71 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
  72
  73 /* Erase sectors. */
  74 int spi_flash_cmd_erase(struct spi_flash *flash, u8 erase_cmd,
  75                         u32 offset, size_t len);
  76
  77 /* Manufacturer-specific probe functions */
  78 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
  79 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
  80 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
  81 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
  82 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
  83 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
  84 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
  85 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);