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