Activate proper support for EN29F002(A)(N)[BT].
[coreboot.git] / util / flashrom / flash.h
index ec28064f53f5b79caa0dcd5dadf8d4d9ed724fce..1dcdbfbdb54309d817ac662e06a2ef67d4d67c49 100644 (file)
 #include <stdint.h>
 #include <stdio.h>
 
+#ifdef __FreeBSD__
+  #include <machine/cpufunc.h>
+  #define off64_t off_t
+  #define lseek64 lseek
+  #define OUTB(x, y) do { u_int tmp = (y); outb(tmp, (x)); } while (0)
+  #define OUTW(x, y) do { u_int tmp = (y); outw(tmp, (x)); } while (0)
+  #define OUTL(x, y) do { u_int tmp = (y); outl(tmp, (x)); } while (0)
+  #define INB(x) __extension__ ({ u_int tmp = (x); inb(tmp); })
+  #define INW(x) __extension__ ({ u_int tmp = (x); inw(tmp); })
+  #define INL(x) __extension__ ({ u_int tmp = (x); inl(tmp); })
+#else
+  #define OUTB outb
+  #define OUTW outw
+  #define OUTL outl
+  #define INB  inb
+  #define INW  inw
+  #define INL  inl
+#endif
+
+#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
+
 struct flashchip {
+       const char *vendor;
        const char *name;
-       int manufacture_id;
-       int model_id;
+       /* With 32bit manufacture_id and model_id we can cover IDs up to
+        * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
+        * Identification code.
+        */
+       uint32_t manufacture_id;
+       uint32_t model_id;
 
        int total_size;
        int page_size;
 
+       /* Indicate if flashrom has been tested with this flash chip and if
+        * everything worked correctly.
+        */
+       uint32_t tested;
+
        int (*probe) (struct flashchip *flash);
        int (*erase) (struct flashchip *flash);
        int (*write) (struct flashchip *flash, uint8_t *buf);
@@ -48,6 +79,22 @@ struct flashchip {
        volatile uint8_t *virtual_registers;
 };
 
+#define TEST_UNTESTED  0
+
+#define TEST_OK_PROBE  (1<<0)
+#define TEST_OK_READ   (1<<1)
+#define TEST_OK_ERASE  (1<<2)
+#define TEST_OK_WRITE  (1<<3)
+#define TEST_OK_PR     (TEST_OK_PROBE|TEST_OK_READ)
+#define TEST_OK_PREW   (TEST_OK_PROBE|TEST_OK_READ|TEST_OK_ERASE|TEST_OK_WRITE)
+#define TEST_OK_MASK   0x0f
+
+#define TEST_BAD_PROBE (1<<4)
+#define TEST_BAD_READ  (1<<5)
+#define TEST_BAD_ERASE (1<<6)
+#define TEST_BAD_WRITE (1<<7)
+#define TEST_BAD_MASK  0xf0
+
 extern struct flashchip flashchips[];
 
 /*
@@ -55,23 +102,44 @@ extern struct flashchip flashchips[];
  * entry of each section should be the manufacturer ID, followed by the
  * list of devices from that manufacturer (sorted by device IDs).
  *
- * All LPC/FWH parts (parallel flash) have 8-bit device IDs.
+ * All LPC/FWH parts (parallel flash) have 8-bit device IDs if there is no
+ * continuation code.
  * All SPI parts have 16-bit device IDs.
  */
 
-#define ALLIANCE_ID            0x52    /* Alliance */
+#define GENERIC_DEVICE_ID      0xffff  /* Only match the vendor ID */
+
+#define ALLIANCE_ID            0x52    /* Alliance Semiconductor */
 
 #define AMD_ID                 0x01    /* AMD */
 #define AM_29F040B             0xA4
 #define AM_29LV040B            0x4F
 #define AM_29F016D             0xAD
 
-#define AMIC_ID                        0x37    /* AMIC */
+#define AMIC_ID                        0x7F37  /* AMIC */
+#define AMIC_ID_NOPREFIX       0x37    /* AMIC */
+#define AMIC_A25L40P           0x2013
+#define AMIC_A29002B           0x0d
+#define AMIC_A29002T           0x8c
+#define AMIC_A29040B           0x86
+#define AMIC_A49LF040A         0x9d
 
-#define ASD_ID                 0x25    /* ASD */
+#define ASD_ID                 0x25    /* ASD, not listed in JEP106W */
 #define ASD_AE49F2008          0x52
 
 #define ATMEL_ID               0x1F    /* Atmel */
+#define AT_25DF021             0x4300
+#define AT_25DF041A            0x4401
+#define AT_25DF081             0x4502
+#define AT_25DF161             0x4602
+#define AT_25DF321             0x4700  /* also 26DF321 */
+#define AT_25DF321A            0x4701
+#define AT_25DF641             0x4800
+#define AT_26DF041             0x4400
+#define AT_26DF081             0x4500  /* guessed, no datasheet available */
+#define AT_26DF081A            0x4501
+#define AT_26DF161             0x4600
+#define AT_26DF161A            0x4601
 #define AT_29C040A             0xA4
 #define AT_29C020              0xDA
 #define AT_49F002N             0x07    /* for AT49F002(N)  */
@@ -79,14 +147,20 @@ extern struct flashchip flashchips[];
 
 #define CATALYST_ID            0x31    /* Catalyst */
 
-#define EMST_ID                        0x8C    /* EMST / EFST */
+#define EMST_ID                        0x8C    /* EMST / EFST Elite Flash Storage*/
 #define EMST_F49B002UA         0x00
 
 /*
  * EN25 chips are SPI, first byte of device ID is memory type,
  * second byte of device ID is log(bitsize)-9.
+ * Vendor and device ID of EN29 series are both prefixed with 0x7F, which
+ * is the continuation code for IDs in bank 2.
+ * Vendor ID of EN25 series is NOT prefixed with 0x7F, this results in
+ * a collision with Mitsubishi. Mitsubishi once manufactured flash chips.
+ * Let's hope they are not manufacturing SPI flash chips as well.
  */
-#define EON_ID                 0x1C    /* EON */
+#define EON_ID                 0x7F1C  /* EON Silicon Devices */
+#define EON_ID_NOPREFIX                0x1C    /* EON, missing 0x7F prefix */
 #define EN_25B05               0x2010  /* 2^19 kbit or 2^16 kByte */
 #define EN_25B10               0x2011
 #define EN_25B20               0x2012
@@ -94,26 +168,37 @@ extern struct flashchip flashchips[];
 #define EN_25B80               0x2014
 #define EN_25B16               0x2015
 #define EN_25B32               0x2016
+#define EN_29F512              0x7F21
+#define EN_29F010              0x7F20
+#define EN_29F040A             0x7F04
+#define EN_29LV010             0x7F6E
+#define EN_29LV040A            0x7F4F  /* EN_29LV040(A) */
+#define EN_29F002T             0x7F92
+#define EN_29F002B             0x7F97
 
 #define FUJITSU_ID             0x04    /* Fujitsu */
-#define MBM29F400TC            0x23
+/* MBM29F400TC_STRANGE has a value not mentioned in the data sheet and we
+ * try to read it from a location not mentioned in the data sheet.
+ */
+#define MBM29F400TC_STRANGE    0x23
+#define MBM29F400BC            0x7B
+#define MBM29F400TC            0x77
 
 #define HYUNDAI_ID             0xAD    /* Hyundai */
 
-#define IMT_ID                 0x7F    /* IMT */
+#define IMT_ID                 0x7F1F  /* Integrated Memory Technologies */
+#define IM_29F004B             0xAE
+#define IM_29F004T             0xAF
 
 #define INTEL_ID               0x89    /* Intel */
 
-#define ISSI_ID                        0xD5    /* ISSI */
-
-#define MSYSTEMS_ID            0x156F  /* M-Systems */
-#define MSYSTEMS_MD2200                0xDB
-#define MSYSTEMS_MD2800                0x30    /* hmm -- both 0x30 */
-#define MSYSTEMS_MD2802                0x30    /* hmm -- both 0x30 */
+#define ISSI_ID                        0xD5    /* ISSI Integrated Silicon Solutions */
 
 /*
  * MX25 chips are SPI, first byte of device ID is memory type,
  * second byte of device ID is log(bitsize)-9.
+ * Generalplus SPI chips seem to be compatible with Macronix
+ * and use the same set of IDs.
  */
 #define MX_ID                  0xC2    /* Macronix (MX) */
 #define MX_25L512              0x2010  /* 2^19 kbit or 2^16 kByte */
@@ -128,13 +213,37 @@ extern struct flashchip flashchips[];
 #define MX_25L3235D            0x2416
 #define MX_29F002              0xB0
 
-#define PMC_ID                 0x9D    /* PMC */
+/* Programmable Micro Corp is listed in JEP106W in bank 2, so it should have
+ * a 0x7F continuation code prefix.
+ */
+#define PMC_ID                 0x7F9D  /* PMC */
+#define PMC_ID_NOPREFIX                0x9D    /* PMC, missing 0x7F prefix */
+#define PMC_25LV512            0x7B
+#define PMC_25LV010            0x7C
+#define PMC_25LV020            0x7D
+#define PMC_25LV040            0x7E
+#define PMC_25LV080B           0x13
+#define PMC_25LV016B           0x14
+#define PMC_39LV512            0x1B
+#define PMC_39F010             0x1C    /* also Pm39LV010 */
+#define PMC_39LV020            0x3D
+#define PMC_39LV040            0x3E
+#define PMC_39F020             0x4D
+#define PMC_39F040             0x4E
 #define PMC_49FL002            0x6D
 #define PMC_49FL004            0x6E
 
 #define SHARP_ID               0xB0    /* Sharp */
 #define SHARP_LHF00L04         0xCF
 
+/*
+ * Spansion was previously a joint venture of AMD and Fujitsu.
+ * S25 chips are SPI. The first device ID byte is memory type and
+ * the second device ID byte is memory capacity.
+ */
+#define SPANSION_ID            0x01    /* Spansion */
+#define SPANSION_S25FL016A     0x0214
+
 /*
  * SST25 chips are SPI, first byte of device ID is memory type, second
  * byte of device ID is related to log(bitsize) at least for some chips.
@@ -148,12 +257,28 @@ extern struct flashchip flashchips[];
 #define SST_25VF032B           0x254A
 #define SST_25VF040B           0x258D
 #define SST_25VF080B           0x258E
-#define SST_29EE020A           0x10
+#define SST_27SF512            0xA4
+#define SST_27SF010            0xA5
+#define SST_27SF020            0xA6
+#define SST_27VF010            0xA9
+#define SST_27VF020            0xAA
 #define SST_28SF040            0x04
+#define SST_29EE512            0x5D
+#define SST_29EE010            0x07
+#define SST_29LE010            0x08    /* also SST29VE010 */
+#define SST_29EE020A           0x10
+#define SST_29LE020            0x12    /* also SST29VE020 */
+#define SST_29SF020            0x24
+#define SST_29VF020            0x25
+#define SST_29SF040            0x13
+#define SST_29VF040            0x14
 #define SST_39SF010            0xB5
 #define SST_39SF020            0xB6
 #define SST_39SF040            0xB7
+#define SST_39VF512            0xD4
+#define SST_39VF010            0xD5
 #define SST_39VF020            0xD6
+#define SST_39VF040            0xD7
 #define SST_49LF040B           0x50
 #define SST_49LF040            0x51
 #define SST_49LF020A           0x52
@@ -171,11 +296,12 @@ extern struct flashchip flashchips[];
  * ST25P chips are SPI, first byte of device ID is memory type, second
  * byte of device ID is related to log(bitsize) at least for some chips.
  */
-#define ST_ID                  0x20    /* ST */
+#define ST_ID                  0x20    /* ST / SGS/Thomson */
 #define ST_M25P05A             0x2010
 #define ST_M25P10A             0x2011
 #define ST_M25P20              0x2012
 #define ST_M25P40              0x2013
+#define ST_M25P40_RES          0x12
 #define ST_M25P80              0x2014
 #define ST_M25P16              0x2015
 #define ST_M25P32              0x2016
@@ -204,7 +330,16 @@ extern struct flashchip flashchips[];
 
 #define TI_ID                  0x97    /* Texas Instruments */
 
+/*
+ * W25X chips are SPI, first byte of device ID is memory type, second
+ * byte of device ID is related to log(bitsize).
+ */
 #define WINBOND_ID             0xDA    /* Winbond */
+#define WINBOND_NEX_ID         0xEF    /* Winbond (ex Nexcom) serial flash devices */
+#define W_25X10                        0x3011
+#define W_25X20                        0x3012
+#define W_25X40                        0x3013
+#define W_25X80                        0x3014
 #define W_29C011               0xC1
 #define W_29C020C              0x45
 #define W_29C040P              0x46
@@ -213,6 +348,8 @@ extern struct flashchip flashchips[];
 #define W_39V040A              0x3D
 #define W_39V040B              0x54
 #define W_39V080A              0xD0
+#define W_39V080FA             0xD3
+#define W_39V080FA_DM          0x93
 #define W_49F002U              0x0B
 #define W_49V002A              0xB0
 #define W_49V002FA             0x32
@@ -227,11 +364,25 @@ struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
                              uint16_t card_vendor, uint16_t card_device);
 
