flash.h 21.8 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 59 60
#if ATAHPT_SUPPORT == 1
	PROGRAMMER_ATAHPT,
#endif
61
#if INTERNAL_SUPPORT == 1
62
	PROGRAMMER_IT87SPI,
63
#endif
64
#if FT2232_SPI_SUPPORT == 1
65
	PROGRAMMER_FT2232SPI,
66
#endif
67
#if SERPROG_SUPPORT == 1
68
	PROGRAMMER_SERPROG,
69 70 71
#endif
#if BUSPIRATE_SPI_SUPPORT == 1
	PROGRAMMER_BUSPIRATESPI,
72 73 74
#endif
#if DEDIPROG_SUPPORT == 1
	PROGRAMMER_DEDIPROG,
75
#endif
76
	PROGRAMMER_INVALID /* This must always be the last entry. */
77 78 79
};

extern enum programmer programmer;
80 81 82 83 84 85 86 87

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

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

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

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

extern const struct programmer_entry programmer_table[];

105 106
int register_shutdown(void (*function) (void *data), void *data);

107 108 109 110 111 112 113 114
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);
115
void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
116 117 118
uint8_t chip_readb(const chipaddr addr);
uint16_t chip_readw(const chipaddr addr);
uint32_t chip_readl(const chipaddr addr);
119
void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
120
void programmer_delay(int usecs);
121

122 123
enum bitbang_spi_master {
	BITBANG_SPI_INVALID /* This must always be the last entry. */
124 125
};

126
extern const int bitbang_spi_master_count;
127

128
extern enum bitbang_spi_master bitbang_spi_master;
129

130
struct bitbang_spi_master_entry {
131 132 133 134 135 136
	void (*set_cs) (int val);
	void (*set_sck) (int val);
	void (*set_mosi) (int val);
	int (*get_miso) (void);
};

137 138
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))

139
enum chipbustype {
140
	CHIP_BUSTYPE_NONE	= 0,
141 142 143 144 145 146 147 148
	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,
};

149 150 151 152 153 154 155 156 157 158 159
/*
 * 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

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

171
struct flashchip {
172
	const char *vendor;
173
	const char *name;
174 175 176

	enum chipbustype bustype;

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

	int total_size;
	int page_size;
187
	int feature_bits;
188

189 190
	/*
	 * Indicate if flashrom has been tested with this flash chip and if
191 192 193 194
	 * everything worked correctly.
	 */
	uint32_t tested;

Uwe Hermann's avatar
Uwe Hermann committed
195
	int (*probe) (struct flashchip *flash);
196 197 198

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

	/*
201 202
	 * Erase blocks and associated erase function. Any chip erase function
	 * is stored as chip-sized virtual block together with said function.
203 204 205 206 207 208 209 210 211
	 */
	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];

212 213
	int (*printlock) (struct flashchip *flash);
	int (*unlock) (struct flashchip *flash);
Uwe Hermann's avatar
Uwe Hermann committed
214
	int (*write) (struct flashchip *flash, uint8_t *buf);
215
	int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
Ronald G. Minnich's avatar
Ronald G. Minnich committed
216

217
	/* Some flash devices have an additional register space. */
218 219
	chipaddr virtual_memory;
	chipaddr virtual_registers;
220 221
};

222 223
#define TEST_UNTESTED	0

Uwe Hermann's avatar
Uwe Hermann committed
224 225 226 227 228 229
#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)
230
#define TEST_OK_PRW	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
Uwe Hermann's avatar
Uwe Hermann committed
231
#define TEST_OK_PREW	(TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
232 233
#define TEST_OK_MASK	0x0f

Uwe Hermann's avatar
Uwe Hermann committed
234 235 236 237 238
#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)
239 240
#define TEST_BAD_MASK	0xf0

241 242 243 244 245 246 247 248 249 250
/* 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

251 252
extern struct flashchip flashchips[];

253
#if INTERNAL_SUPPORT == 1
Uwe Hermann's avatar
Uwe Hermann committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
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
280 281 282
	/* Pattern to match DMI entries */
	const char *dmi_pattern;

