flash.h 21.5 KB
Newer Older
1
/*
2
 * This file is part of the flashrom project.
3
 *
4 5
 * Copyright (C) 2000 Silicon Integrated System Corporation
 * Copyright (C) 2000 Ronald G. Minnich <rminnich@gmail.com>
6
 * Copyright (C) 2005-2009 coresystems GmbH
7
 * Copyright (C) 2006-2009 Carl-Daniel Hailfinger
8
 *
9 10 11 12
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
13
 *
14 15 16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
18
 *
19 20 21
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
22 23
 */

Ronald G. Minnich's avatar
Ronald G. Minnich committed
24 25 26
#ifndef __FLASH_H__
#define __FLASH_H__ 1

27
#include <unistd.h>
28
#include <stdint.h>
29
#include <stdio.h>
30
#include "hwaccess.h"
Patrick Georgi's avatar
Patrick Georgi committed
31 32 33 34 35
#ifdef _WIN32
#include <windows.h>
#undef min
#undef max
#endif
36

37 38
typedef unsigned long chipaddr;

39
enum programmer {
40
#if INTERNAL_SUPPORT == 1
41
	PROGRAMMER_INTERNAL,
42
#endif
43
#if DUMMY_SUPPORT == 1
44
	PROGRAMMER_DUMMY,
45 46
#endif
#if NIC3COM_SUPPORT == 1
47
	PROGRAMMER_NIC3COM,
48
#endif
49 50 51
#if GFXNVIDIA_SUPPORT == 1
	PROGRAMMER_GFXNVIDIA,
#endif
52
#if DRKAISER_SUPPORT == 1
53
	PROGRAMMER_DRKAISER,
54 55
#endif
#if SATASII_SUPPORT == 1
56
	PROGRAMMER_SATASII,
57
#endif
58
#if INTERNAL_SUPPORT == 1
59
	PROGRAMMER_IT87SPI,
60
#endif
61
#if FT2232_SPI_SUPPORT == 1
62
	PROGRAMMER_FT2232SPI,
63
#endif
64
#if SERPROG_SUPPORT == 1
65
	PROGRAMMER_SERPROG,
66 67 68
#endif
#if BUSPIRATE_SPI_SUPPORT == 1
	PROGRAMMER_BUSPIRATESPI,
69 70 71
#endif
#if DEDIPROG_SUPPORT == 1
	PROGRAMMER_DEDIPROG,
72
#endif
73
	PROGRAMMER_INVALID /* This must always be the last entry. */
74 75 76
};

extern enum programmer programmer;
77 78 79 80 81 82 83 84

struct programmer_entry {
	const char *vendor;
	const char *name;

	int (*init) (void);
	int (*shutdown) (void);

Uwe Hermann's avatar
Uwe Hermann committed
85 86
	void * (*map_flash_region) (const char *descr, unsigned long phys_addr,
				    size_t len);
87 88
	void (*unmap_flash_region) (void *virt_addr, size_t len);

89 90 91
	void (*chip_writeb) (uint8_t val, chipaddr addr);
	void (*chip_writew) (uint16_t val, chipaddr addr);
	void (*chip_writel) (uint32_t val, chipaddr addr);
92
	void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
93 94 95
	uint8_t (*chip_readb) (const chipaddr addr);
	uint16_t (*chip_readw) (const chipaddr addr);
	uint32_t (*chip_readl) (const chipaddr addr);
96
	void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
97
	void (*delay) (int usecs);
98 99 100 101
};

extern const struct programmer_entry programmer_table[];

102 103
int register_shutdown(void (*function) (void *data), void *data);

104 105 106 107 108 109 110 111
int programmer_init(void);
int programmer_shutdown(void);
void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
				  size_t len);
