include/part.h

   1 /*
   2  * (C) Copyright 2000-2004
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7 #ifndef _PART_H
   8 #define _PART_H
   9
  10 #include <blk.h>
  11 #include <ide.h>
  12
  13 struct block_drvr {
  14         char *name;
  15         int (*select_hwpart)(int dev_num, int hwpart);
  16 };
  17
  18 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
  19                  ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
  20                  ((x & 0xffff0000) ? 16 : 0))
  21 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
  22
  23 /* Part types */
  24 #define PART_TYPE_UNKNOWN       0x00
  25 #define PART_TYPE_MAC           0x01
  26 #define PART_TYPE_DOS           0x02
  27 #define PART_TYPE_ISO           0x03
  28 #define PART_TYPE_AMIGA         0x04
  29 #define PART_TYPE_EFI           0x05
  30
  31 /*
  32  * Type string for U-Boot bootable partitions
  33  */
  34 #define BOOT_PART_TYPE  "U-Boot"        /* primary boot partition type  */
  35 #define BOOT_PART_COMP  "PPCBoot"       /* PPCBoot compatibility type   */
  36
  37 /* device types */
  38 #define DEV_TYPE_UNKNOWN        0xff    /* not connected */
  39 #define DEV_TYPE_HARDDISK       0x00    /* harddisk */
  40 #define DEV_TYPE_TAPE           0x01    /* Tape */
  41 #define DEV_TYPE_CDROM          0x05    /* CD-ROM */
  42 #define DEV_TYPE_OPDISK         0x07    /* optical disk */
  43
  44 typedef struct disk_partition {
  45         lbaint_t        start;  /* # of first block in partition        */
  46         lbaint_t        size;   /* number of blocks in partition        */
  47         ulong   blksz;          /* block size in bytes                  */
  48         uchar   name[32];       /* partition name                       */
  49         uchar   type[32];       /* string type description              */
  50         int     bootable;       /* Active/Bootable flag is set          */
  51 #ifdef CONFIG_PARTITION_UUIDS
  52         char    uuid[37];       /* filesystem UUID as string, if exists */
  53 #endif
  54 #ifdef CONFIG_PARTITION_TYPE_GUID
  55         char    type_guid[37];  /* type GUID as string, if exists       */
  56 #endif
  57 } disk_partition_t;
  58
  59 /* Misc _get_dev functions */
  60 #ifdef CONFIG_PARTITIONS
  61 /**
  62  * blk_get_dev() - get a pointer to a block device given its type and number
  63  *
  64  * Each interface allocates its own devices and typically struct blk_desc is
  65  * contained with the interface's data structure. There is no global
  66  * numbering for block devices, so the interface name must be provided.
  67  *
  68  * @ifname:     Interface name (e.g. "ide", "scsi")
  69  * @dev:        Device number (0 for first device on that interface, 1 for
  70  *              second, etc.
  71  * @return pointer to the block device, or NULL if not available, or an
  72  *         error occurred.
  73  */
  74 struct blk_desc *blk_get_dev(const char *ifname, int dev);
  75
  76 /**
  77  * mmc_select_hwpart() - Select the MMC hardware partiion on an MMC device
  78  *
  79  * MMC devices can support partitioning at the hardware level. This is quite
  80  * separate from the normal idea of software-based partitions. MMC hardware
  81  * partitions must be explicitly selected. Once selected only the region of
  82  * the device covered by that partition is accessible.
  83  *
  84  * The MMC standard provides for two boot partitions (numbered 1 and 2),
  85  * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
  86  *
  87  * @dev_num:    Block device number (struct blk_desc->dev value)
  88  * @hwpart:     Hardware partition number to select. 0 means the raw device,
  89  *              1 is the first partition, 2 is the second, etc.
  90  * @return 0 if OK, other value for an error
  91  */
  92 int mmc_select_hwpart(int dev_num, int hwpart);
  93 struct blk_desc *mg_disk_get_dev(int dev);
  94 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
  95
  96 /* disk/part.c */
  97 int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
  98 void part_print(struct blk_desc *dev_desc);
  99 void part_init(struct blk_desc *dev_desc);
 100 void dev_print(struct blk_desc *dev_desc);
 101
 102 /**
 103  * blk_get_device_by_str() - Get a block device given its interface/hw partition
 104  *
 105  * Each interface allocates its own devices and typically struct blk_desc is
 106  * contained with the interface's data structure. There is no global
 107  * numbering for block devices, so the interface name must be provided.
 108  *
 109  * The hardware parition is not related to the normal software partitioning
 110  * of a device - each hardware partition is effectively a separately
 111  * accessible block device. When a hardware parition is selected on MMC the
 112  * other hardware partitions become inaccessible. The same block device is
 113  * used to access all hardware partitions, but its capacity may change when a
 114  * different hardware partition is selected.
 115  *
 116  * When a hardware partition number is given, the block device switches to
 117  * that hardware partition.
 118  *
 119  * @ifname:     Interface name (e.g. "ide", "scsi")
 120  * @dev_str:    Device and optional hw partition. This can either be a string
 121  *              containing the device number (e.g. "2") or the device number
 122  *              and hardware partition number (e.g. "2.4") for devices that
 123  *              support it (currently only MMC).
 124  * @dev_desc:   Returns a pointer to the block device on success
 125  * @return block device number (local to the interface), or -1 on error
 126  */
 127 int blk_get_device_by_str(const char *ifname, const char *dev_str,
 128                           struct blk_desc **dev_desc);
 129
 130 /**
 131  * blk_get_device_part_str() - Get a block device and partition
 132  *
 133  * This calls blk_get_device_by_str() to look up a device. It also looks up
 134  * a partition and returns information about it.
 135  *
 136  * @dev_part_str is in the format:
 137  *      <dev>.<hw_part>:<part> where <dev> is the device number,
 138  *      <hw_part> is the optional hardware partition number and
 139  *      <part> is the partition number
 140  *
 141  * If ifname is "hostfs" then this function returns the sandbox host block
 142  * device.
 143  *
 144  * If ifname is ubi, then this function returns 0, with @info set to a
 145  * special UBI device.
 146  *
 147  * If @dev_part_str is NULL or empty or "-", then this function looks up
 148  * the "bootdevice" environment variable and uses that string instead.
 149  *
 150  * If the partition string is empty then the first partition is used. If the
 151  * partition string is "auto" then the first bootable partition is used.
 152  *
 153  * @ifname:     Interface name (e.g. "ide", "scsi")
 154  * @dev_part_str:       Device and partition string
 155  * @dev_desc:   Returns a pointer to the block device on success
 156  * @info:       Returns partition information
 157  * @allow_whole_dev:    true to allow the user to select partition 0
 158  *              (which means the whole device), false to require a valid
 159  *              partition number >= 1
 160  * @return partition number, or -1 on error
 161  *
 162  */
 163 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
 164                             struct blk_desc **dev_desc,
 165                             disk_partition_t *info, int allow_whole_dev);
 166 extern const struct block_drvr block_drvr[];
 167 #else
 168 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
 169 { return NULL; }
 170 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
 171 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
 172
 173 static inline int part_get_info(struct blk_desc *dev_desc, int part,
 174                                 disk_partition_t *info) { return -1; }
 175 static inline void part_print(struct blk_desc *dev_desc) {}
 176 static inline void part_init(struct blk_desc *dev_desc) {}
 177 static inline void dev_print(struct blk_desc *dev_desc) {}
 178 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
 179                                         struct blk_desc **dev_desc)
 180 { return -1; }
 181 static inline int blk_get_device_part_str(const char *ifname,
 182                                            const char *dev_part_str,
 183                                            struct blk_desc **dev_desc,
 184                                            disk_partition_t *info,
 185                                            int allow_whole_dev)
 186 { *dev_desc = NULL; return -1; }
 187 #endif
 188
 189 /*
 190  * We don't support printing partition information in SPL and only support
 191  * getting partition information in a few cases.
 192  */
 193 #ifdef CONFIG_SPL_BUILD
 194 # define part_print_ptr(x)      NULL
 195 # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
 196         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
 197 #  define part_get_info_ptr(x)  x
 198 # else
 199 #  define part_get_info_ptr(x)  NULL
 200 # endif
 201 #else
 202 #define part_print_ptr(x)       x
 203 #define part_get_info_ptr(x)    x
 204 #endif
 205
 206
 207 struct part_driver {
 208         const char *name;
 209         int part_type;
 210
 211         /**
 212          * get_info() - Get information about a partition
 213          *
 214          * @dev_desc:   Block device descriptor
 215          * @part:       Partition number (1 = first)
 216          * @info:       Returns partition information
 217          */
 218         int (*get_info)(struct blk_desc *dev_desc, int part,
 219                         disk_partition_t *info);
 220
 221         /**
 222          * print() - Print partition information
 223          *
 224          * @dev_desc:   Block device descriptor
 225          */
 226         void (*print)(struct blk_desc *dev_desc);
 227
 228         /**
 229          * test() - Test if a device contains this partition type
 230          *
 231          * @dev_desc:   Block device descriptor
 232          * @return 0 if the block device appears to contain this partition
 233          *         type, -ve if not
 234          */
 235         int (*test)(struct blk_desc *dev_desc);
 236 };
 237
 238 /* Declare a new U-Boot partition 'driver' */
 239 #define U_BOOT_PART_TYPE(__name)                                        \
 240         ll_entry_declare(struct part_driver, __name, part_driver)
 241
 242 #ifdef CONFIG_EFI_PARTITION
 243 #include <part_efi.h>
 244 /* disk/part_efi.c */
 245 /**
 246  * part_get_info_efi_by_name() - Find the specified GPT partition table entry
 247  *
 248  * @param dev_desc - block device descriptor
 249  * @param gpt_name - the specified table entry name
 250  * @param info - returns the disk partition info
 251  *
 252  * @return - '0' on match, '-1' on no match, otherwise error
 253  */
 254 int part_get_info_efi_by_name(struct blk_desc *dev_desc,
 255                               const char *name, disk_partition_t *info);
 256
 257 /**
 258  * write_gpt_table() - Write the GUID Partition Table to disk
 259  *
 260  * @param dev_desc - block device descriptor
 261  * @param gpt_h - pointer to GPT header representation
 262  * @param gpt_e - pointer to GPT partition table entries
 263  *
 264  * @return - zero on success, otherwise error
 265  */
 266 int write_gpt_table(struct blk_desc *dev_desc,
 267                   gpt_header *gpt_h, gpt_entry *gpt_e);
 268
 269 /**
 270  * gpt_fill_pte(): Fill the GPT partition table entry
 271  *
 272  * @param gpt_h - GPT header representation
 273  * @param gpt_e - GPT partition table entries
 274  * @param partitions - list of partitions
 275  * @param parts - number of partitions
 276  *
 277  * @return zero on success
 278  */
 279 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
 280                 disk_partition_t *partitions, int parts);
 281
 282 /**
 283  * gpt_fill_header(): Fill the GPT header
 284  *
 285  * @param dev_desc - block device descriptor
 286  * @param gpt_h - GPT header representation
 287  * @param str_guid - disk guid string representation
 288  * @param parts_count - number of partitions
 289  *
 290  * @return - error on str_guid conversion error
 291  */
 292 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 293                 char *str_guid, int parts_count);
 294
 295 /**
 296  * gpt_restore(): Restore GPT partition table
 297  *
 298  * @param dev_desc - block device descriptor
 299  * @param str_disk_guid - disk GUID
 300  * @param partitions - list of partitions
 301  * @param parts - number of partitions
 302  *
 303  * @return zero on success
 304  */
 305 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 306                 disk_partition_t *partitions, const int parts_count);
 307
 308 /**
 309  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 310  *
 311  * @param dev_desc - block device descriptor
 312  * @param buf - buffer which contains the MBR and Primary GPT info
 313  *
 314  * @return - '0' on success, otherwise error
 315  */
 316 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
 317
 318 /**
 319  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 320  *
 321  * @param dev_desc - block device descriptor
 322  * @param buf - buffer which contains the MBR and Primary GPT info
 323  *
 324  * @return - '0' on success, otherwise error
 325  */
 326 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
 327
 328 /**
 329  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 330  *                        and partition table entries (PTE)
 331  *
 332  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 333  *
 334  * @param dev_desc - block device descriptor
 335  * @param gpt_head - pointer to GPT header data read from medium
 336  * @param gpt_pte - pointer to GPT partition table enties read from medium
 337  *
 338  * @return - '0' on success, otherwise error
 339  */
 340 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 341                        gpt_entry **gpt_pte);
 342
 343 /**
 344  * gpt_verify_partitions() - Function to check if partitions' name, start and
 345  *                           size correspond to '$partitions' env variable
 346  *
 347  * This function checks if on medium stored GPT data is in sync with information
 348  * provided in '$partitions' environment variable. Specificially, name, start
 349  * and size of the partition is checked.
 350  *
 351  * @param dev_desc - block device descriptor
 352  * @param partitions - partition data read from '$partitions' env variable
 353  * @param parts - number of partitions read from '$partitions' env variable
 354  * @param gpt_head - pointer to GPT header data read from medium
 355  * @param gpt_pte - pointer to GPT partition table enties read from medium
 356  *
 357  * @return - '0' on success, otherwise error
 358  */
 359 int gpt_verify_partitions(struct blk_desc *dev_desc,
 360                           disk_partition_t *partitions, int parts,
 361                           gpt_header *gpt_head, gpt_entry **gpt_pte);
 362 #endif
 363
 364 #endif /* _PART_H */