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)
112 struct disk_partition gpt_part_info
;
113 struct list_head list
;
116 /* Misc _get_dev functions */
117 #if CONFIG_IS_ENABLED(PARTITIONS)
119 * blk_get_dev() - get a pointer to a block device given its type and number
121 * Each interface allocates its own devices and typically struct blk_desc is
122 * contained with the interface's data structure. There is no global
123 * numbering for block devices, so the interface name must be provided.
125 * @ifname: Interface name (e.g. "ide", "scsi")
126 * @dev: Device number (0 for first device on that interface, 1 for
129 * pointer to the block device, or NULL if not available, or an error occurred.
131 struct blk_desc
*blk_get_dev(const char *ifname
, int dev
);
133 struct blk_desc
*mg_disk_get_dev(int dev
);
136 * part_get_info_by_type() - Get partitions from a block device using a specific
139 * Each interface allocates its own devices and typically struct blk_desc is
140 * contained with the interface's data structure. There is no global
141 * numbering for block devices, so the interface name must be provided.
143 * @desc: Block device descriptor
144 * @part: Partition number to read
145 * @part_type: Partition driver to use, or PART_TYPE_UNKNOWN to automatically
147 * @info: Returned partition information
149 * Return: 0 on success, negative errno on failure
151 int part_get_info_by_type(struct blk_desc
*desc
, int part
, int part_type
,
152 struct disk_partition
*info
);
153 int part_get_info(struct blk_desc
*desc
, int part
,
154 struct disk_partition
*info
);
156 * part_get_info_whole_disk() - get partition info for the special case of
157 * a partition occupying the entire disk.
159 * @desc: block device descriptor
160 * @info: returned partition information
161 * Return: 0 on success
163 int part_get_info_whole_disk(struct blk_desc
*desc
,
164 struct disk_partition
*info
);
166 void part_print(struct blk_desc
*desc
);
167 void part_init(struct blk_desc
*desc
);
168 void dev_print(struct blk_desc
*desc
);
171 * blk_get_device_by_str() - Get a block device given its interface/hw partition
173 * Each interface allocates its own devices and typically struct blk_desc is
174 * contained with the interface's data structure. There is no global
175 * numbering for block devices, so the interface name must be provided.
177 * The hardware parition is not related to the normal software partitioning
178 * of a device - each hardware partition is effectively a separately
179 * accessible block device. When a hardware parition is selected on MMC the
180 * other hardware partitions become inaccessible. The same block device is
181 * used to access all hardware partitions, but its capacity may change when a
182 * different hardware partition is selected.
184 * When a hardware partition number is given, the block device switches to
185 * that hardware partition.
187 * @ifname: Interface name (e.g. "ide", "scsi")
188 * @dev_str: Device and optional hw partition. This can either be a string
189 * containing the device number (e.g. "2") or the device number
190 * and hardware partition number (e.g. "2.4") for devices that
191 * support it (currently only MMC).
192 * @desc: Returns a pointer to the block device on success
193 * Return: block device number (local to the interface), or -1 on error
195 int blk_get_device_by_str(const char *ifname
, const char *dev_str
,
196 struct blk_desc
**desc
);
199 * blk_get_device_part_str() - Get a block device and partition
201 * This calls blk_get_device_by_str() to look up a device. It also looks up
202 * a partition and returns information about it.
204 * @dev_part_str is in the format <dev>.<hw_part>:<part> where
206 * * <dev> is the device number,
208 * * <hw_part> is the optional hardware partition number and
210 * * <part> is the partition number.
212 * If @ifname is "hostfs", then this function returns the sandbox host block
215 * If @ifname is "ubi", then this function returns 0, with @info set to a
216 * special UBI device.
218 * If @dev_part_str is NULL or empty or "-", then this function looks up
219 * the "bootdevice" environment variable and uses that string instead.
221 * If the partition string is empty then the first partition is used. If the
222 * partition string is "auto" then the first bootable partition is used.
224 * @ifname: Interface name (e.g. "ide", "scsi")
225 * @dev_part_str: Device and partition string
226 * @desc: Returns a pointer to the block device on success
227 * @info: Returns partition information
228 * @allow_whole_dev: true to allow the user to select partition 0
229 * (which means the whole device), false to require a valid
230 * partition number >= 1
231 * Return: partition number, or -1 on error
234 int blk_get_device_part_str(const char *ifname
, const char *dev_part_str
,
235 struct blk_desc
**desc
,
236 struct disk_partition
*info
, int allow_whole_dev
);
239 * part_get_info_by_name() - Search for a partition by name
240 * among all available registered partitions
242 * @desc: block device descriptor
243 * @name: the specified table entry name
244 * @info: returns the disk partition info
246 * Return: the partition number on match (starting on 1), -1 on no match,
249 int part_get_info_by_name(struct blk_desc
*desc
, const char *name
,
250 struct disk_partition
*info
);
253 * part_get_info_by_dev_and_name_or_num() - Get partition info from dev number
254 * and part name, or dev number and
257 * Parse a device number and partition description (either name or number)
258 * in the form of device number plus partition name separated by a "#"
259 * (like "device_num#partition_name") or a device number plus a partition number
260 * separated by a ":". For example both "0#misc" and "0:1" can be valid
261 * partition descriptions for a given interface. If the partition is found, sets
262 * desc and part_info accordingly with the information of the partition.
264 * @dev_iface: Device interface
265 * @dev_part_str: Input partition description, like "0#misc" or "0:1"
266 * @desc: Place to store the device description pointer
267 * @part_info: Place to store the partition information
268 * @allow_whole_dev: true to allow the user to select partition 0
269 * (which means the whole device), false to require a valid
270 * partition number >= 1
271 * Return: the partition number on success, or negative errno on error
273 int part_get_info_by_dev_and_name_or_num(const char *dev_iface
,
274 const char *dev_part_str
,
275 struct blk_desc
**desc
,
276 struct disk_partition
*part_info
,
277 int allow_whole_dev
);
280 * part_set_generic_name() - create generic partition like hda1 or sdb2
282 * Helper function for partition tables, which don't hold partition names
283 * (DOS, ISO). Generates partition name out of the device type and partition
286 * @desc: pointer to the block device
287 * @part_num: partition number for which the name is generated
288 * @name: buffer where the name is written
290 void part_set_generic_name(const struct blk_desc
*desc
, int part_num
,
293 extern const struct block_drvr block_drvr
[];
295 static inline struct blk_desc
*blk_get_dev(const char *ifname
, int dev
)
297 static inline struct blk_desc
*mg_disk_get_dev(int dev
) { return NULL
; }
299 static inline int part_get_info(struct blk_desc
*desc
, int part
,
300 struct disk_partition
*info
) { return -1; }
301 static inline int part_get_info_whole_disk(struct blk_desc
*desc
,
302 struct disk_partition
*info
)
304 static inline void part_print(struct blk_desc
*desc
) {}
305 static inline void part_init(struct blk_desc
*desc
) {}
306 static inline void dev_print(struct blk_desc
*desc
) {}
307 static inline int blk_get_device_by_str(const char *ifname
, const char *dev_str
,
308 struct blk_desc
**desc
)
310 static inline int blk_get_device_part_str(const char *ifname
,
311 const char *dev_part_str
,
312 struct blk_desc
**desc
,
313 struct disk_partition
*info
,
315 { *desc
= NULL
; return -1; }
317 static inline int part_get_info_by_name(struct blk_desc
*desc
, const char *name
,
318 struct disk_partition
*info
)
324 part_get_info_by_dev_and_name_or_num(const char *dev_iface
,
325 const char *dev_part_str
,
326 struct blk_desc
**desc
,
327 struct disk_partition
*part_info
,
336 * part_get_bootable() - Find the first bootable partition
338 * @desc: Block-device descriptor
339 * @return first bootable partition, or 0 if there is none
341 int part_get_bootable(struct blk_desc
*desc
);
345 * disk_blk_read() - read blocks from a disk partition
347 * @dev: Device to read from (UCLASS_PARTITION)
348 * @start: Start block number to read in the partition (0=first)
349 * @blkcnt: Number of blocks to read
350 * @buffer: Destination buffer for data read
351 * Return: number of blocks read, or -ve error number (see the
352 * IS_ERR_VALUE() macro
354 ulong
disk_blk_read(struct udevice
*dev
, lbaint_t start
, lbaint_t blkcnt
,
358 * disk_blk_write() - write to a disk partition
360 * @dev: Device to write to (UCLASS_PARTITION)
361 * @start: Start block number to write in the partition (0=first)
362 * @blkcnt: Number of blocks to write
363 * @buffer: Source buffer for data to write
364 * Return: number of blocks written, or -ve error number (see the
365 * IS_ERR_VALUE() macro
367 ulong
disk_blk_write(struct udevice
*dev
, lbaint_t start
, lbaint_t blkcnt
,
371 * disk_blk_erase() - erase a section of a disk partition
373 * @dev: Device to (partially) erase (UCLASS_PARTITION)
374 * @start: Start block number to erase in the partition (0=first)
375 * @blkcnt: Number of blocks to erase
376 * Return: number of blocks erased, or -ve error number (see the
377 * IS_ERR_VALUE() macro
379 ulong
disk_blk_erase(struct udevice
*dev
, lbaint_t start
, lbaint_t blkcnt
);
382 * We don't support printing partition information in SPL and only support
383 * getting partition information in a few cases.
385 #ifdef CONFIG_SPL_BUILD
386 # define part_print_ptr(x) NULL
387 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
388 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
389 # define part_get_info_ptr(x) x
391 # define part_get_info_ptr(x) NULL
394 #define part_print_ptr(x) x
395 #define part_get_info_ptr(x) x
399 * struct part_driver - partition driver
402 /** @name: partition name */
404 /** @part_type: (MBR) partition type */
406 /** @max_entries: maximum number of partition table entries */
407 const int max_entries
;
409 * @get_info: Get information about a partition
411 * @get_info.desc: Block device descriptor
412 * @get_info.part: Partition number (1 = first)
413 * @get_info.info: Returns partition information
415 int (*get_info
)(struct blk_desc
*desc
, int part
,
416 struct disk_partition
*info
);
419 * @print: Print partition information
421 * @print.desc: Block device descriptor
423 void (*print
)(struct blk_desc
*desc
);
426 * @test: Test if a device contains this partition type
428 * @test.desc: Block device descriptor
430 * 0 if the block device appears to contain this partition type,
433 int (*test
)(struct blk_desc
*desc
);
436 /* Declare a new U-Boot partition 'driver' */
437 #define U_BOOT_PART_TYPE(__name) \
438 ll_entry_declare(struct part_driver, __name, part_driver)
440 #include <part_efi.h>
442 #if CONFIG_IS_ENABLED(EFI_PARTITION)
443 /* disk/part_efi.c */
445 * write_gpt_table() - Write the GUID Partition Table to disk
447 * @desc: block device descriptor
448 * @gpt_h: pointer to GPT header representation
449 * @gpt_e: pointer to GPT partition table entries
451 * Return: zero on success, otherwise error
453 int write_gpt_table(struct blk_desc
*desc
, gpt_header
*gpt_h
, gpt_entry
*gpt_e
);
456 * gpt_fill_pte() - Fill the GPT partition table entry
458 * @desc: block device descriptor
459 * @gpt_h: GPT header representation
460 * @gpt_e: GPT partition table entries
461 * @partitions: list of partitions
462 * @parts: number of partitions
464 * Return: zero on success
466 int gpt_fill_pte(struct blk_desc
*desc
, gpt_header
*gpt_h
, gpt_entry
*gpt_e
,
467 struct disk_partition
*partitions
, int parts
);
470 * gpt_fill_header() - Fill the GPT header
472 * @desc: block device descriptor
473 * @gpt_h: GPT header representation
474 * @str_guid: disk guid string representation
475 * @parts_count: number of partitions
477 * Return: error on str_guid conversion error
479 int gpt_fill_header(struct blk_desc
*desc
, gpt_header
*gpt_h
, char *str_guid
,
483 * gpt_restore() - Restore GPT partition table
485 * @desc: block device descriptor
486 * @str_disk_guid: disk GUID
487 * @partitions: list of partitions
488 * @parts_count: number of partitions
490 * Return: 0 on success
492 int gpt_restore(struct blk_desc
*desc
, char *str_disk_guid
,
493 struct disk_partition
*partitions
, const int parts_count
);
496 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
498 * @desc: block device descriptor
499 * @buf: buffer which contains the MBR and Primary GPT info
501 * Return: 0 on success, otherwise error
503 int is_valid_gpt_buf(struct blk_desc
*desc
, void *buf
);
506 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
508 * @desc: block device descriptor
509 * @buf: buffer which contains the MBR and Primary GPT info
511 * Return: 0 on success, otherwise error
513 int write_mbr_and_gpt_partitions(struct blk_desc
*desc
, void *buf
);
516 * gpt_verify_headers() - Read and check CRC32 of the GPT's header
517 * and partition table entries (PTE)
519 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
521 * @desc: block device descriptor
522 * @gpt_head: pointer to GPT header data read from medium
523 * @gpt_pte: pointer to GPT partition table enties read from medium
525 * Return: 0 on success, otherwise error
527 int gpt_verify_headers(struct blk_desc
*desc
, gpt_header
*gpt_head
,
528 gpt_entry
**gpt_pte
);
531 * gpt_repair_headers() - Function to repair the GPT's header
532 * and partition table entries (PTE)
534 * @desc: block device descriptor
536 * Return: 0 on success, otherwise error
538 int gpt_repair_headers(struct blk_desc
*desc
);
541 * gpt_verify_partitions() - Function to check if partitions' name, start and
542 * size correspond to '$partitions' env variable
544 * This function checks if on medium stored GPT data is in sync with information
545 * provided in '$partitions' environment variable. Specificially, name, start
546 * and size of the partition is checked.
548 * @desc: block device descriptor
549 * @partitions: partition data read from '$partitions' env variable
550 * @parts: number of partitions read from '$partitions' env variable
551 * @gpt_head: pointer to GPT header data read from medium
552 * @gpt_pte: pointer to GPT partition table enties read from medium
554 * Return: 0 on success, otherwise error
556 int gpt_verify_partitions(struct blk_desc
*desc
,
557 struct disk_partition
*partitions
, int parts
,
558 gpt_header
*gpt_head
, gpt_entry
**gpt_pte
);
562 * get_disk_guid() - Read the GUID string from a device's GPT
564 * This function reads the GUID string from a block device whose descriptor
567 * @desc: block device descriptor
568 * @guid: pre-allocated string in which to return the GUID
570 * Return: 0 on success, otherwise error
572 int get_disk_guid(struct blk_desc
*desc
, char *guid
);
576 #if CONFIG_IS_ENABLED(DOS_PARTITION)
578 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
580 * @buf: buffer which contains the MBR
582 * Return: 0 on success, otherwise error
584 int is_valid_dos_buf(void *buf
);
587 * write_mbr_sector() - write DOS MBR
589 * @desc: block device descriptor
590 * @buf: buffer which contains the MBR
592 * Return: 0 on success, otherwise error
594 int write_mbr_sector(struct blk_desc
*desc
, void *buf
);
596 int write_mbr_partitions(struct blk_desc
*dev
,
597 struct disk_partition
*p
, int count
, unsigned int disksig
);
598 int layout_mbr_partitions(struct disk_partition
*p
, int count
,
599 lbaint_t total_sectors
);
603 #if CONFIG_IS_ENABLED(PARTITIONS)
605 * part_driver_get_count() - get partition driver count
607 * Return: number of partition drivers
609 static inline int part_driver_get_count(void)
611 return ll_entry_count(struct part_driver
, part_driver
);
615 * part_driver_get_first() - get first partition driver
617 * Return: pointer to first partition driver on success, otherwise NULL
619 static inline struct part_driver
*part_driver_get_first(void)
621 return ll_entry_start(struct part_driver
, part_driver
);
625 * part_get_type_by_name() - Get partition type by name
627 * @name: Name of partition type to look up (not case-sensitive)
629 * Corresponding partition type (PART\_TYPE\_...) or PART\_TYPE\_UNKNOWN
631 int part_get_type_by_name(const char *name
);
634 static inline int part_driver_get_count(void)
637 static inline struct part_driver
*part_driver_get_first(void)
639 #endif /* CONFIG_PARTITIONS */