flash.h 21.1 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 104 105 106 107 108 109
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);
110
void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
111 112 113
uint8_t chip_readb(const chipaddr addr);
uint16_t chip_readw(const chipaddr addr);
uint32_t chip_readl(const chipaddr addr);
114
void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
115
void programmer_delay(int usecs);
116

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

121
extern const int bitbang_spi_master_count;
122

123
extern enum bitbang_spi_master bitbang_spi_master;
124

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

132 133
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))

134
enum chipbustype {
135
	CHIP_BUSTYPE_NONE	= 0,
136 137 138 139 140 141 142 143
	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,
};

144 145 146 147 148 149 150 151 152 153 154
/*
 * 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

155 156 157 158
#define FEATURE_REGISTERMAP	(1 << 0)
#define FEATURE_BYTEWRITES	(1 << 1)
#define FEATURE_ADDR_FULL	(0 << 2)
#define FEATURE_ADDR_MASK	(3 << 2)
159

160
struct flashchip {
161
	const char *vendor;
162
	const char *name;
163 164 165

	enum chipbustype bustype;

166 167
	/*
	 * With 32bit manufacture_id and model_id we can cover IDs up to
168 169 170 171 172
	 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
	 * Identification code.
	 */
	uint32_t manufacture_id;
	uint32_t model_id;
173 174 175

	int total_size;
	int page_size;
176
	int feature_bits;
177

178 179
	/*
	 * Indicate if flashrom has been tested with this flash chip and if
180 181 182 183
	 * everything worked correctly.
	 */
	uint32_t tested;

Uwe Hermann's avatar
Uwe Hermann committed
184
	int (*probe) (struct flashchip *flash);
185 186 187

	/* Delay after "enter/exit ID mode" commands in microseconds. */
	int probe_timing;
Uwe Hermann's avatar
Uwe Hermann committed
188
	int (*erase) (struct flashchip *flash);
189 190

	/*
191 192
	 * Erase blocks and associated erase function. Any chip erase function
	 * is stored as chip-sized virtual block together with said function.
193 194 195 196 197 198 199 200 201
	 */
	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
202
	int (*write) (struct flashchip *flash, uint8_t *buf);
203
	int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
Ronald G. Minnich's avatar
Ronald G. Minnich committed
204

205
	/* Some flash devices have an additional register space. */
206 207
	chipaddr virtual_memory;
	chipaddr virtual_registers;
208 209
};

210 211
#define TEST_UNTESTED	0

Uwe Hermann's avatar
Uwe Hermann committed
212 213 214 215 216 217
#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)
218
#define TEST_OK_PRW	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
Uwe Hermann's avatar
Uwe Hermann committed
219
#define TEST_OK_PREW	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
220 221
#define TEST_OK_MASK	0x0f

Uwe Hermann's avatar
Uwe Hermann committed
222 223 224 225 226
#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)
227 228
#define TEST_BAD_MASK	0xf0

229 230 231 232 233 234 235 236 237 238
/* 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

239 240
extern struct flashchip flashchips[];

241
#if INTERNAL_SUPPORT == 1
Uwe Hermann's avatar
Uwe Hermann committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
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
268 269 270
	/* Pattern to match DMI entries */
	const char *dmi_pattern;

Uwe Hermann's avatar
Uwe Hermann committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
	/* The vendor / part name from the coreboot table. */
	const char *lb_vendor;
	const char *lb_part;

	const char *vendor_name;
	const char *board_name;

	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[];
290 291
extern const struct board_info laptops_ok[];
extern const struct board_info laptops_bad[];
292
#endif
Uwe Hermann's avatar
Uwe Hermann committed
293

294
/* udelay.c */
295
void myusec_delay(int usecs);
296
void myusec_calibrate_delay(void);
297
void internal_delay(int usecs);
298

299
#if NEED_PCI == 1
300 301 302
/* pcidev.c */
#define PCI_OK 0
#define PCI_NT 1    /* Not tested */
303

304 305
extern uint32_t io_base_addr;
extern struct pci_access *pacc;
306
extern struct pci_dev *pcidev_dev;
307 308 309 310 311 312 313
struct pcidev_status {
	uint16_t vendor_id;
	uint16_t device_id;
	int status;
	const char *vendor_name;
	const char *device_name;
};
314 315
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);
316
#endif
317 318 319

