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