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 #include <uuid.h> 13 #include <linux/list.h> 14 15 struct block_drvr { 16 char *name; 17 int (*select_hwpart)(int dev_num, int hwpart); 18 }; 19 20 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \ 21 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \ 22 ((x & 0xffff0000) ? 16 : 0)) 23 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1)) 24 25 /* Part types */ 26 #define PART_TYPE_UNKNOWN 0x00 27 #define PART_TYPE_MAC 0x01 28 #define PART_TYPE_DOS 0x02 29 #define PART_TYPE_ISO 0x03 30 #define PART_TYPE_AMIGA 0x04 31 #define PART_TYPE_EFI 0x05 32 #define PART_TYPE_RKPARM 0x06 33 #define PART_TYPE_RKRAM 0x07 34 #define PART_TYPE_ENV 0x08 35 36 /* maximum number of partition entries supported by search */ 37 #define DOS_ENTRY_NUMBERS 8 38 #define ISO_ENTRY_NUMBERS 64 39 #define MAC_ENTRY_NUMBERS 64 40 #define AMIGA_ENTRY_NUMBERS 8 41 #define RKPARM_ENTRY_NUMBERS 128 42 #define RKRAM_ENTRY_NUMBERS 6 43 #define ENV_ENTRY_NUMBERS 64 44 45 /* 46 * Type string for U-Boot bootable partitions 47 */ 48 #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */ 49 #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */ 50 51 /* device types */ 52 #define DEV_TYPE_UNKNOWN 0xff /* not connected */ 53 #define DEV_TYPE_HARDDISK 0x00 /* harddisk */ 54 #define DEV_TYPE_TAPE 0x01 /* Tape */ 55 #define DEV_TYPE_CDROM 0x05 /* CD-ROM */ 56 #define DEV_TYPE_OPDISK 0x07 /* optical disk */ 57 58 #define PART_NAME_LEN 32 59 #define PART_TYPE_LEN 32 60 #define MAX_SEARCH_PARTITIONS 64 61 62 typedef struct disk_partition { 63 lbaint_t start; /* # of first block in partition */ 64 lbaint_t size; /* number of blocks in partition */ 65 ulong blksz; /* block size in bytes */ 66 uchar name[PART_NAME_LEN]; /* partition name */ 67 uchar type[PART_TYPE_LEN]; /* string type description */ 68 int bootable; /* Active/Bootable flag is set */ 69 #if CONFIG_IS_ENABLED(PARTITION_UUIDS) 70 char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */ 71 #endif 72 #ifdef CONFIG_PARTITION_TYPE_GUID 73 char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */ 74 #endif 75 #ifdef CONFIG_DOS_PARTITION 76 uchar sys_ind; /* partition type */ 77 #endif 78 } disk_partition_t; 79 80 struct disk_part { 81 int partnum; 82 disk_partition_t gpt_part_info; 83 struct list_head list; 84 }; 85 86 /* Misc _get_dev functions */ 87 #ifdef CONFIG_PARTITIONS 88 /** 89 * blk_get_dev() - get a pointer to a block device given its type and number 90 * 91 * Each interface allocates its own devices and typically struct blk_desc is 92 * contained with the interface's data structure. There is no global 93 * numbering for block devices, so the interface name must be provided. 94 * 95 * @ifname: Interface name (e.g. "ide", "scsi") 96 * @dev: Device number (0 for first device on that interface, 1 for 97 * second, etc. 98 * @return pointer to the block device, or NULL if not available, or an 99 * error occurred. 100 */ 101 struct blk_desc *blk_get_dev(const char *ifname, int dev); 102 103 struct blk_desc *mg_disk_get_dev(int dev); 104 int host_get_dev_err(int dev, struct blk_desc **blk_devp); 105 106 /* disk/part.c */ 107 int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info); 108 /** 109 * part_get_info_whole_disk() - get partition info for the special case of 110 * a partition occupying the entire disk. 111 */ 112 int part_get_info_whole_disk(struct blk_desc *dev_desc, disk_partition_t *info); 113 const char *part_get_type(struct blk_desc *dev_desc); 114 void part_print(struct blk_desc *dev_desc); 115 void part_init(struct blk_desc *dev_desc); 116 void dev_print(struct blk_desc *dev_desc); 117 118 /** 119 * blk_get_device_by_str() - Get a block device given its interface/hw partition 120 * 121 * Each interface allocates its own devices and typically struct blk_desc is 122 * contained with the interface's data structure. There is no global 123 * numbering for block devices, so the interface name must be provided. 124 * 125 * The hardware parition is not related to the normal software partitioning 126 * of a device - each hardware partition is effectively a separately 127 * accessible block device. When a hardware parition is selected on MMC the 128 * other hardware partitions become inaccessible. The same block device is 129 * used to access all hardware partitions, but its capacity may change when a 130 * different hardware partition is selected. 131 * 132 * When a hardware partition number is given, the block device switches to 133 * that hardware partition. 134 * 135 * @ifname: Interface name (e.g. "ide", "scsi") 136 * @dev_str: Device and optional hw partition. This can either be a string 137 * containing the device number (e.g. "2") or the device number 138 * and hardware partition number (e.g. "2.4") for devices that 139 * support it (currently only MMC). 140 * @dev_desc: Returns a pointer to the block device on success 141 * @return block device number (local to the interface), or -1 on error 142 */ 143 int blk_get_device_by_str(const char *ifname, const char *dev_str, 144 struct blk_desc **dev_desc); 145 146 /** 147 * blk_get_device_part_str() - Get a block device and partition 148 * 149 * This calls blk_get_device_by_str() to look up a device. It also looks up 150 * a partition and returns information about it. 151 * 152 * @dev_part_str is in the format: 153 * <dev>.<hw_part>:<part> where <dev> is the device number, 154 * <hw_part> is the optional hardware partition number and 155 * <part> is the partition number 156 * 157 * If ifname is "hostfs" then this function returns the sandbox host block 158 * device. 159 * 160 * If ifname is ubi, then this function returns 0, with @info set to a 161 * special UBI device. 162 * 163 * If @dev_part_str is NULL or empty or "-", then this function looks up 164 * the "bootdevice" environment variable and uses that string instead. 165 * 166 * If the partition string is empty then the first partition is used. If the 167 * partition string is "auto" then the first bootable partition is used. 168 * 169 * @ifname: Interface name (e.g. "ide", "scsi") 170 * @dev_part_str: Device and partition string 171 * @dev_desc: Returns a pointer to the block device on success 172 * @info: Returns partition information 173 * @allow_whole_dev: true to allow the user to select partition 0 174 * (which means the whole device), false to require a valid 175 * partition number >= 1 176 * @return partition number, or -1 on error 177 * 178 */ 179 int blk_get_device_part_str(const char *ifname, const char *dev_part_str, 180 struct blk_desc **dev_desc, 181 disk_partition_t *info, int allow_whole_dev); 182 183 /** 184 * part_get_info_by_name() - Search for a partition by name 185 * among all available registered partitions 186 * 187 * @param dev_desc - block device descriptor 188 * @param gpt_name - the specified table entry name 189 * @param info - returns the disk partition info 190 * 191 * @return - the partition number on match (starting on 1), -1 on no match, 192 * otherwise error 193 */ 194 int part_get_info_by_name(struct blk_desc *dev_desc, 195 const char *name, disk_partition_t *info); 196 197 /** 198 * part_get_info_by_name_strict() - Search for a partition by name 199 * among all available registered partitions 200 * with strict name match 201 * 202 * @param dev_desc - block device descriptor 203 * @param gpt_name - the specified table entry name to be match strictly 204 * @param info - returns the disk partition info 205 * 206 * @return - the partition number on match (starting on 1), -1 on no match, 207 * otherwise error 208 */ 209 int part_get_info_by_name_strict(struct blk_desc *dev_desc, const char *name, 210 disk_partition_t *info); 211 /** 212 * part_set_generic_name() - create generic partition like hda1 or sdb2 213 * 214 * Helper function for partition tables, which don't hold partition names 215 * (DOS, ISO). Generates partition name out of the device type and partition 216 * number. 217 * 218 * @dev_desc: pointer to the block device 219 * @part_num: partition number for which the name is generated 220 * @name: buffer where the name is written 221 */ 222 void part_set_generic_name(const struct blk_desc *dev_desc, 223 int part_num, char *name); 224 225 extern const struct block_drvr block_drvr[]; 226 #else 227 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev) 228 { return NULL; } 229 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; } 230 231 static inline int part_get_info(struct blk_desc *dev_desc, int part, 232 disk_partition_t *info) { return -1; } 233 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc, 234 disk_partition_t *info) 235 { return -1; } 236 237 static inline const char *part_get_type(struct blk_desc *dev_desc) { return NULL; } 238 static inline void part_print(struct blk_desc *dev_desc) {} 239 static inline void part_init(struct blk_desc *dev_desc) {} 240 static inline void dev_print(struct blk_desc *dev_desc) {} 241 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str, 242 struct blk_desc **dev_desc) 243 { return -1; } 244 static inline int blk_get_device_part_str(const char *ifname, 245 const char *dev_part_str, 246 struct blk_desc **dev_desc, 247 disk_partition_t *info, 248 int allow_whole_dev) 249 { *dev_desc = NULL; return -1; } 250 #endif 251 252 /* 253 * We don't support printing partition information in SPL. 254 */ 255 #ifdef CONFIG_SPL_BUILD 256 #define part_print_ptr(x) NULL 257 #else 258 #define part_print_ptr(x) x 259 #endif 260 261 #define part_get_info_ptr(x) x 262 263 264 struct part_driver { 265 const char *name; 266 int part_type; 267 const int max_entries; /* maximum number of entries to search */ 268 269 /** 270 * get_info() - Get information about a partition 271 * 272 * @dev_desc: Block device descriptor 273 * @part: Partition number (1 = first) 274 * @info: Returns partition information 275 */ 276 int (*get_info)(struct blk_desc *dev_desc, int part, 277 disk_partition_t *info); 278 279 /** 280 * print() - Print partition information 281 * 282 * @dev_desc: Block device descriptor 283 */ 284 void (*print)(struct blk_desc *dev_desc); 285 286 /** 287 * test() - Test if a device contains this partition type 288 * 289 * @dev_desc: Block device descriptor 290 * @return 0 if the block device appears to contain this partition 291 * type, -ve if not 292 */ 293 int (*test)(struct blk_desc *dev_desc); 294 }; 295 296 /* Declare a new U-Boot partition 'driver' */ 297 #define U_BOOT_PART_TYPE(__name) \ 298 ll_entry_declare(struct part_driver, __name, part_driver) 299 300 #include <part_efi.h> 301 302 #if CONFIG_IS_ENABLED(EFI_PARTITION) 303 /* disk/part_efi.c */ 304 /** 305 * write_gpt_table() - Write the GUID Partition Table to disk 306 * 307 * @param dev_desc - block device descriptor 308 * @param gpt_h - pointer to GPT header representation 309 * @param gpt_e - pointer to GPT partition table entries 310 * 311 * @return - zero on success, otherwise error 312 */ 313 int write_gpt_table(struct blk_desc *dev_desc, 314 gpt_header *gpt_h, gpt_entry *gpt_e); 315 316 /** 317 * gpt_fill_pte(): Fill the GPT partition table entry 318 * 319 * @param dev_desc - block device descriptor 320 * @param gpt_h - GPT header representation 321 * @param gpt_e - GPT partition table entries 322 * @param partitions - list of partitions 323 * @param parts - number of partitions 324 * 325 * @return zero on success 326 */ 327 int gpt_fill_pte(struct blk_desc *dev_desc, 328 gpt_header *gpt_h, gpt_entry *gpt_e, 329 disk_partition_t *partitions, int parts); 330 331 /** 332 * gpt_fill_header(): Fill the GPT header 333 * 334 * @param dev_desc - block device descriptor 335 * @param gpt_h - GPT header representation 336 * @param str_guid - disk guid string representation 337 * @param parts_count - number of partitions 338 * 339 * @return - error on str_guid conversion error 340 */ 341 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, 342 char *str_guid, int parts_count); 343 344 /** 345 * gpt_restore(): Restore GPT partition table 346 * 347 * @param dev_desc - block device descriptor 348 * @param str_disk_guid - disk GUID 349 * @param partitions - list of partitions 350 * @param parts - number of partitions 351 * 352 * @return zero on success 353 */ 354 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, 355 disk_partition_t *partitions, const int parts_count); 356 357 /** 358 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid 359 * 360 * @param dev_desc - block device descriptor 361 * @param buf - buffer which contains the MBR and Primary GPT info 362 * 363 * @return - '0' on success, otherwise error 364 */ 365 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); 366 367 /** 368 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT 369 * 370 * @param dev_desc - block device descriptor 371 * @param buf - buffer which contains the MBR and Primary GPT info 372 * 373 * @return - '0' on success, otherwise error 374 */ 375 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); 376 377 /** 378 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header 379 * and partition table entries (PTE) 380 * 381 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data. 382 * 383 * @param dev_desc - block device descriptor 384 * @param gpt_head - pointer to GPT header data read from medium 385 * @param gpt_pte - pointer to GPT partition table enties read from medium 386 * 387 * @return - '0' on success, otherwise error 388 */ 389 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, 390 gpt_entry **gpt_pte); 391 392 /** 393 * gpt_verify_partitions() - Function to check if partitions' name, start and 394 * size correspond to '$partitions' env variable 395 * 396 * This function checks if on medium stored GPT data is in sync with information 397 * provided in '$partitions' environment variable. Specificially, name, start 398 * and size of the partition is checked. 399 * 400 * @param dev_desc - block device descriptor 401 * @param partitions - partition data read from '$partitions' env variable 402 * @param parts - number of partitions read from '$partitions' env variable 403 * @param gpt_head - pointer to GPT header data read from medium 404 * @param gpt_pte - pointer to GPT partition table enties read from medium 405 * 406 * @return - '0' on success, otherwise error 407 */ 408 int gpt_verify_partitions(struct blk_desc *dev_desc, 409 disk_partition_t *partitions, int parts, 410 gpt_header *gpt_head, gpt_entry **gpt_pte); 411 412 413 /** 414 * get_disk_guid() - Function to read the GUID string from a device's GPT 415 * 416 * This function reads the GUID string from a block device whose descriptor 417 * is provided. 418 * 419 * @param dev_desc - block device descriptor 420 * @param guid - pre-allocated string in which to return the GUID 421 * 422 * @return - '0' on success, otherwise error 423 */ 424 int get_disk_guid(struct blk_desc *dev_desc, char *guid); 425 426 #endif 427 428 #if CONFIG_IS_ENABLED(DOS_PARTITION) 429 /** 430 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid 431 * 432 * @param buf - buffer which contains the MBR 433 * 434 * @return - '0' on success, otherwise error 435 */ 436 int is_valid_dos_buf(void *buf); 437 438 /** 439 * write_mbr_partition() - write DOS MBR 440 * 441 * @param dev_desc - block device descriptor 442 * @param buf - buffer which contains the MBR 443 * 444 * @return - '0' on success, otherwise error 445 */ 446 int write_mbr_partition(struct blk_desc *dev_desc, void *buf); 447 448 #endif 449 450 #if CONFIG_IS_ENABLED(ENV_PARTITION) 451 /** 452 * env_part_list_init() - pass partitons list to env part 453 * 454 * @param list - partitons list 455 */ 456 void env_part_list_init(const char *list); 457 #endif 458 459 #endif /* _PART_H */ 460