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