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 #include <uuid.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
  53 typedef struct disk_partition {
  54         lbaint_t        start;  /* # of first block in partition        */
  55         lbaint_t        size;   /* number of blocks in partition        */
  56         ulong   blksz;          /* block size in bytes                  */
  57         uchar   name[PART_NAME_LEN];    /* partition name                       */
  58         uchar   type[PART_TYPE_LEN];    /* string type description              */
  59         int     bootable;       /* Active/Bootable flag is set          */
  60 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
  61         char    uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
  62 #endif
  63 #ifdef CONFIG_PARTITION_TYPE_GUID
  64         char    type_guid[UUID_STR_LEN + 1];    /* type GUID as string, if exists       */
  65 #endif
  66 #ifdef CONFIG_DOS_PARTITION
  67         uchar   sys_ind;        /* partition type                       */
  68 #endif
  69 } disk_partition_t;
  70
  71 /* Misc _get_dev functions */
  72 #ifdef CONFIG_PARTITIONS
  73 /**
  74  * blk_get_dev() - get a pointer to a block device given its type and number
  75  *
  76  * Each interface allocates its own devices and typically struct blk_desc is
  77  * contained with the interface's data structure. There is no global
  78  * numbering for block devices, so the interface name must be provided.
  79  *
  80  * @ifname:     Interface name (e.g. "ide", "scsi")
  81  * @dev:        Device number (0 for first device on that interface, 1 for
  82  *              second, etc.
  83  * @return pointer to the block device, or NULL if not available, or an
  84  *         error occurred.
  85  */
  86 struct blk_desc *blk_get_dev(const char *ifname, int dev);
  87
  88 struct blk_desc *mg_disk_get_dev(int dev);
  89 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
  90
  91 /* disk/part.c */
  92 int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
  93 void part_print(struct blk_desc *dev_desc);
  94 void part_init(struct blk_desc *dev_desc);
  95 void dev_print(struct blk_desc *dev_desc);
  96
  97 /**
  98  * blk_get_device_by_str() - Get a block device given its interface/hw partition
  99  *
 100  * Each interface allocates its own devices and typically struct blk_desc is
 101  * contained with the interface's data structure. There is no global
 102  * numbering for block devices, so the interface name must be provided.
 103  *
 104  * The hardware parition is not related to the normal software partitioning
 105  * of a device - each hardware partition is effectively a separately
 106  * accessible block device. When a hardware parition is selected on MMC the
 107  * other hardware partitions become inaccessible. The same block device is
 108  * used to access all hardware partitions, but its capacity may change when a
 109  * different hardware partition is selected.
 110  *
 111  * When a hardware partition number is given, the block device switches to
 112  * that hardware partition.
 113  *
 114  * @ifname:     Interface name (e.g. "ide", "scsi")
 115  * @dev_str:    Device and optional hw partition. This can either be a string
 116  *              containing the device number (e.g. "2") or the device number
 117  *              and hardware partition number (e.g. "2.4") for devices that
 118  *              support it (currently only MMC).
 119  * @dev_desc:   Returns a pointer to the block device on success
 120  * @return block device number (local to the interface), or -1 on error
 121  */
 122 int blk_get_device_by_str(const char *ifname, const char *dev_str,
 123                           struct blk_desc **dev_desc);
 124
 125 /**
 126  * blk_get_device_part_str() - Get a block device and partition
 127  *
 128  * This calls blk_get_device_by_str() to look up a device. It also looks up
 129  * a partition and returns information about it.
 130  *
 131  * @dev_part_str is in the format:
 132  *      <dev>.<hw_part>:<part> where <dev> is the device number,
 133  *      <hw_part> is the optional hardware partition number and
 134  *      <part> is the partition number
 135  *
 136  * If ifname is "hostfs" then this function returns the sandbox host block
 137  * device.
 138  *
 139  * If ifname is ubi, then this function returns 0, with @info set to a
 140  * special UBI device.
 141  *
 142  * If @dev_part_str is NULL or empty or "-", then this function looks up
 143  * the "bootdevice" environment variable and uses that string instead.
 144  *
 145  * If the partition string is empty then the first partition is used. If the
 146  * partition string is "auto" then the first bootable partition is used.
 147  *
 148  * @ifname:     Interface name (e.g. "ide", "scsi")
 149  * @dev_part_str:       Device and partition string
 150  * @dev_desc:   Returns a pointer to the block device on success
 151  * @info:       Returns partition information
 152  * @allow_whole_dev:    true to allow the user to select partition 0
 153  *              (which means the whole device), false to require a valid
 154  *              partition number >= 1
 155  * @return partition number, or -1 on error
 156  *
 157  */
 158 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
 159                             struct blk_desc **dev_desc,
 160                             disk_partition_t *info, int allow_whole_dev);
 161
 162 /**
 163  * part_get_info_by_name() - Search for a partition by name
 164  *                           among all available registered partitions
 165  *
 166  * @param dev_desc - block device descriptor
 167  * @param gpt_name - the specified table entry name
 168  * @param info - returns the disk partition info
 169  *
 170  * @return - the partition number on match (starting on 1), -1 on no match,
 171  * otherwise error
 172  */
 173 int part_get_info_by_name(struct blk_desc *dev_desc,
 174                               const char *name, disk_partition_t *info);
 175
 176 /**
 177  * part_set_generic_name() - create generic partition like hda1 or sdb2
 178  *
 179  * Helper function for partition tables, which don't hold partition names
 180  * (DOS, ISO). Generates partition name out of the device type and partition
 181  * number.
 182  *
 183  * @dev_desc:   pointer to the block device
 184  * @part_num:   partition number for which the name is generated
 185  * @name:       buffer where the name is written
 186  */
 187 void part_set_generic_name(const struct blk_desc *dev_desc,
 188         int part_num, char *name);
 189
 190 extern const struct block_drvr block_drvr[];
 191 #else
 192 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
 193 { return NULL; }
 194 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
 195
 196 static inline int part_get_info(struct blk_desc *dev_desc, int part,
 197                                 disk_partition_t *info) { return -1; }
 198 static inline void part_print(struct blk_desc *dev_desc) {}
 199 static inline void part_init(struct blk_desc *dev_desc) {}
 200 static inline void dev_print(struct blk_desc *dev_desc) {}
 201 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
 202                                         struct blk_desc **dev_desc)
 203 { return -1; }
 204 static inline int blk_get_device_part_str(const char *ifname,
 205                                            const char *dev_part_str,
 206                                            struct blk_desc **dev_desc,
 207                                            disk_partition_t *info,
 208                                            int allow_whole_dev)
 209 { *dev_desc = NULL; return -1; }
 210 #endif
 211
 212 /*
 213  * We don't support printing partition information in SPL and only support
 214  * getting partition information in a few cases.
 215  */
 216 #ifdef CONFIG_SPL_BUILD
 217 # define part_print_ptr(x)      NULL
 218 # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
 219         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
 220 #  define part_get_info_ptr(x)  x
 221 # else
 222 #  define part_get_info_ptr(x)  NULL
 223 # endif
 224 #else
 225 #define part_print_ptr(x)       x
 226 #define part_get_info_ptr(x)    x
 227 #endif
 228
 229
 230 struct part_driver {
 231         const char *name;
 232         int part_type;
 233         const int max_entries;  /* maximum number of entries to search */
 234
 235         /**
 236          * get_info() - Get information about a partition
 237          *
 238          * @dev_desc:   Block device descriptor
 239          * @part:       Partition number (1 = first)
 240          * @info:       Returns partition information
 241          */
 242         int (*get_info)(struct blk_desc *dev_desc, int part,
 243                         disk_partition_t *info);
 244
 245         /**
 246          * print() - Print partition information
 247          *
 248          * @dev_desc:   Block device descriptor
 249          */
 250         void (*print)(struct blk_desc *dev_desc);
 251
 252         /**
 253          * test() - Test if a device contains this partition type
 254          *
 255          * @dev_desc:   Block device descriptor
 256          * @return 0 if the block device appears to contain this partition
 257          *         type, -ve if not
 258          */
 259         int (*test)(struct blk_desc *dev_desc);
 260 };
 261
 262 /* Declare a new U-Boot partition 'driver' */
 263 #define U_BOOT_PART_TYPE(__name)                                        \
 264         ll_entry_declare(struct part_driver, __name, part_driver)
 265
 266 #if CONFIG_IS_ENABLED(EFI_PARTITION)
 267 #include <part_efi.h>
 268 /* disk/part_efi.c */
 269 /**
 270  * write_gpt_table() - Write the GUID Partition Table to disk
 271  *
 272  * @param dev_desc - block device descriptor
 273  * @param gpt_h - pointer to GPT header representation
 274  * @param gpt_e - pointer to GPT partition table entries
 275  *
 276  * @return - zero on success, otherwise error
 277  */
 278 int write_gpt_table(struct blk_desc *dev_desc,
 279                   gpt_header *gpt_h, gpt_entry *gpt_e);
 280
 281 /**
 282  * gpt_fill_pte(): Fill the GPT partition table entry
 283  *
 284  * @param gpt_h - GPT header representation
 285  * @param gpt_e - GPT partition table entries
 286  * @param partitions - list of partitions
 287  * @param parts - number of partitions
 288  *
 289  * @return zero on success
 290  */
 291 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
 292                 disk_partition_t *partitions, int parts);
 293
 294 /**
 295  * gpt_fill_header(): Fill the GPT header
 296  *
 297  * @param dev_desc - block device descriptor
 298  * @param gpt_h - GPT header representation
 299  * @param str_guid - disk guid string representation
 300  * @param parts_count - number of partitions
 301  *
 302  * @return - error on str_guid conversion error
 303  */
 304 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 305                 char *str_guid, int parts_count);
 306
 307 /**
 308  * gpt_restore(): Restore GPT partition table
 309  *
 310  * @param dev_desc - block device descriptor
 311  * @param str_disk_guid - disk GUID
 312  * @param partitions - list of partitions
 313  * @param parts - number of partitions
 314  *
 315  * @return zero on success
 316  */
 317 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 318                 disk_partition_t *partitions, const int parts_count);
 319
 320 /**
 321  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 322  *
 323  * @param dev_desc - block device descriptor
 324  * @param buf - buffer which contains the MBR and Primary GPT info
 325  *
 326  * @return - '0' on success, otherwise error
 327  */
 328 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
 329
 330 /**
 331  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 332  *
 333  * @param dev_desc - block device descriptor
 334  * @param buf - buffer which contains the MBR and Primary GPT info
 335  *
 336  * @return - '0' on success, otherwise error
 337  */
 338 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
 339
 340 /**
 341  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 342  *                        and partition table entries (PTE)
 343  *
 344  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 345  *
 346  * @param dev_desc - block device descriptor
 347  * @param gpt_head - pointer to GPT header data read from medium
 348  * @param gpt_pte - pointer to GPT partition table enties read from medium
 349  *
 350  * @return - '0' on success, otherwise error
 351  */
 352 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 353                        gpt_entry **gpt_pte);
 354
 355 /**
 356  * gpt_verify_partitions() - Function to check if partitions' name, start and
 357  *                           size correspond to '$partitions' env variable
 358  *
 359  * This function checks if on medium stored GPT data is in sync with information
 360  * provided in '$partitions' environment variable. Specificially, name, start
 361  * and size of the partition is checked.
 362  *
 363  * @param dev_desc - block device descriptor
 364  * @param partitions - partition data read from '$partitions' env variable
 365  * @param parts - number of partitions read from '$partitions' env variable
 366  * @param gpt_head - pointer to GPT header data read from medium
 367  * @param gpt_pte - pointer to GPT partition table enties read from medium
 368  *
 369  * @return - '0' on success, otherwise error
 370  */
 371 int gpt_verify_partitions(struct blk_desc *dev_desc,
 372                           disk_partition_t *partitions, int parts,
 373                           gpt_header *gpt_head, gpt_entry **gpt_pte);
 374 #endif
 375
 376 #if CONFIG_IS_ENABLED(DOS_PARTITION)
 377 /**
 378  * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
 379  *
 380  * @param buf - buffer which contains the MBR
 381  *
 382  * @return - '0' on success, otherwise error
 383  */
 384 int is_valid_dos_buf(void *buf);
 385
 386 /**
 387  * write_mbr_partition() - write DOS MBR
 388  *
 389  * @param dev_desc - block device descriptor
 390  * @param buf - buffer which contains the MBR
 391  *
 392  * @return - '0' on success, otherwise error
 393  */
 394 int write_mbr_partition(struct blk_desc *dev_desc, void *buf);
 395
 396 #endif
 397
 398
 399 #endif /* _PART_H */