blob: 501fd04611c6d5ccda8b013a2efcfdba205f916a [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.
hailfinger428f6852010-07-27 22:41:39 +000018 */
19
20#ifndef __PROGRAMMER_H__
21#define __PROGRAMMER_H__ 1
22
Edward O'Callaghana6673bd2019-06-24 15:22:28 +100023#include <stdint.h>
24
Souvik Ghoshd75cd672016-06-17 14:21:39 -070025#include "flash.h" /* for chipaddr and flashctx */
hailfingerfe7cd9e2011-11-04 21:35:26 +000026
hailfinger428f6852010-07-27 22:41:39 +000027enum programmer {
28#if CONFIG_INTERNAL == 1
29 PROGRAMMER_INTERNAL,
30#endif
31#if CONFIG_DUMMY == 1
32 PROGRAMMER_DUMMY,
33#endif
34#if CONFIG_NIC3COM == 1
35 PROGRAMMER_NIC3COM,
36#endif
37#if CONFIG_NICREALTEK == 1
38 PROGRAMMER_NICREALTEK,
uwe6764e922010-09-03 18:21:21 +000039#endif
hailfinger428f6852010-07-27 22:41:39 +000040#if CONFIG_NICNATSEMI == 1
41 PROGRAMMER_NICNATSEMI,
uwe6764e922010-09-03 18:21:21 +000042#endif
hailfinger428f6852010-07-27 22:41:39 +000043#if CONFIG_GFXNVIDIA == 1
44 PROGRAMMER_GFXNVIDIA,
45#endif
46#if CONFIG_DRKAISER == 1
47 PROGRAMMER_DRKAISER,
48#endif
49#if CONFIG_SATASII == 1
50 PROGRAMMER_SATASII,
51#endif
52#if CONFIG_ATAHPT == 1
53 PROGRAMMER_ATAHPT,
54#endif
hailfinger428f6852010-07-27 22:41:39 +000055#if CONFIG_FT2232_SPI == 1
56 PROGRAMMER_FT2232_SPI,
57#endif
58#if CONFIG_SERPROG == 1
59 PROGRAMMER_SERPROG,
60#endif
61#if CONFIG_BUSPIRATE_SPI == 1
62 PROGRAMMER_BUSPIRATE_SPI,
63#endif
Anton Staafb2647882014-09-17 15:13:43 -070064#if CONFIG_RAIDEN_DEBUG_SPI == 1
65 PROGRAMMER_RAIDEN_DEBUG_SPI,
66#endif
hailfinger428f6852010-07-27 22:41:39 +000067#if CONFIG_DEDIPROG == 1
68 PROGRAMMER_DEDIPROG,
69#endif
70#if CONFIG_RAYER_SPI == 1
71 PROGRAMMER_RAYER_SPI,
72#endif
hailfinger7949b652011-05-08 00:24:18 +000073#if CONFIG_NICINTEL == 1
74 PROGRAMMER_NICINTEL,
75#endif
uwe6764e922010-09-03 18:21:21 +000076#if CONFIG_NICINTEL_SPI == 1
77 PROGRAMMER_NICINTEL_SPI,
78#endif
hailfingerfb1f31f2010-12-03 14:48:11 +000079#if CONFIG_OGP_SPI == 1
80 PROGRAMMER_OGP_SPI,
81#endif
hailfinger935365d2011-02-04 21:37:59 +000082#if CONFIG_SATAMV == 1
83 PROGRAMMER_SATAMV,
84#endif
David Hendrickscebee892015-05-23 20:30:30 -070085#if CONFIG_LINUX_MTD == 1
86 PROGRAMMER_LINUX_MTD,
87#endif
uwe7df6dda2011-09-03 18:37:52 +000088#if CONFIG_LINUX_SPI == 1
89 PROGRAMMER_LINUX_SPI,
90#endif
hailfinger428f6852010-07-27 22:41:39 +000091 PROGRAMMER_INVALID /* This must always be the last entry. */
92};
93
David Hendricksba0827a2013-05-03 20:25:40 -070094enum alias_type {
95 ALIAS_NONE = 0, /* no alias (default) */
96 ALIAS_EC, /* embedded controller */
97 ALIAS_HOST, /* chipset / PCH / SoC / etc. */
98};
99
100struct programmer_alias {
101 const char *name;
102 enum alias_type type;
103};
104
105extern struct programmer_alias *alias;
106extern struct programmer_alias aliases[];
107
Vadim Bendebury066143d2018-07-16 18:20:33 -0700108/*
109 * This function returns 'true' if current flashrom invocation is programming
110 * the EC.
111 */
112static inline int programming_ec(void) {
113 return alias && (alias->type == ALIAS_EC);
114}
115
hailfinger428f6852010-07-27 22:41:39 +0000116struct programmer_entry {
117 const char *vendor;
118 const char *name;
119
David Hendricksac1d25c2016-08-09 17:00:58 -0700120 int (*init) (void);
hailfinger428f6852010-07-27 22:41:39 +0000121
Patrick Georgi4befc162017-02-03 18:32:01 +0100122 void *(*map_flash_region) (const char *descr, uintptr_t phys_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000123 void (*unmap_flash_region) (void *virt_addr, size_t len);
124
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000125 void (*delay) (unsigned int usecs);
David Hendricks55cdd9c2015-11-25 14:37:26 -0800126
127 /*
128 * If set, use extra precautions such as erasing with small block sizes
129 * and verifying more rigorously. This will incur a performance penalty
130 * but is good for programming the ROM in-system on a live machine.
131 */
132 int paranoid;
hailfinger428f6852010-07-27 22:41:39 +0000133};
134
135extern const struct programmer_entry programmer_table[];
136
David Hendricksac1d25c2016-08-09 17:00:58 -0700137int programmer_init(enum programmer prog, char *param);
David Hendricks93784b42016-08-09 17:00:38 -0700138int programmer_shutdown(void);
hailfinger428f6852010-07-27 22:41:39 +0000139
hailfinger428f6852010-07-27 22:41:39 +0000140struct bitbang_spi_master {
hailfinger428f6852010-07-27 22:41:39 +0000141 /* Note that CS# is active low, so val=0 means the chip is active. */
142 void (*set_cs) (int val);
143 void (*set_sck) (int val);
144 void (*set_mosi) (int val);
145 int (*get_miso) (void);
hailfinger12cba9a2010-09-15 00:17:37 +0000146 void (*request_bus) (void);
147 void (*release_bus) (void);
Patrick Georgie081d5d2017-03-22 21:18:18 +0100148
149 /* Length of half a clock period in usecs. */
150 unsigned int half_period;
hailfinger428f6852010-07-27 22:41:39 +0000151};
152
153#if CONFIG_INTERNAL == 1
Mayur Panchalf4796862019-08-05 15:46:12 +1000154struct pci_dev;
hailfinger428f6852010-07-27 22:41:39 +0000155struct penable {
156 uint16_t vendor_id;
157 uint16_t device_id;
stefanct6d836ba2011-05-26 01:35:19 +0000158 int status; /* OK=0 and NT=1 are defines only. Beware! */
hailfinger428f6852010-07-27 22:41:39 +0000159 const char *vendor_name;
160 const char *device_name;
161 int (*doit) (struct pci_dev *dev, const char *name);
162};
163
164extern const struct penable chipset_enables[];
165
hailfingere52e9f82011-05-05 07:12:40 +0000166enum board_match_phase {
167 P1,
168 P2,
169 P3
170};
171
hailfinger4640bdb2011-08-31 16:19:50 +0000172struct board_match {
hailfinger428f6852010-07-27 22:41:39 +0000173 /* Any device, but make it sensible, like the ISA bridge. */
174 uint16_t first_vendor;
175 uint16_t first_device;
176 uint16_t first_card_vendor;
177 uint16_t first_card_device;
178
179 /* Any device, but make it sensible, like
180 * the host bridge. May be NULL.
181 */
182 uint16_t second_vendor;
183 uint16_t second_device;
184 uint16_t second_card_vendor;
185 uint16_t second_card_device;
186
stefanct6d836ba2011-05-26 01:35:19 +0000187 /* Pattern to match DMI entries. May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000188 const char *dmi_pattern;
189
stefanct6d836ba2011-05-26 01:35:19 +0000190 /* The vendor / part name from the coreboot table. May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000191 const char *lb_vendor;
192 const char *lb_part;
193
hailfingere52e9f82011-05-05 07:12:40 +0000194 enum board_match_phase phase;
195
hailfinger428f6852010-07-27 22:41:39 +0000196 const char *vendor_name;
197 const char *board_name;
198
199 int max_rom_decode_parallel;
200 int status;
stefanct6d836ba2011-05-26 01:35:19 +0000201 int (*enable) (void); /* May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000202};
203
hailfinger4640bdb2011-08-31 16:19:50 +0000204extern const struct board_match board_matches[];
hailfinger428f6852010-07-27 22:41:39 +0000205
206struct board_info {
207 const char *vendor;
208 const char *name;
209 const int working;
210#ifdef CONFIG_PRINT_WIKI
211 const char *url;
212 const char *note;
213#endif
214};
215
216extern const struct board_info boards_known[];
217extern const struct board_info laptops_known[];
218#endif
219
220/* udelay.c */
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000221void myusec_delay(unsigned int usecs);
hailfinger428f6852010-07-27 22:41:39 +0000222void myusec_calibrate_delay(void);
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000223void internal_delay(unsigned int usecs);
hailfinger428f6852010-07-27 22:41:39 +0000224
225#if NEED_PCI == 1
226/* pcidev.c */
hailfinger428f6852010-07-27 22:41:39 +0000227extern struct pci_access *pacc;
Patrick Georgi8ae16572017-03-09 15:59:25 +0100228struct dev_entry {
hailfinger428f6852010-07-27 22:41:39 +0000229 uint16_t vendor_id;
230 uint16_t device_id;
231 int status;
232 const char *vendor_name;
233 const char *device_name;
234};
Edward O'Callaghan80aedd02019-08-02 22:36:56 +1000235int pci_init_common(void);
Patrick Georgif776a442017-03-28 21:34:33 +0200236uintptr_t pcidev_readbar(struct pci_dev *dev, int bar);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100237uintptr_t pcidev_validate(struct pci_dev *dev, int bar, const struct dev_entry *devs);
Patrick Georgi7c30fa92017-03-28 22:47:12 +0200238struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar);
hailfingerf31cbdc2010-11-10 15:25:18 +0000239/* rpci_write_* are reversible writes. The original PCI config space register
240 * contents will be restored on shutdown.
241 */
mkarcher08a24552010-12-26 23:55:19 +0000242int rpci_write_byte(struct pci_dev *dev, int reg, uint8_t data);
243int rpci_write_word(struct pci_dev *dev, int reg, uint16_t data);
244int rpci_write_long(struct pci_dev *dev, int reg, uint32_t data);
hailfinger428f6852010-07-27 22:41:39 +0000245#endif
246
247/* print.c */
hailfinger7949b652011-05-08 00:24:18 +0000248#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
Patrick Georgi8ae16572017-03-09 15:59:25 +0100249void print_supported_pcidevs(const struct dev_entry *devs);
hailfinger428f6852010-07-27 22:41:39 +0000250#endif
251
hailfingere20dc562011-06-09 20:06:34 +0000252#if CONFIG_INTERNAL == 1
hailfinger428f6852010-07-27 22:41:39 +0000253/* board_enable.c */
254void w836xx_ext_enter(uint16_t port);
255void w836xx_ext_leave(uint16_t port);
256int it8705f_write_enable(uint8_t port);
257uint8_t sio_read(uint16_t port, uint8_t reg);
258void sio_write(uint16_t port, uint8_t reg, uint8_t data);
259void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
hailfingere52e9f82011-05-05 07:12:40 +0000260void board_handle_before_superio(void);
261void board_handle_before_laptop(void);
hailfinger428f6852010-07-27 22:41:39 +0000262int board_flash_enable(const char *vendor, const char *part);
263
264/* chipset_enable.c */
265int chipset_flash_enable(void);
Louis Yung-Chieh Lo6b8f0462011-01-06 12:49:46 +0800266int get_target_bus_from_chipset(enum chipbustype *target_bus);
hailfinger428f6852010-07-27 22:41:39 +0000267
268/* processor_enable.c */
269int processor_flash_enable(void);
hailfingere52e9f82011-05-05 07:12:40 +0000270#endif
hailfinger428f6852010-07-27 22:41:39 +0000271
272/* physmap.c */
Patrick Georgi4befc162017-02-03 18:32:01 +0100273void *physmap(const char *descr, uintptr_t phys_addr, size_t len);
Patrick Georgi220f4b52017-03-21 16:55:04 +0100274void *rphysmap(const char *descr, uintptr_t phys_addr, size_t len);
Edward O'Callaghan64a4db22019-05-30 03:13:07 -0400275void *physmap_ro(const char *descr, uintptr_t phys_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000276void physunmap(void *virt_addr, size_t len);
Edward O'Callaghanb2878982019-05-30 03:44:32 -0400277void physunmap_unaligned(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 */
Edward O'Callaghan481cce82019-05-31 15:03:50 +1000283int cb_parse_table(const char **vendor, const char **model);
Carl-Daniel Hailfingere5ec66e2016-08-03 16:10:19 -0700284void lb_vendor_dev_from_string(const char *boardstring);
hailfinger428f6852010-07-27 22:41:39 +0000285extern 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
Mayur Panchalf4796862019-08-05 15:46:12 +1000304struct pci_filter;
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
Patrick Georgi2a2d67f2017-03-09 10:15:39 +0100311int rget_io_perms(void);
hailfinger428f6852010-07-27 22:41:39 +0000312#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;
David Hendricksac1d25c2016-08-09 17:00:58 -0700320int internal_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000321#endif
322
323/* hwaccess.c */
324void mmio_writeb(uint8_t val, void *addr);
325void mmio_writew(uint16_t val, void *addr);
326void mmio_writel(uint32_t val, void *addr);
Edward O'Callaghan46b1e492019-06-02 16:04:48 +1000327uint8_t mmio_readb(const void *addr);
328uint16_t mmio_readw(const void *addr);
329uint32_t mmio_readl(const void *addr);
330void mmio_readn(const void *addr, uint8_t *buf, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000331void mmio_le_writeb(uint8_t val, void *addr);
332void mmio_le_writew(uint16_t val, void *addr);
333void mmio_le_writel(uint32_t val, void *addr);
Edward O'Callaghan46b1e492019-06-02 16:04:48 +1000334uint8_t mmio_le_readb(const void *addr);
335uint16_t mmio_le_readw(const void *addr);
336uint32_t mmio_le_readl(const void *addr);
hailfinger428f6852010-07-27 22:41:39 +0000337#define pci_mmio_writeb mmio_le_writeb
338#define pci_mmio_writew mmio_le_writew
339#define pci_mmio_writel mmio_le_writel
340#define pci_mmio_readb mmio_le_readb
341#define pci_mmio_readw mmio_le_readw
342#define pci_mmio_readl mmio_le_readl
hailfinger1e2e3442011-05-03 21:49:41 +0000343void rmmio_writeb(uint8_t val, void *addr);
344void rmmio_writew(uint16_t val, void *addr);
345void rmmio_writel(uint32_t val, void *addr);
346void rmmio_le_writeb(uint8_t val, void *addr);
347void rmmio_le_writew(uint16_t val, void *addr);
348void rmmio_le_writel(uint32_t val, void *addr);
349#define pci_rmmio_writeb rmmio_le_writeb
350#define pci_rmmio_writew rmmio_le_writew
351#define pci_rmmio_writel rmmio_le_writel
352void rmmio_valb(void *addr);
353void rmmio_valw(void *addr);
354void rmmio_vall(void *addr);
hailfinger428f6852010-07-27 22:41:39 +0000355
hailfinger428f6852010-07-27 22:41:39 +0000356/* dummyflasher.c */
357#if CONFIG_DUMMY == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700358int dummy_init(void);
Patrick Georgi4befc162017-02-03 18:32:01 +0100359void *dummy_map(const char *descr, uintptr_t phys_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000360void dummy_unmap(void *virt_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000361#endif
362
363/* nic3com.c */
364#if CONFIG_NIC3COM == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700365int nic3com_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100366extern const struct dev_entry nics_3com[];
hailfinger428f6852010-07-27 22:41:39 +0000367#endif
368
369/* gfxnvidia.c */
370#if CONFIG_GFXNVIDIA == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700371int gfxnvidia_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100372extern const struct dev_entry gfx_nvidia[];
hailfinger428f6852010-07-27 22:41:39 +0000373#endif
374
375/* drkaiser.c */
376#if CONFIG_DRKAISER == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700377int drkaiser_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100378extern const struct dev_entry drkaiser_pcidev[];
hailfinger428f6852010-07-27 22:41:39 +0000379#endif
380
381/* nicrealtek.c */
382#if CONFIG_NICREALTEK == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700383int nicrealtek_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100384extern const struct dev_entry nics_realtek[];
hailfinger428f6852010-07-27 22:41:39 +0000385#endif
386
387/* nicnatsemi.c */
388#if CONFIG_NICNATSEMI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700389int nicnatsemi_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100390extern const struct dev_entry nics_natsemi[];
hailfinger428f6852010-07-27 22:41:39 +0000391#endif
392
hailfinger7949b652011-05-08 00:24:18 +0000393/* nicintel.c */
394#if CONFIG_NICINTEL == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700395int nicintel_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100396extern const struct dev_entry nics_intel[];
hailfinger7949b652011-05-08 00:24:18 +0000397#endif
398
uwe6764e922010-09-03 18:21:21 +0000399/* nicintel_spi.c */
400#if CONFIG_NICINTEL_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700401int nicintel_spi_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100402extern const struct dev_entry nics_intel_spi[];
uwe6764e922010-09-03 18:21:21 +0000403#endif
404
hailfingerfb1f31f2010-12-03 14:48:11 +0000405/* ogp_spi.c */
406#if CONFIG_OGP_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700407int ogp_spi_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100408extern const struct dev_entry ogp_spi[];
hailfingerfb1f31f2010-12-03 14:48:11 +0000409#endif
410
hailfinger935365d2011-02-04 21:37:59 +0000411/* satamv.c */
412#if CONFIG_SATAMV == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700413int satamv_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100414extern const struct dev_entry satas_mv[];
hailfinger935365d2011-02-04 21:37:59 +0000415#endif
416
hailfinger428f6852010-07-27 22:41:39 +0000417/* satasii.c */
418#if CONFIG_SATASII == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700419int satasii_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100420extern const struct dev_entry satas_sii[];
hailfinger428f6852010-07-27 22:41:39 +0000421#endif
422
423/* atahpt.c */
424#if CONFIG_ATAHPT == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700425int atahpt_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100426extern const struct dev_entry ata_hpt[];
hailfinger428f6852010-07-27 22:41:39 +0000427#endif
428
429/* ft2232_spi.c */
hailfinger888410e2010-07-29 15:54:53 +0000430#if CONFIG_FT2232_SPI == 1
431struct usbdev_status {
uwee15beb92010-08-08 17:01:18 +0000432 uint16_t vendor_id;
433 uint16_t device_id;
434 int status;
435 const char *vendor_name;
436 const char *device_name;
hailfinger888410e2010-07-29 15:54:53 +0000437};
David Hendricksac1d25c2016-08-09 17:00:58 -0700438int ft2232_spi_init(void);
hailfinger888410e2010-07-29 15:54:53 +0000439extern const struct usbdev_status devs_ft2232spi[];
440void print_supported_usbdevs(const struct usbdev_status *devs);
441#endif
hailfinger428f6852010-07-27 22:41:39 +0000442
443/* rayer_spi.c */
444#if CONFIG_RAYER_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700445int rayer_spi_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000446#endif
447
448/* bitbang_spi.c */
Craig Hesling65eb8812019-08-01 09:33:56 -0700449int register_spi_bitbang_master(const struct bitbang_spi_master *master);
David Hendricksac1d25c2016-08-09 17:00:58 -0700450int bitbang_spi_shutdown(const struct bitbang_spi_master *master);
hailfinger428f6852010-07-27 22:41:39 +0000451
452/* buspirate_spi.c */
hailfingere20dc562011-06-09 20:06:34 +0000453#if CONFIG_BUSPIRATE_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700454int buspirate_spi_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000455#endif
hailfinger428f6852010-07-27 22:41:39 +0000456
Anton Staafb2647882014-09-17 15:13:43 -0700457/* raiden_debug_spi.c */
458#if CONFIG_RAIDEN_DEBUG_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700459int raiden_debug_spi_init(void);
Anton Staafb2647882014-09-17 15:13:43 -0700460#endif
461
David Hendricks7e449602013-05-17 19:21:36 -0700462/* linux_i2c.c */
463#if CONFIG_LINUX_I2C == 1
David Hendricks93784b42016-08-09 17:00:38 -0700464int linux_i2c_shutdown(void *data);
David Hendricksac1d25c2016-08-09 17:00:58 -0700465int linux_i2c_init(void);
David Hendricks7e449602013-05-17 19:21:36 -0700466int linux_i2c_open(int bus, int addr, int force);
467void linux_i2c_close(void);
468int linux_i2c_xfer(int bus, int addr, const void *inbuf,
469 int insize, const void *outbuf, int outsize);
470#endif
471
David Hendrickscebee892015-05-23 20:30:30 -0700472/* linux_mtd.c */
473#if CONFIG_LINUX_MTD == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700474int linux_mtd_init(void);
David Hendrickscebee892015-05-23 20:30:30 -0700475#endif
476
uwe7df6dda2011-09-03 18:37:52 +0000477/* linux_spi.c */
478#if CONFIG_LINUX_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700479int linux_spi_init(void);
uwe7df6dda2011-09-03 18:37:52 +0000480#endif
481
hailfinger428f6852010-07-27 22:41:39 +0000482/* dediprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000483#if CONFIG_DEDIPROG == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700484int dediprog_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000485#endif
hailfinger428f6852010-07-27 22:41:39 +0000486
487/* flashrom.c */
488struct decode_sizes {
489 uint32_t parallel;
490 uint32_t lpc;
491 uint32_t fwh;
492 uint32_t spi;
493};
494extern struct decode_sizes max_rom_decode;
495extern int programmer_may_write;
496extern unsigned long flashbase;
hailfinger428f6852010-07-27 22:41:39 +0000497int check_max_decode(enum chipbustype buses, uint32_t size);
stefanct52700282011-06-26 17:38:17 +0000498char *extract_programmer_param(const char *param_name);
hailfinger428f6852010-07-27 22:41:39 +0000499
500/* layout.c */
501int show_id(uint8_t *bios, int size, int force);
502
503/* spi.c */
504enum spi_controller {
505 SPI_CONTROLLER_NONE,
506#if CONFIG_INTERNAL == 1
507#if defined(__i386__) || defined(__x86_64__)
508 SPI_CONTROLLER_ICH7,
509 SPI_CONTROLLER_ICH9,
David Hendricks07af3a42011-07-11 22:13:02 -0700510 SPI_CONTROLLER_ICH_HWSEQ,
hailfinger2b46a862011-02-28 23:58:15 +0000511 SPI_CONTROLLER_IT85XX,
hailfinger428f6852010-07-27 22:41:39 +0000512 SPI_CONTROLLER_IT87XX,
David Hendricks46d32e32011-01-19 16:01:52 -0800513 SPI_CONTROLLER_MEC1308,
hailfinger428f6852010-07-27 22:41:39 +0000514 SPI_CONTROLLER_SB600,
ivy_jian8e0c4e52017-08-23 09:17:56 +0800515 SPI_CONTROLLER_YANGTZE,
hailfinger428f6852010-07-27 22:41:39 +0000516 SPI_CONTROLLER_VIA,
517 SPI_CONTROLLER_WBSIO,
David Hendricksc801adb2010-12-09 16:58:56 -0800518 SPI_CONTROLLER_WPCE775X,
Rong Changaaa1acf2012-06-21 19:21:18 +0800519 SPI_CONTROLLER_ENE,
David Hendricks82fd8ae2010-08-04 14:34:54 -0700520#endif
Louis Yung-Chieh Lobc351d02011-03-31 13:09:21 +0800521#if defined(__arm__)
522 SPI_CONTROLLER_TEGRA2,
hailfinger428f6852010-07-27 22:41:39 +0000523#endif
524#endif
525#if CONFIG_FT2232_SPI == 1
526 SPI_CONTROLLER_FT2232,
527#endif
528#if CONFIG_DUMMY == 1
529 SPI_CONTROLLER_DUMMY,
530#endif
531#if CONFIG_BUSPIRATE_SPI == 1
532 SPI_CONTROLLER_BUSPIRATE,
533#endif
Anton Staafb2647882014-09-17 15:13:43 -0700534#if CONFIG_RAIDEN_DEBUG_SPI == 1
535 SPI_CONTROLLER_RAIDEN_DEBUG,
536#endif
hailfinger428f6852010-07-27 22:41:39 +0000537#if CONFIG_DEDIPROG == 1
538 SPI_CONTROLLER_DEDIPROG,
539#endif
William A. Kennington III852ebf72017-04-05 12:16:06 -0700540#if CONFIG_BITBANG_SPI == 1
mkarcherd264e9e2011-05-11 17:07:07 +0000541 SPI_CONTROLLER_BITBANG,
hailfinger428f6852010-07-27 22:41:39 +0000542#endif
uwe7df6dda2011-09-03 18:37:52 +0000543#if CONFIG_LINUX_SPI == 1
544 SPI_CONTROLLER_LINUX,
545#endif
stefanct69965b62011-09-15 23:38:14 +0000546#if CONFIG_SERPROG == 1
547 SPI_CONTROLLER_SERPROG,
548#endif
hailfinger428f6852010-07-27 22:41:39 +0000549};
Patrick Georgif4f1e2f2017-03-10 17:38:40 +0100550extern const int spi_master_count;
mkarcher8fb57592011-05-11 17:07:02 +0000551
552#define MAX_DATA_UNSPECIFIED 0
553#define MAX_DATA_READ_UNLIMITED 64 * 1024
554#define MAX_DATA_WRITE_UNLIMITED 256
Edward O'Callaghana6673bd2019-06-24 15:22:28 +1000555
556#define SPI_MASTER_4BA (1U << 0) /**< Can handle 4-byte addresses */
557
Patrick Georgif4f1e2f2017-03-10 17:38:40 +0100558struct spi_master {
mkarcherd264e9e2011-05-11 17:07:07 +0000559 enum spi_controller type;
Edward O'Callaghana6673bd2019-06-24 15:22:28 +1000560 uint32_t features;
stefanctc5eb8a92011-11-23 09:13:48 +0000561 unsigned int max_data_read;
562 unsigned int max_data_write;
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700563 int (*command)(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
hailfinger428f6852010-07-27 22:41:39 +0000564 const unsigned char *writearr, unsigned char *readarr);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700565 int (*multicommand)(const struct flashctx *flash, struct spi_command *cmds);
hailfinger428f6852010-07-27 22:41:39 +0000566
Patrick Georgie39d6442017-03-22 21:23:35 +0100567 /* Optimized functions for this master */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700568 int (*read)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100569 int (*write_256)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
hailfinger428f6852010-07-27 22:41:39 +0000570};
571
Craig Hesling65eb8812019-08-01 09:33:56 -0700572extern const struct spi_master *spi_master;
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700573int default_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
hailfinger428f6852010-07-27 22:41:39 +0000574 const unsigned char *writearr, unsigned char *readarr);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700575int default_spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds);
576int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100577int default_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Edward O'Callaghan20ba6152019-08-26 23:21:09 +1000578int register_spi_master(const struct spi_master *programmer);
hailfinger428f6852010-07-27 22:41:39 +0000579
Edward O'Callaghanea053772019-08-13 10:32:30 +1000580/* The following enum is needed by ich_descriptor_tool and ich* code as well as in chipset_enable.c. */
Edward O'Callaghan9ff09132019-09-04 13:48:46 +1000581enum ich_chipset {
stefanctc035c192011-11-06 23:51:09 +0000582 CHIPSET_ICH_UNKNOWN,
Edward O'Callaghan9ff09132019-09-04 13:48:46 +1000583 CHIPSET_ICH,
584 CHIPSET_ICH2345,
Edward O'Callaghanea053772019-08-13 10:32:30 +1000585 CHIPSET_ICH6,
Edward O'Callaghan9ff09132019-09-04 13:48:46 +1000586 CHIPSET_POULSBO, /* SCH U* */
587 CHIPSET_TUNNEL_CREEK, /* Atom E6xx */
Edward O'Callaghanea053772019-08-13 10:32:30 +1000588 CHIPSET_ICH7,
stefanctc035c192011-11-06 23:51:09 +0000589 CHIPSET_ICH8,
590 CHIPSET_ICH9,
591 CHIPSET_ICH10,
592 CHIPSET_5_SERIES_IBEX_PEAK,
593 CHIPSET_6_SERIES_COUGAR_POINT,
Duncan Laurie32e60552013-02-28 09:42:07 -0800594 CHIPSET_7_SERIES_PANTHER_POINT,
595 CHIPSET_8_SERIES_LYNX_POINT,
596 CHIPSET_8_SERIES_LYNX_POINT_LP,
Duncan Laurie9bd2af82014-05-12 10:17:38 -0700597 CHIPSET_9_SERIES_WILDCAT_POINT,
Ramya Vijaykumara9a64f92015-04-15 15:26:22 +0530598 CHIPSET_100_SERIES_SUNRISE_POINT,
Duncan Lauried59ec692013-11-25 09:40:56 -0800599 CHIPSET_BAYTRAIL,
Furquan Shaikh44088752016-07-11 22:48:08 -0700600 CHIPSET_APL,
stefanctc035c192011-11-06 23:51:09 +0000601};
602
Edward O'Callaghanea053772019-08-13 10:32:30 +1000603/* ichspi.c */
Stefan Tauner34f6f5a2016-08-03 11:20:38 -0700604#if CONFIG_INTERNAL == 1
Vadim Bendebury622128c2018-06-21 15:50:28 -0700605
606/*
607 * This global variable is used to communicate the type of ICH found on the
608 * device. When running on non-intel platforms default value of
609 * CHIPSET_ICH_UNKNOWN is used.
610*/
Edward O'Callaghane3e30562019-09-03 13:10:58 +1000611extern enum ich_chipset g_ich_generation;
Vadim Bendebury066143d2018-07-16 18:20:33 -0700612
613/*
614 * This global variable is set to indicate that the invoked flash programming
615 * command should not be executed, but just verified for validity.
616 *
617 * This is useful when one needs to determine if a certain flash erase command
618 * supported by the chip is allowed by the Intel controller on the device.
619 */
620extern int ich_dry_run;
hailfinger428f6852010-07-27 22:41:39 +0000621extern uint32_t ichspi_bbar;
Edward O'Callaghan6f2f8322019-09-06 11:55:24 +1000622int ich_init_spi(struct pci_dev *dev, void *spibar, enum ich_chipset ich_generation);
hailfinger428f6852010-07-27 22:41:39 +0000623int via_init_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000624
Rong Changaaa1acf2012-06-21 19:21:18 +0800625/* ene_lpc.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700626int ene_probe_spi_flash(const char *name);
ivy_jian8e0c4e52017-08-23 09:17:56 +0800627/* amd_imc.c */
628int amd_imc_shutdown(struct pci_dev *dev);
Rong Changaaa1acf2012-06-21 19:21:18 +0800629
hailfinger2b46a862011-02-28 23:58:15 +0000630/* it85spi.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700631int it85xx_spi_init(struct superio s);
632int it8518_spi_init(struct superio s);
hailfinger2b46a862011-02-28 23:58:15 +0000633
hailfinger428f6852010-07-27 22:41:39 +0000634/* it87spi.c */
635void enter_conf_mode_ite(uint16_t port);
636void exit_conf_mode_ite(uint16_t port);
hailfinger94e090c2011-04-27 14:34:08 +0000637void probe_superio_ite(void);
David Hendricksac1d25c2016-08-09 17:00:58 -0700638int init_superio_ite(void);
hailfinger428f6852010-07-27 22:41:39 +0000639
hailfingere20dc562011-06-09 20:06:34 +0000640/* mcp6x_spi.c */
641int mcp6x_spi_init(int want_spi);
642
David Hendricks46d32e32011-01-19 16:01:52 -0800643/* mec1308.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700644int mec1308_probe_spi_flash(const char *name);
David Hendricks46d32e32011-01-19 16:01:52 -0800645
hailfinger428f6852010-07-27 22:41:39 +0000646/* sb600spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000647int sb600_probe_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000648
649/* wbsio_spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000650int wbsio_check_for_spi(void);
hailfinger428f6852010-07-27 22:41:39 +0000651#endif
652
hailfingerfe7cd9e2011-11-04 21:35:26 +0000653/* opaque.c */
Edward O'Callaghanabd30192019-05-14 15:58:19 +1000654struct opaque_master {
hailfingerfe7cd9e2011-11-04 21:35:26 +0000655 int max_data_read;
656 int max_data_write;
657 /* Specific functions for this programmer */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700658 int (*probe) (struct flashctx *flash);
659 int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100660 int (*write) (struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700661 int (*erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
662 uint8_t (*read_status) (const struct flashctx *flash);
663 int (*write_status) (const struct flashctx *flash, int status);
Duncan Laurie25a4ca22019-04-25 12:08:52 -0700664 int (*check_access) (const struct flashctx *flash, unsigned int start, unsigned int len, int read);
David Hendricks5d481e12012-05-24 14:14:14 -0700665 const void *data;
hailfingerfe7cd9e2011-11-04 21:35:26 +0000666};
Craig Hesling65eb8812019-08-01 09:33:56 -0700667extern struct opaque_master *opaque_master;
668void register_opaque_master(struct opaque_master *pgm);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000669
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700670/* programmer.c */
671int noop_shutdown(void);
Patrick Georgi4befc162017-02-03 18:32:01 +0100672void *fallback_map(const char *descr, uintptr_t phys_addr, size_t len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700673void fallback_unmap(void *virt_addr, size_t len);
David Hendricksac1d25c2016-08-09 17:00:58 -0700674uint8_t noop_chip_readb(const struct flashctx *flash, const chipaddr addr);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700675void noop_chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr);
676void fallback_chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr);
677void fallback_chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr);
678void fallback_chip_writen(const struct flashctx *flash, uint8_t *buf, chipaddr addr, size_t len);
679uint16_t fallback_chip_readw(const struct flashctx *flash, const chipaddr addr);
680uint32_t fallback_chip_readl(const struct flashctx *flash, const chipaddr addr);
681void fallback_chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Patrick Georgi0a9533a2017-02-03 19:28:38 +0100682struct par_master {
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700683 void (*chip_writeb) (const struct flashctx *flash, uint8_t val, chipaddr addr);
684 void (*chip_writew) (const struct flashctx *flash, uint16_t val, chipaddr addr);
685 void (*chip_writel) (const struct flashctx *flash, uint32_t val, chipaddr addr);
686 void (*chip_writen) (const struct flashctx *flash, uint8_t *buf, chipaddr addr, size_t len);
687 uint8_t (*chip_readb) (const struct flashctx *flash, const chipaddr addr);
688 uint16_t (*chip_readw) (const struct flashctx *flash, const chipaddr addr);
689 uint32_t (*chip_readl) (const struct flashctx *flash, const chipaddr addr);
690 void (*chip_readn) (const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Edward O'Callaghan20596a82019-06-13 14:47:03 +1000691 const void *data;
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700692};
Craig Hesling65eb8812019-08-01 09:33:56 -0700693extern const struct par_master *par_master;
694void register_par_master(const struct par_master *pgm, const enum chipbustype buses);
Edward O'Callaghan20596a82019-06-13 14:47:03 +1000695struct registered_master {
696 enum chipbustype buses_supported;
697 union {
698 struct par_master par;
699 struct spi_master spi;
Edward O'Callaghanabd30192019-05-14 15:58:19 +1000700 struct opaque_master opaque;
Edward O'Callaghan20596a82019-06-13 14:47:03 +1000701 };
702};
703extern struct registered_master registered_masters[];
704extern int registered_master_count;
705int register_master(const struct registered_master *mst);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700706
hailfinger428f6852010-07-27 22:41:39 +0000707/* serprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000708#if CONFIG_SERPROG == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700709int serprog_init(void);
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000710void serprog_delay(unsigned int usecs);
hailfingere20dc562011-06-09 20:06:34 +0000711#endif
hailfinger428f6852010-07-27 22:41:39 +0000712
713/* serial.c */
714#if _WIN32
715typedef HANDLE fdtype;
716#else
717typedef int fdtype;
718#endif
719
David Hendricksc801adb2010-12-09 16:58:56 -0800720/* wpce775x.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700721int wpce775x_probe_spi_flash(const char *name);
David Hendricksc801adb2010-12-09 16:58:56 -0800722
David Hendricksb907de32014-08-11 16:47:09 -0700723/* cros_ec.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700724int cros_ec_probe_i2c(const char *name);
Simon Glasscd597032013-05-23 17:18:44 -0700725
726/**
727 * Probe the Google Chrome OS EC device
728 *
729 * @return 0 if found correct, non-zero if not found or error
730 */
David Hendricksac1d25c2016-08-09 17:00:58 -0700731int cros_ec_probe_dev(void);
Simon Glasscd597032013-05-23 17:18:44 -0700732
David Hendricksac1d25c2016-08-09 17:00:58 -0700733int cros_ec_probe_lpc(const char *name);
734int cros_ec_need_2nd_pass(void);
735int cros_ec_finish(void);
736int cros_ec_prepare(uint8_t *image, int size);
Louis Yung-Chieh Loedb0cba2011-12-09 17:06:54 +0800737
hailfinger428f6852010-07-27 22:41:39 +0000738void sp_flush_incoming(void);
739fdtype sp_openserport(char *dev, unsigned int baud);
740void __attribute__((noreturn)) sp_die(char *msg);
741extern fdtype sp_fd;
dhendrix0ffc2eb2011-06-14 01:35:36 +0000742/* expose serialport_shutdown as it's currently used by buspirate */
743int serialport_shutdown(void *data);
hailfinger428f6852010-07-27 22:41:39 +0000744int serialport_write(unsigned char *buf, unsigned int writecnt);
745int serialport_read(unsigned char *buf, unsigned int readcnt);
746
Edward O'Callaghana88395f2019-02-27 18:44:04 +1100747/* usbdev.c */
748struct libusb_device_handle;
749struct libusb_context;
750struct libusb_device_handle *usb_dev_get_by_vid_pid_serial(
751 struct libusb_context *usb_ctx, uint16_t vid, uint16_t pid, const char *serialno);
752struct libusb_device_handle *usb_dev_get_by_vid_pid_number(
753 struct libusb_context *usb_ctx, uint16_t vid, uint16_t pid, unsigned int num);
754
Edward O'Callaghana6673bd2019-06-24 15:22:28 +1000755/* spi_master feature checks */
756static inline bool spi_master_4ba(const struct flashctx *const flash)
757{
758 return flash->mst->buses_supported & BUS_SPI &&
759 flash->mst->spi.features & SPI_MASTER_4BA;
760}
761
hailfinger428f6852010-07-27 22:41:39 +0000762#endif /* !__PROGRAMMER_H__ */