blob: c91e9540388d5a850c5b28489f340965687e97b9 [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
David Hendricks8bb20212011-06-14 01:35:36 +000043int register_shutdown(int (*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 Hailfinger1a227952011-07-27 07:13:06 +000060 BUS_NONE = 0,
61 BUS_PARALLEL = 1 << 0,
62 BUS_LPC = 1 << 1,
63 BUS_FWH = 1 << 2,
64 BUS_SPI = 1 << 3,
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000065 BUS_PROG = 1 << 4,
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +000066 BUS_NONSPI = BUS_PARALLEL | BUS_LPC | BUS_FWH,
Carl-Daniel Hailfinger1dfe0ff2009-05-31 17:57:34 +000067};
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
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000110 /* Total chip size in kilobytes */
Stefan Tauner8c357452011-09-18 22:42:18 +0000111 int total_size;
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000112 /* Chip page size in bytes */
Stefan Tauner8c357452011-09-18 22:42:18 +0000113 int page_size;
Sean Nelsonc57a9202010-01-04 17:15:23 +0000114 int feature_bits;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000115
Uwe Hermann394131e2008-10-18 21:14:13 +0000116 /*
117 * Indicate if flashrom has been tested with this flash chip and if
Peter Stuge1159d582008-05-03 04:34:37 +0000118 * everything worked correctly.
119 */
120 uint32_t tested;
121
Uwe Hermann0b7afe62007-04-01 19:44:21 +0000122 int (*probe) (struct flashchip *flash);
Maciej Pijankac6e11112009-06-03 14:46:22 +0000123
124 /* Delay after "enter/exit ID mode" commands in microseconds. */
Stefan Tauner8c357452011-09-18 22:42:18 +0000125 int probe_timing;
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000126
127 /*
Carl-Daniel Hailfinger63ce4bb2009-12-22 13:04:53 +0000128 * Erase blocks and associated erase function. Any chip erase function
129 * is stored as chip-sized virtual block together with said function.
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000130 * The first one that fits will be chosen. There is currently no way to
131 * influence that behaviour. For testing just comment out the other
132 * elements or set the function pointer to NULL.
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000133 */
134 struct block_eraser {
135 struct eraseblock{
Stefan Taunerd06d9412011-06-12 19:47:55 +0000136 unsigned int size; /* Eraseblock size in bytes */
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000137 unsigned int count; /* Number of contiguous blocks with that size */
138 } eraseblocks[NUM_ERASEREGIONS];
Stefan Tauner355cbfd2011-05-28 02:37:14 +0000139 /* a block_erase function should try to erase one block of size
140 * 'blocklen' at address 'blockaddr' and return 0 on success. */
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000141 int (*block_erase) (struct flashchip *flash, unsigned int blockaddr, unsigned int blocklen);
142 } block_erasers[NUM_ERASEFUNCTIONS];
143
Sean Nelson6e0b9122010-02-19 00:52:10 +0000144 int (*printlock) (struct flashchip *flash);
145 int (*unlock) (struct flashchip *flash);
Stefan Tauner8c357452011-09-18 22:42:18 +0000146 int (*write) (struct flashchip *flash, uint8_t *buf, int start, int len);
147 int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len);
Steven Zakuleccbe370e2011-06-03 07:26:31 +0000148 struct {
149 uint16_t min;
150 uint16_t max;
151 } voltage;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000152
Uwe Hermann372eeb52007-12-04 21:49:06 +0000153 /* Some flash devices have an additional register space. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000154 chipaddr virtual_memory;
155 chipaddr virtual_registers;
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000156};
157
Peter Stuge1159d582008-05-03 04:34:37 +0000158#define TEST_UNTESTED 0
159
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000160#define TEST_OK_PROBE (1 << 0)
161#define TEST_OK_READ (1 << 1)
162#define TEST_OK_ERASE (1 << 2)
163#define TEST_OK_WRITE (1 << 3)
164#define TEST_OK_PR (TEST_OK_PROBE | TEST_OK_READ)
165#define TEST_OK_PRE (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE)
Carl-Daniel Hailfingera06287c2009-09-23 22:01:33 +0000166#define TEST_OK_PRW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_WRITE)
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000167#define TEST_OK_PREW (TEST_OK_PROBE | TEST_OK_READ | TEST_OK_ERASE | TEST_OK_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000168#define TEST_OK_MASK 0x0f
169
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000170#define TEST_BAD_PROBE (1 << 4)
171#define TEST_BAD_READ (1 << 5)
172#define TEST_BAD_ERASE (1 << 6)
173#define TEST_BAD_WRITE (1 << 7)
174#define TEST_BAD_PREW (TEST_BAD_PROBE | TEST_BAD_READ | TEST_BAD_ERASE | TEST_BAD_WRITE)
Peter Stuge1159d582008-05-03 04:34:37 +0000175#define TEST_BAD_MASK 0xf0
176
Maciej Pijankac6e11112009-06-03 14:46:22 +0000177/* Timing used in probe routines. ZERO is -2 to differentiate between an unset
178 * field and zero delay.
179 *
180 * SPI devices will always have zero delay and ignore this field.
181 */
182#define TIMING_FIXME -1
183/* this is intentionally same value as fixme */
184#define TIMING_IGNORED -1
185#define TIMING_ZERO -2
186
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000187extern const struct flashchip flashchips[];
Ollie Lho184a4042005-11-26 21:55:36 +0000188
Uwe Hermannba290d12009-06-17 12:07:12 +0000189/* print.c */
190char *flashbuses_to_text(enum chipbustype bustype);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000191void print_supported(void);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000192void print_supported_wiki(void);
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000193
Uwe Hermann0846f892007-08-23 13:34:59 +0000194/* flashrom.c */
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000195enum write_granularity {
196 write_gran_1bit,
197 write_gran_1byte,
198 write_gran_256bytes,
199};
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000200extern enum chipbustype buses_supported;
Uwe Hermannad216bf2009-04-24 16:17:41 +0000201extern int verbose;
Mathias Krausea60faab2011-01-17 07:50:42 +0000202extern const char flashrom_version[];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000203extern char *chip_to_probe;
Peter Stuge776d2022009-01-26 00:39:57 +0000204void map_flash_registers(struct flashchip *flash);
Stefan Tauner8c357452011-09-18 22:42:18 +0000205int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000206int erase_flash(struct flashchip *flash);
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000207int probe_flash(int startchip, struct flashchip *fill_flash, int force);
Stefan Tauner66652442011-06-26 17:38:17 +0000208int read_flash_to_file(struct flashchip *flash, const char *filename);
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000209int min(int a, int b);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000210int max(int a, int b);
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000211void tolower_string(char *str);
Stefan Tauner66652442011-06-26 17:38:17 +0000212char *extract_param(char **haystack, const char *needle, const char *delim);
Stefan Tauner8c357452011-09-18 22:42:18 +0000213int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, const char *message);
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000214int need_erase(uint8_t *have, uint8_t *want, int len, enum write_granularity gran);
Uwe Hermannba290d12009-06-17 12:07:12 +0000215char *strcat_realloc(char *dest, const char *src);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000216void print_version(void);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000217void print_banner(void);
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +0000218void list_programmers_linebreak(int startcol, int cols, int paren);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000219int selfcheck(void);
Stefan Tauner66652442011-06-26 17:38:17 +0000220int doit(struct flashchip *flash, int force, const char *filename, int read_it, int write_it, int erase_it, int verify_it);
221int read_buf_from_file(unsigned char *buf, unsigned long size, const char *filename);
222int write_buf_to_file(unsigned char *buf, unsigned long size, const char *filename);
Uwe Hermannba290d12009-06-17 12:07:12 +0000223
224#define OK 0
225#define NT 1 /* Not tested */
Uwe Hermann0846f892007-08-23 13:34:59 +0000226
Tadas Slotkusad470342011-09-03 17:15:00 +0000227/* Something happened that shouldn't happen, but we can go on. */
Michael Karchera4448d92010-07-22 18:04:15 +0000228#define ERROR_NONFATAL 0x100
229
Tadas Slotkusad470342011-09-03 17:15:00 +0000230/* Something happened that shouldn't happen, we'll abort. */
231#define ERROR_FATAL -0xee
232
Sean Nelson51e97d72010-01-07 20:09:33 +0000233/* cli_output.c */
Carl-Daniel Hailfinger9f5f2152010-06-04 23:20:21 +0000234/* Let gcc and clang check for correct printf-style format strings. */
235int print(int type, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
Carl-Daniel Hailfingerf8dda682010-01-09 03:22:31 +0000236#define MSG_ERROR 0
237#define MSG_INFO 1
238#define MSG_DEBUG 2
Stefan Taunereebeb532011-08-04 17:40:25 +0000239#define MSG_DEBUG2 3
240#define MSG_BARF 4
Carl-Daniel Hailfingerf8dda682010-01-09 03:22:31 +0000241#define msg_gerr(...) print(MSG_ERROR, __VA_ARGS__) /* general errors */
242#define msg_perr(...) print(MSG_ERROR, __VA_ARGS__) /* programmer errors */
243#define msg_cerr(...) print(MSG_ERROR, __VA_ARGS__) /* chip errors */
244#define msg_ginfo(...) print(MSG_INFO, __VA_ARGS__) /* general info */
245#define msg_pinfo(...) print(MSG_INFO, __VA_ARGS__) /* programmer info */
246#define msg_cinfo(...) print(MSG_INFO, __VA_ARGS__) /* chip info */
247#define msg_gdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* general debug */
248#define msg_pdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* programmer debug */
249#define msg_cdbg(...) print(MSG_DEBUG, __VA_ARGS__) /* chip debug */
Stefan Taunereebeb532011-08-04 17:40:25 +0000250#define msg_gdbg2(...) print(MSG_DEBUG2, __VA_ARGS__) /* general debug2 */
251#define msg_pdbg2(...) print(MSG_DEBUG2, __VA_ARGS__) /* programmer debug2 */
252#define msg_cdbg2(...) print(MSG_DEBUG2, __VA_ARGS__) /* chip debug2 */
Carl-Daniel Hailfingerf8dda682010-01-09 03:22:31 +0000253#define msg_gspew(...) print(MSG_BARF, __VA_ARGS__) /* general debug barf */
254#define msg_pspew(...) print(MSG_BARF, __VA_ARGS__) /* programmer debug barf */
255#define msg_cspew(...) print(MSG_BARF, __VA_ARGS__) /* chip debug barf */
Sean Nelson51e97d72010-01-07 20:09:33 +0000256
Uwe Hermann0846f892007-08-23 13:34:59 +0000257/* layout.c */
Uwe Hermann0846f892007-08-23 13:34:59 +0000258int read_romlayout(char *name);
259int find_romentry(char *name);
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +0000260int handle_romentries(struct flashchip *flash, uint8_t *oldcontents, uint8_t *newcontents);
Uwe Hermann0846f892007-08-23 13:34:59 +0000261
Carl-Daniel Hailfinger00f911e2007-10-15 21:44:47 +0000262/* spi.c */
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000263struct spi_command {
264 unsigned int writecnt;
265 unsigned int readcnt;
266 const unsigned char *writearr;
267 unsigned char *readarr;
268};
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +0000269int spi_send_command(unsigned int writecnt, unsigned int readcnt,
Uwe Hermann394131e2008-10-18 21:14:13 +0000270 const unsigned char *writearr, unsigned char *readarr);
Carl-Daniel Hailfinger26f7e642009-09-18 15:50:56 +0000271int spi_send_multicommand(struct spi_command *cmds);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000272uint32_t spi_get_valid_read_addr(void);
Mats Erik Andersson44e1a192008-09-26 13:19:02 +0000273
Ollie Lho761bf1b2004-03-20 16:46:10 +0000274#endif /* !__FLASH_H__ */