/* print.c */
char *flashbuses_to_text(enum chipbustype bustype);
320
void print_supported(void);
321
#if (NIC3COM_SUPPORT == 1) || (GFXNVIDIA_SUPPORT == 1) || (DRKAISER_SUPPORT == 1) || (SATASII_SUPPORT == 1)
322
void print_supported_pcidevs(struct pcidev_status *devs);
323
#endif
324
void print_supported_wiki(void);
325

326
/* board_enable.c */
327 328
void w836xx_ext_enter(uint16_t port);
void w836xx_ext_leave(uint16_t port);
329 330 331
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);
332
int board_flash_enable(const char *vendor, const char *part);
333

334 335
/* chipset_enable.c */
int chipset_flash_enable(void);
336

337 338 339
/* physmap.c */
void *physmap(const char *descr, unsigned long phys_addr, size_t len);
void physunmap(void *virt_addr, size_t len);
340 341
int setup_cpu_msr(int cpu);
void cleanup_cpu_msr(void);
342 343 344 345 346 347

/* 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;
348

Michael Karcher's avatar
Michael Karcher committed
349 350 351 352 353
/* dmi.c */
extern int has_dmi_support;
void dmi_init(void);
int dmi_match(const char *pattern);

354
/* internal.c */
355
#if NEED_PCI == 1
356 357 358 359 360 361 362 363
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
364
struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
365
struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t class);
366 367 368
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);
369
#endif
370
void get_io_perms(void);
371
void release_io_perms(void);
372
#if INTERNAL_SUPPORT == 1
373
void probe_superio(void);
374 375
int internal_init(void);
int internal_shutdown(void);
376 377 378 379 380 381
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);
382
void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
383
#endif
384 385 386 387 388 389
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);
390 391

/* programmer.c */
392
int noop_shutdown(void);
393 394
void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
void fallback_unmap(void *virt_addr, size_t len);
395 396
uint8_t noop_chip_readb(const chipaddr addr);
void noop_chip_writeb(uint8_t val, chipaddr addr);
397 398
void fallback_chip_writew(uint16_t val, chipaddr addr);
void fallback_chip_writel(uint32_t val, chipaddr addr);
399
void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
400 401
uint16_t fallback_chip_readw(const chipaddr addr);
uint32_t fallback_chip_readl(const chipaddr addr);
402
void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
403

404
/* dummyflasher.c */
405
#if DUMMY_SUPPORT == 1
406 407
int dummy_init(void);
int dummy_shutdown(void);
408 409
void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
void dummy_unmap(void *virt_addr, size_t len);
410 411 412
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);
413
void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
414 415 416
uint8_t dummy_chip_readb(const chipaddr addr);
uint16_t dummy_chip_readw(const chipaddr addr);
uint32_t dummy_chip_readl(const chipaddr addr);
417
void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
418
int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
419
		      const unsigned char *writearr, unsigned char *readarr);
420
#endif
421

422
/* nic3com.c */
423
#if NIC3COM_SUPPORT == 1
424 425
int nic3com_init(void);
int nic3com_shutdown(void);
426 427
void nic3com_chip_writeb(uint8_t val, chipaddr addr);
uint8_t nic3com_chip_readb(const chipaddr addr);
428
extern struct pcidev_status nics_3com[];
429
#endif
430

431
/* gfxnvidia.c */
432
#if GFXNVIDIA_SUPPORT == 1
433 434 435 436 437
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[];
438
#endif
439

440
/* drkaiser.c */
441
#if DRKAISER_SUPPORT == 1
442 443 444 445 446
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[];
447
#endif
448

449
/* satasii.c */
450
#if SATASII_SUPPORT == 1
451 452 453 454 455
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[];
456
#endif
457

458
/* ft2232_spi.c */
459 460
#define FTDI_FT2232H 0x6010
#define FTDI_FT4232H 0x6011
461
int ft2232_spi_init(void);
462
int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
463 464 465
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);

466
/* bitbang_spi.c */
467 468
extern int bitbang_spi_half_period;
extern const struct bitbang_spi_master_entry bitbang_spi_master_table[];
469 470 471 472 473
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);

