blob: 2a54806944a0625a3dc5721b4549fa16c9753363 [file] [log] [blame]
stepan5c3f1382007-02-06 19:47:50 +00001/*
uweb25f1ea2007-08-29 17:52:32 +00002 * This file is part of the flashrom project.
stepan5c3f1382007-02-06 19:47:50 +00003 *
uwe555dd972007-09-09 20:21:05 +00004 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2000 Ronald G. Minnich <rminnich@gmail.com>
stepan6d42c0f2009-08-12 09:27:45 +00006 * Copyright (C) 2005-2009 coresystems GmbH
hailfinger77c5d932009-06-15 12:10:57 +00007 * Copyright (C) 2006-2009 Carl-Daniel Hailfinger
stepan5c3f1382007-02-06 19:47:50 +00008 *
uweb25f1ea2007-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.
stepan5c3f1382007-02-06 19:47:50 +000013 *
uweb25f1ea2007-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.
stepan5c3f1382007-02-06 19:47:50 +000018 *
uweb25f1ea2007-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
stepan5c3f1382007-02-06 19:47:50 +000022 */
23
rminnich8d3ff912003-10-25 17:01:29 +000024#ifndef __FLASH_H__
25#define __FLASH_H__ 1
26
stepan5c3f1382007-02-06 19:47:50 +000027#if defined(__GLIBC__)
rminnich8d3ff912003-10-25 17:01:29 +000028#include <sys/io.h>
stepan5c3f1382007-02-06 19:47:50 +000029#endif
rminnich8d3ff912003-10-25 17:01:29 +000030#include <unistd.h>
ollie6a600992005-11-26 21:55:36 +000031#include <stdint.h>
uwe4529d202007-08-23 13:34:59 +000032#include <stdio.h>
uwe6934c4a2009-05-14 18:57:26 +000033#include <pci/pci.h>
rminnich8d3ff912003-10-25 17:01:29 +000034
hailfinger6f84e472009-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
stuge96960832009-01-26 01:23:31 +000043#if (defined(__MACH__) && defined(__APPLE__))
44#define __DARWIN__
45#endif
46
hailfinger0ddb3eb2009-04-28 12:56:04 +000047#if defined(__FreeBSD__) || defined(__DragonFly__)
hailfingere1f062f2008-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
stuge96960832009-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
hailfinger6f84e472009-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
hailfingere1f062f2008-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
hailfinger6f84e472009-05-01 16:34:32 +000079#endif
hailfingere1f062f2008-05-22 13:22:45 +000080
hailfinger82719632009-05-16 21:22:56 +000081typedef unsigned long chipaddr;
82
hailfinger6fe23d62009-08-12 11:39:29 +000083enum programmer {
84 PROGRAMMER_INTERNAL,
hailfinger571a6b32009-09-16 10:09:21 +000085#if DUMMY_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000086 PROGRAMMER_DUMMY,
hailfinger571a6b32009-09-16 10:09:21 +000087#endif
88#if NIC3COM_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000089 PROGRAMMER_NIC3COM,
hailfinger571a6b32009-09-16 10:09:21 +000090#endif
91#if DRKAISER_SUPPORT == 1
uwee2f95ef2009-09-02 23:00:46 +000092 PROGRAMMER_DRKAISER,
hailfinger571a6b32009-09-16 10:09:21 +000093#endif
94#if SATASII_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000095 PROGRAMMER_SATASII,
hailfinger571a6b32009-09-16 10:09:21 +000096#endif
hailfinger6fe23d62009-08-12 11:39:29 +000097 PROGRAMMER_IT87SPI,
hailfingerd9dcfbd2009-08-19 13:27:58 +000098#if FT2232_SPI_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000099 PROGRAMMER_FT2232SPI,
hailfingerd9dcfbd2009-08-19 13:27:58 +0000100#endif
hailfinger74d88a72009-08-12 16:17:41 +0000101#if SERPROG_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +0000102 PROGRAMMER_SERPROG,
hailfinger74d88a72009-08-12 16:17:41 +0000103#endif
hailfinger3548a9a2009-08-12 14:34:35 +0000104 PROGRAMMER_INVALID /* This must always be the last entry. */
hailfinger6fe23d62009-08-12 11:39:29 +0000105};
106
107extern enum programmer programmer;
hailfingerabe249e2009-05-08 17:43:22 +0000108
109struct programmer_entry {
110 const char *vendor;
111 const char *name;
112
113 int (*init) (void);
114 int (*shutdown) (void);
115
uwe4e204a22009-05-28 15:07:42 +0000116 void * (*map_flash_region) (const char *descr, unsigned long phys_addr,
117 size_t len);
hailfinger11ae3c42009-05-11 14:13:25 +0000118 void (*unmap_flash_region) (void *virt_addr, size_t len);
119
hailfinger82719632009-05-16 21:22:56 +0000120 void (*chip_writeb) (uint8_t val, chipaddr addr);
121 void (*chip_writew) (uint16_t val, chipaddr addr);
122 void (*chip_writel) (uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000123 void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000124 uint8_t (*chip_readb) (const chipaddr addr);
125 uint16_t (*chip_readw) (const chipaddr addr);
126 uint32_t (*chip_readl) (const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000127 void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +0000128 void (*delay) (int usecs);
hailfingerabe249e2009-05-08 17:43:22 +0000129};
130
131extern const struct programmer_entry programmer_table[];
132
uweabe92a52009-05-16 22:36:00 +0000133int programmer_init(void);
134int programmer_shutdown(void);
135void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
136 size_t len);
137void programmer_unmap_flash_region(void *virt_addr, size_t len);
138void chip_writeb(uint8_t val, chipaddr addr);
139void chip_writew(uint16_t val, chipaddr addr);
140void chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000141void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
uweabe92a52009-05-16 22:36:00 +0000142uint8_t chip_readb(const chipaddr addr);
143uint16_t chip_readw(const chipaddr addr);
144uint32_t chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000145void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +0000146void programmer_delay(int usecs);
hailfingerba3761a2009-03-05 19:24:22 +0000147
uwe16f99092008-03-12 11:54:51 +0000148#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
149
hailfinger40167462009-05-31 17:57:34 +0000150enum chipbustype {
hailfinger668f3502009-06-01 00:02:11 +0000151 CHIP_BUSTYPE_NONE = 0,
hailfinger40167462009-05-31 17:57:34 +0000152 CHIP_BUSTYPE_PARALLEL = 1 << 0,
153 CHIP_BUSTYPE_LPC = 1 << 1,
154 CHIP_BUSTYPE_FWH = 1 << 2,
155 CHIP_BUSTYPE_SPI = 1 << 3,
156 CHIP_BUSTYPE_NONSPI = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH,
157 CHIP_BUSTYPE_UNKNOWN = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH | CHIP_BUSTYPE_SPI,
158};
159
hailfinger7df21362009-09-05 02:30:58 +0000160/*
161 * How many different contiguous runs of erase blocks with one size each do
162 * we have for a given erase function?
163 */
164#define NUM_ERASEREGIONS 5
165
166/*
167 * How many different erase functions do we have per chip?
168 */
169#define NUM_ERASEFUNCTIONS 5
170
rminnich8d3ff912003-10-25 17:01:29 +0000171struct flashchip {
uwedfcd15f2008-03-14 23:55:58 +0000172 const char *vendor;
uwe6ed6d952007-12-04 21:49:06 +0000173 const char *name;
hailfinger40167462009-05-31 17:57:34 +0000174
175 enum chipbustype bustype;
176
uwefa98ca12008-10-18 21:14:13 +0000177 /*
178 * With 32bit manufacture_id and model_id we can cover IDs up to
hailfinger428f2012007-12-31 01:49:00 +0000179 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
180 * Identification code.
181 */
182 uint32_t manufacture_id;
183 uint32_t model_id;
rminnich8d3ff912003-10-25 17:01:29 +0000184
rminnich8d3ff912003-10-25 17:01:29 +0000185 int total_size;
186 int page_size;
187
uwefa98ca12008-10-18 21:14:13 +0000188 /*
189 * Indicate if flashrom has been tested with this flash chip and if
stuge9cd64bd2008-05-03 04:34:37 +0000190 * everything worked correctly.
191 */
192 uint32_t tested;
193
uwe8e1a2ba2007-04-01 19:44:21 +0000194 int (*probe) (struct flashchip *flash);
hailfingerd5b35922009-06-03 14:46:22 +0000195
196 /* Delay after "enter/exit ID mode" commands in microseconds. */
197 int probe_timing;
uwe8e1a2ba2007-04-01 19:44:21 +0000198 int (*erase) (struct flashchip *flash);
hailfinger7df21362009-09-05 02:30:58 +0000199
200 /*
201 * Erase blocks and associated erase function. The default entry is a
202 * chip-sized virtual block together with the chip erase function.
203 */
204 struct block_eraser {
205 struct eraseblock{
206 unsigned int size; /* Eraseblock size */
207 unsigned int count; /* Number of contiguous blocks with that size */
208 } eraseblocks[NUM_ERASEREGIONS];
209 int (*block_erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
210 } block_erasers[NUM_ERASEFUNCTIONS];
211
uwe8e1a2ba2007-04-01 19:44:21 +0000212 int (*write) (struct flashchip *flash, uint8_t *buf);
hailfinger0f08b7a2009-06-16 08:55:44 +0000213 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
rminnich8d3ff912003-10-25 17:01:29 +0000214
uwe6ed6d952007-12-04 21:49:06 +0000215 /* Some flash devices have an additional register space. */
hailfinger82719632009-05-16 21:22:56 +0000216 chipaddr virtual_memory;
217 chipaddr virtual_registers;
rminnich8d3ff912003-10-25 17:01:29 +0000218};
219
stuge9cd64bd2008-05-03 04:34:37 +0000220#define TEST_UNTESTED 0
221
uwe4e204a22009-05-28 15:07:42 +0000222#define TEST_OK_PROBE (1 << 0)
223#define TEST_OK_READ (1 << 1)
224#define TEST_OK_ERASE (1 << 2)
225#define TEST_OK_WRITE (1 << 3)
226#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
227#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
228#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
stuge9cd64bd2008-05-03 04:34:37 +0000229#define TEST_OK_MASK 0x0f
230
uwe4e204a22009-05-28 15:07:42 +0000231#define TEST_BAD_PROBE (1 << 4)
232#define TEST_BAD_READ (1 << 5)
233#define TEST_BAD_ERASE (1 << 6)
234#define TEST_BAD_WRITE (1 << 7)
235#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
stuge9cd64bd2008-05-03 04:34:37 +0000236#define TEST_BAD_MASK 0xf0
237
hailfingerd5b35922009-06-03 14:46:22 +0000238/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
239 * field and zero delay.
240 *
241 * SPI devices will always have zero delay and ignore this field.
242 */
243#define TIMING_FIXME -1
244/* this is intentionally same value as fixme */
245#define TIMING_IGNORED -1
246#define TIMING_ZERO -2
247
ollie6a600992005-11-26 21:55:36 +0000248extern struct flashchip flashchips[];
249
uwe5f612c82009-05-16 23:42:17 +0000250struct penable {
251 uint16_t vendor_id;
252 uint16_t device_id;
253 int status;
254 const char *vendor_name;
255 const char *device_name;
256 int (*doit) (struct pci_dev *dev, const char *name);
257};
258
259extern const struct penable chipset_enables[];
260
261struct board_pciid_enable {
262 /* Any device, but make it sensible, like the ISA bridge. */
263 uint16_t first_vendor;
264 uint16_t first_device;
265 uint16_t first_card_vendor;
266 uint16_t first_card_device;
267
268 /* Any device, but make it sensible, like
269 * the host bridge. May be NULL.
270 */
271 uint16_t second_vendor;
272 uint16_t second_device;
273 uint16_t second_card_vendor;
274 uint16_t second_card_device;
275
276 /* The vendor / part name from the coreboot table. */
277 const char *lb_vendor;
278 const char *lb_part;
279
280 const char *vendor_name;
281 const char *board_name;
282
283 int (*enable) (const char *name);
284};
285
286extern struct board_pciid_enable board_pciid_enables[];
287
288struct board_info {
289 const char *vendor;
290 const char *name;
291};
292
293extern const struct board_info boards_ok[];
294extern const struct board_info boards_bad[];
uwefef723f2009-06-18 14:04:44 +0000295extern const struct board_info laptops_ok[];
296extern const struct board_info laptops_bad[];
uwe5f612c82009-05-16 23:42:17 +0000297
uwe6ed6d952007-12-04 21:49:06 +0000298/* udelay.c */
hailfingere5829f62009-06-05 17:48:08 +0000299void myusec_delay(int usecs);
hailfinger3d77bc12009-05-01 12:22:17 +0000300void myusec_calibrate_delay(void);
stepan927d4e22007-04-04 22:45:58 +0000301
uwea3a82c92009-05-15 17:02:34 +0000302/* pcidev.c */
303#define PCI_OK 0
304#define PCI_NT 1 /* Not tested */
ruikda922a12009-05-17 19:39:27 +0000305
uwea3a82c92009-05-15 17:02:34 +0000306extern uint32_t io_base_addr;
307extern struct pci_access *pacc;
308extern struct pci_filter filter;
uweb3a82ef2009-05-16 21:39:19 +0000309extern struct pci_dev *pcidev_dev;
uwea3a82c92009-05-15 17:02:34 +0000310struct pcidev_status {
311 uint16_t vendor_id;
312 uint16_t device_id;
313 int status;
314 const char *vendor_name;
315 const char *device_name;
316};
uwee2f95ef2009-09-02 23:00:46 +0000317uint32_t pcidev_validate(struct pci_dev *dev, uint32_t bar, struct pcidev_status *devs);
318uint32_t pcidev_init(uint16_t vendor_id, uint32_t bar, struct pcidev_status *devs, char *pcidev_bdf);
uwe884cc8b2009-06-17 12:07:12 +0000319
320/* print.c */
321char *flashbuses_to_text(enum chipbustype bustype);
322void print_supported_chips(void);
323void print_supported_chipsets(void);
324void print_supported_boards(void);
uwea3a82c92009-05-15 17:02:34 +0000325void print_supported_pcidevs(struct pcidev_status *devs);
uwe488f0842009-06-20 01:21:38 +0000326void print_wiki_tables(void);
uwea3a82c92009-05-15 17:02:34 +0000327
uwe6ed6d952007-12-04 21:49:06 +0000328/* board_enable.c */
stugeaa35d392009-01-26 02:34:51 +0000329void w836xx_ext_enter(uint16_t port);
330void w836xx_ext_leave(uint16_t port);
hailfinger7bac0e52009-05-25 23:26:50 +0000331uint8_t sio_read(uint16_t port, uint8_t reg);
332void sio_write(uint16_t port, uint8_t reg, uint8_t data);
333void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
uwe6ed6d952007-12-04 21:49:06 +0000334int board_flash_enable(const char *vendor, const char *part);
stepan5c3f1382007-02-06 19:47:50 +0000335
uwe6ed6d952007-12-04 21:49:06 +0000336/* chipset_enable.c */
hailfinger40167462009-05-31 17:57:34 +0000337extern enum chipbustype buses_supported;
uwe6ed6d952007-12-04 21:49:06 +0000338int chipset_flash_enable(void);
stepan3bdf6182008-06-30 23:45:22 +0000339
stuge12ac08f2008-12-03 21:24:40 +0000340extern unsigned long flashbase;
341
stuge7c943ee2009-01-26 01:10:48 +0000342/* physmap.c */
343void *physmap(const char *descr, unsigned long phys_addr, size_t len);
344void physunmap(void *virt_addr, size_t len);
stepan6d42c0f2009-08-12 09:27:45 +0000345int setup_cpu_msr(int cpu);
346void cleanup_cpu_msr(void);
hailfinger2cff9a72009-08-19 10:46:23 +0000347#if !defined(__DARWIN__) && !defined(__FreeBSD__) && !defined(__DragonFly__)
stepan6d42c0f2009-08-12 09:27:45 +0000348typedef struct { uint32_t hi, lo; } msr_t;
349msr_t rdmsr(int addr);
350int wrmsr(int addr, msr_t msr);
351#endif
hailfinger2cff9a72009-08-19 10:46:23 +0000352#if defined(__FreeBSD__) || defined(__DragonFly__)
353/* FreeBSD already has conflicting definitions for wrmsr/rdmsr. */
354#undef rdmsr
355#undef wrmsr
356#define rdmsr freebsd_rdmsr
357#define wrmsr freebsd_wrmsr
358typedef struct { uint32_t hi, lo; } msr_t;
359msr_t freebsd_rdmsr(int addr);
360int freebsd_wrmsr(int addr, msr_t msr);
361#endif
stuge7c943ee2009-01-26 01:10:48 +0000362
hailfingerabe249e2009-05-08 17:43:22 +0000363/* internal.c */
uwe57195ba2009-05-16 22:05:42 +0000364struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
365struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
366struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
367 uint16_t card_vendor, uint16_t card_device);
hailfinger0668eba2009-05-14 21:41:10 +0000368void get_io_perms(void);
hailfinger7828d092009-08-09 21:50:24 +0000369void release_io_perms(void);
hailfingerabe249e2009-05-08 17:43:22 +0000370int internal_init(void);
371int internal_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000372void internal_chip_writeb(uint8_t val, chipaddr addr);
373void internal_chip_writew(uint16_t val, chipaddr addr);
374void internal_chip_writel(uint32_t val, chipaddr addr);
375uint8_t internal_chip_readb(const chipaddr addr);
376uint16_t internal_chip_readw(const chipaddr addr);
377uint32_t internal_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000378void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger38da6812009-05-17 15:49:24 +0000379void mmio_writeb(uint8_t val, void *addr);
380void mmio_writew(uint16_t val, void *addr);
381void mmio_writel(uint32_t val, void *addr);
382uint8_t mmio_readb(void *addr);
383uint16_t mmio_readw(void *addr);
384uint32_t mmio_readl(void *addr);
hailfingere5829f62009-06-05 17:48:08 +0000385void internal_delay(int usecs);
hailfinger571a6b32009-09-16 10:09:21 +0000386int noop_shutdown(void);
uwe3e656bd2009-05-17 23:12:17 +0000387void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
388void fallback_unmap(void *virt_addr, size_t len);
hailfinger571a6b32009-09-16 10:09:21 +0000389uint8_t noop_chip_readb(const chipaddr addr);
390void noop_chip_writeb(uint8_t val, chipaddr addr);
hailfinger82719632009-05-16 21:22:56 +0000391void fallback_chip_writew(uint16_t val, chipaddr addr);
392void fallback_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000393void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000394uint16_t fallback_chip_readw(const chipaddr addr);
395uint32_t fallback_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000396void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
uwebc526c82009-05-14 20:41:57 +0000397#if defined(__FreeBSD__) || defined(__DragonFly__)
398extern int io_fd;
399#endif
hailfingerabe249e2009-05-08 17:43:22 +0000400
hailfingera9df33c2009-05-09 00:54:55 +0000401/* dummyflasher.c */
402int dummy_init(void);
403int dummy_shutdown(void);
hailfinger11ae3c42009-05-11 14:13:25 +0000404void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
405void dummy_unmap(void *virt_addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000406void dummy_chip_writeb(uint8_t val, chipaddr addr);
407void dummy_chip_writew(uint16_t val, chipaddr addr);
408void dummy_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000409void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000410uint8_t dummy_chip_readb(const chipaddr addr);
411uint16_t dummy_chip_readw(const chipaddr addr);
412uint32_t dummy_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000413void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger68002c22009-07-10 21:08:55 +0000414int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
hailfingerf91e3b52009-05-14 12:59:36 +0000415 const unsigned char *writearr, unsigned char *readarr);
hailfingera9df33c2009-05-09 00:54:55 +0000416
uwe0f5a3a22009-05-13 11:36:06 +0000417/* nic3com.c */
418int nic3com_init(void);
419int nic3com_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000420void nic3com_chip_writeb(uint8_t val, chipaddr addr);
421uint8_t nic3com_chip_readb(const chipaddr addr);
uwea3a82c92009-05-15 17:02:34 +0000422extern struct pcidev_status nics_3com[];
uwe0f5a3a22009-05-13 11:36:06 +0000423
uwee2f95ef2009-09-02 23:00:46 +0000424/* drkaiser.c */
425int drkaiser_init(void);
426int drkaiser_shutdown(void);
427void drkaiser_chip_writeb(uint8_t val, chipaddr addr);
428uint8_t drkaiser_chip_readb(const chipaddr addr);
429extern struct pcidev_status drkaiser_pcidev[];
430
ruikda922a12009-05-17 19:39:27 +0000431/* satasii.c */
432int satasii_init(void);
433int satasii_shutdown(void);
ruikda922a12009-05-17 19:39:27 +0000434void satasii_chip_writeb(uint8_t val, chipaddr addr);
435uint8_t satasii_chip_readb(const chipaddr addr);
436extern struct pcidev_status satas_sii[];
437
hailfingerf31da3d2009-06-16 21:08:06 +0000438/* ft2232_spi.c */
hailfingere98628b2009-07-01 00:02:23 +0000439#define FTDI_FT2232H 0x6010
440#define FTDI_FT4232H 0x6011
hailfingerf31da3d2009-06-16 21:08:06 +0000441int ft2232_spi_init(void);
hailfinger68002c22009-07-10 21:08:55 +0000442int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
hailfingerf31da3d2009-06-16 21:08:06 +0000443int ft2232_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingerf31da3d2009-06-16 21:08:06 +0000444int ft2232_spi_write_256(struct flashchip *flash, uint8_t *buf);
445
uwe4529d202007-08-23 13:34:59 +0000446/* flashrom.c */
hailfinger4f45a4f2009-08-12 13:32:56 +0000447extern char *programmer_param;
uwee06bcf82009-04-24 16:17:41 +0000448extern int verbose;
hailfinger2d83b5b2009-07-22 20:13:00 +0000449extern const char *flashrom_version;
uwee06bcf82009-04-24 16:17:41 +0000450#define printf_debug(x...) { if (verbose) printf(x); }
stuge5ff0e6c2009-01-26 00:39:57 +0000451void map_flash_registers(struct flashchip *flash);
hailfinger0f08b7a2009-06-16 08:55:44 +0000452int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfinger7df21362009-09-05 02:30:58 +0000453int erase_flash(struct flashchip *flash);
hailfinger7b414742009-06-13 12:04:03 +0000454int min(int a, int b);
hailfinger7af83692009-06-15 17:23:36 +0000455int max(int a, int b);
456int check_erased_range(struct flashchip *flash, int start, int len);
457int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
uwe884cc8b2009-06-17 12:07:12 +0000458char *strcat_realloc(char *dest, const char *src);
459
460#define OK 0
461#define NT 1 /* Not tested */
uwe4529d202007-08-23 13:34:59 +0000462
463/* layout.c */
stuge98c09aa2008-06-18 02:08:40 +0000464int show_id(uint8_t *bios, int size, int force);
uwe4529d202007-08-23 13:34:59 +0000465int read_romlayout(char *name);
466int find_romentry(char *name);
hailfinger051b3442009-08-19 15:19:18 +0000467int handle_romentries(uint8_t *buffer, struct flashchip *flash);
uwe4529d202007-08-23 13:34:59 +0000468
uwee06bcf82009-04-24 16:17:41 +0000469/* cbtable.c */
stepan1037f6f2008-01-18 15:33:10 +0000470int coreboot_init(void);
uwe4529d202007-08-23 13:34:59 +0000471extern char *lb_part, *lb_vendor;
stepan3370c892009-07-30 13:30:17 +0000472extern int partvendor_from_cbtable;
uwe4529d202007-08-23 13:34:59 +0000473
stepan745615e2007-10-15 21:44:47 +0000474/* spi.c */
hailfinger40167462009-05-31 17:57:34 +0000475enum spi_controller {
476 SPI_CONTROLLER_NONE,
477 SPI_CONTROLLER_ICH7,
478 SPI_CONTROLLER_ICH9,
479 SPI_CONTROLLER_IT87XX,
480 SPI_CONTROLLER_SB600,
481 SPI_CONTROLLER_VIA,
482 SPI_CONTROLLER_WBSIO,
hailfingerd9dcfbd2009-08-19 13:27:58 +0000483#if FT2232_SPI_SUPPORT == 1
hailfingerf31da3d2009-06-16 21:08:06 +0000484 SPI_CONTROLLER_FT2232,
hailfingerd9dcfbd2009-08-19 13:27:58 +0000485#endif
hailfinger571a6b32009-09-16 10:09:21 +0000486#if DUMMY_SUPPORT == 1
hailfinger40167462009-05-31 17:57:34 +0000487 SPI_CONTROLLER_DUMMY,
hailfinger571a6b32009-09-16 10:09:21 +0000488#endif
hailfingerd9dcfbd2009-08-19 13:27:58 +0000489 SPI_CONTROLLER_INVALID /* This must always be the last entry. */
hailfinger40167462009-05-31 17:57:34 +0000490};
hailfingerd9dcfbd2009-08-19 13:27:58 +0000491extern const int spi_programmer_count;
hailfinger68002c22009-07-10 21:08:55 +0000492struct spi_command {
493 unsigned int writecnt;
494 unsigned int readcnt;
495 const unsigned char *writearr;
496 unsigned char *readarr;
497};
hailfinger948b81f2009-07-22 15:36:50 +0000498struct spi_programmer {
499 int (*command)(unsigned int writecnt, unsigned int readcnt,
500 const unsigned char *writearr, unsigned char *readarr);
501 int (*multicommand)(struct spi_command *spicommands);
502
503 /* Optimized functions for this programmer */
504 int (*read)(struct flashchip *flash, uint8_t *buf, int start, int len);
505 int (*write_256)(struct flashchip *flash, uint8_t *buf);
506};
hailfinger68002c22009-07-10 21:08:55 +0000507
hailfinger40167462009-05-31 17:57:34 +0000508extern enum spi_controller spi_controller;
hailfinger948b81f2009-07-22 15:36:50 +0000509extern const struct spi_programmer spi_programmer[];
hailfinger40167462009-05-31 17:57:34 +0000510extern void *spibar;
hailfinger82893122008-05-15 03:19:49 +0000511int probe_spi_rdid(struct flashchip *flash);
ruikdbe18ee2008-06-30 21:45:17 +0000512int probe_spi_rdid4(struct flashchip *flash);
hailfinger3dd0c3e2008-11-28 01:25:00 +0000513int probe_spi_rems(struct flashchip *flash);
hailfinger82893122008-05-15 03:19:49 +0000514int probe_spi_res(struct flashchip *flash);
hailfinger68002c22009-07-10 21:08:55 +0000515int spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000516 const unsigned char *writearr, unsigned char *readarr);
hailfinger68002c22009-07-10 21:08:55 +0000517int spi_send_multicommand(struct spi_command *spicommands);
hailfinger3d77bc12009-05-01 12:22:17 +0000518int spi_write_enable(void);
519int spi_write_disable(void);
hailfingerffcf81a2008-11-03 00:02:11 +0000520int spi_chip_erase_60(struct flashchip *flash);
stuge2bb6ab32008-05-10 23:07:52 +0000521int spi_chip_erase_c7(struct flashchip *flash);
hailfingerc1b2e912008-11-18 00:41:02 +0000522int spi_chip_erase_60_c7(struct flashchip *flash);
stepan0f7bff02008-10-29 22:13:20 +0000523int spi_chip_erase_d8(struct flashchip *flash);
hailfingera1289042009-06-24 08:28:39 +0000524int spi_block_erase_20(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
525int spi_block_erase_52(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
526int spi_block_erase_d8(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
527int spi_block_erase_60(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
528int spi_block_erase_c7(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
hailfingered063f52009-05-09 02:30:21 +0000529int spi_chip_write_1(struct flashchip *flash, uint8_t *buf);
hailfinger87c05482009-05-09 02:34:18 +0000530int spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
hailfinger0f08b7a2009-06-16 08:55:44 +0000531int spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfinger3d77bc12009-05-01 12:22:17 +0000532uint8_t spi_read_status_register(void);
hailfingerc1b2e912008-11-18 00:41:02 +0000533int spi_disable_blockprotect(void);
hailfingerec9334b2009-07-12 12:06:18 +0000534int spi_byte_program(int addr, uint8_t byte);
535int spi_nbyte_program(int addr, uint8_t *bytes, int len);
536int spi_nbyte_read(int addr, uint8_t *bytes, int len);
hailfinger0f08b7a2009-06-16 08:55:44 +0000537int spi_read_chunked(struct flashchip *flash, uint8_t *buf, int start, int len, int chunksize);
stuge712ce862009-01-26 03:37:40 +0000538int spi_aai_write(struct flashchip *flash, uint8_t *buf);
hailfinger54c14662009-05-13 11:40:08 +0000539uint32_t spi_get_valid_read_addr(void);
hailfinger948b81f2009-07-22 15:36:50 +0000540int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
541 const unsigned char *writearr, unsigned char *readarr);
542int default_spi_send_multicommand(struct spi_command *spicommands);
ward11844452007-10-02 15:49:25 +0000543
uwe4529d202007-08-23 13:34:59 +0000544/* 82802ab.c */
uwe719e3ca2007-09-09 20:24:29 +0000545int probe_82802ab(struct flashchip *flash);
546int erase_82802ab(struct flashchip *flash);
547int write_82802ab(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000548
549/* am29f040b.c */
uwe719e3ca2007-09-09 20:24:29 +0000550int probe_29f040b(struct flashchip *flash);
551int erase_29f040b(struct flashchip *flash);
552int write_29f040b(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000553
uwe7a083f82009-06-14 21:53:26 +0000554/* pm29f002.c */
555int write_pm29f002(struct flashchip *flash, uint8_t *buf);
556
uweaf9b4df2008-09-26 13:19:02 +0000557/* en29f002a.c */
558int probe_en29f002a(struct flashchip *flash);
559int erase_en29f002a(struct flashchip *flash);
560int write_en29f002a(struct flashchip *flash, uint8_t *buf);
561
hailfinger82e7ddb2008-05-16 12:55:55 +0000562/* ichspi.c */
hailfinger3d77bc12009-05-01 12:22:17 +0000563int ich_init_opcodes(void);
hailfinger68002c22009-07-10 21:08:55 +0000564int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000565 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000566int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000567int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
hailfinger948b81f2009-07-22 15:36:50 +0000568int ich_spi_send_multicommand(struct spi_command *spicommands);
hailfinger82e7ddb2008-05-16 12:55:55 +0000569
hailfinger2c361e42008-05-13 23:03:12 +0000570/* it87spi.c */
571extern uint16_t it8716f_flashport;
hailfinger7bac0e52009-05-25 23:26:50 +0000572void enter_conf_mode_ite(uint16_t port);
573void exit_conf_mode_ite(uint16_t port);
hailfinger26e212b2009-05-31 18:00:57 +0000574int it87spi_init(void);
hailfinger82e7ddb2008-05-16 12:55:55 +0000575int it87xx_probe_spi_flash(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000576int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000577 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000578int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000579int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
hailfinger2c361e42008-05-13 23:03:12 +0000580
uwe17efbed2008-11-28 21:36:51 +0000581/* sb600spi.c */
hailfinger68002c22009-07-10 21:08:55 +0000582int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe17efbed2008-11-28 21:36:51 +0000583 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000584int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000585int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
hailfinger38da6812009-05-17 15:49:24 +0000586extern uint8_t *sb600_spibar;
uwe17efbed2008-11-28 21:36:51 +0000587
uwe4529d202007-08-23 13:34:59 +0000588/* jedec.c */
hailfinger79cf3672008-05-14 12:03:06 +0000589uint8_t oddparity(uint8_t val);
hailfinger82719632009-05-16 21:22:56 +0000590void toggle_ready_jedec(chipaddr dst);
591void data_polling_jedec(chipaddr dst, uint8_t data);
592void unprotect_jedec(chipaddr bios);
593void protect_jedec(chipaddr bios);
594int write_byte_program_jedec(chipaddr bios, uint8_t *src,
595 chipaddr dst);
uwe719e3ca2007-09-09 20:24:29 +0000596int probe_jedec(struct flashchip *flash);
597int erase_chip_jedec(struct flashchip *flash);
598int write_jedec(struct flashchip *flash, uint8_t *buf);
hailfinger7af83692009-06-15 17:23:36 +0000599int erase_sector_jedec(struct flashchip *flash, unsigned int page, int pagesize);
600int erase_block_jedec(struct flashchip *flash, unsigned int page, int blocksize);
hailfinger82719632009-05-16 21:22:56 +0000601int write_sector_jedec(chipaddr bios, uint8_t *src,
602 chipaddr dst, unsigned int page_size);
uwe4529d202007-08-23 13:34:59 +0000603
stugea0e346b2009-01-26 06:42:02 +0000604/* m29f002.c */
605int erase_m29f002(struct flashchip *flash);
606int write_m29f002t(struct flashchip *flash, uint8_t *buf);
607int write_m29f002b(struct flashchip *flash, uint8_t *buf);
608
uwe4529d202007-08-23 13:34:59 +0000609/* m29f400bt.c */
uwe719e3ca2007-09-09 20:24:29 +0000610int probe_m29f400bt(struct flashchip *flash);
611int erase_m29f400bt(struct flashchip *flash);
hailfinger7af83692009-06-15 17:23:36 +0000612int block_erase_m29f400bt(struct flashchip *flash, int start, int len);
uwe719e3ca2007-09-09 20:24:29 +0000613int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
stepan1037f6f2008-01-18 15:33:10 +0000614int write_coreboot_m29f400bt(struct flashchip *flash, uint8_t *buf);
hailfinger82719632009-05-16 21:22:56 +0000615void toggle_ready_m29f400bt(chipaddr dst);
616void data_polling_m29f400bt(chipaddr dst, uint8_t data);
617void protect_m29f400bt(chipaddr bios);
618void write_page_m29f400bt(chipaddr bios, uint8_t *src,
619 chipaddr dst, int page_size);
uwe4529d202007-08-23 13:34:59 +0000620
621/* mx29f002.c */
uwe719e3ca2007-09-09 20:24:29 +0000622int probe_29f002(struct flashchip *flash);
623int erase_29f002(struct flashchip *flash);
624int write_29f002(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000625
stuge54ca40a2008-05-17 01:08:58 +0000626/* pm49fl00x.c */
627int probe_49fl00x(struct flashchip *flash);
628int erase_49fl00x(struct flashchip *flash);
629int write_49fl00x(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000630
631/* sharplhf00l04.c */
uwe719e3ca2007-09-09 20:24:29 +0000632int probe_lhf00l04(struct flashchip *flash);
633int erase_lhf00l04(struct flashchip *flash);
634int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
hailfinger82719632009-05-16 21:22:56 +0000635void toggle_ready_lhf00l04(chipaddr dst);
636void data_polling_lhf00l04(chipaddr dst, uint8_t data);
637void protect_lhf00l04(chipaddr bios);
uwe4529d202007-08-23 13:34:59 +0000638
639/* sst28sf040.c */
uwe719e3ca2007-09-09 20:24:29 +0000640int probe_28sf040(struct flashchip *flash);
641int erase_28sf040(struct flashchip *flash);
642int write_28sf040(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000643
644/* sst39sf020.c */
uwe719e3ca2007-09-09 20:24:29 +0000645int probe_39sf020(struct flashchip *flash);
646int write_39sf020(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000647
648/* sst49lf040.c */
uwe719e3ca2007-09-09 20:24:29 +0000649int erase_49lf040(struct flashchip *flash);
650int write_49lf040(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000651
652/* sst49lfxxxc.c */
uwe719e3ca2007-09-09 20:24:29 +0000653int probe_49lfxxxc(struct flashchip *flash);
654int erase_49lfxxxc(struct flashchip *flash);
655int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000656
657/* sst_fwhub.c */
uwe719e3ca2007-09-09 20:24:29 +0000658int probe_sst_fwhub(struct flashchip *flash);
659int erase_sst_fwhub(struct flashchip *flash);
660int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000661
stugea1efa0e2008-07-21 17:48:40 +0000662/* w39v040c.c */
663int probe_w39v040c(struct flashchip *flash);
664int erase_w39v040c(struct flashchip *flash);
665int write_w39v040c(struct flashchip *flash, uint8_t *buf);
666
stepanb8361b92008-03-17 22:59:40 +0000667/* w39V080fa.c */
668int probe_winbond_fwhub(struct flashchip *flash);
669int erase_winbond_fwhub(struct flashchip *flash);
670int write_winbond_fwhub(struct flashchip *flash, uint8_t *buf);
671
uwe2d828942007-08-30 10:17:50 +0000672/* w29ee011.c */
uwe719e3ca2007-09-09 20:24:29 +0000673int probe_w29ee011(struct flashchip *flash);
uwe2d828942007-08-30 10:17:50 +0000674
uwe4529d202007-08-23 13:34:59 +0000675/* w49f002u.c */
uwe719e3ca2007-09-09 20:24:29 +0000676int write_49f002(struct flashchip *flash, uint8_t *buf);
stepan15e64bc2007-05-24 08:48:10 +0000677
stugea564bcf2009-01-26 03:08:45 +0000678/* wbsio_spi.c */
679int wbsio_check_for_spi(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000680int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe4e204a22009-05-28 15:07:42 +0000681 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000682int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000683int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
stugea564bcf2009-01-26 03:08:45 +0000684
stepan92251692008-04-28 17:51:09 +0000685/* stm50flw0x0x.c */
686int probe_stm50flw0x0x(struct flashchip *flash);
687int erase_stm50flw0x0x(struct flashchip *flash);
688int write_stm50flw0x0x(struct flashchip *flash, uint8_t *buf);
hailfinger82e7ddb2008-05-16 12:55:55 +0000689
hailfinger37b4fbf2009-06-23 11:33:43 +0000690/* serprog.c */
hailfinger37b4fbf2009-06-23 11:33:43 +0000691int serprog_init(void);
692int serprog_shutdown(void);
693void serprog_chip_writeb(uint8_t val, chipaddr addr);
694uint8_t serprog_chip_readb(const chipaddr addr);
695void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
696void serprog_delay(int delay);
uwe619a15a2009-06-28 23:26:37 +0000697
ollie5b621572004-03-20 16:46:10 +0000698#endif /* !__FLASH_H__ */