util/flashrom/flash.h

   1 /*
   2  * This file is part of the flashrom project.
   3  *
   4  * Copyright (C) 2000 Silicon Integrated System Corporation
   5  * Copyright (C) 2000 Ronald G. Minnich <rminnich@gmail.com>
   6  * Copyright (C) 2005-2007 coresystems GmbH <stepan@coresystems.de>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21  */
  22
  23 #ifndef __FLASH_H__
  24 #define __FLASH_H__ 1
  25
  26 #if defined(__GLIBC__)
  27 #include <sys/io.h>
  28 #endif
  29 #include <unistd.h>
  30 #include <stdint.h>
  31 #include <stdio.h>
  32
  33 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  34
  35 struct flashchip {
  36         const char *name;
  37         /* With 32bit manufacture_id and model_id we can cover IDs up to
  38          * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
  39          * Identification code.
  40          */
  41         uint32_t manufacture_id;
  42         uint32_t model_id;
  43
  44         int total_size;
  45         int page_size;
  46
  47         int (*probe) (struct flashchip *flash);
  48         int (*erase) (struct flashchip *flash);
  49         int (*write) (struct flashchip *flash, uint8_t *buf);
  50         int (*read) (struct flashchip *flash, uint8_t *buf);
  51
  52         /* Some flash devices have an additional register space. */
  53         volatile uint8_t *virtual_memory;
  54         volatile uint8_t *virtual_registers;
  55 };
  56
  57 extern struct flashchip flashchips[];
  58
  59 /*
  60  * Please keep this list sorted alphabetically by manufacturer. The first
  61  * entry of each section should be the manufacturer ID, followed by the
  62  * list of devices from that manufacturer (sorted by device IDs).
  63  *
  64  * All LPC/FWH parts (parallel flash) have 8-bit device IDs if there is no
  65  * continuation code.
  66  * All SPI parts have 16-bit device IDs.
  67  */
  68
  69 #define GENERIC_DEVICE_ID       0xffff  /* Only match the vendor ID */
  70
  71 #define ALLIANCE_ID             0x52    /* Alliance Semiconductor */
  72
  73 #define AMD_ID                  0x01    /* AMD */
  74 #define AM_29F040B              0xA4
  75 #define AM_29LV040B             0x4F
  76 #define AM_29F016D              0xAD
  77
  78 #define AMIC_ID                 0x7F37  /* AMIC */
  79
  80 #define ASD_ID                  0x25    /* ASD, not listed in JEP106W */
  81 #define ASD_AE49F2008           0x52
  82
  83 #define ATMEL_ID                0x1F    /* Atmel */
  84 #define AT_29C040A              0xA4
  85 #define AT_29C020               0xDA
  86 #define AT_49F002N              0x07    /* for AT49F002(N)  */
  87 #define AT_49F002NT             0x08    /* for AT49F002(N)T */
  88
  89 #define CATALYST_ID             0x31    /* Catalyst */
  90
  91 #define EMST_ID                 0x8C    /* EMST / EFST Elite Flash Storage*/
  92 #define EMST_F49B002UA          0x00
  93
  94 /*
  95  * EN25 chips are SPI, first byte of device ID is memory type,
  96  * second byte of device ID is log(bitsize)-9.
  97  * Vendor and device ID of EN29 series are both prefixed with 0x7F, which
  98  * is the continuation code for IDs in bank 2.
  99  * Vendor ID of EN25 series is NOT prefixed with 0x7F, this results in
 100  * a collision with Mitsubishi. Mitsubishi once manufactured flash chips.
 101  * Let's hope they are not manufacturing SPI flash chips as well.
 102  */
 103 #define EON_ID                  0x7F1C  /* EON Silicon Devices */
 104 #define EON_ID_NOPREFIX         0x1C    /* EON, missing 0x7F prefix */
 105 #define EN_25B05                0x2010  /* 2^19 kbit or 2^16 kByte */
 106 #define EN_25B10                0x2011
 107 #define EN_25B20                0x2012
 108 #define EN_25B40                0x2013
 109 #define EN_25B80                0x2014
 110 #define EN_25B16                0x2015
 111 #define EN_25B32                0x2016
 112 #define EN_29F512               0x7F21
 113 #define EN_29F010               0x7F20
 114 #define EN_29F040A              0x7F04
 115 #define EN_29LV010              0x7F6E
 116 #define EN_29LV040A             0x7F4F  /* EN_29LV040(A) */
 117 #define EN_29F002T              0x7F92
 118 #define EN_29F002B              0x7F97
 119
 120 #define FUJITSU_ID              0x04    /* Fujitsu */
 121 /* MBM29F400TC_STRANGE has a value not mentioned in the data sheet and we
 122  * try to read it from a location not mentioned in the data sheet.
 123  */
 124 #define MBM29F400TC_STRANGE     0x23
 125 #define MBM29F400BC             0x7B
 126 #define MBM29F400TC             0x77
 127
 128 #define HYUNDAI_ID              0xAD    /* Hyundai */
 129
 130 #define IMT_ID                  0x7F1F  /* Integrated Memory Technologies */
 131 #define IM_29F004B              0xAE
 132 #define IM_29F004T              0xAF
 133
 134 #define INTEL_ID                0x89    /* Intel */
 135
 136 #define ISSI_ID                 0xD5    /* ISSI Integrated Silicon Solutions */
 137
 138 #define MSYSTEMS_ID             0x156F  /* M-Systems, not listed in JEP106W */
 139 #define MSYSTEMS_MD2200         0xDB
 140 #define MSYSTEMS_MD2800         0x30    /* hmm -- both 0x30 */
 141 #define MSYSTEMS_MD2802         0x30    /* hmm -- both 0x30 */
 142
 143 /*
 144  * MX25 chips are SPI, first byte of device ID is memory type,
 145  * second byte of device ID is log(bitsize)-9.
 146  */
 147 #define MX_ID                   0xC2    /* Macronix (MX) */
 148 #define MX_25L512               0x2010  /* 2^19 kbit or 2^16 kByte */
 149 #define MX_25L1005              0x2011
 150 #define MX_25L2005              0x2012
 151 #define MX_25L4005              0x2013  /* MX25L4005{,A} */
 152 #define MX_25L8005              0x2014
 153 #define MX_25L1605              0x2015  /* MX25L1605{,A,D} */
 154 #define MX_25L3205              0x2016  /* MX25L3205{,A} */
 155 #define MX_25L6405              0x2017  /* MX25L3205{,D} */
 156 #define MX_25L1635D             0x2415
 157 #define MX_25L3235D             0x2416
 158 #define MX_29F002               0xB0
 159
 160 /* Programmable Micro Corp is listed in JEP106W in bank 2, so it should have
 161  * a 0x7F continuation code prefix.
 162  */
 163 #define PMC_ID                  0x7F9D  /* PMC */
 164 #define PMC_ID_NOPREFIX         0x9D    /* PMC, missing 0x7F prefix */
 165 #define PMC_25LV512             0x7B
 166 #define PMC_25LV010             0x7C
 167 #define PMC_25LV020             0x7D
 168 #define PMC_25LV040             0x7E
 169 #define PMC_25LV080B            0x13
 170 #define PMC_25LV016B            0x14
 171 #define PMC_39LV512             0x1B
 172 #define PMC_39F010              0x1C    /* also Pm39LV010 */
 173 #define PMC_39LV020             0x3D
 174 #define PMC_39LV040             0x3E
 175 #define PMC_39F020              0x4D
 176 #define PMC_39F040              0x4E
 177 #define PMC_49FL002             0x6D
 178 #define PMC_49FL004             0x6E
 179
 180 #define SHARP_ID                0xB0    /* Sharp */
 181 #define SHARP_LHF00L04          0xCF
 182
 183 /*
 184  * Spansion was previously a joint venture of AMD and Fujitsu.
 185  * S25 chips are SPI. The first device ID byte is memory type and
 186  * the second device ID byte is memory capacity.
 187  */
 188 #define SPANSION_ID             0x01    /* Spansion */
 189 #define SPANSION_S25FL016A      0x0214
 190
 191 /*
 192  * SST25 chips are SPI, first byte of device ID is memory type, second
 193  * byte of device ID is related to log(bitsize) at least for some chips.
 194  */
 195 #define SST_ID                  0xBF    /* SST */
 196 #define SST_25WF512             0x2501
 197 #define SST_25WF010             0x2502
 198 #define SST_25WF020             0x2503
 199 #define SST_25WF040             0x2504
 200 #define SST_25VF016B            0x2541
 201 #define SST_25VF032B            0x254A
 202 #define SST_25VF040B            0x258D
 203 #define SST_25VF080B            0x258E
 204 #define SST_29EE020A            0x10
 205 #define SST_28SF040             0x04
 206 #define SST_39SF010             0xB5
 207 #define SST_39SF020             0xB6
 208 #define SST_39SF040             0xB7
 209 #define SST_39VF020             0xD6
 210 #define SST_49LF040B            0x50
 211 #define SST_49LF040             0x51
 212 #define SST_49LF020A            0x52
 213 #define SST_49LF080A            0x5B
 214 #define SST_49LF002A            0x57
 215 #define SST_49LF003A            0x1B
 216 #define SST_49LF004A            0x60
 217 #define SST_49LF008A            0x5A
 218 #define SST_49LF004C            0x54
 219 #define SST_49LF008C            0x59
 220 #define SST_49LF016C            0x5C
 221 #define SST_49LF160C            0x4C
 222
 223 /*
 224  * ST25P chips are SPI, first byte of device ID is memory type, second
 225  * byte of device ID is related to log(bitsize) at least for some chips.
 226  */
 227 #define ST_ID                   0x20    /* ST / SGS/Thomson */
 228 #define ST_M25P05A              0x2010
 229 #define ST_M25P10A              0x2011
 230 #define ST_M25P20               0x2012
 231 #define ST_M25P40               0x2013
 232 #define ST_M25P80               0x2014
 233 #define ST_M25P16               0x2015
 234 #define ST_M25P32               0x2016
 235 #define ST_M25P64               0x2017
 236 #define ST_M25P128              0x2018
 237 #define ST_M50FLW040A           0x08
 238 #define ST_M50FLW040B           0x28
 239 #define ST_M50FLW080A           0x80
 240 #define ST_M50FLW080B           0x81
 241 #define ST_M50FW040             0x2C
 242 #define ST_M50FW080             0x2D
 243 #define ST_M50FW016             0x2E
 244 #define ST_M50LPW116            0x30
 245 #define ST_M29F002B             0x34
 246 #define ST_M29F002T             0xB0    /* M29F002T / M29F002NT */
 247 #define ST_M29F400BT            0xD5
 248 #define ST_M29F040B             0xE2
 249 #define ST_M29W010B             0x23
 250 #define ST_M29W040B             0xE3
 251
 252 #define SYNCMOS_ID              0x40    /* SyncMOS and Mosel Vitelic */
 253 #define S29C51001T              0x01
 254 #define S29C51002T              0x02
 255 #define S29C51004T              0x03
 256 #define S29C31004T              0x63
 257
 258 #define TI_ID                   0x97    /* Texas Instruments */
 259
 260 /*
 261  * W25X chips are SPI, first byte of device ID is memory type, second
 262  * byte of device ID is related to log(bitsize).
 263  */
 264 #define WINBOND_ID              0xDA    /* Winbond */
 265 #define WINBOND_NEX_ID          0xEF    /* Winbond (ex Nexcom) serial flash devices */
 266 #define W_25X10                 0x3011
 267 #define W_25X20                 0x3012
 268 #define W_25X40                 0x3013
 269 #define W_25X80                 0x3014
 270 #define W_29C011                0xC1
 271 #define W_29C020C               0x45
 272 #define W_29C040P               0x46
 273 #define W_29EE011               0xC1
 274 #define W_39V040FA              0x34
 275 #define W_39V040A               0x3D
 276 #define W_39V040B               0x54
 277 #define W_39V080A               0xD0
 278 #define W_49F002U               0x0B
 279 #define W_49V002A               0xB0
 280 #define W_49V002FA              0x32
 281
 282 /* udelay.c */
 283 void myusec_delay(int time);
 284 void myusec_calibrate_delay();
 285
 286 /* PCI handling for board/chipset_enable */
 287 struct pci_access *pacc;
 288 struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
 289 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
 290                               uint16_t card_vendor, uint16_t card_device);
 291
 292
 293 /* board_enable.c */
 294 int board_flash_enable(const char *vendor, const char *part);
 295 void print_supported_boards(void);
 296
 297 /* chipset_enable.c */
 298 int chipset_flash_enable(void);
 299 void print_supported_chipsets(void);
 300
 301 /* Physical memory mapping device */
 302 #if defined (__sun) && (defined(__i386) || defined(__amd64))
 303 #  define MEM_DEV "/dev/xsvc"
 304 #else
 305 #  define MEM_DEV "/dev/mem"
 306 #endif
 307
 308 extern int fd_mem;
 309
 310 /* debug.c */
 311 extern int verbose;
 312 #define printf_debug(x...) { if (verbose) printf(x); }
 313
 314 /* flashrom.c */
 315 int map_flash_registers(struct flashchip *flash);
 316
 317 /* layout.c */
 318 int show_id(uint8_t *bios, int size);
 319 int read_romlayout(char *name);
 320 int find_romentry(char *name);
 321 int handle_romentries(uint8_t *buffer, uint8_t *content);
 322
 323 /* lbtable.c */
 324 int coreboot_init(void);
 325 extern char *lb_part, *lb_vendor;
 326
 327 /* spi.c */
 328 int probe_spi(struct flashchip *flash);
 329 int it87xx_probe_spi_flash(const char *name);
 330 int generic_spi_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
 331 void generic_spi_write_enable();
 332 void generic_spi_write_disable();
 333 int generic_spi_chip_erase_c7(struct flashchip *flash);
 334 int generic_spi_chip_write(struct flashchip *flash, uint8_t *buf);
 335 int generic_spi_chip_read(struct flashchip *flash, uint8_t *buf);
 336
 337 /* 82802ab.c */
 338 int probe_82802ab(struct flashchip *flash);
 339 int erase_82802ab(struct flashchip *flash);
 340 int write_82802ab(struct flashchip *flash, uint8_t *buf);
 341
 342 /* am29f040b.c */
 343 int probe_29f040b(struct flashchip *flash);
 344 int erase_29f040b(struct flashchip *flash);
 345 int write_29f040b(struct flashchip *flash, uint8_t *buf);
 346
 347 /* jedec.c */
 348 void toggle_ready_jedec(volatile uint8_t *dst);
 349 void data_polling_jedec(volatile uint8_t *dst, uint8_t data);
 350 void unprotect_jedec(volatile uint8_t *bios);
 351 void protect_jedec(volatile uint8_t *bios);
 352 int write_byte_program_jedec(volatile uint8_t *bios, uint8_t *src,
 353                              volatile uint8_t *dst);
 354 int probe_jedec(struct flashchip *flash);
 355 int erase_chip_jedec(struct flashchip *flash);
 356 int write_jedec(struct flashchip *flash, uint8_t *buf);
 357 int erase_sector_jedec(volatile uint8_t *bios, unsigned int page);
 358 int erase_block_jedec(volatile uint8_t *bios, unsigned int page);
 359 int write_sector_jedec(volatile uint8_t *bios, uint8_t *src,
 360                        volatile uint8_t *dst, unsigned int page_size);
 361
 362 /* m29f400bt.c */
 363 int probe_m29f400bt(struct flashchip *flash);
 364 int erase_m29f400bt(struct flashchip *flash);
 365 int block_erase_m29f400bt(volatile uint8_t *bios,
 366                                  volatile uint8_t *dst);
 367 int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
 368 int write_coreboot_m29f400bt(struct flashchip *flash, uint8_t *buf);
 369 void toggle_ready_m29f400bt(volatile uint8_t *dst);
 370 void data_polling_m29f400bt(volatile uint8_t *dst, uint8_t data);
 371 void protect_m29f400bt(volatile uint8_t *bios);
 372 void write_page_m29f400bt(volatile uint8_t *bios, uint8_t *src,
 373                           volatile uint8_t *dst, int page_size);
 374
 375 /* mx29f002.c */
 376 int probe_29f002(struct flashchip *flash);
 377 int erase_29f002(struct flashchip *flash);
 378 int write_29f002(struct flashchip *flash, uint8_t *buf);
 379
 380 /* pm49fl004.c */
 381 int probe_49fl004(struct flashchip *flash);
 382 int erase_49fl004(struct flashchip *flash);
 383 int write_49fl004(struct flashchip *flash, uint8_t *buf);
 384
 385 /* sharplhf00l04.c */
 386 int probe_lhf00l04(struct flashchip *flash);
 387 int erase_lhf00l04(struct flashchip *flash);
 388 int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
 389 void toggle_ready_lhf00l04(volatile uint8_t *dst);
 390 void data_polling_lhf00l04(volatile uint8_t *dst, uint8_t data);
 391 void protect_lhf00l04(volatile uint8_t *bios);
 392
 393 /* sst28sf040.c */
 394 int probe_28sf040(struct flashchip *flash);
 395 int erase_28sf040(struct flashchip *flash);
 396 int write_28sf040(struct flashchip *flash, uint8_t *buf);
 397
 398 /* sst39sf020.c */
 399 int probe_39sf020(struct flashchip *flash);
 400 int write_39sf020(struct flashchip *flash, uint8_t *buf);
 401
 402 /* sst49lf040.c */
 403 int erase_49lf040(struct flashchip *flash);
 404 int write_49lf040(struct flashchip *flash, uint8_t *buf);
 405
 406 /* sst49lfxxxc.c */
 407 int probe_49lfxxxc(struct flashchip *flash);
 408 int erase_49lfxxxc(struct flashchip *flash);
 409 int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
 410
 411 /* sst_fwhub.c */
 412 int probe_sst_fwhub(struct flashchip *flash);
 413 int erase_sst_fwhub(struct flashchip *flash);
 414 int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
 415
 416 /* w29ee011.c */
 417 int probe_w29ee011(struct flashchip *flash);
 418
 419 /* w49f002u.c */
 420 int write_49f002(struct flashchip *flash, uint8_t *buf);
 421
 422 #endif                          /* !__FLASH_H__ */