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