git.sur5r.net Git - u-boot/blob - 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
  12 struct blk_desc {
  13         int             if_type;        /* type of the interface */
  14         int             dev;            /* device number */
  15         unsigned char   part_type;      /* partition type */
  16         unsigned char   target;         /* target SCSI ID */
  17         unsigned char   lun;            /* target LUN */
  18         unsigned char   hwpart;         /* HW partition, e.g. for eMMC */
  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)(struct blk_desc *block_dev,
  31                                       lbaint_t start,
  32                                       lbaint_t blkcnt,
  33                                       void *buffer);
  34         unsigned long   (*block_write)(struct blk_desc *block_dev,
  35                                        lbaint_t start,
  36                                        lbaint_t blkcnt,
  37                                        const void *buffer);
  38         unsigned long   (*block_erase)(struct blk_desc *block_dev,
  39                                        lbaint_t start,
  40                                        lbaint_t blkcnt);
  41         void            *priv;          /* driver private struct pointer */
  42 };
  43
  44 #define BLOCK_CNT(size, blk_desc) (PAD_COUNT(size, blk_desc->blksz))
  45 #define PAD_TO_BLOCKSIZE(size, blk_desc) \
  46         (PAD_SIZE(size, blk_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 struct blk_desc *get_dev(const char *ifname, int dev);
 104 struct blk_desc *ide_get_dev(int dev);
 105 struct blk_desc *sata_get_dev(int dev);
 106 struct blk_desc *scsi_get_dev(int dev);
 107 struct blk_desc *usb_stor_get_dev(int dev);
 108 struct blk_desc *mmc_get_dev(int dev);
 109 int mmc_select_hwpart(int dev_num, int hwpart);
 110 struct blk_desc *systemace_get_dev(int dev);
 111 struct blk_desc *mg_disk_get_dev(int dev);
 112 struct blk_desc *host_get_dev(int dev);
 113 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
 114
 115 /* disk/part.c */
 116 int get_partition_info(struct blk_desc *dev_desc, int part,
 117                        disk_partition_t *info);
 118 void print_part(struct blk_desc *dev_desc);
 119 void init_part(struct blk_desc *dev_desc);
 120 void dev_print(struct blk_desc *dev_desc);
 121 int get_device(const char *ifname, const char *dev_str,
 122                struct blk_desc **dev_desc);
 123 int get_device_and_partition(const char *ifname, const char *dev_part_str,
 124                              struct blk_desc **dev_desc,
 125                              disk_partition_t *info, int allow_whole_dev);
 126 #else
 127 static inline struct blk_desc *get_dev(const char *ifname, int dev)
 128 { return NULL; }
 129 static inline struct blk_desc *ide_get_dev(int dev) { return NULL; }
 130 static inline struct blk_desc *sata_get_dev(int dev) { return NULL; }
 131 static inline struct blk_desc *scsi_get_dev(int dev) { return NULL; }
 132 static inline struct blk_desc *usb_stor_get_dev(int dev) { return NULL; }
 133 static inline struct blk_desc *mmc_get_dev(int dev) { return NULL; }
 134 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
 135 static inline struct blk_desc *systemace_get_dev(int dev) { return NULL; }
 136 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
 137 static inline struct blk_desc *host_get_dev(int dev) { return NULL; }
 138
 139 static inline int get_partition_info(struct blk_desc *dev_desc, int part,
 140                                      disk_partition_t *info) { return -1; }
 141 static inline void print_part(struct blk_desc *dev_desc) {}
 142 static inline void init_part(struct blk_desc *dev_desc) {}
 143 static inline void dev_print(struct blk_desc *dev_desc) {}
 144 static inline int get_device(const char *ifname, const char *dev_str,
 145                              struct blk_desc **dev_desc)
 146 { return -1; }
 147 static inline int get_device_and_partition(const char *ifname,
 148                                            const char *dev_part_str,
 149                                            struct blk_desc **dev_desc,
 150                                            disk_partition_t *info,
 151                                            int allow_whole_dev)
 152 { *dev_desc = NULL; return -1; }
 153 #endif
 154
 155 #ifdef CONFIG_MAC_PARTITION
 156 /* disk/part_mac.c */
 157 int get_partition_info_mac(struct blk_desc *dev_desc, int part,
 158                            disk_partition_t *info);
 159 void print_part_mac(struct blk_desc *dev_desc);
 160 int test_part_mac(struct blk_desc *dev_desc);
 161 #endif
 162
 163 #ifdef CONFIG_DOS_PARTITION
 164 /* disk/part_dos.c */
 165 int get_partition_info_dos(struct blk_desc *dev_desc, int part,
 166                            disk_partition_t *info);
 167 void print_part_dos(struct blk_desc *dev_desc);
 168 int test_part_dos(struct blk_desc *dev_desc);
 169 #endif
 170
 171 #ifdef CONFIG_ISO_PARTITION
 172 /* disk/part_iso.c */
 173 int get_partition_info_iso(struct blk_desc *dev_desc, int part,
 174                            disk_partition_t *info);
 175 void print_part_iso(struct blk_desc *dev_desc);
 176 int test_part_iso(struct blk_desc *dev_desc);
 177 #endif
 178
 179 #ifdef CONFIG_AMIGA_PARTITION
 180 /* disk/part_amiga.c */
 181 int get_partition_info_amiga(struct blk_desc *dev_desc, int part,
 182                              disk_partition_t *info);
 183 void print_part_amiga(struct blk_desc *dev_desc);
 184 int test_part_amiga(struct blk_desc *dev_desc);
 185 #endif
 186
 187 #ifdef CONFIG_EFI_PARTITION
 188 #include <part_efi.h>
 189 /* disk/part_efi.c */
 190 int get_partition_info_efi(struct blk_desc *dev_desc, int part,
 191                            disk_partition_t *info);
 192 /**
 193  * get_partition_info_efi_by_name() - Find the specified GPT partition table entry
 194  *
 195  * @param dev_desc - block device descriptor
 196  * @param gpt_name - the specified table entry name
 197  * @param info - returns the disk partition info
 198  *
 199  * @return - '0' on match, '-1' on no match, otherwise error
 200  */
 201 int get_partition_info_efi_by_name(struct blk_desc *dev_desc,
 202         const char *name, disk_partition_t *info);
 203 void print_part_efi(struct blk_desc *dev_desc);
 204 int test_part_efi(struct blk_desc *dev_desc);
 205
 206 /**
 207  * write_gpt_table() - Write the GUID Partition Table to disk
 208  *
 209  * @param dev_desc - block device descriptor
 210  * @param gpt_h - pointer to GPT header representation
 211  * @param gpt_e - pointer to GPT partition table entries
 212  *
 213  * @return - zero on success, otherwise error
 214  */
 215 int write_gpt_table(struct blk_desc *dev_desc,
 216                   gpt_header *gpt_h, gpt_entry *gpt_e);
 217
 218 /**
 219  * gpt_fill_pte(): Fill the GPT partition table entry
 220  *
 221  * @param gpt_h - GPT header representation
 222  * @param gpt_e - GPT partition table entries
 223  * @param partitions - list of partitions
 224  * @param parts - number of partitions
 225  *
 226  * @return zero on success
 227  */
 228 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
 229                 disk_partition_t *partitions, int parts);
 230
 231 /**
 232  * gpt_fill_header(): Fill the GPT header
 233  *
 234  * @param dev_desc - block device descriptor
 235  * @param gpt_h - GPT header representation
 236  * @param str_guid - disk guid string representation
 237  * @param parts_count - number of partitions
 238  *
 239  * @return - error on str_guid conversion error
 240  */
 241 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 242                 char *str_guid, int parts_count);
 243
 244 /**
 245  * gpt_restore(): Restore GPT partition table
 246  *
 247  * @param dev_desc - block device descriptor
 248  * @param str_disk_guid - disk GUID
 249  * @param partitions - list of partitions
 250  * @param parts - number of partitions
 251  *
 252  * @return zero on success
 253  */
 254 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 255                 disk_partition_t *partitions, const int parts_count);
 256
 257 /**
 258  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
 259  *
 260  * @param dev_desc - block device descriptor
 261  * @param buf - buffer which contains the MBR and Primary GPT info
 262  *
 263  * @return - '0' on success, otherwise error
 264  */
 265 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
 266
 267 /**
 268  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
 269  *
 270  * @param dev_desc - block device descriptor
 271  * @param buf - buffer which contains the MBR and Primary GPT info
 272  *
 273  * @return - '0' on success, otherwise error
 274  */
 275 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
 276
 277 /**
 278  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
 279  *                        and partition table entries (PTE)
 280  *
 281  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
 282  *
 283  * @param dev_desc - block device descriptor
 284  * @param gpt_head - pointer to GPT header data read from medium
 285  * @param gpt_pte - pointer to GPT partition table enties read from medium
 286  *
 287  * @return - '0' on success, otherwise error
 288  */
 289 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 290                        gpt_entry **gpt_pte);
 291
 292 /**
 293  * gpt_verify_partitions() - Function to check if partitions' name, start and
 294  *                           size correspond to '$partitions' env variable
 295  *
 296  * This function checks if on medium stored GPT data is in sync with information
 297  * provided in '$partitions' environment variable. Specificially, name, start
 298  * and size of the partition is checked.
 299  *
 300  * @param dev_desc - block device descriptor
 301  * @param partitions - partition data read from '$partitions' env variable
 302  * @param parts - number of partitions read from '$partitions' env variable
 303  * @param gpt_head - pointer to GPT header data read from medium
 304  * @param gpt_pte - pointer to GPT partition table enties read from medium
 305  *
 306  * @return - '0' on success, otherwise error
 307  */
 308 int gpt_verify_partitions(struct blk_desc *dev_desc,
 309                           disk_partition_t *partitions, int parts,
 310                           gpt_header *gpt_head, gpt_entry **gpt_pte);
 311 #endif
 312
 313 #endif /* _PART_H */