blob: b1ca7b3466cec9ce5520274b87761ab831e03174 [file] [log] [blame]
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001/*
Ollie Lho184a4042005-11-26 21:55:36 +00002 * flash_rom.c: Flash programming utility
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00003 *
4 * Copyright 2000 Silicon Integrated System Corporation
Yinghai Luad8ffd22004-10-20 05:07:16 +00005 * Copyright 2004 Tyan Corp
6 * yhlu yhlu@tyan.com add exclude start and end option
Stefan Reinauerfcb63682006-03-16 16:57:41 +00007 * Copyright 2005-2006 coresystems GmbH
8 * Stefan Reinauer <stepan@coresystems.de> added rom layout
9 * support, and checking for suitable rom image, various fixes
10 * support for flashing the Technologic Systems 5300.
Ollie Lho184a4042005-11-26 21:55:36 +000011 *
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000012 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 *
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000026 */
27
28#include <errno.h>
29#include <fcntl.h>
30#include <sys/mman.h>
Stefan Reinauer018aca82006-11-21 23:48:51 +000031#include <sys/types.h>
32#include <sys/stat.h>
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000033#include <unistd.h>
34#include <stdio.h>
Ronald G. Minnichceec4202003-07-25 04:37:41 +000035#include <string.h>
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000036#include <stdlib.h>
Ollie Lho184a4042005-11-26 21:55:36 +000037#include <getopt.h>
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000038
39#include "flash.h"
Ollie Lho184a4042005-11-26 21:55:36 +000040#include "lbtable.h"
41#include "layout.h"
42#include "debug.h"
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000043
Ronald G. Minnichceec4202003-07-25 04:37:41 +000044char *chip_to_probe = NULL;
Ronald G. Minnich7bd1dee2003-05-08 19:33:19 +000045
Stefan Reinauere3705282005-12-18 16:41:10 +000046int exclude_start_page, exclude_end_page;
47int force=0, verbose=0;
48
Ollie Lho761bf1b2004-03-20 16:46:10 +000049struct flashchip *probe_flash(struct flashchip *flash)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000050{
Ollie Lhocbbf1252004-03-17 22:22:08 +000051 int fd_mem;
Ollie Lho184a4042005-11-26 21:55:36 +000052 volatile uint8_t *bios;
Ollie Lhocbbf1252004-03-17 22:22:08 +000053 unsigned long size;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000054
Ollie Lhocbbf1252004-03-17 22:22:08 +000055 if ((fd_mem = open("/dev/mem", O_RDWR)) < 0) {
Stefan Reinauerf8337dd2006-08-03 10:49:09 +000056 perror("Error: Can not open /dev/mem. You need to be root.");
Ollie Lhocbbf1252004-03-17 22:22:08 +000057 exit(1);
58 }
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000059
Ollie Lhocbbf1252004-03-17 22:22:08 +000060 while (flash->name != NULL) {
Ollie Lho8b8897a2004-03-27 00:18:15 +000061 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0) {
Ollie Lhocbbf1252004-03-17 22:22:08 +000062 flash++;
63 continue;
64 }
Ollie Lho184a4042005-11-26 21:55:36 +000065 printf_debug("Trying %s, %d KB\n", flash->name, flash->total_size);
Ollie Lhocbbf1252004-03-17 22:22:08 +000066 size = flash->total_size * 1024;
67 /* BUG? what happens if getpagesize() > size!?
68 -> ``Error MMAP /dev/mem: Invalid argument'' NIKI */
69 if (getpagesize() > size) {
70 size = getpagesize();
Ollie Lho761bf1b2004-03-20 16:46:10 +000071 printf("%s: warning: size: %d -> %ld\n",
72 __FUNCTION__, flash->total_size * 1024,
73 (unsigned long) size);
Ollie Lhocbbf1252004-03-17 22:22:08 +000074 }
Ollie Lho761bf1b2004-03-20 16:46:10 +000075 bios = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
76 fd_mem, (off_t) (0xffffffff - size + 1));
Ollie Lhocbbf1252004-03-17 22:22:08 +000077 if (bios == MAP_FAILED) {
Stefan Reinauerf8337dd2006-08-03 10:49:09 +000078 perror("Error: Can't mmap /dev/mem.");
Ollie Lhocbbf1252004-03-17 22:22:08 +000079 exit(1);
80 }
81 flash->virt_addr = bios;
82 flash->fd_mem = fd_mem;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000083
Ollie Lhocbbf1252004-03-17 22:22:08 +000084 if (flash->probe(flash) == 1) {
Ollie Lho761bf1b2004-03-20 16:46:10 +000085 printf("%s found at physical address: 0x%lx\n",
86 flash->name, (0xffffffff - size + 1));
Ollie Lhocbbf1252004-03-17 22:22:08 +000087 return flash;
88 }
Ollie Lho761bf1b2004-03-20 16:46:10 +000089 munmap((void *) bios, size);
Stefan Reinauerfcb63682006-03-16 16:57:41 +000090#ifdef TS5300
91 /* TS-5300 */
92 bios = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
93 fd_mem, (off_t) (0x9400000));
94 if (bios == MAP_FAILED) {
Stefan Reinauerf8337dd2006-08-03 10:49:09 +000095 perror("Error: Can't mmap /dev/mem.");
Stefan Reinauerfcb63682006-03-16 16:57:41 +000096 exit(1);
97 }
98 flash->virt_addr = bios;
99 flash->fd_mem = fd_mem;
100
101 if (flash->probe(flash) == 1) {
102 printf("TS-5300 %s found at physical address: 0x%lx\n",
103 flash->name, 0x9400000UL);
104 return flash;
105 }
106 munmap((void *) bios, size);
107 /* TS-5300 */
108#endif
109
Ollie Lhocbbf1252004-03-17 22:22:08 +0000110 flash++;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000111 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000112 return NULL;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000113}
114
Stefan Reinauere3705282005-12-18 16:41:10 +0000115int verify_flash(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000116{
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000117 int idx;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000118 int total_size = flash->total_size * 1024;
Ollie Lho184a4042005-11-26 21:55:36 +0000119 volatile uint8_t *bios = flash->virt_addr;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000120
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000121 printf("Verifying flash ");
122
123 if(verbose) printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");
124
125 for (idx = 0; idx < total_size; idx++) {
126 if (verbose && ( (idx & 0xfff) == 0xfff ))
127 printf("0x%08x", idx);
128
129 if (*(bios + idx) != *(buf + idx)) {
130 if (verbose) {
131 printf("0x%08x ", idx);
132 }
133 printf("- FAILED\n");
134 return 1;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000135 }
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000136
137 if (verbose && ( (idx & 0xfff) == 0xfff ))
Ollie Lhocbbf1252004-03-17 22:22:08 +0000138 printf("\b\b\b\b\b\b\b\b\b\b");
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000139 }
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000140 if (verbose)
141 printf("\b\b\b\b\b\b\b\b\b\b ");
142
143 printf("- VERIFIED \n");
144 return 0;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000145}
146
Ronald G. Minnichc73ad982003-02-11 21:06:09 +0000147
Ronald G. Minniche5559572003-03-28 03:29:43 +0000148void usage(const char *name)
149{
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000150 printf("usage: %s [-rwvEVfh] [-c chipname] [-s exclude_start]\n", name);
151 printf(" [-e exclude_end] [-m vendor:part] [-l file.layout] [-i imagename] [file]\n");
152 printf(" -r | --read: read flash and save into file\n"
153 " -w | --write: write file into flash (default when\n"
154 " file is specified)\n"
155 " -v | --verify: verify flash against file\n"
156 " -E | --erase: erase flash device\n"
157 " -V | --verbose: more verbose output\n"
158 " -c | --chip <chipname>: probe only for specified flash chip\n"
159 " -s | --estart <addr>: exclude start position\n"
160 " -e | --eend <addr>: exclude end postion\n"
Ollie Lho184a4042005-11-26 21:55:36 +0000161 " -m | --mainboard <vendor:part>: override mainboard settings\n"
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000162 " -f | --force: force write without checking image\n"
163 " -l | --layout <file.layout>: read rom layout from file\n"
164 " -i | --image <name>: only flash image name from flash layout\n"
Ollie Lho184a4042005-11-26 21:55:36 +0000165 "\n"
Ollie Lhocbbf1252004-03-17 22:22:08 +0000166 " If no file is specified, then all that happens\n"
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000167 " is that flash info is dumped.\n\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000168 exit(1);
Ronald G. Minniche5559572003-03-28 03:29:43 +0000169}
170
Ollie Lho761bf1b2004-03-20 16:46:10 +0000171int main(int argc, char *argv[])
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000172{
Ollie Lho184a4042005-11-26 21:55:36 +0000173 uint8_t *buf;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000174 unsigned long size;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000175 FILE *image;
176 struct flashchip *flash;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000177 int opt;
Ollie Lho184a4042005-11-26 21:55:36 +0000178 int option_index = 0;
179 int read_it = 0,
180 write_it = 0,
181 erase_it = 0,
182 verify_it = 0;
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000183 int ret = 0;
Ollie Lho184a4042005-11-26 21:55:36 +0000184
185 static struct option long_options[]= {
186 { "read", 0, 0, 'r' },
187 { "write", 0, 0, 'w' },
188 { "erase", 0, 0, 'E' },
189 { "verify", 0, 0, 'v' },
190 { "chip", 1, 0, 'c' },
191 { "estart", 1, 0, 's' },
192 { "eend", 1, 0, 'e' },
193 { "mainboard", 1, 0, 'm' },
194 { "verbose", 0, 0, 'V' },
195 { "force", 0, 0, 'f' },
196 { "layout", 1, 0, 'l' },
197 { "image", 1, 0, 'i' },
198 { "help", 0, 0, 'h' },
199 { 0, 0, 0, 0 }
200 };
201
Ollie Lhocbbf1252004-03-17 22:22:08 +0000202 char *filename = NULL;
Ronald G. Minnichceec4202003-07-25 04:37:41 +0000203
Yinghai Luad8ffd22004-10-20 05:07:16 +0000204
205 unsigned int exclude_start_position=0, exclude_end_position=0; // [x,y)
Ollie Lho184a4042005-11-26 21:55:36 +0000206 char *tempstr=NULL, *tempstr2=NULL;
Yinghai Luad8ffd22004-10-20 05:07:16 +0000207
208 if (argc > 1) {
209 /* Yes, print them. */
210 int i;
Ollie Lho184a4042005-11-26 21:55:36 +0000211 printf_debug ("The arguments are:\n");
Yinghai Luad8ffd22004-10-20 05:07:16 +0000212 for (i = 1; i < argc; ++i)
Ollie Lho184a4042005-11-26 21:55:36 +0000213 printf_debug ("%s\n", argv[i]);
Yinghai Luad8ffd22004-10-20 05:07:16 +0000214 }
215
Ollie Lhocbbf1252004-03-17 22:22:08 +0000216 setbuf(stdout, NULL);
Ollie Lho184a4042005-11-26 21:55:36 +0000217 while ((opt = getopt_long(argc, argv, "rwvVEfc:s:e:m:l:i:h", long_options,
218 &option_index)) != EOF) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000219 switch (opt) {
220 case 'r':
221 read_it = 1;
222 break;
223 case 'w':
224 write_it = 1;
225 break;
226 case 'v':
227 verify_it = 1;
228 break;
229 case 'c':
230 chip_to_probe = strdup(optarg);
231 break;
Ollie Lho789ad3d2004-03-18 20:27:33 +0000232 case 'V':
233 verbose = 1;
234 break;
Ollie Lhoefa28582004-12-08 20:10:01 +0000235 case 'E':
236 erase_it = 1;
237 break;
Yinghai Luad8ffd22004-10-20 05:07:16 +0000238 case 's':
239 tempstr = strdup(optarg);
240 sscanf(tempstr,"%x",&exclude_start_position);
241 break;
242 case 'e':
Ollie Lho98bea8a2004-12-07 03:15:51 +0000243 tempstr = strdup(optarg);
244 sscanf(tempstr,"%x",&exclude_end_position);
245 break;
Ollie Lho184a4042005-11-26 21:55:36 +0000246 case 'm':
247 tempstr = strdup(optarg);
248 strtok(tempstr, ":");
249 tempstr2=strtok(NULL, ":");
250 if (tempstr2) {
251 lb_vendor=tempstr;
252 lb_part=tempstr2;
253 } else {
254 printf("warning: ignored wrong format of"
255 " mainboard: %s\n", tempstr);
256 }
257 break;
258 case 'f':
259 force=1;
260 break;
261 case 'l':
262 tempstr=strdup(optarg);
263 read_romlayout(tempstr);
264 break;
265 case 'i':
266 tempstr=strdup(optarg);
267 find_romentry(tempstr);
268 break;
269 case 'h':
Ollie Lhocbbf1252004-03-17 22:22:08 +0000270 default:
271 usage(argv[0]);
272 break;
273 }
274 }
Yinghai Luad8ffd22004-10-20 05:07:16 +0000275
Ollie Lhocbbf1252004-03-17 22:22:08 +0000276 if (read_it && write_it) {
277 printf("-r and -w are mutually exclusive\n");
278 usage(argv[0]);
279 }
Ronald G. Minniche5559572003-03-28 03:29:43 +0000280
Ollie Lhocbbf1252004-03-17 22:22:08 +0000281 if (optind < argc)
282 filename = argv[optind++];
Ronald G. Minniche5559572003-03-28 03:29:43 +0000283
Ollie Lho184a4042005-11-26 21:55:36 +0000284 printf("Calibrating delay loop... ");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000285 myusec_calibrate_delay();
Ollie Lho184a4042005-11-26 21:55:36 +0000286 printf("ok\n");
287
288 /* We look at the lbtable first to see if we need a
289 * mainboard specific flash enable sequence.
290 */
291 linuxbios_init();
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000292
Ollie Lhocbbf1252004-03-17 22:22:08 +0000293 /* try to enable it. Failure IS an option, since not all motherboards
Ollie Lho184a4042005-11-26 21:55:36 +0000294 * really need this to be done, etc., etc.
Ollie Lhocbbf1252004-03-17 22:22:08 +0000295 */
296 (void) enable_flash_write();
Ollie Lho761bf1b2004-03-20 16:46:10 +0000297
298 if ((flash = probe_flash(flashchips)) == NULL) {
Ollie Lho184a4042005-11-26 21:55:36 +0000299 printf("No EEPROM/flash device found.\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000300 exit(1);
301 }
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000302
Uwe Hermannd1915c12006-10-07 00:23:51 +0000303 printf("Flash part is %s (%d KB)\n", flash->name, flash->total_size);
Ollie Lho184a4042005-11-26 21:55:36 +0000304
Ollie Lhoefa28582004-12-08 20:10:01 +0000305 if (!filename && !erase_it) {
Ollie Lho184a4042005-11-26 21:55:36 +0000306 // FIXME: Do we really want this feature implicitly?
307 printf("OK, only ENABLING flash write, but NOT FLASHING.\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000308 return 0;
309 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000310
Ollie Lho184a4042005-11-26 21:55:36 +0000311 size = flash->total_size * 1024;
312 buf = (uint8_t *) calloc(size, sizeof(char));
313
Ollie Lhoefa28582004-12-08 20:10:01 +0000314 if (erase_it) {
315 printf("Erasing flash chip\n");
316 flash->erase(flash);
317 exit(0);
318 } else if (read_it) {
Ollie Lho761bf1b2004-03-20 16:46:10 +0000319 if ((image = fopen(filename, "w")) == NULL) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000320 perror(filename);
321 exit(1);
322 }
323 printf("Reading Flash...");
Ollie Lho73eca802004-03-19 22:10:07 +0000324 if (flash->read == NULL)
Ollie Lhocbbf1252004-03-17 22:22:08 +0000325 memcpy(buf, (const char *) flash->virt_addr, size);
326 else
Ollie Lho761bf1b2004-03-20 16:46:10 +0000327 flash->read(flash, buf);
Yinghai Luad8ffd22004-10-20 05:07:16 +0000328
Ollie Lho98bea8a2004-12-07 03:15:51 +0000329 if (exclude_end_position - exclude_start_position > 0)
330 memset(buf+exclude_start_position, 0,
331 exclude_end_position-exclude_start_position);
Yinghai Luad8ffd22004-10-20 05:07:16 +0000332
Ollie Lhocbbf1252004-03-17 22:22:08 +0000333 fwrite(buf, sizeof(char), size, image);
334 fclose(image);
335 printf("done\n");
336 } else {
Stefan Reinauer018aca82006-11-21 23:48:51 +0000337 struct stat image_stat;
338
Ollie Lho761bf1b2004-03-20 16:46:10 +0000339 if ((image = fopen(filename, "r")) == NULL) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000340 perror(filename);
341 exit(1);
342 }
Stefan Reinauer018aca82006-11-21 23:48:51 +0000343 if (fstat(fileno(image), &image_stat) != 0) {
344 perror(filename);
345 exit(1);
346 }
347 if(image_stat.st_size!=flash->total_size*1024) {
348 perror("Image size doesnt match");
349 exit(1);
350 }
351
Ollie Lho761bf1b2004-03-20 16:46:10 +0000352 fread(buf, sizeof(char), size, image);
Ollie Lho184a4042005-11-26 21:55:36 +0000353 show_id(buf, size);
Ollie Lhocbbf1252004-03-17 22:22:08 +0000354 fclose(image);
355 }
356
Ollie Lho184a4042005-11-26 21:55:36 +0000357 /* exclude range stuff. Nice idea, but at the moment it is only
358 * supported in hardware by the pm49fl004 chips.
359 * Instead of implementing this for all chips I suggest advancing
360 * it to the rom layout feature below and drop exclude range
361 * completely once all flash chips can do rom layouts. stepan
362 */
363
364 // ////////////////////////////////////////////////////////////
Ollie Lho98bea8a2004-12-07 03:15:51 +0000365 if (exclude_end_position - exclude_start_position > 0)
Ollie Lhod11f3612004-12-07 17:19:04 +0000366 memcpy(buf+exclude_start_position,
Ollie Lho98bea8a2004-12-07 03:15:51 +0000367 (const char *) flash->virt_addr+exclude_start_position,
368 exclude_end_position-exclude_start_position);
369
Yinghai Luad8ffd22004-10-20 05:07:16 +0000370 exclude_start_page = exclude_start_position/flash->page_size;
Ollie Lho98bea8a2004-12-07 03:15:51 +0000371 if ((exclude_start_position%flash->page_size) != 0) {
372 exclude_start_page++;
373 }
374 exclude_end_page = exclude_end_position/flash->page_size;
Ollie Lho184a4042005-11-26 21:55:36 +0000375 // ////////////////////////////////////////////////////////////
Yinghai Luad8ffd22004-10-20 05:07:16 +0000376
Ollie Lho184a4042005-11-26 21:55:36 +0000377 // This should be moved into each flash part's code to do it
378 // cleanly. This does the job.
379 handle_romentries(buf, (uint8_t *)flash->virt_addr);
380
381 // ////////////////////////////////////////////////////////////
382
383 if (write_it)
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000384 ret |= flash->write(flash, buf);
Ollie Lho184a4042005-11-26 21:55:36 +0000385
Ollie Lhocbbf1252004-03-17 22:22:08 +0000386 if (verify_it)
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000387 ret |= verify_flash(flash, buf);
Ollie Lho184a4042005-11-26 21:55:36 +0000388
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000389 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000390}