/*

   * (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);

  struct blk_desc *sata_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 struct blk_desc *sata_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) || \
  	defined(CONFIG_DUAL_BOOTLOADER)

  #  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);

  
  /**

   * write_backup_gpt_partitions - write MBR, backup gpt table.
   * @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_backup_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 */