void programmer_unmap_flash_region(void *virt_addr, size_t len);
void chip_writeb(uint8_t val, chipaddr addr);
void chip_writew(uint16_t val, chipaddr addr);
void chip_writel(uint32_t val, chipaddr addr);
112
void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
113 114 115
uint8_t chip_readb(const chipaddr addr);
uint16_t chip_readw(const chipaddr addr);
uint32_t chip_readl(const chipaddr addr);
116
void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
117
void programmer_delay(int usecs);
118

119 120
enum bitbang_spi_master {
	BITBANG_SPI_INVALID /* This must always be the last entry. */
121 122
};

123
extern const int bitbang_spi_master_count;
124

125
extern enum bitbang_spi_master bitbang_spi_master;
126

127
struct bitbang_spi_master_entry {
128 129 130 131 132 133
	void (*set_cs) (int val);
	void (*set_sck) (int val);
	void (*set_mosi) (int val);
	int (*get_miso) (void);
};

134 135
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))

136
enum chipbustype {
137
	CHIP_BUSTYPE_NONE	= 0,
138 139 140 141 142 143 144 145
	CHIP_BUSTYPE_PARALLEL	= 1 << 0,
	CHIP_BUSTYPE_LPC	= 1 << 1,
	CHIP_BUSTYPE_FWH	= 1 << 2,
	CHIP_BUSTYPE_SPI	= 1 << 3,
	CHIP_BUSTYPE_NONSPI	= CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH,
	CHIP_BUSTYPE_UNKNOWN	= CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH | CHIP_BUSTYPE_SPI,
};

146 147 148 149 150 151 152 153 154 155 156
/*
 * How many different contiguous runs of erase blocks with one size each do
 * we have for a given erase function?
 */
#define NUM_ERASEREGIONS 5

/*
 * How many different erase functions do we have per chip?
 */
#define NUM_ERASEFUNCTIONS 5

157 158
#define FEATURE_REGISTERMAP	(1 << 0)
#define FEATURE_BYTEWRITES	(1 << 1)
159 160 161
#define FEATURE_LONG_RESET	(0 << 4)
#define FEATURE_SHORT_RESET	(1 << 4)
#define FEATURE_EITHER_RESET	FEATURE_LONG_RESET
162 163
#define FEATURE_ADDR_FULL	(0 << 2)
#define FEATURE_ADDR_MASK	(3 << 2)
164 165 166
#define FEATURE_ADDR_2AA	(1 << 2)
#define FEATURE_ADDR_AAA	(2 << 2)
#define FEATURE_ADDR_SHIFTED	0
167

168
struct flashchip {
169
	const char *vendor;
170
	const char *name;
171 172 173

	enum chipbustype bustype;

174 175
	/*
	 * With 32bit manufacture_id and model_id we can cover IDs up to
176 177 178 179 180
	 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
	 * Identification code.
	 */
	uint32_t manufacture_id;
	uint32_t model_id;
181 182 183

	int total_size;
	int page_size;
184
	int feature_bits;
185

186 187
	/*
	 * Indicate if flashrom has been tested with this flash chip and if
188 189 190 191
	 * everything worked correctly.
	 */
	uint32_t tested;

Uwe Hermann's avatar
Uwe Hermann committed
192
	int (*probe) (struct flashchip *flash);
193 194 195

	/* Delay after "enter/exit ID mode" commands in microseconds. */
	int probe_timing;
196 197