+
 /* board_enable.c */
 int board_flash_enable(const char *vendor, const char *part);
+void print_supported_boards(void);
 
 /* chipset_enable.c */
 int chipset_flash_enable(void);
+void print_supported_chipsets(void);
+
+typedef enum {
+       BUS_TYPE_LPC,
+       BUS_TYPE_ICH7_SPI,
+       BUS_TYPE_ICH9_SPI,
+       BUS_TYPE_IT87XX_SPI,
+       BUS_TYPE_VIA_SPI
+} flashbus_t;
+
+extern flashbus_t flashbus;
+extern void *spibar;
 
 /* Physical memory mapping device */
 #if defined (__sun) && (defined(__i386) || defined(__amd64))
@@ -250,23 +401,29 @@ extern int verbose;
 int map_flash_registers(struct flashchip *flash);
 
 /* layout.c */
-int show_id(uint8_t *bios, int size);
+int show_id(uint8_t *bios, int size, int force);
 int read_romlayout(char *name);
 int find_romentry(char *name);
 int handle_romentries(uint8_t *buffer, uint8_t *content);
 
 /* lbtable.c */
-int linuxbios_init(void);
+int coreboot_init(void);
 extern char *lb_part, *lb_vendor;
 
 /* spi.c */
-int probe_spi(struct flashchip *flash);
-int it87xx_probe_spi_flash(const char *name);
-int generic_spi_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
-void generic_spi_write_enable();
-void generic_spi_write_disable();
-int generic_spi_chip_erase_c7(struct flashchip *flash);
-int generic_spi_chip_write(struct flashchip *flash, uint8_t *buf);
+int probe_spi_rdid(struct flashchip *flash);
+int probe_spi_rdid4(struct flashchip *flash);
+int probe_spi_res(struct flashchip *flash);
+int spi_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
+void spi_write_enable();
+void spi_write_disable();
+int spi_chip_erase_c7(struct flashchip *flash);
+int spi_chip_write(struct flashchip *flash, uint8_t *buf);
+int spi_chip_read(struct flashchip *flash, uint8_t *buf);
+uint8_t spi_read_status_register();
+void spi_disable_blockprotect(void);
+void spi_byte_program(int address, uint8_t byte);
+void spi_nbyte_read(int address, uint8_t *bytes, int len);
 
 /* 82802ab.c */
 int probe_82802ab(struct flashchip *flash);
