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