	/*
198 199
	 * Erase blocks and associated erase function. Any chip erase function
	 * is stored as chip-sized virtual block together with said function.
200 201 202 203 204 205 206 207 208
	 */
	struct block_eraser {
		struct eraseblock{
			unsigned int size; /* Eraseblock size */
			unsigned int count; /* Number of contiguous blocks with that size */
		} eraseblocks[NUM_ERASEREGIONS];
		int (*block_erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
	} block_erasers[NUM_ERASEFUNCTIONS];

Uwe Hermann's avatar
Uwe Hermann committed
209
	int (*write) (struct flashchip *flash, uint8_t *buf);
210
	int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
Ronald G. Minnich's avatar
Ronald G. Minnich committed
211

212
	/* Some flash devices have an additional register space. */
213 214
	chipaddr virtual_memory;
	chipaddr virtual_registers;
215 216
};

217 218
#define TEST_UNTESTED	0

Uwe Hermann's avatar
Uwe Hermann committed
219 220 221 222 223 224
#define TEST_OK_PROBE	(1 << 0)
#define TEST_OK_READ	(1 << 1)
#define TEST_OK_ERASE	(1 << 2)
#define TEST_OK_WRITE	(1 << 3)
#define TEST_OK_PR	(TEST_OK_PROBE | TEST_OK_READ)
#define TEST_OK_PRE	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
225
#define TEST_OK_PRW	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
Uwe Hermann's avatar
Uwe Hermann committed
226
#define TEST_OK_PREW	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
227 228
#define TEST_OK_MASK	0x0f

Uwe Hermann's avatar
Uwe Hermann committed
229 230 231 232 233
#define TEST_BAD_PROBE	(1 << 4)
#define TEST_BAD_READ	(1 << 5)
#define TEST_BAD_ERASE	(1 << 6)
#define TEST_BAD_WRITE	(1 << 7)
#define TEST_BAD_PREW	(TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
234 235
#define TEST_BAD_MASK	0xf0

236 237 238 239 240 241 242 243 244 245
/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
 * field and zero delay.
 * 
 * SPI devices will always have zero delay and ignore this field.
 */
#define TIMING_FIXME	-1
/* this is intentionally same value as fixme */
#define TIMING_IGNORED	-1
#define TIMING_ZERO	-2

246 247
extern struct flashchip flashchips[];

248
#if INTERNAL_SUPPORT == 1
Uwe Hermann's avatar
Uwe Hermann committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
struct penable {
	uint16_t vendor_id;
	uint16_t device_id;
	int status;
	const char *vendor_name;
	const char *device_name;
	int (*doit) (struct pci_dev *dev, const char *name);
};

extern const struct penable chipset_enables[];

struct board_pciid_enable {
	/* Any device, but make it sensible, like the ISA bridge. */
	uint16_t first_vendor;
	uint16_t first_device;
	uint16_t first_card_vendor;
	uint16_t first_card_device;

	/* Any device, but make it sensible, like
	 * the host bridge. May be NULL.
	 */
	uint16_t second_vendor;
	uint16_t second_device;
	uint16_t second_card_vendor;
	uint16_t second_card_device;

Michael Karcher's avatar
Michael Karcher committed
275 276 277
	/* Pattern to match DMI entries */
	const char *dmi_pattern;

Uwe Hermann's avatar
Uwe Hermann committed
278 279 280 281 282 283 284
	/* The vendor / part name from the coreboot table. */
	const char *lb_vendor;
	const char *lb_part;

