[people/ms/u-boot.git] / include / part.h

/*
 * (C) Copyright 2000-2004
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */
#ifndef _PART_H
#define _PART_H

#include <blk.h>
#include <ide.h>
#include <uuid.h>
#include <linux/list.h>

struct block_drvr {
	char *name;
	int (*select_hwpart)(int dev_num, int hwpart);
};

#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
		 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
		 ((x & 0xffff0000) ? 16 : 0))
#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))

/* Part types */
#define PART_TYPE_UNKNOWN	0x00
#define PART_TYPE_MAC		0x01
#define PART_TYPE_DOS		0x02
#define PART_TYPE_ISO		0x03
#define PART_TYPE_AMIGA		0x04
#define PART_TYPE_EFI		0x05

/* maximum number of partition entries supported by search */
#define DOS_ENTRY_NUMBERS	8
#define ISO_ENTRY_NUMBERS	64
#define MAC_ENTRY_NUMBERS	64
#define AMIGA_ENTRY_NUMBERS	8
/*
 * Type string for U-Boot bootable partitions
 */
#define BOOT_PART_TYPE	"U-Boot"	/* primary boot partition type	*/
#define BOOT_PART_COMP	"PPCBoot"	/* PPCBoot compatibility type	*/

/* device types */
#define DEV_TYPE_UNKNOWN	0xff	/* not connected */
#define DEV_TYPE_HARDDISK	0x00	/* harddisk */
#define DEV_TYPE_TAPE		0x01	/* Tape */
#define DEV_TYPE_CDROM		0x05	/* CD-ROM */
#define DEV_TYPE_OPDISK		0x07	/* optical disk */

#define PART_NAME_LEN 32
#define PART_TYPE_LEN 32
#define MAX_SEARCH_PARTITIONS 64

typedef struct disk_partition {
	lbaint_t	start;	/* # of first block in partition	*/
	lbaint_t	size;	/* number of blocks in partition	*/
	ulong	blksz;		/* block size in bytes			*/
	uchar	name[PART_NAME_LEN];	/* partition name			*/
	uchar	type[PART_TYPE_LEN];	/* string type description		*/
	int	bootable;	/* Active/Bootable flag is set		*/
#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
	char	uuid[UUID_STR_LEN + 1];	/* filesystem UUID as string, if exists	*/
#endif
#ifdef CONFIG_PARTITION_TYPE_GUID
	char	type_guid[UUID_STR_LEN + 1];	/* type GUID as string, if exists	*/
#endif
#ifdef CONFIG_DOS_PARTITION
	uchar	sys_ind;	/* partition type 			*/
#endif
} disk_partition_t;

struct disk_part {
	int partnum;
	disk_partition_t gpt_part_info;
	struct list_head list;
};

/* Misc _get_dev functions */
#ifdef CONFIG_PARTITIONS
/**
 * blk_get_dev() - get a pointer to a block device given its type and number
 *
 * Each interface allocates its own devices and typically struct blk_desc is
 * contained with the interface's data structure. There is no global
 * numbering for block devices, so the interface name must be provided.
 *
 * @ifname:	Interface name (e.g. "ide", "scsi")
 * @dev:	Device number (0 for first device on that interface, 1 for
 *		second, etc.
 * @return pointer to the block device, or NULL if not available, or an
 *	   error occurred.
 */
struct blk_desc *blk_get_dev(const char *ifname, int dev);

struct blk_desc *mg_disk_get_dev(int dev);
int host_get_dev_err(int dev, struct blk_desc **blk_devp);

/* disk/part.c */
int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
/**
 * part_get_info_whole_disk() - get partition info for the special case of
 * a partition occupying the entire disk.
 */
int part_get_info_whole_disk(struct blk_desc *dev_desc, disk_partition_t *info);

void part_print(struct blk_desc *dev_desc);
void part_init(struct blk_desc *dev_desc);
void dev_print(struct blk_desc *dev_desc);

