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