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