	const char *vendor_name;
	const char *board_name;

285
	int max_rom_decode_parallel;
Uwe Hermann's avatar
Uwe Hermann committed
286 287 288 289 290 291 292 293 294 295 296 297
	int (*enable) (const char *name);
};

extern struct board_pciid_enable board_pciid_enables[];

struct board_info {
	const char *vendor;
	const char *name;
};

extern const struct board_info boards_ok[];
extern const struct board_info boards_bad[];
298 299
extern const struct board_info laptops_ok[];
extern const struct board_info laptops_bad[];
300
#endif
Uwe Hermann's avatar
Uwe Hermann committed
301

302
/* udelay.c */
303
void myusec_delay(int usecs);
304
void myusec_calibrate_delay(void);
305
void internal_delay(int usecs);
306

307
#if NEED_PCI == 1
308 309 310
/* pcidev.c */
#define PCI_OK 0
#define PCI_NT 1    /* Not tested */
311

312 313
extern uint32_t io_base_addr;
extern struct pci_access *pacc;
314
extern struct pci_dev *pcidev_dev;
315 316 317 318 319 320 321
struct pcidev_status {
	uint16_t vendor_id;
	uint16_t device_id;
	int status;
	const char *vendor_name;
	const char *device_name;
};
322 323
uint32_t pcidev_validate(struct pci_dev *dev, uint32_t bar, struct pcidev_status *devs);
uint32_t pcidev_init(uint16_t vendor_id, uint32_t bar, struct pcidev_status *devs, char *pcidev_bdf);
324
#endif
325 326 327

/* print.c */
char *flashbuses_to_text(enum chipbustype bustype);
328
void print_supported(void);
329
#if (NIC3COM_SUPPORT == 1) || (GFXNVIDIA_SUPPORT == 1) || (DRKAISER_SUPPORT == 1) || (SATASII_SUPPORT == 1)
330
void print_supported_pcidevs(struct pcidev_status *devs);
331
#endif
332
void print_supported_wiki(void);
333

334
/* board_enable.c */
335 336
void w836xx_ext_enter(uint16_t port);
void w836xx_ext_leave(uint16_t port);
337 338 339
uint8_t sio_read(uint16_t port, uint8_t reg);
void sio_write(uint16_t port, uint8_t reg, uint8_t data);
void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
340
int board_flash_enable(const char *vendor, const char *part);
341

342 343
/* chipset_enable.c */
int chipset_flash_enable(void);
344

345 346
/* physmap.c */
void *physmap(const char *descr, unsigned long phys_addr, size_t len);
347
void *physmap_try_ro(const char *descr, unsigned long phys_addr, size_t len);
348
void physunmap(void *virt_addr, size_t len);
349 350
int setup_cpu_msr(int cpu);
void cleanup_cpu_msr(void);
351 352 353 354 355 356

/* cbtable.c */
void lb_vendor_dev_from_string(char *boardstring);
int coreboot_init(void);
extern char *lb_part, *lb_vendor;
extern int partvendor_from_cbtable;
357

Michael Karcher's avatar
Michael Karcher committed
358 359 360 361 362
/* dmi.c */
extern int has_dmi_support;
void dmi_init(void);
int dmi_match(const char *pattern);

363
/* internal.c */
364
#if NEED_PCI == 1
365 366 367 368 369 370 371 372
struct superio {
	uint16_t vendor;
	uint16_t port;
	uint16_t model;
};
extern struct superio superio;
#define SUPERIO_VENDOR_NONE	0x0
#define SUPERIO_VENDOR_ITE	0x1
373
struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
374
struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t class);
375 376 377
struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
			      uint16_t card_vendor, uint16_t card_device);
378
#endif
379
void get_io_perms(void);
380
void release_io_perms(void);
381
#if INTERNAL_SUPPORT == 1
382
void probe_superio(void);
383 384
int internal_init(void);
int internal_shutdown(void);
385 386 387 388 389 390
void internal_chip_writeb(uint8_t val, chipaddr addr);
void internal_chip_writew(uint16_t val, chipaddr addr);
void internal_chip_writel(uint32_t val, chipaddr addr);
uint8_t internal_chip_readb(const chipaddr addr);
uint16_t internal_chip_readw(const chipaddr addr);
uint32_t internal_chip_readl(const chipaddr addr);
391
void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
392
#endif
393 394 395 396 397 398
void mmio_writeb(uint8_t val, void *addr);
void mmio_writew(uint16_t val, void *addr);
void mmio_writel(uint32_t val, void *addr);
uint8_t mmio_readb(void *addr);
uint16_t mmio_readw(void *addr);
uint32_t mmio_readl(void *addr);
399 400

/* programmer.c */
401
int noop_shutdown(void);
402 403
void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
void fallback_unmap(void *virt_addr, size_t len);
404 405
uint8_t noop_chip_readb(const chipaddr addr);
void noop_chip_writeb(uint8_t val, chipaddr addr);
406 407
void fallback_chip_writew(uint16_t val, chipaddr addr);
void fallback_chip_writel(uint32_t val, chipaddr addr);
408
void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
409 410
uint16_t fallback_chip_readw(const chipaddr addr);
uint32_t fallback_chip_readl(const chipaddr addr);
411
void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
412

