removed spd_dump.c, it has nothing to do with flashing flash parts.
[coreboot.git] / util / flash_and_burn / flash_rom.c
1 /*
2  * flash_rom.c: Flash programming utility for SiS 630/950 M/Bs
3  *
4  *
5  * Copyright 2000 Silicon Integrated System Corporation
6  *
7  *      This program is free software; you can redistribute it and/or modify
8  *      it under the terms of the GNU General Public License as published by
9  *      the Free Software Foundation; either version 2 of the License, or
10  *      (at your option) any later version.
11  *
12  *      This program is distributed in the hope that it will be useful,
13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *      GNU General Public License for more details.
16  *
17  *      You should have received a copy of the GNU General Public License
18  *      along with this program; if not, write to the Free Software
19  *      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  *
22  * Reference:
23  *      1. SiS 630 Specification
24  *      2. SiS 950 Specification
25  *
26  * $Id$
27  */
28
29 #include <errno.h>
30 #include <fcntl.h>
31 #include <sys/mman.h>
32 #include <unistd.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <stdlib.h>
36
37 #include "flash.h"
38 #include "jedec.h"
39 #include "m29f400bt.h"
40 #include "82802ab.h"
41 #include "msys_doc.h"
42 #include "am29f040b.h"
43 #include "sst28sf040.h"
44 #include "w49f002u.h"
45 #include "sst39sf020.h"
46 #include "sst49lf040.h"
47 #include "pm49fl004.h"
48 #include "mx29f002.h"
49
50 struct flashchip flashchips[] = {
51         {"Am29F040B",   AMD_ID,     AM_29F040B,   NULL, 512, 64*1024,
52          probe_29f040b, erase_29f040b, write_29f040b, NULL},
53         {"At29C040A",   ATMEL_ID,   AT_29C040A,   NULL, 512, 256,
54          probe_jedec,   erase_jedec,   write_jedec, NULL},
55         {"Mx29f002",    MX_ID,      MX_29F002,    NULL, 256, 64*1024,
56          probe_29f002,  erase_29f002,  write_29f002, NULL},
57         {"SST29EE020A", SST_ID,     SST_29EE020A, NULL, 256, 128,
58          probe_jedec,   erase_jedec,   write_jedec, NULL},
59         {"SST28SF040A", SST_ID,     SST_28SF040,  NULL, 512, 256,
60          probe_28sf040, erase_28sf040, write_28sf040, NULL},
61         {"SST39SF020A", SST_ID,     SST_39SF020,  NULL, 256, 4096,
62          probe_39sf020, erase_39sf020, write_39sf020, NULL},
63         {"SST39VF020",  SST_ID,     SST_39VF020,  NULL, 256, 4096,
64          probe_39sf020, erase_39sf020, write_39sf020, NULL},
65         {"SST49LF040",  SST_ID, SST_49LF040,  NULL, 512, 4096,
66          probe_49lf040, erase_49lf040, write_49lf040, NULL},
67         //By LYH begin
68         {"Pm49FL004",   PMC_ID,     PMC_49FL004,  NULL, 512, 64*1024,
69          probe_49fl004, erase_49fl004, write_49fl004, NULL},
70         //END
71         {"W29C011",     WINBOND_ID, W_29C011,    NULL, 128, 128,
72          probe_jedec,   erase_jedec,   write_jedec, NULL},
73         {"W29C020C",    WINBOND_ID, W_29C020C,    NULL, 256, 128,
74          probe_jedec,   erase_jedec,   write_jedec, NULL},
75         {"W49F002U",    WINBOND_ID, W_49F002U,    NULL, 256, 128,
76          probe_49f002,  erase_49f002,   write_49f002, NULL},
77         {"M29F400BT",   ST_ID, ST_M29F400BT ,    NULL, 512, 64*1024,
78          probe_m29f400bt,   erase_m29f400bt,   write_linuxbios_m29f400bt, NULL},
79         {"82802ab",     137,   173 ,    NULL, 512, 64*1024,
80          probe_82802ab, erase_82802ab,   write_82802ab, NULL},
81         {"82802ac",     137,   172 ,    NULL, 1024, 64*1024,
82          probe_82802ab, erase_82802ab,   write_82802ab, NULL},
83         {"MD-2802 (M-Systems DiskOnChip Millennium Module)",
84          MSYSTEMS_ID, MSYSTEMS_MD2802,
85          NULL, 8, 8*1024,
86          probe_md2802, erase_md2802, write_md2802, read_md2802},
87         {NULL,}
88 };
89
90 char *chip_to_probe = NULL;
91
92 struct flashchip * probe_flash(struct flashchip * flash)
93 {
94         int fd_mem;
95         volatile char * bios;
96         unsigned long size;
97
98         if ((fd_mem = open("/dev/mem", O_RDWR)) < 0) {
99                 perror("Can not open /dev/mem");
100                 exit(1);
101         }
102
103         while (flash->name != NULL) {
104                 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0) {
105                         flash++;
106                         continue;
107                 }
108                 printf("Trying %s, %d KB\n", flash->name, flash->total_size);
109                 size = flash->total_size * 1024;
110                 /* BUG? what happens if getpagesize() > size!?
111                    -> ``Error MMAP /dev/mem: Invalid argument'' NIKI */
112                 if (getpagesize() > size) {
113                         size = getpagesize();
114                         printf("%s: warning: size: %d -> %ld\n", __FUNCTION__,
115                                flash->total_size * 1024, (unsigned long)size);
116                 }
117                 bios = mmap (0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
118                              //fd_mem, (off_t) (0x100000000-size));
119                              fd_mem, (off_t) (0xffffffff-size+1));
120                 if (bios == MAP_FAILED) {
121                         perror("Error MMAP /dev/mem");
122                         exit(1);
123                 }
124                 flash->virt_addr = bios;
125                 flash->fd_mem = fd_mem;
126
127                 if (flash->probe(flash) == 1) {
128                         printf ("%s found at physical address: 0x%lx\n",
129                                 flash->name, (0 - size));
130                         return flash;
131                 }
132                 munmap ((void *) bios, size);
133                 flash++;
134         }
135         return NULL;
136 }
137
138 int verify_flash (struct flashchip * flash, char * buf, int verbose)
139 {
140         int i = 0;
141         int total_size = flash->total_size *1024;
142         volatile char * bios = flash->virt_addr;
143
144         printf("Verifying address: ");
145         while (i++ < total_size) {
146                 if (verbose) 
147                         printf("0x%08x", i);
148                 if (*(bios+i) != *(buf+i)) {
149                         printf("FAILED\n");
150                         return 0;
151                 }
152                 if (verbose) 
153                         printf("\b\b\b\b\b\b\b\b\b\b");
154         }
155         if (verbose)
156                 printf("\n");
157         else
158                 printf("VERIFIED\n");
159         return 1;
160 }
161
162
163 void usage(const char *name)
164 {
165         printf("usage: %s [-rwv] [-c chipname][file]\n", name);
166         printf("-r: read flash and save into file\n"
167                "-w: write file into flash (default when file is specified)\n"
168                "-v: verify flash against file\n"
169                "-c: probe only for specified flash chip\n"
170                " If no file is specified, then all that happens\n"
171                " is that flash info is dumped\n");
172         exit(1);
173 }
174
175 int main (int argc, char * argv[])
176 {
177         char * buf;
178         unsigned long size;
179         FILE * image;
180         struct flashchip * flash;
181         int opt;
182         int read_it = 0, write_it = 0, verify_it = 0;
183         char *filename = NULL;
184
185         setbuf(stdout, NULL);
186
187         while ((opt = getopt(argc, argv, "rwvc:")) != EOF) {
188                 switch (opt) {
189                 case 'r':
190                         read_it = 1;
191                         break;
192                 case 'w':
193                         write_it = 1;
194                         break;
195                 case 'v':
196                         verify_it = 1;
197                         break;
198                 case 'c':
199                         chip_to_probe = strdup(optarg);
200                         break;
201                 default:
202                         usage(argv[0]);
203                         break;
204                 }
205         }
206         if (read_it && write_it) {
207                 printf("-r and -w are mutually exclusive\n");
208                 usage(argv[0]);
209         }
210
211         if (optind < argc)
212                 filename = argv[optind++];
213
214         printf("Calibrating timer since microsleep sucks ... takes a second\n");
215         myusec_calibrate_delay();
216         printf("OK, calibrated, now do the deed\n");
217
218         /* try to enable it. Failure IS an option, since not all motherboards
219          * really need this to be done, etc., etc. It sucks.
220          */
221         (void) enable_flash_write();
222     
223         if ((flash = probe_flash (flashchips)) == NULL) {
224                 printf("EEPROM not found\n");
225                 exit(1);
226         }
227
228         printf("Part is %s\n", flash->name);
229         if (!filename){
230                 printf("OK, only ENABLING flash write, but NOT FLASHING\n");
231                 return 0;
232         }
233         size = flash->total_size * 1024;
234         buf = (char *) calloc (size, sizeof(char));
235
236         if (read_it) {
237                 if ((image = fopen (filename, "w")) == NULL) {
238                         perror(filename);
239                         exit(1);
240                 }
241                 printf("Reading Flash...");
242                 if(flash->read == NULL)
243                         memcpy(buf, (const char *) flash->virt_addr, size);
244                 else
245                         flash->read (flash, buf);
246                 fwrite(buf, sizeof(char), size, image);
247                 fclose(image);
248                 printf("done\n");
249         } else {
250                 if ((image = fopen (filename, "r")) == NULL) {
251                         perror(filename);
252                         exit(1);
253                 }
254                 fread (buf, sizeof(char), size, image);
255                 fclose(image);
256         }
257
258         if (write_it || (!read_it && !verify_it))
259                 flash->write (flash, buf);
260         if (verify_it)
261                 verify_flash (flash, buf, /* verbose = */ 0);
262         return 0;
263 }