/**
 * blk_get_device_by_str() - Get a block device given its interface/hw partition
 *
 * Each interface allocates its own devices and typically struct blk_desc is
 * contained with the interface's data structure. There is no global
 * numbering for block devices, so the interface name must be provided.
 *
 * The hardware parition is not related to the normal software partitioning
 * of a device - each hardware partition is effectively a separately
 * accessible block device. When a hardware parition is selected on MMC the
 * other hardware partitions become inaccessible. The same block device is
 * used to access all hardware partitions, but its capacity may change when a
 * different hardware partition is selected.
 *
 * When a hardware partition number is given, the block device switches to
 * that hardware partition.
 *
 * @ifname:	Interface name (e.g. "ide", "scsi")
 * @dev_str:	Device and optional hw partition. This can either be a string
 *		containing the device number (e.g. "2") or the device number
 *		and hardware partition number (e.g. "2.4") for devices that
 *		support it (currently only MMC).
 * @dev_desc:	Returns a pointer to the block device on success
 * @return block device number (local to the interface), or -1 on error
 */
int blk_get_device_by_str(const char *ifname, const char *dev_str,
			  struct blk_desc **dev_desc);

/**
 * blk_get_device_part_str() - Get a block device and partition
 *
 * This calls blk_get_device_by_str() to look up a device. It also looks up
 * a partition and returns information about it.
 *
 * @dev_part_str is in the format:
 *	<dev>.<hw_part>:<part> where <dev> is the device number,
 *	<hw_part> is the optional hardware partition number and
 *	<part> is the partition number
 *
 * If ifname is "hostfs" then this function returns the sandbox host block
 * device.
 *
 * If ifname is ubi, then this function returns 0, with @info set to a
 * special UBI device.
 *
 * If @dev_part_str is NULL or empty or "-", then this function looks up
 * the "bootdevice" environment variable and uses that string instead.
 *
 * If the partition string is empty then the first partition is used. If the
 * partition string is "auto" then the first bootable partition is used.
 *
 * @ifname:	Interface name (e.g. "ide", "scsi")
 * @dev_part_str:	Device and partition string
 * @dev_desc:	Returns a pointer to the block device on success
 * @info:	Returns partition information
 * @allow_whole_dev:	true to allow the user to select partition 0
 *		(which means the whole device), false to require a valid
 *		partition number >= 1
 * @return partition number, or -1 on error
 *
 */
int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
			    struct blk_desc **dev_desc,
			    disk_partition_t *info, int allow_whole_dev);

/**
 * part_get_info_by_name_type() - Search for a partition by name
 *                                for only specified partition type
 *
 * @param dev_desc - block device descriptor
 * @param gpt_name - the specified table entry name
 * @param info - returns the disk partition info
 * @param part_type - only search in partitions of this type
 *
 * @return - the partition number on match (starting on 1), -1 on no match,
 * otherwise error
 */
int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
			       disk_partition_t *info, int part_type);

/**
 * part_get_info_by_name() - Search for a partition by name
 *                           among all available registered partitions
 *
 * @param dev_desc - block device descriptor
 * @param gpt_name - the specified table entry name
 * @param info - returns the disk partition info
 *
 * @return - the partition number on match (starting on 1), -1 on no match,
 * otherwise error
 */
int part_get_info_by_name(struct blk_desc *dev_desc,
			      const char *name, disk_partition_t *info);

/**
 * part_set_generic_name() - create generic partition like hda1 or sdb2
 *
 * Helper function for partition tables, which don't hold partition names
 * (DOS, ISO). Generates partition name out of the device type and partition
 * number.
 *
 * @dev_desc:	pointer to the block device
 * @part_num:	partition number for which the name is generated
 * @name:	buffer where the name is written
 */
void part_set_generic_name(const struct blk_desc *dev_desc,
	int part_num, char *name);

extern const struct block_drvr block_drvr[];
#else
static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
{ return NULL; }
static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }

static inline int part_get_info(struct blk_desc *dev_desc, int part,
				disk_partition_t *info) { return -1; }
static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
					   disk_partition_t *info)
{ return -1; }
static inline void part_print(struct blk_desc *dev_desc) {}
static inline void part_init(struct blk_desc *dev_desc) {}
static inline void dev_print(struct blk_desc *dev_desc) {}
static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
					struct blk_desc **dev_desc)
{ return -1; }
static inline int blk_get_device_part_str(const char *ifname,
					   const char *dev_part_str,
					   struct blk_desc **dev_desc,
					   disk_partition_t *info,
					   int allow_whole_dev)
{ *dev_desc = NULL; return -1; }
#endif

