blob: 6ac3c1cf2dbb79504c49958154c9a883be6f2096 [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
Ollie Lho184a4042005-11-26 21:55:36 +000027#include <stdint.h>
Carl-Daniel Hailfingerdd128c92010-06-03 00:49:50 +000028#include <stddef.h>
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000029#include "hwaccess.h"
Patrick Georgie48654c2010-01-06 22:14:39 +000030#ifdef _WIN32
31#include <windows.h>
32#undef min
33#undef max
34#endif
Andriy Gapon65c1b862008-05-22 13:22:45 +000035
Patrick Georgied7a9642010-09-25 22:53:44 +000036#define ERROR_PTR ((void*)-1)
37
Carl-Daniel Hailfinger174f55b2010-10-08 00:37:55 +000038/* Error codes */
39#define TIMEOUT_ERROR -101
40
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +000041typedef unsigned long chipaddr;
42
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +000043int register_shutdown(void (*function) (void *data), void *data);
Uwe Hermann09e04f72009-05-16 22:36:00 +000044void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
45 size_t len);
46void programmer_unmap_flash_region(void *virt_addr, size_t len);
47void chip_writeb(uint8_t val, chipaddr addr);
48void chip_writew(uint16_t val, chipaddr addr);
49void chip_writel(uint32_t val, chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000050void chip_writen(uint8_t *buf, chipaddr addr, size_t len);
Uwe Hermann09e04f72009-05-16 22:36:00 +000051uint8_t chip_readb(const chipaddr addr);
52uint16_t chip_readw(const chipaddr addr);
53uint32_t chip_readl(const chipaddr addr);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000054void chip_readn(uint8_t *buf, const chipaddr addr, size_t len);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000055void programmer_delay(int usecs);
Carl-Daniel Hailfinger61a8bd22009-03-05 19:24:22 +000056
Uwe Hermanne5ac1642008-03-12 11:54:51 +000057#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
58
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000059enum chipbustype {
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +000060 CHIP_BUSTYPE_NONE = 0,
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000061 CHIP_BUSTYPE_PARALLEL = 1 << 0,
62 CHIP_BUSTYPE_LPC = 1 << 1,
63 CHIP_BUSTYPE_FWH = 1 << 2,
64 CHIP_BUSTYPE_SPI = 1 << 3,
65 CHIP_BUSTYPE_NONSPI = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH,
66 CHIP_BUSTYPE_UNKNOWN = CHIP_BUSTYPE_PARALLEL | CHIP_BUSTYPE_LPC | CHIP_BUSTYPE_FWH | CHIP_BUSTYPE_SPI,
67};
68
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000069/*
70 * How many different contiguous runs of erase blocks with one size each do
71 * we have for a given erase function?
72 */
73#define NUM_ERASEREGIONS 5
74
75/*
76 * How many different erase functions do we have per chip?
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +000077 * Atmel AT25FS010 has 6 different functions.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000078 */
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +000079#define NUM_ERASEFUNCTIONS 6
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +000080
Carl-Daniel Hailfinger4bf4e792010-01-09 03:15:50 +000081#define FEATURE_REGISTERMAP (1 << 0)
82#define FEATURE_BYTEWRITES (1 << 1)
Sean Nelson35727f72010-01-28 23:55:12 +000083#define FEATURE_LONG_RESET (0 << 4)
84#define FEATURE_SHORT_RESET (1 << 4)
85#define FEATURE_EITHER_RESET FEATURE_LONG_RESET
Sean Nelsonf59e2632010-10-20 21:13:19 +000086#define FEATURE_RESET_MASK (FEATURE_LONG_RESET | FEATURE_SHORT_RESET)
Carl-Daniel Hailfinger4bf4e792010-01-09 03:15:50 +000087#define FEATURE_ADDR_FULL (0 << 2)
88#define FEATURE_ADDR_MASK (3 << 2)
Sean Nelson35727f72010-01-28 23:55:12 +000089#define FEATURE_ADDR_2AA (1 << 2)
90#define FEATURE_ADDR_AAA (2 << 2)
Michael Karcherad0010a2010-04-03 10:27:08 +000091#define FEATURE_ADDR_SHIFTED (1 << 5)
Carl-Daniel Hailfingerfd7075a2010-07-29 13:09:18 +000092#define FEATURE_WRSR_EWSR (1 << 6)
93#define FEATURE_WRSR_WREN (1 << 7)
94#define FEATURE_WRSR_EITHER (FEATURE_WRSR_EWSR | FEATURE_WRSR_WREN)
Sean Nelsonc57a9202010-01-04 17:15:23 +000095
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000096struct flashchip {
Uwe Hermann76158682008-03-14 23:55:58 +000097 const char *vendor;
Uwe Hermann372eeb52007-12-04 21:49:06 +000098 const char *name;
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000099
100 enum chipbustype bustype;
101
Uwe Hermann394131e2008-10-18 21:14:13 +0000102 /*
103 * With 32bit manufacture_id and model_id we can cover IDs up to
Carl-Daniel Hailfingerae8afa92007-12-31 01:49:00 +0000104 * (including) the 4th bank of JEDEC JEP106W Standard Manufacturer's
105 * Identification code.
106 */
107 uint32_t manufacture_id;
108 uint32_t model_id;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000109
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000110 int total_size;
111 int page_size;
Sean Nelsonc57a9202010-01-04 17:15:23 +0000112 int feature_bits;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000113
Uwe Hermann394131e2008-10-18 21:14:13 +0000114 /*
115 * Indicate if flashrom has been tested with this flash chip and if
Peter Stuge1159d582008-05-03 04:34:37 +0000116 * everything worked correctly.
117 */
118 uint32_t tested;
119
Uwe Hermann0b7afe62007-04-01 19:44:21 +0000120 int (*probe) (struct flashchip *flash);
Maciej Pijankac6e11112009-06-03 14:46:22 +0000121
122 /* Delay after "enter/exit ID mode" commands in microseconds. */
123 int probe_timing;
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000124
125 /*
Carl-Daniel Hailfinger63ce4bb2009-12-22 13:04:53 +0000126 * Erase blocks and associated erase function. Any chip erase function
127 * is stored as chip-sized virtual block together with said function.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000128 */
129 struct block_eraser {
130 struct eraseblock{
131 unsigned int size; /* Eraseblock size */
132 unsigned int count; /* Number of contiguous blocks with that size */
133 } eraseblocks[NUM_ERASEREGIONS];
134 int (*block_erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
135 } block_erasers[NUM_ERASEFUNCTIONS];
136
Sean Nelson6e0b9122010-02-19 00:52:10 +0000137 int (*printlock) (struct flashchip *flash);
138 int (*unlock) (struct flashchip *flash);
Carl-Daniel Hailfinger75a58f92010-10-13 22:26:56 +0000139 int (*write) (struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000140 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000141
Uwe Hermann372eeb52007-12-04 21:49:06 +0000142 /* Some flash devices have an additional register space. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000143 chipaddr virtual_memory;
144 chipaddr virtual_registers;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000145};
146
Peter Stuge1159d582008-05-03 04:34:37 +0000147#define TEST_UNTESTED 0
148
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000149#define TEST_OK_PROBE (1 << 0)
150#define TEST_OK_READ (1 << 1)
151#define TEST_OK_ERASE (1 << 2)
152#define TEST_OK_WRITE (1 << 3)
153#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
154#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
Carl-Daniel Hailfingera06287c2009-09-23 22:01:33 +0000155#define TEST_OK_PRW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000156#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000157#define TEST_OK_MASK 0x0f
158
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000159#define TEST_BAD_PROBE (1 << 4)
160#define TEST_BAD_READ (1 << 5)
161#define TEST_BAD_ERASE (1 << 6)
162#define TEST_BAD_WRITE (1 << 7)
163#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000164#define TEST_BAD_MASK 0xf0
165
Maciej Pijankac6e11112009-06-03 14:46:22 +0000166/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
167 * field and zero delay.
168 *
169 * SPI devices will always have zero delay and ignore this field.
170 */
171#define TIMING_FIXME -1
172/* this is intentionally same value as fixme */
173#define TIMING_IGNORED -1
174#define TIMING_ZERO -2
175
Ollie Lho184a4042005-11-26 21:55:36 +0000176extern struct flashchip flashchips[];
177
Uwe Hermannba290d12009-06-17 12:07:12 +0000178/* print.c */
179char *flashbuses_to_text(enum chipbustype bustype);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000180void print_supported(void);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000181void print_supported_wiki(void);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000182
Uwe Hermann0846f892007-08-23 13:34:59 +0000183/* flashrom.c */
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000184enum write_granularity {
185 write_gran_1bit,
186 write_gran_1byte,
187 write_gran_256bytes,
188};
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000189extern enum chipbustype buses_supported;
Uwe Hermannad216bf2009-04-24 16:17:41 +0000190extern int verbose;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000191extern const char * const flashrom_version;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000192extern char *chip_to_probe;
Peter Stuge776d2022009-01-26 00:39:57 +0000193void map_flash_registers(struct flashchip *flash);
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000194int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000195int erase_flash(struct flashchip *flash);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000196struct flashchip *probe_flash(struct flashchip *first_flash, int force);
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +0000197int read_flash_to_file(struct flashchip *flash, char *filename);
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000198int min(int a, int b);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000199int max(int a, int b);
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000200char *extract_param(char **haystack, char *needle, char *delim);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000201int check_erased_range(struct flashchip *flash, int start, int len);
202int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message);
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000203int need_erase(uint8_t *have, uint8_t *want, int len, enum write_granularity gran);
Uwe Hermannba290d12009-06-17 12:07:12 +0000204char *strcat_realloc(char *dest, const char *src);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000205void print_version(void);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000206void print_banner(void);
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +0000207void list_programmers_linebreak(int startcol, int cols, int paren);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000208int selfcheck(void);
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +0000209int doit(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it);
Carl-Daniel Hailfingerf68aa8a2010-11-01 22:07:04 +0000210int read_buf_from_file(unsigned char *buf, unsigned long size, char *filename);
211int write_buf_to_file(unsigned char *buf, unsigned long size, char *filename);
Uwe Hermannba290d12009-06-17 12:07:12 +0000212
213#define OK 0
214#define NT 1 /* Not tested */
Uwe Hermann0846f892007-08-23 13:34:59 +0000215
Michael Karchera4448d92010-07-22 18:04:15 +0000216/* Something happened that shouldn't happen, but we can go on */
217#define ERROR_NONFATAL 0x100
218
Sean Nelson51e97d72010-01-07 20:09:33 +0000219/* cli_output.c */
Carl-Daniel Hailfinger9f5f2152010-06-04 23:20:21 +0000220/* Let gcc and clang check for correct printf-style format strings. */
221int print(int type, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
Carl-Daniel Hailfingerf8dda682010-01-09 03:22:31 +0000222#define MSG_ERROR 0
223#define MSG_INFO 1
224#define MSG_DEBUG 2
225#define MSG_BARF 3
226#define msg_gerr(...) print(MSG_ERROR, __VA_ARGS__) /* general errors */
227#define msg_perr(...) print(MSG_ERROR, __VA_ARGS__) /* programmer errors */
228#define msg_cerr(...) print(MSG_ERROR, __VA_ARGS__) /* chip errors */
229#define msg_ginfo(...) print(MSG_INFO, __VA_ARGS__) /* general info */
230#define msg_pinfo(...) print(MSG_INFO, __VA_ARGS__) /* programmer info */
231#define msg_cinfo(...) print(MSG_INFO, __VA_ARGS__) /* chip info */
232#define msg_gdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* general debug */
233#define msg_pdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* programmer debug */
234#define msg_cdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* chip debug */
235#define msg_gspew(...) print(MSG_BARF, __VA_ARGS__) /* general debug barf */
236#define msg_pspew(...) print(MSG_BARF, __VA_ARGS__) /* programmer debug barf */
237#define msg_cspew(...) print(MSG_BARF, __VA_ARGS__) /* chip debug barf */
Sean Nelson51e97d72010-01-07 20:09:33 +0000238
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000239/* cli_classic.c */
240int cli_classic(int argc, char *argv[]);
241
Uwe Hermann0846f892007-08-23 13:34:59 +0000242/* layout.c */
Uwe Hermann0846f892007-08-23 13:34:59 +0000243int read_romlayout(char *name);
244int find_romentry(char *name);
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +0000245int handle_romentries(struct flashchip *flash, uint8_t *oldcontents, uint8_t *newcontents);
Uwe Hermann0846f892007-08-23 13:34:59 +0000246
Carl-Daniel Hailfinger00f911e2007-10-15 21:44:47 +0000247/* spi.c */
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000248struct spi_command {
249 unsigned int writecnt;
250 unsigned int readcnt;
251 const unsigned char *writearr;
252 unsigned char *readarr;
253};
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000254int spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann394131e2008-10-18 21:14:13 +0000255 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfinger26f7e642009-09-18 15:50:56 +0000256int spi_send_multicommand(struct spi_command *cmds);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000257uint32_t spi_get_valid_read_addr(void);
Mats Erik Andersson44e1a192008-09-26 13:19:02 +0000258
Ollie Lho761bf1b2004-03-20 16:46:10 +0000259#endif /* !__FLASH_H__ */