Uwe Hermann's avatar
Uwe Hermann committed
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;

290
	int max_rom_decode_parallel;
291
	int status;
Uwe Hermann's avatar
Uwe Hermann committed
292 293 294 295 296 297 298 299 300 301 302 303
	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[];
304 305
extern const struct board_info laptops_ok[];
extern const struct board_info laptops_bad[];
306
#endif
Uwe Hermann's avatar
Uwe Hermann committed
307

308
/* udelay.c */
309
void myusec_delay(int usecs);
310
void myusec_calibrate_delay(void);
311
void internal_delay(int usecs);
312

313
#if NEED_PCI == 1
314
/* pcidev.c */
315

316 317
extern uint32_t io_base_addr;
extern struct pci_access *pacc;
318
extern struct pci_dev *pcidev_dev;
319 320 321 322 323 324 325
struct pcidev_status {
	uint16_t vendor_id;
	uint16_t device_id;
	int status;
	const char *vendor_name;
	const char *device_name;
};
326 327
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);
328
#endif
329 330 331

/* print.c */
char *flashbuses_to_text(enum chipbustype bustype);
332
void print_supported(void);
333
#if (NIC3COM_SUPPORT == 1) || (GFXNVIDIA_SUPPORT == 1) || (DRKAISER_SUPPORT == 1) || (SATASII_SUPPORT == 1) || (ATAHPT_SUPPORT == 1)
334
void print_supported_pcidevs(struct pcidev_status *devs);
335
#endif
336
void print_supported_wiki(void);
337

338
/* board_enable.c */
339 340
void w836xx_ext_enter(uint16_t port);
void w836xx_ext_leave(uint16_t port);
341 342 343
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);
344
int board_flash_enable(const char *vendor, const char *part);
345

346 347
/* chipset_enable.c */
int chipset_flash_enable(void);
348

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

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

Michael Karcher's avatar
Michael Karcher committed
362 363 364 365 366
/* dmi.c */
extern int has_dmi_support;
void dmi_init(void);
int dmi_match(const char *pattern);

367
/* internal.c */
368
#if NEED_PCI == 1
369 370 371 372 373 374 375 376
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
377
struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
378
struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t class);
379 380 381
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);
382
#endif
383
void get_io_perms(void);
384
void release_io_perms(void);
385
#if INTERNAL_SUPPORT == 1
Michael Karcher's avatar
Michael Karcher committed
386
extern int is_laptop;
387
extern int force_boardenable;
388
void probe_superio(void);
389 390
int internal_init(void);
int internal_shutdown(void);
391 392 393 394 395 396
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);
397
void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
398
#endif
399 400 401 402 403 404
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);
405 406

/* programmer.c */
407
int noop_shutdown(void);
408 409
void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
void fallback_unmap(void *virt_addr, size_t len);
410 411
uint8_t noop_chip_readb(const chipaddr addr);
void noop_chip_writeb(uint8_t val, chipaddr addr);
412 413
void fallback_chip_writew(uint16_t val, chipaddr addr);
void fallback_chip_writel(uint32_t val, chipaddr addr);
414
void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
415 416
uint16_t fallback_chip_readw(const chipaddr addr);
uint32_t fallback_chip_readl(const chipaddr addr);
417
void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
418

419
/* dummyflasher.c */
420
#if DUMMY_SUPPORT == 1
421 422
int dummy_init(void);
int dummy_shutdown(void);
423 424
void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
void dummy_unmap(void *virt_addr, size_t len);
425 426 427
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);
428
void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
429 430 431
uint8_t dummy_chip_readb(const chipaddr addr);
uint16_t dummy_chip_readw(const chipaddr addr);
uint32_t dummy_chip_readl(const chipaddr addr);
432
void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
433
int dummy_spi_send_command(unsigned int writecnt, unsigned int readcnt,
434
		      const unsigned char *writearr, unsigned char *readarr);
435
#endif
436

