blob: 3e87f38a6a67fb3864cbb5a7701513e7fa9a31c3 [file] [log] [blame]
hailfinger428f6852010-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
hailfingerfe7cd9e2011-11-04 21:35:26 +000027#include "flash.h" /* for chipaddr and flashchip */
28
hailfinger428f6852010-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,
uwe6764e922010-09-03 18:21:21 +000041#endif
hailfinger428f6852010-07-27 22:41:39 +000042#if CONFIG_NICNATSEMI == 1
43 PROGRAMMER_NICNATSEMI,
uwe6764e922010-09-03 18:21:21 +000044#endif
hailfinger428f6852010-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
hailfinger428f6852010-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
Anton Staafb2647882014-09-17 15:13:43 -070066#if CONFIG_RAIDEN_DEBUG_SPI == 1
67 PROGRAMMER_RAIDEN_DEBUG_SPI,
68#endif
hailfinger428f6852010-07-27 22:41:39 +000069#if CONFIG_DEDIPROG == 1
70 PROGRAMMER_DEDIPROG,
71#endif
72#if CONFIG_RAYER_SPI == 1
73 PROGRAMMER_RAYER_SPI,
74#endif
hailfinger7949b652011-05-08 00:24:18 +000075#if CONFIG_NICINTEL == 1
76 PROGRAMMER_NICINTEL,
77#endif
uwe6764e922010-09-03 18:21:21 +000078#if CONFIG_NICINTEL_SPI == 1
79 PROGRAMMER_NICINTEL_SPI,
80#endif
hailfingerfb1f31f2010-12-03 14:48:11 +000081#if CONFIG_OGP_SPI == 1
82 PROGRAMMER_OGP_SPI,
83#endif
hailfinger935365d2011-02-04 21:37:59 +000084#if CONFIG_SATAMV == 1
85 PROGRAMMER_SATAMV,
86#endif
uwe7df6dda2011-09-03 18:37:52 +000087#if CONFIG_LINUX_SPI == 1
88 PROGRAMMER_LINUX_SPI,
89#endif
hailfinger428f6852010-07-27 22:41:39 +000090 PROGRAMMER_INVALID /* This must always be the last entry. */
91};
92
David Hendricksba0827a2013-05-03 20:25:40 -070093enum alias_type {
94 ALIAS_NONE = 0, /* no alias (default) */
95 ALIAS_EC, /* embedded controller */
96 ALIAS_HOST, /* chipset / PCH / SoC / etc. */
97};
98
99struct programmer_alias {
100 const char *name;
101 enum alias_type type;
102};
103
104extern struct programmer_alias *alias;
105extern struct programmer_alias aliases[];
106
hailfinger428f6852010-07-27 22:41:39 +0000107struct programmer_entry {
108 const char *vendor;
109 const char *name;
110
111 int (*init) (void);
hailfinger428f6852010-07-27 22:41:39 +0000112
113 void * (*map_flash_region) (const char *descr, unsigned long phys_addr,
114 size_t len);
115 void (*unmap_flash_region) (void *virt_addr, size_t len);
116
hailfinger428f6852010-07-27 22:41:39 +0000117 void (*delay) (int usecs);
118};
119
120extern const struct programmer_entry programmer_table[];
121
hailfinger969e2f32011-09-08 00:00:29 +0000122int programmer_init(enum programmer prog, char *param);
hailfinger428f6852010-07-27 22:41:39 +0000123int programmer_shutdown(void);
124
125enum bitbang_spi_master_type {
126 BITBANG_SPI_INVALID = 0, /* This must always be the first entry. */
127#if CONFIG_RAYER_SPI == 1
128 BITBANG_SPI_MASTER_RAYER,
129#endif
uwe6764e922010-09-03 18:21:21 +0000130#if CONFIG_NICINTEL_SPI == 1
131 BITBANG_SPI_MASTER_NICINTEL,
132#endif
hailfinger52384c92010-07-28 15:08:35 +0000133#if CONFIG_INTERNAL == 1
134#if defined(__i386__) || defined(__x86_64__)
135 BITBANG_SPI_MASTER_MCP,
136#endif
137#endif
hailfingerfb1f31f2010-12-03 14:48:11 +0000138#if CONFIG_OGP_SPI == 1
139 BITBANG_SPI_MASTER_OGP,
140#endif
hailfinger428f6852010-07-27 22:41:39 +0000141};
142
143struct bitbang_spi_master {
144 enum bitbang_spi_master_type type;
145
146 /* Note that CS# is active low, so val=0 means the chip is active. */
147 void (*set_cs) (int val);
148 void (*set_sck) (int val);
149 void (*set_mosi) (int val);
150 int (*get_miso) (void);
hailfinger12cba9a2010-09-15 00:17:37 +0000151 void (*request_bus) (void);
152 void (*release_bus) (void);
hailfinger428f6852010-07-27 22:41:39 +0000153};
154
155#if CONFIG_INTERNAL == 1
156struct penable {
157 uint16_t vendor_id;
158 uint16_t device_id;
stefanct6d836ba2011-05-26 01:35:19 +0000159 int status; /* OK=0 and NT=1 are defines only. Beware! */
hailfinger428f6852010-07-27 22:41:39 +0000160 const char *vendor_name;
161 const char *device_name;
162 int (*doit) (struct pci_dev *dev, const char *name);
163};
164
165extern const struct penable chipset_enables[];
166
hailfingere52e9f82011-05-05 07:12:40 +0000167enum board_match_phase {
168 P1,
169 P2,
170 P3
171};
172
hailfinger4640bdb2011-08-31 16:19:50 +0000173struct board_match {
hailfinger428f6852010-07-27 22:41:39 +0000174 /* Any device, but make it sensible, like the ISA bridge. */
175 uint16_t first_vendor;
176 uint16_t first_device;
177 uint16_t first_card_vendor;
178 uint16_t first_card_device;
179
180 /* Any device, but make it sensible, like
181 * the host bridge. May be NULL.
182 */
183 uint16_t second_vendor;
184 uint16_t second_device;
185 uint16_t second_card_vendor;
186 uint16_t second_card_device;
187
stefanct6d836ba2011-05-26 01:35:19 +0000188 /* Pattern to match DMI entries. May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000189 const char *dmi_pattern;
190
stefanct6d836ba2011-05-26 01:35:19 +0000191 /* The vendor / part name from the coreboot table. May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000192 const char *lb_vendor;
193 const char *lb_part;
194
hailfingere52e9f82011-05-05 07:12:40 +0000195 enum board_match_phase phase;
196
hailfinger428f6852010-07-27 22:41:39 +0000197 const char *vendor_name;
198 const char *board_name;
199
200 int max_rom_decode_parallel;
201 int status;
stefanct6d836ba2011-05-26 01:35:19 +0000202 int (*enable) (void); /* May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000203};
204
hailfinger4640bdb2011-08-31 16:19:50 +0000205extern const struct board_match board_matches[];
hailfinger428f6852010-07-27 22:41:39 +0000206
207struct board_info {
208 const char *vendor;
209 const char *name;
210 const int working;
211#ifdef CONFIG_PRINT_WIKI
212 const char *url;
213 const char *note;
214#endif
215};
216
217extern const struct board_info boards_known[];
218extern const struct board_info laptops_known[];
219#endif
220
221/* udelay.c */
222void myusec_delay(int usecs);
223void myusec_calibrate_delay(void);
224void internal_delay(int usecs);
225
226#if NEED_PCI == 1
227/* pcidev.c */
228extern uint32_t io_base_addr;
229extern struct pci_access *pacc;
230extern struct pci_dev *pcidev_dev;
231struct pcidev_status {
232 uint16_t vendor_id;
233 uint16_t device_id;
234 int status;
235 const char *vendor_name;
236 const char *device_name;
237};
hailfingerbf923c32011-02-15 22:44:27 +0000238uintptr_t pcidev_validate(struct pci_dev *dev, int bar, const struct pcidev_status *devs);
hailfinger0d703d42011-03-07 01:08:09 +0000239uintptr_t pcidev_init(int bar, const struct pcidev_status *devs);
hailfingerf31cbdc2010-11-10 15:25:18 +0000240/* rpci_write_* are reversible writes. The original PCI config space register
241 * contents will be restored on shutdown.
242 */
mkarcher08a24552010-12-26 23:55:19 +0000243int rpci_write_byte(struct pci_dev *dev, int reg, uint8_t data);
244int rpci_write_word(struct pci_dev *dev, int reg, uint16_t data);
245int rpci_write_long(struct pci_dev *dev, int reg, uint32_t data);
hailfinger428f6852010-07-27 22:41:39 +0000246#endif
247
248/* print.c */
hailfinger7949b652011-05-08 00:24:18 +0000249#if CONFIG_NIC3COM+CONFIG_NICREALTEK+CONFIG_NICNATSEMI+CONFIG_GFXNVIDIA+CONFIG_DRKAISER+CONFIG_SATASII+CONFIG_ATAHPT+CONFIG_NICINTEL+CONFIG_NICINTEL_SPI+CONFIG_OGP_SPI+CONFIG_SATAMV >= 1
hailfinger428f6852010-07-27 22:41:39 +0000250void print_supported_pcidevs(const struct pcidev_status *devs);
251#endif
252
hailfingere20dc562011-06-09 20:06:34 +0000253#if CONFIG_INTERNAL == 1
hailfinger428f6852010-07-27 22:41:39 +0000254/* board_enable.c */
255void w836xx_ext_enter(uint16_t port);
256void w836xx_ext_leave(uint16_t port);
257int it8705f_write_enable(uint8_t port);
258uint8_t sio_read(uint16_t port, uint8_t reg);
259void sio_write(uint16_t port, uint8_t reg, uint8_t data);
260void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
hailfingere52e9f82011-05-05 07:12:40 +0000261void board_handle_before_superio(void);
262void board_handle_before_laptop(void);
hailfinger428f6852010-07-27 22:41:39 +0000263int board_flash_enable(const char *vendor, const char *part);
264
265/* chipset_enable.c */
266int chipset_flash_enable(void);
Louis Yung-Chieh Lo6b8f0462011-01-06 12:49:46 +0800267int get_target_bus_from_chipset(enum chipbustype *target_bus);
hailfinger428f6852010-07-27 22:41:39 +0000268
269/* processor_enable.c */
270int processor_flash_enable(void);
hailfingere52e9f82011-05-05 07:12:40 +0000271#endif
hailfinger428f6852010-07-27 22:41:39 +0000272
273/* physmap.c */
274void *physmap(const char *descr, unsigned long phys_addr, size_t len);
275void *physmap_try_ro(const char *descr, unsigned long phys_addr, size_t len);
276void physunmap(void *virt_addr, size_t len);
hailfingere20dc562011-06-09 20:06:34 +0000277#if CONFIG_INTERNAL == 1
hailfinger428f6852010-07-27 22:41:39 +0000278int setup_cpu_msr(int cpu);
279void cleanup_cpu_msr(void);
280
281/* cbtable.c */
282void lb_vendor_dev_from_string(char *boardstring);
283int coreboot_init(void);
284extern char *lb_part, *lb_vendor;
285extern int partvendor_from_cbtable;
286
287/* dmi.c */
288extern int has_dmi_support;
289void dmi_init(void);
290int dmi_match(const char *pattern);
291
292/* internal.c */
hailfinger428f6852010-07-27 22:41:39 +0000293struct superio {
294 uint16_t vendor;
295 uint16_t port;
296 uint16_t model;
297};
hailfinger94e090c2011-04-27 14:34:08 +0000298extern struct superio superios[];
299extern int superio_count;
hailfinger428f6852010-07-27 22:41:39 +0000300#define SUPERIO_VENDOR_NONE 0x0
301#define SUPERIO_VENDOR_ITE 0x1
hailfingere20dc562011-06-09 20:06:34 +0000302#endif
303#if NEED_PCI == 1
hailfinger428f6852010-07-27 22:41:39 +0000304struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
uwe922946a2011-07-13 11:22:03 +0000305struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t devclass);
hailfinger428f6852010-07-27 22:41:39 +0000306struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
307struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
308 uint16_t card_vendor, uint16_t card_device);
309#endif
310void get_io_perms(void);
311void release_io_perms(void);
312#if CONFIG_INTERNAL == 1
313extern int is_laptop;
hailfingere52e9f82011-05-05 07:12:40 +0000314extern int laptop_ok;
hailfinger428f6852010-07-27 22:41:39 +0000315extern int force_boardenable;
316extern int force_boardmismatch;
317void probe_superio(void);
hailfinger94e090c2011-04-27 14:34:08 +0000318int register_superio(struct superio s);
hailfinger76bb7e92011-11-09 23:40:00 +0000319extern enum chipbustype internal_buses_supported;
hailfinger428f6852010-07-27 22:41:39 +0000320int internal_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000321void internal_chip_writeb(uint8_t val, chipaddr addr);
322void internal_chip_writew(uint16_t val, chipaddr addr);
323void internal_chip_writel(uint32_t val, chipaddr addr);
324uint8_t internal_chip_readb(const chipaddr addr);
325uint16_t internal_chip_readw(const chipaddr addr);
326uint32_t internal_chip_readl(const chipaddr addr);
327void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
328#endif
329
330/* hwaccess.c */
331void mmio_writeb(uint8_t val, void *addr);
332void mmio_writew(uint16_t val, void *addr);
333void mmio_writel(uint32_t val, void *addr);
334uint8_t mmio_readb(void *addr);
335uint16_t mmio_readw(void *addr);
336uint32_t mmio_readl(void *addr);
337void mmio_le_writeb(uint8_t val, void *addr);
338void mmio_le_writew(uint16_t val, void *addr);
339void mmio_le_writel(uint32_t val, void *addr);
340uint8_t mmio_le_readb(void *addr);
341uint16_t mmio_le_readw(void *addr);
342uint32_t mmio_le_readl(void *addr);
343#define pci_mmio_writeb mmio_le_writeb
344#define pci_mmio_writew mmio_le_writew
345#define pci_mmio_writel mmio_le_writel
346#define pci_mmio_readb mmio_le_readb
347#define pci_mmio_readw mmio_le_readw
348#define pci_mmio_readl mmio_le_readl
hailfinger1e2e3442011-05-03 21:49:41 +0000349void rmmio_writeb(uint8_t val, void *addr);
350void rmmio_writew(uint16_t val, void *addr);
351void rmmio_writel(uint32_t val, void *addr);
352void rmmio_le_writeb(uint8_t val, void *addr);
353void rmmio_le_writew(uint16_t val, void *addr);
354void rmmio_le_writel(uint32_t val, void *addr);
355#define pci_rmmio_writeb rmmio_le_writeb
356#define pci_rmmio_writew rmmio_le_writew
357#define pci_rmmio_writel rmmio_le_writel
358void rmmio_valb(void *addr);
359void rmmio_valw(void *addr);
360void rmmio_vall(void *addr);
hailfinger428f6852010-07-27 22:41:39 +0000361
362/* programmer.c */
363int noop_shutdown(void);
364void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
365void fallback_unmap(void *virt_addr, size_t len);
366uint8_t noop_chip_readb(const chipaddr addr);
367void noop_chip_writeb(uint8_t val, chipaddr addr);
368void fallback_chip_writew(uint16_t val, chipaddr addr);
369void fallback_chip_writel(uint32_t val, chipaddr addr);
370void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
371uint16_t fallback_chip_readw(const chipaddr addr);
372uint32_t fallback_chip_readl(const chipaddr addr);
373void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger76bb7e92011-11-09 23:40:00 +0000374struct par_programmer {
375 void (*chip_writeb) (uint8_t val, chipaddr addr);
376 void (*chip_writew) (uint16_t val, chipaddr addr);
377 void (*chip_writel) (uint32_t val, chipaddr addr);
378 void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
379 uint8_t (*chip_readb) (const chipaddr addr);
380 uint16_t (*chip_readw) (const chipaddr addr);
381 uint32_t (*chip_readl) (const chipaddr addr);
382 void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
383};
384extern const struct par_programmer *par_programmer;
385void register_par_programmer(const struct par_programmer *pgm, const enum chipbustype buses);
hailfinger428f6852010-07-27 22:41:39 +0000386
387/* dummyflasher.c */
388#if CONFIG_DUMMY == 1
389int dummy_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000390void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
391void dummy_unmap(void *virt_addr, size_t len);
392void dummy_chip_writeb(uint8_t val, chipaddr addr);
393void dummy_chip_writew(uint16_t val, chipaddr addr);
394void dummy_chip_writel(uint32_t val, chipaddr addr);
395void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
396uint8_t dummy_chip_readb(const chipaddr addr);
397uint16_t dummy_chip_readw(const chipaddr addr);
398uint32_t dummy_chip_readl(const chipaddr addr);
399void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000400#endif
401
402/* nic3com.c */
403#if CONFIG_NIC3COM == 1
404int nic3com_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000405void nic3com_chip_writeb(uint8_t val, chipaddr addr);
406uint8_t nic3com_chip_readb(const chipaddr addr);
407extern const struct pcidev_status nics_3com[];
408#endif
409
410/* gfxnvidia.c */
411#if CONFIG_GFXNVIDIA == 1
412int gfxnvidia_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000413void gfxnvidia_chip_writeb(uint8_t val, chipaddr addr);
414uint8_t gfxnvidia_chip_readb(const chipaddr addr);
415extern const struct pcidev_status gfx_nvidia[];
416#endif
417
418/* drkaiser.c */
419#if CONFIG_DRKAISER == 1
420int drkaiser_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000421void drkaiser_chip_writeb(uint8_t val, chipaddr addr);
422uint8_t drkaiser_chip_readb(const chipaddr addr);
423extern const struct pcidev_status drkaiser_pcidev[];
424#endif
425
426/* nicrealtek.c */
427#if CONFIG_NICREALTEK == 1
428int nicrealtek_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000429void nicrealtek_chip_writeb(uint8_t val, chipaddr addr);
430uint8_t nicrealtek_chip_readb(const chipaddr addr);
431extern const struct pcidev_status nics_realtek[];
hailfinger428f6852010-07-27 22:41:39 +0000432#endif
433
434/* nicnatsemi.c */
435#if CONFIG_NICNATSEMI == 1
436int nicnatsemi_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000437void nicnatsemi_chip_writeb(uint8_t val, chipaddr addr);
438uint8_t nicnatsemi_chip_readb(const chipaddr addr);
439extern const struct pcidev_status nics_natsemi[];
440#endif
441
hailfinger7949b652011-05-08 00:24:18 +0000442/* nicintel.c */
443#if CONFIG_NICINTEL == 1
444int nicintel_init(void);
hailfinger7949b652011-05-08 00:24:18 +0000445void nicintel_chip_writeb(uint8_t val, chipaddr addr);
446uint8_t nicintel_chip_readb(const chipaddr addr);
447extern const struct pcidev_status nics_intel[];
448#endif
449
uwe6764e922010-09-03 18:21:21 +0000450/* nicintel_spi.c */
451#if CONFIG_NICINTEL_SPI == 1
452int nicintel_spi_init(void);
uwe6764e922010-09-03 18:21:21 +0000453extern const struct pcidev_status nics_intel_spi[];
454#endif
455
hailfingerfb1f31f2010-12-03 14:48:11 +0000456/* ogp_spi.c */
457#if CONFIG_OGP_SPI == 1
458int ogp_spi_init(void);
hailfingerfb1f31f2010-12-03 14:48:11 +0000459extern const struct pcidev_status ogp_spi[];
460#endif
461
hailfinger935365d2011-02-04 21:37:59 +0000462/* satamv.c */
463#if CONFIG_SATAMV == 1
464int satamv_init(void);
hailfinger935365d2011-02-04 21:37:59 +0000465void satamv_chip_writeb(uint8_t val, chipaddr addr);
466uint8_t satamv_chip_readb(const chipaddr addr);
467extern const struct pcidev_status satas_mv[];
468#endif
469
hailfinger428f6852010-07-27 22:41:39 +0000470/* satasii.c */
471#if CONFIG_SATASII == 1
472int satasii_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000473void satasii_chip_writeb(uint8_t val, chipaddr addr);
474uint8_t satasii_chip_readb(const chipaddr addr);
475extern const struct pcidev_status satas_sii[];
476#endif
477
478/* atahpt.c */
479#if CONFIG_ATAHPT == 1
480int atahpt_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000481void atahpt_chip_writeb(uint8_t val, chipaddr addr);
482uint8_t atahpt_chip_readb(const chipaddr addr);
483extern const struct pcidev_status ata_hpt[];
484#endif
485
486/* ft2232_spi.c */
hailfinger888410e2010-07-29 15:54:53 +0000487#if CONFIG_FT2232_SPI == 1
488struct usbdev_status {
uwee15beb92010-08-08 17:01:18 +0000489 uint16_t vendor_id;
490 uint16_t device_id;
491 int status;
492 const char *vendor_name;
493 const char *device_name;
hailfinger888410e2010-07-29 15:54:53 +0000494};
hailfinger428f6852010-07-27 22:41:39 +0000495int ft2232_spi_init(void);
hailfinger888410e2010-07-29 15:54:53 +0000496extern const struct usbdev_status devs_ft2232spi[];
497void print_supported_usbdevs(const struct usbdev_status *devs);
498#endif
hailfinger428f6852010-07-27 22:41:39 +0000499
500/* rayer_spi.c */
501#if CONFIG_RAYER_SPI == 1
502int rayer_spi_init(void);
503#endif
504
505/* bitbang_spi.c */
506int bitbang_spi_init(const struct bitbang_spi_master *master, int halfperiod);
hailfinger12cba9a2010-09-15 00:17:37 +0000507int bitbang_spi_shutdown(const struct bitbang_spi_master *master);
hailfinger428f6852010-07-27 22:41:39 +0000508
509/* buspirate_spi.c */
hailfingere20dc562011-06-09 20:06:34 +0000510#if CONFIG_BUSPIRATE_SPI == 1
hailfinger428f6852010-07-27 22:41:39 +0000511int buspirate_spi_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000512#endif
hailfinger428f6852010-07-27 22:41:39 +0000513
Anton Staafb2647882014-09-17 15:13:43 -0700514/* raiden_debug_spi.c */
515#if CONFIG_RAIDEN_DEBUG_SPI == 1
516int raiden_debug_spi_init(void);
517#endif
518
David Hendricks7e449602013-05-17 19:21:36 -0700519/* linux_i2c.c */
520#if CONFIG_LINUX_I2C == 1
521int linux_i2c_shutdown(void *data);
522int linux_i2c_init(void);
523int linux_i2c_open(int bus, int addr, int force);
524void linux_i2c_close(void);
525int linux_i2c_xfer(int bus, int addr, const void *inbuf,
526 int insize, const void *outbuf, int outsize);
527#endif
528
uwe7df6dda2011-09-03 18:37:52 +0000529/* linux_spi.c */
530#if CONFIG_LINUX_SPI == 1
531int linux_spi_init(void);
532#endif
533
hailfinger428f6852010-07-27 22:41:39 +0000534/* dediprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000535#if CONFIG_DEDIPROG == 1
hailfinger428f6852010-07-27 22:41:39 +0000536int dediprog_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000537#endif
hailfinger428f6852010-07-27 22:41:39 +0000538
539/* flashrom.c */
540struct decode_sizes {
541 uint32_t parallel;
542 uint32_t lpc;
543 uint32_t fwh;
544 uint32_t spi;
545};
546extern struct decode_sizes max_rom_decode;
547extern int programmer_may_write;
548extern unsigned long flashbase;
hailfinger48ed3e22011-05-04 00:39:50 +0000549void check_chip_supported(const struct flashchip *flash);
hailfinger428f6852010-07-27 22:41:39 +0000550int check_max_decode(enum chipbustype buses, uint32_t size);
stefanct52700282011-06-26 17:38:17 +0000551char *extract_programmer_param(const char *param_name);
hailfinger428f6852010-07-27 22:41:39 +0000552
553/* layout.c */
554int show_id(uint8_t *bios, int size, int force);
555
556/* spi.c */
557enum spi_controller {
558 SPI_CONTROLLER_NONE,
559#if CONFIG_INTERNAL == 1
560#if defined(__i386__) || defined(__x86_64__)
561 SPI_CONTROLLER_ICH7,
562 SPI_CONTROLLER_ICH9,
David Hendricks07af3a42011-07-11 22:13:02 -0700563 SPI_CONTROLLER_ICH_HWSEQ,
hailfinger2b46a862011-02-28 23:58:15 +0000564 SPI_CONTROLLER_IT85XX,
hailfinger428f6852010-07-27 22:41:39 +0000565 SPI_CONTROLLER_IT87XX,
David Hendricks46d32e32011-01-19 16:01:52 -0800566 SPI_CONTROLLER_MEC1308,
hailfinger428f6852010-07-27 22:41:39 +0000567 SPI_CONTROLLER_SB600,
568 SPI_CONTROLLER_VIA,
569 SPI_CONTROLLER_WBSIO,
David Hendricksc801adb2010-12-09 16:58:56 -0800570 SPI_CONTROLLER_WPCE775X,
Rong Changaaa1acf2012-06-21 19:21:18 +0800571 SPI_CONTROLLER_ENE,
David Hendricks82fd8ae2010-08-04 14:34:54 -0700572#endif
Louis Yung-Chieh Lobc351d02011-03-31 13:09:21 +0800573#if defined(__arm__)
574 SPI_CONTROLLER_TEGRA2,
hailfinger428f6852010-07-27 22:41:39 +0000575#endif
576#endif
577#if CONFIG_FT2232_SPI == 1
578 SPI_CONTROLLER_FT2232,
579#endif
580#if CONFIG_DUMMY == 1
581 SPI_CONTROLLER_DUMMY,
582#endif
583#if CONFIG_BUSPIRATE_SPI == 1
584 SPI_CONTROLLER_BUSPIRATE,
585#endif
Anton Staafb2647882014-09-17 15:13:43 -0700586#if CONFIG_RAIDEN_DEBUG_SPI == 1
587 SPI_CONTROLLER_RAIDEN_DEBUG,
588#endif
hailfinger428f6852010-07-27 22:41:39 +0000589#if CONFIG_DEDIPROG == 1
590 SPI_CONTROLLER_DEDIPROG,
591#endif
David Hendricks91040832011-07-08 20:01:09 -0700592#if CONFIG_OGP_SPI == 1 || CONFIG_NICINTEL_SPI == 1 || CONFIG_RAYER_SPI == 1 || (CONFIG_INTERNAL == 1 && (defined(__i386__) || defined(__x86_64__) || defined(__arm__)))
mkarcherd264e9e2011-05-11 17:07:07 +0000593 SPI_CONTROLLER_BITBANG,
hailfinger428f6852010-07-27 22:41:39 +0000594#endif
uwe7df6dda2011-09-03 18:37:52 +0000595#if CONFIG_LINUX_SPI == 1
596 SPI_CONTROLLER_LINUX,
597#endif
stefanct69965b62011-09-15 23:38:14 +0000598#if CONFIG_SERPROG == 1
599 SPI_CONTROLLER_SERPROG,
600#endif
hailfinger428f6852010-07-27 22:41:39 +0000601};
602extern const int spi_programmer_count;
mkarcher8fb57592011-05-11 17:07:02 +0000603
604#define MAX_DATA_UNSPECIFIED 0
605#define MAX_DATA_READ_UNLIMITED 64 * 1024
606#define MAX_DATA_WRITE_UNLIMITED 256
hailfinger428f6852010-07-27 22:41:39 +0000607struct spi_programmer {
mkarcherd264e9e2011-05-11 17:07:07 +0000608 enum spi_controller type;
stefanctc5eb8a92011-11-23 09:13:48 +0000609 unsigned int max_data_read;
610 unsigned int max_data_write;
hailfinger428f6852010-07-27 22:41:39 +0000611 int (*command)(unsigned int writecnt, unsigned int readcnt,
612 const unsigned char *writearr, unsigned char *readarr);
613 int (*multicommand)(struct spi_command *cmds);
614
615 /* Optimized functions for this programmer */
stefanctc5eb8a92011-11-23 09:13:48 +0000616 int (*read)(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
617 int (*write_256)(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
hailfinger428f6852010-07-27 22:41:39 +0000618};
619
mkarcherd264e9e2011-05-11 17:07:07 +0000620extern const struct spi_programmer *spi_programmer;
hailfinger428f6852010-07-27 22:41:39 +0000621int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
622 const unsigned char *writearr, unsigned char *readarr);
623int default_spi_send_multicommand(struct spi_command *cmds);
stefanctc5eb8a92011-11-23 09:13:48 +0000624int default_spi_read(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
625int default_spi_write_256(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
mkarcherd264e9e2011-05-11 17:07:07 +0000626void register_spi_programmer(const struct spi_programmer *programmer);
hailfinger428f6852010-07-27 22:41:39 +0000627
628/* ichspi.c */
629#if CONFIG_INTERNAL == 1
stefanctc035c192011-11-06 23:51:09 +0000630enum ich_chipset {
631 CHIPSET_ICH_UNKNOWN,
632 CHIPSET_ICH7 = 7,
633 CHIPSET_ICH8,
634 CHIPSET_ICH9,
635 CHIPSET_ICH10,
636 CHIPSET_5_SERIES_IBEX_PEAK,
637 CHIPSET_6_SERIES_COUGAR_POINT,
Duncan Laurie32e60552013-02-28 09:42:07 -0800638 CHIPSET_7_SERIES_PANTHER_POINT,
639 CHIPSET_8_SERIES_LYNX_POINT,
640 CHIPSET_8_SERIES_LYNX_POINT_LP,
Duncan Laurie9bd2af82014-05-12 10:17:38 -0700641 CHIPSET_9_SERIES_WILDCAT_POINT,
Duncan Lauried59ec692013-11-25 09:40:56 -0800642 CHIPSET_BAYTRAIL,
stefanctc035c192011-11-06 23:51:09 +0000643};
644
hailfinger428f6852010-07-27 22:41:39 +0000645extern uint32_t ichspi_bbar;
646int ich_init_spi(struct pci_dev *dev, uint32_t base, void *rcrb,
stefanctc035c192011-11-06 23:51:09 +0000647 enum ich_chipset ich_generation);
hailfinger428f6852010-07-27 22:41:39 +0000648int via_init_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000649
Rong Changaaa1acf2012-06-21 19:21:18 +0800650/* ene_lpc.c */
651int ene_probe_spi_flash(const char *name);
652
hailfinger2b46a862011-02-28 23:58:15 +0000653/* it85spi.c */
hailfinger94e090c2011-04-27 14:34:08 +0000654int it85xx_spi_init(struct superio s);
Shawn Nematbakhsh3404b1a2012-07-26 15:19:58 -0700655int it8518_spi_init(struct superio s);
hailfinger2b46a862011-02-28 23:58:15 +0000656
hailfinger428f6852010-07-27 22:41:39 +0000657/* it87spi.c */
658void enter_conf_mode_ite(uint16_t port);
659void exit_conf_mode_ite(uint16_t port);
hailfinger94e090c2011-04-27 14:34:08 +0000660void probe_superio_ite(void);
hailfinger428f6852010-07-27 22:41:39 +0000661int init_superio_ite(void);
hailfinger428f6852010-07-27 22:41:39 +0000662
hailfingere20dc562011-06-09 20:06:34 +0000663/* mcp6x_spi.c */
664int mcp6x_spi_init(int want_spi);
665
David Hendricks46d32e32011-01-19 16:01:52 -0800666/* mec1308.c */
David Hendricks46d32e32011-01-19 16:01:52 -0800667int mec1308_probe_spi_flash(const char *name);
David Hendricks46d32e32011-01-19 16:01:52 -0800668
hailfinger428f6852010-07-27 22:41:39 +0000669/* sb600spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000670int sb600_probe_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000671
672/* wbsio_spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000673int wbsio_check_for_spi(void);
hailfinger428f6852010-07-27 22:41:39 +0000674#endif
675
hailfingerfe7cd9e2011-11-04 21:35:26 +0000676/* opaque.c */
677struct opaque_programmer {
678 int max_data_read;
679 int max_data_write;
680 /* Specific functions for this programmer */
681 int (*probe) (struct flashchip *flash);
stefanctc5eb8a92011-11-23 09:13:48 +0000682 int (*read) (struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
683 int (*write) (struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000684 int (*erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
David Hendricks5d481e12012-05-24 14:14:14 -0700685 const void *data;
hailfingerfe7cd9e2011-11-04 21:35:26 +0000686};
David Hendricks292edf02013-07-11 16:12:58 -0700687extern struct opaque_programmer *opaque_programmer;
688void register_opaque_programmer(struct opaque_programmer *pgm);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000689
hailfinger428f6852010-07-27 22:41:39 +0000690/* serprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000691#if CONFIG_SERPROG == 1
hailfinger428f6852010-07-27 22:41:39 +0000692int serprog_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000693void serprog_chip_writeb(uint8_t val, chipaddr addr);
694uint8_t serprog_chip_readb(const chipaddr addr);
695void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
stefanctd9ac2212011-10-22 21:45:27 +0000696void serprog_delay(int usecs);
hailfingere20dc562011-06-09 20:06:34 +0000697#endif
hailfinger428f6852010-07-27 22:41:39 +0000698
699/* serial.c */
700#if _WIN32
701typedef HANDLE fdtype;
702#else
703typedef int fdtype;
704#endif
705
David Hendricksc801adb2010-12-09 16:58:56 -0800706/* wpce775x.c */
David Hendricksc801adb2010-12-09 16:58:56 -0800707int wpce775x_probe_spi_flash(const char *name);
David Hendricksc801adb2010-12-09 16:58:56 -0800708
David Hendricksb907de32014-08-11 16:47:09 -0700709/* cros_ec.c */
710int cros_ec_probe_i2c(const char *name);
Simon Glasscd597032013-05-23 17:18:44 -0700711
712/**
713 * Probe the Google Chrome OS EC device
714 *
715 * @return 0 if found correct, non-zero if not found or error
716 */
David Hendricksb907de32014-08-11 16:47:09 -0700717int cros_ec_probe_dev(void);
Simon Glasscd597032013-05-23 17:18:44 -0700718
David Hendricksb907de32014-08-11 16:47:09 -0700719int cros_ec_probe_lpc(const char *name);
720int cros_ec_need_2nd_pass(void);
721int cros_ec_finish(void);
722int cros_ec_prepare(uint8_t *image, int size);
Louis Yung-Chieh Loedb0cba2011-12-09 17:06:54 +0800723
hailfinger428f6852010-07-27 22:41:39 +0000724void sp_flush_incoming(void);
725fdtype sp_openserport(char *dev, unsigned int baud);
726void __attribute__((noreturn)) sp_die(char *msg);
727extern fdtype sp_fd;
dhendrix0ffc2eb2011-06-14 01:35:36 +0000728/* expose serialport_shutdown as it's currently used by buspirate */
729int serialport_shutdown(void *data);
hailfinger428f6852010-07-27 22:41:39 +0000730int serialport_write(unsigned char *buf, unsigned int writecnt);
731int serialport_read(unsigned char *buf, unsigned int readcnt);
732
733#endif /* !__PROGRAMMER_H__ */