@@ -278,7 +435,25 @@ int probe_29f040b(struct flashchip *flash);
 int erase_29f040b(struct flashchip *flash);
 int write_29f040b(struct flashchip *flash, uint8_t *buf);
 
+/* en29f002a.c */
+int probe_en29f002a(struct flashchip *flash);
+int erase_en29f002a(struct flashchip *flash);
+int write_en29f002a(struct flashchip *flash, uint8_t *buf);
+
+/* ichspi.c */
+int ich_spi_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
+int ich_spi_read(struct flashchip *flash, uint8_t * buf);
+int ich_spi_write(struct flashchip *flash, uint8_t * buf);
+
+/* it87spi.c */
+extern uint16_t it8716f_flashport;
+int it87xx_probe_spi_flash(const char *name);
+int it8716f_spi_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
+int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf);
+int it8716f_spi_chip_write(struct flashchip *flash, uint8_t *buf);
+
 /* jedec.c */
+uint8_t oddparity(uint8_t val);
 void toggle_ready_jedec(volatile uint8_t *dst);
 void data_polling_jedec(volatile uint8_t *dst, uint8_t data);
 void unprotect_jedec(volatile uint8_t *bios);
@@ -299,7 +474,7 @@ int erase_m29f400bt(struct flashchip *flash);
 int block_erase_m29f400bt(volatile uint8_t *bios,
                                 volatile uint8_t *dst);
 int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