437
/* nic3com.c */
438
#if NIC3COM_SUPPORT == 1
439 440
int nic3com_init(void);
int nic3com_shutdown(void);
441 442
void nic3com_chip_writeb(uint8_t val, chipaddr addr);
uint8_t nic3com_chip_readb(const chipaddr addr);
443
extern struct pcidev_status nics_3com[];
444
#endif
445

446
/* gfxnvidia.c */
447
#if GFXNVIDIA_SUPPORT == 1
448 449 450 451 452
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[];
453
#endif
454

455
/* drkaiser.c */
456
#if DRKAISER_SUPPORT == 1
457 458 459 460 461
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[];
462
#endif
463

464
/* satasii.c */
465
#if SATASII_SUPPORT == 1
466 467 468 469 470
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[];
471
#endif
472

473 474 475 476 477 478 479 480 481
/* atahpt.c */
#if ATAHPT_SUPPORT == 1
int atahpt_init(void);
int atahpt_shutdown(void);
void atahpt_chip_writeb(uint8_t val, chipaddr addr);
uint8_t atahpt_chip_readb(const chipaddr addr);
extern struct pcidev_status ata_hpt[];
#endif

482
/* ft2232_spi.c */
483 484
#define FTDI_FT2232H 0x6010
#define FTDI_FT4232H 0x6011
485
int ft2232_spi_init(void);
486
int ft2232_spi_send_command(unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
487 488 489
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);

490
/* bitbang_spi.c */
491 492
extern int bitbang_spi_half_period;
extern const struct bitbang_spi_master_entry bitbang_spi_master_table[];
493 494 495 496 497
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);

498
/* buspirate_spi.c */
499 500 501 502
struct buspirate_spispeeds {
	const char *name;
	const int speed;
};
503 504 505 506 507
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);

508 509 510 511 512 513
/* 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);

514
/* flashrom.c */
515 516 517 518 519 520 521 522
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;
523
extern char *programmer_param;
524
extern unsigned long flashbase;
Uwe Hermann's avatar
Uwe Hermann committed
525
extern int verbose;
526
extern const char *flashrom_version;
527
extern char *chip_to_probe;
Uwe Hermann's avatar
Uwe Hermann committed
528
#define printf_debug(x...) { if (verbose) printf(x); }
529
void map_flash_registers(struct flashchip *flash);
530
int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
531
int erase_flash(struct flashchip *flash);
532 533 534 535
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);
536
int min(int a, int b);
537
int max(int a, int b);
538
char *extract_param(char **haystack, char *needle, char *delim);
539 540
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);
541
char *strcat_realloc(char *dest, const char *src);
542 543
void print_version(void);
int selfcheck(void);
544
int doit(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it);
545 546 547

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

549 550
/* cli_output.c */
int print(int type, const char *fmt, ...);
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
#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  */
567

568 569 570
/* cli_classic.c */
int cli_classic(int argc, char *argv[]);

571
/* layout.c */
Peter Stuge's avatar
Peter Stuge committed
572
int show_id(uint8_t *bios, int size, int force);
573 574
int read_romlayout(char *name);
int find_romentry(char *name);
575
int handle_romentries(uint8_t *buffer, struct flashchip *flash);
576