413
/* dummyflasher.c */
414
#if DUMMY_SUPPORT == 1
415 416
int dummy_init(void);
int dummy_shutdown(void);
417 418
void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
void dummy_unmap(void *virt_addr, size_t len);
419 420 421
void dummy_chip_writeb(uint8_t val, chipaddr addr);
void dummy_chip_writew(uint16_t val, chipaddr addr);
void dummy_chip_writel(uint32_t val, chipaddr addr);
422
void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
423 424 425
uint8_t dummy_chip_readb(const chipaddr addr);
uint16_t dummy_chip_readw(const chipaddr addr);
uint32_t dummy_chip_readl(const chipaddr addr);
426
void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
427
int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
428
		      const unsigned char *writearr, unsigned char *readarr);
429
#endif
430

431
/* nic3com.c */
432
#if NIC3COM_SUPPORT == 1
433 434
int nic3com_init(void);
int nic3com_shutdown(void);
435 436
void nic3com_chip_writeb(uint8_t val, chipaddr addr);
uint8_t nic3com_chip_readb(const chipaddr addr);
437
extern struct pcidev_status nics_3com[];
438
#endif
439

440
/* gfxnvidia.c */
441
#if GFXNVIDIA_SUPPORT == 1
442 443 444 445 446
int gfxnvidia_init(void);
int gfxnvidia_shutdown(void);
void gfxnvidia_chip_writeb(uint8_t val, chipaddr addr);
uint8_t gfxnvidia_chip_readb(const chipaddr addr);
extern struct pcidev_status gfx_nvidia[];
447
#endif
448

449
/* drkaiser.c */
450
#if DRKAISER_SUPPORT == 1
451 452 453 454 455
int drkaiser_init(void);
int drkaiser_shutdown(void);
void drkaiser_chip_writeb(uint8_t val, chipaddr addr);
uint8_t drkaiser_chip_readb(const chipaddr addr);
extern struct pcidev_status drkaiser_pcidev[];
456
#endif
457

458
/* satasii.c */
459
#if SATASII_SUPPORT == 1
460 461 462 463 464
int satasii_init(void);
int satasii_shutdown(void);
void satasii_chip_writeb(uint8_t val, chipaddr addr);
uint8_t satasii_chip_readb(const chipaddr addr);
extern struct pcidev_status satas_sii[];
465
#endif
466

467
/* ft2232_spi.c */
468 469
#define FTDI_FT2232H 0x6010
#define FTDI_FT4232H 0x6011
470
int ft2232_spi_init(void);
471
int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
472 473 474
int ft2232_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
int ft2232_spi_write_256(struct flashchip *flash, uint8_t *buf);

475
/* bitbang_spi.c */
476 477
extern int bitbang_spi_half_period;
extern const struct bitbang_spi_master_entry bitbang_spi_master_table[];
478 479 480 481 482
int bitbang_spi_init(void);
int bitbang_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
int bitbang_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
int bitbang_spi_write_256(struct flashchip *flash, uint8_t *buf);

483
/* buspirate_spi.c */
484 485 486 487
struct buspirate_spispeeds {
	const char *name;
	const int speed;
};
488 489 490 491 492
int buspirate_spi_init(void);
int buspirate_spi_shutdown(void);
int buspirate_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
int buspirate_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);

493 494 495 496 497 498
/* dediprog.c */
int dediprog_init(void);
int dediprog_shutdown(void);
int dediprog_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
int dediprog_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);

