blob: 1474a388efb123826673797cbe08cb3ec6a81294 [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
rminnich8d3ff912003-10-25 17:01:29 +000027#include <unistd.h>
ollie6a600992005-11-26 21:55:36 +000028#include <stdint.h>
uwe4529d202007-08-23 13:34:59 +000029#include <stdio.h>
hailfinger088dc812009-12-14 03:32:24 +000030#include "hwaccess.h"
oxygene3ad3b332010-01-06 22:14:39 +000031#ifdef _WIN32
32#include <windows.h>
33#undef min
34#undef max
35#endif
hailfingere1f062f2008-05-22 13:22:45 +000036
hailfinger82719632009-05-16 21:22:56 +000037typedef unsigned long chipaddr;
38
hailfinger6fe23d62009-08-12 11:39:29 +000039enum programmer {
hailfinger80422e22009-12-13 22:28:00 +000040#if INTERNAL_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000041 PROGRAMMER_INTERNAL,
hailfinger80422e22009-12-13 22:28:00 +000042#endif
hailfinger571a6b32009-09-16 10:09:21 +000043#if DUMMY_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000044 PROGRAMMER_DUMMY,
hailfinger571a6b32009-09-16 10:09:21 +000045#endif
46#if NIC3COM_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000047 PROGRAMMER_NIC3COM,
hailfinger571a6b32009-09-16 10:09:21 +000048#endif
uweff4576d2009-09-30 18:29:55 +000049#if GFXNVIDIA_SUPPORT == 1
50 PROGRAMMER_GFXNVIDIA,
51#endif
hailfinger571a6b32009-09-16 10:09:21 +000052#if DRKAISER_SUPPORT == 1
uwee2f95ef2009-09-02 23:00:46 +000053 PROGRAMMER_DRKAISER,
hailfinger571a6b32009-09-16 10:09:21 +000054#endif
55#if SATASII_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000056 PROGRAMMER_SATASII,
hailfinger571a6b32009-09-16 10:09:21 +000057#endif
hailfinger80422e22009-12-13 22:28:00 +000058#if INTERNAL_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000059 PROGRAMMER_IT87SPI,
hailfinger80422e22009-12-13 22:28:00 +000060#endif
hailfingerd9dcfbd2009-08-19 13:27:58 +000061#if FT2232_SPI_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000062 PROGRAMMER_FT2232SPI,
hailfingerd9dcfbd2009-08-19 13:27:58 +000063#endif
hailfinger74d88a72009-08-12 16:17:41 +000064#if SERPROG_SUPPORT == 1
hailfinger6fe23d62009-08-12 11:39:29 +000065 PROGRAMMER_SERPROG,
hailfinger74d88a72009-08-12 16:17:41 +000066#endif
hailfinger9c5add72009-11-24 00:20:03 +000067#if BUSPIRATE_SPI_SUPPORT == 1
68 PROGRAMMER_BUSPIRATESPI,
69#endif
hailfingerdfb32a02010-01-19 11:15:48 +000070#if DEDIPROG_SUPPORT == 1
71 PROGRAMMER_DEDIPROG,
72#endif
hailfinger3548a9a2009-08-12 14:34:35 +000073 PROGRAMMER_INVALID /* This must always be the last entry. */
hailfinger6fe23d62009-08-12 11:39:29 +000074};
75
76extern enum programmer programmer;
hailfingerabe249e2009-05-08 17:43:22 +000077
78struct programmer_entry {
79 const char *vendor;
80 const char *name;
81
82 int (*init) (void);
83 int (*shutdown) (void);
84
uwe4e204a22009-05-28 15:07:42 +000085 void * (*map_flash_region) (const char *descr, unsigned long phys_addr,
86 size_t len);
hailfinger11ae3c42009-05-11 14:13:25 +000087 void (*unmap_flash_region) (void *virt_addr, size_t len);
88
hailfinger82719632009-05-16 21:22:56 +000089 void (*chip_writeb) (uint8_t val, chipaddr addr);
90 void (*chip_writew) (uint16_t val, chipaddr addr);
91 void (*chip_writel) (uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +000092 void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +000093 uint8_t (*chip_readb) (const chipaddr addr);
94 uint16_t (*chip_readw) (const chipaddr addr);
95 uint32_t (*chip_readl) (const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +000096 void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +000097 void (*delay) (int usecs);
hailfingerabe249e2009-05-08 17:43:22 +000098};
99
100extern const struct programmer_entry programmer_table[];
101
hailfingerdc6f7972010-02-14 01:20:28 +0000102int register_shutdown(void (*function) (void *data), void *data);
103
uweabe92a52009-05-16 22:36:00 +0000104int programmer_init(void);
105int programmer_shutdown(void);
106void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
107 size_t len);
108void programmer_unmap_flash_region(void *virt_addr, size_t len);
109void chip_writeb(uint8_t val, chipaddr addr);
110void chip_writew(uint16_t val, chipaddr addr);
111void chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000112void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
uweabe92a52009-05-16 22:36:00 +0000113uint8_t chip_readb(const chipaddr addr);
114uint16_t chip_readw(const chipaddr addr);
115uint32_t chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000116void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +0000117void programmer_delay(int usecs);
hailfingerba3761a2009-03-05 19:24:22 +0000118
hailfinger8e278892009-10-01 14:51:25 +0000119enum bitbang_spi_master {
120 BITBANG_SPI_INVALID /* This must always be the last entry. */
hailfingeracce2df2009-09-28 13:15:16 +0000121};
122
hailfinger8e278892009-10-01 14:51:25 +0000123extern const int bitbang_spi_master_count;
hailfingeracce2df2009-09-28 13:15:16 +0000124
hailfinger8e278892009-10-01 14:51:25 +0000125extern enum bitbang_spi_master bitbang_spi_master;
hailfingeracce2df2009-09-28 13:15:16 +0000126
hailfinger8e278892009-10-01 14:51:25 +0000127struct bitbang_spi_master_entry {
hailfingeracce2df2009-09-28 13:15:16 +0000128 void (*set_cs) (int val);
129 void (*set_sck) (int val);
130 void (*set_mosi) (int val);
131 int (*get_miso) (void);
132};
133
uwe16f99092008-03-12 11:54:51 +0000134#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
135
hailfinger40167462009-05-31 17:57:34 +0000136enum chipbustype {
hailfinger668f3502009-06-01 00:02:11 +0000137 CHIP_BUSTYPE_NONE = 0,
hailfinger40167462009-05-31 17:57:34 +0000138 CHIP_BUSTYPE_PARALLEL = 1 << 0,
139 CHIP_BUSTYPE_LPC = 1 << 1,
140 CHIP_BUSTYPE_FWH = 1 << 2,
141 CHIP_BUSTYPE_SPI = 1 << 3,
142 CHIP_BUSTYPE_NONSPI = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH,
143 CHIP_BUSTYPE_UNKNOWN = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH | CHIP_BUSTYPE_SPI,
144};
145
hailfinger7df21362009-09-05 02:30:58 +0000146/*
147 * How many different contiguous runs of erase blocks with one size each do
148 * we have for a given erase function?
149 */
150#define NUM_ERASEREGIONS 5
151
152/*
153 * How many different erase functions do we have per chip?
154 */
155#define NUM_ERASEFUNCTIONS 5
156
hailfinger80dea312010-01-09 03:15:50 +0000157#define FEATURE_REGISTERMAP (1 << 0)
158#define FEATURE_BYTEWRITES (1 << 1)
snelsonc6855342010-01-28 23:55:12 +0000159#define FEATURE_LONG_RESET (0 << 4)
160#define FEATURE_SHORT_RESET (1 << 4)
161#define FEATURE_EITHER_RESET FEATURE_LONG_RESET
hailfinger80dea312010-01-09 03:15:50 +0000162#define FEATURE_ADDR_FULL (0 << 2)
163#define FEATURE_ADDR_MASK (3 << 2)
snelsonc6855342010-01-28 23:55:12 +0000164#define FEATURE_ADDR_2AA (1 << 2)
165#define FEATURE_ADDR_AAA (2 << 2)
166#define FEATURE_ADDR_SHIFTED 0
snelson63133f92010-01-04 17:15:23 +0000167
rminnich8d3ff912003-10-25 17:01:29 +0000168struct flashchip {
uwedfcd15f2008-03-14 23:55:58 +0000169 const char *vendor;
uwe6ed6d952007-12-04 21:49:06 +0000170 const char *name;
hailfinger40167462009-05-31 17:57:34 +0000171
172 enum chipbustype bustype;
173
uwefa98ca12008-10-18 21:14:13 +0000174 /*
175 * With 32bit manufacture_id and model_id we can cover IDs up to
hailfinger428f2012007-12-31 01:49:00 +0000176 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
177 * Identification code.
178 */
179 uint32_t manufacture_id;
180 uint32_t model_id;
rminnich8d3ff912003-10-25 17:01:29 +0000181
rminnich8d3ff912003-10-25 17:01:29 +0000182 int total_size;
183 int page_size;
snelson63133f92010-01-04 17:15:23 +0000184 int feature_bits;
rminnich8d3ff912003-10-25 17:01:29 +0000185
uwefa98ca12008-10-18 21:14:13 +0000186 /*
187 * Indicate if flashrom has been tested with this flash chip and if
stuge9cd64bd2008-05-03 04:34:37 +0000188 * everything worked correctly.
189 */
190 uint32_t tested;
191
uwe8e1a2ba2007-04-01 19:44:21 +0000192 int (*probe) (struct flashchip *flash);
hailfingerd5b35922009-06-03 14:46:22 +0000193
194 /* Delay after "enter/exit ID mode" commands in microseconds. */
195 int probe_timing;
hailfinger7df21362009-09-05 02:30:58 +0000196
197 /*
hailfingerc4fac582009-12-22 13:04:53 +0000198 * Erase blocks and associated erase function. Any chip erase function
199 * is stored as chip-sized virtual block together with said function.
hailfinger7df21362009-09-05 02:30:58 +0000200 */
201 struct block_eraser {
202 struct eraseblock{
203 unsigned int size; /* Eraseblock size */
204 unsigned int count; /* Number of contiguous blocks with that size */
205 } eraseblocks[NUM_ERASEREGIONS];
206 int (*block_erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
207 } block_erasers[NUM_ERASEFUNCTIONS];
208
uwe8e1a2ba2007-04-01 19:44:21 +0000209 int (*write) (struct flashchip *flash, uint8_t *buf);
hailfinger0f08b7a2009-06-16 08:55:44 +0000210 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
rminnich8d3ff912003-10-25 17:01:29 +0000211
uwe6ed6d952007-12-04 21:49:06 +0000212 /* Some flash devices have an additional register space. */
hailfinger82719632009-05-16 21:22:56 +0000213 chipaddr virtual_memory;
214 chipaddr virtual_registers;
rminnich8d3ff912003-10-25 17:01:29 +0000215};
216
stuge9cd64bd2008-05-03 04:34:37 +0000217#define TEST_UNTESTED 0
218
uwe4e204a22009-05-28 15:07:42 +0000219#define TEST_OK_PROBE (1 << 0)
220#define TEST_OK_READ (1 << 1)
221#define TEST_OK_ERASE (1 << 2)
222#define TEST_OK_WRITE (1 << 3)
223#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
224#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
hailfinger80f48682009-09-23 22:01:33 +0000225#define TEST_OK_PRW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
uwe4e204a22009-05-28 15:07:42 +0000226#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
stuge9cd64bd2008-05-03 04:34:37 +0000227#define TEST_OK_MASK 0x0f
228
uwe4e204a22009-05-28 15:07:42 +0000229#define TEST_BAD_PROBE (1 << 4)
230#define TEST_BAD_READ (1 << 5)
231#define TEST_BAD_ERASE (1 << 6)
232#define TEST_BAD_WRITE (1 << 7)
233#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
stuge9cd64bd2008-05-03 04:34:37 +0000234#define TEST_BAD_MASK 0xf0
235
hailfingerd5b35922009-06-03 14:46:22 +0000236/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
237 * field and zero delay.
238 *
239 * SPI devices will always have zero delay and ignore this field.
240 */
241#define TIMING_FIXME -1
242/* this is intentionally same value as fixme */
243#define TIMING_IGNORED -1
244#define TIMING_ZERO -2
245
ollie6a600992005-11-26 21:55:36 +0000246extern struct flashchip flashchips[];
247
hailfinger80422e22009-12-13 22:28:00 +0000248#if INTERNAL_SUPPORT == 1
uwe5f612c82009-05-16 23:42:17 +0000249struct penable {
250 uint16_t vendor_id;
251 uint16_t device_id;
252 int status;
253 const char *vendor_name;
254 const char *device_name;
255 int (*doit) (struct pci_dev *dev, const char *name);
256};
257
258extern const struct penable chipset_enables[];
259
260struct board_pciid_enable {
261 /* Any device, but make it sensible, like the ISA bridge. */
262 uint16_t first_vendor;
263 uint16_t first_device;
264 uint16_t first_card_vendor;
265 uint16_t first_card_device;
266
267 /* Any device, but make it sensible, like
268 * the host bridge. May be NULL.
269 */
270 uint16_t second_vendor;
271 uint16_t second_device;
272 uint16_t second_card_vendor;
273 uint16_t second_card_device;
274
mkarcher803b4042010-01-20 14:14:11 +0000275 /* Pattern to match DMI entries */
276 const char *dmi_pattern;
277
uwe5f612c82009-05-16 23:42:17 +0000278 /* The vendor / part name from the coreboot table. */
279 const char *lb_vendor;
280 const char *lb_part;
281
282 const char *vendor_name;
283 const char *board_name;
284
libve9b336e2010-01-20 14:45:03 +0000285 int max_rom_decode_parallel;
uwe5f612c82009-05-16 23:42:17 +0000286 int (*enable) (const char *name);
287};
288
289extern struct board_pciid_enable board_pciid_enables[];
290
291struct board_info {
292 const char *vendor;
293 const char *name;
294};
295
296extern const struct board_info boards_ok[];
297extern const struct board_info boards_bad[];
uwefef723f2009-06-18 14:04:44 +0000298extern const struct board_info laptops_ok[];
299extern const struct board_info laptops_bad[];
hailfinger80422e22009-12-13 22:28:00 +0000300#endif
uwe5f612c82009-05-16 23:42:17 +0000301
uwe6ed6d952007-12-04 21:49:06 +0000302/* udelay.c */
hailfingere5829f62009-06-05 17:48:08 +0000303void myusec_delay(int usecs);
hailfinger3d77bc12009-05-01 12:22:17 +0000304void myusec_calibrate_delay(void);
hailfinger8f496f32009-12-24 03:11:55 +0000305void internal_delay(int usecs);
stepan927d4e22007-04-04 22:45:58 +0000306
hailfinger80422e22009-12-13 22:28:00 +0000307#if NEED_PCI == 1
uwea3a82c92009-05-15 17:02:34 +0000308/* pcidev.c */
309#define PCI_OK 0
310#define PCI_NT 1 /* Not tested */
ruikda922a12009-05-17 19:39:27 +0000311
uwea3a82c92009-05-15 17:02:34 +0000312extern uint32_t io_base_addr;
313extern struct pci_access *pacc;
uweb3a82ef2009-05-16 21:39:19 +0000314extern struct pci_dev *pcidev_dev;
uwea3a82c92009-05-15 17:02:34 +0000315struct pcidev_status {
316 uint16_t vendor_id;
317 uint16_t device_id;
318 int status;
319 const char *vendor_name;
320 const char *device_name;
321};
uwee2f95ef2009-09-02 23:00:46 +0000322uint32_t pcidev_validate(struct pci_dev *dev, uint32_t bar, struct pcidev_status *devs);
323uint32_t pcidev_init(uint16_t vendor_id, uint32_t bar, struct pcidev_status *devs, char *pcidev_bdf);
hailfinger80422e22009-12-13 22:28:00 +0000324#endif
uwe884cc8b2009-06-17 12:07:12 +0000325
326/* print.c */
327char *flashbuses_to_text(enum chipbustype bustype);
hailfingera50d60e2009-11-17 09:57:34 +0000328void print_supported(void);
hailfinger80422e22009-12-13 22:28:00 +0000329#if (NIC3COM_SUPPORT == 1) || (GFXNVIDIA_SUPPORT == 1) || (DRKAISER_SUPPORT == 1) || (SATASII_SUPPORT == 1)
uwea3a82c92009-05-15 17:02:34 +0000330void print_supported_pcidevs(struct pcidev_status *devs);
hailfinger80422e22009-12-13 22:28:00 +0000331#endif
hailfingera50d60e2009-11-17 09:57:34 +0000332void print_supported_wiki(void);
uwea3a82c92009-05-15 17:02:34 +0000333
uwe6ed6d952007-12-04 21:49:06 +0000334/* board_enable.c */
stugeaa35d392009-01-26 02:34:51 +0000335void w836xx_ext_enter(uint16_t port);
336void w836xx_ext_leave(uint16_t port);
hailfinger7bac0e52009-05-25 23:26:50 +0000337uint8_t sio_read(uint16_t port, uint8_t reg);
338void sio_write(uint16_t port, uint8_t reg, uint8_t data);
339void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
uwe6ed6d952007-12-04 21:49:06 +0000340int board_flash_enable(const char *vendor, const char *part);
stepan5c3f1382007-02-06 19:47:50 +0000341
uwe6ed6d952007-12-04 21:49:06 +0000342/* chipset_enable.c */
343int chipset_flash_enable(void);
stuge12ac08f2008-12-03 21:24:40 +0000344
stuge7c943ee2009-01-26 01:10:48 +0000345/* physmap.c */
346void *physmap(const char *descr, unsigned long phys_addr, size_t len);
hailfinger336a92d2010-02-02 11:09:03 +0000347void *physmap_try_ro(const char *descr, unsigned long phys_addr, size_t len);
stuge7c943ee2009-01-26 01:10:48 +0000348void physunmap(void *virt_addr, size_t len);
stepan6d42c0f2009-08-12 09:27:45 +0000349int setup_cpu_msr(int cpu);
350void cleanup_cpu_msr(void);
hailfinger088dc812009-12-14 03:32:24 +0000351
352/* cbtable.c */
353void lb_vendor_dev_from_string(char *boardstring);
354int coreboot_init(void);
355extern char *lb_part, *lb_vendor;
356extern int partvendor_from_cbtable;
stuge7c943ee2009-01-26 01:10:48 +0000357
mkarcher803b4042010-01-20 14:14:11 +0000358/* dmi.c */
359extern int has_dmi_support;
360void dmi_init(void);
361int dmi_match(const char *pattern);
362
hailfingerabe249e2009-05-08 17:43:22 +0000363/* internal.c */
hailfinger80422e22009-12-13 22:28:00 +0000364#if NEED_PCI == 1
hailfingerc236f9e2009-12-22 23:42:04 +0000365struct superio {
366 uint16_t vendor;
367 uint16_t port;
368 uint16_t model;
369};
370extern struct superio superio;
371#define SUPERIO_VENDOR_NONE 0x0
372#define SUPERIO_VENDOR_ITE 0x1
uwe57195ba2009-05-16 22:05:42 +0000373struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
hailfinger07e3ce02009-11-15 17:13:29 +0000374struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t class);
uwe57195ba2009-05-16 22:05:42 +0000375struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
376struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
377 uint16_t card_vendor, uint16_t card_device);
hailfinger80422e22009-12-13 22:28:00 +0000378#endif
hailfinger0668eba2009-05-14 21:41:10 +0000379void get_io_perms(void);
hailfinger7828d092009-08-09 21:50:24 +0000380void release_io_perms(void);
hailfinger80422e22009-12-13 22:28:00 +0000381#if INTERNAL_SUPPORT == 1
hailfingerc236f9e2009-12-22 23:42:04 +0000382void probe_superio(void);
hailfingerabe249e2009-05-08 17:43:22 +0000383int internal_init(void);
384int internal_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000385void internal_chip_writeb(uint8_t val, chipaddr addr);
386void internal_chip_writew(uint16_t val, chipaddr addr);
387void internal_chip_writel(uint32_t val, chipaddr addr);
388uint8_t internal_chip_readb(const chipaddr addr);
389uint16_t internal_chip_readw(const chipaddr addr);
390uint32_t internal_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000391void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger80422e22009-12-13 22:28:00 +0000392#endif
hailfinger38da6812009-05-17 15:49:24 +0000393void mmio_writeb(uint8_t val, void *addr);
394void mmio_writew(uint16_t val, void *addr);
395void mmio_writel(uint32_t val, void *addr);
396uint8_t mmio_readb(void *addr);
397uint16_t mmio_readw(void *addr);
398uint32_t mmio_readl(void *addr);
hailfingerec022272010-01-06 10:21:00 +0000399
400/* programmer.c */
hailfinger571a6b32009-09-16 10:09:21 +0000401int noop_shutdown(void);
uwe3e656bd2009-05-17 23:12:17 +0000402void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
403void fallback_unmap(void *virt_addr, size_t len);
hailfinger571a6b32009-09-16 10:09:21 +0000404uint8_t noop_chip_readb(const chipaddr addr);
405void noop_chip_writeb(uint8_t val, chipaddr addr);
hailfinger82719632009-05-16 21:22:56 +0000406void fallback_chip_writew(uint16_t val, chipaddr addr);
407void fallback_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000408void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000409uint16_t fallback_chip_readw(const chipaddr addr);
410uint32_t fallback_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000411void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfingerabe249e2009-05-08 17:43:22 +0000412
hailfingera9df33c2009-05-09 00:54:55 +0000413/* dummyflasher.c */
hailfinger80422e22009-12-13 22:28:00 +0000414#if DUMMY_SUPPORT == 1
hailfingera9df33c2009-05-09 00:54:55 +0000415int dummy_init(void);
416int dummy_shutdown(void);
hailfinger11ae3c42009-05-11 14:13:25 +0000417void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
418void dummy_unmap(void *virt_addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000419void dummy_chip_writeb(uint8_t val, chipaddr addr);
420void dummy_chip_writew(uint16_t val, chipaddr addr);
421void dummy_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000422void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000423uint8_t dummy_chip_readb(const chipaddr addr);
424uint16_t dummy_chip_readw(const chipaddr addr);
425uint32_t dummy_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000426void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger68002c22009-07-10 21:08:55 +0000427int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
hailfingerf91e3b52009-05-14 12:59:36 +0000428 const unsigned char *writearr, unsigned char *readarr);
hailfinger80422e22009-12-13 22:28:00 +0000429#endif
hailfingera9df33c2009-05-09 00:54:55 +0000430
uwe0f5a3a22009-05-13 11:36:06 +0000431/* nic3com.c */
hailfinger80422e22009-12-13 22:28:00 +0000432#if NIC3COM_SUPPORT == 1
uwe0f5a3a22009-05-13 11:36:06 +0000433int nic3com_init(void);
434int nic3com_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000435void nic3com_chip_writeb(uint8_t val, chipaddr addr);
436uint8_t nic3com_chip_readb(const chipaddr addr);
uwea3a82c92009-05-15 17:02:34 +0000437extern struct pcidev_status nics_3com[];
hailfinger80422e22009-12-13 22:28:00 +0000438#endif
uwe0f5a3a22009-05-13 11:36:06 +0000439
uweff4576d2009-09-30 18:29:55 +0000440/* gfxnvidia.c */
hailfinger80422e22009-12-13 22:28:00 +0000441#if GFXNVIDIA_SUPPORT == 1
uweff4576d2009-09-30 18:29:55 +0000442int gfxnvidia_init(void);
443int gfxnvidia_shutdown(void);
444void gfxnvidia_chip_writeb(uint8_t val, chipaddr addr);
445uint8_t gfxnvidia_chip_readb(const chipaddr addr);
446extern struct pcidev_status gfx_nvidia[];
hailfinger80422e22009-12-13 22:28:00 +0000447#endif
uweff4576d2009-09-30 18:29:55 +0000448
uwee2f95ef2009-09-02 23:00:46 +0000449/* drkaiser.c */
hailfinger80422e22009-12-13 22:28:00 +0000450#if DRKAISER_SUPPORT == 1
uwee2f95ef2009-09-02 23:00:46 +0000451int drkaiser_init(void);
452int drkaiser_shutdown(void);
453void drkaiser_chip_writeb(uint8_t val, chipaddr addr);
454uint8_t drkaiser_chip_readb(const chipaddr addr);
455extern struct pcidev_status drkaiser_pcidev[];
hailfinger80422e22009-12-13 22:28:00 +0000456#endif
uwee2f95ef2009-09-02 23:00:46 +0000457
ruikda922a12009-05-17 19:39:27 +0000458/* satasii.c */
hailfinger80422e22009-12-13 22:28:00 +0000459#if SATASII_SUPPORT == 1
ruikda922a12009-05-17 19:39:27 +0000460int satasii_init(void);
461int satasii_shutdown(void);
ruikda922a12009-05-17 19:39:27 +0000462void satasii_chip_writeb(uint8_t val, chipaddr addr);
463uint8_t satasii_chip_readb(const chipaddr addr);
464extern struct pcidev_status satas_sii[];
hailfinger80422e22009-12-13 22:28:00 +0000465#endif
ruikda922a12009-05-17 19:39:27 +0000466
hailfingerf31da3d2009-06-16 21:08:06 +0000467/* ft2232_spi.c */
hailfingere98628b2009-07-01 00:02:23 +0000468#define FTDI_FT2232H 0x6010
469#define FTDI_FT4232H 0x6011
hailfingerf31da3d2009-06-16 21:08:06 +0000470int ft2232_spi_init(void);
hailfinger68002c22009-07-10 21:08:55 +0000471int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
hailfingerf31da3d2009-06-16 21:08:06 +0000472int ft2232_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingerf31da3d2009-06-16 21:08:06 +0000473int ft2232_spi_write_256(struct flashchip *flash, uint8_t *buf);
474
hailfingeracce2df2009-09-28 13:15:16 +0000475/* bitbang_spi.c */
hailfinger8e278892009-10-01 14:51:25 +0000476extern int bitbang_spi_half_period;
477extern const struct bitbang_spi_master_entry bitbang_spi_master_table[];
hailfingeracce2df2009-09-28 13:15:16 +0000478int bitbang_spi_init(void);
479int bitbang_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
480int bitbang_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
481int bitbang_spi_write_256(struct flashchip *flash, uint8_t *buf);
482
hailfinger9c5add72009-11-24 00:20:03 +0000483/* buspirate_spi.c */
hailfinger6e5a52a2009-11-24 18:27:10 +0000484struct buspirate_spispeeds {
485 const char *name;
486 const int speed;
487};
hailfinger9c5add72009-11-24 00:20:03 +0000488int buspirate_spi_init(void);
489int buspirate_spi_shutdown(void);
490int buspirate_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
491int buspirate_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
492
hailfingerdfb32a02010-01-19 11:15:48 +0000493/* dediprog.c */
494int dediprog_init(void);
495int dediprog_shutdown(void);
496int dediprog_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
497int dediprog_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
498
uwe4529d202007-08-23 13:34:59 +0000499/* flashrom.c */
hailfinger80422e22009-12-13 22:28:00 +0000500extern enum chipbustype buses_supported;
501struct decode_sizes {
502 uint32_t parallel;
503 uint32_t lpc;
504 uint32_t fwh;
505 uint32_t spi;
506};
507extern struct decode_sizes max_rom_decode;
hailfinger4f45a4f2009-08-12 13:32:56 +0000508extern char *programmer_param;
hailfinger80422e22009-12-13 22:28:00 +0000509extern unsigned long flashbase;
uwee06bcf82009-04-24 16:17:41 +0000510extern int verbose;
hailfinger2d83b5b2009-07-22 20:13:00 +0000511extern const char *flashrom_version;
hailfinger92cd8e32010-01-07 03:24:05 +0000512extern char *chip_to_probe;
uwee06bcf82009-04-24 16:17:41 +0000513#define printf_debug(x...) { if (verbose) printf(x); }
stuge5ff0e6c2009-01-26 00:39:57 +0000514void map_flash_registers(struct flashchip *flash);
hailfinger0f08b7a2009-06-16 08:55:44 +0000515int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfinger7df21362009-09-05 02:30:58 +0000516int erase_flash(struct flashchip *flash);
hailfinger92cd8e32010-01-07 03:24:05 +0000517struct flashchip *probe_flash(struct flashchip *first_flash, int force);
518int read_flash(struct flashchip *flash, char *filename);
519void check_chip_supported(struct flashchip *flash);
520int check_max_decode(enum chipbustype buses, uint32_t size);
hailfinger7b414742009-06-13 12:04:03 +0000521int min(int a, int b);
hailfinger7af83692009-06-15 17:23:36 +0000522int max(int a, int b);
hailfinger6e5a52a2009-11-24 18:27:10 +0000523char *extract_param(char **haystack, char *needle, char *delim);
hailfinger7af83692009-06-15 17:23:36 +0000524int check_erased_range(struct flashchip *flash, int start, int len);
525int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
uwe884cc8b2009-06-17 12:07:12 +0000526char *strcat_realloc(char *dest, const char *src);
hailfinger92cd8e32010-01-07 03:24:05 +0000527void print_version(void);
528int selfcheck(void);
hailfingerc77acb52009-12-24 02:15:55 +0000529int doit(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it);
uwe884cc8b2009-06-17 12:07:12 +0000530
531#define OK 0
532#define NT 1 /* Not tested */
uwe4529d202007-08-23 13:34:59 +0000533
snelson9cba3c62010-01-07 20:09:33 +0000534/* cli_output.c */
535int print(int type, const char *fmt, ...);
hailfingere7326b22010-01-09 03:22:31 +0000536#define MSG_ERROR 0
537#define MSG_INFO 1
538#define MSG_DEBUG 2
539#define MSG_BARF 3
540#define msg_gerr(...) print(MSG_ERROR, __VA_ARGS__) /* general errors */
541#define msg_perr(...) print(MSG_ERROR, __VA_ARGS__) /* programmer errors */
542#define msg_cerr(...) print(MSG_ERROR, __VA_ARGS__) /* chip errors */
543#define msg_ginfo(...) print(MSG_INFO, __VA_ARGS__) /* general info */
544#define msg_pinfo(...) print(MSG_INFO, __VA_ARGS__) /* programmer info */
545#define msg_cinfo(...) print(MSG_INFO, __VA_ARGS__) /* chip info */
546#define msg_gdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* general debug */
547#define msg_pdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* programmer debug */
548#define msg_cdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* chip debug */
549#define msg_gspew(...) print(MSG_BARF, __VA_ARGS__) /* general debug barf */
550#define msg_pspew(...) print(MSG_BARF, __VA_ARGS__) /* programmer debug barf */
551#define msg_cspew(...) print(MSG_BARF, __VA_ARGS__) /* chip debug barf */
snelson9cba3c62010-01-07 20:09:33 +0000552
hailfinger92cd8e32010-01-07 03:24:05 +0000553/* cli_classic.c */
554int cli_classic(int argc, char *argv[]);
555
uwe4529d202007-08-23 13:34:59 +0000556/* layout.c */
stuge98c09aa2008-06-18 02:08:40 +0000557int show_id(uint8_t *bios, int size, int force);
uwe4529d202007-08-23 13:34:59 +0000558int read_romlayout(char *name);
559int find_romentry(char *name);
hailfinger051b3442009-08-19 15:19:18 +0000560int handle_romentries(uint8_t *buffer, struct flashchip *flash);
uwe4529d202007-08-23 13:34:59 +0000561
stepan745615e2007-10-15 21:44:47 +0000562/* spi.c */
hailfinger40167462009-05-31 17:57:34 +0000563enum spi_controller {
564 SPI_CONTROLLER_NONE,
hailfinger80422e22009-12-13 22:28:00 +0000565#if INTERNAL_SUPPORT == 1
hailfinger40167462009-05-31 17:57:34 +0000566 SPI_CONTROLLER_ICH7,
567 SPI_CONTROLLER_ICH9,
568 SPI_CONTROLLER_IT87XX,
569 SPI_CONTROLLER_SB600,
570 SPI_CONTROLLER_VIA,
571 SPI_CONTROLLER_WBSIO,
hailfinger80422e22009-12-13 22:28:00 +0000572#endif
hailfingerd9dcfbd2009-08-19 13:27:58 +0000573#if FT2232_SPI_SUPPORT == 1
hailfingerf31da3d2009-06-16 21:08:06 +0000574 SPI_CONTROLLER_FT2232,
hailfingerd9dcfbd2009-08-19 13:27:58 +0000575#endif
hailfinger571a6b32009-09-16 10:09:21 +0000576#if DUMMY_SUPPORT == 1
hailfinger40167462009-05-31 17:57:34 +0000577 SPI_CONTROLLER_DUMMY,
hailfinger571a6b32009-09-16 10:09:21 +0000578#endif
hailfinger9c5add72009-11-24 00:20:03 +0000579#if BUSPIRATE_SPI_SUPPORT == 1
580 SPI_CONTROLLER_BUSPIRATE,
581#endif
hailfingerdfb32a02010-01-19 11:15:48 +0000582#if DEDIPROG_SUPPORT == 1
583 SPI_CONTROLLER_DEDIPROG,
584#endif
hailfingerd9dcfbd2009-08-19 13:27:58 +0000585 SPI_CONTROLLER_INVALID /* This must always be the last entry. */
hailfinger40167462009-05-31 17:57:34 +0000586};
hailfingerd9dcfbd2009-08-19 13:27:58 +0000587extern const int spi_programmer_count;
hailfinger68002c22009-07-10 21:08:55 +0000588struct spi_command {
589 unsigned int writecnt;
590 unsigned int readcnt;
591 const unsigned char *writearr;
592 unsigned char *readarr;
593};
hailfinger948b81f2009-07-22 15:36:50 +0000594struct spi_programmer {
595 int (*command)(unsigned int writecnt, unsigned int readcnt,
596 const unsigned char *writearr, unsigned char *readarr);
hailfingerbb092112009-09-18 15:50:56 +0000597 int (*multicommand)(struct spi_command *cmds);
hailfinger948b81f2009-07-22 15:36:50 +0000598
599 /* Optimized functions for this programmer */
600 int (*read)(struct flashchip *flash, uint8_t *buf, int start, int len);
601 int (*write_256)(struct flashchip *flash, uint8_t *buf);
602};
hailfinger68002c22009-07-10 21:08:55 +0000603
hailfinger40167462009-05-31 17:57:34 +0000604extern enum spi_controller spi_controller;
hailfinger948b81f2009-07-22 15:36:50 +0000605extern const struct spi_programmer spi_programmer[];
hailfinger40167462009-05-31 17:57:34 +0000606extern void *spibar;
hailfinger68002c22009-07-10 21:08:55 +0000607int spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000608 const unsigned char *writearr, unsigned char *readarr);
hailfingerbb092112009-09-18 15:50:56 +0000609int spi_send_multicommand(struct spi_command *cmds);
hailfinger948b81f2009-07-22 15:36:50 +0000610int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
611 const unsigned char *writearr, unsigned char *readarr);
hailfingerbb092112009-09-18 15:50:56 +0000612int default_spi_send_multicommand(struct spi_command *cmds);
hailfinger088dc812009-12-14 03:32:24 +0000613uint32_t spi_get_valid_read_addr(void);
uweaf9b4df2008-09-26 13:19:02 +0000614
hailfinger82e7ddb2008-05-16 12:55:55 +0000615/* ichspi.c */
hailfinger3d77bc12009-05-01 12:22:17 +0000616int ich_init_opcodes(void);
hailfinger68002c22009-07-10 21:08:55 +0000617int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000618 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000619int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000620int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
hailfingerbb092112009-09-18 15:50:56 +0000621int ich_spi_send_multicommand(struct spi_command *cmds);
hailfinger82e7ddb2008-05-16 12:55:55 +0000622
hailfinger2c361e42008-05-13 23:03:12 +0000623/* it87spi.c */
624extern uint16_t it8716f_flashport;
hailfinger7bac0e52009-05-25 23:26:50 +0000625void enter_conf_mode_ite(uint16_t port);
626void exit_conf_mode_ite(uint16_t port);
hailfingerc236f9e2009-12-22 23:42:04 +0000627struct superio probe_superio_ite(void);
hailfinger26e212b2009-05-31 18:00:57 +0000628int it87spi_init(void);
hailfinger82e7ddb2008-05-16 12:55:55 +0000629int it87xx_probe_spi_flash(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000630int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000631 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000632int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000633int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
hailfinger2c361e42008-05-13 23:03:12 +0000634
uwe17efbed2008-11-28 21:36:51 +0000635/* sb600spi.c */
hailfinger68002c22009-07-10 21:08:55 +0000636int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe17efbed2008-11-28 21:36:51 +0000637 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000638int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000639int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
hailfinger38da6812009-05-17 15:49:24 +0000640extern uint8_t *sb600_spibar;
uwe17efbed2008-11-28 21:36:51 +0000641
stugea564bcf2009-01-26 03:08:45 +0000642/* wbsio_spi.c */
643int wbsio_check_for_spi(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000644int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe4e204a22009-05-28 15:07:42 +0000645 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000646int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000647int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
stugea564bcf2009-01-26 03:08:45 +0000648
hailfinger37b4fbf2009-06-23 11:33:43 +0000649/* serprog.c */
hailfinger37b4fbf2009-06-23 11:33:43 +0000650int serprog_init(void);
651int serprog_shutdown(void);
652void serprog_chip_writeb(uint8_t val, chipaddr addr);
653uint8_t serprog_chip_readb(const chipaddr addr);
654void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
655void serprog_delay(int delay);
hailfinger4979b042009-11-23 19:20:11 +0000656
657/* serial.c */
oxygene3ad3b332010-01-06 22:14:39 +0000658#if _WIN32
659typedef HANDLE fdtype;
660#else
661typedef int fdtype;
662#endif
663
hailfingerb88282e2009-11-21 11:02:48 +0000664void sp_flush_incoming(void);
oxygene3ad3b332010-01-06 22:14:39 +0000665fdtype sp_openserport(char *dev, unsigned int baud);
hailfinger4979b042009-11-23 19:20:11 +0000666void __attribute__((noreturn)) sp_die(char *msg);
oxygene3ad3b332010-01-06 22:14:39 +0000667extern fdtype sp_fd;
hailfinger852163c2010-01-06 16:09:10 +0000668int serialport_shutdown(void);
669int serialport_write(unsigned char *buf, unsigned int writecnt);
670int serialport_read(unsigned char *buf, unsigned int readcnt);
uwe619a15a2009-06-28 23:26:37 +0000671
hailfinger088dc812009-12-14 03:32:24 +0000672#include "chipdrivers.h"
673
ollie5b621572004-03-20 16:46:10 +0000674#endif /* !__FLASH_H__ */