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 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
  14                  ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
  15                  ((x & 0xffff0000) ? 16 : 0))
  16 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
  17
  18 /* Part types */
  19 #define PART_TYPE_UNKNOWN       0x00
  20 #define PART_TYPE_MAC           0x01
  21 #define PART_TYPE_DOS           0x02
  22 #define PART_TYPE_ISO           0x03
  23 #define PART_TYPE_AMIGA         0x04
  24 #define PART_TYPE_EFI           0x05
  25
  26 /*
  27  * Type string for U-Boot bootable partitions
  28  */
  29 #define BOOT_PART_TYPE  "U-Boot"        /* primary boot partition type  */
  30 #define BOOT_PART_COMP  "PPCBoot"       /* PPCBoot compatibility type   */
  31
  32 /* device types */
  33 #define DEV_TYPE_UNKNOWN        0xff    /* not connected */
  34 #define DEV_TYPE_HARDDISK       0x00    /* harddisk */
  35 #define DEV_TYPE_TAPE           0x01    /* Tape */
  36 #define DEV_TYPE_CDROM          0x05    /* CD-ROM */
  37 #define DEV_TYPE_OPDISK         0x07    /* optical disk */
  38
  39 typedef struct disk_partition {
  40         lbaint_t        start;  /* # of first block in partition        */
  41         lbaint_t        size;   /* number of blocks in partition        */
  42         ulong   blksz;          /* block size in bytes                  */
  43         uchar   name[32];       /* partition name                       */
  44         uchar   type[32];       /* string type description              */
  45         int     bootable;       /* Active/Bootable flag is set          */
  46 #ifdef CONFIG_PARTITION_UUIDS
  47         char    uuid[37];       /* filesystem UUID as string, if exists */
  48 #endif
  49 #ifdef CONFIG_PARTITION_TYPE_GUID
  50         char    type_guid[37];  /* type GUID as string, if exists       */
  51 #endif
  52 } disk_partition_t;
  53
  54 /* Misc _get_dev functions */
  55 #ifdef CONFIG_PARTITIONS
  56 /**
  57  * blk_get_dev() - get a pointer to a block device given its type and number
  58  *
  59  * Each interface allocates its own devices and typically struct blk_desc is
  60  * contained with the interface's data structure. There is no global
  61  * numbering for block devices, so the interface name must be provided.
  62  *
  63  * @ifname:     Interface name (e.g. "ide", "scsi")
  64  * @dev:        Device number (0 for first device on that interface, 1 for
  65  *              second, etc.
  66  * @return pointer to the block device, or NULL if not available, or an
  67  *         error occurred.
  68  */
  69 struct blk_desc *blk_get_dev(const char *ifname, int dev);
  70 struct blk_desc *ide_get_dev(int dev);
  71 struct blk_desc *sata_get_dev(int dev);
  72 struct blk_desc *scsi_get_dev(int dev);
  73 struct blk_desc *usb_stor_get_dev(int dev);
  74 struct blk_desc *mmc_get_dev(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 *systemace_get_dev(int dev);
  94 struct blk_desc *mg_disk_get_dev(int dev);
  95 struct blk_desc *host_get_dev(int dev);
  96 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
  97
  98 /* disk/part.c */
  99 int get_partition_info(struct blk_desc *dev_desc, int part,
 100                        disk_partition_t *info);
 101 void print_part(struct blk_desc *dev_desc);
 102 void init_part(struct blk_desc *dev_desc);
 103 void dev_print(struct blk_desc *dev_desc);
 104
 105 /**
 106  * blk_get_device_by_str() - Get a block device given its interface/hw partition
 107  *
 108  * Each interface allocates its own devices and typically struct blk_desc is
 109  * contained with the interface's data structure. There is no global
 110  * numbering for block devices, so the interface name must be provided.
 111  *
 112  * The hardware parition is not related to the normal software partitioning
 113  * of a device - each hardware partition is effectively a separately
 114  * accessible block device. When a hardware parition is selected on MMC the
 115  * other hardware partitions become inaccessible. The same block device is
 116  * used to access all hardware partitions, but its capacity may change when a
 117  * different hardware partition is selected.
 118  *
 119  * When a hardware partition number is given, the block device switches to
 120  * that hardware partition.
 121  *
 122  * @ifname:     Interface name (e.g. "ide", "scsi")
 123  * @dev_str:    Device and optional hw partition. This can either be a string
 124  *              containing the device number (e.g. "2") or the device number
 125  *              and hardware partition number (e.g. "2.4") for devices that
 126  *              support it (currently only MMC).
 127  * @dev_desc:   Returns a pointer to the block device on success
 128  * @return block device number (local to the interface), or -1 on error
 129  */
 130 int blk_get_device_by_str(const char *ifname, const char *dev_str,
 131                           struct blk_desc **dev_desc);
 132 int get_device_and_partition(const char *ifname, const char *dev_part_str,
 133                              struct blk_desc **dev_desc,
 134                              disk_partition_t *info, int allow_whole_dev);
 135 #else
 136 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
 137 { return NULL; }
 138 static inline struct blk_desc *ide_get_dev(int dev) { return NULL; }
 139 static inline struct blk_desc *sata_get_dev(int dev) { return NULL; }
 140 static inline struct blk_desc *scsi_get_dev(int dev) { return NULL; }
 141 static inline struct blk_desc *usb_stor_get_dev(int dev) { return NULL; }
 142 static inline struct blk_desc *mmc_get_dev(int dev) { return NULL; }
 143 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
 144 static inline struct blk_desc *systemace_get_dev(int dev) { return NULL; }
 145 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
 146 static inline struct blk_desc *host_get_dev(int dev) { return NULL; }
 147
 148 static inline int get_partition_info(struct blk_desc *dev_desc, int part,
 149                                      disk_partition_t *info) { return -1; }
 150 static inline void print_part(struct blk_desc *dev_desc) {}
 151 static inline void init_part(struct blk_desc *dev_desc) {}
 152 static inline void dev_print(struct blk_desc *dev_desc) {}
 153 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
 154                                         struct blk_desc **dev_desc)
 155 { return -1; }
 156 static inline int get_device_and_partition(const char *ifname,
 157                                            const char *dev_part_str,
 158                                            struct blk_desc **dev_desc,
 159                                            disk_partition_t *info,
 160                                            int allow_whole_dev)
 161 { *dev_desc = NULL; return -1; }
 162 #endif
 163
 164 #ifdef CONFIG_MAC_PARTITION
 165 /* disk/part_mac.c */
 166 int get_partition_info_mac(struct blk_desc *dev_desc, int part,
 167                            disk_partition_t *info);
 168 void print_part_mac(struct blk_desc *dev_desc);
 169 int test_part_mac(struct blk_desc *dev_desc);
 170 #endif
 171
 172 #ifdef CONFIG_DOS_PARTITION
 173 /* disk/part_dos.c */
 174 int get_partition_info_dos(struct blk_desc *dev_desc, int part,
 175                            disk_partition_t *info);
 176 void print_part_dos(struct blk_desc *dev_desc);
 177 int test_part_dos(struct blk_desc *dev_desc);
 178 #endif
 179
 180 #ifdef CONFIG_ISO_PARTITION
 181 /* disk/part_iso.c */
 182 int get_partition_info_iso(struct blk_desc *dev_desc, int part,
 183                            disk_partition_t *info);
 184 void print_part_iso(struct blk_desc *dev_desc);
 185 int test_part_iso(struct blk_desc *dev_desc);
 186 #endif
 187
 188 #ifdef CONFIG_AMIGA_PARTITION
 189 /* disk/part_amiga.c */
 190 int get_partition_info_amiga(struct blk_desc *dev_desc, int part,
 191                              disk_partition_t *info);
 192 void print_part_amiga(struct blk_desc *dev_desc);
 193 int test_part_amiga(struct blk_desc *dev_desc);
 194 #endif
 195
 196 #ifdef CONFIG_EFI_PARTITION
 197 #include <part_efi.h>
 198 /* disk/part_efi.c */
 199 int get_partition_info_efi(struct blk_desc *dev_desc, int part,
 200                            disk_partition_t *info);
 201 /**
 202  * get_partition_info_efi_by_name() - Find the specified GPT partition table entry
 203  *
 204  * @param dev_desc - block device descriptor
 205  * @param gpt_name - the specified table entry name
 206  * @param info - returns the disk partition info
 207  *
 208  * @return - '0' on match, '-1' on no match, otherwise error
 209  */
 210 int get_partition_info_efi_by_name(struct blk_desc *dev_desc,
 211         const char *name, disk_partition_t *info);
 212 void print_part_efi(struct blk_desc *dev_desc);
 213 int test_part_efi(struct blk_desc *dev_desc);
 214
 215 /**
 216  * write_gpt_table() - Write the GUID Partition Table to disk
 217  *
 218  * @param dev_desc - block device descriptor
 219  * @param gpt_h - pointer to GPT header representation
 220  * @param gpt_e - pointer to GPT partition table entries
 221  *
 222  * @return - zero on success, otherwise error
 223  */
 224 int write_gpt_table(struct blk_desc *dev_desc,
 225                   gpt_header *gpt_h, gpt_entry *gpt_e);
 226
 227 /**
 228  * gpt_fill_pte(): Fill the GPT partition table entry
 229  *
 230  * @param gpt_h - GPT header representation
 231  * @param gpt_e - GPT partition table entries
 232  * @param partitions - list of partitions
 233  * @param parts - number of partitions
 234  *
 235  * @return zero on success
 236  */
 237 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
 238                 disk_partition_t *partitions, int parts);
 239
 240 /**
 241  * gpt_fill_header(): Fill the GPT header
 242  *
 243  * @param dev_desc - block device descriptor
 244  * @param gpt_h - GPT header representation
 245  * @param str_guid - disk guid string representation
 246  * @param parts_count - number of partitions
 247  *
 248  * @return - error on str_guid conversion error
 249  */
 250 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 251                 char *str_guid, int parts_count);
 252
 253 /**
 254  * gpt_restore(): Restore GPT partition table
 255  *
 256  * @param dev_desc - block device descriptor
 257  * @param str_disk_guid - disk GUID
 258  * @param partitions - list of partitions
 259  * @param parts - number of partitions
 260  *
 261  * @return zero on success
 262  */
 263 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 264                 disk_partition_t *partitions, const int parts_count);
 265
 266 /**
 267  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 268  *
 269  * @param dev_desc - block device descriptor
 270  * @param buf - buffer which contains the MBR and Primary GPT info
 271  *
 272  * @return - '0' on success, otherwise error
 273  */
 274 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
 275
 276 /**
 277  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 278  *
 279  * @param dev_desc - block device descriptor
 280  * @param buf - buffer which contains the MBR and Primary GPT info
 281  *
 282  * @return - '0' on success, otherwise error
 283  */
 284 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
 285
 286 /**
 287  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 288  *                        and partition table entries (PTE)
 289  *
 290  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 291  *
 292  * @param dev_desc - block device descriptor
 293  * @param gpt_head - pointer to GPT header data read from medium
 294  * @param gpt_pte - pointer to GPT partition table enties read from medium
 295  *
 296  * @return - '0' on success, otherwise error
 297  */
 298 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 299                        gpt_entry **gpt_pte);
 300
 301 /**
 302  * gpt_verify_partitions() - Function to check if partitions' name, start and
 303  *                           size correspond to '$partitions' env variable
 304  *
 305  * This function checks if on medium stored GPT data is in sync with information
 306  * provided in '$partitions' environment variable. Specificially, name, start
 307  * and size of the partition is checked.
 308  *
 309  * @param dev_desc - block device descriptor
 310  * @param partitions - partition data read from '$partitions' env variable
 311  * @param parts - number of partitions read from '$partitions' env variable
 312  * @param gpt_head - pointer to GPT header data read from medium
 313  * @param gpt_pte - pointer to GPT partition table enties read from medium
 314  *
 315  * @return - '0' on success, otherwise error
 316  */
 317 int gpt_verify_partitions(struct blk_desc *dev_desc,
 318                           disk_partition_t *partitions, int parts,
 319                           gpt_header *gpt_head, gpt_entry **gpt_pte);
 320 #endif
 321
 322 #endif /* _PART_H */