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