474
/* buspirate_spi.c */
475 476 477 478
struct buspirate_spispeeds {
	const char *name;
	const int speed;
};
479 480 481 482 483
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);

484 485 486 487 488 489
/* 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);

490
/* flashrom.c */
491 492 493 494 495 496 497 498
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;
499
extern char *programmer_param;
500
extern unsigned long flashbase;
Uwe Hermann's avatar
Uwe Hermann committed
501
extern int verbose;
502
extern const char *flashrom_version;
503
extern char *chip_to_probe;
Uwe Hermann's avatar
Uwe Hermann committed
504
#define printf_debug(x...) { if (verbose) printf(x); }
505
void map_flash_registers(struct flashchip *flash);
506
int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
507
int erase_flash(struct flashchip *flash);
508 509 510 511
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);
512
int min(int a, int b);
513
int max(int a, int b);
514
char *extract_param(char **haystack, char *needle, char *delim);
515 516
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);
517
char *strcat_realloc(char *dest, const char *src);
518 519
void print_version(void);
int selfcheck(void);
520
int doit(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it);
521 522 523

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

525 526
/* cli_output.c */
int print(int type, const char *fmt, ...);
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
#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  */
543

544 545 546
/* cli_classic.c */
int cli_classic(int argc, char *argv[]);

547
/* layout.c */
Peter Stuge's avatar
Peter Stuge committed
548
int show_id(uint8_t *bios, int size, int force);
549 550
int read_romlayout(char *name);
int find_romentry(char *name);
551
int handle_romentries(uint8_t *buffer, struct flashchip *flash);
552

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

	/* 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);
};
594

595
extern enum spi_controller spi_controller;
596
extern const struct spi_programmer spi_programmer[];
597
extern void *spibar;
598
int spi_send_command(unsigned int writecnt, unsigned int readcnt,
599
		const unsigned char *writearr, unsigned char *readarr);
600
int spi_send_multicommand(struct spi_command *cmds);
601 602
int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
			     const unsigned char *writearr, unsigned char *readarr);
603
int default_spi_send_multicommand(struct spi_command *cmds);
604
uint32_t spi_get_valid_read_addr(void);
605

606
/* ichspi.c */
607
int ich_init_opcodes(void);
608
int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
609
		    const unsigned char *writearr, unsigned char *readarr);
610
int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
611
int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
612
int ich_spi_send_multicommand(struct spi_command *cmds);
613

614 615
/* it87spi.c */
extern uint16_t it8716f_flashport;
616 617
void enter_conf_mode_ite(uint16_t port);
void exit_conf_mode_ite(uint16_t port);
618
struct superio probe_superio_ite(void);
619
int it87spi_init(void);
620
int it87xx_probe_spi_flash(const char *name);
621
int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
622
			const unsigned char *writearr, unsigned char *readarr);
623
int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
624
int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
625

626
/* sb600spi.c */
627
int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
628
		      const unsigned char *writearr, unsigned char *readarr);
629
int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
630
int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
631
extern uint8_t *sb600_spibar;
632

Peter Stuge's avatar
Peter Stuge committed
633 634
/* wbsio_spi.c */
int wbsio_check_for_spi(const char *name);
635
int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann's avatar
Uwe Hermann committed
636
		      const unsigned char *writearr, unsigned char *readarr);
637
int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
638
int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
Peter Stuge's avatar
Peter Stuge committed
639

640 641 642 643 644 645 646
/* 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);
647 648

/* serial.c */
Patrick Georgi's avatar
Patrick Georgi committed
649 650 651 652 653 654
#if _WIN32
typedef HANDLE fdtype;
#else
typedef int fdtype;
#endif

655
void sp_flush_incoming(void);
Patrick Georgi's avatar
Patrick Georgi committed
656
fdtype sp_openserport(char *dev, unsigned int baud);
657
void __attribute__((noreturn)) sp_die(char *msg);
Patrick Georgi's avatar
Patrick Georgi committed
658
extern fdtype sp_fd;
659 660 661
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
662

663 664
#include "chipdrivers.h"

665
#endif				/* !__FLASH_H__ */