include/part.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2004
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6 #ifndef _PART_H
   7 #define _PART_H
   8
   9 #include <blk.h>
  10 #include <ide.h>
  11 #include <uuid.h>
  12 #include <linker_lists.h>
  13 #include <linux/errno.h>
  14 #include <linux/list.h>
  15
  16 struct block_drvr {
  17         char *name;
  18         int (*select_hwpart)(int dev_num, int hwpart);
  19 };
  20
  21 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
  22                  ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
  23                  ((x & 0xffff0000) ? 16 : 0))
  24 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
  25
  26 /* Part types */
  27 #define PART_TYPE_UNKNOWN       0x00
  28 #define PART_TYPE_MAC           0x01
  29 #define PART_TYPE_DOS           0x02
  30 #define PART_TYPE_ISO           0x03
  31 #define PART_TYPE_AMIGA         0x04
  32 #define PART_TYPE_EFI           0x05
  33
  34 /* maximum number of partition entries supported by search */
  35 #define DOS_ENTRY_NUMBERS       8
  36 #define ISO_ENTRY_NUMBERS       64
  37 #define MAC_ENTRY_NUMBERS       64
  38 #define AMIGA_ENTRY_NUMBERS     8
  39 /*
  40  * Type string for U-Boot bootable partitions
  41  */
  42 #define BOOT_PART_TYPE  "U-Boot"        /* primary boot partition type  */
  43 #define BOOT_PART_COMP  "PPCBoot"       /* PPCBoot compatibility type   */
  44
  45 /* device types */
  46 #define DEV_TYPE_UNKNOWN        0xff    /* not connected */
  47 #define DEV_TYPE_HARDDISK       0x00    /* harddisk */
  48 #define DEV_TYPE_TAPE           0x01    /* Tape */
  49 #define DEV_TYPE_CDROM          0x05    /* CD-ROM */
  50 #define DEV_TYPE_OPDISK         0x07    /* optical disk */
  51
  52 #define PART_NAME_LEN 32
  53 #define PART_TYPE_LEN 32
  54 #define MAX_SEARCH_PARTITIONS 128
  55
  56 #define PART_BOOTABLE                   ((int)BIT(0))
  57 #define PART_EFI_SYSTEM_PARTITION       ((int)BIT(1))
  58
  59 struct disk_partition {
  60         lbaint_t        start;  /* # of first block in partition        */
  61         lbaint_t        size;   /* number of blocks in partition        */
  62         ulong   blksz;          /* block size in bytes                  */
  63         uchar   name[PART_NAME_LEN];    /* partition name                       */
  64         uchar   type[PART_TYPE_LEN];    /* string type description              */
  65         /*
  66          * The bootable is a bitmask with the following fields:
  67          *
  68          * PART_BOOTABLE                the MBR bootable flag is set
  69          * PART_EFI_SYSTEM_PARTITION    the partition is an EFI system partition
  70          */
  71         int     bootable;
  72 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
  73         char    uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
  74 #endif
  75 #ifdef CONFIG_PARTITION_TYPE_GUID
  76         char    type_guid[UUID_STR_LEN + 1];    /* type GUID as string, if exists       */
  77 #endif
  78 #ifdef CONFIG_DOS_PARTITION
  79         uchar   sys_ind;        /* partition type                       */
  80 #endif
  81 };
  82
  83 struct disk_part {
  84         int partnum;
  85         struct disk_partition gpt_part_info;
  86         struct list_head list;
  87 };
  88
  89 /* Misc _get_dev functions */
  90 #if CONFIG_IS_ENABLED(PARTITIONS)
  91 /**
  92  * blk_get_dev() - get a pointer to a block device given its type and number
  93  *
  94  * Each interface allocates its own devices and typically struct blk_desc is
  95  * contained with the interface's data structure. There is no global
  96  * numbering for block devices, so the interface name must be provided.
  97  *
  98  * @ifname:     Interface name (e.g. "ide", "scsi")
  99  * @dev:        Device number (0 for first device on that interface, 1 for
 100  *              second, etc.
 101  * Return: pointer to the block device, or NULL if not available, or an
 102  *         error occurred.
 103  */
 104 struct blk_desc *blk_get_dev(const char *ifname, int dev);
 105
 106 struct blk_desc *mg_disk_get_dev(int dev);
 107
 108 /* disk/part.c */
 109 int part_get_info(struct blk_desc *dev_desc, int part,
 110                   struct disk_partition *info);
 111 /**
 112  * part_get_info_whole_disk() - get partition info for the special case of
 113  * a partition occupying the entire disk.
 114  */
 115 int part_get_info_whole_disk(struct blk_desc *dev_desc,
 116                              struct disk_partition *info);
 117
 118 void part_print(struct blk_desc *dev_desc);
 119 void part_init(struct blk_desc *dev_desc);
 120 void dev_print(struct blk_desc *dev_desc);
 121
 122 /**
 123  * blk_get_device_by_str() - Get a block device given its interface/hw partition
 124  *
 125  * Each interface allocates its own devices and typically struct blk_desc is
 126  * contained with the interface's data structure. There is no global
 127  * numbering for block devices, so the interface name must be provided.
 128  *
 129  * The hardware parition is not related to the normal software partitioning
 130  * of a device - each hardware partition is effectively a separately
 131  * accessible block device. When a hardware parition is selected on MMC the
 132  * other hardware partitions become inaccessible. The same block device is
 133  * used to access all hardware partitions, but its capacity may change when a
 134  * different hardware partition is selected.
 135  *
 136  * When a hardware partition number is given, the block device switches to
 137  * that hardware partition.
 138  *
 139  * @ifname:     Interface name (e.g. "ide", "scsi")
 140  * @dev_str:    Device and optional hw partition. This can either be a string
 141  *              containing the device number (e.g. "2") or the device number
 142  *              and hardware partition number (e.g. "2.4") for devices that
 143  *              support it (currently only MMC).
 144  * @dev_desc:   Returns a pointer to the block device on success
 145  * Return: block device number (local to the interface), or -1 on error
 146  */
 147 int blk_get_device_by_str(const char *ifname, const char *dev_str,
 148                           struct blk_desc **dev_desc);
 149
 150 /**
 151  * blk_get_device_part_str() - Get a block device and partition
 152  *
 153  * This calls blk_get_device_by_str() to look up a device. It also looks up
 154  * a partition and returns information about it.
 155  *
 156  * @dev_part_str is in the format:
 157  *      <dev>.<hw_part>:<part> where <dev> is the device number,
 158  *      <hw_part> is the optional hardware partition number and
 159  *      <part> is the partition number
 160  *
 161  * If ifname is "hostfs" then this function returns the sandbox host block
 162  * device.
 163  *
 164  * If ifname is ubi, then this function returns 0, with @info set to a
 165  * special UBI device.
 166  *
 167  * If @dev_part_str is NULL or empty or "-", then this function looks up
 168  * the "bootdevice" environment variable and uses that string instead.
 169  *
 170  * If the partition string is empty then the first partition is used. If the
 171  * partition string is "auto" then the first bootable partition is used.
 172  *
 173  * @ifname:     Interface name (e.g. "ide", "scsi")
 174  * @dev_part_str:       Device and partition string
 175  * @dev_desc:   Returns a pointer to the block device on success
 176  * @info:       Returns partition information
 177  * @allow_whole_dev:    true to allow the user to select partition 0
 178  *              (which means the whole device), false to require a valid
 179  *              partition number >= 1
 180  * Return: partition number, or -1 on error
 181  *
 182  */
 183 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
 184                             struct blk_desc **dev_desc,
 185                             struct disk_partition *info, int allow_whole_dev);
 186
 187 /**
 188  * part_get_info_by_name_type() - Search for a partition by name
 189  *                                for only specified partition type
 190  *
 191  * @param dev_desc - block device descriptor
 192  * @param gpt_name - the specified table entry name
 193  * @param info - returns the disk partition info
 194  * @param part_type - only search in partitions of this type
 195  *
 196  * Return: - the partition number on match (starting on 1), -1 on no match,
 197  * otherwise error
 198  */
 199 int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
 200                                struct disk_partition *info, int part_type);
 201
 202 /**
 203  * part_get_info_by_name() - Search for a partition by name
 204  *                           among all available registered partitions
 205  *
 206  * @param dev_desc - block device descriptor
 207  * @param gpt_name - the specified table entry name
 208  * @param info - returns the disk partition info
 209  *
 210  * Return: - the partition number on match (starting on 1), -1 on no match,
 211  * otherwise error
 212  */
 213 int part_get_info_by_name(struct blk_desc *dev_desc,
 214                               const char *name, struct disk_partition *info);
 215
 216 /**
 217  * Get partition info from dev number + part name, or dev number + part number.
 218  *
 219  * Parse a device number and partition description (either name or number)
 220  * in the form of device number plus partition name separated by a "#"
 221  * (like "device_num#partition_name") or a device number plus a partition number
 222  * separated by a ":". For example both "0#misc" and "0:1" can be valid
 223  * partition descriptions for a given interface. If the partition is found, sets
 224  * dev_desc and part_info accordingly with the information of the partition.
 225  *
 226  * @param[in] dev_iface Device interface
 227  * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
 228  * @param[out] dev_desc Place to store the device description pointer
 229  * @param[out] part_info Place to store the partition information
 230  * @param[in] allow_whole_dev true to allow the user to select partition 0
 231  *              (which means the whole device), false to require a valid
 232  *              partition number >= 1
 233  * Return: the partition number on success, or negative errno on error
 234  */
 235 int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
 236                                          const char *dev_part_str,
 237                                          struct blk_desc **dev_desc,
 238                                          struct disk_partition *part_info,
 239                                          int allow_whole_dev);
 240
 241 /**
 242  * part_set_generic_name() - create generic partition like hda1 or sdb2
 243  *
 244  * Helper function for partition tables, which don't hold partition names
 245  * (DOS, ISO). Generates partition name out of the device type and partition
 246  * number.
 247  *
 248  * @dev_desc:   pointer to the block device
 249  * @part_num:   partition number for which the name is generated
 250  * @name:       buffer where the name is written
 251  */
 252 void part_set_generic_name(const struct blk_desc *dev_desc,
 253         int part_num, char *name);
 254
 255 extern const struct block_drvr block_drvr[];
 256 #else
 257 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
 258 { return NULL; }
 259 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
 260
 261 static inline int part_get_info(struct blk_desc *dev_desc, int part,
 262                                 struct disk_partition *info) { return -1; }
 263 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
 264                                            struct disk_partition *info)
 265 { return -1; }
 266 static inline void part_print(struct blk_desc *dev_desc) {}
 267 static inline void part_init(struct blk_desc *dev_desc) {}
 268 static inline void dev_print(struct blk_desc *dev_desc) {}
 269 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
 270                                         struct blk_desc **dev_desc)
 271 { return -1; }
 272 static inline int blk_get_device_part_str(const char *ifname,
 273                                           const char *dev_part_str,
 274                                           struct blk_desc **dev_desc,
 275                                           struct disk_partition *info,
 276                                           int allow_whole_dev)
 277 { *dev_desc = NULL; return -1; }
 278
 279 static inline int part_get_info_by_name_type(struct blk_desc *dev_desc,
 280                                              const char *name,
 281                                              struct disk_partition *info,
 282                                              int part_type)
 283 {
 284         return -ENOENT;
 285 }
 286
 287 static inline int part_get_info_by_name(struct blk_desc *dev_desc,
 288                                         const char *name,
 289                                         struct disk_partition *info)
 290 {
 291         return -ENOENT;
 292 }
 293
 294 static inline int
 295 part_get_info_by_dev_and_name_or_num(const char *dev_iface,
 296                                      const char *dev_part_str,
 297                                      struct blk_desc **dev_desc,
 298                                      struct disk_partition *part_info,
 299                                      int allow_whole_dev)
 300 {
 301         *dev_desc = NULL;
 302         return -ENOSYS;
 303 }
 304 #endif
 305
 306 struct udevice;
 307 /**
 308  * part_create_block_devices - Create block devices for disk partitions
 309  *
 310  * Create UCLASS_PARTITION udevices for each of disk partitions in @parent
 311  *
 312  * @blk_dev:    Whole disk device
 313  */
 314 int part_create_block_devices(struct udevice *blk_dev);
 315
 316 /*
 317  * We don't support printing partition information in SPL and only support
 318  * getting partition information in a few cases.
 319  */
 320 #ifdef CONFIG_SPL_BUILD
 321 # define part_print_ptr(x)      NULL
 322 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
 323         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
 324 #  define part_get_info_ptr(x)  x
 325 # else
 326 #  define part_get_info_ptr(x)  NULL
 327 # endif
 328 #else
 329 #define part_print_ptr(x)       x
 330 #define part_get_info_ptr(x)    x
 331 #endif
 332
 333
 334 struct part_driver {
 335         const char *name;
 336         int part_type;
 337         const int max_entries;  /* maximum number of entries to search */
 338
 339         /**
 340          * get_info() - Get information about a partition
 341          *
 342          * @dev_desc:   Block device descriptor
 343          * @part:       Partition number (1 = first)
 344          * @info:       Returns partition information
 345          */
 346         int (*get_info)(struct blk_desc *dev_desc, int part,
 347                         struct disk_partition *info);
 348
 349         /**
 350          * print() - Print partition information
 351          *
 352          * @dev_desc:   Block device descriptor
 353          */
 354         void (*print)(struct blk_desc *dev_desc);
 355
 356         /**
 357          * test() - Test if a device contains this partition type
 358          *
 359          * @dev_desc:   Block device descriptor
 360          * @return 0 if the block device appears to contain this partition
 361          *         type, -ve if not
 362          */
 363         int (*test)(struct blk_desc *dev_desc);
 364 };
 365
 366 /* Declare a new U-Boot partition 'driver' */
 367 #define U_BOOT_PART_TYPE(__name)                                        \
 368         ll_entry_declare(struct part_driver, __name, part_driver)
 369
 370 #include <part_efi.h>
 371
 372 #if CONFIG_IS_ENABLED(EFI_PARTITION)
 373 /* disk/part_efi.c */
 374 /**
 375  * write_gpt_table() - Write the GUID Partition Table to disk
 376  *
 377  * @param dev_desc - block device descriptor
 378  * @param gpt_h - pointer to GPT header representation
 379  * @param gpt_e - pointer to GPT partition table entries
 380  *
 381  * Return: - zero on success, otherwise error
 382  */
 383 int write_gpt_table(struct blk_desc *dev_desc,
 384                   gpt_header *gpt_h, gpt_entry *gpt_e);
 385
 386 /**
 387  * gpt_fill_pte(): Fill the GPT partition table entry
 388  *
 389  * @param dev_desc - block device descriptor
 390  * @param gpt_h - GPT header representation
 391  * @param gpt_e - GPT partition table entries
 392  * @param partitions - list of partitions
 393  * @param parts - number of partitions
 394  *
 395  * Return: zero on success
 396  */
 397 int gpt_fill_pte(struct blk_desc *dev_desc,
 398                  gpt_header *gpt_h, gpt_entry *gpt_e,
 399                  struct disk_partition *partitions, int parts);
 400
 401 /**
 402  * gpt_fill_header(): Fill the GPT header
 403  *
 404  * @param dev_desc - block device descriptor
 405  * @param gpt_h - GPT header representation
 406  * @param str_guid - disk guid string representation
 407  * @param parts_count - number of partitions
 408  *
 409  * Return: - error on str_guid conversion error
 410  */
 411 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 412                 char *str_guid, int parts_count);
 413
 414 /**
 415  * gpt_restore(): Restore GPT partition table
 416  *
 417  * @param dev_desc - block device descriptor
 418  * @param str_disk_guid - disk GUID
 419  * @param partitions - list of partitions
 420  * @param parts - number of partitions
 421  *
 422  * Return: zero on success
 423  */
 424 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 425                 struct disk_partition *partitions, const int parts_count);
 426
 427 /**
 428  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 429  *
 430  * @param dev_desc - block device descriptor
 431  * @param buf - buffer which contains the MBR and Primary GPT info
 432  *
 433  * Return: - '0' on success, otherwise error
 434  */
 435 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
 436
 437 /**
 438  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 439  *
 440  * @param dev_desc - block device descriptor
 441  * @param buf - buffer which contains the MBR and Primary GPT info
 442  *
 443  * Return: - '0' on success, otherwise error
 444  */
 445 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
 446
 447 /**
 448  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 449  *                        and partition table entries (PTE)
 450  *
 451  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 452  *
 453  * @param dev_desc - block device descriptor
 454  * @param gpt_head - pointer to GPT header data read from medium
 455  * @param gpt_pte - pointer to GPT partition table enties read from medium
 456  *
 457  * Return: - '0' on success, otherwise error
 458  */
 459 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 460                        gpt_entry **gpt_pte);
 461
 462 /**
 463  * gpt_verify_partitions() - Function to check if partitions' name, start and
 464  *                           size correspond to '$partitions' env variable
 465  *
 466  * This function checks if on medium stored GPT data is in sync with information
 467  * provided in '$partitions' environment variable. Specificially, name, start
 468  * and size of the partition is checked.
 469  *
 470  * @param dev_desc - block device descriptor
 471  * @param partitions - partition data read from '$partitions' env variable
 472  * @param parts - number of partitions read from '$partitions' env variable
 473  * @param gpt_head - pointer to GPT header data read from medium
 474  * @param gpt_pte - pointer to GPT partition table enties read from medium
 475  *
 476  * Return: - '0' on success, otherwise error
 477  */
 478 int gpt_verify_partitions(struct blk_desc *dev_desc,
 479                           struct disk_partition *partitions, int parts,
 480                           gpt_header *gpt_head, gpt_entry **gpt_pte);
 481
 482
 483 /**
 484  * get_disk_guid() - Function to read the GUID string from a device's GPT
 485  *
 486  * This function reads the GUID string from a block device whose descriptor
 487  * is provided.
 488  *
 489  * @param dev_desc - block device descriptor
 490  * @param guid - pre-allocated string in which to return the GUID
 491  *
 492  * Return: - '0' on success, otherwise error
 493  */
 494 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
 495
 496 #endif
 497
 498 #if CONFIG_IS_ENABLED(DOS_PARTITION)
 499 /**
 500  * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
 501  *
 502  * @param buf - buffer which contains the MBR
 503  *
 504  * Return: - '0' on success, otherwise error
 505  */
 506 int is_valid_dos_buf(void *buf);
 507
 508 /**
 509  * write_mbr_sector() - write DOS MBR
 510  *
 511  * @param dev_desc - block device descriptor
 512  * @param buf - buffer which contains the MBR
 513  *
 514  * Return: - '0' on success, otherwise error
 515  */
 516 int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
 517
 518 int write_mbr_partitions(struct blk_desc *dev,
 519                 struct disk_partition *p, int count, unsigned int disksig);
 520 int layout_mbr_partitions(struct disk_partition *p, int count,
 521                           lbaint_t total_sectors);
 522
 523 #endif
 524
 525 #if CONFIG_IS_ENABLED(PARTITIONS)
 526 /**
 527  * part_driver_get_count() - get partition driver count
 528  *
 529  * Return: - number of partition drivers
 530  */
 531 static inline int part_driver_get_count(void)
 532 {
 533         return ll_entry_count(struct part_driver, part_driver);
 534 }
 535
 536 /**
 537  * part_driver_get_first() - get first partition driver
 538  *
 539  * Return: - pointer to first partition driver on success, otherwise NULL
 540  */
 541 static inline struct part_driver *part_driver_get_first(void)
 542 {
 543         return ll_entry_start(struct part_driver, part_driver);
 544 }
 545
 546 #else
 547 static inline int part_driver_get_count(void)
 548 { return 0; }
 549
 550 static inline struct part_driver *part_driver_get_first(void)
 551 { return NULL; }
 552 #endif /* CONFIG_PARTITIONS */
 553
 554 #endif /* _PART_H */