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