blob: 9f3b06b06744c954fd5cb633a3856ca4fd1ce565 [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);
Ramya Vijaykumare6a7ca82015-05-12 14:27:29 +0530268enum ich_chipset ich_generation;
hailfinger428f6852010-07-27 22:41:39 +0000269
270/* processor_enable.c */
271int processor_flash_enable(void);
hailfingere52e9f82011-05-05 07:12:40 +0000272#endif
hailfinger428f6852010-07-27 22:41:39 +0000273
274/* physmap.c */
275void *physmap(const char *descr, unsigned long phys_addr, size_t len);
276void *physmap_try_ro(const char *descr, unsigned long phys_addr, size_t len);
277void physunmap(void *virt_addr, size_t len);
hailfingere20dc562011-06-09 20:06:34 +0000278#if CONFIG_INTERNAL == 1
hailfinger428f6852010-07-27 22:41:39 +0000279int setup_cpu_msr(int cpu);
280void cleanup_cpu_msr(void);
281
282/* cbtable.c */
283void lb_vendor_dev_from_string(char *boardstring);
284int coreboot_init(void);
285extern char *lb_part, *lb_vendor;
286extern int partvendor_from_cbtable;
287
288/* dmi.c */
289extern int has_dmi_support;
290void dmi_init(void);
291int dmi_match(const char *pattern);
292
293/* internal.c */
hailfinger428f6852010-07-27 22:41:39 +0000294struct superio {
295 uint16_t vendor;
296 uint16_t port;
297 uint16_t model;
298};
hailfinger94e090c2011-04-27 14:34:08 +0000299extern struct superio superios[];
300extern int superio_count;
hailfinger428f6852010-07-27 22:41:39 +0000301#define SUPERIO_VENDOR_NONE 0x0
302#define SUPERIO_VENDOR_ITE 0x1
hailfingere20dc562011-06-09 20:06:34 +0000303#endif
304#if NEED_PCI == 1
hailfinger428f6852010-07-27 22:41:39 +0000305struct pci_dev *pci_dev_find_filter(struct pci_filter filter);
uwe922946a2011-07-13 11:22:03 +0000306struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t devclass);
hailfinger428f6852010-07-27 22:41:39 +0000307struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
308struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
309 uint16_t card_vendor, uint16_t card_device);
310#endif
311void get_io_perms(void);
312void release_io_perms(void);
313#if CONFIG_INTERNAL == 1
314extern int is_laptop;
hailfingere52e9f82011-05-05 07:12:40 +0000315extern int laptop_ok;
hailfinger428f6852010-07-27 22:41:39 +0000316extern int force_boardenable;
317extern int force_boardmismatch;
318void probe_superio(void);
hailfinger94e090c2011-04-27 14:34:08 +0000319int register_superio(struct superio s);
hailfinger76bb7e92011-11-09 23:40:00 +0000320extern enum chipbustype internal_buses_supported;
hailfinger428f6852010-07-27 22:41:39 +0000321int internal_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000322void internal_chip_writeb(uint8_t val, chipaddr addr);
323void internal_chip_writew(uint16_t val, chipaddr addr);
324void internal_chip_writel(uint32_t val, chipaddr addr);
325uint8_t internal_chip_readb(const chipaddr addr);
326uint16_t internal_chip_readw(const chipaddr addr);
327uint32_t internal_chip_readl(const chipaddr addr);
328void internal_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
329#endif
330
331/* hwaccess.c */
332void mmio_writeb(uint8_t val, void *addr);
333void mmio_writew(uint16_t val, void *addr);
334void mmio_writel(uint32_t val, void *addr);
335uint8_t mmio_readb(void *addr);
336uint16_t mmio_readw(void *addr);
337uint32_t mmio_readl(void *addr);
338void mmio_le_writeb(uint8_t val, void *addr);
339void mmio_le_writew(uint16_t val, void *addr);
340void mmio_le_writel(uint32_t val, void *addr);
341uint8_t mmio_le_readb(void *addr);
342uint16_t mmio_le_readw(void *addr);
343uint32_t mmio_le_readl(void *addr);
344#define pci_mmio_writeb mmio_le_writeb
345#define pci_mmio_writew mmio_le_writew
346#define pci_mmio_writel mmio_le_writel
347#define pci_mmio_readb mmio_le_readb
348#define pci_mmio_readw mmio_le_readw
349#define pci_mmio_readl mmio_le_readl
hailfinger1e2e3442011-05-03 21:49:41 +0000350void rmmio_writeb(uint8_t val, void *addr);
351void rmmio_writew(uint16_t val, void *addr);
352void rmmio_writel(uint32_t val, void *addr);
353void rmmio_le_writeb(uint8_t val, void *addr);
354void rmmio_le_writew(uint16_t val, void *addr);
355void rmmio_le_writel(uint32_t val, void *addr);
356#define pci_rmmio_writeb rmmio_le_writeb
357#define pci_rmmio_writew rmmio_le_writew
358#define pci_rmmio_writel rmmio_le_writel
359void rmmio_valb(void *addr);
360void rmmio_valw(void *addr);
361void rmmio_vall(void *addr);
hailfinger428f6852010-07-27 22:41:39 +0000362
363/* programmer.c */
364int noop_shutdown(void);
365void *fallback_map(const char *descr, unsigned long phys_addr, size_t len);
366void fallback_unmap(void *virt_addr, size_t len);
367uint8_t noop_chip_readb(const chipaddr addr);
368void noop_chip_writeb(uint8_t val, chipaddr addr);
369void fallback_chip_writew(uint16_t val, chipaddr addr);
370void fallback_chip_writel(uint32_t val, chipaddr addr);
371void fallback_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
372uint16_t fallback_chip_readw(const chipaddr addr);
373uint32_t fallback_chip_readl(const chipaddr addr);
374void fallback_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger76bb7e92011-11-09 23:40:00 +0000375struct par_programmer {
376 void (*chip_writeb) (uint8_t val, chipaddr addr);
377 void (*chip_writew) (uint16_t val, chipaddr addr);
378 void (*chip_writel) (uint32_t val, chipaddr addr);
379 void (*chip_writen) (uint8_t *buf, chipaddr addr, size_t len);
380 uint8_t (*chip_readb) (const chipaddr addr);
381 uint16_t (*chip_readw) (const chipaddr addr);
382 uint32_t (*chip_readl) (const chipaddr addr);
383 void (*chip_readn) (uint8_t *buf, const chipaddr addr, size_t len);
384};
385extern const struct par_programmer *par_programmer;
386void register_par_programmer(const struct par_programmer *pgm, const enum chipbustype buses);
hailfinger428f6852010-07-27 22:41:39 +0000387
388/* dummyflasher.c */
389#if CONFIG_DUMMY == 1
390int dummy_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000391void *dummy_map(const char *descr, unsigned long phys_addr, size_t len);
392void dummy_unmap(void *virt_addr, size_t len);
393void dummy_chip_writeb(uint8_t val, chipaddr addr);
394void dummy_chip_writew(uint16_t val, chipaddr addr);
395void dummy_chip_writel(uint32_t val, chipaddr addr);
396void dummy_chip_writen(uint8_t *buf, chipaddr addr, size_t len);
397uint8_t dummy_chip_readb(const chipaddr addr);
398uint16_t dummy_chip_readw(const chipaddr addr);
399uint32_t dummy_chip_readl(const chipaddr addr);
400void dummy_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000401#endif
402
403/* nic3com.c */
404#if CONFIG_NIC3COM == 1
405int nic3com_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000406void nic3com_chip_writeb(uint8_t val, chipaddr addr);
407uint8_t nic3com_chip_readb(const chipaddr addr);
408extern const struct pcidev_status nics_3com[];
409#endif
410
411/* gfxnvidia.c */
412#if CONFIG_GFXNVIDIA == 1
413int gfxnvidia_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000414void gfxnvidia_chip_writeb(uint8_t val, chipaddr addr);
415uint8_t gfxnvidia_chip_readb(const chipaddr addr);
416extern const struct pcidev_status gfx_nvidia[];
417#endif
418
419/* drkaiser.c */
420#if CONFIG_DRKAISER == 1
421int drkaiser_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000422void drkaiser_chip_writeb(uint8_t val, chipaddr addr);
423uint8_t drkaiser_chip_readb(const chipaddr addr);
424extern const struct pcidev_status drkaiser_pcidev[];
425#endif
426
427/* nicrealtek.c */
428#if CONFIG_NICREALTEK == 1
429int nicrealtek_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000430void nicrealtek_chip_writeb(uint8_t val, chipaddr addr);
431uint8_t nicrealtek_chip_readb(const chipaddr addr);
432extern const struct pcidev_status nics_realtek[];
hailfinger428f6852010-07-27 22:41:39 +0000433#endif
434
435/* nicnatsemi.c */
436#if CONFIG_NICNATSEMI == 1
437int nicnatsemi_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000438void nicnatsemi_chip_writeb(uint8_t val, chipaddr addr);
439uint8_t nicnatsemi_chip_readb(const chipaddr addr);
440extern const struct pcidev_status nics_natsemi[];
441#endif
442
hailfinger7949b652011-05-08 00:24:18 +0000443/* nicintel.c */
444#if CONFIG_NICINTEL == 1
445int nicintel_init(void);
hailfinger7949b652011-05-08 00:24:18 +0000446void nicintel_chip_writeb(uint8_t val, chipaddr addr);
447uint8_t nicintel_chip_readb(const chipaddr addr);
448extern const struct pcidev_status nics_intel[];
449#endif
450
uwe6764e922010-09-03 18:21:21 +0000451/* nicintel_spi.c */
452#if CONFIG_NICINTEL_SPI == 1
453int nicintel_spi_init(void);
uwe6764e922010-09-03 18:21:21 +0000454extern const struct pcidev_status nics_intel_spi[];
455#endif
456
hailfingerfb1f31f2010-12-03 14:48:11 +0000457/* ogp_spi.c */
458#if CONFIG_OGP_SPI == 1
459int ogp_spi_init(void);
hailfingerfb1f31f2010-12-03 14:48:11 +0000460extern const struct pcidev_status ogp_spi[];
461#endif
462
hailfinger935365d2011-02-04 21:37:59 +0000463/* satamv.c */
464#if CONFIG_SATAMV == 1
465int satamv_init(void);
hailfinger935365d2011-02-04 21:37:59 +0000466void satamv_chip_writeb(uint8_t val, chipaddr addr);
467uint8_t satamv_chip_readb(const chipaddr addr);
468extern const struct pcidev_status satas_mv[];
469#endif
470
hailfinger428f6852010-07-27 22:41:39 +0000471/* satasii.c */
472#if CONFIG_SATASII == 1
473int satasii_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000474void satasii_chip_writeb(uint8_t val, chipaddr addr);
475uint8_t satasii_chip_readb(const chipaddr addr);
476extern const struct pcidev_status satas_sii[];
477#endif
478
479/* atahpt.c */
480#if CONFIG_ATAHPT == 1
481int atahpt_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000482void atahpt_chip_writeb(uint8_t val, chipaddr addr);
483uint8_t atahpt_chip_readb(const chipaddr addr);
484extern const struct pcidev_status ata_hpt[];
485#endif
486
487/* ft2232_spi.c */
hailfinger888410e2010-07-29 15:54:53 +0000488#if CONFIG_FT2232_SPI == 1
489struct usbdev_status {
uwee15beb92010-08-08 17:01:18 +0000490 uint16_t vendor_id;
491 uint16_t device_id;
492 int status;
493 const char *vendor_name;
494 const char *device_name;
hailfinger888410e2010-07-29 15:54:53 +0000495};
hailfinger428f6852010-07-27 22:41:39 +0000496int ft2232_spi_init(void);
hailfinger888410e2010-07-29 15:54:53 +0000497extern const struct usbdev_status devs_ft2232spi[];
498void print_supported_usbdevs(const struct usbdev_status *devs);
499#endif
hailfinger428f6852010-07-27 22:41:39 +0000500
501/* rayer_spi.c */
502#if CONFIG_RAYER_SPI == 1
503int rayer_spi_init(void);
504#endif
505
506/* bitbang_spi.c */
507int bitbang_spi_init(const struct bitbang_spi_master *master, int halfperiod);
hailfinger12cba9a2010-09-15 00:17:37 +0000508int bitbang_spi_shutdown(const struct bitbang_spi_master *master);
hailfinger428f6852010-07-27 22:41:39 +0000509
510/* buspirate_spi.c */
hailfingere20dc562011-06-09 20:06:34 +0000511#if CONFIG_BUSPIRATE_SPI == 1
hailfinger428f6852010-07-27 22:41:39 +0000512int buspirate_spi_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000513#endif
hailfinger428f6852010-07-27 22:41:39 +0000514
Anton Staafb2647882014-09-17 15:13:43 -0700515/* raiden_debug_spi.c */
516#if CONFIG_RAIDEN_DEBUG_SPI == 1
517int raiden_debug_spi_init(void);
518#endif
519
David Hendricks7e449602013-05-17 19:21:36 -0700520/* linux_i2c.c */
521#if CONFIG_LINUX_I2C == 1
522int linux_i2c_shutdown(void *data);
523int linux_i2c_init(void);
524int linux_i2c_open(int bus, int addr, int force);
525void linux_i2c_close(void);
526int linux_i2c_xfer(int bus, int addr, const void *inbuf,
527 int insize, const void *outbuf, int outsize);
528#endif
529
uwe7df6dda2011-09-03 18:37:52 +0000530/* linux_spi.c */
531#if CONFIG_LINUX_SPI == 1
532int linux_spi_init(void);
533#endif
534
hailfinger428f6852010-07-27 22:41:39 +0000535/* dediprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000536#if CONFIG_DEDIPROG == 1
hailfinger428f6852010-07-27 22:41:39 +0000537int dediprog_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000538#endif
hailfinger428f6852010-07-27 22:41:39 +0000539
540/* flashrom.c */
541struct decode_sizes {
542 uint32_t parallel;
543 uint32_t lpc;
544 uint32_t fwh;
545 uint32_t spi;
546};
547extern struct decode_sizes max_rom_decode;
548extern int programmer_may_write;
549extern unsigned long flashbase;
hailfinger48ed3e22011-05-04 00:39:50 +0000550void check_chip_supported(const struct flashchip *flash);
hailfinger428f6852010-07-27 22:41:39 +0000551int check_max_decode(enum chipbustype buses, uint32_t size);
stefanct52700282011-06-26 17:38:17 +0000552char *extract_programmer_param(const char *param_name);
hailfinger428f6852010-07-27 22:41:39 +0000553
554/* layout.c */
555int show_id(uint8_t *bios, int size, int force);
556
557/* spi.c */
558enum spi_controller {
559 SPI_CONTROLLER_NONE,
560#if CONFIG_INTERNAL == 1
561#if defined(__i386__) || defined(__x86_64__)
562 SPI_CONTROLLER_ICH7,
563 SPI_CONTROLLER_ICH9,
David Hendricks07af3a42011-07-11 22:13:02 -0700564 SPI_CONTROLLER_ICH_HWSEQ,
hailfinger2b46a862011-02-28 23:58:15 +0000565 SPI_CONTROLLER_IT85XX,
hailfinger428f6852010-07-27 22:41:39 +0000566 SPI_CONTROLLER_IT87XX,
David Hendricks46d32e32011-01-19 16:01:52 -0800567 SPI_CONTROLLER_MEC1308,
hailfinger428f6852010-07-27 22:41:39 +0000568 SPI_CONTROLLER_SB600,
569 SPI_CONTROLLER_VIA,
570 SPI_CONTROLLER_WBSIO,
David Hendricksc801adb2010-12-09 16:58:56 -0800571 SPI_CONTROLLER_WPCE775X,
Rong Changaaa1acf2012-06-21 19:21:18 +0800572 SPI_CONTROLLER_ENE,
David Hendricks82fd8ae2010-08-04 14:34:54 -0700573#endif
Louis Yung-Chieh Lobc351d02011-03-31 13:09:21 +0800574#if defined(__arm__)
575 SPI_CONTROLLER_TEGRA2,
hailfinger428f6852010-07-27 22:41:39 +0000576#endif
577#endif
578#if CONFIG_FT2232_SPI == 1
579 SPI_CONTROLLER_FT2232,
580#endif
581#if CONFIG_DUMMY == 1
582 SPI_CONTROLLER_DUMMY,
583#endif
584#if CONFIG_BUSPIRATE_SPI == 1
585 SPI_CONTROLLER_BUSPIRATE,
586#endif
Anton Staafb2647882014-09-17 15:13:43 -0700587#if CONFIG_RAIDEN_DEBUG_SPI == 1
588 SPI_CONTROLLER_RAIDEN_DEBUG,
589#endif
hailfinger428f6852010-07-27 22:41:39 +0000590#if CONFIG_DEDIPROG == 1
591 SPI_CONTROLLER_DEDIPROG,
592#endif
David Hendricks91040832011-07-08 20:01:09 -0700593#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 +0000594 SPI_CONTROLLER_BITBANG,
hailfinger428f6852010-07-27 22:41:39 +0000595#endif
uwe7df6dda2011-09-03 18:37:52 +0000596#if CONFIG_LINUX_SPI == 1
597 SPI_CONTROLLER_LINUX,
598#endif
stefanct69965b62011-09-15 23:38:14 +0000599#if CONFIG_SERPROG == 1
600 SPI_CONTROLLER_SERPROG,
601#endif
hailfinger428f6852010-07-27 22:41:39 +0000602};
603extern const int spi_programmer_count;
mkarcher8fb57592011-05-11 17:07:02 +0000604
605#define MAX_DATA_UNSPECIFIED 0
606#define MAX_DATA_READ_UNLIMITED 64 * 1024
607#define MAX_DATA_WRITE_UNLIMITED 256
hailfinger428f6852010-07-27 22:41:39 +0000608struct spi_programmer {
mkarcherd264e9e2011-05-11 17:07:07 +0000609 enum spi_controller type;
stefanctc5eb8a92011-11-23 09:13:48 +0000610 unsigned int max_data_read;
611 unsigned int max_data_write;
hailfinger428f6852010-07-27 22:41:39 +0000612 int (*command)(unsigned int writecnt, unsigned int readcnt,
613 const unsigned char *writearr, unsigned char *readarr);
614 int (*multicommand)(struct spi_command *cmds);
615
616 /* Optimized functions for this programmer */
stefanctc5eb8a92011-11-23 09:13:48 +0000617 int (*read)(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
618 int (*write_256)(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
hailfinger428f6852010-07-27 22:41:39 +0000619};
620
mkarcherd264e9e2011-05-11 17:07:07 +0000621extern const struct spi_programmer *spi_programmer;
hailfinger428f6852010-07-27 22:41:39 +0000622int default_spi_send_command(unsigned int writecnt, unsigned int readcnt,
623 const unsigned char *writearr, unsigned char *readarr);
624int default_spi_send_multicommand(struct spi_command *cmds);
stefanctc5eb8a92011-11-23 09:13:48 +0000625int default_spi_read(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
626int default_spi_write_256(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
mkarcherd264e9e2011-05-11 17:07:07 +0000627void register_spi_programmer(const struct spi_programmer *programmer);
hailfinger428f6852010-07-27 22:41:39 +0000628
629/* ichspi.c */
630#if CONFIG_INTERNAL == 1
stefanctc035c192011-11-06 23:51:09 +0000631enum ich_chipset {
632 CHIPSET_ICH_UNKNOWN,
633 CHIPSET_ICH7 = 7,
634 CHIPSET_ICH8,
635 CHIPSET_ICH9,
636 CHIPSET_ICH10,
637 CHIPSET_5_SERIES_IBEX_PEAK,
638 CHIPSET_6_SERIES_COUGAR_POINT,
Duncan Laurie32e60552013-02-28 09:42:07 -0800639 CHIPSET_7_SERIES_PANTHER_POINT,
640 CHIPSET_8_SERIES_LYNX_POINT,
641 CHIPSET_8_SERIES_LYNX_POINT_LP,
Duncan Laurie9bd2af82014-05-12 10:17:38 -0700642 CHIPSET_9_SERIES_WILDCAT_POINT,
Ramya Vijaykumara9a64f92015-04-15 15:26:22 +0530643 CHIPSET_100_SERIES_SUNRISE_POINT,
Duncan Lauried59ec692013-11-25 09:40:56 -0800644 CHIPSET_BAYTRAIL,
stefanctc035c192011-11-06 23:51:09 +0000645};
646
hailfinger428f6852010-07-27 22:41:39 +0000647extern uint32_t ichspi_bbar;
648int ich_init_spi(struct pci_dev *dev, uint32_t base, void *rcrb,
stefanctc035c192011-11-06 23:51:09 +0000649 enum ich_chipset ich_generation);
hailfinger428f6852010-07-27 22:41:39 +0000650int via_init_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000651
Rong Changaaa1acf2012-06-21 19:21:18 +0800652/* ene_lpc.c */
653int ene_probe_spi_flash(const char *name);
654
hailfinger2b46a862011-02-28 23:58:15 +0000655/* it85spi.c */
hailfinger94e090c2011-04-27 14:34:08 +0000656int it85xx_spi_init(struct superio s);
Shawn Nematbakhsh3404b1a2012-07-26 15:19:58 -0700657int it8518_spi_init(struct superio s);
hailfinger2b46a862011-02-28 23:58:15 +0000658
hailfinger428f6852010-07-27 22:41:39 +0000659/* it87spi.c */
660void enter_conf_mode_ite(uint16_t port);
661void exit_conf_mode_ite(uint16_t port);
hailfinger94e090c2011-04-27 14:34:08 +0000662void probe_superio_ite(void);
hailfinger428f6852010-07-27 22:41:39 +0000663int init_superio_ite(void);
hailfinger428f6852010-07-27 22:41:39 +0000664
hailfingere20dc562011-06-09 20:06:34 +0000665/* mcp6x_spi.c */
666int mcp6x_spi_init(int want_spi);
667
David Hendricks46d32e32011-01-19 16:01:52 -0800668/* mec1308.c */
David Hendricks46d32e32011-01-19 16:01:52 -0800669int mec1308_probe_spi_flash(const char *name);
David Hendricks46d32e32011-01-19 16:01:52 -0800670
hailfinger428f6852010-07-27 22:41:39 +0000671/* sb600spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000672int sb600_probe_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000673
674/* wbsio_spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000675int wbsio_check_for_spi(void);
hailfinger428f6852010-07-27 22:41:39 +0000676#endif
677
hailfingerfe7cd9e2011-11-04 21:35:26 +0000678/* opaque.c */
679struct opaque_programmer {
680 int max_data_read;
681 int max_data_write;
682 /* Specific functions for this programmer */
683 int (*probe) (struct flashchip *flash);
stefanctc5eb8a92011-11-23 09:13:48 +0000684 int (*read) (struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
685 int (*write) (struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000686 int (*erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
David Hendricks5d481e12012-05-24 14:14:14 -0700687 const void *data;
hailfingerfe7cd9e2011-11-04 21:35:26 +0000688};
David Hendricks292edf02013-07-11 16:12:58 -0700689extern struct opaque_programmer *opaque_programmer;
690void register_opaque_programmer(struct opaque_programmer *pgm);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000691
hailfinger428f6852010-07-27 22:41:39 +0000692/* serprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000693#if CONFIG_SERPROG == 1
hailfinger428f6852010-07-27 22:41:39 +0000694int serprog_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000695void serprog_chip_writeb(uint8_t val, chipaddr addr);
696uint8_t serprog_chip_readb(const chipaddr addr);
697void serprog_chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
stefanctd9ac2212011-10-22 21:45:27 +0000698void serprog_delay(int usecs);
hailfingere20dc562011-06-09 20:06:34 +0000699#endif
hailfinger428f6852010-07-27 22:41:39 +0000700
701/* serial.c */
702#if _WIN32
703typedef HANDLE fdtype;
704#else
705typedef int fdtype;
706#endif
707
David Hendricksc801adb2010-12-09 16:58:56 -0800708/* wpce775x.c */
David Hendricksc801adb2010-12-09 16:58:56 -0800709int wpce775x_probe_spi_flash(const char *name);
David Hendricksc801adb2010-12-09 16:58:56 -0800710
David Hendricksb907de32014-08-11 16:47:09 -0700711/* cros_ec.c */
712int cros_ec_probe_i2c(const char *name);
Simon Glasscd597032013-05-23 17:18:44 -0700713
714/**
715 * Probe the Google Chrome OS EC device
716 *
717 * @return 0 if found correct, non-zero if not found or error
718 */
David Hendricksb907de32014-08-11 16:47:09 -0700719int cros_ec_probe_dev(void);
Simon Glasscd597032013-05-23 17:18:44 -0700720
David Hendricksb907de32014-08-11 16:47:09 -0700721int cros_ec_probe_lpc(const char *name);
722int cros_ec_need_2nd_pass(void);
723int cros_ec_finish(void);
724int cros_ec_prepare(uint8_t *image, int size);
Louis Yung-Chieh Loedb0cba2011-12-09 17:06:54 +0800725
hailfinger428f6852010-07-27 22:41:39 +0000726void sp_flush_incoming(void);
727fdtype sp_openserport(char *dev, unsigned int baud);
728void __attribute__((noreturn)) sp_die(char *msg);
729extern fdtype sp_fd;
dhendrix0ffc2eb2011-06-14 01:35:36 +0000730/* expose serialport_shutdown as it's currently used by buspirate */
731int serialport_shutdown(void *data);
hailfinger428f6852010-07-27 22:41:39 +0000732int serialport_write(unsigned char *buf, unsigned int writecnt);
733int serialport_read(unsigned char *buf, unsigned int readcnt);
734
735#endif /* !__PROGRAMMER_H__ */