blob: ec28064f53f5b79caa0dcd5dadf8d4d9ed724fce [file] [log] [blame]
Adam Kaufman064b1f22007-02-06 19:47:50 +00001/*
Uwe Hermannd1107642007-08-29 17:52:32 +00002 * This file is part of the flashrom project.
Adam Kaufman064b1f22007-02-06 19:47:50 +00003 *
Uwe Hermannd22a1d42007-09-09 20:21:05 +00004 * 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>
Adam Kaufman064b1f22007-02-06 19:47:50 +00007 *
Uwe Hermannd1107642007-08-29 17:52:32 +00008 * 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.
Adam Kaufman064b1f22007-02-06 19:47:50 +000012 *
Uwe Hermannd1107642007-08-29 17:52:32 +000013 * 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.
Adam Kaufman064b1f22007-02-06 19:47:50 +000017 *
Uwe Hermannd1107642007-08-29 17:52:32 +000018 * 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
Adam Kaufman064b1f22007-02-06 19:47:50 +000021 */
22
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000023#ifndef __FLASH_H__
24#define __FLASH_H__ 1
25
Adam Kaufman064b1f22007-02-06 19:47:50 +000026#if defined(__GLIBC__)
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000027#include <sys/io.h>
Adam Kaufman064b1f22007-02-06 19:47:50 +000028#endif
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000029#include <unistd.h>
Ollie Lho184a4042005-11-26 21:55:36 +000030#include <stdint.h>
Uwe Hermann0846f892007-08-23 13:34:59 +000031#include <stdio.h>
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000032
33struct flashchip {
Uwe Hermann372eeb52007-12-04 21:49:06 +000034 const char *name;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000035 int manufacture_id;
36 int model_id;
37
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000038 int total_size;
39 int page_size;
40
Uwe Hermann0b7afe62007-04-01 19:44:21 +000041 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);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000045
Uwe Hermann372eeb52007-12-04 21:49:06 +000046 /* Some flash devices have an additional register space. */
Stefan Reinauerce532972007-05-23 17:20:56 +000047 volatile uint8_t *virtual_memory;
48 volatile uint8_t *virtual_registers;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000049};
50
Ollie Lho184a4042005-11-26 21:55:36 +000051extern struct flashchip flashchips[];
52
Uwe Hermann372eeb52007-12-04 21:49:06 +000053/*
54 * Please keep this list sorted alphabetically by manufacturer. The first
Uwe Hermannaf2b52d2007-04-01 20:00:32 +000055 * entry of each section should be the manufacturer ID, followed by the
56 * list of devices from that manufacturer (sorted by device IDs).
Uwe Hermann372eeb52007-12-04 21:49:06 +000057 *
Carl-Daniel Hailfingere1514992007-10-02 15:49:25 +000058 * All LPC/FWH parts (parallel flash) have 8-bit device IDs.
59 * All SPI parts have 16-bit device IDs.
Uwe Hermannaf2b52d2007-04-01 20:00:32 +000060 */
61
Peter Lemenkov539478d2007-10-22 20:36:16 +000062#define ALLIANCE_ID 0x52 /* Alliance */
63
Uwe Hermannaf2b52d2007-04-01 20:00:32 +000064#define AMD_ID 0x01 /* AMD */
Uwe Hermann0b7afe62007-04-01 19:44:21 +000065#define AM_29F040B 0xA4
Peter Lemenkov220e26b2007-10-25 04:11:11 +000066#define AM_29LV040B 0x4F
Uwe Hermann0b7afe62007-04-01 19:44:21 +000067#define AM_29F016D 0xAD
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000068
Peter Lemenkov539478d2007-10-22 20:36:16 +000069#define AMIC_ID 0x37 /* AMIC */
70
Uwe Hermannaf2b52d2007-04-01 20:00:32 +000071#define ASD_ID 0x25 /* ASD */
Uwe Hermann0b7afe62007-04-01 19:44:21 +000072#define ASD_AE49F2008 0x52
Stefan Reinaueref54aba2006-11-21 23:51:08 +000073
Uwe Hermannaf2b52d2007-04-01 20:00:32 +000074#define ATMEL_ID 0x1F /* Atmel */
75#define AT_29C040A 0xA4
Uwe Hermannd7f48062007-04-28 02:22:59 +000076#define AT_29C020 0xDA
Frederico Silva4bcf1752007-12-10 16:57:59 +000077#define AT_49F002N 0x07 /* for AT49F002(N) */
78#define AT_49F002NT 0x08 /* for AT49F002(N)T */
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000079
Peter Lemenkov539478d2007-10-22 20:36:16 +000080#define CATALYST_ID 0x31 /* Catalyst */
81
82#define EMST_ID 0x8C /* EMST / EFST */
83#define EMST_F49B002UA 0x00
84
Uwe Hermann372eeb52007-12-04 21:49:06 +000085/*
86 * EN25 chips are SPI, first byte of device ID is memory type,
87 * second byte of device ID is log(bitsize)-9.
88 */
Peter Lemenkov539478d2007-10-22 20:36:16 +000089#define EON_ID 0x1C /* EON */
Carl-Daniel Hailfingere1514992007-10-02 15:49:25 +000090#define EN_25B05 0x2010 /* 2^19 kbit or 2^16 kByte */
91#define EN_25B10 0x2011
92#define EN_25B20 0x2012
93#define EN_25B40 0x2013
94#define EN_25B80 0x2014
95#define EN_25B16 0x2015
96#define EN_25B32 0x2016
97
Peter Lemenkov539478d2007-10-22 20:36:16 +000098#define FUJITSU_ID 0x04 /* Fujitsu */
Uwe Hermann97a64702007-10-30 00:56:50 +000099#define MBM29F400TC 0x23
Peter Lemenkov539478d2007-10-22 20:36:16 +0000100
101#define HYUNDAI_ID 0xAD /* Hyundai */
102
103#define IMT_ID 0x7F /* IMT */
104
105#define INTEL_ID 0x89 /* Intel */
106
107#define ISSI_ID 0xD5 /* ISSI */
108
109#define MSYSTEMS_ID 0x156F /* M-Systems */
Uwe Hermann372eeb52007-12-04 21:49:06 +0000110#define MSYSTEMS_MD2200 0xDB
Peter Lemenkov539478d2007-10-22 20:36:16 +0000111#define MSYSTEMS_MD2800 0x30 /* hmm -- both 0x30 */
112#define MSYSTEMS_MD2802 0x30 /* hmm -- both 0x30 */
113
Uwe Hermann372eeb52007-12-04 21:49:06 +0000114/*
115 * MX25 chips are SPI, first byte of device ID is memory type,
116 * second byte of device ID is log(bitsize)-9.
117 */
Uwe Hermannaf2b52d2007-04-01 20:00:32 +0000118#define MX_ID 0xC2 /* Macronix (MX) */
Carl-Daniel Hailfingere1514992007-10-02 15:49:25 +0000119#define MX_25L512 0x2010 /* 2^19 kbit or 2^16 kByte */
120#define MX_25L1005 0x2011
121#define MX_25L2005 0x2012
122#define MX_25L4005 0x2013 /* MX25L4005{,A} */
123#define MX_25L8005 0x2014
124#define MX_25L1605 0x2015 /* MX25L1605{,A,D} */
125#define MX_25L3205 0x2016 /* MX25L3205{,A} */
126#define MX_25L6405 0x2017 /* MX25L3205{,D} */
127#define MX_25L1635D 0x2415
128#define MX_25L3235D 0x2416
Carl-Daniel Hailfinger5b1c6ed2007-10-22 16:15:28 +0000129#define MX_29F002 0xB0
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000130
Peter Lemenkov539478d2007-10-22 20:36:16 +0000131#define PMC_ID 0x9D /* PMC */
132#define PMC_49FL002 0x6D
133#define PMC_49FL004 0x6E
134
Uwe Hermannaf2b52d2007-04-01 20:00:32 +0000135#define SHARP_ID 0xB0 /* Sharp */
Uwe Hermann0b7afe62007-04-01 19:44:21 +0000136#define SHARP_LHF00L04 0xCF
Ronald G. Minnich5b582f22006-02-23 17:16:44 +0000137
Uwe Hermann372eeb52007-12-04 21:49:06 +0000138/*
139 * SST25 chips are SPI, first byte of device ID is memory type, second
140 * byte of device ID is related to log(bitsize) at least for some chips.
141 */
Uwe Hermannaf2b52d2007-04-01 20:00:32 +0000142#define SST_ID 0xBF /* SST */
Carl-Daniel Hailfinger5b1c6ed2007-10-22 16:15:28 +0000143#define SST_25WF512 0x2501
144#define SST_25WF010 0x2502
145#define SST_25WF020 0x2503
146#define SST_25WF040 0x2504
147#define SST_25VF016B 0x2541
148#define SST_25VF032B 0x254A
149#define SST_25VF040B 0x258D
150#define SST_25VF080B 0x258E
Uwe Hermannaf2b52d2007-04-01 20:00:32 +0000151#define SST_29EE020A 0x10
152#define SST_28SF040 0x04
153#define SST_39SF010 0xB5
154#define SST_39SF020 0xB6
155#define SST_39SF040 0xB7
156#define SST_39VF020 0xD6
157#define SST_49LF040B 0x50
158#define SST_49LF040 0x51
159#define SST_49LF020A 0x52
160#define SST_49LF080A 0x5B
161#define SST_49LF002A 0x57
162#define SST_49LF003A 0x1B
163#define SST_49LF004A 0x60
164#define SST_49LF008A 0x5A
165#define SST_49LF004C 0x54
166#define SST_49LF008C 0x59
167#define SST_49LF016C 0x5C
168#define SST_49LF160C 0x4C
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000169
Carl-Daniel Hailfingerf5df46f2007-12-16 21:15:27 +0000170/*
171 * ST25P chips are SPI, first byte of device ID is memory type, second
172 * byte of device ID is related to log(bitsize) at least for some chips.
173 */
Uwe Hermannaf2b52d2007-04-01 20:00:32 +0000174#define ST_ID 0x20 /* ST */
Carl-Daniel Hailfingerd8cc58c2007-12-17 22:22:40 +0000175#define ST_M25P05A 0x2010
176#define ST_M25P10A 0x2011
177#define ST_M25P20 0x2012
178#define ST_M25P40 0x2013
Carl-Daniel Hailfingerf5df46f2007-12-16 21:15:27 +0000179#define ST_M25P80 0x2014
Carl-Daniel Hailfingerd8cc58c2007-12-17 22:22:40 +0000180#define ST_M25P16 0x2015
181#define ST_M25P32 0x2016
182#define ST_M25P64 0x2017
183#define ST_M25P128 0x2018
Carl-Daniel Hailfingerf41c66f2007-07-25 17:55:45 +0000184#define ST_M50FLW040A 0x08
185#define ST_M50FLW040B 0x28
186#define ST_M50FLW080A 0x80
187#define ST_M50FLW080B 0x81
Carl-Daniel Hailfingere087fa22007-07-24 18:18:05 +0000188#define ST_M50FW040 0x2C
Carl-Daniel Hailfingerf41c66f2007-07-25 17:55:45 +0000189#define ST_M50FW080 0x2D
190#define ST_M50FW016 0x2E
191#define ST_M50LPW116 0x30
Uwe Hermannd7f48062007-04-28 02:22:59 +0000192#define ST_M29F002B 0x34
193#define ST_M29F002T 0xB0 /* M29F002T / M29F002NT */
Uwe Hermann0b7afe62007-04-01 19:44:21 +0000194#define ST_M29F400BT 0xD5
Uwe Hermannd7f48062007-04-28 02:22:59 +0000195#define ST_M29F040B 0xE2
Carl-Daniel Hailfingerf41c66f2007-07-25 17:55:45 +0000196#define ST_M29W010B 0x23
Carl-Daniel Hailfingere087fa22007-07-24 18:18:05 +0000197#define ST_M29W040B 0xE3
Ronald G. Minnich3c910ed2002-05-28 23:29:17 +0000198
Peter Lemenkov539478d2007-10-22 20:36:16 +0000199#define SYNCMOS_ID 0x40 /* SyncMOS and Mosel Vitelic */
Uwe Hermannaf2b52d2007-04-01 20:00:32 +0000200#define S29C51001T 0x01
201#define S29C51002T 0x02
202#define S29C51004T 0x03
203#define S29C31004T 0x63
Giampiero Giancipolia8c80822006-11-20 20:03:07 +0000204
Peter Lemenkov539478d2007-10-22 20:36:16 +0000205#define TI_ID 0x97 /* Texas Instruments */
206
207#define WINBOND_ID 0xDA /* Winbond */
208#define W_29C011 0xC1
209#define W_29C020C 0x45
210#define W_29C040P 0x46
211#define W_29EE011 0xC1
212#define W_39V040FA 0x34
213#define W_39V040A 0x3D
214#define W_39V040B 0x54
215#define W_39V080A 0xD0
216#define W_49F002U 0x0B
217#define W_49V002A 0xB0
218#define W_49V002FA 0x32
219
Uwe Hermann372eeb52007-12-04 21:49:06 +0000220/* udelay.c */
Stefan Reinauer70385642007-04-06 11:58:03 +0000221void myusec_delay(int time);
222void myusec_calibrate_delay();
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000223
Uwe Hermann372eeb52007-12-04 21:49:06 +0000224/* PCI handling for board/chipset_enable */
225struct pci_access *pacc;
Stefan Reinauer70385642007-04-06 11:58:03 +0000226struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
Uwe Hermanna7e05482007-05-09 10:17:44 +0000227struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
228 uint16_t card_vendor, uint16_t card_device);
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000229
Uwe Hermann372eeb52007-12-04 21:49:06 +0000230/* board_enable.c */
231int board_flash_enable(const char *vendor, const char *part);
Adam Kaufman064b1f22007-02-06 19:47:50 +0000232
Uwe Hermann372eeb52007-12-04 21:49:06 +0000233/* chipset_enable.c */
234int chipset_flash_enable(void);
Adam Kaufman064b1f22007-02-06 19:47:50 +0000235
Uwe Hermann372eeb52007-12-04 21:49:06 +0000236/* Physical memory mapping device */
Adam Kaufman064b1f22007-02-06 19:47:50 +0000237#if defined (__sun) && (defined(__i386) || defined(__amd64))
238# define MEM_DEV "/dev/xsvc"
239#else
240# define MEM_DEV "/dev/mem"
241#endif
242
Stefan Reinauer70385642007-04-06 11:58:03 +0000243extern int fd_mem;
244
Uwe Hermann0846f892007-08-23 13:34:59 +0000245/* debug.c */
246extern int verbose;
247#define printf_debug(x...) { if (verbose) printf(x); }
248
249/* flashrom.c */
250int map_flash_registers(struct flashchip *flash);
251
252/* layout.c */
253int show_id(uint8_t *bios, int size);
254int read_romlayout(char *name);
255int find_romentry(char *name);
256int handle_romentries(uint8_t *buffer, uint8_t *content);
257
258/* lbtable.c */
259int linuxbios_init(void);
260extern char *lb_part, *lb_vendor;
261
Carl-Daniel Hailfinger00f911e2007-10-15 21:44:47 +0000262/* spi.c */
Carl-Daniel Hailfingere1514992007-10-02 15:49:25 +0000263int probe_spi(struct flashchip *flash);
Carl-Daniel Hailfinger3d94a0e2007-10-16 21:09:06 +0000264int it87xx_probe_spi_flash(const char *name);
Carl-Daniel Hailfinger5b1c6ed2007-10-22 16:15:28 +0000265int generic_spi_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfinger6b444962007-10-18 00:24:07 +0000266void generic_spi_write_enable();
267void generic_spi_write_disable();
Carl-Daniel Hailfinger21c78902007-12-17 14:33:32 +0000268int generic_spi_chip_erase_c7(struct flashchip *flash);
Carl-Daniel Hailfinger6b444962007-10-18 00:24:07 +0000269int generic_spi_chip_write(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfingere1514992007-10-02 15:49:25 +0000270
Uwe Hermann0846f892007-08-23 13:34:59 +0000271/* 82802ab.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000272int probe_82802ab(struct flashchip *flash);
273int erase_82802ab(struct flashchip *flash);
274int write_82802ab(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000275
276/* am29f040b.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000277int probe_29f040b(struct flashchip *flash);
278int erase_29f040b(struct flashchip *flash);
279int write_29f040b(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000280
281/* jedec.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000282void toggle_ready_jedec(volatile uint8_t *dst);
283void data_polling_jedec(volatile uint8_t *dst, uint8_t data);
284void unprotect_jedec(volatile uint8_t *bios);
285void protect_jedec(volatile uint8_t *bios);
Uwe Hermann0846f892007-08-23 13:34:59 +0000286int write_byte_program_jedec(volatile uint8_t *bios, uint8_t *src,
287 volatile uint8_t *dst);
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000288int probe_jedec(struct flashchip *flash);
289int erase_chip_jedec(struct flashchip *flash);
290int write_jedec(struct flashchip *flash, uint8_t *buf);
291int erase_sector_jedec(volatile uint8_t *bios, unsigned int page);
292int erase_block_jedec(volatile uint8_t *bios, unsigned int page);
293int write_sector_jedec(volatile uint8_t *bios, uint8_t *src,
294 volatile uint8_t *dst, unsigned int page_size);
Uwe Hermann0846f892007-08-23 13:34:59 +0000295
296/* m29f400bt.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000297int probe_m29f400bt(struct flashchip *flash);
298int erase_m29f400bt(struct flashchip *flash);
299int block_erase_m29f400bt(volatile uint8_t *bios,
Uwe Hermann0846f892007-08-23 13:34:59 +0000300 volatile uint8_t *dst);
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000301int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
302int write_linuxbios_m29f400bt(struct flashchip *flash, uint8_t *buf);
303void toggle_ready_m29f400bt(volatile uint8_t *dst);
304void data_polling_m29f400bt(volatile uint8_t *dst, uint8_t data);
305void protect_m29f400bt(volatile uint8_t *bios);
306void write_page_m29f400bt(volatile uint8_t *bios, uint8_t *src,
307 volatile uint8_t *dst, int page_size);
Uwe Hermann0846f892007-08-23 13:34:59 +0000308
309/* mx29f002.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000310int probe_29f002(struct flashchip *flash);
311int erase_29f002(struct flashchip *flash);
312int write_29f002(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000313
314/* pm49fl004.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000315int probe_49fl004(struct flashchip *flash);
316int erase_49fl004(struct flashchip *flash);
317int write_49fl004(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000318
319/* sharplhf00l04.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000320int probe_lhf00l04(struct flashchip *flash);
321int erase_lhf00l04(struct flashchip *flash);
322int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
323void toggle_ready_lhf00l04(volatile uint8_t *dst);
324void data_polling_lhf00l04(volatile uint8_t *dst, uint8_t data);
325void protect_lhf00l04(volatile uint8_t *bios);
Uwe Hermann0846f892007-08-23 13:34:59 +0000326
327/* sst28sf040.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000328int probe_28sf040(struct flashchip *flash);
329int erase_28sf040(struct flashchip *flash);
330int write_28sf040(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000331
332/* sst39sf020.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000333int probe_39sf020(struct flashchip *flash);
334int write_39sf020(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000335
336/* sst49lf040.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000337int erase_49lf040(struct flashchip *flash);
338int write_49lf040(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000339
340/* sst49lfxxxc.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000341int probe_49lfxxxc(struct flashchip *flash);
342int erase_49lfxxxc(struct flashchip *flash);
343int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000344
345/* sst_fwhub.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000346int probe_sst_fwhub(struct flashchip *flash);
347int erase_sst_fwhub(struct flashchip *flash);
348int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000349
Markus Boasd2ac6fc2007-08-30 10:17:50 +0000350/* w29ee011.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000351int probe_w29ee011(struct flashchip *flash);
Markus Boasd2ac6fc2007-08-30 10:17:50 +0000352
Uwe Hermann0846f892007-08-23 13:34:59 +0000353/* w49f002u.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000354int write_49f002(struct flashchip *flash, uint8_t *buf);
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000355
Ollie Lho761bf1b2004-03-20 16:46:10 +0000356#endif /* !__FLASH_H__ */