blob: f9f524152f249cb15e7064db2920c3d133344841 [file] [log] [blame]
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * 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 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef __PROGRAMMER_H__
25#define __PROGRAMMER_H__ 1
26
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000027#include "flash.h" /* for chipaddr and flashctx */
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000028
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000029enum programmer {
30#if CONFIG_INTERNAL == 1
31 PROGRAMMER_INTERNAL,
32#endif
33#if CONFIG_DUMMY == 1
34 PROGRAMMER_DUMMY,
35#endif
36#if CONFIG_NIC3COM == 1
37 PROGRAMMER_NIC3COM,
38#endif
39#if CONFIG_NICREALTEK == 1
40 PROGRAMMER_NICREALTEK,
Idwer Vollering004f4b72010-09-03 18:21:21 +000041#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000042#if CONFIG_NICNATSEMI == 1
43 PROGRAMMER_NICNATSEMI,
Idwer Vollering004f4b72010-09-03 18:21:21 +000044#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000045#if CONFIG_GFXNVIDIA == 1
46 PROGRAMMER_GFXNVIDIA,
47#endif
48#if CONFIG_DRKAISER == 1
49 PROGRAMMER_DRKAISER,
50#endif
51#if CONFIG_SATASII == 1
52 PROGRAMMER_SATASII,
53#endif
54#if CONFIG_ATAHPT == 1
55 PROGRAMMER_ATAHPT,
56#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000057#if CONFIG_FT2232_SPI == 1
58 PROGRAMMER_FT2232_SPI,
59#endif
60#if CONFIG_SERPROG == 1
61 PROGRAMMER_SERPROG,
62#endif
63#if CONFIG_BUSPIRATE_SPI == 1
64 PROGRAMMER_BUSPIRATE_SPI,
65#endif
66#if CONFIG_DEDIPROG == 1
67 PROGRAMMER_DEDIPROG,
68#endif
69#if CONFIG_RAYER_SPI == 1
70 PROGRAMMER_RAYER_SPI,
71#endif
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +000072#if CONFIG_PONY_SPI == 1
73 PROGRAMMER_PONY_SPI,
74#endif
Carl-Daniel Hailfingerb713d2e2011-05-08 00:24:18 +000075#if CONFIG_NICINTEL == 1
76 PROGRAMMER_NICINTEL,
77#endif
Idwer Vollering004f4b72010-09-03 18:21:21 +000078#if CONFIG_NICINTEL_SPI == 1
79 PROGRAMMER_NICINTEL_SPI,
80#endif
Mark Marshall90021f22010-12-03 14:48:11 +000081#if CONFIG_OGP_SPI == 1
82 PROGRAMMER_OGP_SPI,
83#endif
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +000084#if CONFIG_SATAMV == 1
85 PROGRAMMER_SATAMV,
86#endif
Sven Schnelle5ce5f702011-09-03 18:37:52 +000087#if CONFIG_LINUX_SPI == 1
88 PROGRAMMER_LINUX_SPI,
89#endif
James Lairdc60de0e2013-03-27 13:00:23 +000090#if CONFIG_USBBLASTER_SPI == 1
91 PROGRAMMER_USBBLASTER_SPI,
92#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000093 PROGRAMMER_INVALID /* This must always be the last entry. */
94};
95
Stefan Tauneraf358d62012-12-27 18:40:26 +000096enum programmer_type {
97 PCI = 1, /* to detect uninitialized values */
98 USB,
99 OTHER,
100};
101
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000102struct dev_entry {
103 uint16_t vendor_id;
104 uint16_t device_id;
105 const enum test_state status;
106 const char *vendor_name;
107 const char *device_name;
108};
109
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000110struct programmer_entry {
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000111 const char *name;
Stefan Tauneraf358d62012-12-27 18:40:26 +0000112 const enum programmer_type type;
113 union {
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000114 const struct dev_entry *const dev;
Stefan Tauneraf358d62012-12-27 18:40:26 +0000115 const char *const note;
116 } devs;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000117
118 int (*init) (void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000119
Stefan Tauner305e0b92013-07-17 23:46:44 +0000120 void *(*map_flash_region) (const char *descr, uintptr_t phys_addr, size_t len);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000121 void (*unmap_flash_region) (void *virt_addr, size_t len);
122
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000123 void (*delay) (int usecs);
124};
125
126extern const struct programmer_entry programmer_table[];
127
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000128int programmer_init(enum programmer prog, const char *param);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000129int programmer_shutdown(void);
130
131enum bitbang_spi_master_type {
132 BITBANG_SPI_INVALID = 0, /* This must always be the first entry. */
133#if CONFIG_RAYER_SPI == 1
134 BITBANG_SPI_MASTER_RAYER,
135#endif
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +0000136#if CONFIG_PONY_SPI == 1
137 BITBANG_SPI_MASTER_PONY,
138#endif
Idwer Vollering004f4b72010-09-03 18:21:21 +0000139#if CONFIG_NICINTEL_SPI == 1
140 BITBANG_SPI_MASTER_NICINTEL,
141#endif
Carl-Daniel Hailfinger2f436162010-07-28 15:08:35 +0000142#if CONFIG_INTERNAL == 1
143#if defined(__i386__) || defined(__x86_64__)
144 BITBANG_SPI_MASTER_MCP,
145#endif
146#endif
Mark Marshall90021f22010-12-03 14:48:11 +0000147#if CONFIG_OGP_SPI == 1
148 BITBANG_SPI_MASTER_OGP,
149#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000150};
151
152struct bitbang_spi_master {
153 enum bitbang_spi_master_type type;
154
155 /* Note that CS# is active low, so val=0 means the chip is active. */
156 void (*set_cs) (int val);
157 void (*set_sck) (int val);
158 void (*set_mosi) (int val);
159 int (*get_miso) (void);
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000160 void (*request_bus) (void);
161 void (*release_bus) (void);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000162 /* Length of half a clock period in usecs. */
163 unsigned int half_period;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000164};
165
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000166#if NEED_PCI == 1
Patrick Georgi32508eb2012-07-20 20:35:14 +0000167struct pci_dev;
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000168
169/* pcidev.c */
170// FIXME: These need to be local, not global
171extern uint32_t io_base_addr;
172extern struct pci_access *pacc;
173int pci_init_common(void);
174uintptr_t pcidev_readbar(struct pci_dev *dev, int bar);
175struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar);
176/* rpci_write_* are reversible writes. The original PCI config space register
177 * contents will be restored on shutdown.
178 */
179int rpci_write_byte(struct pci_dev *dev, int reg, uint8_t data);
180int rpci_write_word(struct pci_dev *dev, int reg, uint16_t data);
181int rpci_write_long(struct pci_dev *dev, int reg, uint32_t data);
182#endif
183
184#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000185struct penable {
186 uint16_t vendor_id;
187 uint16_t device_id;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000188 const enum test_state status;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000189 const char *vendor_name;
190 const char *device_name;
191 int (*doit) (struct pci_dev *dev, const char *name);
192};
193
194extern const struct penable chipset_enables[];
195
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000196enum board_match_phase {
197 P1,
198 P2,
199 P3
200};
201
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +0000202struct board_match {
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000203 /* Any device, but make it sensible, like the ISA bridge. */
204 uint16_t first_vendor;
205 uint16_t first_device;
206 uint16_t first_card_vendor;
207 uint16_t first_card_device;
208
209 /* Any device, but make it sensible, like
210 * the host bridge. May be NULL.
211 */
212 uint16_t second_vendor;
213 uint16_t second_device;
214 uint16_t second_card_vendor;
215 uint16_t second_card_device;
216
Stefan Tauner7bcacb12011-05-26 01:35:19 +0000217 /* Pattern to match DMI entries. May be NULL. */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000218 const char *dmi_pattern;
219
Stefan Tauner7bcacb12011-05-26 01:35:19 +0000220 /* The vendor / part name from the coreboot table. May be NULL. */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000221 const char *lb_vendor;
222 const char *lb_part;
223
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000224 enum board_match_phase phase;
225
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000226 const char *vendor_name;
227 const char *board_name;
228
229 int max_rom_decode_parallel;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000230 const enum test_state status;
Stefan Tauner7bcacb12011-05-26 01:35:19 +0000231 int (*enable) (void); /* May be NULL. */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000232};
233
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +0000234extern const struct board_match board_matches[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000235
236struct board_info {
237 const char *vendor;
238 const char *name;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000239 const enum test_state working;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000240#ifdef CONFIG_PRINT_WIKI
241 const char *url;
242 const char *note;
243#endif
244};
245
246extern const struct board_info boards_known[];
247extern const struct board_info laptops_known[];
248#endif
249
250/* udelay.c */
251void myusec_delay(int usecs);
252void myusec_calibrate_delay(void);
Maksim Kuleshov73dc0db2013-04-05 08:06:10 +0000253void internal_sleep(int usecs);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000254void internal_delay(int usecs);
255
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000256#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000257/* board_enable.c */
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000258int board_parse_parameter(const char *boardstring, const char **vendor, const char **model);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000259void w836xx_ext_enter(uint16_t port);
260void w836xx_ext_leave(uint16_t port);
Carl-Daniel Hailfingerf5e62cb2012-05-06 22:48:01 +0000261void probe_superio_winbond(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000262int it8705f_write_enable(uint8_t port);
263uint8_t sio_read(uint16_t port, uint8_t reg);
264void sio_write(uint16_t port, uint8_t reg, uint8_t data);
265void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000266void board_handle_before_superio(void);
267void board_handle_before_laptop(void);
Stefan Taunerfa9fa712012-09-24 21:29:29 +0000268int board_flash_enable(const char *vendor, const char *model, const char *cb_vendor, const char *cb_model);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000269
270/* chipset_enable.c */
271int chipset_flash_enable(void);
272
273/* processor_enable.c */
274int processor_flash_enable(void);
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000275#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000276
277/* physmap.c */
Stefan Tauner305e0b92013-07-17 23:46:44 +0000278void *physmap(const char *descr, uintptr_t phys_addr, size_t len);
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000279void *rphysmap(const char *descr, uintptr_t phys_addr, size_t len);
Stefan Tauner305e0b92013-07-17 23:46:44 +0000280void *physmap_try_ro(const char *descr, uintptr_t phys_addr, size_t len);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000281void physunmap(void *virt_addr, size_t len);
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000282#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000283int setup_cpu_msr(int cpu);
284void cleanup_cpu_msr(void);
285
286/* cbtable.c */
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000287int cb_parse_table(const char **vendor, const char **model);
288int cb_check_image(uint8_t *bios, int size);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000289
290/* dmi.c */
291extern int has_dmi_support;
292void dmi_init(void);
293int dmi_match(const char *pattern);
294
295/* internal.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000296struct superio {
297 uint16_t vendor;
298 uint16_t port;
299 uint16_t model;
300};
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000301extern struct superio superios[];
302extern int superio_count;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000303#define SUPERIO_VENDOR_NONE 0x0
304#define SUPERIO_VENDOR_ITE 0x1
Carl-Daniel Hailfingerf5e62cb2012-05-06 22:48:01 +0000305#define SUPERIO_VENDOR_WINBOND 0x2
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000306#endif
307#if NEED_PCI == 1
Patrick Georgi32508eb2012-07-20 20:35:14 +0000308struct pci_filter;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000309struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
Uwe Hermann24c35e42011-07-13 11:22:03 +0000310struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t devclass);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000311struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
312struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
313 uint16_t card_vendor, uint16_t card_device);
314#endif
Carl-Daniel Hailfingerd6bb8282012-07-21 17:27:08 +0000315int rget_io_perms(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000316#if CONFIG_INTERNAL == 1
317extern int is_laptop;
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000318extern int laptop_ok;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000319extern int force_boardenable;
320extern int force_boardmismatch;
321void probe_superio(void);
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000322int register_superio(struct superio s);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000323extern enum chipbustype internal_buses_supported;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000324int internal_init(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000325#endif
326
327/* hwaccess.c */
328void mmio_writeb(uint8_t val, void *addr);
329void mmio_writew(uint16_t val, void *addr);
330void mmio_writel(uint32_t val, void *addr);
331uint8_t mmio_readb(void *addr);
332uint16_t mmio_readw(void *addr);
333uint32_t mmio_readl(void *addr);
Carl-Daniel Hailfingerccd71c22012-03-01 22:38:27 +0000334void mmio_readn(void *addr, uint8_t *buf, size_t len);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000335void mmio_le_writeb(uint8_t val, void *addr);
336void mmio_le_writew(uint16_t val, void *addr);
337void mmio_le_writel(uint32_t val, void *addr);
338uint8_t mmio_le_readb(void *addr);
339uint16_t mmio_le_readw(void *addr);
340uint32_t mmio_le_readl(void *addr);
341#define pci_mmio_writeb mmio_le_writeb
342#define pci_mmio_writew mmio_le_writew
343#define pci_mmio_writel mmio_le_writel
344#define pci_mmio_readb mmio_le_readb
345#define pci_mmio_readw mmio_le_readw
346#define pci_mmio_readl mmio_le_readl
Carl-Daniel Hailfinger54ce73a2011-05-03 21:49:41 +0000347void rmmio_writeb(uint8_t val, void *addr);
348void rmmio_writew(uint16_t val, void *addr);
349void rmmio_writel(uint32_t val, void *addr);
350void rmmio_le_writeb(uint8_t val, void *addr);
351void rmmio_le_writew(uint16_t val, void *addr);
352void rmmio_le_writel(uint32_t val, void *addr);
353#define pci_rmmio_writeb rmmio_le_writeb
354#define pci_rmmio_writew rmmio_le_writew
355#define pci_rmmio_writel rmmio_le_writel
356void rmmio_valb(void *addr);
357void rmmio_valw(void *addr);
358void rmmio_vall(void *addr);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000359
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000360/* dummyflasher.c */
361#if CONFIG_DUMMY == 1
362int dummy_init(void);
Stefan Tauner305e0b92013-07-17 23:46:44 +0000363void *dummy_map(const char *descr, uintptr_t phys_addr, size_t len);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000364void dummy_unmap(void *virt_addr, size_t len);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000365#endif
366
367/* nic3com.c */
368#if CONFIG_NIC3COM == 1
369int nic3com_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000370extern const struct dev_entry nics_3com[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000371#endif
372
373/* gfxnvidia.c */
374#if CONFIG_GFXNVIDIA == 1
375int gfxnvidia_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000376extern const struct dev_entry gfx_nvidia[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000377#endif
378
379/* drkaiser.c */
380#if CONFIG_DRKAISER == 1
381int drkaiser_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000382extern const struct dev_entry drkaiser_pcidev[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000383#endif
384
385/* nicrealtek.c */
386#if CONFIG_NICREALTEK == 1
387int nicrealtek_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000388extern const struct dev_entry nics_realtek[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000389#endif
390
391/* nicnatsemi.c */
392#if CONFIG_NICNATSEMI == 1
393int nicnatsemi_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000394extern const struct dev_entry nics_natsemi[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000395#endif
396
Carl-Daniel Hailfingerb713d2e2011-05-08 00:24:18 +0000397/* nicintel.c */
398#if CONFIG_NICINTEL == 1
399int nicintel_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000400extern const struct dev_entry nics_intel[];
Carl-Daniel Hailfingerb713d2e2011-05-08 00:24:18 +0000401#endif
402
Idwer Vollering004f4b72010-09-03 18:21:21 +0000403/* nicintel_spi.c */
404#if CONFIG_NICINTEL_SPI == 1
405int nicintel_spi_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000406extern const struct dev_entry nics_intel_spi[];
Idwer Vollering004f4b72010-09-03 18:21:21 +0000407#endif
408
Mark Marshall90021f22010-12-03 14:48:11 +0000409/* ogp_spi.c */
410#if CONFIG_OGP_SPI == 1
411int ogp_spi_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000412extern const struct dev_entry ogp_spi[];
Mark Marshall90021f22010-12-03 14:48:11 +0000413#endif
414
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000415/* satamv.c */
416#if CONFIG_SATAMV == 1
417int satamv_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000418extern const struct dev_entry satas_mv[];
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000419#endif
420
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000421/* satasii.c */
422#if CONFIG_SATASII == 1
423int satasii_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000424extern const struct dev_entry satas_sii[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000425#endif
426
427/* atahpt.c */
428#if CONFIG_ATAHPT == 1
429int atahpt_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000430extern const struct dev_entry ata_hpt[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000431#endif
432
433/* ft2232_spi.c */
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000434#if CONFIG_FT2232_SPI == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000435int ft2232_spi_init(void);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000436extern const struct dev_entry devs_ft2232spi[];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000437#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000438
James Lairdc60de0e2013-03-27 13:00:23 +0000439/* usbblaster_spi.c */
440#if CONFIG_USBBLASTER_SPI == 1
441int usbblaster_spi_init(void);
442extern const struct dev_entry devs_usbblasterspi[];
443#endif
444
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000445/* rayer_spi.c */
446#if CONFIG_RAYER_SPI == 1
447int rayer_spi_init(void);
448#endif
449
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +0000450/* pony_spi.c */
451#if CONFIG_PONY_SPI == 1
452int pony_spi_init(void);
453#endif
454
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000455/* bitbang_spi.c */
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000456int bitbang_spi_init(const struct bitbang_spi_master *master);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000457
458/* buspirate_spi.c */
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000459#if CONFIG_BUSPIRATE_SPI == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000460int buspirate_spi_init(void);
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000461#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000462
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000463/* linux_spi.c */
464#if CONFIG_LINUX_SPI == 1
465int linux_spi_init(void);
466#endif
467
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000468/* dediprog.c */
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000469#if CONFIG_DEDIPROG == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000470int dediprog_init(void);
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000471#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000472
473/* flashrom.c */
474struct decode_sizes {
475 uint32_t parallel;
476 uint32_t lpc;
477 uint32_t fwh;
478 uint32_t spi;
479};
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000480// FIXME: These need to be local, not global
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000481extern struct decode_sizes max_rom_decode;
482extern int programmer_may_write;
483extern unsigned long flashbase;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000484void check_chip_supported(const struct flashchip *chip);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000485int check_max_decode(enum chipbustype buses, uint32_t size);
Stefan Tauner66652442011-06-26 17:38:17 +0000486char *extract_programmer_param(const char *param_name);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000487
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000488/* spi.c */
489enum spi_controller {
490 SPI_CONTROLLER_NONE,
491#if CONFIG_INTERNAL == 1
492#if defined(__i386__) || defined(__x86_64__)
493 SPI_CONTROLLER_ICH7,
494 SPI_CONTROLLER_ICH9,
David Hendricks4e748392011-02-28 23:58:15 +0000495 SPI_CONTROLLER_IT85XX,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000496 SPI_CONTROLLER_IT87XX,
497 SPI_CONTROLLER_SB600,
498 SPI_CONTROLLER_VIA,
499 SPI_CONTROLLER_WBSIO,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000500#endif
501#endif
502#if CONFIG_FT2232_SPI == 1
503 SPI_CONTROLLER_FT2232,
504#endif
505#if CONFIG_DUMMY == 1
506 SPI_CONTROLLER_DUMMY,
507#endif
508#if CONFIG_BUSPIRATE_SPI == 1
509 SPI_CONTROLLER_BUSPIRATE,
510#endif
511#if CONFIG_DEDIPROG == 1
512 SPI_CONTROLLER_DEDIPROG,
513#endif
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +0000514#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__)))
Michael Karcherb9dbe482011-05-11 17:07:07 +0000515 SPI_CONTROLLER_BITBANG,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000516#endif
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000517#if CONFIG_LINUX_SPI == 1
518 SPI_CONTROLLER_LINUX,
519#endif
Urja Rannikkoc93f5f12011-09-15 23:38:14 +0000520#if CONFIG_SERPROG == 1
521 SPI_CONTROLLER_SERPROG,
522#endif
James Lairdc60de0e2013-03-27 13:00:23 +0000523#if CONFIG_USBBLASTER_SPI == 1
524 SPI_CONTROLLER_USBBLASTER,
525#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000526};
Michael Karcher62797512011-05-11 17:07:02 +0000527
528#define MAX_DATA_UNSPECIFIED 0
529#define MAX_DATA_READ_UNLIMITED 64 * 1024
530#define MAX_DATA_WRITE_UNLIMITED 256
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000531struct spi_programmer {
Michael Karcherb9dbe482011-05-11 17:07:07 +0000532 enum spi_controller type;
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000533 unsigned int max_data_read;
534 unsigned int max_data_write;
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000535 int (*command)(struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000536 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000537 int (*multicommand)(struct flashctx *flash, struct spi_command *cmds);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000538
539 /* Optimized functions for this programmer */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000540 int (*read)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
541 int (*write_256)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Nico Huber7bca1262012-06-15 22:28:12 +0000542 int (*write_aai)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000543 const void *data;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000544};
545
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000546int default_spi_send_command(struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000547 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000548int default_spi_send_multicommand(struct flashctx *flash, struct spi_command *cmds);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000549int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
550int default_spi_write_256(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Nico Huber7bca1262012-06-15 22:28:12 +0000551int default_spi_write_aai(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000552int register_spi_programmer(const struct spi_programmer *programmer);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000553
Stefan Tauner2abab942012-04-27 20:41:23 +0000554/* The following enum is needed by ich_descriptor_tool and ich* code. */
Stefan Taunera8d838d2011-11-06 23:51:09 +0000555enum ich_chipset {
556 CHIPSET_ICH_UNKNOWN,
557 CHIPSET_ICH7 = 7,
558 CHIPSET_ICH8,
559 CHIPSET_ICH9,
560 CHIPSET_ICH10,
561 CHIPSET_5_SERIES_IBEX_PEAK,
562 CHIPSET_6_SERIES_COUGAR_POINT,
Stefan Tauner2abab942012-04-27 20:41:23 +0000563 CHIPSET_7_SERIES_PANTHER_POINT,
Duncan Laurie90eb2262013-03-15 03:12:29 +0000564 CHIPSET_8_SERIES_LYNX_POINT,
565 CHIPSET_8_SERIES_LYNX_POINT_LP,
566 CHIPSET_8_SERIES_WELLSBURG,
Stefan Taunera8d838d2011-11-06 23:51:09 +0000567};
568
Stefan Tauner2abab942012-04-27 20:41:23 +0000569/* ichspi.c */
570#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000571extern uint32_t ichspi_bbar;
572int ich_init_spi(struct pci_dev *dev, uint32_t base, void *rcrb,
Stefan Taunera8d838d2011-11-06 23:51:09 +0000573 enum ich_chipset ich_generation);
Helge Wagnerdd73d832012-08-24 23:03:46 +0000574int via_init_spi(struct pci_dev *dev, uint32_t mmio_base);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000575
Stefan Taunerdbac46c2013-08-13 22:10:41 +0000576/* amd_imc.c */
Rudolf Marek70e14592013-07-25 22:58:56 +0000577int amd_imc_shutdown(struct pci_dev *dev);
578
David Hendricks4e748392011-02-28 23:58:15 +0000579/* it85spi.c */
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000580int it85xx_spi_init(struct superio s);
David Hendricks4e748392011-02-28 23:58:15 +0000581
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000582/* it87spi.c */
583void enter_conf_mode_ite(uint16_t port);
584void exit_conf_mode_ite(uint16_t port);
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000585void probe_superio_ite(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000586int init_superio_ite(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000587
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000588/* mcp6x_spi.c */
589int mcp6x_spi_init(int want_spi);
590
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000591/* sb600spi.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000592int sb600_probe_spi(struct pci_dev *dev);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000593
594/* wbsio_spi.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000595int wbsio_check_for_spi(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000596#endif
597
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000598/* opaque.c */
599struct opaque_programmer {
600 int max_data_read;
601 int max_data_write;
602 /* Specific functions for this programmer */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000603 int (*probe) (struct flashctx *flash);
604 int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
605 int (*write) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
606 int (*erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000607 const void *data;
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000608};
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000609int register_opaque_programmer(const struct opaque_programmer *pgm);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000610
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000611/* programmer.c */
612int noop_shutdown(void);
Stefan Tauner305e0b92013-07-17 23:46:44 +0000613void *fallback_map(const char *descr, uintptr_t phys_addr, size_t len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000614void fallback_unmap(void *virt_addr, size_t len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000615void noop_chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr);
616void fallback_chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr);
617void fallback_chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr);
618void fallback_chip_writen(const struct flashctx *flash, uint8_t *buf, chipaddr addr, size_t len);
619uint16_t fallback_chip_readw(const struct flashctx *flash, const chipaddr addr);
620uint32_t fallback_chip_readl(const struct flashctx *flash, const chipaddr addr);
621void fallback_chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
622struct par_programmer {
623 void (*chip_writeb) (const struct flashctx *flash, uint8_t val, chipaddr addr);
624 void (*chip_writew) (const struct flashctx *flash, uint16_t val, chipaddr addr);
625 void (*chip_writel) (const struct flashctx *flash, uint32_t val, chipaddr addr);
626 void (*chip_writen) (const struct flashctx *flash, uint8_t *buf, chipaddr addr, size_t len);
627 uint8_t (*chip_readb) (const struct flashctx *flash, const chipaddr addr);
628 uint16_t (*chip_readw) (const struct flashctx *flash, const chipaddr addr);
629 uint32_t (*chip_readl) (const struct flashctx *flash, const chipaddr addr);
630 void (*chip_readn) (const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000631 const void *data;
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000632};
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000633int register_par_programmer(const struct par_programmer *pgm, const enum chipbustype buses);
634struct registered_programmer {
635 enum chipbustype buses_supported;
636 union {
637 struct par_programmer par;
638 struct spi_programmer spi;
639 struct opaque_programmer opaque;
640 };
641};
642extern struct registered_programmer registered_programmers[];
643extern int registered_programmer_count;
644int register_programmer(struct registered_programmer *pgm);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000645
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000646/* serprog.c */
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000647#if CONFIG_SERPROG == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000648int serprog_init(void);
Stefan Tauner31019d42011-10-22 21:45:27 +0000649void serprog_delay(int usecs);
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000650#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000651
652/* serial.c */
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +0000653#ifdef _WIN32
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000654typedef HANDLE fdtype;
Stefan Taunerbb4fed72012-09-01 21:47:19 +0000655#define SER_INV_FD INVALID_HANDLE_VALUE
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000656#else
657typedef int fdtype;
Stefan Taunerbb4fed72012-09-01 21:47:19 +0000658#define SER_INV_FD -1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000659#endif
660
661void sp_flush_incoming(void);
662fdtype sp_openserport(char *dev, unsigned int baud);
663void __attribute__((noreturn)) sp_die(char *msg);
664extern fdtype sp_fd;
David Hendricks8bb20212011-06-14 01:35:36 +0000665/* expose serialport_shutdown as it's currently used by buspirate */
666int serialport_shutdown(void *data);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000667int serialport_write(unsigned char *buf, unsigned int writecnt);
Stefan Taunerae3d8372013-04-01 00:45:45 +0000668int serialport_write_nonblock(unsigned char *buf, unsigned int writecnt, unsigned int timeout, unsigned int *really_wrote);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000669int serialport_read(unsigned char *buf, unsigned int readcnt);
Stefan Tauner00e16082013-04-01 00:45:38 +0000670int serialport_read_nonblock(unsigned char *c, unsigned int readcnt, unsigned int timeout, unsigned int *really_read);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000671
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +0000672/* Serial port/pin mapping:
673
674 1 CD <-
675 2 RXD <-
676 3 TXD ->
677 4 DTR ->
678 5 GND --
679 6 DSR <-
680 7 RTS ->
681 8 CTS <-
682 9 RI <-
683*/
684enum SP_PIN {
685 PIN_CD = 1,
686 PIN_RXD,
687 PIN_TXD,
688 PIN_DTR,
689 PIN_GND,
690 PIN_DSR,
691 PIN_RTS,
692 PIN_CTS,
693 PIN_RI,
694};
695
696void sp_set_pin(enum SP_PIN pin, int val);
697int sp_get_pin(enum SP_PIN pin);
698
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000699#endif /* !__PROGRAMMER_H__ */