[thirdparty/u-boot.git] / include / part.h

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