include/linux/mtd/partitions.h

   1 /*
   2  * MTD partitioning layer definitions
   3  *
   4  * (C) 2000 Nicolas Pitre <nico@fluxnic.net>
   5  *
   6  * This code is GPL
   7  */
   8
   9 #ifndef MTD_PARTITIONS_H
  10 #define MTD_PARTITIONS_H
  11
  12 #include <linux/types.h>
  13 #include <linux/memory.h>
  14
  15
  16 /*
  17  * Partition definition structure:
  18  *
  19  * An array of struct partition is passed along with a MTD object to
  20  * add_mtd_partitions() to create them.
  21  *
  22  * For each partition, these fields are available:
  23  * name: string that will be used to label the partition's MTD device.
  24  * size: the partition size; if defined as MTDPART_SIZ_FULL, the partition
  25  *      will extend to the end of the master MTD device.
  26  * offset: absolute starting position within the master MTD device; if
  27  *      defined as MTDPART_OFS_APPEND, the partition will start where the
  28  *      previous one ended; if MTDPART_OFS_NXTBLK, at the next erase block.
  29  * mask_flags: contains flags that have to be masked (removed) from the
  30  *      master MTD flag set for the corresponding MTD partition.
  31  *      For example, to force a read-only partition, simply adding
  32  *      MTD_WRITEABLE to the mask_flags will do the trick.
  33  *
  34  * Note: writeable partitions require their size and offset be
  35  * erasesize aligned (e.g. use MTDPART_OFS_NEXTBLK).
  36  */
  37
  38 struct mtd_partition {
  39         char *name;                     /* identifier string */
  40         uint64_t size;                  /* partition size */
  41         uint64_t offset;                /* offset within the master MTD space */
  42         uint32_t mask_flags;            /* master MTD flags to mask out for this partition */
  43         struct nand_ecclayout *ecclayout;       /* out of band layout for this partition (NAND only)*/
  44         void (*setup)(struct memory_accessor *, void *context);
  45         void *context;
  46 };
  47
  48 #define MTDPART_OFS_NXTBLK      (-2)
  49 #define MTDPART_OFS_APPEND      (-1)
  50 #define MTDPART_SIZ_FULL        (0)
  51
  52
  53 struct mtd_info;
  54
  55 int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
  56 int del_mtd_partitions(struct mtd_info *);
  57
  58 /*
  59  * Functions dealing with the various ways of partitioning the space
  60  */
  61
  62 struct mtd_part_parser {
  63         struct list_head list;
  64         struct module *owner;
  65         const char *name;
  66         int (*parse_fn)(struct mtd_info *, struct mtd_partition **, unsigned long);
  67 };
  68
  69 extern int register_mtd_parser(struct mtd_part_parser *parser);
  70 extern int deregister_mtd_parser(struct mtd_part_parser *parser);
  71 extern int parse_mtd_partitions(struct mtd_info *master, const char **types,
  72                                 struct mtd_partition **pparts, unsigned long origin);
  73
  74 #define put_partition_parser(p) do { module_put((p)->owner); } while(0)
  75
  76 struct device;
  77 struct device_node;
  78
  79 int __devinit of_mtd_parse_partitions(struct device *dev,
  80                                       struct device_node *node,
  81                                       struct mtd_partition **pparts);
  82
  83 #ifdef CONFIG_MTD_PARTITIONS
  84 static inline int mtd_has_partitions(void) { return 1; }
  85 #else
  86 static inline int mtd_has_partitions(void) { return 0; }
  87 #endif
  88
  89 #ifdef CONFIG_MTD_CMDLINE_PARTS
  90 static inline int mtd_has_cmdlinepart(void) { return 1; }
  91 #else
  92 static inline int mtd_has_cmdlinepart(void) { return 0; }
  93 #endif
  94
  95 #endif