cmd/jffs2.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2002
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  *
   6  * (C) Copyright 2002
   7  * Robert Schwebel, Pengutronix, <r.schwebel@pengutronix.de>
   8  *
   9  * (C) Copyright 2003
  10  * Kai-Uwe Bloem, Auerswald GmbH & Co KG, <linux-development@auerswald.de>
  11  *
  12  * (C) Copyright 2005
  13  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  14  *
  15  *   Added support for reading flash partition table from environment.
  16  *   Parsing routines are based on driver/mtd/cmdline.c from the linux 2.4
  17  *   kernel tree.
  18  *
  19  *   $Id: cmdlinepart.c,v 1.17 2004/11/26 11:18:47 lavinen Exp $
  20  *   Copyright 2002 SYSGO Real-Time Solutions GmbH
  21  */
  22
  23 /*
  24  * Three environment variables are used by the parsing routines:
  25  *
  26  * 'partition' - keeps current partition identifier
  27  *
  28  * partition  := <part-id>
  29  * <part-id>  := <dev-id>,part_num
  30  *
  31  *
  32  * 'mtdids' - linux kernel mtd device id <-> u-boot device id mapping
  33  *
  34  * mtdids=<idmap>[,<idmap>,...]
  35  *
  36  * <idmap>    := <dev-id>=<mtd-id>
  37  * <dev-id>   := 'nand'|'nor'|'onenand'<dev-num>
  38  * <dev-num>  := mtd device number, 0...
  39  * <mtd-id>   := unique device tag used by linux kernel to find mtd device (mtd->name)
  40  *
  41  *
  42  * 'mtdparts' - partition list
  43  *
  44  * mtdparts=mtdparts=<mtd-def>[;<mtd-def>...]
  45  *
  46  * <mtd-def>  := <mtd-id>:<part-def>[,<part-def>...]
  47  * <mtd-id>   := unique device tag used by linux kernel to find mtd device (mtd->name)
  48  * <part-def> := <size>[@<offset>][<name>][<ro-flag>]
  49  * <size>     := standard linux memsize OR '-' to denote all remaining space
  50  * <offset>   := partition start offset within the device
  51  * <name>     := '(' NAME ')'
  52  * <ro-flag>  := when set to 'ro' makes partition read-only (not used, passed to kernel)
  53  *
  54  * Notes:
  55  * - each <mtd-id> used in mtdparts must albo exist in 'mtddis' mapping
  56  * - if the above variables are not set defaults for a given target are used
  57  *
  58  * Examples:
  59  *
  60  * 1 NOR Flash, with 1 single writable partition:
  61  * mtdids=nor0=edb7312-nor
  62  * mtdparts=mtdparts=edb7312-nor:-
  63  *
  64  * 1 NOR Flash with 2 partitions, 1 NAND with one
  65  * mtdids=nor0=edb7312-nor,nand0=edb7312-nand
  66  * mtdparts=mtdparts=edb7312-nor:256k(ARMboot)ro,-(root);edb7312-nand:-(home)
  67  *
  68  */
  69
  70 /*
  71  * JFFS2/CRAMFS support
  72  */
  73 #include <common.h>
  74 #include <command.h>
  75 #include <env.h>
  76 #include <flash.h>
  77 #include <image.h>
  78 #include <malloc.h>
  79 #include <jffs2/jffs2.h>
  80 #include <linux/list.h>
  81 #include <linux/ctype.h>
  82 #include <cramfs/cramfs_fs.h>
  83
  84 #if defined(CONFIG_CMD_NAND)
  85 #include <linux/mtd/rawnand.h>
  86 #include <nand.h>
  87 #endif
  88
  89 #if defined(CONFIG_CMD_ONENAND)
  90 #include <linux/mtd/mtd.h>
  91 #include <linux/mtd/onenand.h>
  92 #include <onenand_uboot.h>
  93 #endif
  94
  95 /* enable/disable debugging messages */
  96 #define DEBUG_JFFS
  97 #undef  DEBUG_JFFS
  98
  99 #ifdef  DEBUG_JFFS
 100 # define DEBUGF(fmt, args...)   printf(fmt ,##args)
 101 #else
 102 # define DEBUGF(fmt, args...)
 103 #endif
 104
 105 /* special size referring to all the remaining space in a partition */
 106 #define SIZE_REMAINING          0xFFFFFFFF
 107
 108 /* special offset value, it is used when not provided by user
 109  *
 110  * this value is used temporarily during parsing, later such offests
 111  * are recalculated */
 112 #define OFFSET_NOT_SPECIFIED    0xFFFFFFFF
 113
 114 /* minimum partition size */
 115 #define MIN_PART_SIZE           4096
 116
 117 /* this flag needs to be set in part_info struct mask_flags
 118  * field for read-only partitions */
 119 #define MTD_WRITEABLE_CMD               1
 120
 121 /* current active device and partition number */
 122 #ifdef CONFIG_CMD_MTDPARTS
 123 /* Use the ones declared in cmd_mtdparts.c */
 124 extern struct mtd_device *current_mtd_dev;
 125 extern u8 current_mtd_partnum;
 126 #else
 127 /* Use local ones */
 128 struct mtd_device *current_mtd_dev = NULL;
 129 u8 current_mtd_partnum = 0;
 130 #endif
 131
 132 #if defined(CONFIG_CMD_CRAMFS)
 133 extern int cramfs_check (struct part_info *info);
 134 extern int cramfs_load (char *loadoffset, struct part_info *info, char *filename);
 135 extern int cramfs_ls (struct part_info *info, char *filename);
 136 extern int cramfs_info (struct part_info *info);
 137 #else
 138 /* defining empty macros for function names is ugly but avoids ifdef clutter
 139  * all over the code */
 140 #define cramfs_check(x)         (0)
 141 #define cramfs_load(x,y,z)      (-1)
 142 #define cramfs_ls(x,y)          (0)
 143 #define cramfs_info(x)          (0)
 144 #endif
 145
 146 #ifndef CONFIG_CMD_MTDPARTS
 147 /**
 148  * Check device number to be within valid range for given device type.
 149  *
 150  * @param dev device to validate
 151  * @return 0 if device is valid, 1 otherwise
 152  */
 153 static int mtd_device_validate(u8 type, u8 num, u32 *size)
 154 {
 155         if (type == MTD_DEV_TYPE_NOR) {
 156 #if defined(CONFIG_CMD_FLASH)
 157                 if (num < CONFIG_SYS_MAX_FLASH_BANKS) {
 158                         extern flash_info_t flash_info[];
 159                         *size = flash_info[num].size;
 160
 161                         return 0;
 162                 }
 163
 164                 printf("no such FLASH device: %s%d (valid range 0 ... %d\n",
 165                                 MTD_DEV_TYPE(type), num, CONFIG_SYS_MAX_FLASH_BANKS - 1);
 166 #else
 167                 printf("support for FLASH devices not present\n");
 168 #endif
 169         } else if (type == MTD_DEV_TYPE_NAND) {
 170 #if defined(CONFIG_JFFS2_NAND) && defined(CONFIG_CMD_NAND)
 171                 struct mtd_info *mtd = get_nand_dev_by_index(num);
 172                 if (mtd) {
 173                         *size = mtd->size;
 174                         return 0;
 175                 }
 176
 177                 printf("no such NAND device: %s%d (valid range 0 ... %d)\n",
 178                                 MTD_DEV_TYPE(type), num, CONFIG_SYS_MAX_NAND_DEVICE - 1);
 179 #else
 180                 printf("support for NAND devices not present\n");
 181 #endif
 182         } else if (type == MTD_DEV_TYPE_ONENAND) {
 183 #if defined(CONFIG_CMD_ONENAND)
 184                 *size = onenand_mtd.size;
 185                 return 0;
 186 #else
 187                 printf("support for OneNAND devices not present\n");
 188 #endif
 189         } else
 190                 printf("Unknown defice type %d\n", type);
 191
 192         return 1;
 193 }
 194
 195 /**
 196  * Parse device id string <dev-id> := 'nand'|'nor'|'onenand'<dev-num>,
 197  * return device type and number.
 198  *
 199  * @param id string describing device id
 200  * @param ret_id output pointer to next char after parse completes (output)
 201  * @param dev_type parsed device type (output)
 202  * @param dev_num parsed device number (output)
 203  * @return 0 on success, 1 otherwise
 204  */
 205 static int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num)
 206 {
 207         const char *p = id;
 208
 209         *dev_type = 0;
 210         if (strncmp(p, "nand", 4) == 0) {
 211                 *dev_type = MTD_DEV_TYPE_NAND;
 212                 p += 4;
 213         } else if (strncmp(p, "nor", 3) == 0) {
 214                 *dev_type = MTD_DEV_TYPE_NOR;
 215                 p += 3;
 216         } else if (strncmp(p, "onenand", 7) == 0) {
 217                 *dev_type = MTD_DEV_TYPE_ONENAND;
 218                 p += 7;
 219         } else {
 220                 printf("incorrect device type in %s\n", id);
 221                 return 1;
 222         }
 223
 224         if (!isdigit(*p)) {
 225                 printf("incorrect device number in %s\n", id);
 226                 return 1;
 227         }
 228
 229         *dev_num = simple_strtoul(p, (char **)&p, 0);
 230         if (ret_id)
 231                 *ret_id = p;
 232         return 0;
 233 }
 234
 235 /*
 236  * 'Static' version of command line mtdparts_init() routine. Single partition on
 237  * a single device configuration.
 238  */
 239
 240 /**
 241  * Calculate sector size.
 242  *
 243  * @return sector size
 244  */
 245 static inline u32 get_part_sector_size_nand(struct mtdids *id)
 246 {
 247 #if defined(CONFIG_JFFS2_NAND) && defined(CONFIG_CMD_NAND)
 248         struct mtd_info *mtd;
 249
 250         mtd = get_nand_dev_by_index(id->num);
 251
 252         return mtd->erasesize;
 253 #else
 254         BUG();
 255         return 0;
 256 #endif
 257 }
 258
 259 static inline u32 get_part_sector_size_nor(struct mtdids *id, struct part_info *part)
 260 {
 261 #if defined(CONFIG_CMD_FLASH)
 262         extern flash_info_t flash_info[];
 263
 264         u32 end_phys, start_phys, sector_size = 0, size = 0;
 265         int i;
 266         flash_info_t *flash;
 267
 268         flash = &flash_info[id->num];
 269
 270         start_phys = flash->start[0] + part->offset;
 271         end_phys = start_phys + part->size - 1;
 272
 273         for (i = 0; i < flash->sector_count; i++) {
 274                 if (flash->start[i] >= end_phys)
 275                         break;
 276
 277                 if (flash->start[i] >= start_phys) {
 278                         if (i == flash->sector_count - 1) {
 279                                 size = flash->start[0] + flash->size - flash->start[i];
 280                         } else {
 281                                 size = flash->start[i+1] - flash->start[i];
 282                         }
 283
 284                         if (sector_size < size)
 285                                 sector_size = size;
 286                 }
 287         }
 288
 289         return sector_size;
 290 #else
 291         BUG();
 292         return 0;
 293 #endif
 294 }
 295
 296 static inline u32 get_part_sector_size_onenand(void)
 297 {
 298 #if defined(CONFIG_CMD_ONENAND)
 299         struct mtd_info *mtd;
 300
 301         mtd = &onenand_mtd;
 302
 303         return mtd->erasesize;
 304 #else
 305         BUG();
 306         return 0;
 307 #endif
 308 }
 309
 310 static inline u32 get_part_sector_size(struct mtdids *id, struct part_info *part)
 311 {
 312         if (id->type == MTD_DEV_TYPE_NAND)
 313                 return get_part_sector_size_nand(id);
 314         else if (id->type == MTD_DEV_TYPE_NOR)
 315                 return get_part_sector_size_nor(id, part);
 316         else if (id->type == MTD_DEV_TYPE_ONENAND)
 317                 return get_part_sector_size_onenand();
 318         else
 319                 DEBUGF("Error: Unknown device type.\n");
 320
 321         return 0;
 322 }
 323
 324 /**
 325  * Parse and initialize global mtdids mapping and create global
 326  * device/partition list.
 327  *
 328  * 'Static' version of command line mtdparts_init() routine. Single partition on
 329  * a single device configuration.
 330  *
 331  * @return 0 on success, 1 otherwise
 332  */
 333 int mtdparts_init(void)
 334 {
 335         static int initialized = 0;
 336         u32 size;
 337         char *dev_name;
 338
 339         DEBUGF("\n---mtdparts_init---\n");
 340         if (!initialized) {
 341                 struct mtdids *id;
 342                 struct part_info *part;
 343
 344                 initialized = 1;
 345                 current_mtd_dev = (struct mtd_device *)
 346                         malloc(sizeof(struct mtd_device) +
 347                                         sizeof(struct part_info) +
 348                                         sizeof(struct mtdids));
 349                 if (!current_mtd_dev) {
 350                         printf("out of memory\n");
 351                         return 1;
 352                 }
 353                 memset(current_mtd_dev, 0, sizeof(struct mtd_device) +
 354                        sizeof(struct part_info) + sizeof(struct mtdids));
 355
 356                 id = (struct mtdids *)(current_mtd_dev + 1);
 357                 part = (struct part_info *)(id + 1);
 358
 359                 /* id */
 360                 id->mtd_id = "single part";
 361
 362 #if defined(CONFIG_JFFS2_DEV)
 363                 dev_name = CONFIG_JFFS2_DEV;
 364 #else
 365                 dev_name = "nor0";
 366 #endif
 367
 368                 if ((mtd_id_parse(dev_name, NULL, &id->type, &id->num) != 0) ||
 369                                 (mtd_device_validate(id->type, id->num, &size) != 0)) {
 370                         printf("incorrect device: %s%d\n", MTD_DEV_TYPE(id->type), id->num);
 371                         free(current_mtd_dev);
 372                         return 1;
 373                 }
 374                 id->size = size;
 375                 INIT_LIST_HEAD(&id->link);
 376
 377                 DEBUGF("dev id: type = %d, num = %d, size = 0x%08lx, mtd_id = %s\n",
 378                                 id->type, id->num, id->size, id->mtd_id);
 379
 380                 /* partition */
 381                 part->name = "static";
 382                 part->auto_name = 0;
 383
 384 #if defined(CONFIG_JFFS2_PART_SIZE)
 385                 part->size = CONFIG_JFFS2_PART_SIZE;
 386 #else
 387                 part->size = SIZE_REMAINING;
 388 #endif
 389
 390 #if defined(CONFIG_JFFS2_PART_OFFSET)
 391                 part->offset = CONFIG_JFFS2_PART_OFFSET;
 392 #else
 393                 part->offset = 0x00000000;
 394 #endif
 395
 396                 part->dev = current_mtd_dev;
 397                 INIT_LIST_HEAD(&part->link);
 398
 399                 /* recalculate size if needed */
 400                 if (part->size == SIZE_REMAINING)
 401                         part->size = id->size - part->offset;
 402
 403                 part->sector_size = get_part_sector_size(id, part);
 404
 405                 DEBUGF("part  : name = %s, size = 0x%08lx, offset = 0x%08lx\n",
 406                                 part->name, part->size, part->offset);
 407
 408                 /* device */
 409                 current_mtd_dev->id = id;
 410                 INIT_LIST_HEAD(&current_mtd_dev->link);
 411                 current_mtd_dev->num_parts = 1;
 412                 INIT_LIST_HEAD(&current_mtd_dev->parts);
 413                 list_add(&part->link, &current_mtd_dev->parts);
 414         }
 415
 416         return 0;
 417 }
 418 #endif /* #ifndef CONFIG_CMD_MTDPARTS */
 419
 420 /**
 421  * Return pointer to the partition of a requested number from a requested
 422  * device.
 423  *
 424  * @param dev device that is to be searched for a partition
 425  * @param part_num requested partition number
 426  * @return pointer to the part_info, NULL otherwise
 427  */
 428 static struct part_info* jffs2_part_info(struct mtd_device *dev, unsigned int part_num)
 429 {
 430         struct list_head *entry;
 431         struct part_info *part;
 432         int num;
 433
 434         if (!dev)
 435                 return NULL;
 436
 437         DEBUGF("\n--- jffs2_part_info: partition number %d for device %s%d (%s)\n",
 438                         part_num, MTD_DEV_TYPE(dev->id->type),
 439                         dev->id->num, dev->id->mtd_id);
 440
 441         if (part_num >= dev->num_parts) {
 442                 printf("invalid partition number %d for device %s%d (%s)\n",
 443                                 part_num, MTD_DEV_TYPE(dev->id->type),
 444                                 dev->id->num, dev->id->mtd_id);
 445                 return NULL;
 446         }
 447
 448         /* locate partition number, return it */
 449         num = 0;
 450         list_for_each(entry, &dev->parts) {
 451                 part = list_entry(entry, struct part_info, link);
 452
 453                 if (part_num == num++) {
 454                         return part;
 455                 }
 456         }
 457
 458         return NULL;
 459 }
 460
 461 /***************************************************/
 462 /* U-Boot commands                                 */
 463 /***************************************************/
 464
 465 /**
 466  * Routine implementing fsload u-boot command. This routine tries to load
 467  * a requested file from jffs2/cramfs filesystem on a current partition.
 468  *
 469  * @param cmdtp command internal data
 470  * @param flag command flag
 471  * @param argc number of arguments supplied to the command
 472  * @param argv arguments list
 473  * @return 0 on success, 1 otherwise
 474  */
 475 int do_jffs2_fsload(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 476 {
 477         char *fsname;
 478         char *filename;
 479         int size;
 480         struct part_info *part;
 481         ulong offset = image_load_addr;
 482
 483         /* pre-set Boot file name */
 484         filename = env_get("bootfile");
 485         if (!filename)
 486                 filename = "uImage";
 487
 488         if (argc == 2) {
 489                 filename = argv[1];
 490         }
 491         if (argc == 3) {
 492                 offset = simple_strtoul(argv[1], NULL, 16);
 493                 image_load_addr = offset;
 494                 filename = argv[2];
 495         }
 496
 497         /* make sure we are in sync with env variables */
 498         if (mtdparts_init() !=0)
 499                 return 1;
 500
 501         if ((part = jffs2_part_info(current_mtd_dev, current_mtd_partnum))){
 502
 503                 /* check partition type for cramfs */
 504                 fsname = (cramfs_check(part) ? "CRAMFS" : "JFFS2");
 505                 printf("### %s loading '%s' to 0x%lx\n", fsname, filename, offset);
 506
 507                 if (cramfs_check(part)) {
 508                         size = cramfs_load ((char *) offset, part, filename);
 509                 } else {
 510                         /* if this is not cramfs assume jffs2 */
 511                         size = jffs2_1pass_load((char *)offset, part, filename);
 512                 }
 513
 514                 if (size > 0) {
 515                         printf("### %s load complete: %d bytes loaded to 0x%lx\n",
 516                                 fsname, size, offset);
 517                         env_set_hex("filesize", size);
 518                 } else {
 519                         printf("### %s LOAD ERROR<%x> for %s!\n", fsname, size, filename);
 520                 }
 521
 522                 return !(size > 0);
 523         }
 524         return 1;
 525 }
 526
 527 /**
 528  * Routine implementing u-boot ls command which lists content of a given
 529  * directory on a current partition.
 530  *
 531  * @param cmdtp command internal data
 532  * @param flag command flag
 533  * @param argc number of arguments supplied to the command
 534  * @param argv arguments list
 535  * @return 0 on success, 1 otherwise
 536  */
 537 int do_jffs2_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 538 {
 539         char *filename = "/";
 540         int ret;
 541         struct part_info *part;
 542
 543         if (argc == 2)
 544                 filename = argv[1];
 545
 546         /* make sure we are in sync with env variables */
 547         if (mtdparts_init() !=0)
 548                 return 1;
 549
 550         if ((part = jffs2_part_info(current_mtd_dev, current_mtd_partnum))){
 551
 552                 /* check partition type for cramfs */
 553                 if (cramfs_check(part)) {
 554                         ret = cramfs_ls (part, filename);
 555                 } else {
 556                         /* if this is not cramfs assume jffs2 */
 557                         ret = jffs2_1pass_ls(part, filename);
 558                 }
 559
 560                 return ret ? 0 : 1;
 561         }
 562         return 1;
 563 }
 564
 565 /**
 566  * Routine implementing u-boot fsinfo command. This routine prints out
 567  * miscellaneous filesystem informations/statistics.
 568  *
 569  * @param cmdtp command internal data
 570  * @param flag command flag
 571  * @param argc number of arguments supplied to the command
 572  * @param argv arguments list
 573  * @return 0 on success, 1 otherwise
 574  */
 575 int do_jffs2_fsinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 576 {
 577         struct part_info *part;
 578         char *fsname;
 579         int ret;
 580
 581         /* make sure we are in sync with env variables */
 582         if (mtdparts_init() !=0)
 583                 return 1;
 584
 585         if ((part = jffs2_part_info(current_mtd_dev, current_mtd_partnum))){
 586
 587                 /* check partition type for cramfs */
 588                 fsname = (cramfs_check(part) ? "CRAMFS" : "JFFS2");
 589                 printf("### filesystem type is %s\n", fsname);
 590
 591                 if (cramfs_check(part)) {
 592                         ret = cramfs_info (part);
 593                 } else {
 594                         /* if this is not cramfs assume jffs2 */
 595                         ret = jffs2_1pass_info(part);
 596                 }
 597
 598                 return ret ? 0 : 1;
 599         }
 600         return 1;
 601 }
 602
 603 /***************************************************/
 604 U_BOOT_CMD(
 605         fsload, 3,      0,      do_jffs2_fsload,
 606         "load binary file from a filesystem image",
 607         "[ off ] [ filename ]\n"
 608         "    - load binary file from flash bank\n"
 609         "      with offset 'off'"
 610 );
 611 U_BOOT_CMD(
 612         fsls,   2,      1,      do_jffs2_ls,
 613         "list files in a directory (default /)",
 614         "[ directory ]"
 615 );
 616
 617 U_BOOT_CMD(
 618         fsinfo, 1,      1,      do_jffs2_fsinfo,
 619         "print information about filesystems",
 620         ""
 621 );
 622 /***************************************************/