package/mtd/src/mtd.c

   1 /*
   2  * mtd - simple memory technology device manipulation tool
   3  *
   4  * Copyright (C) 2005 Waldemar Brodkorb <wbx@dass-it.de>,
   5  *                        Felix Fietkau <nbd@openwrt.org>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  *
  21  * $Id$
  22  *
  23  * The code is based on the linux-mtd examples.
  24  */
  25
  26 #include <limits.h>
  27 #include <unistd.h>
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #include <stdint.h>
  31 #include <signal.h>
  32 #include <sys/ioctl.h>
  33 #include <sys/syscall.h>
  34 #include <fcntl.h>
  35 #include <errno.h>
  36 #include <error.h>
  37 #include <time.h>
  38 #include <string.h>
  39 #include <sys/ioctl.h>
  40 #include <sys/types.h>
  41 #include <sys/param.h>
  42 #include <sys/mount.h>
  43 #include <sys/stat.h>
  44 #include <sys/reboot.h>
  45 #include <linux/reboot.h>
  46
  47 #include "mtd-api.h"
  48
  49 #define TRX_MAGIC       0x30524448      /* "HDR0" */
  50 #define BUFSIZE (16 * 1024)
  51 #define MAX_ARGS 8
  52
  53 #define DEBUG
  54
  55 #define JFFS2_DEFAULT_DIR       "" /* directory name without /, empty means root dir */
  56
  57 #define SYSTYPE_UNKNOWN     0
  58 #define SYSTYPE_BROADCOM    1
  59 /* to be continued */
  60
  61 struct trx_header {
  62         uint32_t magic;         /* "HDR0" */
  63         uint32_t len;           /* Length of file including header */
  64         uint32_t crc32;         /* 32-bit CRC from flag_version to end of file */
  65         uint32_t flag_version;  /* 0:15 flags, 16:31 version */
  66         uint32_t offsets[3];    /* Offsets of partitions from start of header */
  67 };
  68
  69 static char buf[BUFSIZE];
  70 static char *imagefile;
  71 static int buflen;
  72 int quiet;
  73 int mtdsize = 0;
  74 int erasesize = 0;
  75
  76 int mtd_open(const char *mtd)
  77 {
  78         FILE *fp;
  79         char dev[PATH_MAX];
  80         int i;
  81         int ret;
  82         int flags = O_RDWR | O_SYNC;
  83
  84         if ((fp = fopen("/proc/mtd", "r"))) {
  85                 while (fgets(dev, sizeof(dev), fp)) {
  86                         if (sscanf(dev, "mtd%d:", &i) && strstr(dev, mtd)) {
  87                                 snprintf(dev, sizeof(dev), "/dev/mtd/%d", i);
  88                                 if ((ret=open(dev, flags))<0) {
  89                                         snprintf(dev, sizeof(dev), "/dev/mtd%d", i);
  90                                         ret=open(dev, flags);
  91                                 }
  92                                 fclose(fp);
  93                                 return ret;
  94                         }
  95                 }
  96                 fclose(fp);
  97         }
  98
  99         return open(mtd, flags);
 100 }
 101
 102 int mtd_check_open(const char *mtd)
 103 {
 104         struct mtd_info_user mtdInfo;
 105         int fd;
 106
 107         fd = mtd_open(mtd);
 108         if(fd < 0) {
 109                 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
 110                 return 0;
 111         }
 112
 113         if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
 114                 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
 115                 close(fd);
 116                 return 0;
 117         }
 118         mtdsize = mtdInfo.size;
 119         erasesize = mtdInfo.erasesize;
 120
 121         return fd;
 122 }
 123
 124 int mtd_erase_block(int fd, int offset)
 125 {
 126         struct erase_info_user mtdEraseInfo;
 127
 128         mtdEraseInfo.start = offset;
 129         mtdEraseInfo.length = erasesize;
 130         ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
 131         if (ioctl (fd, MEMERASE, &mtdEraseInfo) < 0) {
 132                 fprintf(stderr, "Erasing mtd failed.\n");
 133                 exit(1);
 134         }
 135 }
 136
 137 int mtd_write_buffer(int fd, char *buf, int offset, int length)
 138 {
 139         lseek(fd, offset, SEEK_SET);
 140         write(fd, buf, length);
 141 }
 142
 143
 144 #ifdef target_brcm
 145 static int
 146 image_check_brcm(int imagefd, const char *mtd)
 147 {
 148         struct trx_header *trx = (struct trx_header *) buf;
 149         int fd;
 150
 151         if (strcmp(mtd, "linux") != 0)
 152                 return 1;
 153
 154         buflen = read(imagefd, buf, 32);
 155         if (buflen < 32) {
 156                 fprintf(stdout, "Could not get image header, file too small (%ld bytes)\n", buflen);
 157                 return 0;
 158         }
 159
 160         if (trx->magic != TRX_MAGIC || trx->len < sizeof(struct trx_header)) {
 161                 if (quiet < 2) {
 162                         fprintf(stderr, "Bad trx header\n");
 163                         fprintf(stderr, "This is not the correct file format; refusing to flash.\n"
 164                                         "Please specify the correct file or use -f to force.\n");
 165                 }
 166                 return 0;
 167         }
 168
 169         /* check if image fits to mtd device */
 170         fd = mtd_check_open(mtd);
 171         if(fd < 0) {
 172                 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
 173                 exit(1);
 174         }
 175
 176         if(mtdsize < trx->len) {
 177                 fprintf(stderr, "Image too big for partition: %s\n", mtd);
 178                 close(fd);
 179                 return 0;
 180         }
 181
 182         close(fd);
 183         return 1;
 184 }
 185 #endif /* target_brcm */
 186
 187 static int
 188 image_check(int imagefd, const char *mtd)
 189 {
 190         int fd, systype;
 191         size_t count;
 192         char *c;
 193         FILE *f;
 194
 195 #ifdef target_brcm
 196         return image_check_brcm(imagefd, mtd);
 197 #endif
 198 }
 199
 200 static int mtd_check(const char *mtd)
 201 {
 202         int fd;
 203
 204         fd = mtd_check_open(mtd);
 205         if (!fd)
 206                 return 0;
 207
 208         close(fd);
 209         return 1;
 210 }
 211
 212 static int
 213 mtd_unlock(const char *mtd)
 214 {
 215         int fd;
 216         struct erase_info_user mtdLockInfo;
 217
 218         fd = mtd_check_open(mtd);
 219         if(fd <= 0) {
 220                 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
 221                 exit(1);
 222         }
 223
 224         if (quiet < 2)
 225                 fprintf(stderr, "Unlocking %s ...\n", mtd);
 226
 227         mtdLockInfo.start = 0;
 228         mtdLockInfo.length = mtdsize;
 229         if(ioctl(fd, MEMUNLOCK, &mtdLockInfo)) {
 230                 close(fd);
 231                 return 0;
 232         }
 233
 234         close(fd);
 235         return 0;
 236 }
 237
 238 static int
 239 mtd_erase(const char *mtd)
 240 {
 241         int fd;
 242         struct erase_info_user mtdEraseInfo;
 243
 244         if (quiet < 2)
 245                 fprintf(stderr, "Erasing %s ...\n", mtd);
 246
 247         fd = mtd_check_open(mtd);
 248         if(fd <= 0) {
 249                 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
 250                 exit(1);
 251         }
 252
 253         mtdEraseInfo.length = erasesize;
 254
 255         for (mtdEraseInfo.start = 0;
 256                  mtdEraseInfo.start < mtdsize;
 257                  mtdEraseInfo.start += erasesize) {
 258
 259                 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
 260                 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
 261                         fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
 262         }
 263
 264         close(fd);
 265         return 0;
 266
 267 }
 268
 269 static int
 270 mtd_refresh(const char *mtd)
 271 {
 272         int fd;
 273
 274         if (quiet < 2)
 275                 fprintf(stderr, "Refreshing mtd partition %s ... ", mtd);
 276
 277         fd = mtd_check_open(mtd);
 278         if(fd <= 0) {
 279                 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
 280                 exit(1);
 281         }
 282
 283         if (ioctl(fd, MTDREFRESH, NULL)) {
 284                 fprintf(stderr, "Failed to refresh the MTD device\n");
 285                 close(fd);
 286                 exit(1);
 287         }
 288         close(fd);
 289
 290         if (quiet < 2)
 291                 fprintf(stderr, "\n");
 292
 293         return 0;
 294 }
 295
 296 static int
 297 mtd_write(int imagefd, const char *mtd)
 298 {
 299         int fd, i, result;
 300         size_t r, w, e;
 301         struct erase_info_user mtdEraseInfo;
 302         int ret = 0;
 303
 304         fd = mtd_check_open(mtd);
 305         if(fd < 0) {
 306                 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
 307                 exit(1);
 308         }
 309
 310         if (quiet < 2)
 311                 fprintf(stderr, "Writing from %s to %s ... ", imagefile, mtd);
 312
 313         r = w = e = 0;
 314         if (!quiet)
 315                 fprintf(stderr, " [ ]");
 316
 317         for (;;) {
 318                 /* buffer may contain data already (from trx check) */
 319                 r = buflen;
 320                 r += read(imagefd, buf + buflen, BUFSIZE - buflen);
 321                 w += r;
 322
 323                 /* EOF */
 324                 if (r <= 0) break;
 325
 326                 /* need to erase the next block before writing data to it */
 327                 while (w > e) {
 328                         if (!quiet)
 329                                 fprintf(stderr, "\b\b\b[e]");
 330
 331                         mtd_erase_block(fd, e);
 332
 333                         /* erase the chunk */
 334                         e += erasesize;
 335                 }
 336
 337                 if (!quiet)
 338                         fprintf(stderr, "\b\b\b[w]");
 339
 340                 if ((result = write(fd, buf, r)) < r) {
 341                         if (result < 0) {
 342                                 fprintf(stderr, "Error writing image.\n");
 343                                 exit(1);
 344                         } else {
 345                                 fprintf(stderr, "Insufficient space.\n");
 346                                 exit(1);
 347                         }
 348                 }
 349
 350                 buflen = 0;
 351         }
 352         if (!quiet)
 353                 fprintf(stderr, "\b\b\b\b");
 354
 355         if (quiet < 2)
 356                 fprintf(stderr, "\n");
 357
 358         close(fd);
 359         return 0;
 360 }
 361
 362 static void usage(void)
 363 {
 364         fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>\n\n"
 365         "The device is in the format of mtdX (eg: mtd4) or its label.\n"
 366         "mtd recognizes these commands:\n"
 367         "        unlock                  unlock the device\n"
 368         "        refresh                 refresh mtd partition\n"
 369         "        erase                   erase all data on device\n"
 370         "        write <imagefile>|-     write <imagefile> (use - for stdin) to device\n"
 371         "        jffs2write <file>       append <file> to the jffs2 partition on the device\n"
 372         "Following options are available:\n"
 373         "        -q                      quiet mode (once: no [w] on writing,\n"
 374         "                                           twice: no status messages)\n"
 375         "        -r                      reboot after successful command\n"
 376         "        -f                      force write without trx checks\n"
 377         "        -e <device>             erase <device> before executing the command\n"
 378         "        -d <name>               directory for jffs2write, defaults to \"tmp\"\n"
 379         "\n"
 380         "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
 381         "         mtd -r write linux.trx linux\n\n");
 382         exit(1);
 383 }
 384
 385 static void do_reboot(void)
 386 {
 387         fprintf(stderr, "Rebooting ...\n");
 388         fflush(stderr);
 389
 390         /* try regular reboot method first */
 391         system("/sbin/reboot");
 392         sleep(2);
 393
 394         /* if we're still alive at this point, force the kernel to reboot */
 395         syscall(SYS_reboot,LINUX_REBOOT_MAGIC1,LINUX_REBOOT_MAGIC2,LINUX_REBOOT_CMD_RESTART,NULL);
 396 }
 397
 398 int main (int argc, char **argv)
 399 {
 400         int ch, i, boot, unlock, imagefd, force, unlocked;
 401         char *erase[MAX_ARGS], *device;
 402         char *jffs2dir = JFFS2_DEFAULT_DIR;
 403         enum {
 404                 CMD_ERASE,
 405                 CMD_WRITE,
 406                 CMD_UNLOCK,
 407                 CMD_REFRESH,
 408                 CMD_JFFS2WRITE
 409         } cmd;
 410
 411         erase[0] = NULL;
 412         boot = 0;
 413         force = 0;
 414         buflen = 0;
 415         quiet = 0;
 416
 417         while ((ch = getopt(argc, argv, "frqe:d:")) != -1)
 418                 switch (ch) {
 419                         case 'f':
 420                                 force = 1;
 421                                 break;
 422                         case 'r':
 423                                 boot = 1;
 424                                 break;
 425                         case 'q':
 426                                 quiet++;
 427                                 break;
 428                         case 'e':
 429                                 i = 0;
 430                                 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
 431                                         i++;
 432
 433                                 erase[i++] = optarg;
 434                                 erase[i] = NULL;
 435                                 break;
 436                         case 'd':
 437                                 jffs2dir = optarg;
 438                                 break;
 439                         case '?':
 440                         default:
 441                                 usage();
 442                 }
 443         argc -= optind;
 444         argv += optind;
 445
 446         if (argc < 2)
 447                 usage();
 448
 449         if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
 450                 cmd = CMD_UNLOCK;
 451                 device = argv[1];
 452         } else if ((strcmp(argv[0], "refresh") == 0) && (argc == 2)) {
 453                 cmd = CMD_REFRESH;
 454                 device = argv[1];
 455         } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
 456                 cmd = CMD_ERASE;
 457                 device = argv[1];
 458         } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
 459                 cmd = CMD_WRITE;
 460                 device = argv[2];
 461
 462                 if (strcmp(argv[1], "-") == 0) {
 463                         imagefile = "<stdin>";
 464                         imagefd = 0;
 465                 } else {
 466                         imagefile = argv[1];
 467                         if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
 468                                 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
 469                                 exit(1);
 470                         }
 471                 }
 472
 473                 /* check trx file before erasing or writing anything */
 474                 if (!image_check(imagefd, device)) {
 475                         if (!force) {
 476                                 fprintf(stderr, "Image check failed.\n");
 477                                 exit(1);
 478                         }
 479                 } else {
 480                         if (!mtd_check(device)) {
 481                                 fprintf(stderr, "Can't open device for writing!\n");
 482                                 exit(1);
 483                         }
 484                 }
 485         } else if ((strcmp(argv[0], "jffs2write") == 0) && (argc == 3)) {
 486                 cmd = CMD_JFFS2WRITE;
 487                 device = argv[2];
 488
 489                 imagefile = argv[1];
 490                 if (!mtd_check(device)) {
 491                         fprintf(stderr, "Can't open device for writing!\n");
 492                         exit(1);
 493                 }
 494         } else {
 495                 usage();
 496         }
 497
 498         sync();
 499
 500         i = 0;
 501         unlocked = 0;
 502         while (erase[i] != NULL) {
 503                 mtd_unlock(erase[i]);
 504                 mtd_erase(erase[i]);
 505                 if (strcmp(erase[i], device) == 0)
 506                         unlocked = 1;
 507                 i++;
 508         }
 509
 510
 511         switch (cmd) {
 512                 case CMD_UNLOCK:
 513                         if (!unlocked)
 514                                 mtd_unlock(device);
 515                         break;
 516                 case CMD_ERASE:
 517                         if (!unlocked)
 518                                 mtd_unlock(device);
 519                         mtd_erase(device);
 520                         break;
 521                 case CMD_WRITE:
 522                         if (!unlocked)
 523                                 mtd_unlock(device);
 524                         mtd_write(imagefd, device);
 525                         break;
 526                 case CMD_JFFS2WRITE:
 527                         if (!unlocked)
 528                                 mtd_unlock(device);
 529                         mtd_write_jffs2(device, imagefile, jffs2dir);
 530                         break;
 531                 case CMD_REFRESH:
 532                         mtd_refresh(device);
 533                         break;
 534         }
 535
 536         sync();
 537
 538         if (boot)
 539                 do_reboot();
 540
 541         return 0;
 542 }