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