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 #define SPI_FLASH_16MB_BOUN             0x1000000
  32
  33 /* Manufacture ID's */
  34 #define SPI_FLASH_SPANSION_IDCODE0      0x01
  35 #define SPI_FLASH_STMICRO_IDCODE0       0x20
  36 #define SPI_FLASH_WINBOND_IDCODE0       0xef
  37
  38 #ifdef CONFIG_SPI_FLASH_BAR
  39 /* Bank addr access commands */
  40 # define CMD_BANKADDR_BRWR              0x17
  41 # define CMD_BANKADDR_BRRD              0x16
  42 # define CMD_EXTNADDR_WREAR             0xC5
  43 # define CMD_EXTNADDR_RDEAR             0xC8
  44 #endif
  45
  46 /* Common status */
  47 #define STATUS_WIP                      0x01
  48
  49 /* Send a single-byte command to the device and read the response */
  50 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
  51
  52 /*
  53  * Send a multi-byte command to the device and read the response. Used
  54  * for flash array reads, etc.
  55  */
  56 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  57                 size_t cmd_len, void *data, size_t data_len);
  58
  59 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
  60                 size_t len, void *data);
  61
  62 /*
  63  * Send a multi-byte command to the device followed by (optional)
  64  * data. Used for programming the flash array, etc.
  65  */
  66 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  67                 const void *data, size_t data_len);
  68
  69 /*
  70  * Write the requested data out breaking it up into multiple write
  71  * commands as needed per the write size.
  72  */
  73 int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
  74                 size_t len, const void *buf);
  75
  76 /*
  77  * Enable writing on the SPI flash.
  78  */
  79 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
  80 {
  81         return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
  82 }
  83
  84 /*
  85  * Disable writing on the SPI flash.
  86  */
  87 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
  88 {
  89         return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
  90 }
  91
  92 /* Program the status register. */
  93 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
  94
  95 #ifdef CONFIG_SPI_FLASH_BAR
  96 /* Program the bank address register */
  97 int spi_flash_cmd_bankaddr_write(struct spi_flash *flash, u8 bank_sel);
  98
  99 /* Configure the BAR - discover the bank cmds */
 100 int spi_flash_bank_config(struct spi_flash *flash, u8 idcode0);
 101 #endif
 102
 103 /*
 104  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
 105  * bus. Used as common part of the ->read() operation.
 106  */
 107 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
 108                 size_t cmd_len, void *data, size_t data_len);
 109
 110 /*
 111  * Send the read status command to the device and wait for the wip
 112  * (write-in-progress) bit to clear itself.
 113  */
 114 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
 115
 116 /* Erase sectors. */
 117 int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len);
 118
 119 /* Manufacturer-specific probe functions */
 120 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
 121 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
 122 struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
 123 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
 124 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
 125 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
 126 struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
 127 struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);