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