1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2000-2004
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
12 #include <linker_lists.h>
13 #include <linux/errno.h>
14 #include <linux/list.h>
18 int (*select_hwpart)(int dev_num, int hwpart);
21 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
22 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
23 ((x & 0xffff0000) ? 16 : 0))
24 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
27 #define PART_TYPE_UNKNOWN 0x00
28 #define PART_TYPE_MAC 0x01
29 #define PART_TYPE_DOS 0x02
30 #define PART_TYPE_ISO 0x03
31 #define PART_TYPE_AMIGA 0x04
32 #define PART_TYPE_EFI 0x05
34 /* maximum number of partition entries supported by search */
35 #define DOS_ENTRY_NUMBERS 8
36 #define ISO_ENTRY_NUMBERS 64
37 #define MAC_ENTRY_NUMBERS 64
38 #define AMIGA_ENTRY_NUMBERS 8
40 * Type string for U-Boot bootable partitions
42 #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
43 #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
46 #define DEV_TYPE_UNKNOWN 0xff /* not connected */
47 #define DEV_TYPE_HARDDISK 0x00 /* harddisk */
48 #define DEV_TYPE_TAPE 0x01 /* Tape */
49 #define DEV_TYPE_CDROM 0x05 /* CD-ROM */
50 #define DEV_TYPE_OPDISK 0x07 /* optical disk */
52 #define PART_NAME_LEN 32
53 #define PART_TYPE_LEN 32
54 #define MAX_SEARCH_PARTITIONS 128
56 #define PART_BOOTABLE ((int)BIT(0))
57 #define PART_EFI_SYSTEM_PARTITION ((int)BIT(1))
59 struct disk_partition {
60 lbaint_t start; /* # of first block in partition */
61 lbaint_t size; /* number of blocks in partition */
62 ulong blksz; /* block size in bytes */
63 uchar name[PART_NAME_LEN]; /* partition name */
64 uchar type[PART_TYPE_LEN]; /* string type description */
66 * The bootable is a bitmask with the following fields:
68 * PART_BOOTABLE the MBR bootable flag is set
69 * PART_EFI_SYSTEM_PARTITION the partition is an EFI system partition
72 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
73 char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
75 #ifdef CONFIG_PARTITION_TYPE_GUID
76 char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */
78 #ifdef CONFIG_DOS_PARTITION
79 uchar sys_ind; /* partition type */
85 struct disk_partition gpt_part_info;
86 struct list_head list;
89 /* Misc _get_dev functions */
90 #ifdef CONFIG_PARTITIONS
92 * blk_get_dev() - get a pointer to a block device given its type and number
94 * Each interface allocates its own devices and typically struct blk_desc is
95 * contained with the interface's data structure. There is no global
96 * numbering for block devices, so the interface name must be provided.
98 * @ifname: Interface name (e.g. "ide", "scsi")
99 * @dev: Device number (0 for first device on that interface, 1 for
101 * Return: pointer to the block device, or NULL if not available, or an
104 struct blk_desc *blk_get_dev(const char *ifname, int dev);
106 struct blk_desc *mg_disk_get_dev(int dev);
107 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
110 int part_get_info(struct blk_desc *dev_desc, int part,
111 struct disk_partition *info);
113 * part_get_info_whole_disk() - get partition info for the special case of
114 * a partition occupying the entire disk.
116 int part_get_info_whole_disk(struct blk_desc *dev_desc,
117 struct disk_partition *info);
119 void part_print(struct blk_desc *dev_desc);
120 void part_init(struct blk_desc *dev_desc);
121 void dev_print(struct blk_desc *dev_desc);
124 * blk_get_device_by_str() - Get a block device given its interface/hw partition
126 * Each interface allocates its own devices and typically struct blk_desc is
127 * contained with the interface's data structure. There is no global
128 * numbering for block devices, so the interface name must be provided.
130 * The hardware parition is not related to the normal software partitioning
131 * of a device - each hardware partition is effectively a separately
132 * accessible block device. When a hardware parition is selected on MMC the
133 * other hardware partitions become inaccessible. The same block device is
134 * used to access all hardware partitions, but its capacity may change when a
135 * different hardware partition is selected.
137 * When a hardware partition number is given, the block device switches to
138 * that hardware partition.
140 * @ifname: Interface name (e.g. "ide", "scsi")
141 * @dev_str: Device and optional hw partition. This can either be a string
142 * containing the device number (e.g. "2") or the device number
143 * and hardware partition number (e.g. "2.4") for devices that
144 * support it (currently only MMC).
145 * @dev_desc: Returns a pointer to the block device on success
146 * Return: block device number (local to the interface), or -1 on error
148 int blk_get_device_by_str(const char *ifname, const char *dev_str,
149 struct blk_desc **dev_desc);
152 * blk_get_device_part_str() - Get a block device and partition
154 * This calls blk_get_device_by_str() to look up a device. It also looks up
155 * a partition and returns information about it.
157 * @dev_part_str is in the format:
158 * <dev>.<hw_part>:<part> where <dev> is the device number,
159 * <hw_part> is the optional hardware partition number and
160 * <part> is the partition number
162 * If ifname is "hostfs" then this function returns the sandbox host block
165 * If ifname is ubi, then this function returns 0, with @info set to a
166 * special UBI device.
168 * If @dev_part_str is NULL or empty or "-", then this function looks up
169 * the "bootdevice" environment variable and uses that string instead.
171 * If the partition string is empty then the first partition is used. If the
172 * partition string is "auto" then the first bootable partition is used.
174 * @ifname: Interface name (e.g. "ide", "scsi")
175 * @dev_part_str: Device and partition string
176 * @dev_desc: Returns a pointer to the block device on success
177 * @info: Returns partition information
178 * @allow_whole_dev: true to allow the user to select partition 0
179 * (which means the whole device), false to require a valid
180 * partition number >= 1
181 * Return: partition number, or -1 on error
184 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
185 struct blk_desc **dev_desc,
186 struct disk_partition *info, int allow_whole_dev);
189 * part_get_info_by_name_type() - Search for a partition by name
190 * for only specified partition type
192 * @param dev_desc - block device descriptor
193 * @param gpt_name - the specified table entry name
194 * @param info - returns the disk partition info
195 * @param part_type - only search in partitions of this type
197 * Return: - the partition number on match (starting on 1), -1 on no match,
200 int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
201 struct disk_partition *info, int part_type);
204 * part_get_info_by_name() - Search for a partition by name
205 * among all available registered partitions
207 * @param dev_desc - block device descriptor
208 * @param gpt_name - the specified table entry name
209 * @param info - returns the disk partition info
211 * Return: - the partition number on match (starting on 1), -1 on no match,
214 int part_get_info_by_name(struct blk_desc *dev_desc,
215 const char *name, struct disk_partition *info);
218 * Get partition info from dev number + part name, or dev number + part number.
220 * Parse a device number and partition description (either name or number)
221 * in the form of device number plus partition name separated by a "#"
222 * (like "device_num#partition_name") or a device number plus a partition number
223 * separated by a ":". For example both "0#misc" and "0:1" can be valid
224 * partition descriptions for a given interface. If the partition is found, sets
225 * dev_desc and part_info accordingly with the information of the partition.
227 * @param[in] dev_iface Device interface
228 * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
229 * @param[out] dev_desc Place to store the device description pointer
230 * @param[out] part_info Place to store the partition information
231 * @param[in] allow_whole_dev true to allow the user to select partition 0
232 * (which means the whole device), false to require a valid
233 * partition number >= 1
234 * Return: the partition number on success, or negative errno on error
236 int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
237 const char *dev_part_str,
238 struct blk_desc **dev_desc,
239 struct disk_partition *part_info,
240 int allow_whole_dev);
243 * part_set_generic_name() - create generic partition like hda1 or sdb2
245 * Helper function for partition tables, which don't hold partition names
246 * (DOS, ISO). Generates partition name out of the device type and partition
249 * @dev_desc: pointer to the block device
250 * @part_num: partition number for which the name is generated
251 * @name: buffer where the name is written
253 void part_set_generic_name(const struct blk_desc *dev_desc,
254 int part_num, char *name);
256 extern const struct block_drvr block_drvr[];
258 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
260 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
262 static inline int part_get_info(struct blk_desc *dev_desc, int part,
263 struct disk_partition *info) { return -1; }
264 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
265 struct disk_partition *info)
267 static inline void part_print(struct blk_desc *dev_desc) {}
268 static inline void part_init(struct blk_desc *dev_desc) {}
269 static inline void dev_print(struct blk_desc *dev_desc) {}
270 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
271 struct blk_desc **dev_desc)
273 static inline int blk_get_device_part_str(const char *ifname,
274 const char *dev_part_str,
275 struct blk_desc **dev_desc,
276 struct disk_partition *info,
278 { *dev_desc = NULL; return -1; }
280 part_get_info_by_dev_and_name_or_num(const char *dev_iface,
281 const char *dev_part_str,
282 struct blk_desc **dev_desc,
283 struct disk_partition *part_info,
292 * We don't support printing partition information in SPL and only support
293 * getting partition information in a few cases.
295 #ifdef CONFIG_SPL_BUILD
296 # define part_print_ptr(x) NULL
297 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
298 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
299 # define part_get_info_ptr(x) x
301 # define part_get_info_ptr(x) NULL
304 #define part_print_ptr(x) x
305 #define part_get_info_ptr(x) x
312 const int max_entries; /* maximum number of entries to search */
315 * get_info() - Get information about a partition
317 * @dev_desc: Block device descriptor
318 * @part: Partition number (1 = first)
319 * @info: Returns partition information
321 int (*get_info)(struct blk_desc *dev_desc, int part,
322 struct disk_partition *info);
325 * print() - Print partition information
327 * @dev_desc: Block device descriptor
329 void (*print)(struct blk_desc *dev_desc);
332 * test() - Test if a device contains this partition type
334 * @dev_desc: Block device descriptor
335 * @return 0 if the block device appears to contain this partition
338 int (*test)(struct blk_desc *dev_desc);
341 /* Declare a new U-Boot partition 'driver' */
342 #define U_BOOT_PART_TYPE(__name) \
343 ll_entry_declare(struct part_driver, __name, part_driver)
345 #include <part_efi.h>
347 #if CONFIG_IS_ENABLED(EFI_PARTITION)
348 /* disk/part_efi.c */
350 * write_gpt_table() - Write the GUID Partition Table to disk
352 * @param dev_desc - block device descriptor
353 * @param gpt_h - pointer to GPT header representation
354 * @param gpt_e - pointer to GPT partition table entries
356 * Return: - zero on success, otherwise error
358 int write_gpt_table(struct blk_desc *dev_desc,
359 gpt_header *gpt_h, gpt_entry *gpt_e);
362 * gpt_fill_pte(): Fill the GPT partition table entry
364 * @param dev_desc - block device descriptor
365 * @param gpt_h - GPT header representation
366 * @param gpt_e - GPT partition table entries
367 * @param partitions - list of partitions
368 * @param parts - number of partitions
370 * Return: zero on success
372 int gpt_fill_pte(struct blk_desc *dev_desc,
373 gpt_header *gpt_h, gpt_entry *gpt_e,
374 struct disk_partition *partitions, int parts);
377 * gpt_fill_header(): Fill the GPT header
379 * @param dev_desc - block device descriptor
380 * @param gpt_h - GPT header representation
381 * @param str_guid - disk guid string representation
382 * @param parts_count - number of partitions
384 * Return: - error on str_guid conversion error
386 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
387 char *str_guid, int parts_count);
390 * gpt_restore(): Restore GPT partition table
392 * @param dev_desc - block device descriptor
393 * @param str_disk_guid - disk GUID
394 * @param partitions - list of partitions
395 * @param parts - number of partitions
397 * Return: zero on success
399 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
400 struct disk_partition *partitions, const int parts_count);
403 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
405 * @param dev_desc - block device descriptor
406 * @param buf - buffer which contains the MBR and Primary GPT info
408 * Return: - '0' on success, otherwise error
410 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
413 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
415 * @param dev_desc - block device descriptor
416 * @param buf - buffer which contains the MBR and Primary GPT info
418 * Return: - '0' on success, otherwise error
420 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
423 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
424 * and partition table entries (PTE)
426 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
428 * @param dev_desc - block device descriptor
429 * @param gpt_head - pointer to GPT header data read from medium
430 * @param gpt_pte - pointer to GPT partition table enties read from medium
432 * Return: - '0' on success, otherwise error
434 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
435 gpt_entry **gpt_pte);
438 * gpt_verify_partitions() - Function to check if partitions' name, start and
439 * size correspond to '$partitions' env variable
441 * This function checks if on medium stored GPT data is in sync with information
442 * provided in '$partitions' environment variable. Specificially, name, start
443 * and size of the partition is checked.
445 * @param dev_desc - block device descriptor
446 * @param partitions - partition data read from '$partitions' env variable
447 * @param parts - number of partitions read from '$partitions' env variable
448 * @param gpt_head - pointer to GPT header data read from medium
449 * @param gpt_pte - pointer to GPT partition table enties read from medium
451 * Return: - '0' on success, otherwise error
453 int gpt_verify_partitions(struct blk_desc *dev_desc,
454 struct disk_partition *partitions, int parts,
455 gpt_header *gpt_head, gpt_entry **gpt_pte);
459 * get_disk_guid() - Function to read the GUID string from a device's GPT
461 * This function reads the GUID string from a block device whose descriptor
464 * @param dev_desc - block device descriptor
465 * @param guid - pre-allocated string in which to return the GUID
467 * Return: - '0' on success, otherwise error
469 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
473 #if CONFIG_IS_ENABLED(DOS_PARTITION)
475 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
477 * @param buf - buffer which contains the MBR
479 * Return: - '0' on success, otherwise error
481 int is_valid_dos_buf(void *buf);
484 * write_mbr_sector() - write DOS MBR
486 * @param dev_desc - block device descriptor
487 * @param buf - buffer which contains the MBR
489 * Return: - '0' on success, otherwise error
491 int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
493 int write_mbr_partitions(struct blk_desc *dev,
494 struct disk_partition *p, int count, unsigned int disksig);
495 int layout_mbr_partitions(struct disk_partition *p, int count,
496 lbaint_t total_sectors);
500 #ifdef CONFIG_PARTITIONS
502 * part_driver_get_count() - get partition driver count
504 * Return: - number of partition drivers
506 static inline int part_driver_get_count(void)
508 return ll_entry_count(struct part_driver, part_driver);
512 * part_driver_get_first() - get first partition driver
514 * Return: - pointer to first partition driver on success, otherwise NULL
516 static inline struct part_driver *part_driver_get_first(void)
518 return ll_entry_start(struct part_driver, part_driver);
522 static inline int part_driver_get_count(void)
525 static inline struct part_driver *part_driver_get_first(void)
527 #endif /* CONFIG_PARTITIONS */