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