499
/* flashrom.c */
500 501 502 503 504 505 506 507
extern enum chipbustype buses_supported;
struct decode_sizes {
	uint32_t parallel;
	uint32_t lpc;
	uint32_t fwh;
	uint32_t spi;
};
extern struct decode_sizes max_rom_decode;
508
extern char *programmer_param;
509
extern unsigned long flashbase;
Uwe Hermann's avatar
Uwe Hermann committed
510
extern int verbose;
511
extern const char *flashrom_version;
512
extern char *chip_to_probe;
Uwe Hermann's avatar
Uwe Hermann committed
513
#define printf_debug(x...) { if (verbose) printf(x); }
514
void map_flash_registers(struct flashchip *flash);
515
int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
516
int erase_flash(struct flashchip *flash);
517 518 519 520
struct flashchip *probe_flash(struct flashchip *first_flash, int force);
int read_flash(struct flashchip *flash, char *filename);
void check_chip_supported(struct flashchip *flash);
int check_max_decode(enum chipbustype buses, uint32_t size);
521
int min(int a, int b);
522
int max(int a, int b);
523
char *extract_param(char **haystack, char *needle, char *delim);
524 525
int check_erased_range(struct flashchip *flash, int start, int len);
int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
526
char *strcat_realloc(char *dest, const char *src);
527 528
void print_version(void);
int selfcheck(void);
529
int doit(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it);
530 531 532

#define OK 0
#define NT 1    /* Not tested */
533

534 535
/* cli_output.c */
int print(int type, const char *fmt, ...);
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
#define MSG_ERROR	0
#define MSG_INFO	1
#define MSG_DEBUG	2
#define MSG_BARF	3
#define msg_gerr(...)	print(MSG_ERROR, __VA_ARGS__)	/* general errors */
#define msg_perr(...)	print(MSG_ERROR, __VA_ARGS__)	/* programmer errors */
#define msg_cerr(...)	print(MSG_ERROR, __VA_ARGS__)	/* chip errors */
#define msg_ginfo(...)	print(MSG_INFO, __VA_ARGS__)	/* general info */
#define msg_pinfo(...)	print(MSG_INFO, __VA_ARGS__)	/* programmer info */
#define msg_cinfo(...)	print(MSG_INFO, __VA_ARGS__)	/* chip info */
#define msg_gdbg(...)	print(MSG_DEBUG, __VA_ARGS__)	/* general debug */
#define msg_pdbg(...)	print(MSG_DEBUG, __VA_ARGS__)	/* programmer debug */
#define msg_cdbg(...)	print(MSG_DEBUG, __VA_ARGS__)	/* chip debug */
#define msg_gspew(...)	print(MSG_BARF, __VA_ARGS__)	/* general debug barf  */
#define msg_pspew(...)	print(MSG_BARF, __VA_ARGS__)	/* programmer debug barf  */
#define msg_cspew(...)	print(MSG_BARF, __VA_ARGS__)	/* chip debug barf  */
552

553 554 555
/* cli_classic.c */
int cli_classic(int argc, char *argv[]);

556
/* layout.c */
Peter Stuge's avatar
Peter Stuge committed
557
int show_id(uint8_t *bios, int size, int force);
558 559
int read_romlayout(char *name);
int find_romentry(char *name);
560
int handle_romentries(uint8_t *buffer, struct flashchip *flash);
561

562
/* spi.c */
563 564
enum spi_controller {
	SPI_CONTROLLER_NONE,
565
#if INTERNAL_SUPPORT == 1
566 567 568 569 570 571
	SPI_CONTROLLER_ICH7,
	SPI_CONTROLLER_ICH9,
	SPI_CONTROLLER_IT87XX,
	SPI_CONTROLLER_SB600,
	SPI_CONTROLLER_VIA,
	SPI_CONTROLLER_WBSIO,
572
#endif
573
#if FT2232_SPI_SUPPORT == 1
574
	SPI_CONTROLLER_FT2232,
575
#endif
576
#if DUMMY_SUPPORT == 1
577
	SPI_CONTROLLER_DUMMY,
578 579 580
#endif
#if BUSPIRATE_SPI_SUPPORT == 1
	SPI_CONTROLLER_BUSPIRATE,
581 582 583
#endif
#if DEDIPROG_SUPPORT == 1
	SPI_CONTROLLER_DEDIPROG,
584
#endif
585
	SPI_CONTROLLER_INVALID /* This must always be the last entry. */
586
};
587
extern const int spi_programmer_count;
588 589 590 591 592 593
struct spi_command {
	unsigned int writecnt;
	unsigned int readcnt;
	const unsigned char *writearr;
	unsigned char *readarr;
};
594 595 596
struct spi_programmer {
	int (*command)(unsigned int writecnt, unsigned int readcnt,
		   const unsigned char *writearr, unsigned char *readarr);
597
	int (*multicommand)(struct spi_command *cmds);
598 599 600 601 602

