global: Migrate CONFIG_STACKBASE to CFG
[platform/kernel/u-boot.git] / include / part.h
index 0caceaf..807370d 100644 (file)
@@ -1,8 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * (C) Copyright 2000-2004
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 #ifndef _PART_H
 #define _PART_H
@@ -10,6 +9,8 @@
 #include <blk.h>
 #include <ide.h>
 #include <uuid.h>
+#include <linker_lists.h>
+#include <linux/errno.h>
 #include <linux/list.h>
 
 struct block_drvr {
@@ -50,15 +51,24 @@ struct block_drvr {
 
 #define PART_NAME_LEN 32
 #define PART_TYPE_LEN 32
-#define MAX_SEARCH_PARTITIONS 64
+#define MAX_SEARCH_PARTITIONS 128
+
+#define PART_BOOTABLE                  ((int)BIT(0))
+#define PART_EFI_SYSTEM_PARTITION      ((int)BIT(1))
 
-typedef struct disk_partition {
+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          */
+       /*
+        * The bootable is a bitmask with the following fields:
+        *
+        * PART_BOOTABLE                the MBR bootable flag is set
+        * PART_EFI_SYSTEM_PARTITION    the partition is an EFI system partition
+        */
+       int     bootable;
 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
        char    uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
 #endif
@@ -66,18 +76,18 @@ typedef struct disk_partition {
        char    type_guid[UUID_STR_LEN + 1];    /* type GUID as string, if exists       */
 #endif
 #ifdef CONFIG_DOS_PARTITION
-       uchar   sys_ind;        /* partition type                       */
+       uchar   sys_ind;        /* partition type                       */
 #endif
-} disk_partition_t;
+};
 
 struct disk_part {
        int partnum;
-       disk_partition_t gpt_part_info;
+       struct disk_partition gpt_part_info;
        struct list_head list;
 };
 
 /* Misc _get_dev functions */
-#ifdef CONFIG_PARTITIONS
+#if CONFIG_IS_ENABLED(PARTITIONS)
 /**
  * blk_get_dev() - get a pointer to a block device given its type and number
  *
@@ -88,21 +98,22 @@ struct disk_part {
  * @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
+ * 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);
+int part_get_info(struct blk_desc *dev_desc, int part,
+                 struct disk_partition *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);
+int part_get_info_whole_disk(struct blk_desc *dev_desc,
+                            struct disk_partition *info);
 
 void part_print(struct blk_desc *dev_desc);
 void part_init(struct blk_desc *dev_desc);
@@ -131,7 +142,7 @@ void dev_print(struct blk_desc *dev_desc);
  *             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
+ * 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);
@@ -166,12 +177,12 @@ int blk_get_device_by_str(const char *ifname, const char *dev_str,
  * @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
+ * 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);
+                           struct disk_partition *info, int allow_whole_dev);
 
 /**
  * part_get_info_by_name_type() - Search for a partition by name
@@ -182,11 +193,11 @@ int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
  * @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,
+ * 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);
+                              struct disk_partition *info, int part_type);
 
 /**
  * part_get_info_by_name() - Search for a partition by name
@@ -196,11 +207,36 @@ int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
  * @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,
+ * 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);
+                             const char *name, struct disk_partition *info);
+
+/**
+ * Get partition info from dev number + part name, or dev number + part number.
+ *
+ * Parse a device number and partition description (either name or number)
+ * in the form of device number plus partition name separated by a "#"
+ * (like "device_num#partition_name") or a device number plus a partition number
+ * separated by a ":". For example both "0#misc" and "0:1" can be valid
+ * partition descriptions for a given interface. If the partition is found, sets
+ * dev_desc and part_info accordingly with the information of the partition.
+ *
+ * @param[in] dev_iface        Device interface
+ * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
+ * @param[out] dev_desc        Place to store the device description pointer
+ * @param[out] part_info Place to store the partition information
+ * @param[in] 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: the partition number on success, or negative errno on error
+ */
+int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
+                                        const char *dev_part_str,
+                                        struct blk_desc **dev_desc,
+                                        struct disk_partition *part_info,
+                                        int allow_whole_dev);
 
 /**
  * part_set_generic_name() - create generic partition like hda1 or sdb2
@@ -223,9 +259,9 @@ static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
 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; }
+                               struct disk_partition *info) { return -1; }
 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
-                                          disk_partition_t *info)
+                                          struct disk_partition *info)
 { return -1; }
 static inline void part_print(struct blk_desc *dev_desc) {}
 static inline void part_init(struct blk_desc *dev_desc) {}
@@ -234,20 +270,93 @@ 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)
+                                         const char *dev_part_str,
+                                         struct blk_desc **dev_desc,
+                                         struct disk_partition *info,
+                                         int allow_whole_dev)
 { *dev_desc = NULL; return -1; }
+
+static inline int part_get_info_by_name_type(struct blk_desc *dev_desc,
+                                            const char *name,
+                                            struct disk_partition *info,
+                                            int part_type)
+{
+       return -ENOENT;
+}
+
+static inline int part_get_info_by_name(struct blk_desc *dev_desc,
+                                       const char *name,
+                                       struct disk_partition *info)
+{
+       return -ENOENT;
+}
+
+static inline int
+part_get_info_by_dev_and_name_or_num(const char *dev_iface,
+                                    const char *dev_part_str,
+                                    struct blk_desc **dev_desc,
+                                    struct disk_partition *part_info,
+                                    int allow_whole_dev)
+{
+       *dev_desc = NULL;
+       return -ENOSYS;
+}
 #endif
 
+struct udevice;
+/**
+ * part_create_block_devices - Create block devices for disk partitions
+ *
+ * Create UCLASS_PARTITION udevices for each of disk partitions in @parent
+ *
+ * @blk_dev:   Whole disk device
+ */
+int part_create_block_devices(struct udevice *blk_dev);
+
+/**
+ * disk_blk_read() - read blocks from a disk partition
+ *
+ * @dev:       Device to read from (UCLASS_PARTITION)
+ * @start:     Start block number to read in the partition (0=first)
+ * @blkcnt:    Number of blocks to read
+ * @buffer:    Destination buffer for data read
+ * Returns: number of blocks read, or -ve error number (see the
+ * IS_ERR_VALUE() macro
+ */
+ulong disk_blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
+                   void *buffer);
+
+/**
+ * disk_blk_write() - write to a disk partition
+ *
+ * @dev:       Device to write to (UCLASS_PARTITION)
+ * @start:     Start block number to write in the partition (0=first)
+ * @blkcnt:    Number of blocks to write
+ * @buffer:    Source buffer for data to write
+ * Returns: number of blocks written, or -ve error number (see the
+ * IS_ERR_VALUE() macro
+ */
+ulong disk_blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
+                    const void *buffer);
+
+/**
+ * disk_blk_erase() - erase a section of a disk partition
+ *
+ * @dev:       Device to (partially) erase (UCLASS_PARTITION)
+ * @start:     Start block number to erase in the partition (0=first)
+ * @blkcnt:    Number of blocks to erase
+ * Returns: number of blocks erased, or -ve error number (see the
+ * IS_ERR_VALUE() macro
+ */
+ulong disk_blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt);
+
 /*
  * 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) || \
+# 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
@@ -272,7 +381,7 @@ struct part_driver {
         * @info:       Returns partition information
         */
        int (*get_info)(struct blk_desc *dev_desc, int part,
-                       disk_partition_t *info);
+                       struct disk_partition *info);
 
        /**
         * print() - Print partition information
@@ -306,7 +415,7 @@ struct part_driver {
  * @param gpt_h - pointer to GPT header representation
  * @param gpt_e - pointer to GPT partition table entries
  *
- * @return - zero on success, otherwise error
+ * Return: - zero on success, otherwise error
  */
 int write_gpt_table(struct blk_desc *dev_desc,
                  gpt_header *gpt_h, gpt_entry *gpt_e);
