/* * This file is part of the flashrom project. * * Copyright (C) 2000 Silicon Integrated System Corporation * Copyright (C) 2000 Ronald G. Minnich * Copyright (C) 2005-2009 coresystems GmbH * Copyright (C) 2006-2009 Carl-Daniel Hailfinger * * 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. * * 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. * * 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 */ #ifndef __PROGRAMMER_H__ #define __PROGRAMMER_H__ 1 #include "flash.h" /* for chipaddr and flashctx */ enum programmer { #if CONFIG_INTERNAL == 1 PROGRAMMER_INTERNAL, #endif #if CONFIG_DUMMY == 1 PROGRAMMER_DUMMY, #endif #if CONFIG_NIC3COM == 1 PROGRAMMER_NIC3COM, #endif #if CONFIG_NICREALTEK == 1 PROGRAMMER_NICREALTEK, #endif #if CONFIG_NICNATSEMI == 1 PROGRAMMER_NICNATSEMI, #endif #if CONFIG_GFXNVIDIA == 1 PROGRAMMER_GFXNVIDIA, #endif #if CONFIG_DRKAISER == 1 PROGRAMMER_DRKAISER, #endif #if CONFIG_SATASII == 1 PROGRAMMER_SATASII, #endif #if CONFIG_ATAHPT == 1 PROGRAMMER_ATAHPT, #endif #if CONFIG_ATAVIA == 1 PROGRAMMER_ATAVIA, #endif #if CONFIG_IT8212 == 1 PROGRAMMER_IT8212, #endif #if CONFIG_FT2232_SPI == 1 PROGRAMMER_FT2232_SPI, #endif #if CONFIG_SERPROG == 1 PROGRAMMER_SERPROG, #endif #if CONFIG_BUSPIRATE_SPI == 1 PROGRAMMER_BUSPIRATE_SPI, #endif #if CONFIG_DEDIPROG == 1 PROGRAMMER_DEDIPROG, #endif #if CONFIG_RAYER_SPI == 1 PROGRAMMER_RAYER_SPI, #endif #if CONFIG_PONY_SPI == 1 PROGRAMMER_PONY_SPI, #endif #if CONFIG_NICINTEL == 1 PROGRAMMER_NICINTEL, #endif #if CONFIG_NICINTEL_SPI == 1 PROGRAMMER_NICINTEL_SPI, #endif #if CONFIG_NICINTEL_EEPROM == 1 PROGRAMMER_NICINTEL_EEPROM, #endif #if CONFIG_OGP_SPI == 1 PROGRAMMER_OGP_SPI, #endif #if CONFIG_SATAMV == 1 PROGRAMMER_SATAMV, #endif #if CONFIG_LINUX_SPI == 1 PROGRAMMER_LINUX_SPI, #endif #if CONFIG_USBBLASTER_SPI == 1 PROGRAMMER_USBBLASTER_SPI, #endif PROGRAMMER_INVALID /* This must always be the last entry. */ }; enum programmer_type { PCI = 1, /* to detect uninitialized values */ USB, OTHER, }; struct dev_entry { uint16_t vendor_id; uint16_t device_id; const enum test_state status; const char *vendor_name; const char *device_name; }; struct programmer_entry { const char *name; const enum programmer_type type; union { const struct dev_entry *const dev; const char *const note; } devs; int (*init) (void); void *(*map_flash_region) (const char *descr, uintptr_t phys_addr, size_t len); void (*unmap_flash_region) (void *virt_addr, size_t len); void (*delay) (unsigned int usecs); }; extern const struct programmer_entry programmer_table[]; int programmer_init(enum programmer prog, const char *param); int programmer_shutdown(void); enum bitbang_spi_master_type { BITBANG_SPI_INVALID = 0, /* This must always be the first entry. */ #if CONFIG_RAYER_SPI == 1 BITBANG_SPI_MASTER_RAYER, #endif #if CONFIG_PONY_SPI == 1 BITBANG_SPI_MASTER_PONY, #endif #if CONFIG_NICINTEL_SPI == 1 BITBANG_SPI_MASTER_NICINTEL, #endif #if CONFIG_INTERNAL == 1 #if defined(__i386__) || defined(__x86_64__) BITBANG_SPI_MASTER_MCP, #endif #endif #if CONFIG_OGP_SPI == 1 BITBANG_SPI_MASTER_OGP, #endif }; struct bitbang_spi_master { enum bitbang_spi_master_type type; /* Note that CS# is active low, so val=0 means the chip is active. */ void (*set_cs) (int val); void (*set_sck) (int val); void (*set_mosi) (int val); int (*get_miso) (void); void (*request_bus) (void); void (*release_bus) (void); /* Length of half a clock period in usecs. */ unsigned int half_period; }; #if NEED_PCI == 1 struct pci_dev; /* pcidev.c */ // FIXME: This needs to be local, not global(?) extern struct pci_access *pacc; int pci_init_common(void); uintptr_t pcidev_readbar(struct pci_dev *dev, int bar); struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar); /* rpci_write_* are reversible writes. The original PCI config space register * contents will be restored on shutdown. */ int rpci_write_byte(struct pci_dev *dev, int reg, uint8_t data); int rpci_write_word(struct pci_dev *dev, int reg, uint16_t data); int rpci_write_long(struct pci_dev *dev, int reg, uint32_t data); #endif #if CONFIG_INTERNAL == 1 struct penable { uint16_t vendor_id; uint16_t device_id; const enum test_state status; const char *vendor_name; const char *device_name; int (*doit) (struct pci_dev *dev, const char *name); }; extern const struct penable chipset_enables[]; enum board_match_phase { P1, P2, P3 }; struct board_match { /* 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; /* Pattern to match DMI entries. May be NULL. */ const char *dmi_pattern; /* The vendor / part name from the coreboot table. May be NULL. */ const char *lb_vendor; const char *lb_part; enum board_match_phase phase; const char *vendor_name; const char *board_name; int max_rom_decode_parallel; const enum test_state status; int (*enable) (void); /* May be NULL. */ }; extern const struct board_match board_matches[]; struct board_info { const char *vendor; const char *name; const enum test_state working; #ifdef CONFIG_PRINT_WIKI const char *url; const char *note; #endif }; extern const struct board_info boards_known[]; extern const struct board_info laptops_known[]; #endif /* udelay.c */ void myusec_delay(unsigned int usecs); void myusec_calibrate_delay(void); void internal_sleep(unsigned int usecs); void internal_delay(unsigned int usecs); #if CONFIG_INTERNAL == 1 /* board_enable.c */ int selfcheck_board_enables(void); int board_parse_parameter(const char *boardstring, const char **vendor, const char **model); void w836xx_ext_enter(uint16_t port); void w836xx_ext_leave(uint16_t port); void probe_superio_winbond(void); int it8705f_write_enable(uint8_t port); 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); void board_handle_before_superio(void); void board_handle_before_laptop(void); int board_flash_enable(const char *vendor, const char *model, const char *cb_vendor, const char *cb_model); /* chipset_enable.c */ int chipset_flash_enable(void); /* processor_enable.c */ int processor_flash_enable(void); #endif /* physmap.c */ void *physmap(const char *descr, uintptr_t phys_addr, size_t len); void *rphysmap(const char *descr, uintptr_t phys_addr, size_t len); void *physmap_ro(const char *descr, uintptr_t phys_addr, size_t len); void *physmap_ro_unaligned(const char *descr, uintptr_t phys_addr, size_t len); void physunmap(void *virt_addr, size_t len); void physunmap_unaligned(void *virt_addr, size_t len); #if CONFIG_INTERNAL == 1 int setup_cpu_msr(int cpu); void cleanup_cpu_msr(void); /* cbtable.c */ int cb_parse_table(const char **vendor, const char **model); int cb_check_image(uint8_t *bios, int size); /* dmi.c */ #if defined(__i386__) || defined(__x86_64__) extern int has_dmi_support; void dmi_init(void); int dmi_match(const char *pattern); #endif // defined(__i386__) || defined(__x86_64__) /* internal.c */ struct superio { uint16_t vendor; uint16_t port; uint16_t model; }; extern struct superio superios[]; extern int superio_count; #define SUPERIO_VENDOR_NONE 0x0 #define SUPERIO_VENDOR_ITE 0x1 #define SUPERIO_VENDOR_WINBOND 0x2 #endif #if NEED_PCI == 1 struct pci_filter; struct pci_dev *pci_dev_find_filter(struct pci_filter filter); struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t devclass); 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); #endif int rget_io_perms(void); #if CONFIG_INTERNAL == 1 extern int is_laptop; extern int laptop_ok; extern int force_boardenable; extern int force_boardmismatch; void probe_superio(void); int register_superio(struct superio s); extern enum chipbustype internal_buses_supported; int internal_init(void); #endif /* hwaccess.c */ 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); void mmio_readn(void *addr, uint8_t *buf, size_t len); void mmio_le_writeb(uint8_t val, void *addr); void mmio_le_writew(uint16_t val, void *addr); void mmio_le_writel(uint32_t val, void *addr); uint8_t mmio_le_readb(void *addr); uint16_t mmio_le_readw(void *addr); uint32_t mmio_le_readl(void *addr); #define pci_mmio_writeb mmio_le_writeb #define pci_mmio_writew mmio_le_writew #define pci_mmio_writel mmio_le_writel #define pci_mmio_readb mmio_le_readb #define pci_mmio_readw mmio_le_readw #define pci_mmio_readl mmio_le_readl void rmmio_writeb(uint8_t val, void *addr); void rmmio_writew(uint16_t val, void *addr); void rmmio_writel(uint32_t val, void *addr); void rmmio_le_writeb(uint8_t val, void *addr); void rmmio_le_writew(uint16_t val, void *addr); void rmmio_le_writel(uint32_t val, void *addr); #define pci_rmmio_writeb rmmio_le_writeb #define pci_rmmio_writew rmmio_le_writew #define pci_rmmio_writel rmmio_le_writel void rmmio_valb(void *addr); void rmmio_valw(void *addr); void rmmio_vall(void *addr); /* dummyflasher.c */ #if CONFIG_DUMMY == 1 int dummy_init(void); void *dummy_map(const char *descr, uintptr_t phys_addr, size_t len); void dummy_unmap(void *virt_addr, size_t len); #endif /* nic3com.c */ #if CONFIG_NIC3COM == 1 int nic3com_init(void); extern const struct dev_entry nics_3com[]; #endif /* gfxnvidia.c */ #if CONFIG_GFXNVIDIA == 1 int gfxnvidia_init(void); extern const struct dev_entry gfx_nvidia[]; #endif /* drkaiser.c */ #if CONFIG_DRKAISER == 1 int drkaiser_init(void); extern const struct dev_entry drkaiser_pcidev[]; #endif /* nicrealtek.c */ #if CONFIG_NICREALTEK == 1 int nicrealtek_init(void); extern const struct dev_entry nics_realtek[]; #endif /* nicnatsemi.c */ #if CONFIG_NICNATSEMI == 1 int nicnatsemi_init(void); extern const struct dev_entry nics_natsemi[]; #endif /* nicintel.c */ #if CONFIG_NICINTEL == 1 int nicintel_init(void); extern const struct dev_entry nics_intel[]; #endif /* nicintel_spi.c */ #if CONFIG_NICINTEL_SPI == 1 int nicintel_spi_init(void); extern const struct dev_entry nics_intel_spi[]; #endif /* nicintel_eeprom.c */ #if CONFIG_NICINTEL_EEPROM == 1 int nicintel_ee_init(void); extern const struct dev_entry nics_intel_ee[]; #endif /* ogp_spi.c */ #if CONFIG_OGP_SPI == 1 int ogp_spi_init(void); extern const struct dev_entry ogp_spi[]; #endif /* satamv.c */ #if CONFIG_SATAMV == 1 int satamv_init(void); extern const struct dev_entry satas_mv[]; #endif /* satasii.c */ #if CONFIG_SATASII == 1 int satasii_init(void); extern const struct dev_entry satas_sii[]; #endif /* atahpt.c */ #if CONFIG_ATAHPT == 1 int atahpt_init(void); extern const struct dev_entry ata_hpt[]; #endif /* atavia.c */ #if CONFIG_ATAVIA == 1 int atavia_init(void); void *atavia_map(const char *descr, uintptr_t phys_addr, size_t len); extern const struct dev_entry ata_via[]; #endif /* it8212.c */ #if CONFIG_IT8212 == 1 int it8212_init(void); extern const struct dev_entry devs_it8212[]; #endif /* ft2232_spi.c */ #if CONFIG_FT2232_SPI == 1 int ft2232_spi_init(void); extern const struct dev_entry devs_ft2232spi[]; #endif /* usbblaster_spi.c */ #if CONFIG_USBBLASTER_SPI == 1 int usbblaster_spi_init(void); extern const struct dev_entry devs_usbblasterspi[]; #endif /* rayer_spi.c */ #if CONFIG_RAYER_SPI == 1 int rayer_spi_init(void); #endif /* pony_spi.c */ #if CONFIG_PONY_SPI == 1 int pony_spi_init(void); #endif /* bitbang_spi.c */ int register_spi_bitbang_master(const struct bitbang_spi_master *master); /* buspirate_spi.c */ #if CONFIG_BUSPIRATE_SPI == 1 int buspirate_spi_init(void); #endif /* linux_spi.c */ #if CONFIG_LINUX_SPI == 1 int linux_spi_init(void); #endif /* dediprog.c */ #if CONFIG_DEDIPROG == 1 int dediprog_init(void); #endif /* flashrom.c */ struct decode_sizes { uint32_t parallel; uint32_t lpc; uint32_t fwh; uint32_t spi; }; // FIXME: These need to be local, not global extern struct decode_sizes max_rom_decode; extern int programmer_may_write; extern unsigned long flashbase; int check_max_decode(enum chipbustype buses, uint32_t size); char *extract_programmer_param(const char *param_name); /* spi.c */ enum spi_controller { SPI_CONTROLLER_NONE, #if CONFIG_INTERNAL == 1 #if defined(__i386__) || defined(__x86_64__) SPI_CONTROLLER_ICH7, SPI_CONTROLLER_ICH9, SPI_CONTROLLER_IT85XX, SPI_CONTROLLER_IT87XX, SPI_CONTROLLER_SB600, SPI_CONTROLLER_YANGTZE, SPI_CONTROLLER_VIA, SPI_CONTROLLER_WBSIO, #endif #endif #if CONFIG_FT2232_SPI == 1 SPI_CONTROLLER_FT2232, #endif #if CONFIG_DUMMY == 1 SPI_CONTROLLER_DUMMY, #endif #if CONFIG_BUSPIRATE_SPI == 1 SPI_CONTROLLER_BUSPIRATE, #endif #if CONFIG_DEDIPROG == 1 SPI_CONTROLLER_DEDIPROG, #endif #if CONFIG_OGP_SPI == 1 || CONFIG_NICINTEL_SPI == 1 || CONFIG_RAYER_SPI == 1 || CONFIG_PONY_SPI == 1 || (CONFIG_INTERNAL == 1 && (defined(__i386__) || defined(__x86_64__))) SPI_CONTROLLER_BITBANG, #endif #if CONFIG_LINUX_SPI == 1 SPI_CONTROLLER_LINUX, #endif #if CONFIG_SERPROG == 1 SPI_CONTROLLER_SERPROG, #endif #if CONFIG_USBBLASTER_SPI == 1 SPI_CONTROLLER_USBBLASTER, #endif }; #define MAX_DATA_UNSPECIFIED 0 #define MAX_DATA_READ_UNLIMITED 64 * 1024 #define MAX_DATA_WRITE_UNLIMITED 256 struct spi_master { enum spi_controller type; unsigned int max_data_read; unsigned int max_data_write; int (*command)(struct flashctx *flash, unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr); int (*multicommand)(struct flashctx *flash, struct spi_command *cmds); /* Optimized functions for this master */ int (*read)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len); int (*write_256)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len); int (*write_aai)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len); const void *data; }; int default_spi_send_command(struct flashctx *flash, unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr); int default_spi_send_multicommand(struct flashctx *flash, struct spi_command *cmds); int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len); int default_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len); int default_spi_write_aai(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len); int register_spi_master(const struct spi_master *mst); /* The following enum is needed by ich_descriptor_tool and ich* code as well as in chipset_enable.c. */ enum ich_chipset { CHIPSET_ICH_UNKNOWN, CHIPSET_ICH, CHIPSET_ICH2345, CHIPSET_ICH6, CHIPSET_POULSBO, /* SCH U* */ CHIPSET_TUNNEL_CREEK, /* Atom E6xx */ CHIPSET_CENTERTON, /* Atom S1220 S1240 S1260 */ CHIPSET_ICH7, CHIPSET_ICH8, CHIPSET_ICH9, CHIPSET_ICH10, CHIPSET_5_SERIES_IBEX_PEAK, CHIPSET_6_SERIES_COUGAR_POINT, CHIPSET_7_SERIES_PANTHER_POINT, CHIPSET_8_SERIES_LYNX_POINT, CHIPSET_8_SERIES_LYNX_POINT_LP, CHIPSET_8_SERIES_WELLSBURG, }; /* ichspi.c */ #if CONFIG_INTERNAL == 1 extern uint32_t ichspi_bbar; int ich_init_spi(struct pci_dev *dev, void *spibar, enum ich_chipset ich_generation); int via_init_spi(struct pci_dev *dev, uint32_t mmio_base); /* amd_imc.c */ int amd_imc_shutdown(struct pci_dev *dev); /* it85spi.c */ int it85xx_spi_init(struct superio s); /* it87spi.c */ void enter_conf_mode_ite(uint16_t port); void exit_conf_mode_ite(uint16_t port); void probe_superio_ite(void); int init_superio_ite(void); /* mcp6x_spi.c */ int mcp6x_spi_init(int want_spi); /* sb600spi.c */ int sb600_probe_spi(struct pci_dev *dev); /* wbsio_spi.c */ int wbsio_check_for_spi(void); #endif /* opaque.c */ struct opaque_master { int max_data_read; int max_data_write; /* Specific functions for this master */ int (*probe) (struct flashctx *flash); int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len); int (*write) (struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len); int (*erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen); const void *data; }; int register_opaque_master(const struct opaque_master *mst); /* programmer.c */ int noop_shutdown(void); void *fallback_map(const char *descr, uintptr_t phys_addr, size_t len); void fallback_unmap(void *virt_addr, size_t len); void noop_chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr); void fallback_chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr); void fallback_chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr); void fallback_chip_writen(const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len); uint16_t fallback_chip_readw(const struct flashctx *flash, const chipaddr addr); uint32_t fallback_chip_readl(const struct flashctx *flash, const chipaddr addr); void fallback_chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len); struct par_master { void (*chip_writeb) (const struct flashctx *flash, uint8_t val, chipaddr addr); void (*chip_writew) (const struct flashctx *flash, uint16_t val, chipaddr addr); void (*chip_writel) (const struct flashctx *flash, uint32_t val, chipaddr addr); void (*chip_writen) (const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len); uint8_t (*chip_readb) (const struct flashctx *flash, const chipaddr addr); uint16_t (*chip_readw) (const struct flashctx *flash, const chipaddr addr); uint32_t (*chip_readl) (const struct flashctx *flash, const chipaddr addr); void (*chip_readn) (const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len); const void *data; }; int register_par_master(const struct par_master *mst, const enum chipbustype buses); struct registered_master { enum chipbustype buses_supported; union { struct par_master par; struct spi_master spi; struct opaque_master opaque; }; }; extern struct registered_master registered_masters[]; extern int registered_master_count; int register_master(struct registered_master *mst); /* serprog.c */ #if CONFIG_SERPROG == 1 int serprog_init(void); void serprog_delay(unsigned int usecs); #endif /* serial.c */ #ifdef _WIN32 typedef HANDLE fdtype; #define SER_INV_FD INVALID_HANDLE_VALUE #else typedef int fdtype; #define SER_INV_FD -1 #endif void sp_flush_incoming(void); fdtype sp_openserport(char *dev, unsigned int baud); int serialport_config(fdtype fd, unsigned int baud); extern fdtype sp_fd; /* expose serialport_shutdown as it's currently used by buspirate */ int serialport_shutdown(void *data); int serialport_write(const unsigned char *buf, unsigned int writecnt); int serialport_write_nonblock(const unsigned char *buf, unsigned int writecnt, unsigned int timeout, unsigned int *really_wrote); int serialport_read(unsigned char *buf, unsigned int readcnt); int serialport_read_nonblock(unsigned char *c, unsigned int readcnt, unsigned int timeout, unsigned int *really_read); /* Serial port/pin mapping: 1 CD <- 2 RXD <- 3 TXD -> 4 DTR -> 5 GND -- 6 DSR <- 7 RTS -> 8 CTS <- 9 RI <- */ enum SP_PIN { PIN_CD = 1, PIN_RXD, PIN_TXD, PIN_DTR, PIN_GND, PIN_DSR, PIN_RTS, PIN_CTS, PIN_RI, }; void sp_set_pin(enum SP_PIN pin, int val); int sp_get_pin(enum SP_PIN pin); #endif /* !__PROGRAMMER_H__ */