577
/* spi.c */
578 579
enum spi_controller {
	SPI_CONTROLLER_NONE,
580
#if INTERNAL_SUPPORT == 1
581 582 583 584 585 586
	SPI_CONTROLLER_ICH7,
	SPI_CONTROLLER_ICH9,
	SPI_CONTROLLER_IT87XX,
	SPI_CONTROLLER_SB600,
	SPI_CONTROLLER_VIA,
	SPI_CONTROLLER_WBSIO,
587
#endif
588
#if FT2232_SPI_SUPPORT == 1
589
	SPI_CONTROLLER_FT2232,
590
#endif
591
#if DUMMY_SUPPORT == 1
592
	SPI_CONTROLLER_DUMMY,
593 594 595
#endif
#if BUSPIRATE_SPI_SUPPORT == 1
	SPI_CONTROLLER_BUSPIRATE,
596 597 598
#endif
#if DEDIPROG_SUPPORT == 1
	SPI_CONTROLLER_DEDIPROG,
599
#endif
600
	SPI_CONTROLLER_INVALID /* This must always be the last entry. */
601
};
602
extern const int spi_programmer_count;
603 604 605 606 607 608
struct spi_command {
	unsigned int writecnt;
	unsigned int readcnt;
	const unsigned char *writearr;
	unsigned char *readarr;
};
609 610 611
struct spi_programmer {
	int (*command)(unsigned int writecnt, unsigned int readcnt,
		   const unsigned char *writearr, unsigned char *readarr);
612
	int (*multicommand)(struct spi_command *cmds);
613 614 615 616 617

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

619
extern enum spi_controller spi_controller;
620
extern const struct spi_programmer spi_programmer[];
621
extern void *spibar;
622
int spi_send_command(unsigned int writecnt, unsigned int readcnt,
623
		const unsigned char *writearr, unsigned char *readarr);
624
int spi_send_multicommand(struct spi_command *cmds);
625 626
int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
			     const unsigned char *writearr, unsigned char *readarr);
627
int default_spi_send_multicommand(struct spi_command *cmds);
628
uint32_t spi_get_valid_read_addr(void);
629

630
/* ichspi.c */
631
int ich_init_opcodes(void);
632
int ich_spi_send_command(unsigned int writecnt, unsigned int readcnt,
633
		    const unsigned char *writearr, unsigned char *readarr);
634
int ich_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
635
int ich_spi_write_256(struct flashchip *flash, uint8_t * buf);
636
int ich_spi_send_multicommand(struct spi_command *cmds);
637

638 639
/* it87spi.c */
extern uint16_t it8716f_flashport;
640 641
void enter_conf_mode_ite(uint16_t port);
void exit_conf_mode_ite(uint16_t port);
642
struct superio probe_superio_ite(void);
643
int it87spi_init(void);
644
int it87xx_probe_spi_flash(const char *name);
645
int it8716f_spi_send_command(unsigned int writecnt, unsigned int readcnt,
646
			const unsigned char *writearr, unsigned char *readarr);
647
int it8716f_spi_chip_read(struct flashchip *flash, uint8_t *buf, int start, int len);
648
int it8716f_spi_chip_write_256(struct flashchip *flash, uint8_t *buf);
649

650
/* sb600spi.c */
651
int sb600_spi_send_command(unsigned int writecnt, unsigned int readcnt,
652
		      const unsigned char *writearr, unsigned char *readarr);
653
int sb600_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
654
int sb600_spi_write_1(struct flashchip *flash, uint8_t *buf);
655
extern uint8_t *sb600_spibar;
656

Peter Stuge's avatar
Peter Stuge committed
657 658
/* wbsio_spi.c */
int wbsio_check_for_spi(const char *name);
659
int wbsio_spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann's avatar
Uwe Hermann committed
660
		      const unsigned char *writearr, unsigned char *readarr);
661
int wbsio_spi_read(struct flashchip *flash, uint8_t *buf, int start, int len);
662
int wbsio_spi_write_1(struct flashchip *flash, uint8_t *buf);
Peter Stuge's avatar
Peter Stuge committed
663

664 665 666 667 668 669 670
/* 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);
671 672

/* serial.c */
Patrick Georgi's avatar
Patrick Georgi committed
673 674 675 676 677 678
#if _WIN32
typedef HANDLE fdtype;
#else
typedef int fdtype;
#endif

679
void sp_flush_incoming(void);
Patrick Georgi's avatar
Patrick Georgi committed
680
fdtype sp_openserport(char *dev, unsigned int baud);
681
void __attribute__((noreturn)) sp_die(char *msg);
Patrick Georgi's avatar
Patrick Georgi committed
682
extern fdtype sp_fd;
683 684 685
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
686

687
#endif				/* !__FLASH_H__ */