/*
 * We don't support printing partition information in SPL and only support
 * getting partition information in a few cases.
 */
#ifdef CONFIG_SPL_BUILD
# define part_print_ptr(x)	NULL
# if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
	defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
#  define part_get_info_ptr(x)	x
# else
#  define part_get_info_ptr(x)	NULL
# endif
#else
#define part_print_ptr(x)	x
#define part_get_info_ptr(x)	x
#endif


struct part_driver {
	const char *name;
	int part_type;
	const int max_entries;	/* maximum number of entries to search */

	/**
	 * get_info() - Get information about a partition
	 *
	 * @dev_desc:	Block device descriptor
	 * @part:	Partition number (1 = first)
	 * @info:	Returns partition information
	 */
	int (*get_info)(struct blk_desc *dev_desc, int part,
			disk_partition_t *info);

	/**
	 * print() - Print partition information
	 *
	 * @dev_desc:	Block device descriptor
	 */
	void (*print)(struct blk_desc *dev_desc);

	/**
	 * test() - Test if a device contains this partition type
	 *
	 * @dev_desc:	Block device descriptor
	 * @return 0 if the block device appears to contain this partition
	 *	   type, -ve if not
	 */
	int (*test)(struct blk_desc *dev_desc);
};

/* Declare a new U-Boot partition 'driver' */
#define U_BOOT_PART_TYPE(__name)					\
	ll_entry_declare(struct part_driver, __name, part_driver)

#include <part_efi.h>

#if CONFIG_IS_ENABLED(EFI_PARTITION)
/* disk/part_efi.c */
/**
 * write_gpt_table() - Write the GUID Partition Table to disk
 *
 * @param dev_desc - block device descriptor
 * @param gpt_h - pointer to GPT header representation
 * @param gpt_e - pointer to GPT partition table entries
 *
 * @return - zero on success, otherwise error
 */
int write_gpt_table(struct blk_desc *dev_desc,
		  gpt_header *gpt_h, gpt_entry *gpt_e);

/**
 * gpt_fill_pte(): Fill the GPT partition table entry
 *
 * @param dev_desc - block device descriptor
 * @param gpt_h - GPT header representation
 * @param gpt_e - GPT partition table entries
 * @param partitions - list of partitions
 * @param parts - number of partitions
 *
 * @return zero on success
 */
int gpt_fill_pte(struct blk_desc *dev_desc,
		 gpt_header *gpt_h, gpt_entry *gpt_e,
		 disk_partition_t *partitions, int parts);

/**
 * gpt_fill_header(): Fill the GPT header
 *
 * @param dev_desc - block device descriptor
 * @param gpt_h - GPT header representation
 * @param str_guid - disk guid string representation
 * @param parts_count - number of partitions
 *
 * @return - error on str_guid conversion error
 */
int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
		char *str_guid, int parts_count);

/**
 * gpt_restore(): Restore GPT partition table
 *
 * @param dev_desc - block device descriptor
 * @param str_disk_guid - disk GUID
 * @param partitions - list of partitions
 * @param parts - number of partitions
 *
 * @return zero on success
 */
int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
		disk_partition_t *partitions, const int parts_count);

/**
 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 *
 * @param dev_desc - block device descriptor
 * @param buf - buffer which contains the MBR and Primary GPT info
 *
 * @return - '0' on success, otherwise error
 */
int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);

/**
 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 *
 * @param dev_desc - block device descriptor
 * @param buf - buffer which contains the MBR and Primary GPT info
 *
 * @return - '0' on success, otherwise error
 */
int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);

/**
 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 *                        and partition table entries (PTE)
 *
 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 *
 * @param dev_desc - block device descriptor
 * @param gpt_head - pointer to GPT header data read from medium
 * @param gpt_pte - pointer to GPT partition table enties read from medium
 *
 * @return - '0' on success, otherwise error
 */
int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
		       gpt_entry **gpt_pte);

