blob: d1844661c9d9dbc77f1f6362315fec56f1318dce [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
Shiyu Sun9dde7162020-04-16 17:32:55 +100091#if CONFIG_LSPCON_I2C_SPI == 1
92 PROGRAMMER_LSPCON_I2C_SPI,
93#endif
Edward O'Callaghan97dd9262020-03-26 00:00:41 +110094#if CONFIG_REALTEK_MST_I2C_SPI == 1
95 PROGRAMMER_REALTEK_MST_I2C_SPI,
96#endif
hailfinger428f6852010-07-27 22:41:39 +000097 PROGRAMMER_INVALID /* This must always be the last entry. */
98};
99
David Hendricksba0827a2013-05-03 20:25:40 -0700100enum alias_type {
101 ALIAS_NONE = 0, /* no alias (default) */
102 ALIAS_EC, /* embedded controller */
103 ALIAS_HOST, /* chipset / PCH / SoC / etc. */
104};
105
106struct programmer_alias {
107 const char *name;
108 enum alias_type type;
109};
110
111extern struct programmer_alias *alias;
112extern struct programmer_alias aliases[];
113
Vadim Bendebury066143d2018-07-16 18:20:33 -0700114/*
115 * This function returns 'true' if current flashrom invocation is programming
116 * the EC.
117 */
118static inline int programming_ec(void) {
119 return alias && (alias->type == ALIAS_EC);
120}
121
Edward O'Callaghan0949b782019-11-10 23:23:20 +1100122enum programmer_type {
123 PCI = 1, /* to detect uninitialized values */
124 USB,
125 OTHER,
126};
127
128struct dev_entry {
129 uint16_t vendor_id;
130 uint16_t device_id;
131 const enum test_state status;
132 const char *vendor_name;
133 const char *device_name;
134};
135
hailfinger428f6852010-07-27 22:41:39 +0000136struct programmer_entry {
hailfinger428f6852010-07-27 22:41:39 +0000137 const char *name;
Edward O'Callaghan0949b782019-11-10 23:23:20 +1100138 const enum programmer_type type;
139 union {
140 const struct dev_entry *const dev;
141 const char *const note;
142 } devs;
hailfinger428f6852010-07-27 22:41:39 +0000143
David Hendricksac1d25c2016-08-09 17:00:58 -0700144 int (*init) (void);
hailfinger428f6852010-07-27 22:41:39 +0000145
Patrick Georgi4befc162017-02-03 18:32:01 +0100146 void *(*map_flash_region) (const char *descr, uintptr_t phys_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000147 void (*unmap_flash_region) (void *virt_addr, size_t len);
148
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000149 void (*delay) (unsigned int usecs);
David Hendricks55cdd9c2015-11-25 14:37:26 -0800150
151 /*
152 * If set, use extra precautions such as erasing with small block sizes
153 * and verifying more rigorously. This will incur a performance penalty
154 * but is good for programming the ROM in-system on a live machine.
155 */
156 int paranoid;
hailfinger428f6852010-07-27 22:41:39 +0000157};
158
159extern const struct programmer_entry programmer_table[];
160
Edward O'Callaghanb2257cc2020-07-25 22:19:47 +1000161int programmer_init(enum programmer prog, const char *param);
David Hendricks93784b42016-08-09 17:00:38 -0700162int programmer_shutdown(void);
hailfinger428f6852010-07-27 22:41:39 +0000163
hailfinger428f6852010-07-27 22:41:39 +0000164struct bitbang_spi_master {
hailfinger428f6852010-07-27 22:41:39 +0000165 /* Note that CS# is active low, so val=0 means the chip is active. */
166 void (*set_cs) (int val);
167 void (*set_sck) (int val);
168 void (*set_mosi) (int val);
169 int (*get_miso) (void);
hailfinger12cba9a2010-09-15 00:17:37 +0000170 void (*request_bus) (void);
171 void (*release_bus) (void);
Patrick Georgie081d5d2017-03-22 21:18:18 +0100172
173 /* Length of half a clock period in usecs. */
174 unsigned int half_period;
hailfinger428f6852010-07-27 22:41:39 +0000175};
176
177#if CONFIG_INTERNAL == 1
Mayur Panchalf4796862019-08-05 15:46:12 +1000178struct pci_dev;
hailfinger428f6852010-07-27 22:41:39 +0000179struct penable {
180 uint16_t vendor_id;
181 uint16_t device_id;
Edward O'Callaghan01c39672020-05-27 19:13:26 +1000182 enum chipbustype buses;
stefanct6d836ba2011-05-26 01:35:19 +0000183 int status; /* OK=0 and NT=1 are defines only. Beware! */
hailfinger428f6852010-07-27 22:41:39 +0000184 const char *vendor_name;
185 const char *device_name;
186 int (*doit) (struct pci_dev *dev, const char *name);
187};
188
189extern const struct penable chipset_enables[];
190
hailfingere52e9f82011-05-05 07:12:40 +0000191enum board_match_phase {
192 P1,
193 P2,
194 P3
195};
196
hailfinger4640bdb2011-08-31 16:19:50 +0000197struct board_match {
hailfinger428f6852010-07-27 22:41:39 +0000198 /* Any device, but make it sensible, like the ISA bridge. */
199 uint16_t first_vendor;
200 uint16_t first_device;
201 uint16_t first_card_vendor;
202 uint16_t first_card_device;
203
204 /* Any device, but make it sensible, like
205 * the host bridge. May be NULL.
206 */
207 uint16_t second_vendor;
208 uint16_t second_device;
209 uint16_t second_card_vendor;
210 uint16_t second_card_device;
211
stefanct6d836ba2011-05-26 01:35:19 +0000212 /* Pattern to match DMI entries. May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000213 const char *dmi_pattern;
214
stefanct6d836ba2011-05-26 01:35:19 +0000215 /* The vendor / part name from the coreboot table. May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000216 const char *lb_vendor;
217 const char *lb_part;
218
hailfingere52e9f82011-05-05 07:12:40 +0000219 enum board_match_phase phase;
220
hailfinger428f6852010-07-27 22:41:39 +0000221 const char *vendor_name;
222 const char *board_name;
223
224 int max_rom_decode_parallel;
225 int status;
stefanct6d836ba2011-05-26 01:35:19 +0000226 int (*enable) (void); /* May be NULL. */
hailfinger428f6852010-07-27 22:41:39 +0000227};
228
hailfinger4640bdb2011-08-31 16:19:50 +0000229extern const struct board_match board_matches[];
hailfinger428f6852010-07-27 22:41:39 +0000230
231struct board_info {
232 const char *vendor;
233 const char *name;
234 const int working;
235#ifdef CONFIG_PRINT_WIKI
236 const char *url;
237 const char *note;
238#endif
239};
240
241extern const struct board_info boards_known[];
242extern const struct board_info laptops_known[];
243#endif
244
245/* udelay.c */
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000246void myusec_delay(unsigned int usecs);
hailfinger428f6852010-07-27 22:41:39 +0000247void myusec_calibrate_delay(void);
Nikolai Artemievc40dd0e2020-07-15 15:57:55 +1000248void internal_sleep(unsigned int usecs);
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000249void internal_delay(unsigned int usecs);
Nikolai Artemievdf53e852020-08-28 15:57:00 +1000250void internal_sleep(unsigned int usecs);
hailfinger428f6852010-07-27 22:41:39 +0000251
252#if NEED_PCI == 1
253/* pcidev.c */
hailfinger428f6852010-07-27 22:41:39 +0000254extern struct pci_access *pacc;
Edward O'Callaghan80aedd02019-08-02 22:36:56 +1000255int pci_init_common(void);
Patrick Georgif776a442017-03-28 21:34:33 +0200256uintptr_t pcidev_readbar(struct pci_dev *dev, int bar);
Patrick Georgi7c30fa92017-03-28 22:47:12 +0200257struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar);
hailfingerf31cbdc2010-11-10 15:25:18 +0000258/* rpci_write_* are reversible writes. The original PCI config space register
259 * contents will be restored on shutdown.
260 */
mkarcher08a24552010-12-26 23:55:19 +0000261int rpci_write_byte(struct pci_dev *dev, int reg, uint8_t data);
262int rpci_write_word(struct pci_dev *dev, int reg, uint16_t data);
263int rpci_write_long(struct pci_dev *dev, int reg, uint32_t data);
hailfinger428f6852010-07-27 22:41:39 +0000264#endif
265
hailfingere20dc562011-06-09 20:06:34 +0000266#if CONFIG_INTERNAL == 1
hailfinger428f6852010-07-27 22:41:39 +0000267/* board_enable.c */
268void w836xx_ext_enter(uint16_t port);
269void w836xx_ext_leave(uint16_t port);
270int it8705f_write_enable(uint8_t port);
271uint8_t sio_read(uint16_t port, uint8_t reg);
272void sio_write(uint16_t port, uint8_t reg, uint8_t data);
273void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
hailfingere52e9f82011-05-05 07:12:40 +0000274void board_handle_before_superio(void);
275void board_handle_before_laptop(void);
hailfinger428f6852010-07-27 22:41:39 +0000276int board_flash_enable(const char *vendor, const char *part);
277
278/* chipset_enable.c */
279int chipset_flash_enable(void);
Louis Yung-Chieh Lo6b8f0462011-01-06 12:49:46 +0800280int get_target_bus_from_chipset(enum chipbustype *target_bus);
hailfinger428f6852010-07-27 22:41:39 +0000281
282/* processor_enable.c */
283int processor_flash_enable(void);
hailfingere52e9f82011-05-05 07:12:40 +0000284#endif
hailfinger428f6852010-07-27 22:41:39 +0000285
286/* physmap.c */
Patrick Georgi4befc162017-02-03 18:32:01 +0100287void *physmap(const char *descr, uintptr_t phys_addr, size_t len);
Patrick Georgi220f4b52017-03-21 16:55:04 +0100288void *rphysmap(const char *descr, uintptr_t phys_addr, size_t len);
Edward O'Callaghan64a4db22019-05-30 03:13:07 -0400289void *physmap_ro(const char *descr, uintptr_t phys_addr, size_t len);
Edward O'Callaghan0822bc22019-10-29 14:26:30 +1100290void *physmap_ro_unaligned(const char *descr, uintptr_t phys_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000291void physunmap(void *virt_addr, size_t len);
Edward O'Callaghanb2878982019-05-30 03:44:32 -0400292void physunmap_unaligned(void *virt_addr, size_t len);
hailfingere20dc562011-06-09 20:06:34 +0000293#if CONFIG_INTERNAL == 1
hailfinger428f6852010-07-27 22:41:39 +0000294int setup_cpu_msr(int cpu);
295void cleanup_cpu_msr(void);
296
297/* cbtable.c */
Edward O'Callaghan481cce82019-05-31 15:03:50 +1000298int cb_parse_table(const char **vendor, const char **model);
Carl-Daniel Hailfingere5ec66e2016-08-03 16:10:19 -0700299void lb_vendor_dev_from_string(const char *boardstring);
hailfinger428f6852010-07-27 22:41:39 +0000300extern int partvendor_from_cbtable;
301
302/* dmi.c */
303extern int has_dmi_support;
304void dmi_init(void);
305int dmi_match(const char *pattern);
306
307/* internal.c */
hailfinger428f6852010-07-27 22:41:39 +0000308struct superio {
309 uint16_t vendor;
310 uint16_t port;
311 uint16_t model;
312};
hailfinger94e090c2011-04-27 14:34:08 +0000313extern struct superio superios[];
314extern int superio_count;
hailfinger428f6852010-07-27 22:41:39 +0000315#define SUPERIO_VENDOR_NONE 0x0
316#define SUPERIO_VENDOR_ITE 0x1
hailfingere20dc562011-06-09 20:06:34 +0000317#endif
318#if NEED_PCI == 1
Mayur Panchalf4796862019-08-05 15:46:12 +1000319struct pci_filter;
uwe922946a2011-07-13 11:22:03 +0000320struct pci_dev *pci_dev_find_vendorclass(uint16_t vendor, uint16_t devclass);
hailfinger428f6852010-07-27 22:41:39 +0000321struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device);
322struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
323 uint16_t card_vendor, uint16_t card_device);
324#endif
Patrick Georgi2a2d67f2017-03-09 10:15:39 +0100325int rget_io_perms(void);
hailfinger428f6852010-07-27 22:41:39 +0000326#if CONFIG_INTERNAL == 1
327extern int is_laptop;
hailfingere52e9f82011-05-05 07:12:40 +0000328extern int laptop_ok;
hailfinger428f6852010-07-27 22:41:39 +0000329extern int force_boardenable;
330extern int force_boardmismatch;
331void probe_superio(void);
hailfinger94e090c2011-04-27 14:34:08 +0000332int register_superio(struct superio s);
hailfinger76bb7e92011-11-09 23:40:00 +0000333extern enum chipbustype internal_buses_supported;
David Hendricksac1d25c2016-08-09 17:00:58 -0700334int internal_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000335#endif
336
337/* hwaccess.c */
338void mmio_writeb(uint8_t val, void *addr);
339void mmio_writew(uint16_t val, void *addr);
340void mmio_writel(uint32_t val, void *addr);
Edward O'Callaghan46b1e492019-06-02 16:04:48 +1000341uint8_t mmio_readb(const void *addr);
342uint16_t mmio_readw(const void *addr);
343uint32_t mmio_readl(const void *addr);
344void mmio_readn(const void *addr, uint8_t *buf, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000345void mmio_le_writeb(uint8_t val, void *addr);
346void mmio_le_writew(uint16_t val, void *addr);
347void mmio_le_writel(uint32_t val, void *addr);
Edward O'Callaghan46b1e492019-06-02 16:04:48 +1000348uint8_t mmio_le_readb(const void *addr);
349uint16_t mmio_le_readw(const void *addr);
350uint32_t mmio_le_readl(const void *addr);
hailfinger428f6852010-07-27 22:41:39 +0000351#define pci_mmio_writeb mmio_le_writeb
352#define pci_mmio_writew mmio_le_writew
353#define pci_mmio_writel mmio_le_writel
354#define pci_mmio_readb mmio_le_readb
355#define pci_mmio_readw mmio_le_readw
356#define pci_mmio_readl mmio_le_readl
hailfinger1e2e3442011-05-03 21:49:41 +0000357void rmmio_writeb(uint8_t val, void *addr);
358void rmmio_writew(uint16_t val, void *addr);
359void rmmio_writel(uint32_t val, void *addr);
360void rmmio_le_writeb(uint8_t val, void *addr);
361void rmmio_le_writew(uint16_t val, void *addr);
362void rmmio_le_writel(uint32_t val, void *addr);
363#define pci_rmmio_writeb rmmio_le_writeb
364#define pci_rmmio_writew rmmio_le_writew
365#define pci_rmmio_writel rmmio_le_writel
366void rmmio_valb(void *addr);
367void rmmio_valw(void *addr);
368void rmmio_vall(void *addr);
hailfinger428f6852010-07-27 22:41:39 +0000369
hailfinger428f6852010-07-27 22:41:39 +0000370/* dummyflasher.c */
371#if CONFIG_DUMMY == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700372int dummy_init(void);
Patrick Georgi4befc162017-02-03 18:32:01 +0100373void *dummy_map(const char *descr, uintptr_t phys_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000374void dummy_unmap(void *virt_addr, size_t len);
hailfinger428f6852010-07-27 22:41:39 +0000375#endif
376
377/* nic3com.c */
378#if CONFIG_NIC3COM == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700379int nic3com_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100380extern const struct dev_entry nics_3com[];
hailfinger428f6852010-07-27 22:41:39 +0000381#endif
382
383/* gfxnvidia.c */
384#if CONFIG_GFXNVIDIA == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700385int gfxnvidia_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100386extern const struct dev_entry gfx_nvidia[];
hailfinger428f6852010-07-27 22:41:39 +0000387#endif
388
389/* drkaiser.c */
390#if CONFIG_DRKAISER == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700391int drkaiser_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100392extern const struct dev_entry drkaiser_pcidev[];
hailfinger428f6852010-07-27 22:41:39 +0000393#endif
394
395/* nicrealtek.c */
396#if CONFIG_NICREALTEK == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700397int nicrealtek_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100398extern const struct dev_entry nics_realtek[];
hailfinger428f6852010-07-27 22:41:39 +0000399#endif
400
401/* nicnatsemi.c */
402#if CONFIG_NICNATSEMI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700403int nicnatsemi_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100404extern const struct dev_entry nics_natsemi[];
hailfinger428f6852010-07-27 22:41:39 +0000405#endif
406
hailfinger7949b652011-05-08 00:24:18 +0000407/* nicintel.c */
408#if CONFIG_NICINTEL == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700409int nicintel_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100410extern const struct dev_entry nics_intel[];
hailfinger7949b652011-05-08 00:24:18 +0000411#endif
412
uwe6764e922010-09-03 18:21:21 +0000413/* nicintel_spi.c */
414#if CONFIG_NICINTEL_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700415int nicintel_spi_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100416extern const struct dev_entry nics_intel_spi[];
uwe6764e922010-09-03 18:21:21 +0000417#endif
418
hailfingerfb1f31f2010-12-03 14:48:11 +0000419/* ogp_spi.c */
420#if CONFIG_OGP_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700421int ogp_spi_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100422extern const struct dev_entry ogp_spi[];
hailfingerfb1f31f2010-12-03 14:48:11 +0000423#endif
424
hailfinger935365d2011-02-04 21:37:59 +0000425/* satamv.c */
426#if CONFIG_SATAMV == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700427int satamv_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100428extern const struct dev_entry satas_mv[];
hailfinger935365d2011-02-04 21:37:59 +0000429#endif
430
hailfinger428f6852010-07-27 22:41:39 +0000431/* satasii.c */
432#if CONFIG_SATASII == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700433int satasii_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100434extern const struct dev_entry satas_sii[];
hailfinger428f6852010-07-27 22:41:39 +0000435#endif
436
437/* atahpt.c */
438#if CONFIG_ATAHPT == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700439int atahpt_init(void);
Patrick Georgi8ae16572017-03-09 15:59:25 +0100440extern const struct dev_entry ata_hpt[];
hailfinger428f6852010-07-27 22:41:39 +0000441#endif
442
443/* ft2232_spi.c */
hailfinger888410e2010-07-29 15:54:53 +0000444#if CONFIG_FT2232_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700445int ft2232_spi_init(void);
Nikolai Artemievc347a852020-04-29 12:17:08 +1000446extern const struct dev_entry devs_ft2232spi[];
hailfinger888410e2010-07-29 15:54:53 +0000447#endif
hailfinger428f6852010-07-27 22:41:39 +0000448
449/* rayer_spi.c */
450#if CONFIG_RAYER_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700451int rayer_spi_init(void);
hailfinger428f6852010-07-27 22:41:39 +0000452#endif
453
454/* bitbang_spi.c */
Craig Hesling65eb8812019-08-01 09:33:56 -0700455int register_spi_bitbang_master(const struct bitbang_spi_master *master);
David Hendricksac1d25c2016-08-09 17:00:58 -0700456int bitbang_spi_shutdown(const struct bitbang_spi_master *master);
hailfinger428f6852010-07-27 22:41:39 +0000457
458/* buspirate_spi.c */
hailfingere20dc562011-06-09 20:06:34 +0000459#if CONFIG_BUSPIRATE_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700460int buspirate_spi_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000461#endif
hailfinger428f6852010-07-27 22:41:39 +0000462
Anton Staafb2647882014-09-17 15:13:43 -0700463/* raiden_debug_spi.c */
464#if CONFIG_RAIDEN_DEBUG_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700465int raiden_debug_spi_init(void);
Brian J. Nemecb42d6c12020-07-23 03:07:38 -0700466extern const struct dev_entry devs_raiden[];
Anton Staafb2647882014-09-17 15:13:43 -0700467#endif
468
David Hendrickscebee892015-05-23 20:30:30 -0700469/* linux_mtd.c */
470#if CONFIG_LINUX_MTD == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700471int linux_mtd_init(void);
David Hendrickscebee892015-05-23 20:30:30 -0700472#endif
473
uwe7df6dda2011-09-03 18:37:52 +0000474/* linux_spi.c */
475#if CONFIG_LINUX_SPI == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700476int linux_spi_init(void);
uwe7df6dda2011-09-03 18:37:52 +0000477#endif
478
hailfinger428f6852010-07-27 22:41:39 +0000479/* dediprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000480#if CONFIG_DEDIPROG == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700481int dediprog_init(void);
hailfingere20dc562011-06-09 20:06:34 +0000482#endif
hailfinger428f6852010-07-27 22:41:39 +0000483
484/* flashrom.c */
485struct decode_sizes {
486 uint32_t parallel;
487 uint32_t lpc;
488 uint32_t fwh;
489 uint32_t spi;
490};
Edward O'Callaghan929b6382020-05-15 12:47:24 +1000491// FIXME: These need to be local, not global
hailfinger428f6852010-07-27 22:41:39 +0000492extern struct decode_sizes max_rom_decode;
493extern int programmer_may_write;
494extern unsigned long flashbase;
hailfinger428f6852010-07-27 22:41:39 +0000495int check_max_decode(enum chipbustype buses, uint32_t size);
stefanct52700282011-06-26 17:38:17 +0000496char *extract_programmer_param(const char *param_name);
hailfinger428f6852010-07-27 22:41:39 +0000497
hailfinger428f6852010-07-27 22:41:39 +0000498/* spi.c */
Patrick Georgif4f1e2f2017-03-10 17:38:40 +0100499extern const int spi_master_count;
mkarcher8fb57592011-05-11 17:07:02 +0000500
501#define MAX_DATA_UNSPECIFIED 0
502#define MAX_DATA_READ_UNLIMITED 64 * 1024
503#define MAX_DATA_WRITE_UNLIMITED 256
Edward O'Callaghana6673bd2019-06-24 15:22:28 +1000504
505#define SPI_MASTER_4BA (1U << 0) /**< Can handle 4-byte addresses */
Edward O'Callaghandaf990f2019-11-11 14:57:13 +1100506#define SPI_MASTER_NO_4BA_MODES (1U << 1) /**< Compatibility modes (i.e. extended address
507 register, 4BA mode switch) don't work */
Edward O'Callaghana6673bd2019-06-24 15:22:28 +1000508
Patrick Georgif4f1e2f2017-03-10 17:38:40 +0100509struct spi_master {
Edward O'Callaghana6673bd2019-06-24 15:22:28 +1000510 uint32_t features;
stefanctc5eb8a92011-11-23 09:13:48 +0000511 unsigned int max_data_read;
512 unsigned int max_data_write;
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700513 int (*command)(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
hailfinger428f6852010-07-27 22:41:39 +0000514 const unsigned char *writearr, unsigned char *readarr);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700515 int (*multicommand)(const struct flashctx *flash, struct spi_command *cmds);
hailfinger428f6852010-07-27 22:41:39 +0000516
Patrick Georgie39d6442017-03-22 21:23:35 +0100517 /* Optimized functions for this master */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700518 int (*read)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100519 int (*write_256)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Edward O'Callaghan9cf8b7c2020-04-15 12:40:45 +1000520 int (*write_aai)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
521 const void *data;
hailfinger428f6852010-07-27 22:41:39 +0000522};
523
Craig Hesling65eb8812019-08-01 09:33:56 -0700524extern const struct spi_master *spi_master;
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700525int default_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
hailfinger428f6852010-07-27 22:41:39 +0000526 const unsigned char *writearr, unsigned char *readarr);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700527int default_spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds);
528int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100529int 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 +1000530int register_spi_master(const struct spi_master *programmer);
hailfinger428f6852010-07-27 22:41:39 +0000531
Edward O'Callaghanea053772019-08-13 10:32:30 +1000532/* 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 +1000533enum ich_chipset {
stefanctc035c192011-11-06 23:51:09 +0000534 CHIPSET_ICH_UNKNOWN,
Edward O'Callaghan9ff09132019-09-04 13:48:46 +1000535 CHIPSET_ICH,
536 CHIPSET_ICH2345,
Edward O'Callaghanea053772019-08-13 10:32:30 +1000537 CHIPSET_ICH6,
Edward O'Callaghan9ff09132019-09-04 13:48:46 +1000538 CHIPSET_POULSBO, /* SCH U* */
539 CHIPSET_TUNNEL_CREEK, /* Atom E6xx */
Edward O'Callaghanc8e0a112020-05-26 21:38:37 +1000540 CHIPSET_CENTERTON, /* Atom S1220 S1240 S1260 */
Edward O'Callaghanea053772019-08-13 10:32:30 +1000541 CHIPSET_ICH7,
stefanctc035c192011-11-06 23:51:09 +0000542 CHIPSET_ICH8,
543 CHIPSET_ICH9,
544 CHIPSET_ICH10,
545 CHIPSET_5_SERIES_IBEX_PEAK,
546 CHIPSET_6_SERIES_COUGAR_POINT,
Duncan Laurie32e60552013-02-28 09:42:07 -0800547 CHIPSET_7_SERIES_PANTHER_POINT,
548 CHIPSET_8_SERIES_LYNX_POINT,
Edward O'Callaghan595c4382020-07-29 10:44:59 +1000549 CHIPSET_BAYTRAIL, /* Actually all with Silvermont architecture: Bay Trail, Avoton/Rangeley */
Duncan Laurie32e60552013-02-28 09:42:07 -0800550 CHIPSET_8_SERIES_LYNX_POINT_LP,
Edward O'Callaghanc8e0a112020-05-26 21:38:37 +1000551 CHIPSET_8_SERIES_WELLSBURG,
Duncan Laurie9bd2af82014-05-12 10:17:38 -0700552 CHIPSET_9_SERIES_WILDCAT_POINT,
Edward O'Callaghanc8e0a112020-05-26 21:38:37 +1000553 CHIPSET_9_SERIES_WILDCAT_POINT_LP,
554 CHIPSET_100_SERIES_SUNRISE_POINT, /* also 6th/7th gen Core i/o (LP) variants */
Edward O'Callaghanc8e0a112020-05-26 21:38:37 +1000555 CHIPSET_C620_SERIES_LEWISBURG,
556 CHIPSET_300_SERIES_CANNON_POINT,
Edward O'Callaghan595c4382020-07-29 10:44:59 +1000557 CHIPSET_APOLLO_LAKE,
stefanctc035c192011-11-06 23:51:09 +0000558};
559
Edward O'Callaghan595c4382020-07-29 10:44:59 +1000560
Edward O'Callaghanea053772019-08-13 10:32:30 +1000561/* ichspi.c */
Stefan Tauner34f6f5a2016-08-03 11:20:38 -0700562#if CONFIG_INTERNAL == 1
Vadim Bendebury622128c2018-06-21 15:50:28 -0700563
564/*
565 * This global variable is used to communicate the type of ICH found on the
566 * device. When running on non-intel platforms default value of
567 * CHIPSET_ICH_UNKNOWN is used.
568*/
Edward O'Callaghane3e30562019-09-03 13:10:58 +1000569extern enum ich_chipset g_ich_generation;
Vadim Bendebury066143d2018-07-16 18:20:33 -0700570
Edward O'Callaghanbb51dcc2020-05-27 12:22:55 +1000571int ich_init_spi(void *spibar, enum ich_chipset ich_generation);
Edward O'Callaghan3300e4e2019-10-03 13:20:09 +1000572int via_init_spi(uint32_t mmio_base);
hailfinger428f6852010-07-27 22:41:39 +0000573
Rong Changaaa1acf2012-06-21 19:21:18 +0800574/* ene_lpc.c */
Victor Ding7fd63dc2020-08-19 23:03:23 +1000575int ene_probe_spi_flash();
ivy_jian8e0c4e52017-08-23 09:17:56 +0800576/* amd_imc.c */
577int amd_imc_shutdown(struct pci_dev *dev);
Rong Changaaa1acf2012-06-21 19:21:18 +0800578
hailfinger2b46a862011-02-28 23:58:15 +0000579/* it85spi.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700580int it85xx_spi_init(struct superio s);
581int it8518_spi_init(struct superio s);
hailfinger2b46a862011-02-28 23:58:15 +0000582
hailfinger428f6852010-07-27 22:41:39 +0000583/* it87spi.c */
584void enter_conf_mode_ite(uint16_t port);
585void exit_conf_mode_ite(uint16_t port);
hailfinger94e090c2011-04-27 14:34:08 +0000586void probe_superio_ite(void);
David Hendricksac1d25c2016-08-09 17:00:58 -0700587int init_superio_ite(void);
hailfinger428f6852010-07-27 22:41:39 +0000588
hailfingere20dc562011-06-09 20:06:34 +0000589/* mcp6x_spi.c */
590int mcp6x_spi_init(int want_spi);
591
David Hendricks46d32e32011-01-19 16:01:52 -0800592/* mec1308.c */
Victor Dinga2c921c2020-08-18 18:55:20 +1000593int mec1308_probe_spi_flash();
David Hendricks46d32e32011-01-19 16:01:52 -0800594
hailfinger428f6852010-07-27 22:41:39 +0000595/* sb600spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000596int sb600_probe_spi(struct pci_dev *dev);
hailfinger428f6852010-07-27 22:41:39 +0000597
598/* wbsio_spi.c */
hailfinger428f6852010-07-27 22:41:39 +0000599int wbsio_check_for_spi(void);
hailfinger428f6852010-07-27 22:41:39 +0000600#endif
601
hailfingerfe7cd9e2011-11-04 21:35:26 +0000602/* opaque.c */
Edward O'Callaghanabd30192019-05-14 15:58:19 +1000603struct opaque_master {
hailfingerfe7cd9e2011-11-04 21:35:26 +0000604 int max_data_read;
605 int max_data_write;
Edward O'Callaghan929b6382020-05-15 12:47:24 +1000606 /* Specific functions for this master */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700607 int (*probe) (struct flashctx *flash);
608 int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100609 int (*write) (struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700610 int (*erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
611 uint8_t (*read_status) (const struct flashctx *flash);
612 int (*write_status) (const struct flashctx *flash, int status);
Duncan Laurie25a4ca22019-04-25 12:08:52 -0700613 int (*check_access) (const struct flashctx *flash, unsigned int start, unsigned int len, int read);
David Hendricks5d481e12012-05-24 14:14:14 -0700614 const void *data;
hailfingerfe7cd9e2011-11-04 21:35:26 +0000615};
Craig Hesling65eb8812019-08-01 09:33:56 -0700616extern struct opaque_master *opaque_master;
617void register_opaque_master(struct opaque_master *pgm);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000618
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700619/* programmer.c */
620int noop_shutdown(void);
Patrick Georgi4befc162017-02-03 18:32:01 +0100621void *fallback_map(const char *descr, uintptr_t phys_addr, size_t len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700622void fallback_unmap(void *virt_addr, size_t len);
David Hendricksac1d25c2016-08-09 17:00:58 -0700623uint8_t noop_chip_readb(const struct flashctx *flash, const chipaddr addr);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700624void noop_chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr);
625void fallback_chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr);
626void fallback_chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr);
Stuart langleyc98e43f2020-03-26 20:27:36 +1100627void fallback_chip_writen(const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700628uint16_t fallback_chip_readw(const struct flashctx *flash, const chipaddr addr);
629uint32_t fallback_chip_readl(const struct flashctx *flash, const chipaddr addr);
630void fallback_chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Patrick Georgi0a9533a2017-02-03 19:28:38 +0100631struct par_master {
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700632 void (*chip_writeb) (const struct flashctx *flash, uint8_t val, chipaddr addr);
633 void (*chip_writew) (const struct flashctx *flash, uint16_t val, chipaddr addr);
634 void (*chip_writel) (const struct flashctx *flash, uint32_t val, chipaddr addr);
Stuart langleyc98e43f2020-03-26 20:27:36 +1100635 void (*chip_writen) (const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700636 uint8_t (*chip_readb) (const struct flashctx *flash, const chipaddr addr);
637 uint16_t (*chip_readw) (const struct flashctx *flash, const chipaddr addr);
638 uint32_t (*chip_readl) (const struct flashctx *flash, const chipaddr addr);
639 void (*chip_readn) (const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Edward O'Callaghan20596a82019-06-13 14:47:03 +1000640 const void *data;
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700641};
Craig Hesling65eb8812019-08-01 09:33:56 -0700642extern const struct par_master *par_master;
643void register_par_master(const struct par_master *pgm, const enum chipbustype buses);
Edward O'Callaghan20596a82019-06-13 14:47:03 +1000644struct registered_master {
645 enum chipbustype buses_supported;
646 union {
647 struct par_master par;
648 struct spi_master spi;
Edward O'Callaghanabd30192019-05-14 15:58:19 +1000649 struct opaque_master opaque;
Edward O'Callaghan20596a82019-06-13 14:47:03 +1000650 };
651};
652extern struct registered_master registered_masters[];
653extern int registered_master_count;
654int register_master(const struct registered_master *mst);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700655
hailfinger428f6852010-07-27 22:41:39 +0000656/* serprog.c */
hailfingere20dc562011-06-09 20:06:34 +0000657#if CONFIG_SERPROG == 1
David Hendricksac1d25c2016-08-09 17:00:58 -0700658int serprog_init(void);
Edward O'Callaghan8ebbd502019-09-03 15:11:02 +1000659void serprog_delay(unsigned int usecs);
hailfingere20dc562011-06-09 20:06:34 +0000660#endif
hailfinger428f6852010-07-27 22:41:39 +0000661
662/* serial.c */
Kangheui Won0c485a72019-09-10 14:27:04 +1000663#if IS_WINDOWS
hailfinger428f6852010-07-27 22:41:39 +0000664typedef HANDLE fdtype;
Kangheui Won0c485a72019-09-10 14:27:04 +1000665#define SER_INV_FD INVALID_HANDLE_VALUE
hailfinger428f6852010-07-27 22:41:39 +0000666#else
667typedef int fdtype;
Kangheui Won0c485a72019-09-10 14:27:04 +1000668#define SER_INV_FD -1
hailfinger428f6852010-07-27 22:41:39 +0000669#endif
670
David Hendricksc801adb2010-12-09 16:58:56 -0800671/* wpce775x.c */
David Hendricksac1d25c2016-08-09 17:00:58 -0700672int wpce775x_probe_spi_flash(const char *name);
David Hendricksc801adb2010-12-09 16:58:56 -0800673
Simon Glasscd597032013-05-23 17:18:44 -0700674/**
675 * Probe the Google Chrome OS EC device
676 *
677 * @return 0 if found correct, non-zero if not found or error
678 */
David Hendricksac1d25c2016-08-09 17:00:58 -0700679int cros_ec_probe_dev(void);
Simon Glasscd597032013-05-23 17:18:44 -0700680
David Hendricksac1d25c2016-08-09 17:00:58 -0700681int cros_ec_need_2nd_pass(void);
682int cros_ec_finish(void);
683int cros_ec_prepare(uint8_t *image, int size);
Louis Yung-Chieh Loedb0cba2011-12-09 17:06:54 +0800684
hailfinger428f6852010-07-27 22:41:39 +0000685void sp_flush_incoming(void);
Kangheui Won0c485a72019-09-10 14:27:04 +1000686fdtype sp_openserport(char *dev, int baud);
hailfinger428f6852010-07-27 22:41:39 +0000687extern fdtype sp_fd;
Kangheui Won0c485a72019-09-10 14:27:04 +1000688int serialport_config(fdtype fd, int baud);
dhendrix0ffc2eb2011-06-14 01:35:36 +0000689int serialport_shutdown(void *data);
Kangheui Won0c485a72019-09-10 14:27:04 +1000690int serialport_write(const unsigned char *buf, unsigned int writecnt);
691int serialport_write_nonblock(const unsigned char *buf, unsigned int writecnt, unsigned int timeout, unsigned int *really_wrote);
hailfinger428f6852010-07-27 22:41:39 +0000692int serialport_read(unsigned char *buf, unsigned int readcnt);
Kangheui Won0c485a72019-09-10 14:27:04 +1000693int serialport_read_nonblock(unsigned char *c, unsigned int readcnt, unsigned int timeout, unsigned int *really_read);
694
695/* Serial port/pin mapping:
696
697 1 CD <-
698 2 RXD <-
699 3 TXD ->
700 4 DTR ->
701 5 GND --
702 6 DSR <-
703 7 RTS ->
704 8 CTS <-
705 9 RI <-
706*/
707enum SP_PIN {
708 PIN_CD = 1,
709 PIN_RXD,
710 PIN_TXD,
711 PIN_DTR,
712 PIN_GND,
713 PIN_DSR,
714 PIN_RTS,
715 PIN_CTS,
716 PIN_RI,
717};
718
719void sp_set_pin(enum SP_PIN pin, int val);
720int sp_get_pin(enum SP_PIN pin);
721
Edward O'Callaghandaf990f2019-11-11 14:57:13 +1100722/* spi_master feature checks */
723static inline bool spi_master_4ba(const struct flashctx *const flash)
724{
725 return flash->mst->buses_supported & BUS_SPI &&
726 flash->mst->spi.features & SPI_MASTER_4BA;
727}
728static inline bool spi_master_no_4ba_modes(const struct flashctx *const flash)
729{
730 return flash->mst->buses_supported & BUS_SPI &&
731 flash->mst->spi.features & SPI_MASTER_NO_4BA_MODES;
732}
hailfinger428f6852010-07-27 22:41:39 +0000733
Edward O'Callaghana88395f2019-02-27 18:44:04 +1100734/* usbdev.c */
735struct libusb_device_handle;
736struct libusb_context;
737struct libusb_device_handle *usb_dev_get_by_vid_pid_serial(
738 struct libusb_context *usb_ctx, uint16_t vid, uint16_t pid, const char *serialno);
739struct libusb_device_handle *usb_dev_get_by_vid_pid_number(
740 struct libusb_context *usb_ctx, uint16_t vid, uint16_t pid, unsigned int num);
741
Shiyu Sun9dde7162020-04-16 17:32:55 +1000742/* lspcon_i2c_spi.c */
743#if CONFIG_LSPCON_I2C_SPI == 1
744int lspcon_i2c_spi_init(void);
745#endif
746
Edward O'Callaghan97dd9262020-03-26 00:00:41 +1100747/* realtek_mst_i2c_spi.c */
748#if CONFIG_REALTEK_MST_I2C_SPI == 1
749int realtek_mst_i2c_spi_init(void);
750#endif
751
hailfinger428f6852010-07-27 22:41:39 +0000752#endif /* !__PROGRAMMER_H__ */