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 133 /** 134 * blk_get_device_part_str() - Get a block device and partition 135 * 136 * This calls blk_get_device_by_str() to look up a device. It also looks up 137 * a partition and returns information about it. 138 * 139 * @dev_part_str is in the format: 140 * <dev>.<hw_part>:<part> where <dev> is the device number, 141 * <hw_part> is the optional hardware partition number and 142 * <part> is the partition number 143 * 144 * If ifname is "hostfs" then this function returns the sandbox host block 145 * device. 146 * 147 * If ifname is ubi, then this function returns 0, with @info set to a 148 * special UBI device. 149 * 150 * If @dev_part_str is NULL or empty or "-", then this function looks up 151 * the "bootdevice" environment variable and uses that string instead. 152 * 153 * If the partition string is empty then the first partition is used. If the 154 * partition string is "auto" then the first bootable partition is used. 155 * 156 * @ifname: Interface name (e.g. "ide", "scsi") 157 * @dev_part_str: Device and partition string 158 * @dev_desc: Returns a pointer to the block device on success 159 * @info: Returns partition information 160 * @allow_whole_dev: true to allow the user to select partition 0 161 * (which means the whole device), false to require a valid 162 * partition number >= 1 163 * @return partition number, or -1 on error 164 * 165 */ 166 int blk_get_device_part_str(const char *ifname, const char *dev_part_str, 167 struct blk_desc **dev_desc, 168 disk_partition_t *info, int allow_whole_dev); 169 #else 170 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev) 171 { return NULL; } 172 static inline struct blk_desc *ide_get_dev(int dev) { return NULL; } 173 static inline struct blk_desc *sata_get_dev(int dev) { return NULL; } 174 static inline struct blk_desc *scsi_get_dev(int dev) { return NULL; } 175 static inline struct blk_desc *usb_stor_get_dev(int dev) { return NULL; } 176 static inline struct blk_desc *mmc_get_dev(int dev) { return NULL; } 177 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; } 178 static inline struct blk_desc *systemace_get_dev(int dev) { return NULL; } 179 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; } 180 static inline struct blk_desc *host_get_dev(int dev) { return NULL; } 181 182 static inline int get_partition_info(struct blk_desc *dev_desc, int part, 183 disk_partition_t *info) { return -1; } 184 static inline void print_part(struct blk_desc *dev_desc) {} 185 static inline void init_part(struct blk_desc *dev_desc) {} 186 static inline void dev_print(struct blk_desc *dev_desc) {} 187 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str, 188 struct blk_desc **dev_desc) 189 { return -1; } 190 static inline int blk_get_device_part_str(const char *ifname, 191 const char *dev_part_str, 192 struct blk_desc **dev_desc, 193 disk_partition_t *info, 194 int allow_whole_dev) 195 { *dev_desc = NULL; return -1; } 196 #endif 197 198 /* 199 * We don't support printing partition information in SPL and only support 200 * getting partition information in a few cases. 201 */ 202 #ifdef CONFIG_SPL_BUILD 203 # define part_print_ptr(x) NULL 204 # if defined(CONFIG_SPL_EXT_SUPPORT) || \ 205 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION) 206 # define part_get_info_ptr(x) x 207 # else 208 # define part_get_info_ptr(x) NULL 209 # endif 210 #else 211 #define part_print_ptr(x) x 212 #define part_get_info_ptr(x) x 213 #endif 214 215 216 struct part_driver { 217 const char *name; 218 int part_type; 219 220 /** 221 * get_info() - Get information about a partition 222 * 223 * @dev_desc: Block device descriptor 224 * @part: Partition number (1 = first) 225 * @info: Returns partition information 226 */ 227 int (*get_info)(struct blk_desc *dev_desc, int part, 228 disk_partition_t *info); 229 230 /** 231 * print() - Print partition information 232 * 233 * @dev_desc: Block device descriptor 234 */ 235 void (*print)(struct blk_desc *dev_desc); 236 237 /** 238 * test() - Test if a device contains this partition type 239 * 240 * @dev_desc: Block device descriptor 241 * @return 0 if the block device appears to contain this partition 242 * type, -ve if not 243 */ 244 int (*test)(struct blk_desc *dev_desc); 245 }; 246 247 /* Declare a new U-Boot partition 'driver' */ 248 #define U_BOOT_PART_TYPE(__name) \ 249 ll_entry_declare(struct part_driver, __name, part_driver) 250 251 #ifdef CONFIG_EFI_PARTITION 252 #include <part_efi.h> 253 /* disk/part_efi.c */ 254 /** 255 * get_partition_info_efi_by_name() - Find the specified GPT partition table entry 256 * 257 * @param dev_desc - block device descriptor 258 * @param gpt_name - the specified table entry name 259 * @param info - returns the disk partition info 260 * 261 * @return - '0' on match, '-1' on no match, otherwise error 262 */ 263 int get_partition_info_efi_by_name(struct blk_desc *dev_desc, 264 const char *name, disk_partition_t *info); 265 266 /** 267 * write_gpt_table() - Write the GUID Partition Table to disk 268 * 269 * @param dev_desc - block device descriptor 270 * @param gpt_h - pointer to GPT header representation 271 * @param gpt_e - pointer to GPT partition table entries 272 * 273 * @return - zero on success, otherwise error 274 */ 275 int write_gpt_table(struct blk_desc *dev_desc, 276 gpt_header *gpt_h, gpt_entry *gpt_e); 277 278 /** 279 * gpt_fill_pte(): Fill the GPT partition table entry 280 * 281 * @param gpt_h - GPT header representation 282 * @param gpt_e - GPT partition table entries 283 * @param partitions - list of partitions 284 * @param parts - number of partitions 285 * 286 * @return zero on success 287 */ 288 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e, 289 disk_partition_t *partitions, int parts); 290 291 /** 292 * gpt_fill_header(): Fill the GPT header 293 * 294 * @param dev_desc - block device descriptor 295 * @param gpt_h - GPT header representation 296 * @param str_guid - disk guid string representation 297 * @param parts_count - number of partitions 298 * 299 * @return - error on str_guid conversion error 300 */ 301 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, 302 char *str_guid, int parts_count); 303 304 /** 305 * gpt_restore(): Restore GPT partition table 306 * 307 * @param dev_desc - block device descriptor 308 * @param str_disk_guid - disk GUID 309 * @param partitions - list of partitions 310 * @param parts - number of partitions 311 * 312 * @return zero on success 313 */ 314 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, 315 disk_partition_t *partitions, const int parts_count); 316 317 /** 318 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid 319 * 320 * @param dev_desc - block device descriptor 321 * @param buf - buffer which contains the MBR and Primary GPT info 322 * 323 * @return - '0' on success, otherwise error 324 */ 325 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); 326 327 /** 328 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT 329 * 330 * @param dev_desc - block device descriptor 331 * @param buf - buffer which contains the MBR and Primary GPT info 332 * 333 * @return - '0' on success, otherwise error 334 */ 335 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); 336 337 /** 338 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header 339 * and partition table entries (PTE) 340 * 341 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data. 342 * 343 * @param dev_desc - block device descriptor 344 * @param gpt_head - pointer to GPT header data read from medium 345 * @param gpt_pte - pointer to GPT partition table enties read from medium 346 * 347 * @return - '0' on success, otherwise error 348 */ 349 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, 350 gpt_entry **gpt_pte); 351 352 /** 353 * gpt_verify_partitions() - Function to check if partitions' name, start and 354 * size correspond to '$partitions' env variable 355 * 356 * This function checks if on medium stored GPT data is in sync with information 357 * provided in '$partitions' environment variable. Specificially, name, start 358 * and size of the partition is checked. 359 * 360 * @param dev_desc - block device descriptor 361 * @param partitions - partition data read from '$partitions' env variable 362 * @param parts - number of partitions read from '$partitions' env variable 363 * @param gpt_head - pointer to GPT header data read from medium 364 * @param gpt_pte - pointer to GPT partition table enties read from medium 365 * 366 * @return - '0' on success, otherwise error 367 */ 368 int gpt_verify_partitions(struct blk_desc *dev_desc, 369 disk_partition_t *partitions, int parts, 370 gpt_header *gpt_head, gpt_entry **gpt_pte); 371 #endif 372 373 #endif /* _PART_H */ 374