drivers/mtd/cmdlinepart.c

   1 /*
   2  * Read flash partition table from command line
   3  *
   4  * Copyright © 2002      SYSGO Real-Time Solutions GmbH
   5  * Copyright © 2002-2010 David Woodhouse <dwmw2@infradead.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  *
  21  * The format for the command line is as follows:
  22  *
  23  * mtdparts=<mtddef>[;<mtddef]
  24  * <mtddef>  := <mtd-id>:<partdef>[,<partdef>]
  25  * <partdef> := <size>[@<offset>][<name>][ro][lk]
  26  * <mtd-id>  := unique name used in mapping driver/device (mtd->name)
  27  * <size>    := standard linux memsize OR "-" to denote all remaining space
  28  *              size is automatically truncated at end of device
  29  *              if specified or trucated size is 0 the part is skipped
  30  * <offset>  := standard linux memsize
  31  *              if omitted the part will immediately follow the previous part
  32  *              or 0 if the first part
  33  * <name>    := '(' NAME ')'
  34  *              NAME will appear in /proc/mtd
  35  *
  36  * <size> and <offset> can be specified such that the parts are out of order
  37  * in physical memory and may even overlap.
  38  *
  39  * The parts are assigned MTD numbers in the order they are specified in the
  40  * command line regardless of their order in physical memory.
  41  *
  42  * Examples:
  43  *
  44  * 1 NOR Flash, with 1 single writable partition:
  45  * edb7312-nor:-
  46  *
  47  * 1 NOR Flash with 2 partitions, 1 NAND with one
  48  * edb7312-nor:256k(ARMboot)ro,-(root);edb7312-nand:-(home)
  49  */
  50
  51 #include <linux/kernel.h>
  52 #include <linux/slab.h>
  53 #include <linux/mtd/mtd.h>
  54 #include <linux/mtd/partitions.h>
  55 #include <linux/module.h>
  56 #include <linux/err.h>
  57
  58 /* error message prefix */
  59 #define ERRP "mtd: "
  60
  61 /* debug macro */
  62 #if 0
  63 #define dbg(x) do { printk("DEBUG-CMDLINE-PART: "); printk x; } while(0)
  64 #else
  65 #define dbg(x)
  66 #endif
  67
  68
  69 /* special size referring to all the remaining space in a partition */
  70 #define SIZE_REMAINING ULLONG_MAX
  71 #define OFFSET_CONTINUOUS ULLONG_MAX
  72
  73 struct cmdline_mtd_partition {
  74         struct cmdline_mtd_partition *next;
  75         char *mtd_id;
  76         int num_parts;
  77         struct mtd_partition *parts;
  78 };
  79
  80 /* mtdpart_setup() parses into here */
  81 static struct cmdline_mtd_partition *partitions;
  82
  83 /* the command line passed to mtdpart_setup() */
  84 static char *cmdline;
  85 static int cmdline_parsed;
  86
  87 /*
  88  * Parse one partition definition for an MTD. Since there can be many
  89  * comma separated partition definitions, this function calls itself
  90  * recursively until no more partition definitions are found. Nice side
  91  * effect: the memory to keep the mtd_partition structs and the names
  92  * is allocated upon the last definition being found. At that point the
  93  * syntax has been verified ok.
  94  */
  95 static struct mtd_partition * newpart(char *s,
  96                                       char **retptr,
  97                                       int *num_parts,
  98                                       int this_part,
  99                                       unsigned char **extra_mem_ptr,
 100                                       int extra_mem_size)
 101 {
 102         struct mtd_partition *parts;
 103         unsigned long long size, offset = OFFSET_CONTINUOUS;
 104         char *name;
 105         int name_len;
 106         unsigned char *extra_mem;
 107         char delim;
 108         unsigned int mask_flags;
 109
 110         /* fetch the partition size */
 111         if (*s == '-') {
 112                 /* assign all remaining space to this partition */
 113                 size = SIZE_REMAINING;
 114                 s++;
 115         } else {
 116                 size = memparse(s, &s);
 117                 if (size < PAGE_SIZE) {
 118                         printk(KERN_ERR ERRP "partition size too small (%llx)\n",
 119                                size);
 120                         return ERR_PTR(-EINVAL);
 121                 }
 122         }
 123
 124         /* fetch partition name and flags */
 125         mask_flags = 0; /* this is going to be a regular partition */
 126         delim = 0;
 127
 128         /* check for offset */
 129         if (*s == '@') {
 130                 s++;
 131                 offset = memparse(s, &s);
 132         }
 133
 134         /* now look for name */
 135         if (*s == '(')
 136                 delim = ')';
 137
 138         if (delim) {
 139                 char *p;
 140
 141                 name = ++s;
 142                 p = strchr(name, delim);
 143                 if (!p) {
 144                         printk(KERN_ERR ERRP "no closing %c found in partition name\n", delim);
 145                         return ERR_PTR(-EINVAL);
 146                 }
 147                 name_len = p - name;
 148                 s = p + 1;
 149         } else {
 150                 name = NULL;
 151                 name_len = 13; /* Partition_000 */
 152         }
 153
 154         /* record name length for memory allocation later */
 155         extra_mem_size += name_len + 1;
 156
 157         /* test for options */
 158         if (strncmp(s, "ro", 2) == 0) {
 159                 mask_flags |= MTD_WRITEABLE;
 160                 s += 2;
 161         }
 162
 163         /* if lk is found do NOT unlock the MTD partition*/
 164         if (strncmp(s, "lk", 2) == 0) {
 165                 mask_flags |= MTD_POWERUP_LOCK;
 166                 s += 2;
 167         }
 168
 169         /* test if more partitions are following */
 170         if (*s == ',') {
 171                 if (size == SIZE_REMAINING) {
 172                         printk(KERN_ERR ERRP "no partitions allowed after a fill-up partition\n");
 173                         return ERR_PTR(-EINVAL);
 174                 }
 175                 /* more partitions follow, parse them */
 176                 parts = newpart(s + 1, &s, num_parts, this_part + 1,
 177                                 &extra_mem, extra_mem_size);
 178                 if (IS_ERR(parts))
 179                         return parts;
 180         } else {
 181                 /* this is the last partition: allocate space for all */
 182                 int alloc_size;
 183
 184                 *num_parts = this_part + 1;
 185                 alloc_size = *num_parts * sizeof(struct mtd_partition) +
 186                              extra_mem_size;
 187
 188                 parts = kzalloc(alloc_size, GFP_KERNEL);
 189                 if (!parts)
 190                         return ERR_PTR(-ENOMEM);
 191                 extra_mem = (unsigned char *)(parts + *num_parts);
 192         }
 193
 194         /* enter this partition (offset will be calculated later if it is zero at this point) */
 195         parts[this_part].size = size;
 196         parts[this_part].offset = offset;
 197         parts[this_part].mask_flags = mask_flags;
 198         if (name)
 199                 strlcpy(extra_mem, name, name_len + 1);
 200         else
 201                 sprintf(extra_mem, "Partition_%03d", this_part);
 202         parts[this_part].name = extra_mem;
 203         extra_mem += name_len + 1;
 204
 205         dbg(("partition %d: name <%s>, offset %llx, size %llx, mask flags %x\n",
 206              this_part, parts[this_part].name, parts[this_part].offset,
 207              parts[this_part].size, parts[this_part].mask_flags));
 208
 209         /* return (updated) pointer to extra_mem memory */
 210         if (extra_mem_ptr)
 211                 *extra_mem_ptr = extra_mem;
 212
 213         /* return (updated) pointer command line string */
 214         *retptr = s;
 215
 216         /* return partition table */
 217         return parts;
 218 }
 219
 220 /*
 221  * Parse the command line.
 222  */
 223 static int mtdpart_setup_real(char *s)
 224 {
 225         cmdline_parsed = 1;
 226
 227         for( ; s != NULL; )
 228         {
 229                 struct cmdline_mtd_partition *this_mtd;
 230                 struct mtd_partition *parts;
 231                 int mtd_id_len, num_parts;
 232                 char *p, *mtd_id;
 233
 234                 mtd_id = s;
 235
 236                 /* fetch <mtd-id> */
 237                 p = strchr(s, ':');
 238                 if (!p) {
 239                         printk(KERN_ERR ERRP "no mtd-id\n");
 240                         return -EINVAL;
 241                 }
 242                 mtd_id_len = p - mtd_id;
 243
 244                 dbg(("parsing <%s>\n", p+1));
 245
 246                 /*
 247                  * parse one mtd. have it reserve memory for the
 248                  * struct cmdline_mtd_partition and the mtd-id string.
 249                  */
 250                 parts = newpart(p + 1,          /* cmdline */
 251                                 &s,             /* out: updated cmdline ptr */
 252                                 &num_parts,     /* out: number of parts */
 253                                 0,              /* first partition */
 254                                 (unsigned char**)&this_mtd, /* out: extra mem */
 255                                 mtd_id_len + 1 + sizeof(*this_mtd) +
 256                                 sizeof(void*)-1 /*alignment*/);
 257                 if (IS_ERR(parts)) {
 258                         /*
 259                          * An error occurred. We're either:
 260                          * a) out of memory, or
 261                          * b) in the middle of the partition spec
 262                          * Either way, this mtd is hosed and we're
 263                          * unlikely to succeed in parsing any more
 264                          */
 265                          return PTR_ERR(parts);
 266                  }
 267
 268                 /* align this_mtd */
 269                 this_mtd = (struct cmdline_mtd_partition *)
 270                                 ALIGN((unsigned long)this_mtd, sizeof(void *));
 271                 /* enter results */
 272                 this_mtd->parts = parts;
 273                 this_mtd->num_parts = num_parts;
 274                 this_mtd->mtd_id = (char*)(this_mtd + 1);
 275                 strlcpy(this_mtd->mtd_id, mtd_id, mtd_id_len + 1);
 276
 277                 /* link into chain */
 278                 this_mtd->next = partitions;
 279                 partitions = this_mtd;
 280
 281                 dbg(("mtdid=<%s> num_parts=<%d>\n",
 282                      this_mtd->mtd_id, this_mtd->num_parts));
 283
 284
 285                 /* EOS - we're done */
 286                 if (*s == 0)
 287                         break;
 288
 289                 /* does another spec follow? */
 290                 if (*s != ';') {
 291                         printk(KERN_ERR ERRP "bad character after partition (%c)\n", *s);
 292                         return -EINVAL;
 293                 }
 294                 s++;
 295         }
 296
 297         return 0;
 298 }
 299
 300 /*
 301  * Main function to be called from the MTD mapping driver/device to
 302  * obtain the partitioning information. At this point the command line
 303  * arguments will actually be parsed and turned to struct mtd_partition
 304  * information. It returns partitions for the requested mtd device, or
 305  * the first one in the chain if a NULL mtd_id is passed in.
 306  */
 307 static int parse_cmdline_partitions(struct mtd_info *master,
 308                                     struct mtd_partition **pparts,
 309                                     struct mtd_part_parser_data *data)
 310 {
 311         unsigned long long offset;
 312         int i, err;
 313         struct cmdline_mtd_partition *part;
 314         const char *mtd_id = master->name;
 315
 316         /* parse command line */
 317         if (!cmdline_parsed) {
 318                 err = mtdpart_setup_real(cmdline);
 319                 if (err)
 320                         return err;
 321         }
 322
 323         /*
 324          * Search for the partition definition matching master->name.
 325          * If master->name is not set, stop at first partition definition.
 326          */
 327         for (part = partitions; part; part = part->next) {
 328                 if ((!mtd_id) || (!strcmp(part->mtd_id, mtd_id)))
 329                         break;
 330         }
 331
 332         if (!part)
 333                 return 0;
 334
 335         for (i = 0, offset = 0; i < part->num_parts; i++) {
 336                 if (part->parts[i].offset == OFFSET_CONTINUOUS)
 337                         part->parts[i].offset = offset;
 338                 else
 339                         offset = part->parts[i].offset;
 340
 341                 if (part->parts[i].size == SIZE_REMAINING)
 342                         part->parts[i].size = master->size - offset;
 343
 344                 if (offset + part->parts[i].size > master->size) {
 345                         printk(KERN_WARNING ERRP
 346                                "%s: partitioning exceeds flash size, truncating\n",
 347                                part->mtd_id);
 348                         part->parts[i].size = master->size - offset;
 349                 }
 350                 offset += part->parts[i].size;
 351
 352                 if (part->parts[i].size == 0) {
 353                         printk(KERN_WARNING ERRP
 354                                "%s: skipping zero sized partition\n",
 355                                part->mtd_id);
 356                         part->num_parts--;
 357                         memmove(&part->parts[i], &part->parts[i + 1],
 358                                 sizeof(*part->parts) * (part->num_parts - i));
 359                         i--;
 360                 }
 361         }
 362
 363         *pparts = kmemdup(part->parts, sizeof(*part->parts) * part->num_parts,
 364                           GFP_KERNEL);
 365         if (!*pparts)
 366                 return -ENOMEM;
 367
 368         return part->num_parts;
 369 }
 370
 371
 372 /*
 373  * This is the handler for our kernel parameter, called from
 374  * main.c::checksetup(). Note that we can not yet kmalloc() anything,
 375  * so we only save the commandline for later processing.
 376  *
 377  * This function needs to be visible for bootloaders.
 378  */
 379 static int mtdpart_setup(char *s)
 380 {
 381         cmdline = s;
 382         return 1;
 383 }
 384
 385 __setup("mtdparts=", mtdpart_setup);
 386
 387 static struct mtd_part_parser cmdline_parser = {
 388         .owner = THIS_MODULE,
 389         .parse_fn = parse_cmdline_partitions,
 390         .name = "cmdlinepart",
 391 };
 392
 393 static int __init cmdline_parser_init(void)
 394 {
 395         return register_mtd_parser(&cmdline_parser);
 396 }
 397
 398 module_init(cmdline_parser_init);
 399
 400 MODULE_LICENSE("GPL");
 401 MODULE_AUTHOR("Marius Groeger <mag@sysgo.de>");
 402 MODULE_DESCRIPTION("Command line configuration of MTD partitions");