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 */
83 /* Accessors for struct disk_partition field ->uuid */
84 extern char *__invalid_use_of_disk_partition_uuid
;
86 static inline const char *disk_partition_uuid(const struct disk_partition
*info
)
88 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
91 return __invalid_use_of_disk_partition_uuid
;
95 static inline void disk_partition_set_uuid(struct disk_partition
*info
,
98 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
99 strlcpy(info
->uuid
, val
, UUID_STR_LEN
+ 1);
103 static inline void disk_partition_clr_uuid(struct disk_partition
*info
)
105 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
110 /* Accessors for struct disk_partition field ->type_guid */
111 extern char *__invalid_use_of_disk_partition_type_guid
;
114 * disk_partition_type_guid() - get partition type GUID
116 * By using this function to get the partition type GUID we can use
117 * 'if (IS_ENABLED(CONFIG_PARTITION_TYPE_GUID))' instead of
118 * '#ifdef CONFIG_PARTITION_TYPE_GUID'.
120 * @info: partition information
121 * Return: partition type GUID
124 char *disk_partition_type_guid(const struct disk_partition
*info
)
126 #ifdef CONFIG_PARTITION_TYPE_GUID
127 return info
->type_guid
;
129 return __invalid_use_of_disk_partition_type_guid
;
134 * disk_partition_set_type_guid() - set partition type GUID
136 * By using this function to set the partition type GUID we can use
137 * 'if (IS_ENABLED(CONFIG_PARTITION_TYPE_GUID))' instead of
138 * '#ifdef CONFIG_PARTITION_TYPE_GUID'.
140 * @info: partition information
141 * @val: partition type GUID as string
143 static inline void disk_partition_set_type_guid(struct disk_partition
*info
,
146 #ifdef CONFIG_PARTITION_TYPE_GUID
147 strlcpy(info
->type_guid
, val
, UUID_STR_LEN
+ 1);
151 static inline void disk_partition_clr_type_guid(struct disk_partition
*info
)
153 #ifdef CONFIG_PARTITION_TYPE_GUID
154 *info
->type_guid
= '\0';
158 /* Accessors for struct disk_partition field ->sys_ind */
159 extern int __invalid_use_of_disk_partition_sys_ind
;
161 static inline uint
disk_partition_sys_ind(const struct disk_partition
*info
)
163 #ifdef CONFIG_DOS_PARTITION
164 return info
->sys_ind
;
166 return __invalid_use_of_disk_partition_sys_ind
;
172 struct disk_partition gpt_part_info
;
173 struct list_head list
;
176 /* Misc _get_dev functions */
177 #if CONFIG_IS_ENABLED(PARTITIONS)
179 * blk_get_dev() - get a pointer to a block device given its type and number
181 * Each interface allocates its own devices and typically struct blk_desc is
182 * contained with the interface's data structure. There is no global
183 * numbering for block devices, so the interface name must be provided.
185 * @ifname: Interface name (e.g. "ide", "scsi")
186 * @dev: Device number (0 for first device on that interface, 1 for
189 * pointer to the block device, or NULL if not available, or an error occurred.
191 struct blk_desc
*blk_get_dev(const char *ifname
, int dev
);
193 struct blk_desc
*mg_disk_get_dev(int dev
);
196 * part_get_info_by_type() - Get partitions from a block device using a specific
199 * Each interface allocates its own devices and typically struct blk_desc is
200 * contained with the interface's data structure. There is no global
201 * numbering for block devices, so the interface name must be provided.
203 * @desc: Block device descriptor
204 * @part: Partition number to read
205 * @part_type: Partition driver to use, or PART_TYPE_UNKNOWN to automatically
207 * @info: Returned partition information
209 * Return: 0 on success, negative errno on failure
211 int part_get_info_by_type(struct blk_desc
*desc
, int part
, int part_type
,
212 struct disk_partition
*info
);
213 int part_get_info(struct blk_desc
*desc
, int part
,
214 struct disk_partition
*info
);
216 * part_get_info_whole_disk() - get partition info for the special case of
217 * a partition occupying the entire disk.
219 * @desc: block device descriptor
220 * @info: returned partition information
221 * Return: 0 on success
223 int part_get_info_whole_disk(struct blk_desc
*desc
,
224 struct disk_partition
*info
);
226 void part_print(struct blk_desc
*desc
);
227 void part_init(struct blk_desc
*desc
);
228 void dev_print(struct blk_desc
*desc
);
231 * blk_get_device_by_str() - Get a block device given its interface/hw partition
233 * Each interface allocates its own devices and typically struct blk_desc is
234 * contained with the interface's data structure. There is no global
235 * numbering for block devices, so the interface name must be provided.
237 * The hardware parition is not related to the normal software partitioning
238 * of a device - each hardware partition is effectively a separately
239 * accessible block device. When a hardware parition is selected on MMC the
240 * other hardware partitions become inaccessible. The same block device is
241 * used to access all hardware partitions, but its capacity may change when a
242 * different hardware partition is selected.
244 * When a hardware partition number is given, the block device switches to
245 * that hardware partition.
247 * @ifname: Interface name (e.g. "ide", "scsi")
248 * @dev_str: Device and optional hw partition. This can either be a string
249 * containing the device number (e.g. "2") or the device number
250 * and hardware partition number (e.g. "2.4") for devices that
251 * support it (currently only MMC).
252 * @desc: Returns a pointer to the block device on success
253 * Return: block device number (local to the interface), or -1 on error
255 int blk_get_device_by_str(const char *ifname
, const char *dev_str
,
256 struct blk_desc
**desc
);
259 * blk_get_device_part_str() - Get a block device and partition
261 * This calls blk_get_device_by_str() to look up a device. It also looks up
262 * a partition and returns information about it.
264 * @dev_part_str is in the format <dev>.<hw_part>:<part> where
266 * * <dev> is the device number,
268 * * <hw_part> is the optional hardware partition number and
270 * * <part> is the partition number.
272 * If @ifname is "hostfs", then this function returns the sandbox host block
275 * If @ifname is "ubi", then this function returns 0, with @info set to a
276 * special UBI device.
278 * If @dev_part_str is NULL or empty or "-", then this function looks up
279 * the "bootdevice" environment variable and uses that string instead.
281 * If the partition string is empty then the first partition is used. If the
282 * partition string is "auto" then the first bootable partition is used.
284 * @ifname: Interface name (e.g. "ide", "scsi")
285 * @dev_part_str: Device and partition string
286 * @desc: Returns a pointer to the block device on success
287 * @info: Returns partition information
288 * @allow_whole_dev: true to allow the user to select partition 0
289 * (which means the whole device), false to require a valid
290 * partition number >= 1
291 * Return: partition number, or -1 on error
294 int blk_get_device_part_str(const char *ifname
, const char *dev_part_str
,
295 struct blk_desc
**desc
,
296 struct disk_partition
*info
, int allow_whole_dev
);
299 * part_get_info_by_name() - Search for a partition by name
300 * among all available registered partitions
302 * @desc: block device descriptor
303 * @name: the specified table entry name
304 * @info: returns the disk partition info
306 * Return: the partition number on match (starting on 1), -1 on no match,
309 int part_get_info_by_name(struct blk_desc
*desc
, const char *name
,
310 struct disk_partition
*info
);
313 * part_get_info_by_dev_and_name_or_num() - Get partition info from dev number
314 * and part name, or dev number and
317 * Parse a device number and partition description (either name or number)
318 * in the form of device number plus partition name separated by a "#"
319 * (like "device_num#partition_name") or a device number plus a partition number
320 * separated by a ":". For example both "0#misc" and "0:1" can be valid
321 * partition descriptions for a given interface. If the partition is found, sets
322 * desc and part_info accordingly with the information of the partition.
324 * @dev_iface: Device interface
325 * @dev_part_str: Input partition description, like "0#misc" or "0:1"
326 * @desc: Place to store the device description pointer
327 * @part_info: Place to store the partition information
328 * @allow_whole_dev: true to allow the user to select partition 0
329 * (which means the whole device), false to require a valid
330 * partition number >= 1
331 * Return: the partition number on success, or negative errno on error
333 int part_get_info_by_dev_and_name_or_num(const char *dev_iface
,
334 const char *dev_part_str
,
335 struct blk_desc
**desc
,
336 struct disk_partition
*part_info
,
337 int allow_whole_dev
);
340 * part_set_generic_name() - create generic partition like hda1 or sdb2
342 * Helper function for partition tables, which don't hold partition names
343 * (DOS, ISO). Generates partition name out of the device type and partition
346 * @desc: pointer to the block device
347 * @part_num: partition number for which the name is generated
348 * @name: buffer where the name is written
350 void part_set_generic_name(const struct blk_desc
*desc
, int part_num
,
353 extern const struct block_drvr block_drvr
[];
355 static inline struct blk_desc
*blk_get_dev(const char *ifname
, int dev
)
357 static inline struct blk_desc
*mg_disk_get_dev(int dev
) { return NULL
; }
359 static inline int part_get_info(struct blk_desc
*desc
, int part
,
360 struct disk_partition
*info
) { return -1; }
361 static inline int part_get_info_whole_disk(struct blk_desc
*desc
,
362 struct disk_partition
*info
)
364 static inline void part_print(struct blk_desc
*desc
) {}
365 static inline void part_init(struct blk_desc
*desc
) {}
366 static inline void dev_print(struct blk_desc
*desc
) {}
367 static inline int blk_get_device_by_str(const char *ifname
, const char *dev_str
,
368 struct blk_desc
**desc
)
370 static inline int blk_get_device_part_str(const char *ifname
,
371 const char *dev_part_str
,
372 struct blk_desc
**desc
,
373 struct disk_partition
*info
,
375 { *desc
= NULL
; return -1; }
377 static inline int part_get_info_by_name(struct blk_desc
*desc
, const char *name
,
378 struct disk_partition
*info
)
384 part_get_info_by_dev_and_name_or_num(const char *dev_iface
,
385 const char *dev_part_str
,
386 struct blk_desc
**desc
,
387 struct disk_partition
*part_info
,
397 * disk_blk_read() - read blocks from a disk partition
399 * @dev: Device to read from (UCLASS_PARTITION)
400 * @start: Start block number to read in the partition (0=first)
401 * @blkcnt: Number of blocks to read
402 * @buffer: Destination buffer for data read
403 * Return: number of blocks read, or -ve error number (see the
404 * IS_ERR_VALUE() macro
406 ulong
disk_blk_read(struct udevice
*dev
, lbaint_t start
, lbaint_t blkcnt
,
410 * disk_blk_write() - write to a disk partition
412 * @dev: Device to write to (UCLASS_PARTITION)
413 * @start: Start block number to write in the partition (0=first)
414 * @blkcnt: Number of blocks to write
415 * @buffer: Source buffer for data to write
416 * Return: number of blocks written, or -ve error number (see the
417 * IS_ERR_VALUE() macro
419 ulong
disk_blk_write(struct udevice
*dev
, lbaint_t start
, lbaint_t blkcnt
,
423 * disk_blk_erase() - erase a section of a disk partition
425 * @dev: Device to (partially) erase (UCLASS_PARTITION)
426 * @start: Start block number to erase in the partition (0=first)
427 * @blkcnt: Number of blocks to erase
428 * Return: number of blocks erased, or -ve error number (see the
429 * IS_ERR_VALUE() macro
431 ulong
disk_blk_erase(struct udevice
*dev
, lbaint_t start
, lbaint_t blkcnt
);
434 * We don't support printing partition information in SPL and only support
435 * getting partition information in a few cases.
437 #ifdef CONFIG_SPL_BUILD
438 # define part_print_ptr(x) NULL
439 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
440 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
441 # define part_get_info_ptr(x) x
443 # define part_get_info_ptr(x) NULL
446 #define part_print_ptr(x) x
447 #define part_get_info_ptr(x) x
451 * struct part_driver - partition driver
454 /** @name: partition name */
456 /** @part_type: (MBR) partition type */
458 /** @max_entries: maximum number of partition table entries */
459 const int max_entries
;
461 * @get_info: Get information about a partition
463 * @get_info.desc: Block device descriptor
464 * @get_info.part: Partition number (1 = first)
465 * @get_info.info: Returns partition information
467 int (*get_info
)(struct blk_desc
*desc
, int part
,
468 struct disk_partition
*info
);
471 * @print: Print partition information
473 * @print.desc: Block device descriptor
475 void (*print
)(struct blk_desc
*desc
);
478 * @test: Test if a device contains this partition type
480 * @test.desc: Block device descriptor
482 * 0 if the block device appears to contain this partition type,
485 int (*test
)(struct blk_desc
*desc
);
488 /* Declare a new U-Boot partition 'driver' */
489 #define U_BOOT_PART_TYPE(__name) \
490 ll_entry_declare(struct part_driver, __name, part_driver)
492 #include <part_efi.h>
494 #if CONFIG_IS_ENABLED(EFI_PARTITION)
495 /* disk/part_efi.c */
497 * write_gpt_table() - Write the GUID Partition Table to disk
499 * @desc: block device descriptor
500 * @gpt_h: pointer to GPT header representation
501 * @gpt_e: pointer to GPT partition table entries
503 * Return: zero on success, otherwise error
505 int write_gpt_table(struct blk_desc
*desc
, gpt_header
*gpt_h
, gpt_entry
*gpt_e
);
508 * gpt_fill_pte() - Fill the GPT partition table entry
510 * @desc: block device descriptor
511 * @gpt_h: GPT header representation
512 * @gpt_e: GPT partition table entries
513 * @partitions: list of partitions
514 * @parts: number of partitions
516 * Return: zero on success
518 int gpt_fill_pte(struct blk_desc
*desc
, gpt_header
*gpt_h
, gpt_entry
*gpt_e
,
519 struct disk_partition
*partitions
, int parts
);
522 * gpt_fill_header() - Fill the GPT header
524 * @desc: block device descriptor
525 * @gpt_h: GPT header representation
526 * @str_guid: disk guid string representation
527 * @parts_count: number of partitions
529 * Return: error on str_guid conversion error
531 int gpt_fill_header(struct blk_desc
*desc
, gpt_header
*gpt_h
, char *str_guid
,
535 * gpt_restore() - Restore GPT partition table
537 * @desc: block device descriptor
538 * @str_disk_guid: disk GUID
539 * @partitions: list of partitions
540 * @parts_count: number of partitions
542 * Return: 0 on success
544 int gpt_restore(struct blk_desc
*desc
, char *str_disk_guid
,
545 struct disk_partition
*partitions
, const int parts_count
);
548 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
550 * @desc: block device descriptor
551 * @buf: buffer which contains the MBR and Primary GPT info
553 * Return: 0 on success, otherwise error
555 int is_valid_gpt_buf(struct blk_desc
*desc
, void *buf
);
558 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
560 * @desc: block device descriptor
561 * @buf: buffer which contains the MBR and Primary GPT info
563 * Return: 0 on success, otherwise error
565 int write_mbr_and_gpt_partitions(struct blk_desc
*desc
, void *buf
);
568 * gpt_verify_headers() - Read and check CRC32 of the GPT's header
569 * and partition table entries (PTE)
571 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
573 * @desc: block device descriptor
574 * @gpt_head: pointer to GPT header data read from medium
575 * @gpt_pte: pointer to GPT partition table enties read from medium
577 * Return: 0 on success, otherwise error
579 int gpt_verify_headers(struct blk_desc
*desc
, gpt_header
*gpt_head
,
580 gpt_entry
**gpt_pte
);
583 * gpt_repair_headers() - Function to repair the GPT's header
584 * and partition table entries (PTE)
586 * @desc: block device descriptor
588 * Return: 0 on success, otherwise error
590 int gpt_repair_headers(struct blk_desc
*desc
);
593 * gpt_verify_partitions() - Function to check if partitions' name, start and
594 * size correspond to '$partitions' env variable
596 * This function checks if on medium stored GPT data is in sync with information
597 * provided in '$partitions' environment variable. Specificially, name, start
598 * and size of the partition is checked.
600 * @desc: block device descriptor
601 * @partitions: partition data read from '$partitions' env variable
602 * @parts: number of partitions read from '$partitions' env variable
603 * @gpt_head: pointer to GPT header data read from medium
604 * @gpt_pte: pointer to GPT partition table enties read from medium
606 * Return: 0 on success, otherwise error
608 int gpt_verify_partitions(struct blk_desc
*desc
,
609 struct disk_partition
*partitions
, int parts
,
610 gpt_header
*gpt_head
, gpt_entry
**gpt_pte
);
614 * get_disk_guid() - Read the GUID string from a device's GPT
616 * This function reads the GUID string from a block device whose descriptor
619 * @desc: block device descriptor
620 * @guid: pre-allocated string in which to return the GUID
622 * Return: 0 on success, otherwise error
624 int get_disk_guid(struct blk_desc
*desc
, char *guid
);
628 #if CONFIG_IS_ENABLED(DOS_PARTITION)
630 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
632 * @buf: buffer which contains the MBR
634 * Return: 0 on success, otherwise error
636 int is_valid_dos_buf(void *buf
);
639 * write_mbr_sector() - write DOS MBR
641 * @desc: block device descriptor
642 * @buf: buffer which contains the MBR
644 * Return: 0 on success, otherwise error
646 int write_mbr_sector(struct blk_desc
*desc
, void *buf
);
648 int write_mbr_partitions(struct blk_desc
*dev
,
649 struct disk_partition
*p
, int count
, unsigned int disksig
);
650 int layout_mbr_partitions(struct disk_partition
*p
, int count
,
651 lbaint_t total_sectors
);
655 #if CONFIG_IS_ENABLED(PARTITIONS)
657 * part_driver_get_count() - get partition driver count
659 * Return: number of partition drivers
661 static inline int part_driver_get_count(void)
663 return ll_entry_count(struct part_driver
, part_driver
);
667 * part_driver_get_first() - get first partition driver
669 * Return: pointer to first partition driver on success, otherwise NULL
671 static inline struct part_driver
*part_driver_get_first(void)
673 return ll_entry_start(struct part_driver
, part_driver
);
677 * part_get_type_by_name() - Get partition type by name
679 * @name: Name of partition type to look up (not case-sensitive)
681 * Corresponding partition type (PART\_TYPE\_...) or PART\_TYPE\_UNKNOWN
683 int part_get_type_by_name(const char *name
);
686 * part_get_bootable() - Find the first bootable partition
688 * @desc: Block-device descriptor
689 * Return: first bootable partition, or 0 if there is none
691 int part_get_bootable(struct blk_desc
*desc
);
694 static inline int part_driver_get_count(void)
697 static inline struct part_driver
*part_driver_get_first(void)
700 static inline bool part_get_bootable(struct blk_desc
*desc
)
703 #endif /* CONFIG_PARTITIONS */