	/* Optimized functions for this programmer */
	int (*read)(struct flashchip *flash, uint8_t *buf, int start, int len);
	int (*write_256)(struct flashchip *flash, uint8_t *buf);
};
603

604
extern enum spi_controller spi_controller;
605
extern const struct spi_programmer spi_programmer[];
606
extern void *spibar;
607
int spi_send_command(unsigned int writecnt, unsigned int readcnt,
608
		const unsigned char *writearr, unsigned char *readarr);
609
int spi_send_multicommand(struct spi_command *cmds);
610 611
int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
			     const unsigned char *writearr, unsigned char *readarr);
612
int default_spi_send_multicommand(struct spi_command *cmds);
613
uint32_t spi_get_valid_read_addr(void);
614

615
/* ichspi.c */
616
int ich_init_opcodes(void);
617
int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
618
		    const unsigned char *writearr, unsigned char *readarr);
619
int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
620
int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
621
int ich_spi_send_multicommand(struct spi_command *cmds);
622

623 624
/* it87spi.c */
extern uint16_t it8716f_flashport;
625 626
void enter_conf_mode_ite(uint16_t port);
void exit_conf_mode_ite(uint16_t port);
627
struct superio probe_superio_ite(void);
628
int it87spi_init(void);
629
int it87xx_probe_spi_flash(const char *name);
630
int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
631
			const unsigned char *writearr, unsigned char *readarr);
632
int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
633
int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
634

635
/* sb600spi.c */
636
int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
637
		      const unsigned char *writearr, unsigned char *readarr);
638
int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
639
int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
640
extern uint8_t *sb600_spibar;
641

Peter Stuge's avatar
Peter Stuge committed
642 643
/* wbsio_spi.c */
int wbsio_check_for_spi(const char *name);
644
int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann's avatar
Uwe Hermann committed
645
		      const unsigned char *writearr, unsigned char *readarr);
646
int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
647
int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
Peter Stuge's avatar
Peter Stuge committed
648

649 650 651 652 653 654 655
/* serprog.c */
int serprog_init(void);
int serprog_shutdown(void);
void serprog_chip_writeb(uint8_t val, chipaddr addr);
uint8_t serprog_chip_readb(const chipaddr addr);
void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
void serprog_delay(int delay);
656 657

/* serial.c */
Patrick Georgi's avatar
Patrick Georgi committed
658 659 660 661 662 663
#if _WIN32
typedef HANDLE fdtype;
#else
typedef int fdtype;
#endif

664
void sp_flush_incoming(void);
Patrick Georgi's avatar
Patrick Georgi committed
665
fdtype sp_openserport(char *dev, unsigned int baud);
666
void __attribute__((noreturn)) sp_die(char *msg);
Patrick Georgi's avatar
Patrick Georgi committed
667
extern fdtype sp_fd;
668 669 670
int serialport_shutdown(void);
int serialport_write(unsigned char *buf, unsigned int writecnt);
int serialport_read(unsigned char *buf, unsigned int readcnt);
Uwe Hermann's avatar
Uwe Hermann committed
671

672 673
#include "chipdrivers.h"

674
#endif				/* !__FLASH_H__ */