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  * Copyright 2004 Tyan Corp
   7  *      yhlu yhlu@tyan.com add exclude start and end option
   8  *
   9  *      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.
  13  *
  14  *      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.
  18  *
  19  *      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., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  *
  24  * Reference:
  25  *      1. SiS 630 Specification
  26  *      2. SiS 950 Specification
  27  *
  28  * $Id$
  29  */
  30
  31 #include <errno.h>
  32 #include <fcntl.h>
  33 #include <sys/mman.h>
  34 #include <unistd.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <stdlib.h>
  38
  39 #include "flash.h"
  40 #include "jedec.h"
  41 #include "m29f400bt.h"
  42 #include "82802ab.h"
  43 #include "msys_doc.h"
  44 #include "am29f040b.h"
  45 #include "sst28sf040.h"
  46 #include "w49f002u.h"
  47 #include "sst39sf020.h"
  48 #include "sst49lf040.h"
  49 #include "pm49fl004.h"
  50 #include "mx29f002.h"
  51 #include "sst_fwhub.h"
  52
  53 struct flashchip flashchips[] = {
  54         {"Am29F040B",   AMD_ID,         AM_29F040B,     NULL, 512, 64 * 1024,
  55          probe_29f040b, erase_29f040b,  write_29f040b,  NULL},
  56         {"At29C040A",   ATMEL_ID,       AT_29C040A,     NULL, 512, 256,
  57          probe_jedec,   erase_chip_jedec, write_jedec,  NULL},
  58         {"Mx29f002",    MX_ID,          MX_29F002,      NULL, 256, 64 * 1024,
  59          probe_29f002,  erase_29f002,   write_29f002,   NULL},
  60         {"SST29EE020A", SST_ID,         SST_29EE020A,   NULL, 256, 128,
  61          probe_jedec,   erase_chip_jedec, write_jedec,  NULL},
  62         {"SST28SF040A", SST_ID,         SST_28SF040,    NULL, 512, 256,
  63          probe_28sf040, erase_28sf040, write_28sf040,   NULL},
  64         {"SST39SF020A", SST_ID,         SST_39SF020,    NULL, 256, 4096,
  65          probe_jedec,   erase_chip_jedec, write_39sf020,NULL},
  66         {"SST39VF020",  SST_ID,         SST_39VF020,    NULL, 256, 4096,
  67          probe_jedec,   erase_chip_jedec, write_39sf020,NULL},
  68         {"SST49LF040",  SST_ID,         SST_49LF040,    NULL, 512, 4096,
  69          probe_jedec,   erase_49lf040, write_49lf040,NULL},
  70         {"SST49LF080A", SST_ID,         SST_49LF080A,   NULL, 1024, 4096,
  71          probe_jedec,   erase_chip_jedec, write_49lf040,NULL},
  72         {"SST49LF002A/B", SST_ID,       SST_49LF002A,   NULL, 256, 16 * 1024,
  73          probe_sst_fwhub, erase_sst_fwhub, write_sst_fwhub, NULL},
  74         {"SST49LF003A/B", SST_ID,       SST_49LF003A,   NULL, 384, 64 * 1024,
  75          probe_sst_fwhub, erase_sst_fwhub, write_sst_fwhub,NULL},
  76         {"SST49LF004A/B", SST_ID,       SST_49LF004A,   NULL, 512, 64 * 1024,
  77          probe_sst_fwhub, erase_sst_fwhub, write_sst_fwhub,NULL},
  78         {"SST49LF008A", SST_ID,         SST_49LF008A,   NULL, 1024, 64 * 1024 ,
  79          probe_sst_fwhub, erase_sst_fwhub, write_sst_fwhub, NULL},
  80         {"Pm49FL004",   PMC_ID,         PMC_49FL004,    NULL, 512, 64 * 1024,
  81          probe_jedec,   erase_chip_jedec, write_49fl004,NULL},
  82         {"W29C011",     WINBOND_ID,     W_29C011,       NULL, 128, 128,
  83          probe_jedec,   erase_chip_jedec, write_jedec,  NULL},
  84         {"W29C020C",    WINBOND_ID,     W_29C020C,      NULL, 256, 128,
  85          probe_jedec,   erase_chip_jedec, write_jedec,  NULL},
  86         {"W49F002U",    WINBOND_ID,     W_49F002U,      NULL, 256, 128,
  87          probe_jedec,   erase_chip_jedec, write_49f002, NULL},
  88         {"M29F400BT",   ST_ID,          ST_M29F400BT,   NULL, 512, 64 * 1024,
  89          probe_m29f400bt, erase_m29f400bt, write_linuxbios_m29f400bt, NULL},
  90         {"82802ab",     137,            173,            NULL, 512, 64 * 1024,
  91          probe_82802ab, erase_82802ab,  write_82802ab,  NULL},
  92         {"82802ac",     137,            172,            NULL, 1024, 64 * 1024,
  93          probe_82802ab, erase_82802ab,  write_82802ab,  NULL},
  94         {"MD-2802 (M-Systems DiskOnChip Millennium Module)",
  95          MSYSTEMS_ID, MSYSTEMS_MD2802,
  96          NULL, 8, 8 * 1024,
  97          probe_md2802, erase_md2802, write_md2802, read_md2802},
  98         {NULL,}
  99 };
 100
 101 char *chip_to_probe = NULL;
 102
 103 struct flashchip *probe_flash(struct flashchip *flash)
 104 {
 105         int fd_mem;
 106         volatile char *bios;
 107         unsigned long size;
 108
 109         if ((fd_mem = open("/dev/mem", O_RDWR)) < 0) {
 110                 perror("Can not open /dev/mem");
 111                 exit(1);
 112         }
 113
 114         while (flash->name != NULL) {
 115                 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0) {
 116                         flash++;
 117                         continue;
 118                 }
 119                 printf("Trying %s, %d KB\n", flash->name, flash->total_size);
 120                 size = flash->total_size * 1024;
 121                 /* BUG? what happens if getpagesize() > size!?
 122                    -> ``Error MMAP /dev/mem: Invalid argument'' NIKI */
 123                 if (getpagesize() > size) {
 124                         size = getpagesize();
 125                         printf("%s: warning: size: %d -> %ld\n",
 126                                __FUNCTION__, flash->total_size * 1024,
 127                                (unsigned long) size);
 128                 }
 129                 bios = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
 130                             fd_mem, (off_t) (0xffffffff - size + 1));
 131                 if (bios == MAP_FAILED) {
 132                         perror("Error MMAP /dev/mem");
 133                         exit(1);
 134                 }
 135                 flash->virt_addr = bios;
 136                 flash->fd_mem = fd_mem;
 137
 138                 if (flash->probe(flash) == 1) {
 139                         printf("%s found at physical address: 0x%lx\n",
 140                                flash->name, (0xffffffff - size + 1));
 141                         return flash;
 142                 }
 143                 munmap((void *) bios, size);
 144                 flash++;
 145         }
 146         return NULL;
 147 }
 148
 149 int verify_flash(struct flashchip *flash, char *buf, int verbose)
 150 {
 151         int i;
 152         int total_size = flash->total_size * 1024;
 153         volatile char *bios = flash->virt_addr;
 154
 155         printf("Verifying address: ");
 156         for (i = 0; i < total_size; i++) {
 157                 if (verbose)
 158                         printf("0x%08x", i);
 159                 if (*(bios + i) != *(buf + i)) {
 160                         printf("FAILED\n");
 161                         return 0;
 162                 }
 163                 if (verbose)
 164                         printf("\b\b\b\b\b\b\b\b\b\b");
 165         }
 166         if (verbose)
 167                 printf("\n");
 168         else
 169                 printf("VERIFIED\n");
 170         return 1;
 171 }
 172
 173
 174 void usage(const char *name)
 175 {
 176         printf("usage: %s [-rwv] [-c chipname] [-s exclude_start] [-e exclude_end] [file]\n", name);
 177         printf("-r: read flash and save into file\n"
 178                "-w: write file into flash (default when file is specified)\n"
 179                "-v: verify flash against file\n"
 180                "-c: probe only for specified flash chip\n"
 181                "-s: exclude start position\n"
 182                "-e: exclude end postion\n"
 183                " If no file is specified, then all that happens\n"
 184                " is that flash info is dumped\n");
 185         exit(1);
 186 }
 187
 188 int exclude_start_page, exclude_end_page;
 189
 190 int main(int argc, char *argv[])
 191 {
 192         char *buf;
 193         unsigned long size;
 194         FILE *image;
 195         struct flashchip *flash;
 196         int opt;
 197         int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0,
 198                 verbose = 0;
 199         char *filename = NULL;
 200
 201
 202         unsigned int exclude_start_position=0, exclude_end_position=0; // [x,y)
 203         char *tempstr=NULL;
 204
 205         if (argc > 1) {
 206                 /* Yes, print them. */
 207                 int i;
 208                 printf ("The arguments are:\n");
 209                 for (i = 1; i < argc; ++i)
 210                         printf ("%s\n", argv[i]);
 211         }
 212
 213         setbuf(stdout, NULL);
 214
 215         while ((opt = getopt(argc, argv, "rwvVEc:s:e:")) != EOF) {
 216                 switch (opt) {
 217                 case 'r':
 218                         read_it = 1;
 219                         break;
 220                 case 'w':
 221                         write_it = 1;
 222                         break;
 223                 case 'v':
 224                         verify_it = 1;
 225                         break;
 226                 case 'c':
 227                         chip_to_probe = strdup(optarg);
 228                         break;
 229                 case 'V':
 230                         verbose = 1;
 231                         break;
 232                 case 'E':
 233                         erase_it = 1;
 234                         break;
 235                 case 's':
 236                         tempstr = strdup(optarg);
 237                         sscanf(tempstr,"%x",&exclude_start_position);
 238                         break;
 239                 case 'e':
 240                         tempstr = strdup(optarg);
 241                         sscanf(tempstr,"%x",&exclude_end_position);
 242                         break;
 243
 244                 default:
 245                         usage(argv[0]);
 246                         break;
 247                 }
 248         }
 249
 250         if (read_it && write_it) {
 251                 printf("-r and -w are mutually exclusive\n");
 252                 usage(argv[0]);
 253         }
 254
 255         if (optind < argc)
 256                 filename = argv[optind++];
 257
 258         printf("Calibrating timer since microsleep sucks ... takes a second\n");
 259         myusec_calibrate_delay();
 260         printf("OK, calibrated, now do the deed\n");
 261
 262         /* try to enable it. Failure IS an option, since not all motherboards
 263          * really need this to be done, etc., etc. It sucks.
 264          */
 265         (void) enable_flash_write();
 266
 267         if ((flash = probe_flash(flashchips)) == NULL) {
 268                 printf("EEPROM not found\n");
 269                 exit(1);
 270         }
 271
 272         printf("Part is %s\n", flash->name);
 273         if (!filename && !erase_it) {
 274                 printf("OK, only ENABLING flash write, but NOT FLASHING\n");
 275                 return 0;
 276         }
 277         size = flash->total_size * 1024;
 278         buf = (char *) calloc(size, sizeof(char));
 279
 280         if (erase_it) {
 281                 printf("Erasing flash chip\n");
 282                 flash->erase(flash);
 283                 exit(0);
 284         } else if (read_it) {
 285                 if ((image = fopen(filename, "w")) == NULL) {
 286                         perror(filename);
 287                         exit(1);
 288                 }
 289                 printf("Reading Flash...");
 290                 if (flash->read == NULL)
 291                         memcpy(buf, (const char *) flash->virt_addr, size);
 292                 else
 293                         flash->read(flash, buf);
 294
 295                 if (exclude_end_position - exclude_start_position > 0)
 296                         memset(buf+exclude_start_position, 0,
 297                                exclude_end_position-exclude_start_position);
 298
 299                 fwrite(buf, sizeof(char), size, image);
 300                 fclose(image);
 301                 printf("done\n");
 302         } else {
 303                 if ((image = fopen(filename, "r")) == NULL) {
 304                         perror(filename);
 305                         exit(1);
 306                 }
 307                 fread(buf, sizeof(char), size, image);
 308                 fclose(image);
 309         }
 310
 311         if (exclude_end_position - exclude_start_position > 0)
 312                 memcpy(buf+exclude_start_position,
 313                        (const char *) flash->virt_addr+exclude_start_position,
 314                        exclude_end_position-exclude_start_position);
 315
 316         exclude_start_page = exclude_start_position/flash->page_size;
 317         if ((exclude_start_position%flash->page_size) != 0) {
 318                 exclude_start_page++;
 319         }
 320         exclude_end_page = exclude_end_position/flash->page_size;
 321
 322         if (write_it || (!read_it && !verify_it)) {
 323                 flash->write(flash, buf);
 324         }
 325         if (verify_it)
 326                 verify_flash(flash, buf, verbose);
 327         return 0;
 328 }