blob: 65fa685edcb6b8c4e2b74ffa1aa5a18985a179f4 [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
uweabe92a52009-05-16 22:36:00 +0000102int programmer_init(void);
103int programmer_shutdown(void);
104void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
105 size_t len);
106void programmer_unmap_flash_region(void *virt_addr, size_t len);
107void chip_writeb(uint8_t val, chipaddr addr);
108void chip_writew(uint16_t val, chipaddr addr);
109void chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000110void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
uweabe92a52009-05-16 22:36:00 +0000111uint8_t chip_readb(const chipaddr addr);
112uint16_t chip_readw(const chipaddr addr);
113uint32_t chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000114void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfingere5829f62009-06-05 17:48:08 +0000115void programmer_delay(int usecs);
hailfingerba3761a2009-03-05 19:24:22 +0000116
hailfinger8e278892009-10-01 14:51:25 +0000117enum bitbang_spi_master {
118 BITBANG_SPI_INVALID /* This must always be the last entry. */
hailfingeracce2df2009-09-28 13:15:16 +0000119};
120
hailfinger8e278892009-10-01 14:51:25 +0000121extern const int bitbang_spi_master_count;
hailfingeracce2df2009-09-28 13:15:16 +0000122
hailfinger8e278892009-10-01 14:51:25 +0000123extern enum bitbang_spi_master bitbang_spi_master;
hailfingeracce2df2009-09-28 13:15:16 +0000124
hailfinger8e278892009-10-01 14:51:25 +0000125struct bitbang_spi_master_entry {
hailfingeracce2df2009-09-28 13:15:16 +0000126 void (*set_cs) (int val);
127 void (*set_sck) (int val);
128 void (*set_mosi) (int val);
129 int (*get_miso) (void);
130};
131
uwe16f99092008-03-12 11:54:51 +0000132#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
133
hailfinger40167462009-05-31 17:57:34 +0000134enum chipbustype {
hailfinger668f3502009-06-01 00:02:11 +0000135 CHIP_BUSTYPE_NONE = 0,
hailfinger40167462009-05-31 17:57:34 +0000136 CHIP_BUSTYPE_PARALLEL = 1 << 0,
137 CHIP_BUSTYPE_LPC = 1 << 1,
138 CHIP_BUSTYPE_FWH = 1 << 2,
139 CHIP_BUSTYPE_SPI = 1 << 3,
140 CHIP_BUSTYPE_NONSPI = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH,
141 CHIP_BUSTYPE_UNKNOWN = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH | CHIP_BUSTYPE_SPI,
142};
143
hailfinger7df21362009-09-05 02:30:58 +0000144/*
145 * How many different contiguous runs of erase blocks with one size each do
146 * we have for a given erase function?
147 */
148#define NUM_ERASEREGIONS 5
149
150/*
151 * How many different erase functions do we have per chip?
152 */
153#define NUM_ERASEFUNCTIONS 5
154
hailfinger80dea312010-01-09 03:15:50 +0000155#define FEATURE_REGISTERMAP (1 << 0)
156#define FEATURE_BYTEWRITES (1 << 1)
157#define FEATURE_ADDR_FULL (0 << 2)
158#define FEATURE_ADDR_MASK (3 << 2)
snelson63133f92010-01-04 17:15:23 +0000159
rminnich8d3ff912003-10-25 17:01:29 +0000160struct flashchip {
uwedfcd15f2008-03-14 23:55:58 +0000161 const char *vendor;
uwe6ed6d952007-12-04 21:49:06 +0000162 const char *name;
hailfinger40167462009-05-31 17:57:34 +0000163
164 enum chipbustype bustype;
165
uwefa98ca12008-10-18 21:14:13 +0000166 /*
167 * With 32bit manufacture_id and model_id we can cover IDs up to
hailfinger428f2012007-12-31 01:49:00 +0000168 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
169 * Identification code.
170 */
171 uint32_t manufacture_id;
172 uint32_t model_id;
rminnich8d3ff912003-10-25 17:01:29 +0000173
rminnich8d3ff912003-10-25 17:01:29 +0000174 int total_size;
175 int page_size;
snelson63133f92010-01-04 17:15:23 +0000176 int feature_bits;
rminnich8d3ff912003-10-25 17:01:29 +0000177
uwefa98ca12008-10-18 21:14:13 +0000178 /*
179 * Indicate if flashrom has been tested with this flash chip and if
stuge9cd64bd2008-05-03 04:34:37 +0000180 * everything worked correctly.
181 */
182 uint32_t tested;
183
uwe8e1a2ba2007-04-01 19:44:21 +0000184 int (*probe) (struct flashchip *flash);
hailfingerd5b35922009-06-03 14:46:22 +0000185
186 /* Delay after "enter/exit ID mode" commands in microseconds. */
187 int probe_timing;
uwe8e1a2ba2007-04-01 19:44:21 +0000188 int (*erase) (struct flashchip *flash);
hailfinger7df21362009-09-05 02:30:58 +0000189
190 /*
hailfingerc4fac582009-12-22 13:04:53 +0000191 * Erase blocks and associated erase function. Any chip erase function
192 * is stored as chip-sized virtual block together with said function.
hailfinger7df21362009-09-05 02:30:58 +0000193 */
194 struct block_eraser {
195 struct eraseblock{
196 unsigned int size; /* Eraseblock size */
197 unsigned int count; /* Number of contiguous blocks with that size */
198 } eraseblocks[NUM_ERASEREGIONS];
199 int (*block_erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
200 } block_erasers[NUM_ERASEFUNCTIONS];
201
uwe8e1a2ba2007-04-01 19:44:21 +0000202 int (*write) (struct flashchip *flash, uint8_t *buf);
hailfinger0f08b7a2009-06-16 08:55:44 +0000203 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
rminnich8d3ff912003-10-25 17:01:29 +0000204
uwe6ed6d952007-12-04 21:49:06 +0000205 /* Some flash devices have an additional register space. */
hailfinger82719632009-05-16 21:22:56 +0000206 chipaddr virtual_memory;
207 chipaddr virtual_registers;
rminnich8d3ff912003-10-25 17:01:29 +0000208};
209
stuge9cd64bd2008-05-03 04:34:37 +0000210#define TEST_UNTESTED 0
211
uwe4e204a22009-05-28 15:07:42 +0000212#define TEST_OK_PROBE (1 << 0)
213#define TEST_OK_READ (1 << 1)
214#define TEST_OK_ERASE (1 << 2)
215#define TEST_OK_WRITE (1 << 3)
216#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
217#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
hailfinger80f48682009-09-23 22:01:33 +0000218#define TEST_OK_PRW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
uwe4e204a22009-05-28 15:07:42 +0000219#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
stuge9cd64bd2008-05-03 04:34:37 +0000220#define TEST_OK_MASK 0x0f
221
uwe4e204a22009-05-28 15:07:42 +0000222#define TEST_BAD_PROBE (1 << 4)
223#define TEST_BAD_READ (1 << 5)
224#define TEST_BAD_ERASE (1 << 6)
225#define TEST_BAD_WRITE (1 << 7)
226#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
stuge9cd64bd2008-05-03 04:34:37 +0000227#define TEST_BAD_MASK 0xf0
228
hailfingerd5b35922009-06-03 14:46:22 +0000229/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
230 * field and zero delay.
231 *
232 * SPI devices will always have zero delay and ignore this field.
233 */
234#define TIMING_FIXME -1
235/* this is intentionally same value as fixme */
236#define TIMING_IGNORED -1
237#define TIMING_ZERO -2
238
ollie6a600992005-11-26 21:55:36 +0000239extern struct flashchip flashchips[];
240
hailfinger80422e22009-12-13 22:28:00 +0000241#if INTERNAL_SUPPORT == 1
uwe5f612c82009-05-16 23:42:17 +0000242struct penable {
243 uint16_t vendor_id;
244 uint16_t device_id;
245 int status;
246 const char *vendor_name;
247 const char *device_name;
248 int (*doit) (struct pci_dev *dev, const char *name);
249};
250
251extern const struct penable chipset_enables[];
252
253struct board_pciid_enable {
254 /* Any device, but make it sensible, like the ISA bridge. */
255 uint16_t first_vendor;
256 uint16_t first_device;
257 uint16_t first_card_vendor;
258 uint16_t first_card_device;
259
260 /* Any device, but make it sensible, like
261 * the host bridge. May be NULL.
262 */
263 uint16_t second_vendor;
264 uint16_t second_device;
265 uint16_t second_card_vendor;
266 uint16_t second_card_device;
267
268 /* The vendor / part name from the coreboot table. */
269 const char *lb_vendor;
270 const char *lb_part;
271
272 const char *vendor_name;
273 const char *board_name;
274
275 int (*enable) (const char *name);
276};
277
278extern struct board_pciid_enable board_pciid_enables[];
279
280struct board_info {
281 const char *vendor;
282 const char *name;
283};
284
285extern const struct board_info boards_ok[];
286extern const struct board_info boards_bad[];
uwefef723f2009-06-18 14:04:44 +0000287extern const struct board_info laptops_ok[];
288extern const struct board_info laptops_bad[];
hailfinger80422e22009-12-13 22:28:00 +0000289#endif
uwe5f612c82009-05-16 23:42:17 +0000290
uwe6ed6d952007-12-04 21:49:06 +0000291/* udelay.c */
hailfingere5829f62009-06-05 17:48:08 +0000292void myusec_delay(int usecs);
hailfinger3d77bc12009-05-01 12:22:17 +0000293void myusec_calibrate_delay(void);
hailfinger8f496f32009-12-24 03:11:55 +0000294void internal_delay(int usecs);
stepan927d4e22007-04-04 22:45:58 +0000295
hailfinger80422e22009-12-13 22:28:00 +0000296#if NEED_PCI == 1
uwea3a82c92009-05-15 17:02:34 +0000297/* pcidev.c */
298#define PCI_OK 0
299#define PCI_NT 1 /* Not tested */
ruikda922a12009-05-17 19:39:27 +0000300
uwea3a82c92009-05-15 17:02:34 +0000301extern uint32_t io_base_addr;
302extern struct pci_access *pacc;
uweb3a82ef2009-05-16 21:39:19 +0000303extern struct pci_dev *pcidev_dev;
uwea3a82c92009-05-15 17:02:34 +0000304struct pcidev_status {
305 uint16_t vendor_id;
306 uint16_t device_id;
307 int status;
308 const char *vendor_name;
309 const char *device_name;
310};
uwee2f95ef2009-09-02 23:00:46 +0000311uint32_t pcidev_validate(struct pci_dev *dev, uint32_t bar, struct pcidev_status *devs);
312uint32_t pcidev_init(uint16_t vendor_id, uint32_t bar, struct pcidev_status *devs, char *pcidev_bdf);
hailfinger80422e22009-12-13 22:28:00 +0000313#endif
uwe884cc8b2009-06-17 12:07:12 +0000314
315/* print.c */
316char *flashbuses_to_text(enum chipbustype bustype);
hailfingera50d60e2009-11-17 09:57:34 +0000317void print_supported(void);
hailfinger80422e22009-12-13 22:28:00 +0000318#if (NIC3COM_SUPPORT == 1) || (GFXNVIDIA_SUPPORT == 1) || (DRKAISER_SUPPORT == 1) || (SATASII_SUPPORT == 1)
uwea3a82c92009-05-15 17:02:34 +0000319void print_supported_pcidevs(struct pcidev_status *devs);
hailfinger80422e22009-12-13 22:28:00 +0000320#endif
hailfingera50d60e2009-11-17 09:57:34 +0000321void print_supported_wiki(void);
uwea3a82c92009-05-15 17:02:34 +0000322
uwe6ed6d952007-12-04 21:49:06 +0000323/* board_enable.c */
stugeaa35d392009-01-26 02:34:51 +0000324void w836xx_ext_enter(uint16_t port);
325void w836xx_ext_leave(uint16_t port);
hailfinger7bac0e52009-05-25 23:26:50 +0000326uint8_t sio_read(uint16_t port, uint8_t reg);
327void sio_write(uint16_t port, uint8_t reg, uint8_t data);
328void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
uwe6ed6d952007-12-04 21:49:06 +0000329int board_flash_enable(const char *vendor, const char *part);
stepan5c3f1382007-02-06 19:47:50 +0000330
uwe6ed6d952007-12-04 21:49:06 +0000331/* chipset_enable.c */
332int chipset_flash_enable(void);
stuge12ac08f2008-12-03 21:24:40 +0000333
stuge7c943ee2009-01-26 01:10:48 +0000334/* physmap.c */
335void *physmap(const char *descr, unsigned long phys_addr, size_t len);
336void physunmap(void *virt_addr, size_t len);
stepan6d42c0f2009-08-12 09:27:45 +0000337int setup_cpu_msr(int cpu);
338void cleanup_cpu_msr(void);
hailfinger088dc812009-12-14 03:32:24 +0000339
340/* cbtable.c */
341void lb_vendor_dev_from_string(char *boardstring);
342int coreboot_init(void);
343extern char *lb_part, *lb_vendor;
344extern int partvendor_from_cbtable;
stuge7c943ee2009-01-26 01:10:48 +0000345
hailfingerabe249e2009-05-08 17:43:22 +0000346/* internal.c */
hailfinger80422e22009-12-13 22:28:00 +0000347#if NEED_PCI == 1
hailfingerc236f9e2009-12-22 23:42:04 +0000348struct superio {
349 uint16_t vendor;
350 uint16_t port;
351 uint16_t model;
352};
353extern struct superio superio;
354#define SUPERIO_VENDOR_NONE 0x0
355#define SUPERIO_VENDOR_ITE 0x1
uwe57195ba2009-05-16 22:05:42 +0000356struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
hailfinger07e3ce02009-11-15 17:13:29 +0000357struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t class);
uwe57195ba2009-05-16 22:05:42 +0000358struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
359struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
360 uint16_t card_vendor, uint16_t card_device);
hailfinger80422e22009-12-13 22:28:00 +0000361#endif
hailfinger0668eba2009-05-14 21:41:10 +0000362void get_io_perms(void);
hailfinger7828d092009-08-09 21:50:24 +0000363void release_io_perms(void);
hailfinger80422e22009-12-13 22:28:00 +0000364#if INTERNAL_SUPPORT == 1
hailfingerc236f9e2009-12-22 23:42:04 +0000365void probe_superio(void);
hailfingerabe249e2009-05-08 17:43:22 +0000366int internal_init(void);
367int internal_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000368void internal_chip_writeb(uint8_t val, chipaddr addr);
369void internal_chip_writew(uint16_t val, chipaddr addr);
370void internal_chip_writel(uint32_t val, chipaddr addr);
371uint8_t internal_chip_readb(const chipaddr addr);
372uint16_t internal_chip_readw(const chipaddr addr);
373uint32_t internal_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000374void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger80422e22009-12-13 22:28:00 +0000375#endif
hailfinger38da6812009-05-17 15:49:24 +0000376void mmio_writeb(uint8_t val, void *addr);
377void mmio_writew(uint16_t val, void *addr);
378void mmio_writel(uint32_t val, void *addr);
379uint8_t mmio_readb(void *addr);
380uint16_t mmio_readw(void *addr);
381uint32_t mmio_readl(void *addr);
hailfingerec022272010-01-06 10:21:00 +0000382
383/* programmer.c */
hailfinger571a6b32009-09-16 10:09:21 +0000384int noop_shutdown(void);
uwe3e656bd2009-05-17 23:12:17 +0000385void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
386void fallback_unmap(void *virt_addr, size_t len);
hailfinger571a6b32009-09-16 10:09:21 +0000387uint8_t noop_chip_readb(const chipaddr addr);
388void noop_chip_writeb(uint8_t val, chipaddr addr);
hailfinger82719632009-05-16 21:22:56 +0000389void fallback_chip_writew(uint16_t val, chipaddr addr);
390void fallback_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000391void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000392uint16_t fallback_chip_readw(const chipaddr addr);
393uint32_t fallback_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000394void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfingerabe249e2009-05-08 17:43:22 +0000395
hailfingera9df33c2009-05-09 00:54:55 +0000396/* dummyflasher.c */
hailfinger80422e22009-12-13 22:28:00 +0000397#if DUMMY_SUPPORT == 1
hailfingera9df33c2009-05-09 00:54:55 +0000398int dummy_init(void);
399int dummy_shutdown(void);
hailfinger11ae3c42009-05-11 14:13:25 +0000400void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
401void dummy_unmap(void *virt_addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000402void dummy_chip_writeb(uint8_t val, chipaddr addr);
403void dummy_chip_writew(uint16_t val, chipaddr addr);
404void dummy_chip_writel(uint32_t val, chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000405void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
hailfinger82719632009-05-16 21:22:56 +0000406uint8_t dummy_chip_readb(const chipaddr addr);
407uint16_t dummy_chip_readw(const chipaddr addr);
408uint32_t dummy_chip_readl(const chipaddr addr);
hailfinger9d987ef2009-06-05 18:32:07 +0000409void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger68002c22009-07-10 21:08:55 +0000410int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
hailfingerf91e3b52009-05-14 12:59:36 +0000411 const unsigned char *writearr, unsigned char *readarr);
hailfinger80422e22009-12-13 22:28:00 +0000412#endif
hailfingera9df33c2009-05-09 00:54:55 +0000413
uwe0f5a3a22009-05-13 11:36:06 +0000414/* nic3com.c */
hailfinger80422e22009-12-13 22:28:00 +0000415#if NIC3COM_SUPPORT == 1
uwe0f5a3a22009-05-13 11:36:06 +0000416int nic3com_init(void);
417int nic3com_shutdown(void);
hailfinger82719632009-05-16 21:22:56 +0000418void nic3com_chip_writeb(uint8_t val, chipaddr addr);
419uint8_t nic3com_chip_readb(const chipaddr addr);
uwea3a82c92009-05-15 17:02:34 +0000420extern struct pcidev_status nics_3com[];
hailfinger80422e22009-12-13 22:28:00 +0000421#endif
uwe0f5a3a22009-05-13 11:36:06 +0000422
uweff4576d2009-09-30 18:29:55 +0000423/* gfxnvidia.c */
hailfinger80422e22009-12-13 22:28:00 +0000424#if GFXNVIDIA_SUPPORT == 1
uweff4576d2009-09-30 18:29:55 +0000425int gfxnvidia_init(void);
426int gfxnvidia_shutdown(void);
427void gfxnvidia_chip_writeb(uint8_t val, chipaddr addr);
428uint8_t gfxnvidia_chip_readb(const chipaddr addr);
429extern struct pcidev_status gfx_nvidia[];
hailfinger80422e22009-12-13 22:28:00 +0000430#endif
uweff4576d2009-09-30 18:29:55 +0000431
uwee2f95ef2009-09-02 23:00:46 +0000432/* drkaiser.c */
hailfinger80422e22009-12-13 22:28:00 +0000433#if DRKAISER_SUPPORT == 1
uwee2f95ef2009-09-02 23:00:46 +0000434int drkaiser_init(void);
435int drkaiser_shutdown(void);
436void drkaiser_chip_writeb(uint8_t val, chipaddr addr);
437uint8_t drkaiser_chip_readb(const chipaddr addr);
438extern struct pcidev_status drkaiser_pcidev[];
hailfinger80422e22009-12-13 22:28:00 +0000439#endif
uwee2f95ef2009-09-02 23:00:46 +0000440
ruikda922a12009-05-17 19:39:27 +0000441/* satasii.c */
hailfinger80422e22009-12-13 22:28:00 +0000442#if SATASII_SUPPORT == 1
ruikda922a12009-05-17 19:39:27 +0000443int satasii_init(void);
444int satasii_shutdown(void);
ruikda922a12009-05-17 19:39:27 +0000445void satasii_chip_writeb(uint8_t val, chipaddr addr);
446uint8_t satasii_chip_readb(const chipaddr addr);
447extern struct pcidev_status satas_sii[];
hailfinger80422e22009-12-13 22:28:00 +0000448#endif
ruikda922a12009-05-17 19:39:27 +0000449
hailfingerf31da3d2009-06-16 21:08:06 +0000450/* ft2232_spi.c */
hailfingere98628b2009-07-01 00:02:23 +0000451#define FTDI_FT2232H 0x6010
452#define FTDI_FT4232H 0x6011
hailfingerf31da3d2009-06-16 21:08:06 +0000453int ft2232_spi_init(void);
hailfinger68002c22009-07-10 21:08:55 +0000454int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
hailfingerf31da3d2009-06-16 21:08:06 +0000455int ft2232_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingerf31da3d2009-06-16 21:08:06 +0000456int ft2232_spi_write_256(struct flashchip *flash, uint8_t *buf);
457
hailfingeracce2df2009-09-28 13:15:16 +0000458/* bitbang_spi.c */
hailfinger8e278892009-10-01 14:51:25 +0000459extern int bitbang_spi_half_period;
460extern const struct bitbang_spi_master_entry bitbang_spi_master_table[];
hailfingeracce2df2009-09-28 13:15:16 +0000461int bitbang_spi_init(void);
462int bitbang_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
463int bitbang_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
464int bitbang_spi_write_256(struct flashchip *flash, uint8_t *buf);
465
hailfinger9c5add72009-11-24 00:20:03 +0000466/* buspirate_spi.c */
hailfinger6e5a52a2009-11-24 18:27:10 +0000467struct buspirate_spispeeds {
468 const char *name;
469 const int speed;
470};
hailfinger9c5add72009-11-24 00:20:03 +0000471int buspirate_spi_init(void);
472int buspirate_spi_shutdown(void);
473int buspirate_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
474int buspirate_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
475
hailfingerdfb32a02010-01-19 11:15:48 +0000476/* dediprog.c */
477int dediprog_init(void);
478int dediprog_shutdown(void);
479int dediprog_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
480int dediprog_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
481
uwe4529d202007-08-23 13:34:59 +0000482/* flashrom.c */
hailfinger80422e22009-12-13 22:28:00 +0000483extern enum chipbustype buses_supported;
484struct decode_sizes {
485 uint32_t parallel;
486 uint32_t lpc;
487 uint32_t fwh;
488 uint32_t spi;
489};
490extern struct decode_sizes max_rom_decode;
hailfinger4f45a4f2009-08-12 13:32:56 +0000491extern char *programmer_param;
hailfinger80422e22009-12-13 22:28:00 +0000492extern unsigned long flashbase;
uwee06bcf82009-04-24 16:17:41 +0000493extern int verbose;
hailfinger2d83b5b2009-07-22 20:13:00 +0000494extern const char *flashrom_version;
hailfinger92cd8e32010-01-07 03:24:05 +0000495extern char *chip_to_probe;
uwee06bcf82009-04-24 16:17:41 +0000496#define printf_debug(x...) { if (verbose) printf(x); }
stuge5ff0e6c2009-01-26 00:39:57 +0000497void map_flash_registers(struct flashchip *flash);
hailfinger0f08b7a2009-06-16 08:55:44 +0000498int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfinger7df21362009-09-05 02:30:58 +0000499int erase_flash(struct flashchip *flash);
hailfinger92cd8e32010-01-07 03:24:05 +0000500struct flashchip *probe_flash(struct flashchip *first_flash, int force);
501int read_flash(struct flashchip *flash, char *filename);
502void check_chip_supported(struct flashchip *flash);
503int check_max_decode(enum chipbustype buses, uint32_t size);
hailfinger7b414742009-06-13 12:04:03 +0000504int min(int a, int b);
hailfinger7af83692009-06-15 17:23:36 +0000505int max(int a, int b);
hailfinger6e5a52a2009-11-24 18:27:10 +0000506char *extract_param(char **haystack, char *needle, char *delim);
hailfinger7af83692009-06-15 17:23:36 +0000507int check_erased_range(struct flashchip *flash, int start, int len);
508int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
uwe884cc8b2009-06-17 12:07:12 +0000509char *strcat_realloc(char *dest, const char *src);
hailfinger92cd8e32010-01-07 03:24:05 +0000510void print_version(void);
511int selfcheck(void);
hailfingerc77acb52009-12-24 02:15:55 +0000512int 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 +0000513
514#define OK 0
515#define NT 1 /* Not tested */
uwe4529d202007-08-23 13:34:59 +0000516
snelson9cba3c62010-01-07 20:09:33 +0000517/* cli_output.c */
518int print(int type, const char *fmt, ...);
hailfingere7326b22010-01-09 03:22:31 +0000519#define MSG_ERROR 0
520#define MSG_INFO 1
521#define MSG_DEBUG 2
522#define MSG_BARF 3
523#define msg_gerr(...) print(MSG_ERROR, __VA_ARGS__) /* general errors */
524#define msg_perr(...) print(MSG_ERROR, __VA_ARGS__) /* programmer errors */
525#define msg_cerr(...) print(MSG_ERROR, __VA_ARGS__) /* chip errors */
526#define msg_ginfo(...) print(MSG_INFO, __VA_ARGS__) /* general info */
527#define msg_pinfo(...) print(MSG_INFO, __VA_ARGS__) /* programmer info */
528#define msg_cinfo(...) print(MSG_INFO, __VA_ARGS__) /* chip info */
529#define msg_gdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* general debug */
530#define msg_pdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* programmer debug */
531#define msg_cdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* chip debug */
532#define msg_gspew(...) print(MSG_BARF, __VA_ARGS__) /* general debug barf */
533#define msg_pspew(...) print(MSG_BARF, __VA_ARGS__) /* programmer debug barf */
534#define msg_cspew(...) print(MSG_BARF, __VA_ARGS__) /* chip debug barf */
snelson9cba3c62010-01-07 20:09:33 +0000535
hailfinger92cd8e32010-01-07 03:24:05 +0000536/* cli_classic.c */
537int cli_classic(int argc, char *argv[]);
538
uwe4529d202007-08-23 13:34:59 +0000539/* layout.c */
stuge98c09aa2008-06-18 02:08:40 +0000540int show_id(uint8_t *bios, int size, int force);
uwe4529d202007-08-23 13:34:59 +0000541int read_romlayout(char *name);
542int find_romentry(char *name);
hailfinger051b3442009-08-19 15:19:18 +0000543int handle_romentries(uint8_t *buffer, struct flashchip *flash);
uwe4529d202007-08-23 13:34:59 +0000544
stepan745615e2007-10-15 21:44:47 +0000545/* spi.c */
hailfinger40167462009-05-31 17:57:34 +0000546enum spi_controller {
547 SPI_CONTROLLER_NONE,
hailfinger80422e22009-12-13 22:28:00 +0000548#if INTERNAL_SUPPORT == 1
hailfinger40167462009-05-31 17:57:34 +0000549 SPI_CONTROLLER_ICH7,
550 SPI_CONTROLLER_ICH9,
551 SPI_CONTROLLER_IT87XX,
552 SPI_CONTROLLER_SB600,
553 SPI_CONTROLLER_VIA,
554 SPI_CONTROLLER_WBSIO,
hailfinger80422e22009-12-13 22:28:00 +0000555#endif
hailfingerd9dcfbd2009-08-19 13:27:58 +0000556#if FT2232_SPI_SUPPORT == 1
hailfingerf31da3d2009-06-16 21:08:06 +0000557 SPI_CONTROLLER_FT2232,
hailfingerd9dcfbd2009-08-19 13:27:58 +0000558#endif
hailfinger571a6b32009-09-16 10:09:21 +0000559#if DUMMY_SUPPORT == 1
hailfinger40167462009-05-31 17:57:34 +0000560 SPI_CONTROLLER_DUMMY,
hailfinger571a6b32009-09-16 10:09:21 +0000561#endif
hailfinger9c5add72009-11-24 00:20:03 +0000562#if BUSPIRATE_SPI_SUPPORT == 1
563 SPI_CONTROLLER_BUSPIRATE,
564#endif
hailfingerdfb32a02010-01-19 11:15:48 +0000565#if DEDIPROG_SUPPORT == 1
566 SPI_CONTROLLER_DEDIPROG,
567#endif
hailfingerd9dcfbd2009-08-19 13:27:58 +0000568 SPI_CONTROLLER_INVALID /* This must always be the last entry. */
hailfinger40167462009-05-31 17:57:34 +0000569};
hailfingerd9dcfbd2009-08-19 13:27:58 +0000570extern const int spi_programmer_count;
hailfinger68002c22009-07-10 21:08:55 +0000571struct spi_command {
572 unsigned int writecnt;
573 unsigned int readcnt;
574 const unsigned char *writearr;
575 unsigned char *readarr;
576};
hailfinger948b81f2009-07-22 15:36:50 +0000577struct spi_programmer {
578 int (*command)(unsigned int writecnt, unsigned int readcnt,
579 const unsigned char *writearr, unsigned char *readarr);
hailfingerbb092112009-09-18 15:50:56 +0000580 int (*multicommand)(struct spi_command *cmds);
hailfinger948b81f2009-07-22 15:36:50 +0000581
582 /* Optimized functions for this programmer */
583 int (*read)(struct flashchip *flash, uint8_t *buf, int start, int len);
584 int (*write_256)(struct flashchip *flash, uint8_t *buf);
585};
hailfinger68002c22009-07-10 21:08:55 +0000586
hailfinger40167462009-05-31 17:57:34 +0000587extern enum spi_controller spi_controller;
hailfinger948b81f2009-07-22 15:36:50 +0000588extern const struct spi_programmer spi_programmer[];
hailfinger40167462009-05-31 17:57:34 +0000589extern void *spibar;
hailfinger68002c22009-07-10 21:08:55 +0000590int spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000591 const unsigned char *writearr, unsigned char *readarr);
hailfingerbb092112009-09-18 15:50:56 +0000592int spi_send_multicommand(struct spi_command *cmds);
hailfinger948b81f2009-07-22 15:36:50 +0000593int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
594 const unsigned char *writearr, unsigned char *readarr);
hailfingerbb092112009-09-18 15:50:56 +0000595int default_spi_send_multicommand(struct spi_command *cmds);
hailfinger088dc812009-12-14 03:32:24 +0000596uint32_t spi_get_valid_read_addr(void);
uweaf9b4df2008-09-26 13:19:02 +0000597
hailfinger82e7ddb2008-05-16 12:55:55 +0000598/* ichspi.c */
hailfinger3d77bc12009-05-01 12:22:17 +0000599int ich_init_opcodes(void);
hailfinger68002c22009-07-10 21:08:55 +0000600int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000601 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000602int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000603int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
hailfingerbb092112009-09-18 15:50:56 +0000604int ich_spi_send_multicommand(struct spi_command *cmds);
hailfinger82e7ddb2008-05-16 12:55:55 +0000605
hailfinger2c361e42008-05-13 23:03:12 +0000606/* it87spi.c */
607extern uint16_t it8716f_flashport;
hailfinger7bac0e52009-05-25 23:26:50 +0000608void enter_conf_mode_ite(uint16_t port);
609void exit_conf_mode_ite(uint16_t port);
hailfingerc236f9e2009-12-22 23:42:04 +0000610struct superio probe_superio_ite(void);
hailfinger26e212b2009-05-31 18:00:57 +0000611int it87spi_init(void);
hailfinger82e7ddb2008-05-16 12:55:55 +0000612int it87xx_probe_spi_flash(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000613int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwefa98ca12008-10-18 21:14:13 +0000614 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000615int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000616int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
hailfinger2c361e42008-05-13 23:03:12 +0000617
uwe17efbed2008-11-28 21:36:51 +0000618/* sb600spi.c */
hailfinger68002c22009-07-10 21:08:55 +0000619int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe17efbed2008-11-28 21:36:51 +0000620 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000621int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000622int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
hailfinger38da6812009-05-17 15:49:24 +0000623extern uint8_t *sb600_spibar;
uwe17efbed2008-11-28 21:36:51 +0000624
stugea564bcf2009-01-26 03:08:45 +0000625/* wbsio_spi.c */
626int wbsio_check_for_spi(const char *name);
hailfinger68002c22009-07-10 21:08:55 +0000627int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
uwe4e204a22009-05-28 15:07:42 +0000628 const unsigned char *writearr, unsigned char *readarr);
hailfinger0f08b7a2009-06-16 08:55:44 +0000629int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
hailfingered063f52009-05-09 02:30:21 +0000630int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
stugea564bcf2009-01-26 03:08:45 +0000631
hailfinger37b4fbf2009-06-23 11:33:43 +0000632/* serprog.c */
hailfinger37b4fbf2009-06-23 11:33:43 +0000633int serprog_init(void);
634int serprog_shutdown(void);
635void serprog_chip_writeb(uint8_t val, chipaddr addr);
636uint8_t serprog_chip_readb(const chipaddr addr);
637void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
638void serprog_delay(int delay);
hailfinger4979b042009-11-23 19:20:11 +0000639
640/* serial.c */
oxygene3ad3b332010-01-06 22:14:39 +0000641#if _WIN32
642typedef HANDLE fdtype;
643#else
644typedef int fdtype;
645#endif
646
hailfingerb88282e2009-11-21 11:02:48 +0000647void sp_flush_incoming(void);
oxygene3ad3b332010-01-06 22:14:39 +0000648fdtype sp_openserport(char *dev, unsigned int baud);
hailfinger4979b042009-11-23 19:20:11 +0000649void __attribute__((noreturn)) sp_die(char *msg);
oxygene3ad3b332010-01-06 22:14:39 +0000650extern fdtype sp_fd;
hailfinger852163c2010-01-06 16:09:10 +0000651int serialport_shutdown(void);
652int serialport_write(unsigned char *buf, unsigned int writecnt);
653int serialport_read(unsigned char *buf, unsigned int readcnt);
uwe619a15a2009-06-28 23:26:37 +0000654
hailfinger088dc812009-12-14 03:32:24 +0000655#include "chipdrivers.h"
656
ollie5b621572004-03-20 16:46:10 +0000657#endif /* !__FLASH_H__ */