blob: 13564e18f51d69645df966ce06111dd4d8fbe476 [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>
Stefan Reinauer8fa64812009-08-12 09:27:45 +00006 * Copyright (C) 2005-2009 coresystems GmbH
Carl-Daniel Hailfingera0a6ae92009-06-15 12:10:57 +00007 * Copyright (C) 2006-2009 Carl-Daniel Hailfinger
Adam Kaufman064b1f22007-02-06 19:47:50 +00008 *
Uwe Hermannd1107642007-08-29 17:52:32 +00009 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
Adam Kaufman064b1f22007-02-06 19:47:50 +000013 *
Uwe Hermannd1107642007-08-29 17:52:32 +000014 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
Adam Kaufman064b1f22007-02-06 19:47:50 +000018 *
Uwe Hermannd1107642007-08-29 17:52:32 +000019 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Adam Kaufman064b1f22007-02-06 19:47:50 +000022 */
23
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000024#ifndef __FLASH_H__
25#define __FLASH_H__ 1
26
Adam Kaufman064b1f22007-02-06 19:47:50 +000027#if defined(__GLIBC__)
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000028#include <sys/io.h>
Adam Kaufman064b1f22007-02-06 19:47:50 +000029#endif
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000030#include <unistd.h>
Ollie Lho184a4042005-11-26 21:55:36 +000031#include <stdint.h>
Uwe Hermann0846f892007-08-23 13:34:59 +000032#include <stdio.h>
Christian Ruppert0cdb0312009-05-14 18:57:26 +000033#include <pci/pci.h>
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000034
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000035/* for iopl and outb under Solaris */
36#if defined (__sun) && (defined(__i386) || defined(__amd64))
37#include <strings.h>
38#include <sys/sysi86.h>
39#include <sys/psw.h>
40#include <asm/sunddi.h>
41#endif
42
Stefan Reinauerf79edb92009-01-26 01:23:31 +000043#if (defined(__MACH__) && defined(__APPLE__))
44#define __DARWIN__
45#endif
46
Patrick Georgi60622e22009-04-28 12:56:04 +000047#if defined(__FreeBSD__) || defined(__DragonFly__)
Andriy Gapon65c1b862008-05-22 13:22:45 +000048 #include <machine/cpufunc.h>
49 #define off64_t off_t
50 #define lseek64 lseek
51 #define OUTB(x, y) do { u_int tmp = (y); outb(tmp, (x)); } while (0)
52 #define OUTW(x, y) do { u_int tmp = (y); outw(tmp, (x)); } while (0)
53 #define OUTL(x, y) do { u_int tmp = (y); outl(tmp, (x)); } while (0)
54 #define INB(x) __extension__ ({ u_int tmp = (x); inb(tmp); })
55 #define INW(x) __extension__ ({ u_int tmp = (x); inw(tmp); })
56 #define INL(x) __extension__ ({ u_int tmp = (x); inl(tmp); })
57#else
Stefan Reinauerf79edb92009-01-26 01:23:31 +000058#if defined(__DARWIN__)
59 #include <DirectIO/darwinio.h>
60 #define off64_t off_t
61 #define lseek64 lseek
62#endif
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000063#if defined (__sun) && (defined(__i386) || defined(__amd64))
64 /* Note different order for outb */
65 #define OUTB(x,y) outb(y, x)
66 #define OUTW(x,y) outw(y, x)
67 #define OUTL(x,y) outl(y, x)
68 #define INB inb
69 #define INW inw
70 #define INL inl
71#else
Andriy Gapon65c1b862008-05-22 13:22:45 +000072 #define OUTB outb
73 #define OUTW outw
74 #define OUTL outl
75 #define INB inb
76 #define INW inw
77 #define INL inl
78#endif
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000079#endif
Andriy Gapon65c1b862008-05-22 13:22:45 +000080
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +000081typedef unsigned long chipaddr;
82
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +000083enum programmer {
84 PROGRAMMER_INTERNAL,
85 PROGRAMMER_DUMMY,
86 PROGRAMMER_NIC3COM,
87 PROGRAMMER_SATASII,
88 PROGRAMMER_IT87SPI,
89 PROGRAMMER_FT2232SPI,
Carl-Daniel Hailfinger6be74112009-08-12 16:17:41 +000090#if SERPROG_SUPPORT == 1
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +000091 PROGRAMMER_SERPROG,
Carl-Daniel Hailfinger6be74112009-08-12 16:17:41 +000092#endif
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000093 PROGRAMMER_INVALID /* This must always be the last entry. */
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +000094};
95
96extern enum programmer programmer;
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000097
98struct programmer_entry {
99 const char *vendor;
100 const char *name;
101
102 int (*init) (void);
103 int (*shutdown) (void);
104
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000105 void * (*map_flash_region) (const char *descr, unsigned long phys_addr,
106 size_t len);
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000107 void (*unmap_flash_region) (void *virt_addr, size_t len);
108
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000109 void (*chip_writeb) (uint8_t val, chipaddr addr);
110 void (*chip_writew) (uint16_t val, chipaddr addr);
111 void (*chip_writel) (uint32_t val, chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000112 void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000113 uint8_t (*chip_readb) (const chipaddr addr);
114 uint16_t (*chip_readw) (const chipaddr addr);
115 uint32_t (*chip_readl) (const chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000116 void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000117 void (*delay) (int usecs);
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000118};
119
120extern const struct programmer_entry programmer_table[];
121
Uwe Hermann09e04f72009-05-16 22:36:00 +0000122int programmer_init(void);
123int programmer_shutdown(void);
124void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
125 size_t len);
126void programmer_unmap_flash_region(void *virt_addr, size_t len);
127void chip_writeb(uint8_t val, chipaddr addr);
128void chip_writew(uint16_t val, chipaddr addr);
129void chip_writel(uint32_t val, chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000130void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000131uint8_t chip_readb(const chipaddr addr);
132uint16_t chip_readw(const chipaddr addr);
133uint32_t chip_readl(const chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000134void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000135void programmer_delay(int usecs);
Carl-Daniel Hailfinger61a8bd22009-03-05 19:24:22 +0000136
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000137#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
138
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000139enum chipbustype {
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000140 CHIP_BUSTYPE_NONE = 0,
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000141 CHIP_BUSTYPE_PARALLEL = 1 << 0,
142 CHIP_BUSTYPE_LPC = 1 << 1,
143 CHIP_BUSTYPE_FWH = 1 << 2,
144 CHIP_BUSTYPE_SPI = 1 << 3,
145 CHIP_BUSTYPE_NONSPI = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH,
146 CHIP_BUSTYPE_UNKNOWN = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH | CHIP_BUSTYPE_SPI,
147};
148
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000149struct flashchip {
Uwe Hermann76158682008-03-14 23:55:58 +0000150 const char *vendor;
Uwe Hermann372eeb52007-12-04 21:49:06 +0000151 const char *name;
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000152
153 enum chipbustype bustype;
154
Uwe Hermann394131e2008-10-18 21:14:13 +0000155 /*
156 * With 32bit manufacture_id and model_id we can cover IDs up to
Carl-Daniel Hailfingerae8afa92007-12-31 01:49:00 +0000157 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
158 * Identification code.
159 */
160 uint32_t manufacture_id;
161 uint32_t model_id;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000162
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000163 int total_size;
164 int page_size;
165
Uwe Hermann394131e2008-10-18 21:14:13 +0000166 /*
167 * Indicate if flashrom has been tested with this flash chip and if
Peter Stuge1159d582008-05-03 04:34:37 +0000168 * everything worked correctly.
169 */
170 uint32_t tested;
171
Uwe Hermann0b7afe62007-04-01 19:44:21 +0000172 int (*probe) (struct flashchip *flash);
Maciej Pijankac6e11112009-06-03 14:46:22 +0000173
174 /* Delay after "enter/exit ID mode" commands in microseconds. */
175 int probe_timing;
Uwe Hermann0b7afe62007-04-01 19:44:21 +0000176 int (*erase) (struct flashchip *flash);
177 int (*write) (struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000178 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000179
Uwe Hermann372eeb52007-12-04 21:49:06 +0000180 /* Some flash devices have an additional register space. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000181 chipaddr virtual_memory;
182 chipaddr virtual_registers;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000183};
184
Peter Stuge1159d582008-05-03 04:34:37 +0000185#define TEST_UNTESTED 0
186
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000187#define TEST_OK_PROBE (1 << 0)
188#define TEST_OK_READ (1 << 1)
189#define TEST_OK_ERASE (1 << 2)
190#define TEST_OK_WRITE (1 << 3)
191#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
192#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
193#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000194#define TEST_OK_MASK 0x0f
195
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000196#define TEST_BAD_PROBE (1 << 4)
197#define TEST_BAD_READ (1 << 5)
198#define TEST_BAD_ERASE (1 << 6)
199#define TEST_BAD_WRITE (1 << 7)
200#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000201#define TEST_BAD_MASK 0xf0
202
Maciej Pijankac6e11112009-06-03 14:46:22 +0000203/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
204 * field and zero delay.
205 *
206 * SPI devices will always have zero delay and ignore this field.
207 */
208#define TIMING_FIXME -1
209/* this is intentionally same value as fixme */
210#define TIMING_IGNORED -1
211#define TIMING_ZERO -2
212
Ollie Lho184a4042005-11-26 21:55:36 +0000213extern struct flashchip flashchips[];
214
Uwe Hermann05fab752009-05-16 23:42:17 +0000215struct penable {
216 uint16_t vendor_id;
217 uint16_t device_id;
218 int status;
219 const char *vendor_name;
220 const char *device_name;
221 int (*doit) (struct pci_dev *dev, const char *name);
222};
223
224extern const struct penable chipset_enables[];
225
226struct board_pciid_enable {
227 /* Any device, but make it sensible, like the ISA bridge. */
228 uint16_t first_vendor;
229 uint16_t first_device;
230 uint16_t first_card_vendor;
231 uint16_t first_card_device;
232
233 /* Any device, but make it sensible, like
234 * the host bridge. May be NULL.
235 */
236 uint16_t second_vendor;
237 uint16_t second_device;
238 uint16_t second_card_vendor;
239 uint16_t second_card_device;
240
241 /* The vendor / part name from the coreboot table. */
242 const char *lb_vendor;
243 const char *lb_part;
244
245 const char *vendor_name;
246 const char *board_name;
247
248 int (*enable) (const char *name);
249};
250
251extern struct board_pciid_enable board_pciid_enables[];
252
253struct board_info {
254 const char *vendor;
255 const char *name;
256};
257
258extern const struct board_info boards_ok[];
259extern const struct board_info boards_bad[];
Uwe Hermanne1aa75e2009-06-18 14:04:44 +0000260extern const struct board_info laptops_ok[];
261extern const struct board_info laptops_bad[];
Uwe Hermann05fab752009-05-16 23:42:17 +0000262
Uwe Hermann372eeb52007-12-04 21:49:06 +0000263/* udelay.c */
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000264void myusec_delay(int usecs);
Carl-Daniel Hailfinger43634392009-05-01 12:22:17 +0000265void myusec_calibrate_delay(void);
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000266
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000267/* pcidev.c */
268#define PCI_OK 0
269#define PCI_NT 1 /* Not tested */
Rudolf Marek68720c72009-05-17 19:39:27 +0000270
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000271extern uint32_t io_base_addr;
272extern struct pci_access *pacc;
273extern struct pci_filter filter;
Uwe Hermann8403ccb2009-05-16 21:39:19 +0000274extern struct pci_dev *pcidev_dev;
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000275struct pcidev_status {
276 uint16_t vendor_id;
277 uint16_t device_id;
278 int status;
279 const char *vendor_name;
280 const char *device_name;
281};
282uint32_t pcidev_validate(struct pci_dev *dev, struct pcidev_status *devs);
Carl-Daniel Hailfingeref58a9c2009-08-12 13:32:56 +0000283uint32_t pcidev_init(uint16_t vendor_id, struct pcidev_status *devs, char *pcidev_bdf);
Uwe Hermannba290d12009-06-17 12:07:12 +0000284
285/* print.c */
286char *flashbuses_to_text(enum chipbustype bustype);
287void print_supported_chips(void);
288void print_supported_chipsets(void);
289void print_supported_boards(void);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000290void print_supported_pcidevs(struct pcidev_status *devs);
Uwe Hermanna2d05012009-06-20 01:21:38 +0000291void print_wiki_tables(void);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000292
Uwe Hermann372eeb52007-12-04 21:49:06 +0000293/* board_enable.c */
Peter Stuge9d9399c2009-01-26 02:34:51 +0000294void w836xx_ext_enter(uint16_t port);
295void w836xx_ext_leave(uint16_t port);
Carl-Daniel Hailfinger24c1a162009-05-25 23:26:50 +0000296uint8_t sio_read(uint16_t port, uint8_t reg);
297void sio_write(uint16_t port, uint8_t reg, uint8_t data);
298void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
Uwe Hermann372eeb52007-12-04 21:49:06 +0000299int board_flash_enable(const char *vendor, const char *part);
Adam Kaufman064b1f22007-02-06 19:47:50 +0000300
Uwe Hermann372eeb52007-12-04 21:49:06 +0000301/* chipset_enable.c */
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000302extern enum chipbustype buses_supported;
Uwe Hermann372eeb52007-12-04 21:49:06 +0000303int chipset_flash_enable(void);
Stefan Reinauer2cb94e12008-06-30 23:45:22 +0000304
Stefan Reinauer9a6d1762008-12-03 21:24:40 +0000305extern unsigned long flashbase;
306
Stefan Reinauer0593f212009-01-26 01:10:48 +0000307/* physmap.c */
308void *physmap(const char *descr, unsigned long phys_addr, size_t len);
309void physunmap(void *virt_addr, size_t len);
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000310int setup_cpu_msr(int cpu);
311void cleanup_cpu_msr(void);
312#ifndef __DARWIN__
313typedef struct { uint32_t hi, lo; } msr_t;
314msr_t rdmsr(int addr);
315int wrmsr(int addr, msr_t msr);
316#endif
Stefan Reinauer0593f212009-01-26 01:10:48 +0000317
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000318/* internal.c */
Uwe Hermann2cac6862009-05-16 22:05:42 +0000319struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
320struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
321struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
322 uint16_t card_vendor, uint16_t card_device);
Carl-Daniel Hailfinger3b7e75a2009-05-14 21:41:10 +0000323void get_io_perms(void);
Carl-Daniel Hailfingerdb41c592009-08-09 21:50:24 +0000324void release_io_perms(void);
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000325int internal_init(void);
326int internal_shutdown(void);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000327void internal_chip_writeb(uint8_t val, chipaddr addr);
328void internal_chip_writew(uint16_t val, chipaddr addr);
329void internal_chip_writel(uint32_t val, chipaddr addr);
330uint8_t internal_chip_readb(const chipaddr addr);
331uint16_t internal_chip_readw(const chipaddr addr);
332uint32_t internal_chip_readl(const chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000333void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfinger78185dc2009-05-17 15:49:24 +0000334void mmio_writeb(uint8_t val, void *addr);
335void mmio_writew(uint16_t val, void *addr);
336void mmio_writel(uint32_t val, void *addr);
337uint8_t mmio_readb(void *addr);
338uint16_t mmio_readw(void *addr);
339uint32_t mmio_readl(void *addr);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000340void internal_delay(int usecs);
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000341int fallback_shutdown(void);
Uwe Hermannc6915932009-05-17 23:12:17 +0000342void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
343void fallback_unmap(void *virt_addr, size_t len);
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000344void fallback_chip_writeb(uint8_t val, chipaddr addr);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000345void fallback_chip_writew(uint16_t val, chipaddr addr);
346void fallback_chip_writel(uint32_t val, chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000347void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000348uint16_t fallback_chip_readw(const chipaddr addr);
349uint32_t fallback_chip_readl(const chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000350void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
Uwe Hermanna0869322009-05-14 20:41:57 +0000351#if defined(__FreeBSD__) || defined(__DragonFly__)
352extern int io_fd;
353#endif
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000354
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +0000355/* dummyflasher.c */
356int dummy_init(void);
357int dummy_shutdown(void);
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000358void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
359void dummy_unmap(void *virt_addr, size_t len);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000360void dummy_chip_writeb(uint8_t val, chipaddr addr);
361void dummy_chip_writew(uint16_t val, chipaddr addr);
362void dummy_chip_writel(uint32_t val, chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000363void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000364uint8_t dummy_chip_readb(const chipaddr addr);
365uint16_t dummy_chip_readw(const chipaddr addr);
366uint32_t dummy_chip_readl(const chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000367void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000368int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfingerbfe2e0c2009-05-14 12:59:36 +0000369 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +0000370
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000371/* nic3com.c */
372int nic3com_init(void);
373int nic3com_shutdown(void);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000374void nic3com_chip_writeb(uint8_t val, chipaddr addr);
375uint8_t nic3com_chip_readb(const chipaddr addr);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000376extern struct pcidev_status nics_3com[];
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000377
Rudolf Marek68720c72009-05-17 19:39:27 +0000378/* satasii.c */
379int satasii_init(void);
380int satasii_shutdown(void);
Rudolf Marek68720c72009-05-17 19:39:27 +0000381void satasii_chip_writeb(uint8_t val, chipaddr addr);
382uint8_t satasii_chip_readb(const chipaddr addr);
383extern struct pcidev_status satas_sii[];
384
Paul Fox05dfbe62009-06-16 21:08:06 +0000385/* ft2232_spi.c */
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000386#define FTDI_FT2232H 0x6010
387#define FTDI_FT4232H 0x6011
Paul Fox05dfbe62009-06-16 21:08:06 +0000388int ft2232_spi_init(void);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000389int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
Paul Fox05dfbe62009-06-16 21:08:06 +0000390int ft2232_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
Paul Fox05dfbe62009-06-16 21:08:06 +0000391int ft2232_spi_write_256(struct flashchip *flash, uint8_t *buf);
392
Uwe Hermann0846f892007-08-23 13:34:59 +0000393/* flashrom.c */
Carl-Daniel Hailfingeref58a9c2009-08-12 13:32:56 +0000394extern char *programmer_param;
Uwe Hermannad216bf2009-04-24 16:17:41 +0000395extern int verbose;
Carl-Daniel Hailfingera80cfbc2009-07-22 20:13:00 +0000396extern const char *flashrom_version;
Uwe Hermannad216bf2009-04-24 16:17:41 +0000397#define printf_debug(x...) { if (verbose) printf(x); }
Peter Stuge776d2022009-01-26 00:39:57 +0000398void map_flash_registers(struct flashchip *flash);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000399int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000400int min(int a, int b);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000401int max(int a, int b);
402int check_erased_range(struct flashchip *flash, int start, int len);
403int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
Uwe Hermannba290d12009-06-17 12:07:12 +0000404char *strcat_realloc(char *dest, const char *src);
405
406#define OK 0
407#define NT 1 /* Not tested */
Uwe Hermann0846f892007-08-23 13:34:59 +0000408
409/* layout.c */
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000410int show_id(uint8_t *bios, int size, int force);
Uwe Hermann0846f892007-08-23 13:34:59 +0000411int read_romlayout(char *name);
412int find_romentry(char *name);
413int handle_romentries(uint8_t *buffer, uint8_t *content);
414
Uwe Hermannad216bf2009-04-24 16:17:41 +0000415/* cbtable.c */
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000416int coreboot_init(void);
Uwe Hermann0846f892007-08-23 13:34:59 +0000417extern char *lb_part, *lb_vendor;
Carl-Daniel Hailfingerbc25f942009-07-30 13:30:17 +0000418extern int partvendor_from_cbtable;
Uwe Hermann0846f892007-08-23 13:34:59 +0000419
Carl-Daniel Hailfinger00f911e2007-10-15 21:44:47 +0000420/* spi.c */
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000421enum spi_controller {
422 SPI_CONTROLLER_NONE,
423 SPI_CONTROLLER_ICH7,
424 SPI_CONTROLLER_ICH9,
425 SPI_CONTROLLER_IT87XX,
426 SPI_CONTROLLER_SB600,
427 SPI_CONTROLLER_VIA,
428 SPI_CONTROLLER_WBSIO,
Paul Fox05dfbe62009-06-16 21:08:06 +0000429 SPI_CONTROLLER_FT2232,
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000430 SPI_CONTROLLER_DUMMY,
431};
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000432struct spi_command {
433 unsigned int writecnt;
434 unsigned int readcnt;
435 const unsigned char *writearr;
436 unsigned char *readarr;
437};
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +0000438struct spi_programmer {
439 int (*command)(unsigned int writecnt, unsigned int readcnt,
440 const unsigned char *writearr, unsigned char *readarr);
441 int (*multicommand)(struct spi_command *spicommands);
442
443 /* Optimized functions for this programmer */
444 int (*read)(struct flashchip *flash, uint8_t *buf, int start, int len);
445 int (*write_256)(struct flashchip *flash, uint8_t *buf);
446};
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000447
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000448extern enum spi_controller spi_controller;
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +0000449extern const struct spi_programmer spi_programmer[];
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000450extern void *spibar;
Carl-Daniel Hailfinger42c54972008-05-15 03:19:49 +0000451int probe_spi_rdid(struct flashchip *flash);
Rudolf Marek48a85e42008-06-30 21:45:17 +0000452int probe_spi_rdid4(struct flashchip *flash);
Carl-Daniel Hailfinger14e50ac2008-11-28 01:25:00 +0000453int probe_spi_rems(struct flashchip *flash);
Carl-Daniel Hailfinger42c54972008-05-15 03:19:49 +0000454int probe_spi_res(struct flashchip *flash);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000455int spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann394131e2008-10-18 21:14:13 +0000456 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000457int spi_send_multicommand(struct spi_command *spicommands);
Carl-Daniel Hailfinger43634392009-05-01 12:22:17 +0000458int spi_write_enable(void);
459int spi_write_disable(void);
Carl-Daniel Hailfinger6afb6132008-11-03 00:02:11 +0000460int spi_chip_erase_60(struct flashchip *flash);
Peter Stugefa8c5502008-05-10 23:07:52 +0000461int spi_chip_erase_c7(struct flashchip *flash);
Carl-Daniel Hailfinger598ec582008-11-18 00:41:02 +0000462int spi_chip_erase_60_c7(struct flashchip *flash);
Stefan Reinauer424ed222008-10-29 22:13:20 +0000463int spi_chip_erase_d8(struct flashchip *flash);
Carl-Daniel Hailfinger3431bb72009-06-24 08:28:39 +0000464int spi_block_erase_20(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
465int spi_block_erase_52(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
466int spi_block_erase_d8(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
467int spi_block_erase_60(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
468int spi_block_erase_c7(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000469int spi_chip_write_1(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfinger8d497012009-05-09 02:34:18 +0000470int spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000471int spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfinger43634392009-05-01 12:22:17 +0000472uint8_t spi_read_status_register(void);
Carl-Daniel Hailfinger598ec582008-11-18 00:41:02 +0000473int spi_disable_blockprotect(void);
Carl-Daniel Hailfinger2f1b36f2009-07-12 12:06:18 +0000474int spi_byte_program(int addr, uint8_t byte);
475int spi_nbyte_program(int addr, uint8_t *bytes, int len);
476int spi_nbyte_read(int addr, uint8_t *bytes, int len);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000477int spi_read_chunked(struct flashchip *flash, uint8_t *buf, int start, int len, int chunksize);
Peter Stugefd9217d2009-01-26 03:37:40 +0000478int spi_aai_write(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfinger3e9dbea2009-05-13 11:40:08 +0000479uint32_t spi_get_valid_read_addr(void);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +0000480int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
481 const unsigned char *writearr, unsigned char *readarr);
482int default_spi_send_multicommand(struct spi_command *spicommands);
Carl-Daniel Hailfingere1514992007-10-02 15:49:25 +0000483
Uwe Hermann0846f892007-08-23 13:34:59 +0000484/* 82802ab.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000485int probe_82802ab(struct flashchip *flash);
486int erase_82802ab(struct flashchip *flash);
487int write_82802ab(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000488
489/* am29f040b.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000490int probe_29f040b(struct flashchip *flash);
491int erase_29f040b(struct flashchip *flash);
492int write_29f040b(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000493
Uwe Hermannf983d9f2009-06-14 21:53:26 +0000494/* pm29f002.c */
495int write_pm29f002(struct flashchip *flash, uint8_t *buf);
496
Mats Erik Andersson44e1a192008-09-26 13:19:02 +0000497/* en29f002a.c */
498int probe_en29f002a(struct flashchip *flash);
499int erase_en29f002a(struct flashchip *flash);
500int write_en29f002a(struct flashchip *flash, uint8_t *buf);
501
Dominik Geyerb46acba2008-05-16 12:55:55 +0000502/* ichspi.c */
Carl-Daniel Hailfinger43634392009-05-01 12:22:17 +0000503int ich_init_opcodes(void);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000504int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann394131e2008-10-18 21:14:13 +0000505 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000506int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000507int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +0000508int ich_spi_send_multicommand(struct spi_command *spicommands);
Dominik Geyerb46acba2008-05-16 12:55:55 +0000509
Carl-Daniel Hailfingerbfe5b4a2008-05-13 23:03:12 +0000510/* it87spi.c */
511extern uint16_t it8716f_flashport;
Carl-Daniel Hailfinger24c1a162009-05-25 23:26:50 +0000512void enter_conf_mode_ite(uint16_t port);
513void exit_conf_mode_ite(uint16_t port);
Carl-Daniel Hailfingerb8afecd2009-05-31 18:00:57 +0000514int it87spi_init(void);
Dominik Geyerb46acba2008-05-16 12:55:55 +0000515int it87xx_probe_spi_flash(const char *name);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000516int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann394131e2008-10-18 21:14:13 +0000517 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000518int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000519int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfingerbfe5b4a2008-05-13 23:03:12 +0000520
Jason Wanga3f04be2008-11-28 21:36:51 +0000521/* sb600spi.c */
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000522int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Jason Wanga3f04be2008-11-28 21:36:51 +0000523 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000524int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000525int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfinger78185dc2009-05-17 15:49:24 +0000526extern uint8_t *sb600_spibar;
Jason Wanga3f04be2008-11-28 21:36:51 +0000527
Uwe Hermann0846f892007-08-23 13:34:59 +0000528/* jedec.c */
Carl-Daniel Hailfingera758f512008-05-14 12:03:06 +0000529uint8_t oddparity(uint8_t val);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000530void toggle_ready_jedec(chipaddr dst);
531void data_polling_jedec(chipaddr dst, uint8_t data);
532void unprotect_jedec(chipaddr bios);
533void protect_jedec(chipaddr bios);
534int write_byte_program_jedec(chipaddr bios, uint8_t *src,
535 chipaddr dst);
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000536int probe_jedec(struct flashchip *flash);
537int erase_chip_jedec(struct flashchip *flash);
538int write_jedec(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000539int erase_sector_jedec(struct flashchip *flash, unsigned int page, int pagesize);
540int erase_block_jedec(struct flashchip *flash, unsigned int page, int blocksize);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000541int write_sector_jedec(chipaddr bios, uint8_t *src,
542 chipaddr dst, unsigned int page_size);
Uwe Hermann0846f892007-08-23 13:34:59 +0000543
Peter Stugeaf8ffac2009-01-26 06:42:02 +0000544/* m29f002.c */
545int erase_m29f002(struct flashchip *flash);
546int write_m29f002t(struct flashchip *flash, uint8_t *buf);
547int write_m29f002b(struct flashchip *flash, uint8_t *buf);
548
Uwe Hermann0846f892007-08-23 13:34:59 +0000549/* m29f400bt.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000550int probe_m29f400bt(struct flashchip *flash);
551int erase_m29f400bt(struct flashchip *flash);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000552int block_erase_m29f400bt(struct flashchip *flash, int start, int len);
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000553int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000554int write_coreboot_m29f400bt(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000555void toggle_ready_m29f400bt(chipaddr dst);
556void data_polling_m29f400bt(chipaddr dst, uint8_t data);
557void protect_m29f400bt(chipaddr bios);
558void write_page_m29f400bt(chipaddr bios, uint8_t *src,
559 chipaddr dst, int page_size);
Uwe Hermann0846f892007-08-23 13:34:59 +0000560
561/* mx29f002.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000562int probe_29f002(struct flashchip *flash);
563int erase_29f002(struct flashchip *flash);
564int write_29f002(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000565
Nikolay Petukhov4784c472008-05-17 01:08:58 +0000566/* pm49fl00x.c */
567int probe_49fl00x(struct flashchip *flash);
568int erase_49fl00x(struct flashchip *flash);
569int write_49fl00x(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000570
571/* sharplhf00l04.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000572int probe_lhf00l04(struct flashchip *flash);
573int erase_lhf00l04(struct flashchip *flash);
574int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000575void toggle_ready_lhf00l04(chipaddr dst);
576void data_polling_lhf00l04(chipaddr dst, uint8_t data);
577void protect_lhf00l04(chipaddr bios);
Uwe Hermann0846f892007-08-23 13:34:59 +0000578
579/* sst28sf040.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000580int probe_28sf040(struct flashchip *flash);
581int erase_28sf040(struct flashchip *flash);
582int write_28sf040(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000583
584/* sst39sf020.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000585int probe_39sf020(struct flashchip *flash);
586int write_39sf020(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000587
588/* sst49lf040.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000589int erase_49lf040(struct flashchip *flash);
590int write_49lf040(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000591
592/* sst49lfxxxc.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000593int probe_49lfxxxc(struct flashchip *flash);
594int erase_49lfxxxc(struct flashchip *flash);
595int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000596
597/* sst_fwhub.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000598int probe_sst_fwhub(struct flashchip *flash);
599int erase_sst_fwhub(struct flashchip *flash);
600int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
Uwe Hermann0846f892007-08-23 13:34:59 +0000601
Peter Stugecce26822008-07-21 17:48:40 +0000602/* w39v040c.c */
603int probe_w39v040c(struct flashchip *flash);
604int erase_w39v040c(struct flashchip *flash);
605int write_w39v040c(struct flashchip *flash, uint8_t *buf);
606
Stefan Reinauerac378972008-03-17 22:59:40 +0000607/* w39V080fa.c */
608int probe_winbond_fwhub(struct flashchip *flash);
609int erase_winbond_fwhub(struct flashchip *flash);
610int write_winbond_fwhub(struct flashchip *flash, uint8_t *buf);
611
Markus Boasd2ac6fc2007-08-30 10:17:50 +0000612/* w29ee011.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000613int probe_w29ee011(struct flashchip *flash);
Markus Boasd2ac6fc2007-08-30 10:17:50 +0000614
Uwe Hermann0846f892007-08-23 13:34:59 +0000615/* w49f002u.c */
Uwe Hermanna0cc53d2007-09-09 20:24:29 +0000616int write_49f002(struct flashchip *flash, uint8_t *buf);
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000617
Peter Stugebf196e92009-01-26 03:08:45 +0000618/* wbsio_spi.c */
619int wbsio_check_for_spi(const char *name);
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000620int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000621 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000622int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000623int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
Peter Stugebf196e92009-01-26 03:08:45 +0000624
Claus Gindharta7b35512008-04-28 17:51:09 +0000625/* stm50flw0x0x.c */
626int probe_stm50flw0x0x(struct flashchip *flash);
627int erase_stm50flw0x0x(struct flashchip *flash);
628int write_stm50flw0x0x(struct flashchip *flash, uint8_t *buf);
Dominik Geyerb46acba2008-05-16 12:55:55 +0000629
Urja Rannikko22915352009-06-23 11:33:43 +0000630/* serprog.c */
Urja Rannikko22915352009-06-23 11:33:43 +0000631int serprog_init(void);
632int serprog_shutdown(void);
633void serprog_chip_writeb(uint8_t val, chipaddr addr);
634uint8_t serprog_chip_readb(const chipaddr addr);
635void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
636void serprog_delay(int delay);
Uwe Hermann1432a602009-06-28 23:26:37 +0000637
Ollie Lho761bf1b2004-03-20 16:46:10 +0000638#endif /* !__FLASH_H__ */