blob: 4fee2ef42254b4bd88a098e67763e6768a0bfe7e [file] [log] [blame]
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2000 Ronald G. Minnich <rminnich@gmail.com>
6 * Copyright (C) 2005-2009 coresystems GmbH
7 * Copyright (C) 2006-2009 Carl-Daniel Hailfinger
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000018 */
19
20#ifndef __PROGRAMMER_H__
21#define __PROGRAMMER_H__ 1
22
Felix Singerb8db74a2022-08-19 00:19:26 +020023#include <stdbool.h>
Nico Huber1cf407b2017-11-10 20:18:23 +010024#include <stdint.h>
Nico Huber019810f2023-01-29 17:11:24 +000025#include <stdbool.h>
Nico Huber1cf407b2017-11-10 20:18:23 +010026
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000027#include "flash.h" /* for chipaddr and flashctx */
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000028
Stefan Tauneraf358d62012-12-27 18:40:26 +000029enum programmer_type {
30 PCI = 1, /* to detect uninitialized values */
31 USB,
32 OTHER,
33};
34
Stefan Tauner4b24a2d2012-12-27 18:40:36 +000035struct dev_entry {
36 uint16_t vendor_id;
37 uint16_t device_id;
38 const enum test_state status;
39 const char *vendor_name;
40 const char *device_name;
41};
42
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000043struct programmer_entry {
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000044 const char *name;
Stefan Tauneraf358d62012-12-27 18:40:26 +000045 const enum programmer_type type;
46 union {
Stefan Tauner4b24a2d2012-12-27 18:40:36 +000047 const struct dev_entry *const dev;
Stefan Tauneraf358d62012-12-27 18:40:26 +000048 const char *const note;
49 } devs;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000050
51 int (*init) (void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000052
Stefan Tauner305e0b92013-07-17 23:46:44 +000053 void *(*map_flash_region) (const char *descr, uintptr_t phys_addr, size_t len);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000054 void (*unmap_flash_region) (void *virt_addr, size_t len);
55
Stefan Taunerf80419c2014-05-02 15:41:42 +000056 void (*delay) (unsigned int usecs);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000057};
58
Thomas Heijligen633d6db2021-03-31 19:09:44 +020059extern const struct programmer_entry *const programmer_table[];
Thomas Heijligend0fcce22021-05-19 13:53:34 +020060extern const size_t programmer_table_size;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000061
Thomas Heijligen40d32332021-06-10 15:17:53 +020062/* programmer drivers */
Thomas Heijligen40d32332021-06-10 15:17:53 +020063extern const struct programmer_entry programmer_atahpt;
Thomas Heijligen40d32332021-06-10 15:17:53 +020064extern const struct programmer_entry programmer_atapromise;
Thomas Heijligen1535db42021-06-14 13:20:09 +020065extern const struct programmer_entry programmer_atavia;
Thomas Heijligen40d32332021-06-10 15:17:53 +020066extern const struct programmer_entry programmer_buspirate_spi;
Thomas Heijligen1535db42021-06-14 13:20:09 +020067extern const struct programmer_entry programmer_ch341a_spi;
Nicholas Chin197b7c72022-10-23 13:10:31 -060068extern const struct programmer_entry programmer_ch347_spi;
Thomas Heijligen40d32332021-06-10 15:17:53 +020069extern const struct programmer_entry programmer_dediprog;
70extern const struct programmer_entry programmer_developerbox;
Thomas Heijligen40d32332021-06-10 15:17:53 +020071extern const struct programmer_entry programmer_digilent_spi;
Thomas Heijligen1535db42021-06-14 13:20:09 +020072extern const struct programmer_entry programmer_drkaiser;
73extern const struct programmer_entry programmer_dummy;
74extern const struct programmer_entry programmer_ft2232_spi;
75extern const struct programmer_entry programmer_gfxnvidia;
76extern const struct programmer_entry programmer_internal;
77extern const struct programmer_entry programmer_it8212;
Thomas Heijligen40d32332021-06-10 15:17:53 +020078extern const struct programmer_entry programmer_jlink_spi;
Steve Markgraf61899472023-01-09 23:06:52 +010079extern const struct programmer_entry programmer_linux_gpio_spi;
Thomas Heijligen1535db42021-06-14 13:20:09 +020080extern const struct programmer_entry programmer_linux_mtd;
81extern const struct programmer_entry programmer_linux_spi;
82extern const struct programmer_entry programmer_mstarddc_spi;
Thomas Heijligen40d32332021-06-10 15:17:53 +020083extern const struct programmer_entry programmer_ni845x_spi;
Thomas Heijligen1535db42021-06-14 13:20:09 +020084extern const struct programmer_entry programmer_nic3com;
85extern const struct programmer_entry programmer_nicintel;
86extern const struct programmer_entry programmer_nicintel_eeprom;
87extern const struct programmer_entry programmer_nicintel_spi;
88extern const struct programmer_entry programmer_nicnatsemi;
89extern const struct programmer_entry programmer_nicrealtek;
90extern const struct programmer_entry programmer_ogp_spi;
91extern const struct programmer_entry programmer_pickit2_spi;
92extern const struct programmer_entry programmer_pony_spi;
93extern const struct programmer_entry programmer_rayer_spi;
94extern const struct programmer_entry programmer_satamv;
95extern const struct programmer_entry programmer_satasii;
Thomas Heijligen40d32332021-06-10 15:17:53 +020096extern const struct programmer_entry programmer_serprog;
Thomas Heijligen1535db42021-06-14 13:20:09 +020097extern const struct programmer_entry programmer_stlinkv3_spi;
98extern const struct programmer_entry programmer_usbblaster_spi;
Jean THOMASe28d8e42022-10-11 17:54:30 +020099extern const struct programmer_entry programmer_dirtyjtag_spi;
Thomas Heijligen40d32332021-06-10 15:17:53 +0200100
Thomas Heijligene0e93cf2021-06-01 14:37:12 +0200101int programmer_init(const struct programmer_entry *prog, const char *param);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000102int programmer_shutdown(void);
103
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000104struct bitbang_spi_master {
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000105 /* Note that CS# is active low, so val=0 means the chip is active. */
Anastasia Klimchuk0e788182021-05-26 09:54:08 +1000106 void (*set_cs) (int val, void *spi_data);
107 void (*set_sck) (int val, void *spi_data);
108 void (*set_mosi) (int val, void *spi_data);
109 int (*get_miso) (void *spi_data);
110 void (*request_bus) (void *spi_data);
111 void (*release_bus) (void *spi_data);
Daniel Thompsonb623f402018-06-05 09:38:19 +0100112 /* optional functions to optimize xfers */
Anastasia Klimchuk0e788182021-05-26 09:54:08 +1000113 void (*set_sck_set_mosi) (int sck, int mosi, void *spi_data);
114 int (*set_sck_get_miso) (int sck, void *spi_data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000115 /* Length of half a clock period in usecs. */
116 unsigned int half_period;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000117};
118
Patrick Georgi32508eb2012-07-20 20:35:14 +0000119struct pci_dev;
Edward O'Callaghan15004ba2021-11-13 13:14:06 +1100120struct pci_filter;
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000121
122/* pcidev.c */
Stefan Tauner0ccec8f2014-06-01 23:49:03 +0000123// FIXME: This needs to be local, not global(?)
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000124extern struct pci_access *pacc;
125int pci_init_common(void);
126uintptr_t pcidev_readbar(struct pci_dev *dev, int bar);
127struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar);
Edward O'Callaghan15004ba2021-11-13 13:14:06 +1100128struct pci_dev *pcidev_scandev(struct pci_filter *filter, struct pci_dev *start);
Edward O'Callaghan48a94662022-02-26 11:36:17 +1100129struct pci_dev *pcidev_find_vendorclass(uint16_t vendor, uint16_t devclass);
Edward O'Callaghan6c73e272021-11-13 17:56:20 +1100130struct pci_dev *pcidev_card_find(uint16_t vendor, uint16_t device, uint16_t card_vendor, uint16_t card_device);
Edward O'Callaghan19ce50d2021-11-13 17:59:18 +1100131struct pci_dev *pcidev_find(uint16_t vendor, uint16_t device);
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000132/* rpci_write_* are reversible writes. The original PCI config space register
133 * contents will be restored on shutdown.
Youness Alaouia54ceb12017-07-26 18:03:36 -0400134 * To clone the pci_dev instances internally, the `pacc` global
135 * variable has to reference a pci_access method that is compatible
136 * with the given pci_dev handle. The referenced pci_access (not
137 * the variable) has to stay valid until the shutdown handlers are
138 * finished.
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000139 */
140int rpci_write_byte(struct pci_dev *dev, int reg, uint8_t data);
141int rpci_write_word(struct pci_dev *dev, int reg, uint16_t data);
142int rpci_write_long(struct pci_dev *dev, int reg, uint32_t data);
Carl-Daniel Hailfingera2faddf2013-01-05 23:52:45 +0000143
144#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000145struct penable {
146 uint16_t vendor_id;
147 uint16_t device_id;
Nico Huber019810f2023-01-29 17:11:24 +0000148 bool match_revision;
149 uint8_t revision_id;
Nico Huber2e50cdc2018-09-23 20:20:26 +0200150 enum chipbustype buses;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000151 const enum test_state status;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000152 const char *vendor_name;
153 const char *device_name;
154 int (*doit) (struct pci_dev *dev, const char *name);
155};
156
157extern const struct penable chipset_enables[];
158
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000159enum board_match_phase {
160 P1,
161 P2,
162 P3
163};
164
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +0000165struct board_match {
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000166 /* Any device, but make it sensible, like the ISA bridge. */
167 uint16_t first_vendor;
168 uint16_t first_device;
169 uint16_t first_card_vendor;
170 uint16_t first_card_device;
171
172 /* Any device, but make it sensible, like
173 * the host bridge. May be NULL.
174 */
175 uint16_t second_vendor;
176 uint16_t second_device;
177 uint16_t second_card_vendor;
178 uint16_t second_card_device;
179
Stefan Tauner7bcacb12011-05-26 01:35:19 +0000180 /* Pattern to match DMI entries. May be NULL. */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000181 const char *dmi_pattern;
182
Stefan Tauner7bcacb12011-05-26 01:35:19 +0000183 /* The vendor / part name from the coreboot table. May be NULL. */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000184 const char *lb_vendor;
185 const char *lb_part;
186
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000187 enum board_match_phase phase;
188
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000189 const char *vendor_name;
190 const char *board_name;
191
192 int max_rom_decode_parallel;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000193 const enum test_state status;
Stefan Tauner7bcacb12011-05-26 01:35:19 +0000194 int (*enable) (void); /* May be NULL. */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000195};
196
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +0000197extern const struct board_match board_matches[];
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000198
199struct board_info {
200 const char *vendor;
201 const char *name;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000202 const enum test_state working;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000203#ifdef CONFIG_PRINT_WIKI
204 const char *url;
205 const char *note;
206#endif
207};
208
209extern const struct board_info boards_known[];
210extern const struct board_info laptops_known[];
211#endif
212
213/* udelay.c */
Stefan Taunerf80419c2014-05-02 15:41:42 +0000214void myusec_delay(unsigned int usecs);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000215void myusec_calibrate_delay(void);
Stefan Taunerf80419c2014-05-02 15:41:42 +0000216void internal_sleep(unsigned int usecs);
217void internal_delay(unsigned int usecs);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000218
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000219#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000220/* board_enable.c */
Stefan Tauner600576b2014-06-12 22:57:36 +0000221int selfcheck_board_enables(void);
Jacob Garber1c091d12019-08-12 11:14:14 -0600222int board_parse_parameter(const char *boardstring, char **vendor, char **model);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000223void w836xx_ext_enter(uint16_t port);
224void w836xx_ext_leave(uint16_t port);
Carl-Daniel Hailfingerf5e62cb2012-05-06 22:48:01 +0000225void probe_superio_winbond(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000226int it8705f_write_enable(uint8_t port);
227uint8_t sio_read(uint16_t port, uint8_t reg);
228void sio_write(uint16_t port, uint8_t reg, uint8_t data);
229void sio_mask(uint16_t port, uint8_t reg, uint8_t data, uint8_t mask);
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000230void board_handle_before_superio(void);
231void board_handle_before_laptop(void);
Stefan Taunerfa9fa712012-09-24 21:29:29 +0000232int board_flash_enable(const char *vendor, const char *model, const char *cb_vendor, const char *cb_model);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000233
234/* chipset_enable.c */
235int chipset_flash_enable(void);
236
237/* processor_enable.c */
238int processor_flash_enable(void);
Carl-Daniel Hailfinger580d29a2011-05-05 07:12:40 +0000239#endif
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000240
Thomas Heijligenb3287b42021-12-14 17:25:49 +0100241#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000242/* cbtable.c */
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000243int cb_parse_table(const char **vendor, const char **model);
Nico Huber519be662018-12-23 20:03:35 +0100244int cb_check_image(const uint8_t *bios, unsigned int size);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000245
246/* dmi.c */
Sean Nelson4c6d3a42013-09-11 23:35:03 +0000247#if defined(__i386__) || defined(__x86_64__)
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000248extern int has_dmi_support;
249void dmi_init(void);
250int dmi_match(const char *pattern);
Sean Nelson4c6d3a42013-09-11 23:35:03 +0000251#endif // defined(__i386__) || defined(__x86_64__)
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000252
253/* internal.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000254struct superio {
255 uint16_t vendor;
256 uint16_t port;
257 uint16_t model;
258};
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000259extern struct superio superios[];
260extern int superio_count;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000261#define SUPERIO_VENDOR_NONE 0x0
262#define SUPERIO_VENDOR_ITE 0x1
Carl-Daniel Hailfingerf5e62cb2012-05-06 22:48:01 +0000263#define SUPERIO_VENDOR_WINBOND 0x2
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000264#endif
Edward O'Callaghan19ce50d2021-11-13 17:59:18 +1100265
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000266#if CONFIG_INTERNAL == 1
267extern int is_laptop;
Felix Singerd1ab7d22022-08-19 03:03:47 +0200268extern bool laptop_ok;
Felix Singerb8db74a2022-08-19 00:19:26 +0200269extern bool force_boardenable;
270extern bool force_boardmismatch;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000271void probe_superio(void);
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000272int register_superio(struct superio s);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000273extern enum chipbustype internal_buses_supported;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000274#endif
275
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000276/* bitbang_spi.c */
Anastasia Klimchuka447c122021-05-31 11:20:01 +1000277int register_spi_bitbang_master(const struct bitbang_spi_master *master, void *spi_data);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000278
Miklós Márton2d20d6d2018-01-30 20:20:15 +0100279
Nico Huberc3b02dc2023-08-12 01:13:45 +0200280/* flashprog.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000281struct decode_sizes {
282 uint32_t parallel;
283 uint32_t lpc;
284 uint32_t fwh;
285 uint32_t spi;
286};
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000287// FIXME: These need to be local, not global
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000288extern struct decode_sizes max_rom_decode;
Felix Singer980d6b82022-08-19 02:48:15 +0200289extern bool programmer_may_write;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000290extern unsigned long flashbase;
Stefan Tauner66652442011-06-26 17:38:17 +0000291char *extract_programmer_param(const char *param_name);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000292
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000293/* spi.c */
Michael Karcher62797512011-05-11 17:07:02 +0000294#define MAX_DATA_UNSPECIFIED 0
295#define MAX_DATA_READ_UNLIMITED 64 * 1024
296#define MAX_DATA_WRITE_UNLIMITED 256
Nico Huber1cf407b2017-11-10 20:18:23 +0100297
298#define SPI_MASTER_4BA (1U << 0) /**< Can handle 4-byte addresses */
Nico Huberdc5af542018-12-22 16:54:59 +0100299#define SPI_MASTER_NO_4BA_MODES (1U << 1) /**< Compatibility modes (i.e. extended address
300 register, 4BA mode switch) don't work */
Nico Huber1cf407b2017-11-10 20:18:23 +0100301
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000302struct spi_master {
Nico Huber1cf407b2017-11-10 20:18:23 +0100303 uint32_t features;
Stefan Tauner23e10b82016-01-23 16:16:49 +0000304 unsigned int max_data_read; // (Ideally,) maximum data read size in one go (excluding opcode+address).
305 unsigned int max_data_write; // (Ideally,) maximum data write size in one go (excluding opcode+address).
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000306 int (*command)(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000307 const unsigned char *writearr, unsigned char *readarr);
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000308 int (*multicommand)(const struct flashctx *flash, struct spi_command *cmds);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000309
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000310 /* Optimized functions for this master */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000311 int (*read)(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000312 int (*write_256)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
313 int (*write_aai)(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Anastasia Klimchuk7783f2f2021-07-05 09:18:06 +1000314 int (*shutdown)(void *data);
Nikolai Artemieve7a41e32022-11-28 17:40:56 +1100315 bool (*probe_opcode)(const struct flashctx *flash, uint8_t opcode);
Edward O'Callaghan13f90e62021-01-06 14:10:52 +1100316 void *data;
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000317};
318
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000319int default_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000320 const unsigned char *writearr, unsigned char *readarr);
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000321int default_spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000322int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000323int default_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
324int default_spi_write_aai(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Nikolai Artemieve7a41e32022-11-28 17:40:56 +1100325bool default_spi_probe_opcode(const struct flashctx *flash, uint8_t opcode);
Nico Huber5e08e3e2021-05-11 17:38:14 +0200326int register_spi_master(const struct spi_master *mst, void *data);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000327
Kyösti Mälkki78cd0872013-09-14 23:36:57 +0000328/* The following enum is needed by ich_descriptor_tool and ich* code as well as in chipset_enable.c. */
Stefan Taunera8d838d2011-11-06 23:51:09 +0000329enum ich_chipset {
330 CHIPSET_ICH_UNKNOWN,
Stefan Tauner92d6a862013-10-25 00:33:37 +0000331 CHIPSET_ICH,
332 CHIPSET_ICH2345,
Kyösti Mälkki78cd0872013-09-14 23:36:57 +0000333 CHIPSET_ICH6,
Stefan Tauner92d6a862013-10-25 00:33:37 +0000334 CHIPSET_POULSBO, /* SCH U* */
335 CHIPSET_TUNNEL_CREEK, /* Atom E6xx */
336 CHIPSET_CENTERTON, /* Atom S1220 S1240 S1260 */
Kyösti Mälkki78cd0872013-09-14 23:36:57 +0000337 CHIPSET_ICH7,
Stefan Taunera8d838d2011-11-06 23:51:09 +0000338 CHIPSET_ICH8,
339 CHIPSET_ICH9,
340 CHIPSET_ICH10,
341 CHIPSET_5_SERIES_IBEX_PEAK,
342 CHIPSET_6_SERIES_COUGAR_POINT,
Stefan Tauner2abab942012-04-27 20:41:23 +0000343 CHIPSET_7_SERIES_PANTHER_POINT,
Duncan Laurie90eb2262013-03-15 03:12:29 +0000344 CHIPSET_8_SERIES_LYNX_POINT,
Duncan Laurie4095ed72014-08-20 15:39:32 +0000345 CHIPSET_BAYTRAIL, /* Actually all with Silvermont architecture: Bay Trail, Avoton/Rangeley */
Duncan Laurie90eb2262013-03-15 03:12:29 +0000346 CHIPSET_8_SERIES_LYNX_POINT_LP,
347 CHIPSET_8_SERIES_WELLSBURG,
Duncan Laurie823096e2014-08-20 15:39:38 +0000348 CHIPSET_9_SERIES_WILDCAT_POINT,
Nico Huber51205912017-03-17 17:59:54 +0100349 CHIPSET_9_SERIES_WILDCAT_POINT_LP,
Nico Huber93c30692017-03-20 14:25:09 +0100350 CHIPSET_100_SERIES_SUNRISE_POINT, /* also 6th/7th gen Core i/o (LP) variants */
David Hendricksa5216362017-08-08 20:02:22 -0700351 CHIPSET_C620_SERIES_LEWISBURG,
Thomas Heijligen5ec84b32019-03-19 17:00:03 +0100352 CHIPSET_300_SERIES_CANNON_POINT,
Michał Żygowski5c9f5422021-06-16 15:13:54 +0200353 CHIPSET_500_SERIES_TIGER_POINT,
Nico Huber37509862019-01-18 14:23:02 +0100354 CHIPSET_APOLLO_LAKE,
Angel Pons4db0fdf2020-07-10 17:04:10 +0200355 CHIPSET_GEMINI_LAKE,
Werner Zehe57d4e42022-01-03 09:44:29 +0100356 CHIPSET_ELKHART_LAKE,
Stefan Taunera8d838d2011-11-06 23:51:09 +0000357};
358
Stefan Tauner2abab942012-04-27 20:41:23 +0000359/* ichspi.c */
360#if CONFIG_INTERNAL == 1
Nico Huber560111e2017-04-26 12:27:17 +0200361int ich_init_spi(void *spibar, enum ich_chipset ich_generation);
362int via_init_spi(uint32_t mmio_base);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000363
Stefan Taunerdbac46c2013-08-13 22:10:41 +0000364/* amd_imc.c */
Nico Huber4d51e072023-01-29 17:56:29 +0000365int handle_imc(struct pci_dev *);
Rudolf Marek70e14592013-07-25 22:58:56 +0000366
Nico Huber735b1862023-01-29 18:28:45 +0000367/* amd_spi100.c */
Nico Hubere3c305d2023-01-29 21:45:56 +0000368int amd_spi100_probe(void *const spibar, void *const memory_mapping, const size_t mapped_len);
Nico Huber735b1862023-01-29 18:28:45 +0000369
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000370/* it87spi.c */
371void enter_conf_mode_ite(uint16_t port);
372void exit_conf_mode_ite(uint16_t port);
Carl-Daniel Hailfingerbfecef62011-04-27 14:34:08 +0000373void probe_superio_ite(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000374int init_superio_ite(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000375
Nico Huber2f753792023-03-28 00:46:50 +0200376#if CONFIG_LINUX_MTD == 1 && LINUX_MTD_AS_INTERNAL == 1
David Hendricksf9a30552015-05-23 20:30:30 -0700377/* trivial wrapper to avoid cluttering internal_init() with #if */
Thomas Heijligencc853d82021-05-04 15:32:17 +0200378static inline int try_mtd(void) { return programmer_linux_mtd.init(); };
David Hendricksf9a30552015-05-23 20:30:30 -0700379#else
380static inline int try_mtd(void) { return 1; };
381#endif
382
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +0000383/* mcp6x_spi.c */
384int mcp6x_spi_init(int want_spi);
385
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000386/* sb600spi.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000387int sb600_probe_spi(struct pci_dev *dev);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000388
389/* wbsio_spi.c */
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000390int wbsio_check_for_spi(void);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000391#endif
392
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000393/* opaque.c */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000394struct opaque_master {
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000395 int max_data_read;
396 int max_data_write;
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000397 /* Specific functions for this master */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000398 int (*probe) (struct flashctx *flash);
399 int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000400 int (*write) (struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000401 int (*erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Anastasia Klimchuka1fed9f2021-08-03 14:08:02 +1000402 int (*shutdown)(void *data);
Edward O'Callaghan13f90e62021-01-06 14:10:52 +1100403 void *data;
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000404};
Anastasia Klimchuk21b20212021-05-13 12:28:47 +1000405int register_opaque_master(const struct opaque_master *mst, void *data);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000406
Edward O'Callaghan63f6a372022-08-12 12:56:43 +1000407/* parallel.c */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000408struct par_master {
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000409 void (*chip_writeb) (const struct flashctx *flash, uint8_t val, chipaddr addr);
410 void (*chip_writew) (const struct flashctx *flash, uint16_t val, chipaddr addr);
411 void (*chip_writel) (const struct flashctx *flash, uint32_t val, chipaddr addr);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000412 void (*chip_writen) (const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000413 uint8_t (*chip_readb) (const struct flashctx *flash, const chipaddr addr);
414 uint16_t (*chip_readw) (const struct flashctx *flash, const chipaddr addr);
415 uint32_t (*chip_readl) (const struct flashctx *flash, const chipaddr addr);
416 void (*chip_readn) (const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Anastasia Klimchuke6953e52021-08-26 10:10:32 +1000417 int (*shutdown)(void *data);
Edward O'Callaghan13f90e62021-01-06 14:10:52 +1100418 void *data;
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000419};
Anastasia Klimchukb91a2032021-05-21 09:40:58 +1000420int register_par_master(const struct par_master *mst, const enum chipbustype buses, void *data);
Edward O'Callaghan63f6a372022-08-12 12:56:43 +1000421
422/* programmer.c */
423void *fallback_map(const char *descr, uintptr_t phys_addr, size_t len);
424void fallback_unmap(void *virt_addr, size_t len);
425void fallback_chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr);
426void fallback_chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr);
427void fallback_chip_writen(const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len);
428uint16_t fallback_chip_readw(const struct flashctx *flash, const chipaddr addr);
429uint32_t fallback_chip_readl(const struct flashctx *flash, const chipaddr addr);
430void fallback_chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000431struct registered_master {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000432 enum chipbustype buses_supported;
433 union {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000434 struct par_master par;
435 struct spi_master spi;
436 struct opaque_master opaque;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000437 };
438};
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000439extern struct registered_master registered_masters[];
440extern int registered_master_count;
Stefan Tauner5c316f92015-02-08 21:57:52 +0000441int register_master(const struct registered_master *mst);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000442
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000443
444/* serial.c */
Stefan Taunerb0eee9b2015-01-10 09:32:50 +0000445#if IS_WINDOWS
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000446typedef HANDLE fdtype;
Stefan Taunerbb4fed72012-09-01 21:47:19 +0000447#define SER_INV_FD INVALID_HANDLE_VALUE
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000448#else
449typedef int fdtype;
Stefan Taunerbb4fed72012-09-01 21:47:19 +0000450#define SER_INV_FD -1
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000451#endif
452
453void sp_flush_incoming(void);
Stefan Tauner72587f82016-01-04 03:05:15 +0000454fdtype sp_openserport(char *dev, int baud);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000455extern fdtype sp_fd;
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600456int serialport_config(fdtype fd, int baud);
David Hendricks8bb20212011-06-14 01:35:36 +0000457int serialport_shutdown(void *data);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000458int serialport_write(const unsigned char *buf, unsigned int writecnt);
459int serialport_write_nonblock(const unsigned char *buf, unsigned int writecnt, unsigned int timeout, unsigned int *really_wrote);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000460int serialport_read(unsigned char *buf, unsigned int readcnt);
Stefan Tauner00e16082013-04-01 00:45:38 +0000461int serialport_read_nonblock(unsigned char *c, unsigned int readcnt, unsigned int timeout, unsigned int *really_read);
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000462
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +0000463/* Serial port/pin mapping:
464
465 1 CD <-
466 2 RXD <-
467 3 TXD ->
468 4 DTR ->
469 5 GND --
470 6 DSR <-
471 7 RTS ->
472 8 CTS <-
473 9 RI <-
474*/
475enum SP_PIN {
476 PIN_CD = 1,
477 PIN_RXD,
478 PIN_TXD,
479 PIN_DTR,
480 PIN_GND,
481 PIN_DSR,
482 PIN_RTS,
483 PIN_CTS,
484 PIN_RI,
485};
486
487void sp_set_pin(enum SP_PIN pin, int val);
488int sp_get_pin(enum SP_PIN pin);
489
Nico Huber1cf407b2017-11-10 20:18:23 +0100490/* spi_master feature checks */
491static inline bool spi_master_4ba(const struct flashctx *const flash)
492{
493 return flash->mst->buses_supported & BUS_SPI &&
494 flash->mst->spi.features & SPI_MASTER_4BA;
495}
Nico Huberdc5af542018-12-22 16:54:59 +0100496static inline bool spi_master_no_4ba_modes(const struct flashctx *const flash)
497{
498 return flash->mst->buses_supported & BUS_SPI &&
499 flash->mst->spi.features & SPI_MASTER_NO_4BA_MODES;
500}
Nico Huber1cf407b2017-11-10 20:18:23 +0100501
Daniel Thompson1d507a02018-07-12 11:02:28 +0100502/* usbdev.c */
503struct libusb_device_handle;
504struct libusb_context;
505struct libusb_device_handle *usb_dev_get_by_vid_pid_serial(
506 struct libusb_context *usb_ctx, uint16_t vid, uint16_t pid, const char *serialno);
507struct libusb_device_handle *usb_dev_get_by_vid_pid_number(
508 struct libusb_context *usb_ctx, uint16_t vid, uint16_t pid, unsigned int num);
509
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +0000510#endif /* !__PROGRAMMER_H__ */