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