/**
 * gpt_verify_partitions() - Function to check if partitions' name, start and
 *                           size correspond to '$partitions' env variable
 *
 * This function checks if on medium stored GPT data is in sync with information
 * provided in '$partitions' environment variable. Specificially, name, start
 * and size of the partition is checked.
 *
 * @param dev_desc - block device descriptor
 * @param partitions - partition data read from '$partitions' env variable
 * @param parts - number of partitions read from '$partitions' env variable
 * @param gpt_head - pointer to GPT header data read from medium
 * @param gpt_pte - pointer to GPT partition table enties read from medium
 *
 * @return - '0' on success, otherwise error
 */
int gpt_verify_partitions(struct blk_desc *dev_desc,
			  disk_partition_t *partitions, int parts,
			  gpt_header *gpt_head, gpt_entry **gpt_pte);


/**
 * get_disk_guid() - Function to read the GUID string from a device's GPT
 *
 * This function reads the GUID string from a block device whose descriptor
 * is provided.
 *
 * @param dev_desc - block device descriptor
 * @param guid - pre-allocated string in which to return the GUID
 *
 * @return - '0' on success, otherwise error
 */
int get_disk_guid(struct blk_desc *dev_desc, char *guid);

#endif

#if CONFIG_IS_ENABLED(DOS_PARTITION)
/**
 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
 *
 * @param buf - buffer which contains the MBR
 *
 * @return - '0' on success, otherwise error
 */
int is_valid_dos_buf(void *buf);

/**
 * write_mbr_partition() - write DOS MBR
 *
 * @param dev_desc - block device descriptor
 * @param buf - buffer which contains the MBR
 *
 * @return - '0' on success, otherwise error
 */
int write_mbr_partition(struct blk_desc *dev_desc, void *buf);

#endif


#endif /* _PART_H */
Commit	Line	Data
012771d8	1	/*
42dfe7a1	2	* (C) Copyright 2000-2004
012771d8 WD	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
012771d8 WD	4	*
3765b3e7	5	* SPDX-License-Identifier: GPL-2.0+
012771d8 WD	6	*/
	7	#ifndef _PART_H
	8	#define _PART_H
735dd97b	9
1a73661b	10	#include <blk.h>
6e592385	11	#include <ide.h>
db9b6200	12	#include <uuid.h>
09a49930	13	#include <linux/list.h>
012771d8	14
d96a9804 AG	15	struct block_drvr {
d96a9804 AG	16	char *name;
d96a9804 AG	17	int (*select_hwpart)(int dev_num, int hwpart);
	18	};
	19
