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