2 * (C) Copyright 2000-2004
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
13 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
14 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
15 ((x & 0xffff0000) ? 16 : 0))
16 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
19 #define PART_TYPE_UNKNOWN 0x00
20 #define PART_TYPE_MAC 0x01
21 #define PART_TYPE_DOS 0x02
22 #define PART_TYPE_ISO 0x03
23 #define PART_TYPE_AMIGA 0x04
24 #define PART_TYPE_EFI 0x05
27 * Type string for U-Boot bootable partitions
29 #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
30 #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
33 #define DEV_TYPE_UNKNOWN 0xff /* not connected */
34 #define DEV_TYPE_HARDDISK 0x00 /* harddisk */
35 #define DEV_TYPE_TAPE 0x01 /* Tape */
36 #define DEV_TYPE_CDROM 0x05 /* CD-ROM */
37 #define DEV_TYPE_OPDISK 0x07 /* optical disk */
39 typedef struct disk_partition {
40 lbaint_t start; /* # of first block in partition */
41 lbaint_t size; /* number of blocks in partition */
42 ulong blksz; /* block size in bytes */
43 uchar name[32]; /* partition name */
44 uchar type[32]; /* string type description */
45 int bootable; /* Active/Bootable flag is set */
46 #ifdef CONFIG_PARTITION_UUIDS
47 char uuid[37]; /* filesystem UUID as string, if exists */
49 #ifdef CONFIG_PARTITION_TYPE_GUID
50 char type_guid[37]; /* type GUID as string, if exists */
54 /* Misc _get_dev functions */
55 #ifdef CONFIG_PARTITIONS
57 * blk_get_dev() - get a pointer to a block device given its type and number
59 * Each interface allocates its own devices and typically struct blk_desc is
60 * contained with the interface's data structure. There is no global
61 * numbering for block devices, so the interface name must be provided.
63 * @ifname: Interface name (e.g. "ide", "scsi")
64 * @dev: Device number (0 for first device on that interface, 1 for
66 * @return pointer to the block device, or NULL if not available, or an
69 struct blk_desc *blk_get_dev(const char *ifname, int dev);
70 struct blk_desc *ide_get_dev(int dev);
71 struct blk_desc *sata_get_dev(int dev);
72 struct blk_desc *scsi_get_dev(int dev);
73 struct blk_desc *usb_stor_get_dev(int dev);
74 struct blk_desc *mmc_get_dev(int dev);
77 * mmc_select_hwpart() - Select the MMC hardware partiion on an MMC device
79 * MMC devices can support partitioning at the hardware level. This is quite
80 * separate from the normal idea of software-based partitions. MMC hardware
81 * partitions must be explicitly selected. Once selected only the region of
82 * the device covered by that partition is accessible.
84 * The MMC standard provides for two boot partitions (numbered 1 and 2),
85 * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
87 * @dev_num: Block device number (struct blk_desc->dev value)
88 * @hwpart: Hardware partition number to select. 0 means the raw device,
89 * 1 is the first partition, 2 is the second, etc.
90 * @return 0 if OK, other value for an error
92 int mmc_select_hwpart(int dev_num, int hwpart);
93 struct blk_desc *systemace_get_dev(int dev);
94 struct blk_desc *mg_disk_get_dev(int dev);
95 struct blk_desc *host_get_dev(int dev);
96 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
99 int get_partition_info(struct blk_desc *dev_desc, int part,
100 disk_partition_t *info);
101 void print_part(struct blk_desc *dev_desc);
102 void init_part(struct blk_desc *dev_desc);
103 void dev_print(struct blk_desc *dev_desc);
106 * blk_get_device_by_str() - Get a block device given its interface/hw partition
108 * Each interface allocates its own devices and typically struct blk_desc is
109 * contained with the interface's data structure. There is no global
110 * numbering for block devices, so the interface name must be provided.
112 * The hardware parition is not related to the normal software partitioning
113 * of a device - each hardware partition is effectively a separately
114 * accessible block device. When a hardware parition is selected on MMC the
115 * other hardware partitions become inaccessible. The same block device is
116 * used to access all hardware partitions, but its capacity may change when a
117 * different hardware partition is selected.
119 * When a hardware partition number is given, the block device switches to
120 * that hardware partition.
122 * @ifname: Interface name (e.g. "ide", "scsi")
123 * @dev_str: Device and optional hw partition. This can either be a string
124 * containing the device number (e.g. "2") or the device number
125 * and hardware partition number (e.g. "2.4") for devices that
126 * support it (currently only MMC).
127 * @dev_desc: Returns a pointer to the block device on success
128 * @return block device number (local to the interface), or -1 on error
130 int blk_get_device_by_str(const char *ifname, const char *dev_str,
131 struct blk_desc **dev_desc);
134 * blk_get_device_part_str() - Get a block device and partition
136 * This calls blk_get_device_by_str() to look up a device. It also looks up
137 * a partition and returns information about it.
139 * @dev_part_str is in the format:
140 * <dev>.<hw_part>:<part> where <dev> is the device number,
141 * <hw_part> is the optional hardware partition number and
142 * <part> is the partition number
144 * If ifname is "hostfs" then this function returns the sandbox host block
147 * If ifname is ubi, then this function returns 0, with @info set to a
148 * special UBI device.
150 * If @dev_part_str is NULL or empty or "-", then this function looks up
151 * the "bootdevice" environment variable and uses that string instead.
153 * If the partition string is empty then the first partition is used. If the
154 * partition string is "auto" then the first bootable partition is used.
156 * @ifname: Interface name (e.g. "ide", "scsi")
157 * @dev_part_str: Device and partition string
158 * @dev_desc: Returns a pointer to the block device on success
159 * @info: Returns partition information
160 * @allow_whole_dev: true to allow the user to select partition 0
161 * (which means the whole device), false to require a valid
162 * partition number >= 1
163 * @return partition number, or -1 on error
166 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
167 struct blk_desc **dev_desc,
168 disk_partition_t *info, int allow_whole_dev);
170 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
172 static inline struct blk_desc *ide_get_dev(int dev) { return NULL; }
173 static inline struct blk_desc *sata_get_dev(int dev) { return NULL; }
174 static inline struct blk_desc *scsi_get_dev(int dev) { return NULL; }
175 static inline struct blk_desc *usb_stor_get_dev(int dev) { return NULL; }
176 static inline struct blk_desc *mmc_get_dev(int dev) { return NULL; }
177 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
178 static inline struct blk_desc *systemace_get_dev(int dev) { return NULL; }
179 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
180 static inline struct blk_desc *host_get_dev(int dev) { return NULL; }
182 static inline int get_partition_info(struct blk_desc *dev_desc, int part,
183 disk_partition_t *info) { return -1; }
184 static inline void print_part(struct blk_desc *dev_desc) {}
185 static inline void init_part(struct blk_desc *dev_desc) {}
186 static inline void dev_print(struct blk_desc *dev_desc) {}
187 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
188 struct blk_desc **dev_desc)
190 static inline int blk_get_device_part_str(const char *ifname,
191 const char *dev_part_str,
192 struct blk_desc **dev_desc,
193 disk_partition_t *info,
195 { *dev_desc = NULL; return -1; }
198 #ifdef CONFIG_MAC_PARTITION
199 /* disk/part_mac.c */
200 int get_partition_info_mac(struct blk_desc *dev_desc, int part,
201 disk_partition_t *info);
202 void print_part_mac(struct blk_desc *dev_desc);
203 int test_part_mac(struct blk_desc *dev_desc);
206 #ifdef CONFIG_DOS_PARTITION
207 /* disk/part_dos.c */
208 int get_partition_info_dos(struct blk_desc *dev_desc, int part,
209 disk_partition_t *info);
210 void print_part_dos(struct blk_desc *dev_desc);
211 int test_part_dos(struct blk_desc *dev_desc);
214 #ifdef CONFIG_ISO_PARTITION
215 /* disk/part_iso.c */
216 int get_partition_info_iso(struct blk_desc *dev_desc, int part,
217 disk_partition_t *info);
218 void print_part_iso(struct blk_desc *dev_desc);
219 int test_part_iso(struct blk_desc *dev_desc);
222 #ifdef CONFIG_AMIGA_PARTITION
223 /* disk/part_amiga.c */
224 int get_partition_info_amiga(struct blk_desc *dev_desc, int part,
225 disk_partition_t *info);
226 void print_part_amiga(struct blk_desc *dev_desc);
227 int test_part_amiga(struct blk_desc *dev_desc);
230 #ifdef CONFIG_EFI_PARTITION
231 #include <part_efi.h>
232 /* disk/part_efi.c */
233 int get_partition_info_efi(struct blk_desc *dev_desc, int part,
234 disk_partition_t *info);
236 * get_partition_info_efi_by_name() - Find the specified GPT partition table entry
238 * @param dev_desc - block device descriptor
239 * @param gpt_name - the specified table entry name
240 * @param info - returns the disk partition info
242 * @return - '0' on match, '-1' on no match, otherwise error
244 int get_partition_info_efi_by_name(struct blk_desc *dev_desc,
245 const char *name, disk_partition_t *info);
246 void print_part_efi(struct blk_desc *dev_desc);
247 int test_part_efi(struct blk_desc *dev_desc);
250 * write_gpt_table() - Write the GUID Partition Table to disk
252 * @param dev_desc - block device descriptor
253 * @param gpt_h - pointer to GPT header representation
254 * @param gpt_e - pointer to GPT partition table entries
256 * @return - zero on success, otherwise error
258 int write_gpt_table(struct blk_desc *dev_desc,
259 gpt_header *gpt_h, gpt_entry *gpt_e);
262 * gpt_fill_pte(): Fill the GPT partition table entry
264 * @param gpt_h - GPT header representation
265 * @param gpt_e - GPT partition table entries
266 * @param partitions - list of partitions
267 * @param parts - number of partitions
269 * @return zero on success
271 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
272 disk_partition_t *partitions, int parts);
275 * gpt_fill_header(): Fill the GPT header
277 * @param dev_desc - block device descriptor
278 * @param gpt_h - GPT header representation
279 * @param str_guid - disk guid string representation
280 * @param parts_count - number of partitions
282 * @return - error on str_guid conversion error
284 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
285 char *str_guid, int parts_count);
288 * gpt_restore(): Restore GPT partition table
290 * @param dev_desc - block device descriptor
291 * @param str_disk_guid - disk GUID
292 * @param partitions - list of partitions
293 * @param parts - number of partitions
295 * @return zero on success
297 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
298 disk_partition_t *partitions, const int parts_count);
301 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
303 * @param dev_desc - block device descriptor
304 * @param buf - buffer which contains the MBR and Primary GPT info
306 * @return - '0' on success, otherwise error
308 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
311 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
313 * @param dev_desc - block device descriptor
314 * @param buf - buffer which contains the MBR and Primary GPT info
316 * @return - '0' on success, otherwise error
318 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
321 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
322 * and partition table entries (PTE)
324 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
326 * @param dev_desc - block device descriptor
327 * @param gpt_head - pointer to GPT header data read from medium
328 * @param gpt_pte - pointer to GPT partition table enties read from medium
330 * @return - '0' on success, otherwise error
332 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
333 gpt_entry **gpt_pte);
336 * gpt_verify_partitions() - Function to check if partitions' name, start and
337 * size correspond to '$partitions' env variable
339 * This function checks if on medium stored GPT data is in sync with information
340 * provided in '$partitions' environment variable. Specificially, name, start
341 * and size of the partition is checked.
343 * @param dev_desc - block device descriptor
344 * @param partitions - partition data read from '$partitions' env variable
345 * @param parts - number of partitions read from '$partitions' env variable
346 * @param gpt_head - pointer to GPT header data read from medium
347 * @param gpt_pte - pointer to GPT partition table enties read from medium
349 * @return - '0' on success, otherwise error
351 int gpt_verify_partitions(struct blk_desc *dev_desc,
352 disk_partition_t *partitions, int parts,
353 gpt_header *gpt_head, gpt_entry **gpt_pte);