@@ -320,11 +429,11 @@ int write_gpt_table(struct blk_desc *dev_desc,
  * @param partitions - list of partitions
  * @param parts - number of partitions
  *
- * @return zero on success
+ * 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);
+                struct disk_partition *partitions, int parts);
 
 /**
  * gpt_fill_header(): Fill the GPT header
@@ -334,7 +443,7 @@ int gpt_fill_pte(struct blk_desc *dev_desc,
  * @param str_guid - disk guid string representation
  * @param parts_count - number of partitions
  *
- * @return - error on str_guid conversion error
+ * 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);
@@ -347,10 +456,10 @@ int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
  * @param partitions - list of partitions
  * @param parts - number of partitions
  *
- * @return zero on success
+ * Return: zero on success
  */
 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
-               disk_partition_t *partitions, const int parts_count);
+               struct disk_partition *partitions, const int parts_count);
 
 /**
  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
@@ -358,7 +467,7 @@ int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
  * @param dev_desc - block device descriptor
  * @param buf - buffer which contains the MBR and Primary GPT info
  *
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
  */
 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
 
@@ -368,7 +477,7 @@ int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
  * @param dev_desc - block device descriptor
  * @param buf - buffer which contains the MBR and Primary GPT info
  *
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
  */
 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
 
@@ -382,12 +491,22 @@ int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
  * @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
