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