913e766f190db4b3978df45a5cb3fc7cf130bbef
[karo-tx-uboot.git] / common / cmd_mtdparts.c
1 /*
2  * (C) Copyright 2002
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * (C) Copyright 2002
6  * Robert Schwebel, Pengutronix, <r.schwebel@pengutronix.de>
7  *
8  * (C) Copyright 2003
9  * Kai-Uwe Bloem, Auerswald GmbH & Co KG, <linux-development@auerswald.de>
10  *
11  * (C) Copyright 2005
12  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
13  *
14  *   Added support for reading flash partition table from environment.
15  *   Parsing routines are based on driver/mtd/cmdline.c from the linux 2.4
16  *   kernel tree.
17  *
18  * (C) Copyright 2008
19  * Harald Welte, OpenMoko, Inc., Harald Welte <laforge@openmoko.org>
20  *
21  *   $Id: cmdlinepart.c,v 1.17 2004/11/26 11:18:47 lavinen Exp $
22  *   Copyright 2002 SYSGO Real-Time Solutions GmbH
23  *
24  * SPDX-License-Identifier:     GPL-2.0+
25  */
26
27 /*
28  * Three environment variables are used by the parsing routines:
29  *
30  * 'partition' - keeps current partition identifier
31  *
32  * partition  := <part-id>
33  * <part-id>  := <dev-id>,part_num
34  *
35  *
36  * 'mtdids' - linux kernel mtd device id <-> u-boot device id mapping
37  *
38  * mtdids=<idmap>[,<idmap>,...]
39  *
40  * <idmap>    := <dev-id>=<mtd-id>
41  * <dev-id>   := 'nand'|'nor'|'onenand'<dev-num>
42  * <dev-num>  := mtd device number, 0...
43  * <mtd-id>   := unique device tag used by linux kernel to find mtd device (mtd->name)
44  *
45  *
46  * 'mtdparts' - partition list
47  *
48  * mtdparts=mtdparts=<mtd-def>[;<mtd-def>...]
49  *
50  * <mtd-def>  := <mtd-id>:<part-def>[,<part-def>...]
51  * <mtd-id>   := unique device tag used by linux kernel to find mtd device (mtd->name)
52  * <part-def> := <size>[@<offset>][<name>][<ro-flag>]
53  * <size>     := standard linux memsize OR '-' to denote all remaining space
54  * <offset>   := partition start offset within the device
55  * <name>     := '(' NAME ')'
56  * <ro-flag>  := when set to 'ro' makes partition read-only (not used, passed to kernel)
57  *
58  * Notes:
59  * - each <mtd-id> used in mtdparts must albo exist in 'mtddis' mapping
60  * - if the above variables are not set defaults for a given target are used
61  *
62  * Examples:
63  *
64  * 1 NOR Flash, with 1 single writable partition:
65  * mtdids=nor0=edb7312-nor
66  * mtdparts=mtdparts=edb7312-nor:-
67  *
68  * 1 NOR Flash with 2 partitions, 1 NAND with one
69  * mtdids=nor0=edb7312-nor,nand0=edb7312-nand
70  * mtdparts=mtdparts=edb7312-nor:256k(ARMboot)ro,-(root);edb7312-nand:-(home)
71  *
72  */
73
74 #include <common.h>
75 #include <command.h>
76 #include <malloc.h>
77 #include <jffs2/load_kernel.h>
78 #include <linux/list.h>
79 #include <linux/ctype.h>
80 #include <linux/err.h>
81 #include <linux/mtd/mtd.h>
82
83 #if defined(CONFIG_CMD_NAND)
84 #include <linux/mtd/nand.h>
85 #include <nand.h>
86 #endif
87
88 #if defined(CONFIG_CMD_ONENAND)
89 #include <linux/mtd/onenand.h>
90 #include <onenand_uboot.h>
91 #endif
92
93 DECLARE_GLOBAL_DATA_PTR;
94
95 /* special size referring to all the remaining space in a partition */
96 #define SIZE_REMAINING          (~0llu)
97
98 /* special offset value, it is used when not provided by user
99  *
100  * this value is used temporarily during parsing, later such offests
101  * are recalculated */
102 #define OFFSET_NOT_SPECIFIED    (~0llu)
103
104 /* minimum partition size */
105 #define MIN_PART_SIZE           4096
106
107 /* this flag needs to be set in part_info struct mask_flags
108  * field for read-only partitions */
109 #define MTD_WRITEABLE_CMD               1
110
111 /* default values for mtdids and mtdparts variables */
112 #if defined(MTDIDS_DEFAULT)
113 static const char *const mtdids_default = MTDIDS_DEFAULT;
114 #else
115 static const char *const mtdids_default = NULL;
116 #endif
117
118 #if defined(MTDPARTS_DEFAULT)
119 static const char *const mtdparts_default = MTDPARTS_DEFAULT;
120 #else
121 static const char *const mtdparts_default = NULL;
122 #endif
123
124 /* copies of last seen 'mtdids', 'mtdparts' and 'partition' env variables */
125 #define MTDIDS_MAXLEN           128
126 #define MTDPARTS_MAXLEN         512
127 #define PARTITION_MAXLEN        16
128 static char last_ids[MTDIDS_MAXLEN];
129 static char last_parts[MTDPARTS_MAXLEN];
130 static char last_partition[PARTITION_MAXLEN];
131
132 /* low level jffs2 cache cleaning routine */
133 extern void jffs2_free_cache(struct part_info *part);
134
135 /* mtdids mapping list, filled by parse_ids() */
136 static struct list_head mtdids;
137
138 /* device/partition list, parse_cmdline() parses into here */
139 static struct list_head devices;
140
141 /* current active device and partition number */
142 struct mtd_device *current_mtd_dev = NULL;
143 u8 current_mtd_partnum = 0;
144
145 static struct part_info* mtd_part_info(struct mtd_device *dev, unsigned int part_num);
146
147 /* command line only routines */
148 static struct mtdids* id_find_by_mtd_id(const char *mtd_id, unsigned int mtd_id_len);
149 static int device_del(struct mtd_device *dev);
150
151 /**
152  * Parses a string into a number.  The number stored at ptr is
153  * potentially suffixed with K (for kilobytes, or 1024 bytes),
154  * M (for megabytes, or 1048576 bytes), or G (for gigabytes, or
155  * 1073741824).  If the number is suffixed with K, M, or G, then
156  * the return value is the number multiplied by one kilobyte, one
157  * megabyte, or one gigabyte, respectively.
158  *
159  * @param ptr where parse begins
160  * @param retptr output pointer to next char after parse completes (output)
161  * @return resulting unsigned int
162  */
163 static u64 memsize_parse (const char *const ptr, const char **retptr)
164 {
165         u64 ret = simple_strtoull(ptr, (char **)retptr, 0);
166
167         switch (**retptr) {
168                 case 'G':
169                 case 'g':
170                         ret <<= 10;
171                 case 'M':
172                 case 'm':
173                         ret <<= 10;
174                 case 'K':
175                 case 'k':
176                         ret <<= 10;
177                         (*retptr)++;
178                 default:
179                         break;
180         }
181
182         return ret;
183 }
184
185 /**
186  * Format string describing supplied size. This routine does the opposite job
187  * to memsize_parse(). Size in bytes is converted to string and if possible
188  * shortened by using k (kilobytes), m (megabytes) or g (gigabytes) suffix.
189  *
190  * Note, that this routine does not check for buffer overflow, it's the caller
191  * who must assure enough space.
192  *
193  * @param buf output buffer
194  * @param size size to be converted to string
195  */
196 static void memsize_format(char *buf, u64 size)
197 {
198 #define SIZE_GB ((u32)1024*1024*1024)
199 #define SIZE_MB ((u32)1024*1024)
200 #define SIZE_KB ((u32)1024)
201
202         if ((size % SIZE_GB) == 0)
203                 sprintf(buf, "%llug", size/SIZE_GB);
204         else if ((size % SIZE_MB) == 0)
205                 sprintf(buf, "%llum", size/SIZE_MB);
206         else if (size % SIZE_KB == 0)
207                 sprintf(buf, "%lluk", size/SIZE_KB);
208         else
209                 sprintf(buf, "%llu", size);
210 }
211
212 /**
213  * This routine does global indexing of all partitions. Resulting index for
214  * current partition is saved in 'mtddevnum'. Current partition name in
215  * 'mtddevname'.
216  */
217 static void index_partitions(void)
218 {
219         u16 mtddevnum;
220         struct part_info *part;
221         struct list_head *dentry;
222         struct mtd_device *dev;
223
224         debug("--- index partitions ---\n");
225
226         if (current_mtd_dev) {
227                 mtddevnum = 0;
228                 list_for_each(dentry, &devices) {
229                         dev = list_entry(dentry, struct mtd_device, link);
230                         if (dev == current_mtd_dev) {
231                                 mtddevnum += current_mtd_partnum;
232                                 setenv_ulong("mtddevnum", mtddevnum);
233                                 break;
234                         }
235                         mtddevnum += dev->num_parts;
236                 }
237
238                 part = mtd_part_info(current_mtd_dev, current_mtd_partnum);
239                 setenv("mtddevname", part->name);
240
241                 debug("=> mtddevnum %d,\n=> mtddevname %s\n", mtddevnum, part->name);
242         } else {
243                 setenv("mtddevnum", NULL);
244                 setenv("mtddevname", NULL);
245
246                 debug("=> mtddevnum NULL\n=> mtddevname NULL\n");
247         }
248 }
249
250 /**
251  * Save current device and partition in environment variable 'partition'.
252  */
253 static void current_save(void)
254 {
255         char buf[16];
256
257         debug("--- current_save ---\n");
258
259         if (current_mtd_dev) {
260                 sprintf(buf, "%s%d,%d", MTD_DEV_TYPE(current_mtd_dev->id->type),
261                                         current_mtd_dev->id->num, current_mtd_partnum);
262
263                 setenv("partition", buf);
264                 strncpy(last_partition, buf, 16);
265
266                 debug("=> partition %s\n", buf);
267         } else {
268                 setenv("partition", NULL);
269                 last_partition[0] = '\0';
270
271                 debug("=> partition NULL\n");
272         }
273         index_partitions();
274 }
275
276
277 /**
278  * Produce a mtd_info given a type and num.
279  *
280  * @param type mtd type
281  * @param num mtd number
282  * @param mtd a pointer to an mtd_info instance (output)
283  * @return 0 if device is valid, 1 otherwise
284  */
285 static int get_mtd_info(u8 type, u8 num, struct mtd_info **mtd)
286 {
287         char mtd_dev[16];
288
289         sprintf(mtd_dev, "%s%d", MTD_DEV_TYPE(type), num);
290         *mtd = get_mtd_device_nm(mtd_dev);
291         if (IS_ERR(*mtd)) {
292                 printf("Device %s not found!\n", mtd_dev);
293                 return 1;
294         }
295         put_mtd_device(*mtd);
296
297         return 0;
298 }
299
300 /**
301  * Performs sanity check for supplied flash partition.
302  * Table of existing MTD flash devices is searched and partition device
303  * is located. Alignment with the granularity of nand erasesize is verified.
304  *
305  * @param id of the parent device
306  * @param part partition to validate
307  * @return 0 if partition is valid, 1 otherwise
308  */
309 static int part_validate_eraseblock(struct mtdids *id, struct part_info *part)
310 {
311         struct mtd_info *mtd = NULL;
312         int i, j;
313         ulong start;
314         u64 offset, size;
315
316         if (get_mtd_info(id->type, id->num, &mtd))
317                 return 1;
318
319         part->sector_size = mtd->erasesize;
320
321         if (!mtd->numeraseregions) {
322                 /*
323                  * Only one eraseregion (NAND, OneNAND or uniform NOR),
324                  * checking for alignment is easy here
325                  */
326                 offset = part->offset;
327                 if (do_div(offset, mtd->erasesize)) {
328                         printf("%s%d: partition (%s) start offset alignment incorrect\n",
329                                MTD_DEV_TYPE(id->type), id->num, part->name);
330                         return 1;
331                 }
332
333                 size = part->size;
334                 if (do_div(size, mtd->erasesize)) {
335                         printf("%s%d: partition (%s) size alignment incorrect\n",
336                                MTD_DEV_TYPE(id->type), id->num, part->name);
337                         return 1;
338                 }
339         } else {
340                 /*
341                  * Multiple eraseregions (non-uniform NOR),
342                  * checking for alignment is more complex here
343                  */
344
345                 /* Check start alignment */
346                 for (i = 0; i < mtd->numeraseregions; i++) {
347                         start = mtd->eraseregions[i].offset;
348                         for (j = 0; j < mtd->eraseregions[i].numblocks; j++) {
349                                 if (part->offset == start)
350                                         goto start_ok;
351                                 start += mtd->eraseregions[i].erasesize;
352                         }
353                 }
354
355                 printf("%s%d: partition (%s) start offset alignment incorrect\n",
356                        MTD_DEV_TYPE(id->type), id->num, part->name);
357                 return 1;
358
359         start_ok:
360
361                 /* Check end/size alignment */
362                 for (i = 0; i < mtd->numeraseregions; i++) {
363                         start = mtd->eraseregions[i].offset;
364                         for (j = 0; j < mtd->eraseregions[i].numblocks; j++) {
365                                 if ((part->offset + part->size) == start)
366                                         goto end_ok;
367                                 start += mtd->eraseregions[i].erasesize;
368                         }
369                 }
370                 /* Check last sector alignment */
371                 if ((part->offset + part->size) == start)
372                         goto end_ok;
373
374                 printf("%s%d: partition (%s) size alignment incorrect\n",
375                        MTD_DEV_TYPE(id->type), id->num, part->name);
376                 return 1;
377
378         end_ok:
379                 return 0;
380         }
381
382         return 0;
383 }
384
385
386 /**
387  * Performs sanity check for supplied partition. Offset and size are
388  * verified to be within valid range. Partition type is checked and
389  * part_validate_eraseblock() is called with the argument of part.
390  *
391  * @param id of the parent device
392  * @param part partition to validate
393  * @return 0 if partition is valid, 1 otherwise
394  */
395 static int part_validate(struct mtdids *id, struct part_info *part)
396 {
397         if (part->size == SIZE_REMAINING)
398                 part->size = id->size - part->offset;
399
400         if (part->offset > id->size) {
401                 printf("%s: offset %08llx beyond flash size %08llx\n",
402                                 id->mtd_id, part->offset, id->size);
403                 return 1;
404         }
405
406         if ((part->offset + part->size) <= part->offset) {
407                 printf("%s%d: partition (%s) size too big\n",
408                                 MTD_DEV_TYPE(id->type), id->num, part->name);
409                 return 1;
410         }
411
412         if (part->offset + part->size > id->size) {
413                 printf("%s: partitioning exceeds flash size\n", id->mtd_id);
414                 return 1;
415         }
416
417         /*
418          * Now we need to check if the partition starts and ends on
419          * sector (eraseblock) regions
420          */
421         return part_validate_eraseblock(id, part);
422 }
423
424 /**
425  * Delete selected partition from the partition list of the specified device.
426  *
427  * @param dev device to delete partition from
428  * @param part partition to delete
429  * @return 0 on success, 1 otherwise
430  */
431 static int part_del(struct mtd_device *dev, struct part_info *part)
432 {
433         u8 current_save_needed = 0;
434
435         /* if there is only one partition, remove whole device */
436         if (dev->num_parts == 1)
437                 return device_del(dev);
438
439         /* otherwise just delete this partition */
440
441         if (dev == current_mtd_dev) {
442                 /* we are modyfing partitions for the current device,
443                  * update current */
444                 struct part_info *curr_pi;
445                 curr_pi = mtd_part_info(current_mtd_dev, current_mtd_partnum);
446
447                 if (curr_pi) {
448                         if (curr_pi == part) {
449                                 printf("current partition deleted, resetting current to 0\n");
450                                 current_mtd_partnum = 0;
451                         } else if (part->offset <= curr_pi->offset) {
452                                 current_mtd_partnum--;
453                         }
454                         current_save_needed = 1;
455                 }
456         }
457
458         list_del(&part->link);
459         free(part);
460         dev->num_parts--;
461
462         if (current_save_needed > 0)
463                 current_save();
464         else
465                 index_partitions();
466
467         return 0;
468 }
469
470 /**
471  * Delete all partitions from parts head list, free memory.
472  *
473  * @param head list of partitions to delete
474  */
475 static void part_delall(struct list_head *head)
476 {
477         struct list_head *entry, *n;
478         struct part_info *part_tmp;
479
480         /* clean tmp_list and free allocated memory */
481         list_for_each_safe(entry, n, head) {
482                 part_tmp = list_entry(entry, struct part_info, link);
483
484                 list_del(entry);
485                 free(part_tmp);
486         }
487 }
488
489 /**
490  * Add new partition to the supplied partition list. Make sure partitions are
491  * sorted by offset in ascending order.
492  *
493  * @param head list this partition is to be added to
494  * @param new partition to be added
495  */
496 static int part_sort_add(struct mtd_device *dev, struct part_info *part)
497 {
498         struct list_head *entry;
499         struct part_info *new_pi, *curr_pi;
500
501         /* link partition to parrent dev */
502         part->dev = dev;
503
504         if (list_empty(&dev->parts)) {
505                 debug("part_sort_add: list empty\n");
506                 list_add(&part->link, &dev->parts);
507                 dev->num_parts++;
508                 index_partitions();
509                 return 0;
510         }
511
512         new_pi = list_entry(&part->link, struct part_info, link);
513
514         /* get current partition info if we are updating current device */
515         curr_pi = NULL;
516         if (dev == current_mtd_dev)
517                 curr_pi = mtd_part_info(current_mtd_dev, current_mtd_partnum);
518
519         list_for_each(entry, &dev->parts) {
520                 struct part_info *pi;
521
522                 pi = list_entry(entry, struct part_info, link);
523
524                 /* be compliant with kernel cmdline, allow only one partition at offset zero */
525                 if ((new_pi->offset == pi->offset) && (pi->offset == 0)) {
526                         printf("cannot add second partition at offset 0\n");
527                         return 1;
528                 }
529
530                 if (new_pi->offset <= pi->offset) {
531                         list_add_tail(&part->link, entry);
532                         dev->num_parts++;
533
534                         if (curr_pi && (pi->offset <= curr_pi->offset)) {
535                                 /* we are modyfing partitions for the current
536                                  * device, update current */
537                                 current_mtd_partnum++;
538                                 current_save();
539                         } else {
540                                 index_partitions();
541                         }
542                         return 0;
543                 }
544         }
545
546         list_add_tail(&part->link, &dev->parts);
547         dev->num_parts++;
548         index_partitions();
549         return 0;
550 }
551
552 /**
553  * Add provided partition to the partition list of a given device.
554  *
555  * @param dev device to which partition is added
556  * @param part partition to be added
557  * @return 0 on success, 1 otherwise
558  */
559 static int part_add(struct mtd_device *dev, struct part_info *part)
560 {
561         /* verify alignment and size */
562         if (part_validate(dev->id, part) != 0)
563                 return 1;
564
565         /* partition is ok, add it to the list */
566         if (part_sort_add(dev, part) != 0)
567                 return 1;
568
569         return 0;
570 }
571
572 /**
573  * Parse one partition definition, allocate memory and return pointer to this
574  * location in retpart.
575  *
576  * @param partdef pointer to the partition definition string i.e. <part-def>
577  * @param ret output pointer to next char after parse completes (output)
578  * @param retpart pointer to the allocated partition (output)
579  * @return 0 on success, 1 otherwise
580  */
581 static int part_parse(const char *const partdef, const char **ret, struct part_info **retpart)
582 {
583         struct part_info *part;
584         u64 size;
585         u64 offset;
586         const char *name;
587         int name_len;
588         unsigned int mask_flags;
589         const char *p;
590
591         p = partdef;
592         *retpart = NULL;
593         *ret = NULL;
594
595         /* fetch the partition size */
596         if (*p == '-') {
597                 /* assign all remaining space to this partition */
598                 debug("'-': remaining size assigned\n");
599                 size = SIZE_REMAINING;
600                 p++;
601         } else {
602                 size = memsize_parse(p, &p);
603                 if (size < MIN_PART_SIZE) {
604                         printf("partition size too small (%llx)\n", size);
605                         return 1;
606                 }
607         }
608
609         /* check for offset */
610         offset = OFFSET_NOT_SPECIFIED;
611         if (*p == '@') {
612                 p++;
613                 offset = memsize_parse(p, &p);
614         }
615
616         /* now look for the name */
617         if (*p == '(') {
618                 name = ++p;
619                 if ((p = strchr(name, ')')) == NULL) {
620                         printf("no closing ) found in partition name\n");
621                         return 1;
622                 }
623                 name_len = p - name + 1;
624                 if ((name_len - 1) == 0) {
625                         printf("empty partition name\n");
626                         return 1;
627                 }
628                 p++;
629         } else {
630                 /* 0x00000000@0x00000000 */
631                 name_len = 22;
632                 name = NULL;
633         }
634
635         /* test for options */
636         mask_flags = 0;
637         if (strncmp(p, "ro", 2) == 0) {
638                 mask_flags |= MTD_WRITEABLE_CMD;
639                 p += 2;
640         }
641
642         /* check for next partition definition */
643         if (*p == ',') {
644                 if (size == SIZE_REMAINING) {
645                         *ret = NULL;
646                         printf("no partitions allowed after a fill-up partition\n");
647                         return 1;
648                 }
649                 *ret = ++p;
650         } else if ((*p == ';') || (*p == '\0')) {
651                 *ret = p;
652         } else {
653                 printf("unexpected character '%c' at the end of partition\n", *p);
654                 *ret = NULL;
655                 return 1;
656         }
657
658         /*  allocate memory */
659         part = (struct part_info *)malloc(sizeof(struct part_info) + name_len);
660         if (!part) {
661                 printf("out of memory\n");
662                 return 1;
663         }
664         memset(part, 0, sizeof(struct part_info) + name_len);
665         part->size = size;
666         part->offset = offset;
667         part->mask_flags = mask_flags;
668         part->name = (char *)(part + 1);
669
670         if (name) {
671                 /* copy user provided name */
672                 strncpy(part->name, name, name_len - 1);
673                 part->auto_name = 0;
674         } else {
675                 /* auto generated name in form of size@offset */
676                 sprintf(part->name, "0x%08llx@0x%08llx", size, offset);
677                 part->auto_name = 1;
678         }
679
680         part->name[name_len - 1] = '\0';
681         INIT_LIST_HEAD(&part->link);
682
683         debug("+ partition: name %-22s size 0x%08llx offset 0x%08llx mask flags %d\n",
684                         part->name, part->size,
685                         part->offset, part->mask_flags);
686
687         *retpart = part;
688         return 0;
689 }
690
691 /**
692  * Check device number to be within valid range for given device type.
693  *
694  * @param type mtd type
695  * @param num mtd number
696  * @param size a pointer to the size of the mtd device (output)
697  * @return 0 if device is valid, 1 otherwise
698  */
699 static int mtd_device_validate(u8 type, u8 num, u64 *size)
700 {
701         struct mtd_info *mtd = NULL;
702
703         if (get_mtd_info(type, num, &mtd))
704                 return 1;
705
706         *size = mtd->size;
707
708         return 0;
709 }
710
711 /**
712  * Delete all mtd devices from a supplied devices list, free memory allocated for
713  * each device and delete all device partitions.
714  *
715  * @return 0 on success, 1 otherwise
716  */
717 static int device_delall(struct list_head *head)
718 {
719         struct list_head *entry, *n;
720         struct mtd_device *dev_tmp;
721
722         /* clean devices list */
723         list_for_each_safe(entry, n, head) {
724                 dev_tmp = list_entry(entry, struct mtd_device, link);
725                 list_del(entry);
726                 part_delall(&dev_tmp->parts);
727                 free(dev_tmp);
728         }
729         INIT_LIST_HEAD(&devices);
730
731         return 0;
732 }
733
734 /**
735  * If provided device exists it's partitions are deleted, device is removed
736  * from device list and device memory is freed.
737  *
738  * @param dev device to be deleted
739  * @return 0 on success, 1 otherwise
740  */
741 static int device_del(struct mtd_device *dev)
742 {
743         part_delall(&dev->parts);
744         list_del(&dev->link);
745         free(dev);
746
747         if (dev == current_mtd_dev) {
748                 /* we just deleted current device */
749                 if (list_empty(&devices)) {
750                         current_mtd_dev = NULL;
751                 } else {
752                         /* reset first partition from first dev from the
753                          * devices list as current */
754                         current_mtd_dev = list_entry(devices.next, struct mtd_device, link);
755                         current_mtd_partnum = 0;
756                 }
757                 current_save();
758                 return 0;
759         }
760
761         index_partitions();
762         return 0;
763 }
764
765 /**
766  * Search global device list and return pointer to the device of type and num
767  * specified.
768  *
769  * @param type device type
770  * @param num device number
771  * @return NULL if requested device does not exist
772  */
773 struct mtd_device *device_find(u8 type, u8 num)
774 {
775         struct list_head *entry;
776         struct mtd_device *dev_tmp;
777
778         list_for_each(entry, &devices) {
779                 dev_tmp = list_entry(entry, struct mtd_device, link);
780
781                 if ((dev_tmp->id->type == type) && (dev_tmp->id->num == num))
782                         return dev_tmp;
783         }
784
785         return NULL;
786 }
787
788 /**
789  * Add specified device to the global device list.
790  *
791  * @param dev device to be added
792  */
793 static void device_add(struct mtd_device *dev)
794 {
795         u8 current_save_needed = 0;
796
797         if (list_empty(&devices)) {
798                 current_mtd_dev = dev;
799                 current_mtd_partnum = 0;
800                 current_save_needed = 1;
801         }
802
803         list_add_tail(&dev->link, &devices);
804
805         if (current_save_needed > 0)
806                 current_save();
807         else
808                 index_partitions();
809 }
810
811 /**
812  * Parse device type, name and mtd-id. If syntax is ok allocate memory and
813  * return pointer to the device structure.
814  *
815  * @param mtd_dev pointer to the device definition string i.e. <mtd-dev>
816  * @param ret output pointer to next char after parse completes (output)
817  * @param retdev pointer to the allocated device (output)
818  * @return 0 on success, 1 otherwise
819  */
820 static int device_parse(const char *const mtd_dev, const char **ret, struct mtd_device **retdev)
821 {
822         struct mtd_device *dev;
823         struct part_info *part;
824         struct mtdids *id;
825         const char *mtd_id;
826         unsigned int mtd_id_len;
827         const char *p;
828         const char *pend;
829         LIST_HEAD(tmp_list);
830         struct list_head *entry, *n;
831         u16 num_parts;
832         u64 offset;
833         int err = 1;
834
835         debug("===device_parse===\n");
836
837         assert(retdev);
838         *retdev = NULL;
839
840         if (ret)
841                 *ret = NULL;
842
843         /* fetch <mtd-id> */
844         mtd_id = p = mtd_dev;
845         if (!(p = strchr(mtd_id, ':'))) {
846                 printf("no <mtd-id> identifier\n");
847                 return 1;
848         }
849         mtd_id_len = p - mtd_id + 1;
850         p++;
851
852         /* verify if we have a valid device specified */
853         if ((id = id_find_by_mtd_id(mtd_id, mtd_id_len - 1)) == NULL) {
854                 printf("invalid mtd device '%.*s'\n", mtd_id_len - 1, mtd_id);
855                 return 1;
856         }
857
858 #ifdef DEBUG
859         pend = strchr(p, ';');
860 #endif
861         debug("dev type = %d (%s), dev num = %d, mtd-id = %s\n",
862                         id->type, MTD_DEV_TYPE(id->type),
863                         id->num, id->mtd_id);
864         debug("parsing partitions %.*s\n", (int)(pend ? pend - p : strlen(p)), p);
865
866
867         /* parse partitions */
868         num_parts = 0;
869
870         offset = 0;
871         if ((dev = device_find(id->type, id->num)) != NULL) {
872                 /* if device already exists start at the end of the last partition */
873                 part = list_entry(dev->parts.prev, struct part_info, link);
874                 offset = part->offset + part->size;
875         }
876
877         while (p && (*p != '\0') && (*p != ';')) {
878                 err = 1;
879                 if ((part_parse(p, &p, &part) != 0) || (!part))
880                         break;
881
882                 /* calculate offset when not specified */
883                 if (part->offset == OFFSET_NOT_SPECIFIED)
884                         part->offset = offset;
885                 else
886                         offset = part->offset;
887
888                 /* verify alignment and size */
889                 if (part_validate(id, part) != 0)
890                         break;
891
892                 offset += part->size;
893
894                 /* partition is ok, add it to the list */
895                 list_add_tail(&part->link, &tmp_list);
896                 num_parts++;
897                 err = 0;
898         }
899         if (err == 1) {
900                 part_delall(&tmp_list);
901                 return 1;
902         }
903
904         if (num_parts == 0) {
905                 printf("no partitions for device %s%d (%s)\n",
906                                 MTD_DEV_TYPE(id->type), id->num, id->mtd_id);
907                 return 1;
908         }
909
910         debug("\ntotal partitions: %d\n", num_parts);
911
912         /* check for next device presence */
913         if (p) {
914                 if (*p == ';') {
915                         if (ret)
916                                 *ret = ++p;
917                 } else if (*p == '\0') {
918                         if (ret)
919                                 *ret = p;
920                 } else {
921                         printf("unexpected character '%c' at the end of device\n", *p);
922                         if (ret)
923                                 *ret = NULL;
924                         return 1;
925                 }
926         }
927
928         /* allocate memory for mtd_device structure */
929         if ((dev = (struct mtd_device *)malloc(sizeof(struct mtd_device))) == NULL) {
930                 printf("out of memory\n");
931                 return 1;
932         }
933         memset(dev, 0, sizeof(struct mtd_device));
934         dev->id = id;
935         dev->num_parts = 0; /* part_sort_add increments num_parts */
936         INIT_LIST_HEAD(&dev->parts);
937         INIT_LIST_HEAD(&dev->link);
938
939         /* move partitions from tmp_list to dev->parts */
940         list_for_each_safe(entry, n, &tmp_list) {
941                 part = list_entry(entry, struct part_info, link);
942                 list_del(entry);
943                 if (part_sort_add(dev, part) != 0) {
944                         device_del(dev);
945                         return 1;
946                 }
947         }
948
949         *retdev = dev;
950
951         debug("===\n\n");
952         return 0;
953 }
954
955 /**
956  * Initialize global device list.
957  *
958  * @return 0 on success, 1 otherwise
959  */
960 static int mtd_devices_init(void)
961 {
962         last_parts[0] = '\0';
963         current_mtd_dev = NULL;
964         current_save();
965
966         return device_delall(&devices);
967 }
968
969 /*
970  * Search global mtdids list and find id of requested type and number.
971  *
972  * @return pointer to the id if it exists, NULL otherwise
973  */
974 static struct mtdids* id_find(u8 type, u8 num)
975 {
976         struct list_head *entry;
977         struct mtdids *id;
978
979         list_for_each(entry, &mtdids) {
980                 id = list_entry(entry, struct mtdids, link);
981
982                 if ((id->type == type) && (id->num == num))
983                         return id;
984         }
985
986         return NULL;
987 }
988
989 /**
990  * Search global mtdids list and find id of a requested mtd_id.
991  *
992  * Note: first argument is not null terminated.
993  *
994  * @param mtd_id string containing requested mtd_id
995  * @param mtd_id_len length of supplied mtd_id
996  * @return pointer to the id if it exists, NULL otherwise
997  */
998 static struct mtdids* id_find_by_mtd_id(const char *mtd_id, unsigned int mtd_id_len)
999 {
1000         struct list_head *entry;
1001         struct mtdids *id;
1002
1003         debug("--- id_find_by_mtd_id: '%.*s' (len = %d)\n",
1004                         mtd_id_len, mtd_id, mtd_id_len);
1005
1006         list_for_each(entry, &mtdids) {
1007                 id = list_entry(entry, struct mtdids, link);
1008
1009                 debug("entry: '%s' (len = %zu)\n",
1010                                 id->mtd_id, strlen(id->mtd_id));
1011
1012                 if (mtd_id_len != strlen(id->mtd_id))
1013                         continue;
1014                 if (strncmp(id->mtd_id, mtd_id, mtd_id_len) == 0)
1015                         return id;
1016         }
1017
1018         return NULL;
1019 }
1020
1021 /**
1022  * Parse device id string <dev-id> := 'nand'|'nor'|'onenand'<dev-num>,
1023  * return device type and number.
1024  *
1025  * @param id string describing device id
1026  * @param ret_id output pointer to next char after parse completes (output)
1027  * @param dev_type parsed device type (output)
1028  * @param dev_num parsed device number (output)
1029  * @return 0 on success, 1 otherwise
1030  */
1031 int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type,
1032                  u8 *dev_num)
1033 {
1034         const char *p = id;
1035
1036         *dev_type = 0;
1037         if (strncmp(p, "nand", 4) == 0) {
1038                 *dev_type = MTD_DEV_TYPE_NAND;
1039                 p += 4;
1040         } else if (strncmp(p, "nor", 3) == 0) {
1041                 *dev_type = MTD_DEV_TYPE_NOR;
1042                 p += 3;
1043         } else if (strncmp(p, "onenand", 7) == 0) {
1044                 *dev_type = MTD_DEV_TYPE_ONENAND;
1045                 p += 7;
1046         } else {
1047                 printf("incorrect device type in %s\n", id);
1048                 return 1;
1049         }
1050
1051         if (!isdigit(*p)) {
1052                 printf("incorrect device number in %s\n", id);
1053                 return 1;
1054         }
1055
1056         *dev_num = simple_strtoul(p, (char **)&p, 0);
1057         if (ret_id)
1058                 *ret_id = p;
1059         return 0;
1060 }
1061
1062 /**
1063  * Process all devices and generate corresponding mtdparts string describing
1064  * all partitions on all devices.
1065  *
1066  * @param buf output buffer holding generated mtdparts string (output)
1067  * @param buflen buffer size
1068  * @return 0 on success, 1 otherwise
1069  */
1070 static int generate_mtdparts(char *buf, u32 buflen)
1071 {
1072         struct list_head *pentry, *dentry;
1073         struct mtd_device *dev;
1074         struct part_info *part, *prev_part;
1075         char *p = buf;
1076         char tmpbuf[32];
1077         u64 size, offset;
1078         u32 len, part_cnt;
1079         u32 maxlen = buflen - 1;
1080
1081         debug("--- generate_mtdparts ---\n");
1082
1083         if (list_empty(&devices)) {
1084                 buf[0] = '\0';
1085                 return 0;
1086         }
1087
1088         sprintf(p, "mtdparts=");
1089         p += 9;
1090
1091         list_for_each(dentry, &devices) {
1092                 dev = list_entry(dentry, struct mtd_device, link);
1093
1094                 /* copy mtd_id */
1095                 len = strlen(dev->id->mtd_id) + 1;
1096                 if (len > maxlen)
1097                         goto cleanup;
1098                 memcpy(p, dev->id->mtd_id, len - 1);
1099                 p += len - 1;
1100                 *(p++) = ':';
1101                 maxlen -= len;
1102
1103                 /* format partitions */
1104                 prev_part = NULL;
1105                 part_cnt = 0;
1106                 list_for_each(pentry, &dev->parts) {
1107                         part = list_entry(pentry, struct part_info, link);
1108                         size = part->size;
1109                         offset = part->offset;
1110                         part_cnt++;
1111
1112                         /* partition size */
1113                         memsize_format(tmpbuf, size);
1114                         len = strlen(tmpbuf);
1115                         if (len > maxlen)
1116                                 goto cleanup;
1117                         memcpy(p, tmpbuf, len);
1118                         p += len;
1119                         maxlen -= len;
1120
1121
1122                         /* add offset only when there is a gap between
1123                          * partitions */
1124                         if ((!prev_part && (offset != 0)) ||
1125                                         (prev_part && ((prev_part->offset + prev_part->size) != part->offset))) {
1126
1127                                 memsize_format(tmpbuf, offset);
1128                                 len = strlen(tmpbuf) + 1;
1129                                 if (len > maxlen)
1130                                         goto cleanup;
1131                                 *(p++) = '@';
1132                                 memcpy(p, tmpbuf, len - 1);
1133                                 p += len - 1;
1134                                 maxlen -= len;
1135                         }
1136
1137                         /* copy name only if user supplied */
1138                         if(!part->auto_name) {
1139                                 len = strlen(part->name) + 2;
1140                                 if (len > maxlen)
1141                                         goto cleanup;
1142
1143                                 *(p++) = '(';
1144                                 memcpy(p, part->name, len - 2);
1145                                 p += len - 2;
1146                                 *(p++) = ')';
1147                                 maxlen -= len;
1148                         }
1149
1150                         /* ro mask flag */
1151                         if (part->mask_flags && MTD_WRITEABLE_CMD) {
1152                                 len = 2;
1153                                 if (len > maxlen)
1154                                         goto cleanup;
1155                                 *(p++) = 'r';
1156                                 *(p++) = 'o';
1157                                 maxlen -= 2;
1158                         }
1159
1160                         /* print ',' separator if there are other partitions
1161                          * following */
1162                         if (dev->num_parts > part_cnt) {
1163                                 if (1 > maxlen)
1164                                         goto cleanup;
1165                                 *(p++) = ',';
1166                                 maxlen--;
1167                         }
1168                         prev_part = part;
1169                 }
1170                 /* print ';' separator if there are other devices following */
1171                 if (dentry->next != &devices) {
1172                         if (1 > maxlen)
1173                                 goto cleanup;
1174                         *(p++) = ';';
1175                         maxlen--;
1176                 }
1177         }
1178
1179         /* we still have at least one char left, as we decremented maxlen at
1180          * the begining */
1181         *p = '\0';
1182
1183         return 0;
1184
1185 cleanup:
1186         last_parts[0] = '\0';
1187         return 1;
1188 }
1189
1190 /**
1191  * Call generate_mtdparts to process all devices and generate corresponding
1192  * mtdparts string, save it in mtdparts environment variable.
1193  *
1194  * @param buf output buffer holding generated mtdparts string (output)
1195  * @param buflen buffer size
1196  * @return 0 on success, 1 otherwise
1197  */
1198 static int generate_mtdparts_save(char *buf, u32 buflen)
1199 {
1200         int ret;
1201
1202         ret = generate_mtdparts(buf, buflen);
1203
1204         if ((buf[0] != '\0') && (ret == 0))
1205                 setenv("mtdparts", buf);
1206         else
1207                 setenv("mtdparts", NULL);
1208
1209         return ret;
1210 }
1211
1212 #if defined(CONFIG_CMD_MTDPARTS_SHOW_NET_SIZES)
1213 /**
1214  * Get the net size (w/o bad blocks) of the given partition.
1215  *
1216  * @param mtd the mtd info
1217  * @param part the partition
1218  * @return the calculated net size of this partition
1219  */
1220 static uint64_t net_part_size(struct mtd_info *mtd, struct part_info *part)
1221 {
1222         uint64_t i, net_size = 0;
1223
1224         if (!mtd->block_isbad)
1225                 return part->size;
1226
1227         for (i = 0; i < part->size; i += mtd->erasesize) {
1228                 if (!mtd->block_isbad(mtd, part->offset + i))
1229                         net_size += mtd->erasesize;
1230         }
1231
1232         return net_size;
1233 }
1234 #endif
1235
1236 static void print_partition_table(void)
1237 {
1238         struct list_head *dentry, *pentry;
1239         struct part_info *part;
1240         struct mtd_device *dev;
1241         int part_num;
1242
1243         list_for_each(dentry, &devices) {
1244                 dev = list_entry(dentry, struct mtd_device, link);
1245                 /* list partitions for given device */
1246                 part_num = 0;
1247 #if defined(CONFIG_CMD_MTDPARTS_SHOW_NET_SIZES)
1248                 struct mtd_info *mtd;
1249
1250                 if (get_mtd_info(dev->id->type, dev->id->num, &mtd))
1251                         return;
1252
1253                 printf("\ndevice %s%d <%s>, # parts = %d\n",
1254                                 MTD_DEV_TYPE(dev->id->type), dev->id->num,
1255                                 dev->id->mtd_id, dev->num_parts);
1256                 printf(" #: name\t\tsize\t\tnet size\toffset\t\tmask_flags\n");
1257
1258                 list_for_each(pentry, &dev->parts) {
1259                         u32 net_size;
1260                         char *size_note;
1261
1262                         part = list_entry(pentry, struct part_info, link);
1263                         net_size = net_part_size(mtd, part);
1264                         size_note = part->size == net_size ? " " : " (!)";
1265                         printf("%2d: %-20s0x%08x\t0x%08x%s\t0x%08x\t%d\n",
1266                                         part_num, part->name, part->size,
1267                                         net_size, size_note, part->offset,
1268                                         part->mask_flags);
1269 #else /* !defined(CONFIG_CMD_MTDPARTS_SHOW_NET_SIZES) */
1270                 printf("\ndevice %s%d <%s>, # parts = %d\n",
1271                                 MTD_DEV_TYPE(dev->id->type), dev->id->num,
1272                                 dev->id->mtd_id, dev->num_parts);
1273                 printf(" #: name\t\tsize\t\toffset\t\tmask_flags\n");
1274
1275                 list_for_each(pentry, &dev->parts) {
1276                         part = list_entry(pentry, struct part_info, link);
1277                         printf("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
1278                                         part_num, part->name, part->size,
1279                                         part->offset, part->mask_flags);
1280 #endif /* defined(CONFIG_CMD_MTDPARTS_SHOW_NET_SIZES) */
1281                         part_num++;
1282                 }
1283         }
1284
1285         if (list_empty(&devices))
1286                 printf("no partitions defined\n");
1287 }
1288
1289 /**
1290  * Format and print out a partition list for each device from global device
1291  * list.
1292  */
1293 static void list_partitions(void)
1294 {
1295         struct part_info *part;
1296
1297         debug("\n---list_partitions---\n");
1298         print_partition_table();
1299
1300         /* current_mtd_dev is not NULL only when we have non empty device list */
1301         if (current_mtd_dev) {
1302                 part = mtd_part_info(current_mtd_dev, current_mtd_partnum);
1303                 if (part) {
1304                         printf("\nactive partition: %s%d,%d - (%s) 0x%08llx @ 0x%08llx\n",
1305                                         MTD_DEV_TYPE(current_mtd_dev->id->type),
1306                                         current_mtd_dev->id->num, current_mtd_partnum,
1307                                         part->name, part->size, part->offset);
1308                 } else {
1309                         printf("could not get current partition info\n\n");
1310                 }
1311         }
1312
1313         printf("\ndefaults:\n");
1314         printf("mtdids  : %s\n",
1315                 mtdids_default ? mtdids_default : "none");
1316         /*
1317          * Using printf() here results in printbuffer overflow
1318          * if default mtdparts string is greater than console
1319          * printbuffer. Use puts() to prevent system crashes.
1320          */
1321         puts("mtdparts: ");
1322         puts(mtdparts_default ? mtdparts_default : "none");
1323         puts("\n");
1324 }
1325
1326 /**
1327  * Given partition identifier in form of <dev_type><dev_num>,<part_num> find
1328  * corresponding device and verify partition number.
1329  *
1330  * @param id string describing device and partition or partition name
1331  * @param dev pointer to the requested device (output)
1332  * @param part_num verified partition number (output)
1333  * @param part pointer to requested partition (output)
1334  * @return 0 on success, 1 otherwise
1335  */
1336 int find_dev_and_part(const char *id, struct mtd_device **dev,
1337                 u8 *part_num, struct part_info **part)
1338 {
1339         struct list_head *dentry, *pentry;
1340         u8 type, dnum, pnum;
1341         const char *p;
1342
1343         debug("--- find_dev_and_part ---\nid = %s\n", id);
1344
1345         list_for_each(dentry, &devices) {
1346                 *part_num = 0;
1347                 *dev = list_entry(dentry, struct mtd_device, link);
1348                 list_for_each(pentry, &(*dev)->parts) {
1349                         *part = list_entry(pentry, struct part_info, link);
1350                         if (strcmp((*part)->name, id) == 0)
1351                                 return 0;
1352                         (*part_num)++;
1353                 }
1354         }
1355
1356         p = id;
1357         *dev = NULL;
1358         *part = NULL;
1359         *part_num = 0;
1360
1361         if (mtd_id_parse(p, &p, &type, &dnum) != 0)
1362                 return 1;
1363
1364         if ((*p++ != ',') || (*p == '\0')) {
1365                 printf("no partition number specified\n");
1366                 return 1;
1367         }
1368         pnum = simple_strtoul(p, (char **)&p, 0);
1369         if (*p != '\0') {
1370                 printf("unexpected trailing character '%c'\n", *p);
1371                 return 1;
1372         }
1373
1374         if ((*dev = device_find(type, dnum)) == NULL) {
1375                 printf("no such device %s%d\n", MTD_DEV_TYPE(type), dnum);
1376                 return 1;
1377         }
1378
1379         if ((*part = mtd_part_info(*dev, pnum)) == NULL) {
1380                 printf("no such partition\n");
1381                 *dev = NULL;
1382                 return 1;
1383         }
1384
1385         *part_num = pnum;
1386
1387         return 0;
1388 }
1389
1390 /**
1391  * Find and delete partition. For partition id format see find_dev_and_part().
1392  *
1393  * @param id string describing device and partition
1394  * @return 0 on success, 1 otherwise
1395  */
1396 static int delete_partition(const char *id)
1397 {
1398         u8 pnum;
1399         struct mtd_device *dev;
1400         struct part_info *part;
1401
1402         if (find_dev_and_part(id, &dev, &pnum, &part) == 0) {
1403
1404                 debug("delete_partition: device = %s%d, partition %d = (%s) 0x%08llx@0x%08llx\n",
1405                                 MTD_DEV_TYPE(dev->id->type), dev->id->num, pnum,
1406                                 part->name, part->size, part->offset);
1407
1408                 if (part_del(dev, part) != 0)
1409                         return CMD_RET_FAILURE;
1410
1411                 if (generate_mtdparts_save(last_parts, MTDPARTS_MAXLEN) != 0) {
1412                         printf("generated mtdparts too long, resetting to null\n");
1413                         return CMD_RET_FAILURE;
1414                 }
1415                 return CMD_RET_SUCCESS;
1416         }
1417
1418         printf("partition %s not found\n", id);
1419         return CMD_RET_FAILURE;
1420 }
1421
1422 #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
1423 /**
1424  * Increase the size of the given partition so that it's net size is at least
1425  * as large as the size member and such that the next partition would start on a
1426  * good block if it were adjacent to this partition.
1427  *
1428  * @param mtd the mtd device
1429  * @param part the partition
1430  * @param next_offset pointer to the offset of the next partition after this
1431  *                    partition's size has been modified (output)
1432  */
1433 static void spread_partition(struct mtd_info *mtd, struct part_info *part,
1434                              uint64_t *next_offset)
1435 {
1436         uint64_t net_size, padding_size = 0;
1437         int truncated;
1438
1439         mtd_get_len_incl_bad(mtd, part->offset, part->size, &net_size,
1440                              &truncated);
1441
1442         /*
1443          * Absorb bad blocks immediately following this
1444          * partition also into the partition, such that
1445          * the next partition starts with a good block.
1446          */
1447         if (!truncated) {
1448                 mtd_get_len_incl_bad(mtd, part->offset + net_size,
1449                                      mtd->erasesize, &padding_size, &truncated);
1450                 if (truncated)
1451                         padding_size = 0;
1452                 else
1453                         padding_size -= mtd->erasesize;
1454         }
1455
1456         if (truncated) {
1457                 printf("truncated partition %s to %lld bytes\n", part->name,
1458                        (uint64_t) net_size + padding_size);
1459         }
1460
1461         part->size = net_size + padding_size;
1462         *next_offset = part->offset + part->size;
1463 }
1464
1465 /**
1466  * Adjust all of the partition sizes, such that all partitions are at least
1467  * as big as their mtdparts environment variable sizes and they each start
1468  * on a good block.
1469  *
1470  * @return 0 on success, 1 otherwise
1471  */
1472 static int spread_partitions(void)
1473 {
1474         struct list_head *dentry, *pentry;
1475         struct mtd_device *dev;
1476         struct part_info *part;
1477         struct mtd_info *mtd;
1478         int part_num;
1479         uint64_t cur_offs;
1480
1481         list_for_each(dentry, &devices) {
1482                 dev = list_entry(dentry, struct mtd_device, link);
1483
1484                 if (get_mtd_info(dev->id->type, dev->id->num, &mtd))
1485                         return CMD_RET_FAILURE;
1486
1487                 part_num = 0;
1488                 cur_offs = 0;
1489                 list_for_each(pentry, &dev->parts) {
1490                         part = list_entry(pentry, struct part_info, link);
1491
1492                         debug("spread_partitions: device = %s%d, partition %d ="
1493                                 " (%s) 0x%08x@0x%08x\n",
1494                                 MTD_DEV_TYPE(dev->id->type), dev->id->num,
1495                                 part_num, part->name, part->size,
1496                                 part->offset);
1497
1498                         if (cur_offs > part->offset)
1499                                 part->offset = cur_offs;
1500
1501                         spread_partition(mtd, part, &cur_offs);
1502
1503                         part_num++;
1504                 }
1505         }
1506
1507         index_partitions();
1508
1509         if (generate_mtdparts_save(last_parts, MTDPARTS_MAXLEN) != 0) {
1510                 printf("generated mtdparts too long, resetting to null\n");
1511                 return CMD_RET_FAILURE;
1512         }
1513         return CMD_RET_SUCCESS;
1514 }
1515 #endif /* CONFIG_CMD_MTDPARTS_SPREAD */
1516
1517 /**
1518  * Accept character string describing mtd partitions and call device_parse()
1519  * for each entry. Add created devices to the global devices list.
1520  *
1521  * @param mtdparts string specifing mtd partitions
1522  * @return 0 on success, 1 otherwise
1523  */
1524 static int parse_mtdparts(const char *const mtdparts)
1525 {
1526         const char *p = mtdparts;
1527         struct mtd_device *dev;
1528         int err = 1;
1529         char tmp_parts[MTDPARTS_MAXLEN];
1530
1531         debug("\n---parse_mtdparts---\nmtdparts = %s\n\n", p);
1532
1533         /* delete all devices and partitions */
1534         if (mtd_devices_init() != 0) {
1535                 printf("could not initialise device list\n");
1536                 return err;
1537         }
1538
1539         /* re-read 'mtdparts' variable, mtd_devices_init may be updating env */
1540         if (gd->flags & GD_FLG_ENV_READY) {
1541                 p = getenv("mtdparts");
1542         } else {
1543                 p = tmp_parts;
1544                 getenv_f("mtdparts", tmp_parts, MTDPARTS_MAXLEN);
1545         }
1546
1547         if (strncmp(p, "mtdparts=", 9) != 0) {
1548                 printf("mtdparts variable doesn't start with 'mtdparts='\n");
1549                 return err;
1550         }
1551         p += 9;
1552
1553         while (p && (*p != '\0')) {
1554                 err = 1;
1555                 if ((device_parse(p, &p, &dev) != 0) || (!dev))
1556                         break;
1557
1558                 debug("+ device: %s\t%d\t%s\n", MTD_DEV_TYPE(dev->id->type),
1559                                 dev->id->num, dev->id->mtd_id);
1560
1561                 /* check if parsed device is already on the list */
1562                 if (device_find(dev->id->type, dev->id->num) != NULL) {
1563                         printf("device %s%d redefined, please correct mtdparts variable\n",
1564                                         MTD_DEV_TYPE(dev->id->type), dev->id->num);
1565                         break;
1566                 }
1567
1568                 list_add_tail(&dev->link, &devices);
1569                 err = 0;
1570         }
1571         if (err == 1) {
1572                 device_delall(&devices);
1573                 return 1;
1574         }
1575
1576         return 0;
1577 }
1578
1579 /**
1580  * Parse provided string describing mtdids mapping (see file header for mtdids
1581  * variable format). Allocate memory for each entry and add all found entries
1582  * to the global mtdids list.
1583  *
1584  * @param ids mapping string
1585  * @return 0 on success, 1 otherwise
1586  */
1587 static int parse_mtdids(const char *const ids)
1588 {
1589         const char *p = ids;
1590         const char *mtd_id;
1591         int mtd_id_len;
1592         struct mtdids *id;
1593         struct list_head *entry, *n;
1594         struct mtdids *id_tmp;
1595         u8 type, num;
1596         u64 size;
1597         int ret = 1;
1598
1599         debug("\n---parse_mtdids---\nmtdids = %s\n\n", ids);
1600
1601         /* clean global mtdids list */
1602         list_for_each_safe(entry, n, &mtdids) {
1603                 id_tmp = list_entry(entry, struct mtdids, link);
1604                 debug("mtdids del: %d %d\n", id_tmp->type, id_tmp->num);
1605                 list_del(entry);
1606                 free(id_tmp);
1607         }
1608         last_ids[0] = '\0';
1609         INIT_LIST_HEAD(&mtdids);
1610
1611         while(p && (*p != '\0')) {
1612
1613                 ret = 1;
1614                 /* parse 'nor'|'nand'|'onenand'<dev-num> */
1615                 if (mtd_id_parse(p, &p, &type, &num) != 0)
1616                         break;
1617
1618                 if (*p != '=') {
1619                         printf("mtdids: incorrect <dev-num>\n");
1620                         break;
1621                 }
1622                 p++;
1623
1624                 /* check if requested device exists */
1625                 if (mtd_device_validate(type, num, &size) != 0)
1626                         return 1;
1627
1628                 /* locate <mtd-id> */
1629                 mtd_id = p;
1630                 if ((p = strchr(mtd_id, ',')) != NULL) {
1631                         mtd_id_len = p - mtd_id + 1;
1632                         p++;
1633                 } else {
1634                         mtd_id_len = strlen(mtd_id) + 1;
1635                 }
1636                 if (mtd_id_len == 0) {
1637                         printf("mtdids: no <mtd-id> identifier\n");
1638                         break;
1639                 }
1640
1641                 /* check if this id is already on the list */
1642                 int double_entry = 0;
1643                 list_for_each(entry, &mtdids) {
1644                         id_tmp = list_entry(entry, struct mtdids, link);
1645                         if ((id_tmp->type == type) && (id_tmp->num == num)) {
1646                                 double_entry = 1;
1647                                 break;
1648                         }
1649                 }
1650                 if (double_entry) {
1651                         printf("device id %s%d redefined, please correct mtdids variable\n",
1652                                         MTD_DEV_TYPE(type), num);
1653                         break;
1654                 }
1655
1656                 /* allocate mtdids structure */
1657                 if (!(id = (struct mtdids *)malloc(sizeof(struct mtdids) + mtd_id_len))) {
1658                         printf("out of memory\n");
1659                         break;
1660                 }
1661                 memset(id, 0, sizeof(struct mtdids) + mtd_id_len);
1662                 id->num = num;
1663                 id->type = type;
1664                 id->size = size;
1665                 id->mtd_id = (char *)(id + 1);
1666                 strncpy(id->mtd_id, mtd_id, mtd_id_len - 1);
1667                 id->mtd_id[mtd_id_len - 1] = '\0';
1668                 INIT_LIST_HEAD(&id->link);
1669
1670                 debug("+ id %s%d\t%16lld bytes\t%s\n",
1671                                 MTD_DEV_TYPE(id->type), id->num,
1672                                 id->size, id->mtd_id);
1673
1674                 list_add_tail(&id->link, &mtdids);
1675                 ret = 0;
1676         }
1677         if (ret == 1) {
1678                 /* clean mtdids list and free allocated memory */
1679                 list_for_each_safe(entry, n, &mtdids) {
1680                         id_tmp = list_entry(entry, struct mtdids, link);
1681                         list_del(entry);
1682                         free(id_tmp);
1683                 }
1684                 return 1;
1685         }
1686
1687         return 0;
1688 }
1689
1690 /**
1691  * Parse and initialize global mtdids mapping and create global
1692  * device/partition list.
1693  *
1694  * @return 0 on success, 1 otherwise
1695  */
1696 int mtdparts_init(void)
1697 {
1698         static int initialized = 0;
1699         const char *ids, *parts;
1700         const char *current_partition;
1701         int ids_changed;
1702         char tmp_ep[PARTITION_MAXLEN];
1703         char tmp_parts[MTDPARTS_MAXLEN];
1704
1705         debug("\n---mtdparts_init---\n");
1706         if (!initialized) {
1707                 INIT_LIST_HEAD(&mtdids);
1708                 INIT_LIST_HEAD(&devices);
1709                 memset(last_ids, 0, MTDIDS_MAXLEN);
1710                 memset(last_parts, 0, MTDPARTS_MAXLEN);
1711                 memset(last_partition, 0, PARTITION_MAXLEN);
1712                 initialized = 1;
1713         }
1714
1715         /* get variables */
1716         ids = getenv("mtdids");
1717         /*
1718          * The mtdparts variable tends to be long. If we need to access it
1719          * before the env is relocated, then we need to use our own stack
1720          * buffer.  gd->env_buf will be too small.
1721          */
1722         if (gd->flags & GD_FLG_ENV_READY) {
1723                 parts = getenv("mtdparts");
1724         } else {
1725                 parts = tmp_parts;
1726                 getenv_f("mtdparts", tmp_parts, MTDPARTS_MAXLEN);
1727         }
1728         current_partition = getenv("partition");
1729
1730         /* save it for later parsing, cannot rely on current partition pointer
1731          * as 'partition' variable may be updated during init */
1732         tmp_ep[0] = '\0';
1733         if (current_partition)
1734                 strncpy(tmp_ep, current_partition, PARTITION_MAXLEN);
1735
1736         debug("last_ids  : %s\n", last_ids);
1737         debug("env_ids   : %s\n", ids);
1738         debug("last_parts: %s\n", last_parts);
1739         debug("env_parts : %s\n\n", parts);
1740
1741         debug("last_partition : %s\n", last_partition);
1742         debug("env_partition  : %s\n", current_partition);
1743
1744         /* if mtdids varible is empty try to use defaults */
1745         if (!ids) {
1746                 if (mtdids_default) {
1747                         debug("mtdids variable not defined, using default\n");
1748                         ids = mtdids_default;
1749                         setenv("mtdids", (char *)ids);
1750                 } else {
1751                         printf("mtdids not defined, no default present\n");
1752                         return 1;
1753                 }
1754         }
1755         if (strlen(ids) > MTDIDS_MAXLEN - 1) {
1756                 printf("mtdids too long (> %d)\n", MTDIDS_MAXLEN);
1757                 return 1;
1758         }
1759
1760         /* do no try to use defaults when mtdparts variable is not defined,
1761          * just check the length */
1762         if (!parts)
1763                 printf("mtdparts variable not set, see 'help mtdparts'\n");
1764
1765         if (parts && (strlen(parts) > MTDPARTS_MAXLEN - 1)) {
1766                 printf("mtdparts too long (> %d)\n", MTDPARTS_MAXLEN);
1767                 return 1;
1768         }
1769
1770         /* check if we have already parsed those mtdids */
1771         if ((last_ids[0] != '\0') && (strcmp(last_ids, ids) == 0)) {
1772                 ids_changed = 0;
1773         } else {
1774                 ids_changed = 1;
1775
1776                 if (parse_mtdids(ids) != 0) {
1777                         mtd_devices_init();
1778                         return 1;
1779                 }
1780
1781                 /* ok it's good, save new ids */
1782                 strncpy(last_ids, ids, MTDIDS_MAXLEN);
1783         }
1784
1785         /* parse partitions if either mtdparts or mtdids were updated */
1786         if (parts && ((last_parts[0] == '\0') || ((strcmp(last_parts, parts) != 0)) || ids_changed)) {
1787                 if (parse_mtdparts(parts) != 0)
1788                         return 1;
1789
1790                 if (list_empty(&devices)) {
1791                         printf("mtdparts_init: no valid partitions\n");
1792                         return 1;
1793                 }
1794
1795                 /* ok it's good, save new parts */
1796                 strncpy(last_parts, parts, MTDPARTS_MAXLEN);
1797
1798                 /* reset first partition from first dev from the list as current */
1799                 current_mtd_dev = list_entry(devices.next, struct mtd_device, link);
1800                 current_mtd_partnum = 0;
1801                 current_save();
1802
1803                 debug("mtdparts_init: current_mtd_dev  = %s%d, current_mtd_partnum = %d\n",
1804                                 MTD_DEV_TYPE(current_mtd_dev->id->type),
1805                                 current_mtd_dev->id->num, current_mtd_partnum);
1806         }
1807
1808         /* mtdparts variable was reset to NULL, delete all devices/partitions */
1809         if (!parts && (last_parts[0] != '\0'))
1810                 return mtd_devices_init();
1811
1812         /* do not process current partition if mtdparts variable is null */
1813         if (!parts)
1814                 return 0;
1815
1816         /* is current partition set in environment? if so, use it */
1817         if ((tmp_ep[0] != '\0') && (strcmp(tmp_ep, last_partition) != 0)) {
1818                 struct part_info *p;
1819                 struct mtd_device *cdev;
1820                 u8 pnum;
1821
1822                 debug("--- getting current partition: %s\n", tmp_ep);
1823
1824                 if (find_dev_and_part(tmp_ep, &cdev, &pnum, &p) == 0) {
1825                         current_mtd_dev = cdev;
1826                         current_mtd_partnum = pnum;
1827                         current_save();
1828                 }
1829         } else if (getenv("partition") == NULL) {
1830                 debug("no partition variable set, setting...\n");
1831                 current_save();
1832         }
1833
1834         return 0;
1835 }
1836
1837 /**
1838  * Return pointer to the partition of a requested number from a requested
1839  * device.
1840  *
1841  * @param dev device that is to be searched for a partition
1842  * @param part_num requested partition number
1843  * @return pointer to the part_info, NULL otherwise
1844  */
1845 static struct part_info* mtd_part_info(struct mtd_device *dev, unsigned int part_num)
1846 {
1847         struct list_head *entry;
1848         struct part_info *part;
1849         int num;
1850
1851         if (!dev)
1852                 return NULL;
1853
1854         debug("\n--- mtd_part_info: partition number %d for device %s%d (%s)\n",
1855                         part_num, MTD_DEV_TYPE(dev->id->type),
1856                         dev->id->num, dev->id->mtd_id);
1857
1858         if (part_num >= dev->num_parts) {
1859                 printf("invalid partition number %d for device %s%d (%s)\n",
1860                                 part_num, MTD_DEV_TYPE(dev->id->type),
1861                                 dev->id->num, dev->id->mtd_id);
1862                 return NULL;
1863         }
1864
1865         /* locate partition number, return it */
1866         num = 0;
1867         list_for_each(entry, &dev->parts) {
1868                 part = list_entry(entry, struct part_info, link);
1869
1870                 if (part_num == num++) {
1871                         return part;
1872                 }
1873         }
1874
1875         return NULL;
1876 }
1877
1878 /***************************************************/
1879 /* U-boot commands                                 */
1880 /***************************************************/
1881 /* command line only */
1882 /**
1883  * Routine implementing u-boot chpart command. Sets new current partition based
1884  * on the user supplied partition id. For partition id format see find_dev_and_part().
1885  *
1886  * @param cmdtp command internal data
1887  * @param flag command flag
1888  * @param argc number of arguments supplied to the command
1889  * @param argv arguments list
1890  * @return 0 on success, 1 otherwise
1891  */
1892 static int do_chpart(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1893 {
1894 /* command line only */
1895         struct mtd_device *dev;
1896         struct part_info *part;
1897         u8 pnum;
1898
1899         if (mtdparts_init() !=0)
1900                 return CMD_RET_FAILURE;
1901
1902         if (argc < 2) {
1903                 printf("no partition id specified\n");
1904                 return CMD_RET_FAILURE;
1905         }
1906
1907         if (find_dev_and_part(argv[1], &dev, &pnum, &part) != 0)
1908                 return CMD_RET_FAILURE;
1909
1910         current_mtd_dev = dev;
1911         current_mtd_partnum = pnum;
1912         current_save();
1913
1914         printf("partition changed to %s%d,%d\n",
1915                         MTD_DEV_TYPE(dev->id->type), dev->id->num, pnum);
1916
1917         return CMD_RET_SUCCESS;
1918 }
1919
1920 /**
1921  * Routine implementing u-boot mtdparts command. Initialize/update default global
1922  * partition list and process user partition request (list, add, del).
1923  *
1924  * @param cmdtp command internal data
1925  * @param flag command flag
1926  * @param argc number of arguments supplied to the command
1927  * @param argv arguments list
1928  * @return 0 on success, 1 otherwise
1929  */
1930 static int do_mtdparts(cmd_tbl_t *cmdtp, int flag, int argc,
1931                        char * const argv[])
1932 {
1933         if (argc == 2) {
1934                 if (strcmp(argv[1], "default") == 0) {
1935                         setenv("mtdids", (char *)mtdids_default);
1936                         setenv("mtdparts", (char *)mtdparts_default);
1937                         setenv("partition", NULL);
1938
1939                         mtdparts_init();
1940                         return 0;
1941                 } else if (strcmp(argv[1], "delall") == 0) {
1942                         /* this may be the first run, initialize lists if needed */
1943                         mtdparts_init();
1944
1945                         setenv("mtdparts", NULL);
1946
1947                         /* mtd_devices_init() calls current_save() */
1948                         return mtd_devices_init() ? CMD_RET_FAILURE :
1949                                 CMD_RET_SUCCESS;
1950                 }
1951         }
1952
1953         /* make sure we are in sync with env variables */
1954         if (mtdparts_init() != 0)
1955                 return CMD_RET_FAILURE;
1956
1957         if (argc == 1) {
1958                 list_partitions();
1959                 return CMD_RET_SUCCESS;
1960         }
1961
1962         /* mtdparts add <mtd-dev> <size>[@<offset>] <name> [ro] */
1963         if (((argc == 5) || (argc == 6)) && (strncmp(argv[1], "add", 3) == 0)) {
1964 #define PART_ADD_DESC_MAXLEN 64
1965                 char tmpbuf[PART_ADD_DESC_MAXLEN];
1966 #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
1967                 struct mtd_info *mtd;
1968                 uint64_t next_offset;
1969 #endif
1970                 u8 type, num, len;
1971                 struct mtd_device *dev;
1972                 struct mtd_device *dev_tmp;
1973                 struct mtdids *id;
1974                 struct part_info *p;
1975
1976                 if (mtd_id_parse(argv[2], NULL, &type, &num) != 0)
1977                         return CMD_RET_FAILURE;
1978
1979                 if ((id = id_find(type, num)) == NULL) {
1980                         printf("no such device %s defined in mtdids variable\n", argv[2]);
1981                         return CMD_RET_FAILURE;
1982                 }
1983
1984                 len = strlen(id->mtd_id) + 1;   /* 'mtd_id:' */
1985                 len += strlen(argv[3]);         /* size@offset */
1986                 len += strlen(argv[4]) + 2;     /* '(' name ')' */
1987                 if (argv[5] && (strlen(argv[5]) == 2))
1988                         len += 2;               /* 'ro' */
1989
1990                 if (len >= PART_ADD_DESC_MAXLEN) {
1991                         printf("too long partition description\n");
1992                         return CMD_RET_FAILURE;
1993                 }
1994                 sprintf(tmpbuf, "%s:%s(%s)%s",
1995                                 id->mtd_id, argv[3], argv[4], argv[5] ? argv[5] : "");
1996                 debug("add tmpbuf: %s\n", tmpbuf);
1997
1998                 if ((device_parse(tmpbuf, NULL, &dev) != 0) || (!dev))
1999                         return CMD_RET_FAILURE;
2000
2001                 debug("+ %s\t%d\t%s\n", MTD_DEV_TYPE(dev->id->type),
2002                                 dev->id->num, dev->id->mtd_id);
2003
2004                 p = list_entry(dev->parts.next, struct part_info, link);
2005
2006 #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
2007                 if (get_mtd_info(dev->id->type, dev->id->num, &mtd))
2008                         return CMD_RET_FAILURE;
2009
2010                 if (!strcmp(&argv[1][3], ".spread")) {
2011                         spread_partition(mtd, p, &next_offset);
2012                         debug("increased %s to %d bytes\n", p->name, p->size);
2013                 }
2014 #endif
2015
2016                 dev_tmp = device_find(dev->id->type, dev->id->num);
2017                 if (dev_tmp == NULL) {
2018                         device_add(dev);
2019                 } else if (part_add(dev_tmp, p) != 0) {
2020                         /* merge new partition with existing ones*/
2021                         device_del(dev);
2022                         return CMD_RET_FAILURE;
2023                 }
2024
2025                 if (generate_mtdparts_save(last_parts, MTDPARTS_MAXLEN) != 0) {
2026                         printf("generated mtdparts too long, resetting to null\n");
2027                         return CMD_RET_FAILURE;
2028                 }
2029
2030                 return CMD_RET_SUCCESS;
2031         }
2032
2033         /* mtdparts del part-id */
2034         if ((argc == 3) && (strcmp(argv[1], "del") == 0)) {
2035                 debug("del: part-id = %s\n", argv[2]);
2036
2037                 return delete_partition(argv[2]);
2038         }
2039
2040 #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
2041         if ((argc == 2) && (strcmp(argv[1], "spread") == 0))
2042                 return spread_partitions();
2043 #endif /* CONFIG_CMD_MTDPARTS_SPREAD */
2044
2045         return CMD_RET_USAGE;
2046 }
2047
2048 /***************************************************/
2049 U_BOOT_CMD(
2050         chpart, 2,      0,      do_chpart,
2051         "change active partition",
2052         "part-id\n"
2053         "    - change active partition (e.g. part-id = nand0,1)"
2054 );
2055
2056 #ifdef CONFIG_SYS_LONGHELP
2057 static char mtdparts_help_text[] =
2058         "\n"
2059         "    - list partition table\n"
2060         "mtdparts delall\n"
2061         "    - delete all partitions\n"
2062         "mtdparts del part-id\n"
2063         "    - delete partition (e.g. part-id = nand0,1)\n"
2064         "mtdparts add <mtd-dev> <size>[@<offset>] [<name>] [ro]\n"
2065         "    - add partition\n"
2066 #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
2067         "mtdparts add.spread <mtd-dev> <size>[@<offset>] [<name>] [ro]\n"
2068         "    - add partition, padding size by skipping bad blocks\n"
2069 #endif
2070         "mtdparts default\n"
2071         "    - reset partition table to defaults\n"
2072 #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
2073         "mtdparts spread\n"
2074         "    - adjust the sizes of the partitions so they are\n"
2075         "      at least as big as the mtdparts variable specifies\n"
2076         "      and they each start on a good block\n\n"
2077 #else
2078         "\n"
2079 #endif /* CONFIG_CMD_MTDPARTS_SPREAD */
2080         "-----\n\n"
2081         "this command uses three environment variables:\n\n"
2082         "'partition' - keeps current partition identifier\n\n"
2083         "partition  := <part-id>\n"
2084         "<part-id>  := <dev-id>,part_num\n\n"
2085         "'mtdids' - linux kernel mtd device id <-> u-boot device id mapping\n\n"
2086         "mtdids=<idmap>[,<idmap>,...]\n\n"
2087         "<idmap>    := <dev-id>=<mtd-id>\n"
2088         "<dev-id>   := 'nand'|'nor'|'onenand'<dev-num>\n"
2089         "<dev-num>  := mtd device number, 0...\n"
2090         "<mtd-id>   := unique device tag used by linux kernel to find mtd device (mtd->name)\n\n"
2091         "'mtdparts' - partition list\n\n"
2092         "mtdparts=mtdparts=<mtd-def>[;<mtd-def>...]\n\n"
2093         "<mtd-def>  := <mtd-id>:<part-def>[,<part-def>...]\n"
2094         "<mtd-id>   := unique device tag used by linux kernel to find mtd device (mtd->name)\n"
2095         "<part-def> := <size>[@<offset>][<name>][<ro-flag>]\n"
2096         "<size>     := standard linux memsize OR '-' to denote all remaining space\n"
2097         "<offset>   := partition start offset within the device\n"
2098         "<name>     := '(' NAME ')'\n"
2099         "<ro-flag>  := when set to 'ro' makes partition read-only (not used, passed to kernel)";
2100 #endif
2101
2102 U_BOOT_CMD(
2103         mtdparts,       6,      0,      do_mtdparts,
2104         "define flash/nand partitions", mtdparts_help_text
2105 );
2106 /***************************************************/