2 * (C) Copyright 2000-2004
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
16 int (*select_hwpart)(int dev_num, int hwpart);
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))
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
32 /* maximum number of partition entries supported by search */
33 #define DOS_ENTRY_NUMBERS 8
34 #define ISO_ENTRY_NUMBERS 64
35 #define MAC_ENTRY_NUMBERS 64
36 #define AMIGA_ENTRY_NUMBERS 8
38 * Type string for U-Boot bootable partitions
40 #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
41 #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
44 #define DEV_TYPE_UNKNOWN 0xff /* not connected */
45 #define DEV_TYPE_HARDDISK 0x00 /* harddisk */
46 #define DEV_TYPE_TAPE 0x01 /* Tape */
47 #define DEV_TYPE_CDROM 0x05 /* CD-ROM */
48 #define DEV_TYPE_OPDISK 0x07 /* optical disk */
50 typedef struct disk_partition {
51 lbaint_t start; /* # of first block in partition */
52 lbaint_t size; /* number of blocks in partition */
53 ulong blksz; /* block size in bytes */
54 uchar name[32]; /* partition name */
55 uchar type[32]; /* string type description */
56 int bootable; /* Active/Bootable flag is set */
57 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
58 char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
60 #ifdef CONFIG_PARTITION_TYPE_GUID
61 char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */
63 #ifdef CONFIG_DOS_PARTITION
64 uchar sys_ind; /* partition type */
68 /* Misc _get_dev functions */
69 #ifdef CONFIG_PARTITIONS
71 * blk_get_dev() - get a pointer to a block device given its type and number
73 * Each interface allocates its own devices and typically struct blk_desc is
74 * contained with the interface's data structure. There is no global
75 * numbering for block devices, so the interface name must be provided.
77 * @ifname: Interface name (e.g. "ide", "scsi")
78 * @dev: Device number (0 for first device on that interface, 1 for
80 * @return pointer to the block device, or NULL if not available, or an
83 struct blk_desc *blk_get_dev(const char *ifname, int dev);
85 struct blk_desc *mg_disk_get_dev(int dev);
86 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
89 int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
90 void part_print(struct blk_desc *dev_desc);
91 void part_init(struct blk_desc *dev_desc);
92 void dev_print(struct blk_desc *dev_desc);
95 * blk_get_device_by_str() - Get a block device given its interface/hw partition
97 * Each interface allocates its own devices and typically struct blk_desc is
98 * contained with the interface's data structure. There is no global
99 * numbering for block devices, so the interface name must be provided.
101 * The hardware parition is not related to the normal software partitioning
102 * of a device - each hardware partition is effectively a separately
103 * accessible block device. When a hardware parition is selected on MMC the
104 * other hardware partitions become inaccessible. The same block device is
105 * used to access all hardware partitions, but its capacity may change when a
106 * different hardware partition is selected.
108 * When a hardware partition number is given, the block device switches to
109 * that hardware partition.
111 * @ifname: Interface name (e.g. "ide", "scsi")
112 * @dev_str: Device and optional hw partition. This can either be a string
113 * containing the device number (e.g. "2") or the device number
114 * and hardware partition number (e.g. "2.4") for devices that
115 * support it (currently only MMC).
116 * @dev_desc: Returns a pointer to the block device on success
117 * @return block device number (local to the interface), or -1 on error
119 int blk_get_device_by_str(const char *ifname, const char *dev_str,
120 struct blk_desc **dev_desc);
123 * blk_get_device_part_str() - Get a block device and partition
125 * This calls blk_get_device_by_str() to look up a device. It also looks up
126 * a partition and returns information about it.
128 * @dev_part_str is in the format:
129 * <dev>.<hw_part>:<part> where <dev> is the device number,
130 * <hw_part> is the optional hardware partition number and
131 * <part> is the partition number
133 * If ifname is "hostfs" then this function returns the sandbox host block
136 * If ifname is ubi, then this function returns 0, with @info set to a
137 * special UBI device.
139 * If @dev_part_str is NULL or empty or "-", then this function looks up
140 * the "bootdevice" environment variable and uses that string instead.
142 * If the partition string is empty then the first partition is used. If the
143 * partition string is "auto" then the first bootable partition is used.
145 * @ifname: Interface name (e.g. "ide", "scsi")
146 * @dev_part_str: Device and partition string
147 * @dev_desc: Returns a pointer to the block device on success
148 * @info: Returns partition information
149 * @allow_whole_dev: true to allow the user to select partition 0
150 * (which means the whole device), false to require a valid
151 * partition number >= 1
152 * @return partition number, or -1 on error
155 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
156 struct blk_desc **dev_desc,
157 disk_partition_t *info, int allow_whole_dev);
160 * part_get_info_by_name() - Search for a partition by name
161 * among all available registered partitions
163 * @param dev_desc - block device descriptor
164 * @param gpt_name - the specified table entry name
165 * @param info - returns the disk partition info
167 * @return - the partition number on match (starting on 1), -1 on no match,
170 int part_get_info_by_name(struct blk_desc *dev_desc,
171 const char *name, disk_partition_t *info);
174 * part_set_generic_name() - create generic partition like hda1 or sdb2
176 * Helper function for partition tables, which don't hold partition names
177 * (DOS, ISO). Generates partition name out of the device type and partition
180 * @dev_desc: pointer to the block device
181 * @part_num: partition number for which the name is generated
182 * @name: buffer where the name is written
184 void part_set_generic_name(const struct blk_desc *dev_desc,
185 int part_num, char *name);
187 extern const struct block_drvr block_drvr[];
189 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
191 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
193 static inline int part_get_info(struct blk_desc *dev_desc, int part,
194 disk_partition_t *info) { return -1; }
195 static inline void part_print(struct blk_desc *dev_desc) {}
196 static inline void part_init(struct blk_desc *dev_desc) {}
197 static inline void dev_print(struct blk_desc *dev_desc) {}
198 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
199 struct blk_desc **dev_desc)
201 static inline int blk_get_device_part_str(const char *ifname,
202 const char *dev_part_str,
203 struct blk_desc **dev_desc,
204 disk_partition_t *info,
206 { *dev_desc = NULL; return -1; }
210 * We don't support printing partition information in SPL and only support
211 * getting partition information in a few cases.
213 #ifdef CONFIG_SPL_BUILD
214 # define part_print_ptr(x) NULL
215 # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
216 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
217 # define part_get_info_ptr(x) x
219 # define part_get_info_ptr(x) NULL
222 #define part_print_ptr(x) x
223 #define part_get_info_ptr(x) x
230 const int max_entries; /* maximum number of entries to search */
233 * get_info() - Get information about a partition
235 * @dev_desc: Block device descriptor
236 * @part: Partition number (1 = first)
237 * @info: Returns partition information
239 int (*get_info)(struct blk_desc *dev_desc, int part,
240 disk_partition_t *info);
243 * print() - Print partition information
245 * @dev_desc: Block device descriptor
247 void (*print)(struct blk_desc *dev_desc);
250 * test() - Test if a device contains this partition type
252 * @dev_desc: Block device descriptor
253 * @return 0 if the block device appears to contain this partition
256 int (*test)(struct blk_desc *dev_desc);
259 /* Declare a new U-Boot partition 'driver' */
260 #define U_BOOT_PART_TYPE(__name) \
261 ll_entry_declare(struct part_driver, __name, part_driver)
263 #if CONFIG_IS_ENABLED(EFI_PARTITION)
264 #include <part_efi.h>
265 /* disk/part_efi.c */
267 * write_gpt_table() - Write the GUID Partition Table to disk
269 * @param dev_desc - block device descriptor
270 * @param gpt_h - pointer to GPT header representation
271 * @param gpt_e - pointer to GPT partition table entries
273 * @return - zero on success, otherwise error
275 int write_gpt_table(struct blk_desc *dev_desc,
276 gpt_header *gpt_h, gpt_entry *gpt_e);
279 * gpt_fill_pte(): Fill the GPT partition table entry
281 * @param gpt_h - GPT header representation
282 * @param gpt_e - GPT partition table entries
283 * @param partitions - list of partitions
284 * @param parts - number of partitions
286 * @return zero on success
288 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
289 disk_partition_t *partitions, int parts);
292 * gpt_fill_header(): Fill the GPT header
294 * @param dev_desc - block device descriptor
295 * @param gpt_h - GPT header representation
296 * @param str_guid - disk guid string representation
297 * @param parts_count - number of partitions
299 * @return - error on str_guid conversion error
301 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
302 char *str_guid, int parts_count);
305 * gpt_restore(): Restore GPT partition table
307 * @param dev_desc - block device descriptor
308 * @param str_disk_guid - disk GUID
309 * @param partitions - list of partitions
310 * @param parts - number of partitions
312 * @return zero on success
314 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
315 disk_partition_t *partitions, const int parts_count);
318 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
320 * @param dev_desc - block device descriptor
321 * @param buf - buffer which contains the MBR and Primary GPT info
323 * @return - '0' on success, otherwise error
325 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
328 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
330 * @param dev_desc - block device descriptor
331 * @param buf - buffer which contains the MBR and Primary GPT info
333 * @return - '0' on success, otherwise error
335 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
338 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
339 * and partition table entries (PTE)
341 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
343 * @param dev_desc - block device descriptor
344 * @param gpt_head - pointer to GPT header data read from medium
345 * @param gpt_pte - pointer to GPT partition table enties read from medium
347 * @return - '0' on success, otherwise error
349 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
350 gpt_entry **gpt_pte);
353 * gpt_verify_partitions() - Function to check if partitions' name, start and
354 * size correspond to '$partitions' env variable
356 * This function checks if on medium stored GPT data is in sync with information
357 * provided in '$partitions' environment variable. Specificially, name, start
358 * and size of the partition is checked.
360 * @param dev_desc - block device descriptor
361 * @param partitions - partition data read from '$partitions' env variable
362 * @param parts - number of partitions read from '$partitions' env variable
363 * @param gpt_head - pointer to GPT header data read from medium
364 * @param gpt_pte - pointer to GPT partition table enties read from medium
366 * @return - '0' on success, otherwise error
368 int gpt_verify_partitions(struct blk_desc *dev_desc,
369 disk_partition_t *partitions, int parts,
370 gpt_header *gpt_head, gpt_entry **gpt_pte);
373 #if CONFIG_IS_ENABLED(DOS_PARTITION)
375 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
377 * @param buf - buffer which contains the MBR
379 * @return - '0' on success, otherwise error
381 int is_valid_dos_buf(void *buf);
384 * write_mbr_partition() - write DOS MBR
386 * @param dev_desc - block device descriptor
387 * @param buf - buffer which contains the MBR
389 * @return - '0' on success, otherwise error
391 int write_mbr_partition(struct blk_desc *dev_desc, void *buf);