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  */
  59
  60 #define AMD_ID                  0x01    /* AMD */
  61 #define AM_29F040B              0xA4
  62 #define AM_29F016D              0xAD
  63
  64 #define ASD_ID                  0x25    /* ASD */
  65 #define ASD_AE49F2008           0x52
  66
  67 #define ATMEL_ID                0x1F    /* Atmel */
  68 #define AT_29C040A              0xA4
  69 #define AT_29C020               0xDA
  70
  71 #define MX_ID                   0xC2    /* Macronix (MX) */
  72 #define MX_29F002               0xB0
  73
  74 #define SHARP_ID                0xB0    /* Sharp */
  75 #define SHARP_LHF00L04          0xCF
  76
  77 #define SST_ID                  0xBF    /* SST */
  78 #define SST_29EE020A            0x10
  79 #define SST_28SF040             0x04
  80 #define SST_39SF010             0xB5
  81 #define SST_39SF020             0xB6
  82 #define SST_39SF040             0xB7
  83 #define SST_39VF020             0xD6
  84 #define SST_49LF040B            0x50
  85 #define SST_49LF040             0x51
  86 #define SST_49LF020A            0x52
  87 #define SST_49LF080A            0x5B
  88 #define SST_49LF002A            0x57
  89 #define SST_49LF003A            0x1B
  90 #define SST_49LF004A            0x60
  91 #define SST_49LF008A            0x5A
  92 #define SST_49LF004C            0x54
  93 #define SST_49LF008C            0x59
  94 #define SST_49LF016C            0x5C
  95 #define SST_49LF160C            0x4C
  96
  97 #define PMC_ID                  0x9D    /* PMC */
  98 #define PMC_49FL002             0x6D
  99 #define PMC_49FL004             0x6E
 100
 101 #define WINBOND_ID              0xDA    /* Winbond */
 102 #define W_29C011                0xC1
 103 #define W_29C020C               0x45
 104 #define W_29C040P               0x46
 105 #define W_29EE011               0xC1
 106 #define W_39V040FA              0x34
 107 #define W_39V040A               0x3D
 108 #define W_39V040B               0x54
 109 #define W_39V080A               0xD0
 110 #define W_49F002U               0x0B
 111 #define W_49V002A               0xB0
 112 #define W_49V002FA              0x32
 113
 114 #define ST_ID                   0x20    /* ST */
 115 #define ST_M50FLW040A           0x08
 116 #define ST_M50FLW040B           0x28
 117 #define ST_M50FLW080A           0x80
 118 #define ST_M50FLW080B           0x81
 119 #define ST_M50FW040             0x2C
 120 #define ST_M50FW080             0x2D
 121 #define ST_M50FW016             0x2E
 122 #define ST_M50LPW116            0x30
 123 #define ST_M29F002B             0x34
 124 #define ST_M29F002T             0xB0    /* M29F002T / M29F002NT */
 125 #define ST_M29F400BT            0xD5
 126 #define ST_M29F040B             0xE2
 127 #define ST_M29W010B             0x23
 128 #define ST_M29W040B             0xE3
 129
 130 #define EMST_ID                 0x8c    /* EMST / EFST */
 131 #define EMST_F49B002UA          0x00
 132
 133 #define MSYSTEMS_ID             0x156f  /* M-Systems */
 134 #define MSYSTEMS_MD2200         0xdb    /* ? */
 135 #define MSYSTEMS_MD2800         0x30    /* hmm -- both 0x30 */
 136 #define MSYSTEMS_MD2802         0x30    /* hmm -- both 0x30 */
 137
 138 #define SYNCMOS_ID              0x40    /* SyncMOS */
 139 #define S29C51001T              0x01
 140 #define S29C51002T              0x02
 141 #define S29C51004T              0x03
 142 #define S29C31004T              0x63
 143
 144 /* function prototypes from udelay.h */
 145
 146 void myusec_delay(int time);
 147 void myusec_calibrate_delay();
 148
 149 /* pci handling for board/chipset_enable */
 150 struct pci_access *pacc;        /* For board and chipset_enable */
 151 struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
 152 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
 153                               uint16_t card_vendor, uint16_t card_device);
 154
 155 int board_flash_enable(char *vendor, char *part);       /* board_enable.c */
 156 int chipset_flash_enable(void); /* chipset_enable.c */
 157
 158 /* physical memory mapping device */
 159
 160 #if defined (__sun) && (defined(__i386) || defined(__amd64))
 161 #  define MEM_DEV "/dev/xsvc"
 162 #else
 163 #  define MEM_DEV "/dev/mem"
 164 #endif
 165
 166 extern int fd_mem;
 167
 168 /* debug.c */
 169 extern int verbose;
 170 #define printf_debug(x...) { if (verbose) printf(x); }
 171
 172 /* flashrom.c */
 173 int map_flash_registers(struct flashchip *flash);
 174
 175 /* layout.c */
 176 int show_id(uint8_t *bios, int size);
 177 int read_romlayout(char *name);
 178 int find_romentry(char *name);
 179 int handle_romentries(uint8_t *buffer, uint8_t *content);
 180
 181 /* lbtable.c */
 182 int linuxbios_init(void);
 183 extern char *lb_part, *lb_vendor;
 184
 185 /* 82802ab.c */
 186 int probe_82802ab(struct flashchip *flash);
 187 int erase_82802ab(struct flashchip *flash);
 188 int write_82802ab(struct flashchip *flash, uint8_t *buf);
 189
 190 /* am29f040b.c */
 191 int probe_29f040b(struct flashchip *flash);
 192 int erase_29f040b(struct flashchip *flash);
 193 int write_29f040b(struct flashchip *flash, uint8_t *buf);
 194
 195 /* jedec.c */
 196 void toggle_ready_jedec(volatile uint8_t *dst);
 197 void data_polling_jedec(volatile uint8_t *dst, uint8_t data);
 198 void unprotect_jedec(volatile uint8_t *bios);
 199 void protect_jedec(volatile uint8_t *bios);
 200 int write_byte_program_jedec(volatile uint8_t *bios, uint8_t *src,
 201                              volatile uint8_t *dst);
 202 int probe_jedec(struct flashchip *flash);
 203 int erase_chip_jedec(struct flashchip *flash);
 204 int write_jedec(struct flashchip *flash, uint8_t *buf);
 205 int erase_sector_jedec(volatile uint8_t *bios, unsigned int page);
 206 int erase_block_jedec(volatile uint8_t *bios, unsigned int page);
 207 int write_sector_jedec(volatile uint8_t *bios, uint8_t *src,
 208                        volatile uint8_t *dst, unsigned int page_size);
 209
 210 /* m29f400bt.c */
 211 int probe_m29f400bt(struct flashchip *flash);
 212 int erase_m29f400bt(struct flashchip *flash);
 213 int block_erase_m29f400bt(volatile uint8_t *bios,
 214                                  volatile uint8_t *dst);
 215 int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
 216 int write_linuxbios_m29f400bt(struct flashchip *flash, uint8_t *buf);
 217 void toggle_ready_m29f400bt(volatile uint8_t *dst);
 218 void data_polling_m29f400bt(volatile uint8_t *dst, uint8_t data);
 219 void protect_m29f400bt(volatile uint8_t *bios);
 220 void write_page_m29f400bt(volatile uint8_t *bios, uint8_t *src,
 221                           volatile uint8_t *dst, int page_size);
 222
 223 /* mx29f002.c */
 224 int probe_29f002(struct flashchip *flash);
 225 int erase_29f002(struct flashchip *flash);
 226 int write_29f002(struct flashchip *flash, uint8_t *buf);
 227
 228 /* pm49fl004.c */
 229 int probe_49fl004(struct flashchip *flash);
 230 int erase_49fl004(struct flashchip *flash);
 231 int write_49fl004(struct flashchip *flash, uint8_t *buf);
 232
 233 /* sharplhf00l04.c */
 234 int probe_lhf00l04(struct flashchip *flash);
 235 int erase_lhf00l04(struct flashchip *flash);
 236 int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
 237 void toggle_ready_lhf00l04(volatile uint8_t *dst);
 238 void data_polling_lhf00l04(volatile uint8_t *dst, uint8_t data);
 239 void protect_lhf00l04(volatile uint8_t *bios);
 240
 241 /* sst28sf040.c */
 242 int probe_28sf040(struct flashchip *flash);
 243 int erase_28sf040(struct flashchip *flash);
 244 int write_28sf040(struct flashchip *flash, uint8_t *buf);
 245
 246 /* sst39sf020.c */
 247 int probe_39sf020(struct flashchip *flash);
 248 int write_39sf020(struct flashchip *flash, uint8_t *buf);
 249
 250 /* sst49lf040.c */
 251 int erase_49lf040(struct flashchip *flash);
 252 int write_49lf040(struct flashchip *flash, uint8_t *buf);
 253
 254 /* sst49lfxxxc.c */
 255 int probe_49lfxxxc(struct flashchip *flash);
 256 int erase_49lfxxxc(struct flashchip *flash);
 257 int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
 258
 259 /* sst_fwhub.c */
 260 int probe_sst_fwhub(struct flashchip *flash);
 261 int erase_sst_fwhub(struct flashchip *flash);
 262 int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
 263
 264 /* w29ee011.c */
 265 int probe_w29ee011(struct flashchip *flash);
 266
 267 /* w49f002u.c */
 268 int write_49f002(struct flashchip *flash, uint8_t *buf);
 269
 270 #endif                          /* !__FLASH_H__ */