Commit ad274cec authored by Artem Bityutskiy's avatar Artem Bityutskiy Committed by Artem Bityutskiy
Browse files

mtd: document parse_mtd_partitions 



Add a kerneldoc comment for the 'parse_mtd_partitions()' function - its
behavior has changed recently so it is good idea to have it documented.

Signed-off-by: default avatarArtem Bityutskiy <Artem.Bityutskiy@nokia.com>
parent 543e32d5

drivers/mtd/mtdpart.c

+22 −0
Original line number Diff line number Diff line
@@ -725,8 +725,30 @@ int deregister_mtd_parser(struct mtd_part_parser *p) 
}

EXPORT_SYMBOL_GPL(deregister_mtd_parser);



/*

 * Do not forget to update 'parse_mtd_partitions()' kerneldoc comment if you

 * are changing this array!

 */

static const char *default_mtd_part_types[] = {"cmdlinepart", NULL};



/**

 * parse_mtd_partitions - parse MTD partitions

 * @master: the master partition (describes whole MTD device)

 * @types: names of partition parsers to try or %NULL

 * @pparts: array of partitions found is returned here

 * @origin: MTD device start address (use %0 if unsure)

 *

 * This function tries to find partition on MTD device @master. It uses MTD

 * partition parsers, specified in @types. However, if @types is %NULL, then

 * the default list of parsers is used. The default list contains only the

 * "cmdlinepart" parser ATM.

 *

 * This function may return:

 * o a negative error code in case of failure

 * o zero if no partitions were found

 * o a positive number of found partitions, in which case on exit @pparts will

 *   point to an array containing this number of &struct mtd_info objects.

 */

int parse_mtd_partitions(struct mtd_info *master, const char **types,

			 struct mtd_partition **pparts, unsigned long origin)

{