blob: a80a9c249b9bb4b34a730d374ed2ae8692478cc3 [file] [log] [blame]
Adam Kaufman064b1f22007-02-06 19:47:50 +00001/*
Uwe Hermannd1107642007-08-29 17:52:32 +00002 * This file is part of the flashrom project.
Adam Kaufman064b1f22007-02-06 19:47:50 +00003 *
Uwe Hermannd22a1d42007-09-09 20:21:05 +00004 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2000 Ronald G. Minnich <rminnich@gmail.com>
Stefan Reinauer8fa64812009-08-12 09:27:45 +00006 * Copyright (C) 2005-2009 coresystems GmbH
Carl-Daniel Hailfingera0a6ae92009-06-15 12:10:57 +00007 * Copyright (C) 2006-2009 Carl-Daniel Hailfinger
Adam Kaufman064b1f22007-02-06 19:47:50 +00008 *
Uwe Hermannd1107642007-08-29 17:52:32 +00009 * 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.
Adam Kaufman064b1f22007-02-06 19:47:50 +000013 *
Uwe Hermannd1107642007-08-29 17:52:32 +000014 * 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.
Adam Kaufman064b1f22007-02-06 19:47:50 +000018 *
Uwe Hermannd1107642007-08-29 17:52:32 +000019 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Adam Kaufman064b1f22007-02-06 19:47:50 +000022 */
23
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000024#ifndef __FLASH_H__
25#define __FLASH_H__ 1
26
Stefan Taunerb0eee9b2015-01-10 09:32:50 +000027#include "platform.h"
28
Stefan Tauner0466c812013-06-16 10:30:08 +000029#include <inttypes.h>
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +000030#include <stdio.h>
Ollie Lho184a4042005-11-26 21:55:36 +000031#include <stdint.h>
Carl-Daniel Hailfingerdd128c92010-06-03 00:49:50 +000032#include <stddef.h>
Nico Huber18781102012-12-10 13:34:12 +000033#include <stdarg.h>
Stefan Tauner682122b2013-06-23 22:15:39 +000034#include <stdbool.h>
Stefan Taunerb0eee9b2015-01-10 09:32:50 +000035#if IS_WINDOWS
Patrick Georgie48654c2010-01-06 22:14:39 +000036#include <windows.h>
37#undef min
38#undef max
39#endif
Andriy Gapon65c1b862008-05-22 13:22:45 +000040
Nico Huberd152fb92017-06-19 12:57:10 +020041#include "libflashrom.h"
Nico Huber3a9939b2016-04-27 15:56:14 +020042#include "layout.h"
43
Patrick Georgied7a9642010-09-25 22:53:44 +000044#define ERROR_PTR ((void*)-1)
45
Carl-Daniel Hailfinger174f55b2010-10-08 00:37:55 +000046/* Error codes */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +000047#define ERROR_OOM -100
Carl-Daniel Hailfinger174f55b2010-10-08 00:37:55 +000048#define TIMEOUT_ERROR -101
49
Stefan Taunerc2333752013-07-13 23:31:37 +000050/* TODO: check using code for correct usage of types */
51typedef uintptr_t chipaddr;
Stefan Tauner305e0b92013-07-17 23:46:44 +000052#define PRIxPTR_WIDTH ((int)(sizeof(uintptr_t)*2))
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +000053
David Hendricks8bb20212011-06-14 01:35:36 +000054int register_shutdown(int (*function) (void *data), void *data);
Stefan Tauner2a1ed772014-08-31 00:09:21 +000055int shutdown_free(void *data);
Stefan Tauner305e0b92013-07-17 23:46:44 +000056void *programmer_map_flash_region(const char *descr, uintptr_t phys_addr, size_t len);
Uwe Hermann09e04f72009-05-16 22:36:00 +000057void programmer_unmap_flash_region(void *virt_addr, size_t len);
Stefan Taunerf80419c2014-05-02 15:41:42 +000058void programmer_delay(unsigned int usecs);
Carl-Daniel Hailfinger61a8bd22009-03-05 19:24:22 +000059
Uwe Hermanne5ac1642008-03-12 11:54:51 +000060#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
61
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000062enum chipbustype {
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +000063 BUS_NONE = 0,
64 BUS_PARALLEL = 1 << 0,
65 BUS_LPC = 1 << 1,
66 BUS_FWH = 1 << 2,
67 BUS_SPI = 1 << 3,
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000068 BUS_PROG = 1 << 4,
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +000069 BUS_NONSPI = BUS_PARALLEL | BUS_LPC | BUS_FWH,
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000070};
71
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000072/*
Stefan Tauner02437452013-04-01 19:34:53 +000073 * The following enum defines possible write granularities of flash chips. These tend to reflect the properties
74 * of the actual hardware not necesserily the write function(s) defined by the respective struct flashchip.
75 * The latter might (and should) be more precisely specified, e.g. they might bail out early if their execution
76 * would result in undefined chip contents.
Stefan Taunereb582572012-09-21 12:52:50 +000077 */
78enum write_granularity {
Stefan Tauner02437452013-04-01 19:34:53 +000079 /* We assume 256 byte granularity by default. */
80 write_gran_256bytes = 0,/* If less than 256 bytes are written, the unwritten bytes are undefined. */
81 write_gran_1bit, /* Each bit can be cleared individually. */
82 write_gran_1byte, /* A byte can be written once. Further writes to an already written byte cause
83 * its contents to be either undefined or to stay unchanged. */
Paul Kocialkowskic8305e12015-10-16 02:16:20 +000084 write_gran_128bytes, /* If less than 128 bytes are written, the unwritten bytes are undefined. */
Stefan Tauner02437452013-04-01 19:34:53 +000085 write_gran_264bytes, /* If less than 264 bytes are written, the unwritten bytes are undefined. */
86 write_gran_512bytes, /* If less than 512 bytes are written, the unwritten bytes are undefined. */
87 write_gran_528bytes, /* If less than 528 bytes are written, the unwritten bytes are undefined. */
88 write_gran_1024bytes, /* If less than 1024 bytes are written, the unwritten bytes are undefined. */
89 write_gran_1056bytes, /* If less than 1056 bytes are written, the unwritten bytes are undefined. */
Carl-Daniel Hailfinger1b0e9fc2014-06-16 22:36:17 +000090 write_gran_1byte_implicit_erase, /* EEPROMs and other chips with implicit erase and 1-byte writes. */
Stefan Taunereb582572012-09-21 12:52:50 +000091};
92
93/*
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000094 * How many different contiguous runs of erase blocks with one size each do
95 * we have for a given erase function?
96 */
97#define NUM_ERASEREGIONS 5
98
99/*
100 * How many different erase functions do we have per chip?
Nico Huberaac81422017-11-10 22:54:13 +0100101 * Macronix MX25L25635F has 8 different functions.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000102 */
Nico Huberaac81422017-11-10 22:54:13 +0100103#define NUM_ERASEFUNCTIONS 8
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000104
Stefan Tauner0554ca52013-07-25 22:54:25 +0000105/* Feature bits used for non-SPI only */
Carl-Daniel Hailfinger4bf4e792010-01-09 03:15:50 +0000106#define FEATURE_REGISTERMAP (1 << 0)
Sean Nelson35727f72010-01-28 23:55:12 +0000107#define FEATURE_LONG_RESET (0 << 4)
108#define FEATURE_SHORT_RESET (1 << 4)
109#define FEATURE_EITHER_RESET FEATURE_LONG_RESET
Sean Nelsonf59e2632010-10-20 21:13:19 +0000110#define FEATURE_RESET_MASK (FEATURE_LONG_RESET | FEATURE_SHORT_RESET)
Carl-Daniel Hailfinger4bf4e792010-01-09 03:15:50 +0000111#define FEATURE_ADDR_FULL (0 << 2)
112#define FEATURE_ADDR_MASK (3 << 2)
Sean Nelson35727f72010-01-28 23:55:12 +0000113#define FEATURE_ADDR_2AA (1 << 2)
114#define FEATURE_ADDR_AAA (2 << 2)
Michael Karcherad0010a2010-04-03 10:27:08 +0000115#define FEATURE_ADDR_SHIFTED (1 << 5)
Stefan Tauner0554ca52013-07-25 22:54:25 +0000116/* Feature bits used for SPI only */
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +0000117#define FEATURE_WRSR_EWSR (1 << 6)
118#define FEATURE_WRSR_WREN (1 << 7)
Stefan Tauner0554ca52013-07-25 22:54:25 +0000119#define FEATURE_WRSR_EITHER (FEATURE_WRSR_EWSR | FEATURE_WRSR_WREN)
Daniel Lenski65922a32012-02-15 23:40:23 +0000120#define FEATURE_OTP (1 << 8)
Vincent Palatinf800f552013-03-15 02:03:16 +0000121#define FEATURE_QPI (1 << 9)
Nico Huberfe34d2a2017-11-10 21:10:20 +0100122#define FEATURE_4BA_ENTER (1 << 10) /**< Can enter/exit 4BA mode with instructions 0xb7/0xe9 w/o WREN */
123#define FEATURE_4BA_ENTER_WREN (1 << 11) /**< Can enter/exit 4BA mode with instructions 0xb7/0xe9 after WREN */
124#define FEATURE_4BA_EXT_ADDR (1 << 12) /**< Regular 3-byte operations can be used by writing the most
Nico Huberf43c6542017-10-14 17:47:28 +0200125 significant address byte into an extended address register. */
Nico Huberfe34d2a2017-11-10 21:10:20 +0100126#define FEATURE_4BA_READ (1 << 13) /**< Native 4BA read instruction (0x13) is supported. */
Nico Huberaac81422017-11-10 22:54:13 +0100127#define FEATURE_4BA_FAST_READ (1 << 14) /**< Native 4BA fast read instruction (0x0c) is supported. */
128#define FEATURE_4BA_WRITE (1 << 15) /**< Native 4BA byte program (0x12) is supported. */
129/* 4BA Shorthands */
130#define FEATURE_4BA_NATIVE (FEATURE_4BA_READ | FEATURE_4BA_FAST_READ | FEATURE_4BA_WRITE)
131#define FEATURE_4BA (FEATURE_4BA_ENTER | FEATURE_4BA_EXT_ADDR | FEATURE_4BA_NATIVE)
132#define FEATURE_4BA_WREN (FEATURE_4BA_ENTER_WREN | FEATURE_4BA_EXT_ADDR | FEATURE_4BA_NATIVE)
Paul Kocialkowski995f7552018-01-15 01:06:09 +0300133/*
134 * Most flash chips are erased to ones and programmed to zeros. However, some
135 * other flash chips, such as the ENE KB9012 internal flash, work the opposite way.
136 */
137#define FEATURE_ERASED_ZERO (1 << 16)
138
139#define ERASED_VALUE(flash) (((flash)->chip->feature_bits & FEATURE_ERASED_ZERO) ? 0x00 : 0xff)
Sean Nelsonc57a9202010-01-04 17:15:23 +0000140
Stefan Tauner6455dff2014-05-26 00:36:24 +0000141enum test_state {
142 OK = 0,
143 NT = 1, /* Not tested */
144 BAD, /* Known to not work */
145 DEP, /* Support depends on configuration (e.g. Intel flash descriptor) */
146 NA, /* Not applicable (e.g. write support on ROM chips) */
147};
148
149#define TEST_UNTESTED (struct tested){ .probe = NT, .read = NT, .erase = NT, .write = NT }
150
151#define TEST_OK_PROBE (struct tested){ .probe = OK, .read = NT, .erase = NT, .write = NT }
152#define TEST_OK_PR (struct tested){ .probe = OK, .read = OK, .erase = NT, .write = NT }
153#define TEST_OK_PRE (struct tested){ .probe = OK, .read = OK, .erase = OK, .write = NT }
154#define TEST_OK_PREW (struct tested){ .probe = OK, .read = OK, .erase = OK, .write = OK }
155
156#define TEST_BAD_PROBE (struct tested){ .probe = BAD, .read = NT, .erase = NT, .write = NT }
157#define TEST_BAD_PR (struct tested){ .probe = BAD, .read = BAD, .erase = NT, .write = NT }
158#define TEST_BAD_PRE (struct tested){ .probe = BAD, .read = BAD, .erase = BAD, .write = NT }
159#define TEST_BAD_PREW (struct tested){ .probe = BAD, .read = BAD, .erase = BAD, .write = BAD }
160
Nico Huber454f6132012-12-10 13:34:10 +0000161struct flashrom_flashctx;
162#define flashctx flashrom_flashctx /* TODO: Agree on a name and convert all occurences. */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000163typedef int (erasefunc_t)(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000164
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000165struct flashchip {
Uwe Hermann76158682008-03-14 23:55:58 +0000166 const char *vendor;
Uwe Hermann372eeb52007-12-04 21:49:06 +0000167 const char *name;
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000168
169 enum chipbustype bustype;
170
Uwe Hermann394131e2008-10-18 21:14:13 +0000171 /*
172 * With 32bit manufacture_id and model_id we can cover IDs up to
Carl-Daniel Hailfingerae8afa92007-12-31 01:49:00 +0000173 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
174 * Identification code.
175 */
176 uint32_t manufacture_id;
177 uint32_t model_id;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000178
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000179 /* Total chip size in kilobytes */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000180 unsigned int total_size;
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000181 /* Chip page size in bytes */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000182 unsigned int page_size;
Sean Nelsonc57a9202010-01-04 17:15:23 +0000183 int feature_bits;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000184
Stefan Tauner6455dff2014-05-26 00:36:24 +0000185 /* Indicate how well flashrom supports different operations of this flash chip. */
186 struct tested {
187 enum test_state probe;
188 enum test_state read;
189 enum test_state erase;
190 enum test_state write;
191 } tested;
Peter Stuge1159d582008-05-03 04:34:37 +0000192
Mike Banon31b5e3b2018-01-15 01:10:00 +0300193 /*
194 * Group chips that have common command sets. This should ensure that
195 * no chip gets confused by a probing command for a very different class
196 * of chips.
197 */
198 enum {
199 /* SPI25 is very common. Keep it at zero so we don't have
200 to specify it for each and every chip in the database.*/
201 SPI25 = 0,
Paul Kocialkowski80ae14e2018-01-15 01:07:46 +0300202 SPI_EDI = 1,
Mike Banon31b5e3b2018-01-15 01:10:00 +0300203 } spi_cmd_set;
204
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000205 int (*probe) (struct flashctx *flash);
Maciej Pijankac6e11112009-06-03 14:46:22 +0000206
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000207 /* Delay after "enter/exit ID mode" commands in microseconds.
208 * NB: negative values have special meanings, see TIMING_* below.
209 */
210 signed int probe_timing;
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000211
212 /*
Carl-Daniel Hailfinger63ce4bb2009-12-22 13:04:53 +0000213 * Erase blocks and associated erase function. Any chip erase function
214 * is stored as chip-sized virtual block together with said function.
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000215 * The first one that fits will be chosen. There is currently no way to
216 * influence that behaviour. For testing just comment out the other
217 * elements or set the function pointer to NULL.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000218 */
219 struct block_eraser {
Stefan Tauner6697f712014-08-06 15:09:15 +0000220 struct eraseblock {
Stefan Taunerd06d9412011-06-12 19:47:55 +0000221 unsigned int size; /* Eraseblock size in bytes */
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000222 unsigned int count; /* Number of contiguous blocks with that size */
223 } eraseblocks[NUM_ERASEREGIONS];
Stefan Tauner355cbfd2011-05-28 02:37:14 +0000224 /* a block_erase function should try to erase one block of size
225 * 'blocklen' at address 'blockaddr' and return 0 on success. */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000226 int (*block_erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000227 } block_erasers[NUM_ERASEFUNCTIONS];
228
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000229 int (*printlock) (struct flashctx *flash);
230 int (*unlock) (struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000231 int (*write) (struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000232 int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
233 struct voltage {
Steven Zakuleccbe370e2011-06-03 07:26:31 +0000234 uint16_t min;
235 uint16_t max;
236 } voltage;
Stefan Tauner50d67aa2013-03-03 23:49:48 +0000237 enum write_granularity gran;
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000238};
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000239
Nico Huber454f6132012-12-10 13:34:10 +0000240struct flashrom_flashctx {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000241 struct flashchip *chip;
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000242 /* FIXME: The memory mappings should be saved in a more structured way. */
243 /* The physical_* fields store the respective addresses in the physical address space of the CPU. */
244 uintptr_t physical_memory;
245 /* The virtual_* fields store where the respective physical address is mapped into flashrom's address
246 * space. A value equivalent to (chipaddr)ERROR_PTR indicates an invalid mapping (or none at all). */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000247 chipaddr virtual_memory;
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000248 /* Some flash devices have an additional register space; semantics are like above. */
249 uintptr_t physical_registers;
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000250 chipaddr virtual_registers;
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000251 struct registered_master *mst;
Nico Huber7af0e792016-04-29 16:40:15 +0200252 const struct flashrom_layout *layout;
253 struct single_layout fallback_layout;
Nico Huber454f6132012-12-10 13:34:10 +0000254 struct {
255 bool force;
256 bool force_boardmismatch;
257 bool verify_after_write;
258 bool verify_whole_chip;
259 } flags;
Nico Huberf43c6542017-10-14 17:47:28 +0200260 /* We cache the state of the extended address register (highest byte
261 of a 4BA for 3BA instructions) and the state of the 4BA mode here.
262 If possible, we enter 4BA mode early. If that fails, we make use
263 of the extended address register. */
264 int address_high_byte;
265 bool in_4ba_mode;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000266};
267
Maciej Pijankac6e11112009-06-03 14:46:22 +0000268/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
269 * field and zero delay.
Paul Kocialkowski80ae14e2018-01-15 01:07:46 +0300270 *
Maciej Pijankac6e11112009-06-03 14:46:22 +0000271 * SPI devices will always have zero delay and ignore this field.
272 */
273#define TIMING_FIXME -1
274/* this is intentionally same value as fixme */
275#define TIMING_IGNORED -1
276#define TIMING_ZERO -2
277
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000278extern const struct flashchip flashchips[];
Stefan Tauner96658be2014-05-26 22:05:31 +0000279extern const unsigned int flashchips_size;
Ollie Lho184a4042005-11-26 21:55:36 +0000280
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000281void chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr);
282void chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr);
283void chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000284void chip_writen(const struct flashctx *flash, const uint8_t *buf, chipaddr addr, size_t len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000285uint8_t chip_readb(const struct flashctx *flash, const chipaddr addr);
286uint16_t chip_readw(const struct flashctx *flash, const chipaddr addr);
287uint32_t chip_readl(const struct flashctx *flash, const chipaddr addr);
288void chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
289
Uwe Hermannba290d12009-06-17 12:07:12 +0000290/* print.c */
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000291int print_supported(void);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000292void print_supported_wiki(void);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000293
Stefan Tauner6ad6e012014-06-12 00:04:32 +0000294/* helpers.c */
295uint32_t address_to_bits(uint32_t addr);
296int bitcount(unsigned long a);
297int max(int a, int b);
298int min(int a, int b);
299char *strcat_realloc(char *dest, const char *src);
300void tolower_string(char *str);
Stefan Taunerb41d8472014-11-01 22:56:06 +0000301#ifdef __MINGW32__
302char* strtok_r(char *str, const char *delim, char **nextp);
303#endif
Nico Huber2d625722016-05-03 10:48:02 +0200304#if defined(__DJGPP__) || (!defined(__LIBPAYLOAD__) && !defined(HAVE_STRNLEN))
Stefan Taunerdc627932015-01-27 18:07:50 +0000305size_t strnlen(const char *str, size_t n);
306#endif
Stefan Tauner6ad6e012014-06-12 00:04:32 +0000307
Uwe Hermann0846f892007-08-23 13:34:59 +0000308/* flashrom.c */
Mathias Krausea60faab2011-01-17 07:50:42 +0000309extern const char flashrom_version[];
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000310extern const char *chip_to_probe;
Nico Huber2d625722016-05-03 10:48:02 +0200311char *flashbuses_to_text(enum chipbustype bustype);
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000312int map_flash(struct flashctx *flash);
313void unmap_flash(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000314int read_memmapped(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
315int erase_flash(struct flashctx *flash);
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000316int probe_flash(struct registered_master *mst, int startchip, struct flashctx *fill_flash, int force);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000317int read_flash_to_file(struct flashctx *flash, const char *filename);
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000318char *extract_param(const char *const *haystack, const char *needle, const char *delim);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000319int verify_range(struct flashctx *flash, const uint8_t *cmpbuf, unsigned int start, unsigned int len);
Paul Kocialkowski995f7552018-01-15 01:06:09 +0300320int need_erase(const uint8_t *have, const uint8_t *want, unsigned int len, enum write_granularity gran, const uint8_t erased_value);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000321void print_version(void);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000322void print_buildinfo(void);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000323void print_banner(void);
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +0000324void list_programmers_linebreak(int startcol, int cols, int paren);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000325int selfcheck(void);
Stefan Tauner66652442011-06-26 17:38:17 +0000326int read_buf_from_file(unsigned char *buf, unsigned long size, const char *filename);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000327int write_buf_to_file(const unsigned char *buf, unsigned long size, const char *filename);
Nico Huber305f4172013-06-14 11:55:26 +0200328int prepare_flash_access(struct flashctx *, bool read_it, bool write_it, bool erase_it, bool verify_it);
329void finalize_flash_access(struct flashctx *);
Nico Huber899e4ec2016-04-29 18:39:01 +0200330int do_read(struct flashctx *, const char *filename);
331int do_erase(struct flashctx *);
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300332int do_write(struct flashctx *, const char *const filename, const char *const referencefile);
Nico Huber899e4ec2016-04-29 18:39:01 +0200333int do_verify(struct flashctx *, const char *const filename);
Uwe Hermannba290d12009-06-17 12:07:12 +0000334
Tadas Slotkusad470342011-09-03 17:15:00 +0000335/* Something happened that shouldn't happen, but we can go on. */
Michael Karchera4448d92010-07-22 18:04:15 +0000336#define ERROR_NONFATAL 0x100
337
Tadas Slotkusad470342011-09-03 17:15:00 +0000338/* Something happened that shouldn't happen, we'll abort. */
339#define ERROR_FATAL -0xee
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000340#define ERROR_FLASHROM_BUG -200
341/* We reached one of the hardcoded limits of flashrom. This can be fixed by
342 * increasing the limit of a compile-time allocation or by switching to dynamic
343 * allocation.
344 * Note: If this warning is triggered, check first for runaway registrations.
345 */
346#define ERROR_FLASHROM_LIMIT -201
Tadas Slotkusad470342011-09-03 17:15:00 +0000347
Stefan Tauner9b32de92014-08-08 23:52:33 +0000348/* cli_common.c */
Stefan Tauner9b32de92014-08-08 23:52:33 +0000349void print_chip_support_status(const struct flashchip *chip);
350
Sean Nelson51e97d72010-01-07 20:09:33 +0000351/* cli_output.c */
Nico Huberd152fb92017-06-19 12:57:10 +0200352extern enum flashrom_log_level verbose_screen;
353extern enum flashrom_log_level verbose_logfile;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000354#ifndef STANDALONE
355int open_logfile(const char * const filename);
356int close_logfile(void);
357void start_logging(void);
358#endif
Nico Huberd152fb92017-06-19 12:57:10 +0200359int flashrom_print_cb(enum flashrom_log_level level, const char *fmt, va_list ap);
Carl-Daniel Hailfinger9f5f2152010-06-04 23:20:21 +0000360/* Let gcc and clang check for correct printf-style format strings. */
Nico Huberd152fb92017-06-19 12:57:10 +0200361int print(enum flashrom_log_level level, const char *fmt, ...)
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +0000362#ifdef __MINGW32__
Stefan Taunerf268d8b2017-10-26 18:45:00 +0200363__attribute__((format(__MINGW_PRINTF_FORMAT, 2, 3)));
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +0000364#else
365__attribute__((format(printf, 2, 3)));
366#endif
Nico Huberd152fb92017-06-19 12:57:10 +0200367#define msg_gerr(...) print(FLASHROM_MSG_ERROR, __VA_ARGS__) /* general errors */
368#define msg_perr(...) print(FLASHROM_MSG_ERROR, __VA_ARGS__) /* programmer errors */
369#define msg_cerr(...) print(FLASHROM_MSG_ERROR, __VA_ARGS__) /* chip errors */
370#define msg_gwarn(...) print(FLASHROM_MSG_WARN, __VA_ARGS__) /* general warnings */
371#define msg_pwarn(...) print(FLASHROM_MSG_WARN, __VA_ARGS__) /* programmer warnings */
372#define msg_cwarn(...) print(FLASHROM_MSG_WARN, __VA_ARGS__) /* chip warnings */
373#define msg_ginfo(...) print(FLASHROM_MSG_INFO, __VA_ARGS__) /* general info */
374#define msg_pinfo(...) print(FLASHROM_MSG_INFO, __VA_ARGS__) /* programmer info */
375#define msg_cinfo(...) print(FLASHROM_MSG_INFO, __VA_ARGS__) /* chip info */
376#define msg_gdbg(...) print(FLASHROM_MSG_DEBUG, __VA_ARGS__) /* general debug */
377#define msg_pdbg(...) print(FLASHROM_MSG_DEBUG, __VA_ARGS__) /* programmer debug */
378#define msg_cdbg(...) print(FLASHROM_MSG_DEBUG, __VA_ARGS__) /* chip debug */
379#define msg_gdbg2(...) print(FLASHROM_MSG_DEBUG2, __VA_ARGS__) /* general debug2 */
380#define msg_pdbg2(...) print(FLASHROM_MSG_DEBUG2, __VA_ARGS__) /* programmer debug2 */
381#define msg_cdbg2(...) print(FLASHROM_MSG_DEBUG2, __VA_ARGS__) /* chip debug2 */
382#define msg_gspew(...) print(FLASHROM_MSG_SPEW, __VA_ARGS__) /* general debug spew */
383#define msg_pspew(...) print(FLASHROM_MSG_SPEW, __VA_ARGS__) /* programmer debug spew */
384#define msg_cspew(...) print(FLASHROM_MSG_SPEW, __VA_ARGS__) /* chip debug spew */
Sean Nelson51e97d72010-01-07 20:09:33 +0000385
Uwe Hermann0846f892007-08-23 13:34:59 +0000386/* layout.c */
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000387int register_include_arg(char *name);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000388int read_romlayout(const char *name);
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000389int normalize_romentries(const struct flashctx *flash);
Stefan Tauner949ccc82013-09-15 14:01:06 +0000390void layout_cleanup(void);
Uwe Hermann0846f892007-08-23 13:34:59 +0000391
Carl-Daniel Hailfinger00f911e2007-10-15 21:44:47 +0000392/* spi.c */
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000393struct spi_command {
394 unsigned int writecnt;
395 unsigned int readcnt;
396 const unsigned char *writearr;
397 unsigned char *readarr;
398};
Nico Hubera3140d02017-10-15 11:20:58 +0200399#define NULL_SPI_CMD { 0, 0, NULL, NULL, }
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000400int spi_send_command(struct flashctx *flash, unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
401int spi_send_multicommand(struct flashctx *flash, struct spi_command *cmds);
Mats Erik Andersson44e1a192008-09-26 13:19:02 +0000402
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000403enum chipbustype get_buses_supported(void);
Ollie Lho761bf1b2004-03-20 16:46:10 +0000404#endif /* !__FLASH_H__ */