blob: a571be746923ad0a2b0c10be0354c786ced2701c [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,
85 PROGRAMMER_DUMMY,
86 PROGRAMMER_NIC3COM,
87 PROGRAMMER_SATASII,
88 PROGRAMMER_IT87SPI,
89 PROGRAMMER_FT2232SPI,
hailfinger74d88a72009-08-12 16:17:41 +000090#if SERPROG_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000091 PROGRAMMER_SERPROG,
hailfinger74d88a72009-08-12 16:17:41 +000092#endif
hailfinger3548a9a2009-08-12 14:34:35 +000093 PROGRAMMER_INVALID /* This must always be the last entry. */
hailfinger6fe23d62009-08-12 11:39:29 +000094};
95
96extern enum programmer programmer;
hailfingerabe249e2009-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
uwe4e204a22009-05-28 15:07:42 +0000105 void * (*map_flash_region) (const char *descr, unsigned long phys_addr,
106 size_t len);
hailfinger11ae3c42009-05-11 14:13:25 +0000107 void (*unmap_flash_region) (void *virt_addr, size_t len);
108
hailfinger82719632009-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);
hailfinger9d987ef2009-06-05 18:32:07 +0000112 void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-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);
hailfinger9d987ef2009-06-05 18:32:07 +0000116 void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +0000117 void (*delay) (int usecs);
hailfingerabe249e2009-05-08 17:43:22 +0000118};
119
120extern const struct programmer_entry programmer_table[];
121
uweabe92a52009-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);
hailfinger9d987ef2009-06-05 18:32:07 +0000130void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
uweabe92a52009-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);
hailfinger9d987ef2009-06-05 18:32:07 +0000134void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +0000135void programmer_delay(int usecs);
hailfingerba3761a2009-03-05 19:24:22 +0000136
uwe16f99092008-03-12 11:54:51 +0000137#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
138
hailfinger40167462009-05-31 17:57:34 +0000139enum chipbustype {
hailfinger668f3502009-06-01 00:02:11 +0000140 CHIP_BUSTYPE_NONE = 0,
hailfinger40167462009-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
rminnich8d3ff912003-10-25 17:01:29 +0000149struct flashchip {
uwedfcd15f2008-03-14 23:55:58 +0000150 const char *vendor;
uwe6ed6d952007-12-04 21:49:06 +0000151 const char *name;
hailfinger40167462009-05-31 17:57:34 +0000152
153 enum chipbustype bustype;
154
uwefa98ca12008-10-18 21:14:13 +0000155 /*
156 * With 32bit manufacture_id and model_id we can cover IDs up to
hailfinger428f2012007-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;
rminnich8d3ff912003-10-25 17:01:29 +0000162
rminnich8d3ff912003-10-25 17:01:29 +0000163 int total_size;
164 int page_size;
165
uwefa98ca12008-10-18 21:14:13 +0000166 /*
167 * Indicate if flashrom has been tested with this flash chip and if
stuge9cd64bd2008-05-03 04:34:37 +0000168 * everything worked correctly.
169 */
170 uint32_t tested;
171
uwe8e1a2ba2007-04-01 19:44:21 +0000172 int (*probe) (struct flashchip *flash);
hailfingerd5b35922009-06-03 14:46:22 +0000173
174 /* Delay after "enter/exit ID mode" commands in microseconds. */
175 int probe_timing;
uwe8e1a2ba2007-04-01 19:44:21 +0000176 int (*erase) (struct flashchip *flash);
177 int (*write) (struct flashchip *flash, uint8_t *buf);
hailfinger0f08b7a2009-06-16 08:55:44 +0000178 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
rminnich8d3ff912003-10-25 17:01:29 +0000179
uwe6ed6d952007-12-04 21:49:06 +0000180 /* Some flash devices have an additional register space. */
hailfinger82719632009-05-16 21:22:56 +0000181 chipaddr virtual_memory;
182 chipaddr virtual_registers;
rminnich8d3ff912003-10-25 17:01:29 +0000183};
184
stuge9cd64bd2008-05-03 04:34:37 +0000185#define TEST_UNTESTED 0
186
uwe4e204a22009-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)
stuge9cd64bd2008-05-03 04:34:37 +0000194#define TEST_OK_MASK 0x0f
195
uwe4e204a22009-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)
stuge9cd64bd2008-05-03 04:34:37 +0000201#define TEST_BAD_MASK 0xf0
202
hailfingerd5b35922009-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
ollie6a600992005-11-26 21:55:36 +0000213extern struct flashchip flashchips[];
214
uwe5f612c82009-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[];
uwefef723f2009-06-18 14:04:44 +0000260extern const struct board_info laptops_ok[];
261extern const struct board_info laptops_bad[];
uwe5f612c82009-05-16 23:42:17 +0000262
uwe6ed6d952007-12-04 21:49:06 +0000263/* udelay.c */
hailfingere5829f62009-06-05 17:48:08 +0000264void myusec_delay(int usecs);
hailfinger3d77bc12009-05-01 12:22:17 +0000265void myusec_calibrate_delay(void);
stepan927d4e22007-04-04 22:45:58 +0000266
uwea3a82c92009-05-15 17:02:34 +0000267/* pcidev.c */
268#define PCI_OK 0
269#define PCI_NT 1 /* Not tested */
ruikda922a12009-05-17 19:39:27 +0000270
uwea3a82c92009-05-15 17:02:34 +0000271extern uint32_t io_base_addr;
272extern struct pci_access *pacc;
273extern struct pci_filter filter;
uweb3a82ef2009-05-16 21:39:19 +0000274extern struct pci_dev *pcidev_dev;
uwea3a82c92009-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);
hailfinger4f45a4f2009-08-12 13:32:56 +0000283uint32_t pcidev_init(uint16_t vendor_id, struct pcidev_status *devs, char *pcidev_bdf);
uwe884cc8b2009-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);
uwea3a82c92009-05-15 17:02:34 +0000290void print_supported_pcidevs(struct pcidev_status *devs);
uwe488f0842009-06-20 01:21:38 +0000291void print_wiki_tables(void);
uwea3a82c92009-05-15 17:02:34 +0000292
uwe6ed6d952007-12-04 21:49:06 +0000293/* board_enable.c */
stugeaa35d392009-01-26 02:34:51 +0000294void w836xx_ext_enter(uint16_t port);
295void w836xx_ext_leave(uint16_t port);
hailfinger7bac0e52009-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);
uwe6ed6d952007-12-04 21:49:06 +0000299int board_flash_enable(const char *vendor, const char *part);
stepan5c3f1382007-02-06 19:47:50 +0000300
uwe6ed6d952007-12-04 21:49:06 +0000301/* chipset_enable.c */
hailfinger40167462009-05-31 17:57:34 +0000302extern enum chipbustype buses_supported;
uwe6ed6d952007-12-04 21:49:06 +0000303int chipset_flash_enable(void);
stepan3bdf6182008-06-30 23:45:22 +0000304
stuge12ac08f2008-12-03 21:24:40 +0000305extern unsigned long flashbase;
306
stuge7c943ee2009-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);
stepan6d42c0f2009-08-12 09:27:45 +0000310int setup_cpu_msr(int cpu);
311void cleanup_cpu_msr(void);
hailfinger2cff9a72009-08-19 10:46:23 +0000312#if !defined(__DARWIN__) && !defined(__FreeBSD__) && !defined(__DragonFly__)
stepan6d42c0f2009-08-12 09:27:45 +0000313typedef struct { uint32_t hi, lo; } msr_t;
314msr_t rdmsr(int addr);
315int wrmsr(int addr, msr_t msr);
316#endif
hailfinger2cff9a72009-08-19 10:46:23 +0000317#if defined(__FreeBSD__) || defined(__DragonFly__)
318/* FreeBSD already has conflicting definitions for wrmsr/rdmsr. */
319#undef rdmsr
320#undef wrmsr
321#define rdmsr freebsd_rdmsr
322#define wrmsr freebsd_wrmsr
323typedef struct { uint32_t hi, lo; } msr_t;
324msr_t freebsd_rdmsr(int addr);
325int freebsd_wrmsr(int addr, msr_t msr);
326#endif
stuge7c943ee2009-01-26 01:10:48 +0000327
hailfingerabe249e2009-05-08 17:43:22 +0000328/* internal.c */
uwe57195ba2009-05-16 22:05:42 +0000329struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
330struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
331struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
332 uint16_t card_vendor, uint16_t card_device);
hailfinger0668eba2009-05-14 21:41:10 +0000333void get_io_perms(void);
hailfinger7828d092009-08-09 21:50:24 +0000334void release_io_perms(void);
hailfingerabe249e2009-05-08 17:43:22 +0000335int internal_init(void);
336int internal_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000337void internal_chip_writeb(uint8_t val, chipaddr addr);
338void internal_chip_writew(uint16_t val, chipaddr addr);
339void internal_chip_writel(uint32_t val, chipaddr addr);
340uint8_t internal_chip_readb(const chipaddr addr);
341uint16_t internal_chip_readw(const chipaddr addr);
342uint32_t internal_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000343void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger38da6812009-05-17 15:49:24 +0000344void mmio_writeb(uint8_t val, void *addr);
345void mmio_writew(uint16_t val, void *addr);
346void mmio_writel(uint32_t val, void *addr);
347uint8_t mmio_readb(void *addr);
348uint16_t mmio_readw(void *addr);
349uint32_t mmio_readl(void *addr);
hailfingere5829f62009-06-05 17:48:08 +0000350void internal_delay(int usecs);
hailfinger6fe23d62009-08-12 11:39:29 +0000351int fallback_shutdown(void);
uwe3e656bd2009-05-17 23:12:17 +0000352void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
353void fallback_unmap(void *virt_addr, size_t len);
hailfinger6fe23d62009-08-12 11:39:29 +0000354void fallback_chip_writeb(uint8_t val, chipaddr addr);
hailfinger82719632009-05-16 21:22:56 +0000355void fallback_chip_writew(uint16_t val, chipaddr addr);
356void fallback_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000357void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000358uint16_t fallback_chip_readw(const chipaddr addr);
359uint32_t fallback_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000360void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
uwebc526c82009-05-14 20:41:57 +0000361#if defined(__FreeBSD__) || defined(__DragonFly__)
362extern int io_fd;
363#endif
hailfingerabe249e2009-05-08 17:43:22 +0000364
hailfingera9df33c2009-05-09 00:54:55 +0000365/* dummyflasher.c */
366int dummy_init(void);
367int dummy_shutdown(void);
hailfinger11ae3c42009-05-11 14:13:25 +0000368void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
369void dummy_unmap(void *virt_addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000370void dummy_chip_writeb(uint8_t val, chipaddr addr);
371void dummy_chip_writew(uint16_t val, chipaddr addr);
372void dummy_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000373void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000374uint8_t dummy_chip_readb(const chipaddr addr);
375uint16_t dummy_chip_readw(const chipaddr addr);
376uint32_t dummy_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000377void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger68002c22009-07-10 21:08:55 +0000378int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
hailfingerf91e3b52009-05-14 12:59:36 +0000379 const unsigned char *writearr, unsigned char *readarr);
hailfingera9df33c2009-05-09 00:54:55 +0000380
uwe0f5a3a22009-05-13 11:36:06 +0000381/* nic3com.c */
382int nic3com_init(void);
383int nic3com_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000384void nic3com_chip_writeb(uint8_t val, chipaddr addr);
385uint8_t nic3com_chip_readb(const chipaddr addr);
uwea3a82c92009-05-15 17:02:34 +0000386extern struct pcidev_status nics_3com[];
uwe0f5a3a22009-05-13 11:36:06 +0000387
ruikda922a12009-05-17 19:39:27 +0000388/* satasii.c */
389int satasii_init(void);
390int satasii_shutdown(void);
ruikda922a12009-05-17 19:39:27 +0000391void satasii_chip_writeb(uint8_t val, chipaddr addr);
392uint8_t satasii_chip_readb(const chipaddr addr);
393extern struct pcidev_status satas_sii[];
394
hailfingerf31da3d2009-06-16 21:08:06 +0000395/* ft2232_spi.c */
hailfingere98628b2009-07-01 00:02:23 +0000396#define FTDI_FT2232H 0x6010
397#define FTDI_FT4232H 0x6011
hailfingerf31da3d2009-06-16 21:08:06 +0000398int ft2232_spi_init(void);
hailfinger68002c22009-07-10 21:08:55 +0000399int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
hailfingerf31da3d2009-06-16 21:08:06 +0000400int ft2232_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingerf31da3d2009-06-16 21:08:06 +0000401int ft2232_spi_write_256(struct flashchip *flash, uint8_t *buf);
402
uwe4529d202007-08-23 13:34:59 +0000403/* flashrom.c */
hailfinger4f45a4f2009-08-12 13:32:56 +0000404extern char *programmer_param;
uwee06bcf82009-04-24 16:17:41 +0000405extern int verbose;
hailfinger2d83b5b2009-07-22 20:13:00 +0000406extern const char *flashrom_version;
uwee06bcf82009-04-24 16:17:41 +0000407#define printf_debug(x...) { if (verbose) printf(x); }
stuge5ff0e6c2009-01-26 00:39:57 +0000408void map_flash_registers(struct flashchip *flash);
hailfinger0f08b7a2009-06-16 08:55:44 +0000409int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfinger7b414742009-06-13 12:04:03 +0000410int min(int a, int b);
hailfinger7af83692009-06-15 17:23:36 +0000411int max(int a, int b);
412int check_erased_range(struct flashchip *flash, int start, int len);
413int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
uwe884cc8b2009-06-17 12:07:12 +0000414char *strcat_realloc(char *dest, const char *src);
415
416#define OK 0
417#define NT 1 /* Not tested */
uwe4529d202007-08-23 13:34:59 +0000418
419/* layout.c */
stuge98c09aa2008-06-18 02:08:40 +0000420int show_id(uint8_t *bios, int size, int force);
uwe4529d202007-08-23 13:34:59 +0000421int read_romlayout(char *name);
422int find_romentry(char *name);
423int handle_romentries(uint8_t *buffer, uint8_t *content);
424
uwee06bcf82009-04-24 16:17:41 +0000425/* cbtable.c */
stepan1037f6f2008-01-18 15:33:10 +0000426int coreboot_init(void);
uwe4529d202007-08-23 13:34:59 +0000427extern char *lb_part, *lb_vendor;
stepan3370c892009-07-30 13:30:17 +0000428extern int partvendor_from_cbtable;
uwe4529d202007-08-23 13:34:59 +0000429
stepan745615e2007-10-15 21:44:47 +0000430/* spi.c */
hailfinger40167462009-05-31 17:57:34 +0000431enum spi_controller {
432 SPI_CONTROLLER_NONE,
433 SPI_CONTROLLER_ICH7,
434 SPI_CONTROLLER_ICH9,
435 SPI_CONTROLLER_IT87XX,
436 SPI_CONTROLLER_SB600,
437 SPI_CONTROLLER_VIA,
438 SPI_CONTROLLER_WBSIO,
hailfingerf31da3d2009-06-16 21:08:06 +0000439 SPI_CONTROLLER_FT2232,
hailfinger40167462009-05-31 17:57:34 +0000440 SPI_CONTROLLER_DUMMY,
441};
hailfinger68002c22009-07-10 21:08:55 +0000442struct spi_command {
443 unsigned int writecnt;
444 unsigned int readcnt;
445 const unsigned char *writearr;
446 unsigned char *readarr;
447};
hailfinger948b81f2009-07-22 15:36:50 +0000448struct spi_programmer {
449 int (*command)(unsigned int writecnt, unsigned int readcnt,
450 const unsigned char *writearr, unsigned char *readarr);
451 int (*multicommand)(struct spi_command *spicommands);
452
453 /* Optimized functions for this programmer */
454 int (*read)(struct flashchip *flash, uint8_t *buf, int start, int len);
455 int (*write_256)(struct flashchip *flash, uint8_t *buf);
456};
hailfinger68002c22009-07-10 21:08:55 +0000457
hailfinger40167462009-05-31 17:57:34 +0000458extern enum spi_controller spi_controller;
hailfinger948b81f2009-07-22 15:36:50 +0000459extern const struct spi_programmer spi_programmer[];
hailfinger40167462009-05-31 17:57:34 +0000460extern void *spibar;
hailfinger82893122008-05-15 03:19:49 +0000461int probe_spi_rdid(struct flashchip *flash);
ruikdbe18ee2008-06-30 21:45:17 +0000462int probe_spi_rdid4(struct flashchip *flash);
hailfinger3dd0c3e2008-11-28 01:25:00 +0000463int probe_spi_rems(struct flashchip *flash);
hailfinger82893122008-05-15 03:19:49 +0000464int probe_spi_res(struct flashchip *flash);
hailfinger68002c22009-07-10 21:08:55 +0000465int spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000466 const unsigned char *writearr, unsigned char *readarr);
hailfinger68002c22009-07-10 21:08:55 +0000467int spi_send_multicommand(struct spi_command *spicommands);
hailfinger3d77bc12009-05-01 12:22:17 +0000468int spi_write_enable(void);
469int spi_write_disable(void);
hailfingerffcf81a2008-11-03 00:02:11 +0000470int spi_chip_erase_60(struct flashchip *flash);
stuge2bb6ab32008-05-10 23:07:52 +0000471int spi_chip_erase_c7(struct flashchip *flash);
hailfingerc1b2e912008-11-18 00:41:02 +0000472int spi_chip_erase_60_c7(struct flashchip *flash);
stepan0f7bff02008-10-29 22:13:20 +0000473int spi_chip_erase_d8(struct flashchip *flash);
hailfingera1289042009-06-24 08:28:39 +0000474int spi_block_erase_20(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
475int spi_block_erase_52(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
476int spi_block_erase_d8(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
477int spi_block_erase_60(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
478int spi_block_erase_c7(struct flashchip *flash, unsigned int addr, unsigned int blocklen);
hailfingered063f52009-05-09 02:30:21 +0000479int spi_chip_write_1(struct flashchip *flash, uint8_t *buf);
hailfinger87c05482009-05-09 02:34:18 +0000480int spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
hailfinger0f08b7a2009-06-16 08:55:44 +0000481int spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfinger3d77bc12009-05-01 12:22:17 +0000482uint8_t spi_read_status_register(void);
hailfingerc1b2e912008-11-18 00:41:02 +0000483int spi_disable_blockprotect(void);
hailfingerec9334b2009-07-12 12:06:18 +0000484int spi_byte_program(int addr, uint8_t byte);
485int spi_nbyte_program(int addr, uint8_t *bytes, int len);
486int spi_nbyte_read(int addr, uint8_t *bytes, int len);
hailfinger0f08b7a2009-06-16 08:55:44 +0000487int spi_read_chunked(struct flashchip *flash, uint8_t *buf, int start, int len, int chunksize);
stuge712ce862009-01-26 03:37:40 +0000488int spi_aai_write(struct flashchip *flash, uint8_t *buf);
hailfinger54c14662009-05-13 11:40:08 +0000489uint32_t spi_get_valid_read_addr(void);
hailfinger948b81f2009-07-22 15:36:50 +0000490int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
491 const unsigned char *writearr, unsigned char *readarr);
492int default_spi_send_multicommand(struct spi_command *spicommands);
ward11844452007-10-02 15:49:25 +0000493
uwe4529d202007-08-23 13:34:59 +0000494/* 82802ab.c */
uwe719e3ca2007-09-09 20:24:29 +0000495int probe_82802ab(struct flashchip *flash);
496int erase_82802ab(struct flashchip *flash);
497int write_82802ab(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000498
499/* am29f040b.c */
uwe719e3ca2007-09-09 20:24:29 +0000500int probe_29f040b(struct flashchip *flash);
501int erase_29f040b(struct flashchip *flash);
502int write_29f040b(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000503
uwe7a083f82009-06-14 21:53:26 +0000504/* pm29f002.c */
505int write_pm29f002(struct flashchip *flash, uint8_t *buf);
506
uweaf9b4df2008-09-26 13:19:02 +0000507/* en29f002a.c */
508int probe_en29f002a(struct flashchip *flash);
509int erase_en29f002a(struct flashchip *flash);
510int write_en29f002a(struct flashchip *flash, uint8_t *buf);
511
hailfinger82e7ddb2008-05-16 12:55:55 +0000512/* ichspi.c */
hailfinger3d77bc12009-05-01 12:22:17 +0000513int ich_init_opcodes(void);
hailfinger68002c22009-07-10 21:08:55 +0000514int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000515 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000516int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000517int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
hailfinger948b81f2009-07-22 15:36:50 +0000518int ich_spi_send_multicommand(struct spi_command *spicommands);
hailfinger82e7ddb2008-05-16 12:55:55 +0000519
hailfinger2c361e42008-05-13 23:03:12 +0000520/* it87spi.c */
521extern uint16_t it8716f_flashport;
hailfinger7bac0e52009-05-25 23:26:50 +0000522void enter_conf_mode_ite(uint16_t port);
523void exit_conf_mode_ite(uint16_t port);
hailfinger26e212b2009-05-31 18:00:57 +0000524int it87spi_init(void);
hailfinger82e7ddb2008-05-16 12:55:55 +0000525int it87xx_probe_spi_flash(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000526int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000527 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000528int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000529int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
hailfinger2c361e42008-05-13 23:03:12 +0000530
uwe17efbed2008-11-28 21:36:51 +0000531/* sb600spi.c */
hailfinger68002c22009-07-10 21:08:55 +0000532int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe17efbed2008-11-28 21:36:51 +0000533 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000534int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000535int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
hailfinger38da6812009-05-17 15:49:24 +0000536extern uint8_t *sb600_spibar;
uwe17efbed2008-11-28 21:36:51 +0000537
uwe4529d202007-08-23 13:34:59 +0000538/* jedec.c */
hailfinger79cf3672008-05-14 12:03:06 +0000539uint8_t oddparity(uint8_t val);
hailfinger82719632009-05-16 21:22:56 +0000540void toggle_ready_jedec(chipaddr dst);
541void data_polling_jedec(chipaddr dst, uint8_t data);
542void unprotect_jedec(chipaddr bios);
543void protect_jedec(chipaddr bios);
544int write_byte_program_jedec(chipaddr bios, uint8_t *src,
545 chipaddr dst);
uwe719e3ca2007-09-09 20:24:29 +0000546int probe_jedec(struct flashchip *flash);
547int erase_chip_jedec(struct flashchip *flash);
548int write_jedec(struct flashchip *flash, uint8_t *buf);
hailfinger7af83692009-06-15 17:23:36 +0000549int erase_sector_jedec(struct flashchip *flash, unsigned int page, int pagesize);
550int erase_block_jedec(struct flashchip *flash, unsigned int page, int blocksize);
hailfinger82719632009-05-16 21:22:56 +0000551int write_sector_jedec(chipaddr bios, uint8_t *src,
552 chipaddr dst, unsigned int page_size);
uwe4529d202007-08-23 13:34:59 +0000553
stugea0e346b2009-01-26 06:42:02 +0000554/* m29f002.c */
555int erase_m29f002(struct flashchip *flash);
556int write_m29f002t(struct flashchip *flash, uint8_t *buf);
557int write_m29f002b(struct flashchip *flash, uint8_t *buf);
558
uwe4529d202007-08-23 13:34:59 +0000559/* m29f400bt.c */
uwe719e3ca2007-09-09 20:24:29 +0000560int probe_m29f400bt(struct flashchip *flash);
561int erase_m29f400bt(struct flashchip *flash);
hailfinger7af83692009-06-15 17:23:36 +0000562int block_erase_m29f400bt(struct flashchip *flash, int start, int len);
uwe719e3ca2007-09-09 20:24:29 +0000563int write_m29f400bt(struct flashchip *flash, uint8_t *buf);
stepan1037f6f2008-01-18 15:33:10 +0000564int write_coreboot_m29f400bt(struct flashchip *flash, uint8_t *buf);
hailfinger82719632009-05-16 21:22:56 +0000565void toggle_ready_m29f400bt(chipaddr dst);
566void data_polling_m29f400bt(chipaddr dst, uint8_t data);
567void protect_m29f400bt(chipaddr bios);
568void write_page_m29f400bt(chipaddr bios, uint8_t *src,
569 chipaddr dst, int page_size);
uwe4529d202007-08-23 13:34:59 +0000570
571/* mx29f002.c */
uwe719e3ca2007-09-09 20:24:29 +0000572int probe_29f002(struct flashchip *flash);
573int erase_29f002(struct flashchip *flash);
574int write_29f002(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000575
stuge54ca40a2008-05-17 01:08:58 +0000576/* pm49fl00x.c */
577int probe_49fl00x(struct flashchip *flash);
578int erase_49fl00x(struct flashchip *flash);
579int write_49fl00x(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000580
581/* sharplhf00l04.c */
uwe719e3ca2007-09-09 20:24:29 +0000582int probe_lhf00l04(struct flashchip *flash);
583int erase_lhf00l04(struct flashchip *flash);
584int write_lhf00l04(struct flashchip *flash, uint8_t *buf);
hailfinger82719632009-05-16 21:22:56 +0000585void toggle_ready_lhf00l04(chipaddr dst);
586void data_polling_lhf00l04(chipaddr dst, uint8_t data);
587void protect_lhf00l04(chipaddr bios);
uwe4529d202007-08-23 13:34:59 +0000588
589/* sst28sf040.c */
uwe719e3ca2007-09-09 20:24:29 +0000590int probe_28sf040(struct flashchip *flash);
591int erase_28sf040(struct flashchip *flash);
592int write_28sf040(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000593
594/* sst39sf020.c */
uwe719e3ca2007-09-09 20:24:29 +0000595int probe_39sf020(struct flashchip *flash);
596int write_39sf020(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000597
598/* sst49lf040.c */
uwe719e3ca2007-09-09 20:24:29 +0000599int erase_49lf040(struct flashchip *flash);
600int write_49lf040(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000601
602/* sst49lfxxxc.c */
uwe719e3ca2007-09-09 20:24:29 +0000603int probe_49lfxxxc(struct flashchip *flash);
604int erase_49lfxxxc(struct flashchip *flash);
605int write_49lfxxxc(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000606
607/* sst_fwhub.c */
uwe719e3ca2007-09-09 20:24:29 +0000608int probe_sst_fwhub(struct flashchip *flash);
609int erase_sst_fwhub(struct flashchip *flash);
610int write_sst_fwhub(struct flashchip *flash, uint8_t *buf);
uwe4529d202007-08-23 13:34:59 +0000611
stugea1efa0e2008-07-21 17:48:40 +0000612/* w39v040c.c */
613int probe_w39v040c(struct flashchip *flash);
614int erase_w39v040c(struct flashchip *flash);
615int write_w39v040c(struct flashchip *flash, uint8_t *buf);
616
stepanb8361b92008-03-17 22:59:40 +0000617/* w39V080fa.c */
618int probe_winbond_fwhub(struct flashchip *flash);
619int erase_winbond_fwhub(struct flashchip *flash);
620int write_winbond_fwhub(struct flashchip *flash, uint8_t *buf);
621
uwe2d828942007-08-30 10:17:50 +0000622/* w29ee011.c */
uwe719e3ca2007-09-09 20:24:29 +0000623int probe_w29ee011(struct flashchip *flash);
uwe2d828942007-08-30 10:17:50 +0000624
uwe4529d202007-08-23 13:34:59 +0000625/* w49f002u.c */
uwe719e3ca2007-09-09 20:24:29 +0000626int write_49f002(struct flashchip *flash, uint8_t *buf);
stepan15e64bc2007-05-24 08:48:10 +0000627
stugea564bcf2009-01-26 03:08:45 +0000628/* wbsio_spi.c */
629int wbsio_check_for_spi(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000630int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe4e204a22009-05-28 15:07:42 +0000631 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000632int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000633int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
stugea564bcf2009-01-26 03:08:45 +0000634
stepan92251692008-04-28 17:51:09 +0000635/* stm50flw0x0x.c */
636int probe_stm50flw0x0x(struct flashchip *flash);
637int erase_stm50flw0x0x(struct flashchip *flash);
638int write_stm50flw0x0x(struct flashchip *flash, uint8_t *buf);
hailfinger82e7ddb2008-05-16 12:55:55 +0000639
hailfinger37b4fbf2009-06-23 11:33:43 +0000640/* serprog.c */
hailfinger37b4fbf2009-06-23 11:33:43 +0000641int serprog_init(void);
642int serprog_shutdown(void);
643void serprog_chip_writeb(uint8_t val, chipaddr addr);
644uint8_t serprog_chip_readb(const chipaddr addr);
645void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
646void serprog_delay(int delay);
uwe619a15a2009-06-28 23:26:37 +0000647
ollie5b621572004-03-20 16:46:10 +0000648#endif /* !__FLASH_H__ */