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