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 #if CONFIG_IS_ENABLED(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
102 * pointer to the block device, or NULL if not available, or an error occurred.
104 struct blk_desc *blk_get_dev(const char *ifname, int dev);
106 struct blk_desc *mg_disk_get_dev(int dev);
109 * part_get_info_by_type() - Get partitions from a block device using a specific
112 * Each interface allocates its own devices and typically struct blk_desc is
113 * contained with the interface's data structure. There is no global
114 * numbering for block devices, so the interface name must be provided.
116 * @dev_desc: Block device descriptor
117 * @part: Partition number to read
118 * @part_type: Partition driver to use, or PART_TYPE_UNKNOWN to automatically
120 * @info: Returned partition information
122 * Return: 0 on success, negative errno on failure
124 int part_get_info_by_type(struct blk_desc *dev_desc, int part, int part_type,
125 struct disk_partition *info);
126 int part_get_info(struct blk_desc *dev_desc, int part,
127 struct disk_partition *info);
129 * part_get_info_whole_disk() - get partition info for the special case of
130 * a partition occupying the entire disk.
132 * @dev_desc: block device descriptor
133 * @info: returned partition information
134 * Return: 0 on success
136 int part_get_info_whole_disk(struct blk_desc *dev_desc,
137 struct disk_partition *info);
139 void part_print(struct blk_desc *dev_desc);
140 void part_init(struct blk_desc *dev_desc);
141 void dev_print(struct blk_desc *dev_desc);
144 * blk_get_device_by_str() - Get a block device given its interface/hw partition
146 * Each interface allocates its own devices and typically struct blk_desc is
147 * contained with the interface's data structure. There is no global
148 * numbering for block devices, so the interface name must be provided.
150 * The hardware parition is not related to the normal software partitioning
151 * of a device - each hardware partition is effectively a separately
152 * accessible block device. When a hardware parition is selected on MMC the
153 * other hardware partitions become inaccessible. The same block device is
154 * used to access all hardware partitions, but its capacity may change when a
155 * different hardware partition is selected.
157 * When a hardware partition number is given, the block device switches to
158 * that hardware partition.
160 * @ifname: Interface name (e.g. "ide", "scsi")
161 * @dev_str: Device and optional hw partition. This can either be a string
162 * containing the device number (e.g. "2") or the device number
163 * and hardware partition number (e.g. "2.4") for devices that
164 * support it (currently only MMC).
165 * @dev_desc: Returns a pointer to the block device on success
166 * Return: block device number (local to the interface), or -1 on error
168 int blk_get_device_by_str(const char *ifname, const char *dev_str,
169 struct blk_desc **dev_desc);
172 * blk_get_device_part_str() - Get a block device and partition
174 * This calls blk_get_device_by_str() to look up a device. It also looks up
175 * a partition and returns information about it.
177 * @dev_part_str is in the format <dev>.<hw_part>:<part> where
179 * * <dev> is the device number,
181 * * <hw_part> is the optional hardware partition number and
183 * * <part> is the partition number.
185 * If @ifname is "hostfs", then this function returns the sandbox host block
188 * If @ifname is "ubi", then this function returns 0, with @info set to a
189 * special UBI device.
191 * If @dev_part_str is NULL or empty or "-", then this function looks up
192 * the "bootdevice" environment variable and uses that string instead.
194 * If the partition string is empty then the first partition is used. If the
195 * partition string is "auto" then the first bootable partition is used.
197 * @ifname: Interface name (e.g. "ide", "scsi")
198 * @dev_part_str: Device and partition string
199 * @dev_desc: Returns a pointer to the block device on success
200 * @info: Returns partition information
201 * @allow_whole_dev: true to allow the user to select partition 0
202 * (which means the whole device), false to require a valid
203 * partition number >= 1
204 * Return: partition number, or -1 on error
207 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
208 struct blk_desc **dev_desc,
209 struct disk_partition *info, int allow_whole_dev);
212 * part_get_info_by_name() - Search for a partition by name
213 * among all available registered partitions
215 * @dev_desc: block device descriptor
216 * @name: the specified table entry name
217 * @info: returns the disk partition info
219 * Return: the partition number on match (starting on 1), -1 on no match,
222 int part_get_info_by_name(struct blk_desc *dev_desc,
223 const char *name, struct disk_partition *info);
226 * part_get_info_by_dev_and_name_or_num() - Get partition info from dev number
227 * and part name, or dev number and
230 * Parse a device number and partition description (either name or number)
231 * in the form of device number plus partition name separated by a "#"
232 * (like "device_num#partition_name") or a device number plus a partition number
233 * separated by a ":". For example both "0#misc" and "0:1" can be valid
234 * partition descriptions for a given interface. If the partition is found, sets
235 * dev_desc and part_info accordingly with the information of the partition.
237 * @dev_iface: Device interface
238 * @dev_part_str: Input partition description, like "0#misc" or "0:1"
239 * @dev_desc: Place to store the device description pointer
240 * @part_info: Place to store the partition information
241 * @allow_whole_dev: true to allow the user to select partition 0
242 * (which means the whole device), false to require a valid
243 * partition number >= 1
244 * Return: the partition number on success, or negative errno on error
246 int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
247 const char *dev_part_str,
248 struct blk_desc **dev_desc,
249 struct disk_partition *part_info,
250 int allow_whole_dev);
253 * part_set_generic_name() - create generic partition like hda1 or sdb2
255 * Helper function for partition tables, which don't hold partition names
256 * (DOS, ISO). Generates partition name out of the device type and partition
259 * @dev_desc: pointer to the block device
260 * @part_num: partition number for which the name is generated
261 * @name: buffer where the name is written
263 void part_set_generic_name(const struct blk_desc *dev_desc,
264 int part_num, char *name);
266 extern const struct block_drvr block_drvr[];
268 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
270 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
272 static inline int part_get_info(struct blk_desc *dev_desc, int part,
273 struct disk_partition *info) { return -1; }
274 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
275 struct disk_partition *info)
277 static inline void part_print(struct blk_desc *dev_desc) {}
278 static inline void part_init(struct blk_desc *dev_desc) {}
279 static inline void dev_print(struct blk_desc *dev_desc) {}
280 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
281 struct blk_desc **dev_desc)
283 static inline int blk_get_device_part_str(const char *ifname,
284 const char *dev_part_str,
285 struct blk_desc **dev_desc,
286 struct disk_partition *info,
288 { *dev_desc = NULL; return -1; }
290 static inline int part_get_info_by_name(struct blk_desc *dev_desc,
292 struct disk_partition *info)
298 part_get_info_by_dev_and_name_or_num(const char *dev_iface,
299 const char *dev_part_str,
300 struct blk_desc **dev_desc,
301 struct disk_partition *part_info,
310 * part_get_bootable() - Find the first bootable partition
312 * @desc: Block-device descriptor
313 * @return first bootable partition, or 0 if there is none
315 int part_get_bootable(struct blk_desc *desc);
319 * part_create_block_devices - Create block devices for disk partitions
321 * Create UCLASS_PARTITION udevices for each of disk partitions in @parent
323 * @blk_dev: Whole disk device
325 int part_create_block_devices(struct udevice *blk_dev);
328 * disk_blk_read() - read blocks from a disk partition
330 * @dev: Device to read from (UCLASS_PARTITION)
331 * @start: Start block number to read in the partition (0=first)
332 * @blkcnt: Number of blocks to read
333 * @buffer: Destination buffer for data read
334 * Return: number of blocks read, or -ve error number (see the
335 * IS_ERR_VALUE() macro
337 ulong disk_blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
341 * disk_blk_write() - write to a disk partition
343 * @dev: Device to write to (UCLASS_PARTITION)
344 * @start: Start block number to write in the partition (0=first)
345 * @blkcnt: Number of blocks to write
346 * @buffer: Source buffer for data to write
347 * Return: number of blocks written, or -ve error number (see the
348 * IS_ERR_VALUE() macro
350 ulong disk_blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
354 * disk_blk_erase() - erase a section of a disk partition
356 * @dev: Device to (partially) erase (UCLASS_PARTITION)
357 * @start: Start block number to erase in the partition (0=first)
358 * @blkcnt: Number of blocks to erase
359 * Return: number of blocks erased, or -ve error number (see the
360 * IS_ERR_VALUE() macro
362 ulong disk_blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt);
365 * We don't support printing partition information in SPL and only support
366 * getting partition information in a few cases.
368 #ifdef CONFIG_SPL_BUILD
369 # define part_print_ptr(x) NULL
370 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
371 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
372 # define part_get_info_ptr(x) x
374 # define part_get_info_ptr(x) NULL
377 #define part_print_ptr(x) x
378 #define part_get_info_ptr(x) x
382 * struct part_driver - partition driver
385 /** @name: partition name */
387 /** @part_type: (MBR) partition type */
389 /** @max_entries: maximum number of partition table entries */
390 const int max_entries;
392 * @get_info: Get information about a partition
394 * @get_info.dev_desc: Block device descriptor
395 * @get_info.part: Partition number (1 = first)
396 * @get_info.info: Returns partition information
398 int (*get_info)(struct blk_desc *dev_desc, int part,
399 struct disk_partition *info);
402 * @print: Print partition information
404 * @print.dev_desc: Block device descriptor
406 void (*print)(struct blk_desc *dev_desc);
409 * @test: Test if a device contains this partition type
411 * @test.dev_desc: Block device descriptor
413 * 0 if the block device appears to contain this partition type,
416 int (*test)(struct blk_desc *dev_desc);
419 /* Declare a new U-Boot partition 'driver' */
420 #define U_BOOT_PART_TYPE(__name) \
421 ll_entry_declare(struct part_driver, __name, part_driver)
423 #include <part_efi.h>
425 #if CONFIG_IS_ENABLED(EFI_PARTITION)
426 /* disk/part_efi.c */
428 * write_gpt_table() - Write the GUID Partition Table to disk
430 * @dev_desc: block device descriptor
431 * @gpt_h: pointer to GPT header representation
432 * @gpt_e: pointer to GPT partition table entries
434 * Return: zero on success, otherwise error
436 int write_gpt_table(struct blk_desc *dev_desc,
437 gpt_header *gpt_h, gpt_entry *gpt_e);
440 * gpt_fill_pte() - Fill the GPT partition table entry
442 * @dev_desc: block device descriptor
443 * @gpt_h: GPT header representation
444 * @gpt_e: GPT partition table entries
445 * @partitions: list of partitions
446 * @parts: number of partitions
448 * Return: zero on success
450 int gpt_fill_pte(struct blk_desc *dev_desc,
451 gpt_header *gpt_h, gpt_entry *gpt_e,
452 struct disk_partition *partitions, int parts);
455 * gpt_fill_header() - Fill the GPT header
457 * @dev_desc: block device descriptor
458 * @gpt_h: GPT header representation
459 * @str_guid: disk guid string representation
460 * @parts_count: number of partitions
462 * Return: error on str_guid conversion error
464 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
465 char *str_guid, int parts_count);
468 * gpt_restore() - Restore GPT partition table
470 * @dev_desc: block device descriptor
471 * @str_disk_guid: disk GUID
472 * @partitions: list of partitions
473 * @parts_count: number of partitions
475 * Return: 0 on success
477 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
478 struct disk_partition *partitions, const int parts_count);
481 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
483 * @dev_desc: block device descriptor
484 * @buf: buffer which contains the MBR and Primary GPT info
486 * Return: 0 on success, otherwise error
488 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
491 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
493 * @dev_desc: block device descriptor
494 * @buf: buffer which contains the MBR and Primary GPT info
496 * Return: 0 on success, otherwise error
498 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
501 * gpt_verify_headers() - Read and check CRC32 of the GPT's header
502 * and partition table entries (PTE)
504 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
506 * @dev_desc: block device descriptor
507 * @gpt_head: pointer to GPT header data read from medium
508 * @gpt_pte: pointer to GPT partition table enties read from medium
510 * Return: 0 on success, otherwise error
512 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
513 gpt_entry **gpt_pte);
516 * gpt_repair_headers() - Function to repair the GPT's header
517 * and partition table entries (PTE)
519 * @dev_desc: block device descriptor
521 * Return: 0 on success, otherwise error
523 int gpt_repair_headers(struct blk_desc *dev_desc);
526 * gpt_verify_partitions() - Function to check if partitions' name, start and
527 * size correspond to '$partitions' env variable
529 * This function checks if on medium stored GPT data is in sync with information
530 * provided in '$partitions' environment variable. Specificially, name, start
531 * and size of the partition is checked.
533 * @dev_desc: block device descriptor
534 * @partitions: partition data read from '$partitions' env variable
535 * @parts: number of partitions read from '$partitions' env variable
536 * @gpt_head: pointer to GPT header data read from medium
537 * @gpt_pte: pointer to GPT partition table enties read from medium
539 * Return: 0 on success, otherwise error
541 int gpt_verify_partitions(struct blk_desc *dev_desc,
542 struct disk_partition *partitions, int parts,
543 gpt_header *gpt_head, gpt_entry **gpt_pte);
547 * get_disk_guid() - Read the GUID string from a device's GPT
549 * This function reads the GUID string from a block device whose descriptor
552 * @dev_desc: block device descriptor
553 * @guid: pre-allocated string in which to return the GUID
555 * Return: 0 on success, otherwise error
557 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
561 #if CONFIG_IS_ENABLED(DOS_PARTITION)
563 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
565 * @buf: buffer which contains the MBR
567 * Return: 0 on success, otherwise error
569 int is_valid_dos_buf(void *buf);
572 * write_mbr_sector() - write DOS MBR
574 * @dev_desc: block device descriptor
575 * @buf: buffer which contains the MBR
577 * Return: 0 on success, otherwise error
579 int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
581 int write_mbr_partitions(struct blk_desc *dev,
582 struct disk_partition *p, int count, unsigned int disksig);
583 int layout_mbr_partitions(struct disk_partition *p, int count,
584 lbaint_t total_sectors);
588 #if CONFIG_IS_ENABLED(PARTITIONS)
590 * part_driver_get_count() - get partition driver count
592 * Return: number of partition drivers
594 static inline int part_driver_get_count(void)
596 return ll_entry_count(struct part_driver, part_driver);
600 * part_driver_get_first() - get first partition driver
602 * Return: pointer to first partition driver on success, otherwise NULL
604 static inline struct part_driver *part_driver_get_first(void)
606 return ll_entry_start(struct part_driver, part_driver);
610 * part_get_type_by_name() - Get partition type by name
612 * @name: Name of partition type to look up (not case-sensitive)
614 * Corresponding partition type (PART\_TYPE\_...) or PART\_TYPE\_UNKNOWN
616 int part_get_type_by_name(const char *name);
619 static inline int part_driver_get_count(void)
622 static inline struct part_driver *part_driver_get_first(void)
624 #endif /* CONFIG_PARTITIONS */