blob: cba7bd84965bda7ad15502c88d61261681bf2578 [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 Tauner0466c812013-06-16 10:30:08 +000027#include <inttypes.h>
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +000028#include <stdio.h>
Ollie Lho184a4042005-11-26 21:55:36 +000029#include <stdint.h>
Carl-Daniel Hailfingerdd128c92010-06-03 00:49:50 +000030#include <stddef.h>
Stefan Tauner682122b2013-06-23 22:15:39 +000031#include <stdbool.h>
Patrick Georgie48654c2010-01-06 22:14:39 +000032#ifdef _WIN32
33#include <windows.h>
34#undef min
35#undef max
36#endif
Andriy Gapon65c1b862008-05-22 13:22:45 +000037
Patrick Georgied7a9642010-09-25 22:53:44 +000038#define ERROR_PTR ((void*)-1)
39
Carl-Daniel Hailfinger174f55b2010-10-08 00:37:55 +000040/* Error codes */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +000041#define ERROR_OOM -100
Carl-Daniel Hailfinger174f55b2010-10-08 00:37:55 +000042#define TIMEOUT_ERROR -101
43
Stefan Taunerc2333752013-07-13 23:31:37 +000044/* TODO: check using code for correct usage of types */
45typedef uintptr_t chipaddr;
Stefan Tauner305e0b92013-07-17 23:46:44 +000046#define PRIxPTR_WIDTH ((int)(sizeof(uintptr_t)*2))
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +000047
David Hendricks8bb20212011-06-14 01:35:36 +000048int register_shutdown(int (*function) (void *data), void *data);
Stefan Tauner305e0b92013-07-17 23:46:44 +000049void *programmer_map_flash_region(const char *descr, uintptr_t phys_addr, size_t len);
Uwe Hermann09e04f72009-05-16 22:36:00 +000050void programmer_unmap_flash_region(void *virt_addr, size_t len);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000051void programmer_delay(int usecs);
Carl-Daniel Hailfinger61a8bd22009-03-05 19:24:22 +000052
Uwe Hermanne5ac1642008-03-12 11:54:51 +000053#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
54
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000055enum chipbustype {
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +000056 BUS_NONE = 0,
57 BUS_PARALLEL = 1 << 0,
58 BUS_LPC = 1 << 1,
59 BUS_FWH = 1 << 2,
60 BUS_SPI = 1 << 3,
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000061 BUS_PROG = 1 << 4,
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +000062 BUS_NONSPI = BUS_PARALLEL | BUS_LPC | BUS_FWH,
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000063};
64
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000065/*
Stefan Tauner02437452013-04-01 19:34:53 +000066 * The following enum defines possible write granularities of flash chips. These tend to reflect the properties
67 * of the actual hardware not necesserily the write function(s) defined by the respective struct flashchip.
68 * The latter might (and should) be more precisely specified, e.g. they might bail out early if their execution
69 * would result in undefined chip contents.
Stefan Taunereb582572012-09-21 12:52:50 +000070 */
71enum write_granularity {
Stefan Tauner02437452013-04-01 19:34:53 +000072 /* We assume 256 byte granularity by default. */
73 write_gran_256bytes = 0,/* If less than 256 bytes are written, the unwritten bytes are undefined. */
74 write_gran_1bit, /* Each bit can be cleared individually. */
75 write_gran_1byte, /* A byte can be written once. Further writes to an already written byte cause
76 * its contents to be either undefined or to stay unchanged. */
77 write_gran_264bytes, /* If less than 264 bytes are written, the unwritten bytes are undefined. */
78 write_gran_512bytes, /* If less than 512 bytes are written, the unwritten bytes are undefined. */
79 write_gran_528bytes, /* If less than 528 bytes are written, the unwritten bytes are undefined. */
80 write_gran_1024bytes, /* If less than 1024 bytes are written, the unwritten bytes are undefined. */
81 write_gran_1056bytes, /* If less than 1056 bytes are written, the unwritten bytes are undefined. */
Stefan Taunereb582572012-09-21 12:52:50 +000082};
83
84/*
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000085 * How many different contiguous runs of erase blocks with one size each do
86 * we have for a given erase function?
87 */
88#define NUM_ERASEREGIONS 5
89
90/*
91 * How many different erase functions do we have per chip?
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +000092 * Atmel AT25FS010 has 6 different functions.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000093 */
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +000094#define NUM_ERASEFUNCTIONS 6
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000095
Carl-Daniel Hailfinger4bf4e792010-01-09 03:15:50 +000096#define FEATURE_REGISTERMAP (1 << 0)
97#define FEATURE_BYTEWRITES (1 << 1)
Sean Nelson35727f72010-01-28 23:55:12 +000098#define FEATURE_LONG_RESET (0 << 4)
99#define FEATURE_SHORT_RESET (1 << 4)
100#define FEATURE_EITHER_RESET FEATURE_LONG_RESET
Sean Nelsonf59e2632010-10-20 21:13:19 +0000101#define FEATURE_RESET_MASK (FEATURE_LONG_RESET | FEATURE_SHORT_RESET)
Carl-Daniel Hailfinger4bf4e792010-01-09 03:15:50 +0000102#define FEATURE_ADDR_FULL (0 << 2)
103#define FEATURE_ADDR_MASK (3 << 2)
Sean Nelson35727f72010-01-28 23:55:12 +0000104#define FEATURE_ADDR_2AA (1 << 2)
105#define FEATURE_ADDR_AAA (2 << 2)
Michael Karcherad0010a2010-04-03 10:27:08 +0000106#define FEATURE_ADDR_SHIFTED (1 << 5)
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +0000107#define FEATURE_WRSR_EWSR (1 << 6)
108#define FEATURE_WRSR_WREN (1 << 7)
Daniel Lenski65922a32012-02-15 23:40:23 +0000109#define FEATURE_OTP (1 << 8)
Vincent Palatinf800f552013-03-15 02:03:16 +0000110#define FEATURE_QPI (1 << 9)
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +0000111#define FEATURE_WRSR_EITHER (FEATURE_WRSR_EWSR | FEATURE_WRSR_WREN)
Sean Nelsonc57a9202010-01-04 17:15:23 +0000112
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000113struct flashctx;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000114typedef int (erasefunc_t)(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000115
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000116struct flashchip {
Uwe Hermann76158682008-03-14 23:55:58 +0000117 const char *vendor;
Uwe Hermann372eeb52007-12-04 21:49:06 +0000118 const char *name;
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +0000119
120 enum chipbustype bustype;
121
Uwe Hermann394131e2008-10-18 21:14:13 +0000122 /*
123 * With 32bit manufacture_id and model_id we can cover IDs up to
Carl-Daniel Hailfingerae8afa92007-12-31 01:49:00 +0000124 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
125 * Identification code.
126 */
127 uint32_t manufacture_id;
128 uint32_t model_id;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000129
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000130 /* Total chip size in kilobytes */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000131 unsigned int total_size;
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000132 /* Chip page size in bytes */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000133 unsigned int page_size;
Sean Nelsonc57a9202010-01-04 17:15:23 +0000134 int feature_bits;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000135
Uwe Hermann394131e2008-10-18 21:14:13 +0000136 /*
137 * Indicate if flashrom has been tested with this flash chip and if
Peter Stuge1159d582008-05-03 04:34:37 +0000138 * everything worked correctly.
139 */
140 uint32_t tested;
141
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000142 int (*probe) (struct flashctx *flash);
Maciej Pijankac6e11112009-06-03 14:46:22 +0000143
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000144 /* Delay after "enter/exit ID mode" commands in microseconds.
145 * NB: negative values have special meanings, see TIMING_* below.
146 */
147 signed int probe_timing;
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000148
149 /*
Carl-Daniel Hailfinger63ce4bb2009-12-22 13:04:53 +0000150 * Erase blocks and associated erase function. Any chip erase function
151 * is stored as chip-sized virtual block together with said function.
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000152 * The first one that fits will be chosen. There is currently no way to
153 * influence that behaviour. For testing just comment out the other
154 * elements or set the function pointer to NULL.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000155 */
156 struct block_eraser {
157 struct eraseblock{
Stefan Taunerd06d9412011-06-12 19:47:55 +0000158 unsigned int size; /* Eraseblock size in bytes */
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000159 unsigned int count; /* Number of contiguous blocks with that size */
160 } eraseblocks[NUM_ERASEREGIONS];
Stefan Tauner355cbfd2011-05-28 02:37:14 +0000161 /* a block_erase function should try to erase one block of size
162 * 'blocklen' at address 'blockaddr' and return 0 on success. */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000163 int (*block_erase) (struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000164 } block_erasers[NUM_ERASEFUNCTIONS];
165
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000166 int (*printlock) (struct flashctx *flash);
167 int (*unlock) (struct flashctx *flash);
168 int (*write) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
169 int (*read) (struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
170 struct voltage {
Steven Zakuleccbe370e2011-06-03 07:26:31 +0000171 uint16_t min;
172 uint16_t max;
173 } voltage;
Stefan Tauner50d67aa2013-03-03 23:49:48 +0000174 enum write_granularity gran;
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000175};
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000176
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000177struct flashctx {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000178 struct flashchip *chip;
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000179 chipaddr virtual_memory;
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000180 /* Some flash devices have an additional register space. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000181 chipaddr virtual_registers;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000182 struct registered_programmer *pgm;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000183};
184
Peter Stuge1159d582008-05-03 04:34:37 +0000185#define TEST_UNTESTED 0
186
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000187#define TEST_OK_PROBE (1 << 0)
188#define TEST_OK_READ (1 << 1)
189#define TEST_OK_ERASE (1 << 2)
190#define TEST_OK_WRITE (1 << 3)
191#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
192#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
Carl-Daniel Hailfingera06287c2009-09-23 22:01:33 +0000193#define TEST_OK_PRW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000194#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000195#define TEST_OK_MASK 0x0f
196
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000197#define TEST_BAD_PROBE (1 << 4)
198#define TEST_BAD_READ (1 << 5)
199#define TEST_BAD_ERASE (1 << 6)
200#define TEST_BAD_WRITE (1 << 7)
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000201#define TEST_BAD_REW (TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000202#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000203#define TEST_BAD_MASK 0xf0
204
Maciej Pijankac6e11112009-06-03 14:46:22 +0000205/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
206 * field and zero delay.
207 *
208 * SPI devices will always have zero delay and ignore this field.
209 */
210#define TIMING_FIXME -1
211/* this is intentionally same value as fixme */
212#define TIMING_IGNORED -1
213#define TIMING_ZERO -2
214
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000215extern const struct flashchip flashchips[];
Ollie Lho184a4042005-11-26 21:55:36 +0000216
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000217void chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr);
218void chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr);
219void chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr);
220void chip_writen(const struct flashctx *flash, uint8_t *buf, chipaddr addr, size_t len);
221uint8_t chip_readb(const struct flashctx *flash, const chipaddr addr);
222uint16_t chip_readw(const struct flashctx *flash, const chipaddr addr);
223uint32_t chip_readl(const struct flashctx *flash, const chipaddr addr);
224void chip_readn(const struct flashctx *flash, uint8_t *buf, const chipaddr addr, size_t len);
225
Uwe Hermannba290d12009-06-17 12:07:12 +0000226/* print.c */
227char *flashbuses_to_text(enum chipbustype bustype);
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000228int print_supported(void);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000229void print_supported_wiki(void);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000230
Uwe Hermann0846f892007-08-23 13:34:59 +0000231/* flashrom.c */
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000232extern int verbose_screen;
233extern int verbose_logfile;
Mathias Krausea60faab2011-01-17 07:50:42 +0000234extern const char flashrom_version[];
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000235extern const char *chip_to_probe;
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000236void map_flash_registers(struct flashctx *flash);
237int read_memmapped(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
238int erase_flash(struct flashctx *flash);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000239int probe_flash(struct registered_programmer *pgm, int startchip, struct flashctx *fill_flash, int force);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000240int read_flash_to_file(struct flashctx *flash, const char *filename);
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000241int min(int a, int b);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000242int max(int a, int b);
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000243void tolower_string(char *str);
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000244char *extract_param(const char *const *haystack, const char *needle, const char *delim);
Stefan Tauner78ffbea2012-10-27 15:36:56 +0000245int verify_range(struct flashctx *flash, uint8_t *cmpbuf, unsigned int start, unsigned int len);
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000246int need_erase(uint8_t *have, uint8_t *want, unsigned int len, enum write_granularity gran);
Uwe Hermannba290d12009-06-17 12:07:12 +0000247char *strcat_realloc(char *dest, const char *src);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000248void print_version(void);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000249void print_buildinfo(void);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000250void print_banner(void);
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +0000251void list_programmers_linebreak(int startcol, int cols, int paren);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000252int selfcheck(void);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000253int doit(struct flashctx *flash, int force, const char *filename, int read_it, int write_it, int erase_it, int verify_it);
Stefan Tauner66652442011-06-26 17:38:17 +0000254int read_buf_from_file(unsigned char *buf, unsigned long size, const char *filename);
255int write_buf_to_file(unsigned char *buf, unsigned long size, const char *filename);
Uwe Hermannba290d12009-06-17 12:07:12 +0000256
Stefan Tauner2c20b282012-07-28 19:35:26 +0000257enum test_state {
258 OK = 0,
259 NT = 1, /* Not tested */
260 BAD
261};
Uwe Hermann0846f892007-08-23 13:34:59 +0000262
Tadas Slotkusad470342011-09-03 17:15:00 +0000263/* Something happened that shouldn't happen, but we can go on. */
Michael Karchera4448d92010-07-22 18:04:15 +0000264#define ERROR_NONFATAL 0x100
265
Tadas Slotkusad470342011-09-03 17:15:00 +0000266/* Something happened that shouldn't happen, we'll abort. */
267#define ERROR_FATAL -0xee
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000268#define ERROR_FLASHROM_BUG -200
269/* We reached one of the hardcoded limits of flashrom. This can be fixed by
270 * increasing the limit of a compile-time allocation or by switching to dynamic
271 * allocation.
272 * Note: If this warning is triggered, check first for runaway registrations.
273 */
274#define ERROR_FLASHROM_LIMIT -201
Tadas Slotkusad470342011-09-03 17:15:00 +0000275
Sean Nelson51e97d72010-01-07 20:09:33 +0000276/* cli_output.c */
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000277#ifndef STANDALONE
278int open_logfile(const char * const filename);
279int close_logfile(void);
280void start_logging(void);
281#endif
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000282enum msglevel {
283 MSG_ERROR = 0,
Stefan Taunerc6fa32d2013-01-04 22:54:07 +0000284 MSG_WARN = 1,
285 MSG_INFO = 2,
286 MSG_DEBUG = 3,
287 MSG_DEBUG2 = 4,
288 MSG_SPEW = 5,
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000289};
Carl-Daniel Hailfinger9f5f2152010-06-04 23:20:21 +0000290/* Let gcc and clang check for correct printf-style format strings. */
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +0000291int print(enum msglevel level, const char *fmt, ...)
292#ifdef __MINGW32__
293__attribute__((format(gnu_printf, 2, 3)));
294#else
295__attribute__((format(printf, 2, 3)));
296#endif
Carl-Daniel Hailfingerf8dda682010-01-09 03:22:31 +0000297#define msg_gerr(...) print(MSG_ERROR, __VA_ARGS__) /* general errors */
298#define msg_perr(...) print(MSG_ERROR, __VA_ARGS__) /* programmer errors */
299#define msg_cerr(...) print(MSG_ERROR, __VA_ARGS__) /* chip errors */
Stefan Taunerc6fa32d2013-01-04 22:54:07 +0000300#define msg_gwarn(...) print(MSG_WARN, __VA_ARGS__) /* general warnings */
301#define msg_pwarn(...) print(MSG_WARN, __VA_ARGS__) /* programmer warnings */
302#define msg_cwarn(...) print(MSG_WARN, __VA_ARGS__) /* chip warnings */
Carl-Daniel Hailfingerf8dda682010-01-09 03:22:31 +0000303#define msg_ginfo(...) print(MSG_INFO, __VA_ARGS__) /* general info */
304#define msg_pinfo(...) print(MSG_INFO, __VA_ARGS__) /* programmer info */
305#define msg_cinfo(...) print(MSG_INFO, __VA_ARGS__) /* chip info */
306#define msg_gdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* general debug */
307#define msg_pdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* programmer debug */
308#define msg_cdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* chip debug */
Stefan Taunereebeb532011-08-04 17:40:25 +0000309#define msg_gdbg2(...) print(MSG_DEBUG2, __VA_ARGS__) /* general debug2 */
310#define msg_pdbg2(...) print(MSG_DEBUG2, __VA_ARGS__) /* programmer debug2 */
311#define msg_cdbg2(...) print(MSG_DEBUG2, __VA_ARGS__) /* chip debug2 */
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000312#define msg_gspew(...) print(MSG_SPEW, __VA_ARGS__) /* general debug spew */
313#define msg_pspew(...) print(MSG_SPEW, __VA_ARGS__) /* programmer debug spew */
314#define msg_cspew(...) print(MSG_SPEW, __VA_ARGS__) /* chip debug spew */
Sean Nelson51e97d72010-01-07 20:09:33 +0000315
Uwe Hermann0846f892007-08-23 13:34:59 +0000316/* layout.c */
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000317int register_include_arg(char *name);
318int process_include_args(void);
Uwe Hermann0846f892007-08-23 13:34:59 +0000319int read_romlayout(char *name);
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000320int handle_romentries(const struct flashctx *flash, uint8_t *oldcontents, uint8_t *newcontents);
Uwe Hermann0846f892007-08-23 13:34:59 +0000321
Carl-Daniel Hailfinger00f911e2007-10-15 21:44:47 +0000322/* spi.c */
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000323struct spi_command {
324 unsigned int writecnt;
325 unsigned int readcnt;
326 const unsigned char *writearr;
327 unsigned char *readarr;
328};
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000329int spi_send_command(struct flashctx *flash, unsigned int writecnt, unsigned int readcnt, const unsigned char *writearr, unsigned char *readarr);
330int spi_send_multicommand(struct flashctx *flash, struct spi_command *cmds);
331uint32_t spi_get_valid_read_addr(struct flashctx *flash);
Mats Erik Andersson44e1a192008-09-26 13:19:02 +0000332
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000333enum chipbustype get_buses_supported(void);
Ollie Lho761bf1b2004-03-20 16:46:10 +0000334#endif /* !__FLASH_H__ */