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 <ide.h>
  11 #include <common.h>
  12
  13 typedef struct block_dev_desc block_dev_desc_t;
  14
  15 struct block_dev_desc {
  16         int             if_type;        /* type of the interface */
  17         int             dev;            /* device number */
  18         unsigned char   part_type;      /* partition type */
  19         unsigned char   target;         /* target SCSI ID */
  20         unsigned char   lun;            /* target LUN */
  21         unsigned char   type;           /* device type */
  22         unsigned char   removable;      /* removable device */
  23 #ifdef CONFIG_LBA48
  24         unsigned char   lba48;          /* device can use 48bit addr (ATA/ATAPI v7) */
  25 #endif
  26         lbaint_t        lba;            /* number of blocks */
  27         unsigned long   blksz;          /* block size */
  28         int             log2blksz;      /* for convenience: log2(blksz) */
  29         char            vendor [40+1];  /* IDE model, SCSI Vendor */
  30         char            product[20+1];  /* IDE Serial no, SCSI product */
  31         char            revision[8+1];  /* firmware revision */
  32         unsigned long   (*block_read)(block_dev_desc_t *block_dev,
  33                                       lbaint_t start,
  34                                       lbaint_t blkcnt,
  35                                       void *buffer);
  36         unsigned long   (*block_write)(block_dev_desc_t *block_dev,
  37                                        lbaint_t start,
  38                                        lbaint_t blkcnt,
  39                                        const void *buffer);
  40         unsigned long   (*block_erase)(block_dev_desc_t *block_dev,
  41                                        lbaint_t start,
  42                                        lbaint_t blkcnt);
  43         void            *priv;          /* driver private struct pointer */
  44 };
  45
  46 #define BLOCK_CNT(size, block_dev_desc) (PAD_COUNT(size, block_dev_desc->blksz))
  47 #define PAD_TO_BLOCKSIZE(size, block_dev_desc) \
  48         (PAD_SIZE(size, block_dev_desc->blksz))
  49 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
  50                  ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
  51                  ((x & 0xffff0000) ? 16 : 0))
  52 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
  53
  54 /* Interface types: */
  55 #define IF_TYPE_UNKNOWN         0
  56 #define IF_TYPE_IDE             1
  57 #define IF_TYPE_SCSI            2
  58 #define IF_TYPE_ATAPI           3
  59 #define IF_TYPE_USB             4
  60 #define IF_TYPE_DOC             5
  61 #define IF_TYPE_MMC             6
  62 #define IF_TYPE_SD              7
  63 #define IF_TYPE_SATA            8
  64 #define IF_TYPE_HOST            9
  65 #define IF_TYPE_MAX             10      /* Max number of IF_TYPE_* supported */
  66
  67 /* Part types */
  68 #define PART_TYPE_UNKNOWN       0x00
  69 #define PART_TYPE_MAC           0x01
  70 #define PART_TYPE_DOS           0x02
  71 #define PART_TYPE_ISO           0x03
  72 #define PART_TYPE_AMIGA         0x04
  73 #define PART_TYPE_EFI           0x05
  74
  75 /*
  76  * Type string for U-Boot bootable partitions
  77  */
  78 #define BOOT_PART_TYPE  "U-Boot"        /* primary boot partition type  */
  79 #define BOOT_PART_COMP  "PPCBoot"       /* PPCBoot compatibility type   */
  80
  81 /* device types */
  82 #define DEV_TYPE_UNKNOWN        0xff    /* not connected */
  83 #define DEV_TYPE_HARDDISK       0x00    /* harddisk */
  84 #define DEV_TYPE_TAPE           0x01    /* Tape */
  85 #define DEV_TYPE_CDROM          0x05    /* CD-ROM */
  86 #define DEV_TYPE_OPDISK         0x07    /* optical disk */
  87
  88 typedef struct disk_partition {
  89         lbaint_t        start;  /* # of first block in partition        */
  90         lbaint_t        size;   /* number of blocks in partition        */
  91         ulong   blksz;          /* block size in bytes                  */
  92         uchar   name[32];       /* partition name                       */
  93         uchar   type[32];       /* string type description              */
  94         int     bootable;       /* Active/Bootable flag is set          */
  95 #ifdef CONFIG_PARTITION_UUIDS
  96         char    uuid[37];       /* filesystem UUID as string, if exists */
  97 #endif
  98 #ifdef CONFIG_PARTITION_TYPE_GUID
  99         char    type_guid[37];  /* type GUID as string, if exists       */
 100 #endif
 101 } disk_partition_t;
 102
 103 /* Misc _get_dev functions */
 104 #ifdef CONFIG_PARTITIONS
 105 block_dev_desc_t *get_dev(const char *ifname, int dev);
 106 block_dev_desc_t* ide_get_dev(int dev);
 107 block_dev_desc_t* sata_get_dev(int dev);
 108 block_dev_desc_t* scsi_get_dev(int dev);
 109 block_dev_desc_t* usb_stor_get_dev(int dev);
 110 block_dev_desc_t* mmc_get_dev(int dev);
 111 int mmc_select_hwpart(int dev_num, int hwpart);
 112 block_dev_desc_t* systemace_get_dev(int dev);
 113 block_dev_desc_t* mg_disk_get_dev(int dev);
 114 block_dev_desc_t *host_get_dev(int dev);
 115 int host_get_dev_err(int dev, block_dev_desc_t **blk_devp);
 116
 117 /* disk/part.c */
 118 int get_partition_info (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
 119 void print_part (block_dev_desc_t *dev_desc);
 120 void  init_part (block_dev_desc_t *dev_desc);
 121 void dev_print(block_dev_desc_t *dev_desc);
 122 int get_device(const char *ifname, const char *dev_str,
 123                block_dev_desc_t **dev_desc);
 124 int get_device_and_partition(const char *ifname, const char *dev_part_str,
 125                              block_dev_desc_t **dev_desc,
 126                              disk_partition_t *info, int allow_whole_dev);
 127 #else
 128 static inline block_dev_desc_t *get_dev(const char *ifname, int dev)
 129 { return NULL; }
 130 static inline block_dev_desc_t* ide_get_dev(int dev) { return NULL; }
 131 static inline block_dev_desc_t* sata_get_dev(int dev) { return NULL; }
 132 static inline block_dev_desc_t* scsi_get_dev(int dev) { return NULL; }
 133 static inline block_dev_desc_t* usb_stor_get_dev(int dev) { return NULL; }
 134 static inline block_dev_desc_t* mmc_get_dev(int dev) { return NULL; }
 135 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
 136 static inline block_dev_desc_t* systemace_get_dev(int dev) { return NULL; }
 137 static inline block_dev_desc_t* mg_disk_get_dev(int dev) { return NULL; }
 138 static inline block_dev_desc_t *host_get_dev(int dev) { return NULL; }
 139
 140 static inline int get_partition_info (block_dev_desc_t * dev_desc, int part,
 141         disk_partition_t *info) { return -1; }
 142 static inline void print_part (block_dev_desc_t *dev_desc) {}
 143 static inline void  init_part (block_dev_desc_t *dev_desc) {}
 144 static inline void dev_print(block_dev_desc_t *dev_desc) {}
 145 static inline int get_device(const char *ifname, const char *dev_str,
 146                block_dev_desc_t **dev_desc)
 147 { return -1; }
 148 static inline int get_device_and_partition(const char *ifname,
 149                                            const char *dev_part_str,
 150                                            block_dev_desc_t **dev_desc,
 151                                            disk_partition_t *info,
 152                                            int allow_whole_dev)
 153 { *dev_desc = NULL; return -1; }
 154 #endif
 155
 156 #ifdef CONFIG_MAC_PARTITION
 157 /* disk/part_mac.c */
 158 int get_partition_info_mac (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
 159 void print_part_mac (block_dev_desc_t *dev_desc);
 160 int   test_part_mac (block_dev_desc_t *dev_desc);
 161 #endif
 162
 163 #ifdef CONFIG_DOS_PARTITION
 164 /* disk/part_dos.c */
 165 int get_partition_info_dos (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
 166 void print_part_dos (block_dev_desc_t *dev_desc);
 167 int   test_part_dos (block_dev_desc_t *dev_desc);
 168 #endif
 169
 170 #ifdef CONFIG_ISO_PARTITION
 171 /* disk/part_iso.c */
 172 int get_partition_info_iso (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
 173 void print_part_iso (block_dev_desc_t *dev_desc);
 174 int   test_part_iso (block_dev_desc_t *dev_desc);
 175 #endif
 176
 177 #ifdef CONFIG_AMIGA_PARTITION
 178 /* disk/part_amiga.c */
 179 int get_partition_info_amiga (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
 180 void print_part_amiga (block_dev_desc_t *dev_desc);
 181 int   test_part_amiga (block_dev_desc_t *dev_desc);
 182 #endif
 183
 184 #ifdef CONFIG_EFI_PARTITION
 185 #include <part_efi.h>
 186 /* disk/part_efi.c */
 187 int get_partition_info_efi (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
 188 /**
 189  * get_partition_info_efi_by_name() - Find the specified GPT partition table entry
 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  *
 195  * @return - '0' on match, '-1' on no match, otherwise error
 196  */
 197 int get_partition_info_efi_by_name(block_dev_desc_t *dev_desc,
 198         const char *name, disk_partition_t *info);
 199 void print_part_efi (block_dev_desc_t *dev_desc);
 200 int   test_part_efi (block_dev_desc_t *dev_desc);
 201
 202 /**
 203  * write_gpt_table() - Write the GUID Partition Table to disk
 204  *
 205  * @param dev_desc - block device descriptor
 206  * @param gpt_h - pointer to GPT header representation
 207  * @param gpt_e - pointer to GPT partition table entries
 208  *
 209  * @return - zero on success, otherwise error
 210  */
 211 int write_gpt_table(block_dev_desc_t *dev_desc,
 212                   gpt_header *gpt_h, gpt_entry *gpt_e);
 213
 214 /**
 215  * gpt_fill_pte(): Fill the GPT partition table entry
 216  *
 217  * @param gpt_h - GPT header representation
 218  * @param gpt_e - GPT partition table entries
 219  * @param partitions - list of partitions
 220  * @param parts - number of partitions
 221  *
 222  * @return zero on success
 223  */
 224 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
 225                 disk_partition_t *partitions, int parts);
 226
 227 /**
 228  * gpt_fill_header(): Fill the GPT header
 229  *
 230  * @param dev_desc - block device descriptor
 231  * @param gpt_h - GPT header representation
 232  * @param str_guid - disk guid string representation
 233  * @param parts_count - number of partitions
 234  *
 235  * @return - error on str_guid conversion error
 236  */
 237 int gpt_fill_header(block_dev_desc_t *dev_desc, gpt_header *gpt_h,
 238                 char *str_guid, int parts_count);
 239
 240 /**
 241  * gpt_restore(): Restore GPT partition table
 242  *
 243  * @param dev_desc - block device descriptor
 244  * @param str_disk_guid - disk GUID
 245  * @param partitions - list of partitions
 246  * @param parts - number of partitions
 247  *
 248  * @return zero on success
 249  */
 250 int gpt_restore(block_dev_desc_t *dev_desc, char *str_disk_guid,
 251                 disk_partition_t *partitions, const int parts_count);
 252
 253 /**
 254  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 255  *
 256  * @param dev_desc - block device descriptor
 257  * @param buf - buffer which contains the MBR and Primary GPT info
 258  *
 259  * @return - '0' on success, otherwise error
 260  */
 261 int is_valid_gpt_buf(block_dev_desc_t *dev_desc, void *buf);
 262
 263 /**
 264  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 265  *
 266  * @param dev_desc - block device descriptor
 267  * @param buf - buffer which contains the MBR and Primary GPT info
 268  *
 269  * @return - '0' on success, otherwise error
 270  */
 271 int write_mbr_and_gpt_partitions(block_dev_desc_t *dev_desc, void *buf);
 272
 273 /**
 274  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 275  *                        and partition table entries (PTE)
 276  *
 277  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 278  *
 279  * @param dev_desc - block device descriptor
 280  * @param gpt_head - pointer to GPT header data read from medium
 281  * @param gpt_pte - pointer to GPT partition table enties read from medium
 282  *
 283  * @return - '0' on success, otherwise error
 284  */
 285 int gpt_verify_headers(block_dev_desc_t *dev_desc, gpt_header *gpt_head,
 286                        gpt_entry **gpt_pte);
 287
 288 /**
 289  * gpt_verify_partitions() - Function to check if partitions' name, start and
 290  *                           size correspond to '$partitions' env variable
 291  *
 292  * This function checks if on medium stored GPT data is in sync with information
 293  * provided in '$partitions' environment variable. Specificially, name, start
 294  * and size of the partition is checked.
 295  *
 296  * @param dev_desc - block device descriptor
 297  * @param partitions - partition data read from '$partitions' env variable
 298  * @param parts - number of partitions read from '$partitions' env variable
 299  * @param gpt_head - pointer to GPT header data read from medium
 300  * @param gpt_pte - pointer to GPT partition table enties read from medium
 301  *
 302  * @return - '0' on success, otherwise error
 303  */
 304 int gpt_verify_partitions(block_dev_desc_t *dev_desc,
 305                           disk_partition_t *partitions, int parts,
 306                           gpt_header *gpt_head, gpt_entry **gpt_pte);
 307 #endif
 308
 309 #endif /* _PART_H */