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 struct flashchip {
  34         char *name;
  35         int manufacture_id;
  36         int model_id;
  37
  38         int total_size;
  39         int page_size;
  40
  41         int (*probe) (struct flashchip *flash);
  42         int (*erase) (struct flashchip *flash);
  43         int (*write) (struct flashchip *flash, uint8_t *buf);
  44         int (*read) (struct flashchip *flash, uint8_t *buf);
  45
  46         /* some flash devices have an additional
  47          * register space
  48          */
  49         volatile uint8_t *virtual_memory;
  50         volatile uint8_t *virtual_registers;
  51 };
  52
  53 extern struct flashchip flashchips[];
  54
  55 /* Please keep this list sorted alphabetically by manufacturer. The first
  56  * entry of each section should be the manufacturer ID, followed by the
  57  * list of devices from that manufacturer (sorted by device IDs).
  58  * All LPC/FWH parts (parallel flash) have 8-bit device IDs.
  59  * All SPI parts have 16-bit device IDs.
  60  */
  61
  62 #define AMD_ID                  0x01    /* AMD */
  63 #define AM_29F040B              0xA4
  64 #define AM_29F016D              0xAD
  65
  66 #define ASD_ID                  0x25    /* ASD */
  67 #define ASD_AE49F2008           0x52
  68
  69 #define ATMEL_ID                0x1F    /* Atmel */
  70 #define AT_29C040A              0xA4
  71 #define AT_29C020               0xDA
  72
  73 #define EON_ID                  0x1C
  74 /* EN25 chips are SPI, first byte of device id is memory type,
  75    second byte of device id is log(bitsize)-9 */
  76 #define EN_25B05                0x2010  /* 2^19 kbit or 2^16 kByte */
  77 #define EN_25B10                0x2011
  78 #define EN_25B20                0x2012
  79 #define EN_25B40                0x2013
  80 #define EN_25B80                0x2014
  81 #define EN_25B16                0x2015
  82 #define EN_25B32                0x2016
  83
  84 #define MX_ID                   0xC2    /* Macronix (MX) */
  85 #define MX_29F002               0xB0
  86 /* MX25L chips are SPI, first byte of device id is memory type,
  87    second byte of device id is log(bitsize)-9 */
  88 #define MX_25L512               0x2010  /* 2^19 kbit or 2^16 kByte */
  89 #define MX_25L1005              0x2011
  90 #define MX_25L2005              0x2012
  91 #define MX_25L4005              0x2013  /* MX25L4005{,A} */
  92 #define MX_25L8005              0x2014
  93 #define MX_25L1605              0x2015  /* MX25L1605{,A,D} */
  94 #define MX_25L3205              0x2016  /* MX25L3205{,A} */
  95 #define MX_25L6405              0x2017  /* MX25L3205{,D} */
  96 #define MX_25L1635D             0x2415
  97 #define MX_25L3235D             0x2416
  98
  99 #define SHARP_ID                0xB0    /* Sharp */
 100 #define SHARP_LHF00L04          0xCF
 101
 102 #define SST_ID                  0xBF    /* SST */
 103 #define SST_29EE020A            0x10
 104 #define SST_28SF040             0x04
 105 #define SST_39SF010             0xB5
 106 #define SST_39SF020             0xB6
 107 #define SST_39SF040             0xB7
 108 #define SST_39VF020             0xD6
 109 #define SST_49LF040B            0x50
 110 #define SST_49LF040             0x51
 111 #define SST_49LF020A            0x52
 112 #define SST_49LF080A            0x5B
 113 #define SST_49LF002A            0x57
 114 #define SST_49LF003A            0x1B
 115 #define SST_49LF004A            0x60
 116 #define SST_49LF008A            0x5A
 117 #define SST_49LF004C            0x54
 118 #define SST_49LF008C            0x59
 119 #define SST_49LF016C            0x5C
 120 #define SST_49LF160C            0x4C
 121
 122 #define PMC_ID                  0x9D    /* PMC */
 123 #define PMC_49FL002             0x6D
 124 #define PMC_49FL004             0x6E
 125
 126 #define WINBOND_ID              0xDA    /* Winbond */
 127 #define W_29C011                0xC1
 128 #define W_29C020C               0x45
 129 #define W_29C040P               0x46
 130 #define W_29EE011               0xC1
 131 #define W_39V040FA              0x34
 132 #define W_39V040A               0x3D
 133 #define W_39V040B               0x54
 134 #define W_39V080A               0xD0
 135 #define W_49F002U               0x0B
 136 #define W_49V002A               0xB0
 137 #define W_49V002FA              0x32
 138
 139 #define ST_ID                   0x20    /* ST */
 140 #define ST_M50FLW040A           0x08
 141 #define ST_M50FLW040B           0x28
 142 #define ST_M50FLW080A           0x80
 143 #define ST_M50FLW080B           0x81
 144 #define ST_M50FW040             0x2C
 145 #define ST_M50FW080             0x2D
 146 #define ST_M50FW016             0x2E
 147 #define ST_M50LPW116            0x30
 148 #define ST_M29F002B             0x34
 149 #define ST_M29F002T             0xB0    /* M29F002T / M29F002NT */
 150 #define ST_M29F400BT            0xD5
 151 #define ST_M29F040B             0xE2
 152 #define ST_M29W010B             0x23
 153 #define ST_M29W040B             0xE3
 154
 155 #define EMST_ID                 0x8c    /* EMST / EFST */
 156 #define EMST_F49B002UA          0x00
 157
 158 #define MSYSTEMS_ID             0x156f  /* M-Systems */
 159 #define MSYSTEMS_MD2200         0xdb    /* ? */
 160 #define MSYSTEMS_MD2800         0x30    /* hmm -- both 0x30 */
 161 #define MSYSTEMS_MD2802         0x30    /* hmm -- both 0x30 */
 162
 163 #define SYNCMOS_ID              0x40    /* SyncMOS */
 164 #define S29C51001T              0x01
 165 #define S29C51002T              0x02
 166 #define S29C51004T              0x03
 167 #define S29C31004T              0x63
 168
 169 /* function prototypes from udelay.h */
 170
 171 void myusec_delay(int time);
 172 void myusec_calibrate_delay();
 173
 174 /* pci handling for board/chipset_enable */
 175 struct pci_access *pacc;        /* For board and chipset_enable */
 176 struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
 177 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
 178                               uint16_t card_vendor, uint16_t card_device);
 179
 180 int board_flash_enable(char *vendor, char *part);       /* board_enable.c */
 181 int chipset_flash_enable(void); /* chipset_enable.c */
 182
 183 /* physical memory mapping device */
 184
 185 #if defined (__sun) && (defined(__i386) || defined(__amd64))
 186 #  define MEM_DEV "/dev/xsvc"
 187 #else
 188 #  define MEM_DEV "/dev/mem"
 189 #endif
 190
 191 extern int fd_mem;
 192
 193 /* debug.c */
 194 extern int verbose;
 195 #define printf_debug(x...) { if (verbose) printf(x); }
 196
 197 /* flashrom.c */
 198 int map_flash_registers(struct flashchip *flash);
 199
 200 /* layout.c */
 201 int show_id(uint8_t *bios, int size);
 202 int read_romlayout(char *name);
 203 int find_romentry(char *name);
 204 int handle_romentries(uint8_t *buffer, uint8_t *content);
 205
 206 /* lbtable.c */
 207 int linuxbios_init(void);
 208 extern char *lb_part, *lb_vendor;
 209
 210 /* spi.c */
 211 int probe_spi(struct flashchip *flash);
 212 int it87xx_probe_serial_flash(const char *name);
 213
 214 /* 82802ab.c */
 215 int probe_82802ab(struct flashchip *flash);
 216 int erase_82802ab(struct flashchip *flash);
 217 int write_82802ab(struct flashchip *flash, uint8_t *buf);
 218
 219 /* am29f040b.c */
 220 int probe_29f040b(struct flashchip *flash);
 221 int erase_29f040b(struct flashchip *flash);
 222 int write_29f040b(struct flashchip *flash, uint8_t *buf);
 223
 224 /* jedec.c */
 225 void toggle_ready_jedec(volatile uint8_t *dst);
 226 void data_polling_jedec(volatile uint8_t *dst, uint8_t data);
 227 void unprotect_jedec(volatile uint8_t *bios);
 228 void protect_jedec(volatile uint8_t *bios);
 229 int write_byte_program_jedec(volatile uint8_t *bios, uint8_t *src,
 230                              volatile uint8_t *dst);
 231 int probe_jedec(struct flashchip *flash);
 232 int erase_chip_jedec(struct flashchip *flash);
 233 int write_jedec(struct flashchip *flash, uint8_t *buf);
 234 int erase_sector_jedec(volatile uint8_t *bios, unsigned int page);
 235 int erase_block_jedec(volatile uint8_t *bios, unsigned int page);
 236 int write_sector_jedec(volatile uint8_t *bios, uint8_t *src,
 237                        volatile uint8_t *dst, unsigned int page_size);
 238
 239 /* m29f400bt.c */
 240 int probe_m29f400bt(struct flashchip *flash);
 241 int erase_m29f400bt(struct flashchip *flash);
 242 int block_erase_m29f400bt(volatile uint8_t *bios,
 243                                  volatile uint8_t *dst);
 244 int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
 245 int write_linuxbios_m29f400bt(struct flashchip *flash, uint8_t *buf);
 246 void toggle_ready_m29f400bt(volatile uint8_t *dst);
 247 void data_polling_m29f400bt(volatile uint8_t *dst, uint8_t data);
 248 void protect_m29f400bt(volatile uint8_t *bios);
 249 void write_page_m29f400bt(volatile uint8_t *bios, uint8_t *src,
 250                           volatile uint8_t *dst, int page_size);
 251
 252 /* mx29f002.c */
 253 int probe_29f002(struct flashchip *flash);
 254 int erase_29f002(struct flashchip *flash);
 255 int write_29f002(struct flashchip *flash, uint8_t *buf);
 256
 257 /* pm49fl004.c */
 258 int probe_49fl004(struct flashchip *flash);
 259 int erase_49fl004(struct flashchip *flash);
 260 int write_49fl004(struct flashchip *flash, uint8_t *buf);
 261
 262 /* sharplhf00l04.c */
 263 int probe_lhf00l04(struct flashchip *flash);
 264 int erase_lhf00l04(struct flashchip *flash);
 265 int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
 266 void toggle_ready_lhf00l04(volatile uint8_t *dst);
 267 void data_polling_lhf00l04(volatile uint8_t *dst, uint8_t data);
 268 void protect_lhf00l04(volatile uint8_t *bios);
 269
 270 /* sst28sf040.c */
 271 int probe_28sf040(struct flashchip *flash);
 272 int erase_28sf040(struct flashchip *flash);
 273 int write_28sf040(struct flashchip *flash, uint8_t *buf);
 274
 275 /* sst39sf020.c */
 276 int probe_39sf020(struct flashchip *flash);
 277 int write_39sf020(struct flashchip *flash, uint8_t *buf);
 278
 279 /* sst49lf040.c */
 280 int erase_49lf040(struct flashchip *flash);
 281 int write_49lf040(struct flashchip *flash, uint8_t *buf);
 282
 283 /* sst49lfxxxc.c */
 284 int probe_49lfxxxc(struct flashchip *flash);
 285 int erase_49lfxxxc(struct flashchip *flash);
 286 int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
 287
 288 /* sst_fwhub.c */
 289 int probe_sst_fwhub(struct flashchip *flash);
 290 int erase_sst_fwhub(struct flashchip *flash);
 291 int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
 292
 293 /* w29ee011.c */
 294 int probe_w29ee011(struct flashchip *flash);
 295
 296 /* w49f002u.c */
 297 int write_49f002(struct flashchip *flash, uint8_t *buf);
 298
 299 #endif                          /* !__FLASH_H__ */