0472fbfd EE	20	#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
	21	((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
	22	((x & 0xffff0000) ? 16 : 0))
	23	#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
ae1768a7	24
012771d8	25	/* Part types */
42dfe7a1	26	#define PART_TYPE_UNKNOWN 0x00
012771d8 WD	27	#define PART_TYPE_MAC 0x01
	28	#define PART_TYPE_DOS 0x02
	29	#define PART_TYPE_ISO 0x03
42dfe7a1	30	#define PART_TYPE_AMIGA 0x04
07f3d789	31	#define PART_TYPE_EFI 0x05
c7de829c	32
87b8530f PK	33	/* maximum number of partition entries supported by search */
	34	#define DOS_ENTRY_NUMBERS 8
	35	#define ISO_ENTRY_NUMBERS 64
	36	#define MAC_ENTRY_NUMBERS 64
	37	#define AMIGA_ENTRY_NUMBERS 8
b0fce99b WD	38	/*
	39	* Type string for U-Boot bootable partitions
	40	*/
	41	#define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
	42	#define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
	43
012771d8	44	/* device types */
b0fce99b WD	45	#define DEV_TYPE_UNKNOWN 0xff /* not connected */
b0fce99b WD	46	#define DEV_TYPE_HARDDISK 0x00 /* harddisk */
42dfe7a1 WD	47	#define DEV_TYPE_TAPE 0x01 /* Tape */
	48	#define DEV_TYPE_CDROM 0x05 /* CD-ROM */
	49	#define DEV_TYPE_OPDISK 0x07 /* optical disk */
012771d8	50
92856b48 AC	51	#define PART_NAME_LEN 32
92856b48 AC	52	#define PART_TYPE_LEN 32
e6faf21f	53	#define MAX_SEARCH_PARTITIONS 64
92856b48	54
42dfe7a1	55	typedef struct disk_partition {
04735e9c FL	56	lbaint_t start; /* # of first block in partition */
04735e9c FL	57	lbaint_t size; /* number of blocks in partition */
012771d8	58	ulong blksz; /* block size in bytes */
92856b48 AC	59	uchar name[PART_NAME_LEN]; /* partition name */
92856b48 AC	60	uchar type[PART_TYPE_LEN]; /* string type description */
40e0e568	61	int bootable; /* Active/Bootable flag is set */
b331cd62	62	#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
db9b6200	63	char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
894bfbbf	64	#endif
7561b258	65	#ifdef CONFIG_PARTITION_TYPE_GUID
db9b6200	66	char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */
7561b258	67	#endif
f0fb4fa7 DW	68	#ifdef CONFIG_DOS_PARTITION
	69	uchar sys_ind; /* partition type */
	70	#endif
012771d8 WD	71	} disk_partition_t;
012771d8 WD	72
09a49930 AC	73	struct disk_part {
	74	int partnum;
	75	disk_partition_t gpt_part_info;
	76	struct list_head list;
	77	};
	78
735dd97b	79	/* Misc _get_dev functions */
df3fc526	80	#ifdef CONFIG_PARTITIONS
fb1b7be9	81	/**
db1d9e78	82	* blk_get_dev() - get a pointer to a block device given its type and number
fb1b7be9 SG	83	*
	84	* Each interface allocates its own devices and typically struct blk_desc is
	85	* contained with the interface's data structure. There is no global
	86	* numbering for block devices, so the interface name must be provided.
	87	*
	88	* @ifname: Interface name (e.g. "ide", "scsi")
	89	* @dev: Device number (0 for first device on that interface, 1 for
	90	* second, etc.
	91	* @return pointer to the block device, or NULL if not available, or an
	92	* error occurred.
	93	*/
db1d9e78	94	struct blk_desc blk_get_dev(const char ifname, int dev);
fb1b7be9	95
4101f687	96	struct blk_desc *mg_disk_get_dev(int dev);
4101f687	97	int host_get_dev_err(int dev, struct blk_desc **blk_devp);
735dd97b	98
012771d8	99	/* disk/part.c */
3e8bd469	100	int part_get_info(struct blk_desc dev_desc, int part, disk_partition_t info);
4bbcc965 RC	101	/**
	102	* part_get_info_whole_disk() - get partition info for the special case of
	103	* a partition occupying the entire disk.
	104	*/
	105	int part_get_info_whole_disk(struct blk_desc dev_desc, disk_partition_t info);
	106
3e8bd469 SG	107	void part_print(struct blk_desc *dev_desc);
3e8bd469 SG	108	void part_init(struct blk_desc *dev_desc);
4101f687	109	void dev_print(struct blk_desc *dev_desc);
ebac37cf SG	110
	111	/**
	112	* blk_get_device_by_str() - Get a block device given its interface/hw partition
	113	*
	114	* Each interface allocates its own devices and typically struct blk_desc is
	115	* contained with the interface's data structure. There is no global
	116	* numbering for block devices, so the interface name must be provided.
	117	*
	118	* The hardware parition is not related to the normal software partitioning
	119	* of a device - each hardware partition is effectively a separately
	120	* accessible block device. When a hardware parition is selected on MMC the
	121	* other hardware partitions become inaccessible. The same block device is
	122	* used to access all hardware partitions, but its capacity may change when a
	123	* different hardware partition is selected.
	124	*
	125	* When a hardware partition number is given, the block device switches to
	126	* that hardware partition.
	127	*
	128	* @ifname: Interface name (e.g. "ide", "scsi")
	129	* @dev_str: Device and optional hw partition. This can either be a string
	130	* containing the device number (e.g. "2") or the device number
	131	* and hardware partition number (e.g. "2.4") for devices that
	132	* support it (currently only MMC).
	133	* @dev_desc: Returns a pointer to the block device on success
	134	* @return block device number (local to the interface), or -1 on error
	135	*/
	136	int blk_get_device_by_str(const char ifname, const char dev_str,
	137	struct blk_desc **dev_desc);
e35929e4 SG	138
	139	/**
	140	* blk_get_device_part_str() - Get a block device and partition
	141	*
	142	* This calls blk_get_device_by_str() to look up a device. It also looks up
	143	* a partition and returns information about it.
	144	*
	145	* @dev_part_str is in the format:
	146	* <dev>.<hw_part>:<part> where <dev> is the device number,
	147	* <hw_part> is the optional hardware partition number and
	148	* <part> is the partition number
	149	*
	150	* If ifname is "hostfs" then this function returns the sandbox host block
	151	* device.
	152	*
	153	* If ifname is ubi, then this function returns 0, with @info set to a
	154	* special UBI device.
	155	*
	156	* If @dev_part_str is NULL or empty or "-", then this function looks up
	157	* the "bootdevice" environment variable and uses that string instead.
	158	*
	159	* If the partition string is empty then the first partition is used. If the
	160	* partition string is "auto" then the first bootable partition is used.
	161	*
	162	* @ifname: Interface name (e.g. "ide", "scsi")
	163	* @dev_part_str: Device and partition string
	164	* @dev_desc: Returns a pointer to the block device on success
	165	* @info: Returns partition information
	166	* @allow_whole_dev: true to allow the user to select partition 0
	167	* (which means the whole device), false to require a valid
	168	* partition number >= 1
	169	* @return partition number, or -1 on error
	170	*
	171	*/
	172	int blk_get_device_part_str(const char ifname, const char dev_part_str,
	173	struct blk_desc **dev_desc,
	174	disk_partition_t *info, int allow_whole_dev);
87b8530f	175
30789095 SP	176	/**
	177	* part_get_info_by_name_type() - Search for a partition by name
	178	* for only specified partition type
	179	*
	180	* @param dev_desc - block device descriptor
	181	* @param gpt_name - the specified table entry name
	182	* @param info - returns the disk partition info
	183	* @param part_type - only search in partitions of this type
	184	*
	185	* @return - the partition number on match (starting on 1), -1 on no match,
	186	* otherwise error
	187	*/
	188	int part_get_info_by_name_type(struct blk_desc dev_desc, const char name,
	189	disk_partition_t *info, int part_type);
	190
87b8530f PK	191	/**
	192	* part_get_info_by_name() - Search for a partition by name
	193	* among all available registered partitions
	194	*
	195	* @param dev_desc - block device descriptor
	196	* @param gpt_name - the specified table entry name
	197	* @param info - returns the disk partition info
	198	*
88b6329c AD	199	* @return - the partition number on match (starting on 1), -1 on no match,
88b6329c AD	200	* otherwise error
87b8530f PK	201	*/
	202	int part_get_info_by_name(struct blk_desc *dev_desc,
	203	const char name, disk_partition_t info);
	204
da2ee24d PK	205	/**
	206	* part_set_generic_name() - create generic partition like hda1 or sdb2
	207	*
	208	* Helper function for partition tables, which don't hold partition names
	209	* (DOS, ISO). Generates partition name out of the device type and partition
	210	* number.
	211	*
	212	* @dev_desc: pointer to the block device
	213	* @part_num: partition number for which the name is generated
	214	* @name: buffer where the name is written
	215	*/
	216	void part_set_generic_name(const struct blk_desc *dev_desc,
	217	int part_num, char *name);
	218
d96a9804	219	extern const struct block_drvr block_drvr[];
df3fc526	220	#else
db1d9e78	221	static inline struct blk_desc blk_get_dev(const char ifname, int dev)
99d2c205	222	{ return NULL; }
4101f687	223	static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
012771d8	224
3e8bd469 SG	225	static inline int part_get_info(struct blk_desc *dev_desc, int part,
3e8bd469 SG	226	disk_partition_t *info) { return -1; }
4bbcc965 RC	227	static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
	228	disk_partition_t *info)
	229	{ return -1; }
