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_PAGE_PROGRAM                0x02
  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 */
  30 int 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  */
  36 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  37                 size_t cmd_len, void *data, size_t data_len);
  38
  39 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
  40                 size_t len, void *data);
  41
  42 /*
  43  * Send a multi-byte command to the device followed by (optional)
  44  * data. Used for programming the flash array, etc.
  45  */
  46 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  47                 const void *data, size_t data_len);
  48
  49 /*
  50  * Write the requested data out breaking it up into multiple write
  51  * commands as needed per the write size.
  52  */
  53 int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
  54                 size_t len, const void *buf);
  55
  56 /*
  57  * Enable writing on the SPI flash.
  58  */
  59 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
  60 {
  61         return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
  62 }
  63
  64 /*
  65  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
  66  * bus. Used as common part of the ->read() operation.
  67  */
  68 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
  69                 size_t cmd_len, void *data, size_t data_len);
  70
  71 /* Send a command to the device and wait for some bit to clear itself. */
  72 int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
  73                            u8 cmd, u8 poll_bit);
  74
  75 /*
  76  * Send the read status command to the device and wait for the wip
  77  * (write-in-progress) bit to clear itself.
  78  */
  79 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
  80
  81 /* Erase sectors. */
  82 int spi_flash_cmd_erase(struct spi_flash *flash, u8 erase_cmd,
  83                         u32 offset, size_t len);
  84
  85 /* Manufacturer-specific probe functions */
  86 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
  87 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
  88 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
  89 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
  90 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
  91 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
  92 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
  93 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);