-int write_linuxbios_m29f400bt(struct flashchip *flash, uint8_t *buf);
+int write_coreboot_m29f400bt(struct flashchip *flash, uint8_t *buf);
 void toggle_ready_m29f400bt(volatile uint8_t *dst);
 void data_polling_m29f400bt(volatile uint8_t *dst, uint8_t data);
 void protect_m29f400bt(volatile uint8_t *bios);
@@ -311,10 +486,10 @@ int probe_29f002(struct flashchip *flash);
 int erase_29f002(struct flashchip *flash);
 int write_29f002(struct flashchip *flash, uint8_t *buf);
 
-/* pm49fl004.c */
-int probe_49fl004(struct flashchip *flash);
-int erase_49fl004(struct flashchip *flash);
-int write_49fl004(struct flashchip *flash, uint8_t *buf);
+/* pm49fl00x.c */
+int probe_49fl00x(struct flashchip *flash);
+int erase_49fl00x(struct flashchip *flash);
+int write_49fl00x(struct flashchip *flash, uint8_t *buf);
 
 /* sharplhf00l04.c */
 int probe_lhf00l04(struct flashchip *flash);
@@ -347,10 +522,25 @@ int probe_sst_fwhub(struct flashchip *flash);
 int erase_sst_fwhub(struct flashchip *flash);
 int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
 
+/* w39v040c.c */
+int probe_w39v040c(struct flashchip *flash);
+int erase_w39v040c(struct flashchip *flash);
+int write_w39v040c(struct flashchip *flash, uint8_t *buf);
+
+/* w39V080fa.c */
+int probe_winbond_fwhub(struct flashchip *flash);
+int erase_winbond_fwhub(struct flashchip *flash);
+int write_winbond_fwhub(struct flashchip *flash, uint8_t *buf);
+
 /* w29ee011.c */
 int probe_w29ee011(struct flashchip *flash);
 
 /* w49f002u.c */
 int write_49f002(struct flashchip *flash, uint8_t *buf);
 
+/* stm50flw0x0x.c */
+int probe_stm50flw0x0x(struct flashchip *flash);
+int erase_stm50flw0x0x(struct flashchip *flash);
+int write_stm50flw0x0x(struct flashchip *flash, uint8_t *buf);
+
 #endif                         /* !__FLASH_H__ */