+ * Return: - '0' on success, otherwise error
  */
 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
                       gpt_entry **gpt_pte);
 
 /**
+ * gpt_repair_headers() - Function to repair the GPT's header
+ *                        and partition table entries (PTE)
+ *
+ * @param dev_desc - block device descriptor
+ *
+ * Return: - '0' on success, otherwise error
+ */
+int gpt_repair_headers(struct blk_desc *dev_desc);
+
+/**
  * gpt_verify_partitions() - Function to check if partitions' name, start and
  *                           size correspond to '$partitions' env variable
  *
@@ -401,10 +520,10 @@ int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
  * @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
+ * Return: - '0' on success, otherwise error
  */
 int gpt_verify_partitions(struct blk_desc *dev_desc,
-                         disk_partition_t *partitions, int parts,
+                         struct disk_partition *partitions, int parts,
                          gpt_header *gpt_head, gpt_entry **gpt_pte);
 
 
@@ -417,7 +536,7 @@ int gpt_verify_partitions(struct blk_desc *dev_desc,
  * @param dev_desc - block device descriptor
  * @param guid - pre-allocated string in which to return the GUID
  *
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
  */
 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
 
@@ -429,21 +548,54 @@ int get_disk_guid(struct blk_desc *dev_desc, char *guid);
  *
  * @param buf - buffer which contains the MBR
  *
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
  */
 int is_valid_dos_buf(void *buf);
 
 /**
- * write_mbr_partition() - write DOS MBR
+ * write_mbr_sector() - write DOS MBR
  *
  * @param dev_desc - block device descriptor
  * @param buf - buffer which contains the MBR
  *
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
  */
-int write_mbr_partition(struct blk_desc *dev_desc, void *buf);
+int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
+
+int write_mbr_partitions(struct blk_desc *dev,
+               struct disk_partition *p, int count, unsigned int disksig);
+int layout_mbr_partitions(struct disk_partition *p, int count,
+                         lbaint_t total_sectors);
 
 #endif
 
+#if CONFIG_IS_ENABLED(PARTITIONS)
+/**
+ * part_driver_get_count() - get partition driver count
+ *
+ * Return: - number of partition drivers
+ */
+static inline int part_driver_get_count(void)
+{
+       return ll_entry_count(struct part_driver, part_driver);
+}
+
+/**
+ * part_driver_get_first() - get first partition driver
+ *
+ * Return: - pointer to first partition driver on success, otherwise NULL
+ */
+static inline struct part_driver *part_driver_get_first(void)
+{
+       return ll_entry_start(struct part_driver, part_driver);
+}
+
+#else
+static inline int part_driver_get_count(void)
+{ return 0; }
+
+static inline struct part_driver *part_driver_get_first(void)
+{ return NULL; }
+#endif /* CONFIG_PARTITIONS */
 
 #endif /* _PART_H */