3e8bd469 SG	230	static inline void part_print(struct blk_desc *dev_desc) {}
3e8bd469 SG	231	static inline void part_init(struct blk_desc *dev_desc) {}
4101f687	232	static inline void dev_print(struct blk_desc *dev_desc) {}
ebac37cf SG	233	static inline int blk_get_device_by_str(const char ifname, const char dev_str,
ebac37cf SG	234	struct blk_desc **dev_desc)
2023e608	235	{ return -1; }
e35929e4	236	static inline int blk_get_device_part_str(const char *ifname,
10a37fd7	237	const char *dev_part_str,
4101f687	238	struct blk_desc **dev_desc,
10a37fd7 SW	239	disk_partition_t *info,
10a37fd7 SW	240	int allow_whole_dev)
99d2c205	241	{ *dev_desc = NULL; return -1; }
df3fc526	242	#endif
012771d8	243
96e5b03c SG	244	/*
	245	* We don't support printing partition information in SPL and only support
	246	* getting partition information in a few cases.
	247	*/
	248	#ifdef CONFIG_SPL_BUILD
	249	# define part_print_ptr(x) NULL
d9b2678e	250	# if defined(CONFIG_SPL_EXT_SUPPORT) \|\| defined(CONFIG_SPL_FAT_SUPPORT) \|\| \
96e5b03c SG	251	defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
	252	# define part_get_info_ptr(x) x
	253	# else
	254	# define part_get_info_ptr(x) NULL
	255	# endif
	256	#else
	257	#define part_print_ptr(x) x
	258	#define part_get_info_ptr(x) x
