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