012771d8 WD	259	#endif
012771d8 WD	260
012771d8	261
96e5b03c SG	262	struct part_driver {
	263	const char *name;
	264	int part_type;
87b8530f	265	const int max_entries; /* maximum number of entries to search */
012771d8	266
96e5b03c SG	267	/**
	268	* get_info() - Get information about a partition
	269	*
	270	* @dev_desc: Block device descriptor
	271	* @part: Partition number (1 = first)
	272	* @info: Returns partition information
	273	*/
	274	int (get_info)(struct blk_desc dev_desc, int part,
	275	disk_partition_t *info);
	276
	277	/**
	278	* print() - Print partition information
	279	*
	280	* @dev_desc: Block device descriptor
	281	*/
	282	void (print)(struct blk_desc dev_desc);
	283
	284	/**
	285	* test() - Test if a device contains this partition type
	286	*
	287	* @dev_desc: Block device descriptor
	288	* @return 0 if the block device appears to contain this partition
	289	* type, -ve if not
	290	*/
	291	int (test)(struct blk_desc dev_desc);
	292	};
	293
	294	/* Declare a new U-Boot partition 'driver' */
	295	#define U_BOOT_PART_TYPE(__name) \
	296	ll_entry_declare(struct part_driver, __name, part_driver)
c7de829c	297
40684ddb	298	#include <part_efi.h>
0d6ab32e RC	299
0d6ab32e RC	300	#if CONFIG_IS_ENABLED(EFI_PARTITION)
07f3d789	301	/* disk/part_efi.c */
40684ddb ŁM	302	/**
	303	* write_gpt_table() - Write the GUID Partition Table to disk
	304	*
	305	* @param dev_desc - block device descriptor
	306	* @param gpt_h - pointer to GPT header representation
	307	* @param gpt_e - pointer to GPT partition table entries
	308	*
	309	* @return - zero on success, otherwise error
	310	*/
4101f687	311	int write_gpt_table(struct blk_desc *dev_desc,
40684ddb ŁM	312	gpt_header gpt_h, gpt_entry gpt_e);
	313
	314	/**
	315	* gpt_fill_pte(): Fill the GPT partition table entry
	316	*
47d7ee47	317	* @param dev_desc - block device descriptor
40684ddb ŁM	318	* @param gpt_h - GPT header representation
	319	* @param gpt_e - GPT partition table entries
	320	* @param partitions - list of partitions
	321	* @param parts - number of partitions
	322	*
	323	* @return zero on success
	324	*/
47d7ee47 MR	325	int gpt_fill_pte(struct blk_desc *dev_desc,
	326	gpt_header gpt_h, gpt_entry gpt_e,
	327	disk_partition_t *partitions, int parts);
40684ddb ŁM	328
	329	/**
	330	* gpt_fill_header(): Fill the GPT header
	331	*
	332	* @param dev_desc - block device descriptor
	333	* @param gpt_h - GPT header representation
	334	* @param str_guid - disk guid string representation
	335	* @param parts_count - number of partitions
	336	*
	337	* @return - error on str_guid conversion error
	338	*/
4101f687	339	int gpt_fill_header(struct blk_desc dev_desc, gpt_header gpt_h,
40684ddb ŁM	340	char *str_guid, int parts_count);
	341
	342	/**
	343	* gpt_restore(): Restore GPT partition table
	344	*
	345	* @param dev_desc - block device descriptor
	346	* @param str_disk_guid - disk GUID
	347	* @param partitions - list of partitions
	348	* @param parts - number of partitions
	349	*
	350	* @return zero on success
	351	*/
4101f687	352	int gpt_restore(struct blk_desc dev_desc, char str_disk_guid,
40684ddb	353	disk_partition_t *partitions, const int parts_count);
0ff7e585 SR	354
	355	/**
	356	* is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
	357	*
	358	* @param dev_desc - block device descriptor
	359	* @param buf - buffer which contains the MBR and Primary GPT info
	360	*
	361	* @return - '0' on success, otherwise error
	362	*/
4101f687	363	int is_valid_gpt_buf(struct blk_desc dev_desc, void buf);
0ff7e585 SR	364
	365	/**
	366	* write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
	367	*
	368	* @param dev_desc - block device descriptor
	369	* @param buf - buffer which contains the MBR and Primary GPT info
	370	*
	371	* @return - '0' on success, otherwise error
	372	*/
4101f687	373	int write_mbr_and_gpt_partitions(struct blk_desc dev_desc, void buf);
cef68bf9 LM	374
	375	/**
	376	* gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
	377	* and partition table entries (PTE)
	378	*
	379	* As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
	380	*
	381	* @param dev_desc - block device descriptor
	382	* @param gpt_head - pointer to GPT header data read from medium
	383	* @param gpt_pte - pointer to GPT partition table enties read from medium
	384	*
	385	* @return - '0' on success, otherwise error
	386	*/
4101f687	387	int gpt_verify_headers(struct blk_desc dev_desc, gpt_header gpt_head,
cef68bf9 LM	388	gpt_entry **gpt_pte);
	389
	390	/**
	391	* gpt_verify_partitions() - Function to check if partitions' name, start and
	392	* size correspond to '$partitions' env variable
	393	*
	394	* This function checks if on medium stored GPT data is in sync with information
	395	* provided in '$partitions' environment variable. Specificially, name, start
	396	* and size of the partition is checked.
	397	*
	398	* @param dev_desc - block device descriptor
	399	* @param partitions - partition data read from '$partitions' env variable
	400	* @param parts - number of partitions read from '$partitions' env variable
	401	* @param gpt_head - pointer to GPT header data read from medium
	402	* @param gpt_pte - pointer to GPT partition table enties read from medium
	403	*
	404	* @return - '0' on success, otherwise error
	405	*/
4101f687	406	int gpt_verify_partitions(struct blk_desc *dev_desc,
cef68bf9 LM	407	disk_partition_t *partitions, int parts,
cef68bf9 LM	408	gpt_header gpt_head, gpt_entry *gpt_pte);
73d6d18b AC	409
	410
	411	/**
	412	* get_disk_guid() - Function to read the GUID string from a device's GPT
	413	*
	414	* This function reads the GUID string from a block device whose descriptor
	415	* is provided.
	416	*
	417	* @param dev_desc - block device descriptor
	418	* @param guid - pre-allocated string in which to return the GUID
	419	*
	420	* @return - '0' on success, otherwise error
	421	*/
	422	int get_disk_guid(struct blk_desc dev_desc, char guid);
	423
07f3d789	424	#endif
07f3d789	425
b0cf7339	426	#if CONFIG_IS_ENABLED(DOS_PARTITION)
b6dd69a4 PK	427	/**
	428	* is_valid_dos_buf() - Ensure that a DOS MBR image is valid
	429	*
	430	* @param buf - buffer which contains the MBR
	431	*
	432	* @return - '0' on success, otherwise error
	433	*/
	434	int is_valid_dos_buf(void *buf);
	435
	436	/**
	437	* write_mbr_partition() - write DOS MBR
	438	*
	439	* @param dev_desc - block device descriptor
	440	* @param buf - buffer which contains the MBR
	441	*
	442	* @return - '0' on success, otherwise error
	443	*/
	444	int write_mbr_partition(struct blk_desc dev_desc, void buf);
	445
	446	#endif
	447
	448
012771d8	449	#endif /* _PART_H */