]>
Commit | Line | Data |
---|---|---|
012771d8 | 1 | /* |
42dfe7a1 | 2 | * (C) Copyright 2000-2004 |
012771d8 WD |
3 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
4 | * | |
3765b3e7 | 5 | * SPDX-License-Identifier: GPL-2.0+ |
012771d8 WD |
6 | */ |
7 | #ifndef _PART_H | |
8 | #define _PART_H | |
735dd97b | 9 | |
1a73661b | 10 | #include <blk.h> |
6e592385 | 11 | #include <ide.h> |
db9b6200 | 12 | #include <uuid.h> |
09a49930 | 13 | #include <linux/list.h> |
012771d8 | 14 | |
d96a9804 AG |
15 | struct block_drvr { |
16 | char *name; | |
d96a9804 AG |
17 | int (*select_hwpart)(int dev_num, int hwpart); |
18 | }; | |
19 | ||
0472fbfd EE |
20 | #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \ |
21 | ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \ | |
22 | ((x & 0xffff0000) ? 16 : 0)) | |
23 | #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1)) | |
ae1768a7 | 24 | |
012771d8 | 25 | /* Part types */ |
42dfe7a1 | 26 | #define PART_TYPE_UNKNOWN 0x00 |
012771d8 WD |
27 | #define PART_TYPE_MAC 0x01 |
28 | #define PART_TYPE_DOS 0x02 | |
29 | #define PART_TYPE_ISO 0x03 | |
42dfe7a1 | 30 | #define PART_TYPE_AMIGA 0x04 |
07f3d789 | 31 | #define PART_TYPE_EFI 0x05 |
c7de829c | 32 | |
87b8530f PK |
33 | /* maximum number of partition entries supported by search */ |
34 | #define DOS_ENTRY_NUMBERS 8 | |
35 | #define ISO_ENTRY_NUMBERS 64 | |
36 | #define MAC_ENTRY_NUMBERS 64 | |
37 | #define AMIGA_ENTRY_NUMBERS 8 | |
b0fce99b WD |
38 | /* |
39 | * Type string for U-Boot bootable partitions | |
40 | */ | |
41 | #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */ | |
42 | #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */ | |
43 | ||
012771d8 | 44 | /* device types */ |
b0fce99b WD |
45 | #define DEV_TYPE_UNKNOWN 0xff /* not connected */ |
46 | #define DEV_TYPE_HARDDISK 0x00 /* harddisk */ | |
42dfe7a1 WD |
47 | #define DEV_TYPE_TAPE 0x01 /* Tape */ |
48 | #define DEV_TYPE_CDROM 0x05 /* CD-ROM */ | |
49 | #define DEV_TYPE_OPDISK 0x07 /* optical disk */ | |
012771d8 | 50 | |
92856b48 AC |
51 | #define PART_NAME_LEN 32 |
52 | #define PART_TYPE_LEN 32 | |
e6faf21f | 53 | #define MAX_SEARCH_PARTITIONS 64 |
92856b48 | 54 | |
42dfe7a1 | 55 | typedef struct disk_partition { |
04735e9c FL |
56 | lbaint_t start; /* # of first block in partition */ |
57 | lbaint_t size; /* number of blocks in partition */ | |
012771d8 | 58 | ulong blksz; /* block size in bytes */ |
92856b48 AC |
59 | uchar name[PART_NAME_LEN]; /* partition name */ |
60 | uchar type[PART_TYPE_LEN]; /* string type description */ | |
40e0e568 | 61 | int bootable; /* Active/Bootable flag is set */ |
b331cd62 | 62 | #if CONFIG_IS_ENABLED(PARTITION_UUIDS) |
db9b6200 | 63 | char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */ |
894bfbbf | 64 | #endif |
7561b258 | 65 | #ifdef CONFIG_PARTITION_TYPE_GUID |
db9b6200 | 66 | char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */ |
7561b258 | 67 | #endif |
f0fb4fa7 DW |
68 | #ifdef CONFIG_DOS_PARTITION |
69 | uchar sys_ind; /* partition type */ | |
70 | #endif | |
012771d8 WD |
71 | } disk_partition_t; |
72 | ||
09a49930 AC |
73 | struct disk_part { |
74 | int partnum; | |
75 | disk_partition_t gpt_part_info; | |
76 | struct list_head list; | |
77 | }; | |
78 | ||
735dd97b | 79 | /* Misc _get_dev functions */ |
df3fc526 | 80 | #ifdef CONFIG_PARTITIONS |
fb1b7be9 | 81 | /** |
db1d9e78 | 82 | * blk_get_dev() - get a pointer to a block device given its type and number |
fb1b7be9 SG |
83 | * |
84 | * Each interface allocates its own devices and typically struct blk_desc is | |
85 | * contained with the interface's data structure. There is no global | |
86 | * numbering for block devices, so the interface name must be provided. | |
87 | * | |
88 | * @ifname: Interface name (e.g. "ide", "scsi") | |
89 | * @dev: Device number (0 for first device on that interface, 1 for | |
90 | * second, etc. | |
91 | * @return pointer to the block device, or NULL if not available, or an | |
92 | * error occurred. | |
93 | */ | |
db1d9e78 | 94 | struct blk_desc *blk_get_dev(const char *ifname, int dev); |
fb1b7be9 | 95 | |
4101f687 | 96 | struct blk_desc *mg_disk_get_dev(int dev); |
4101f687 | 97 | int host_get_dev_err(int dev, struct blk_desc **blk_devp); |
735dd97b | 98 | |
012771d8 | 99 | /* disk/part.c */ |
3e8bd469 | 100 | int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info); |
4bbcc965 RC |
101 | /** |
102 | * part_get_info_whole_disk() - get partition info for the special case of | |
103 | * a partition occupying the entire disk. | |
104 | */ | |
105 | int part_get_info_whole_disk(struct blk_desc *dev_desc, disk_partition_t *info); | |
106 | ||
3e8bd469 SG |
107 | void part_print(struct blk_desc *dev_desc); |
108 | void part_init(struct blk_desc *dev_desc); | |
4101f687 | 109 | void dev_print(struct blk_desc *dev_desc); |
ebac37cf SG |
110 | |
111 | /** | |
112 | * blk_get_device_by_str() - Get a block device given its interface/hw partition | |
113 | * | |
114 | * Each interface allocates its own devices and typically struct blk_desc is | |
115 | * contained with the interface's data structure. There is no global | |
116 | * numbering for block devices, so the interface name must be provided. | |
117 | * | |
118 | * The hardware parition is not related to the normal software partitioning | |
119 | * of a device - each hardware partition is effectively a separately | |
120 | * accessible block device. When a hardware parition is selected on MMC the | |
121 | * other hardware partitions become inaccessible. The same block device is | |
122 | * used to access all hardware partitions, but its capacity may change when a | |
123 | * different hardware partition is selected. | |
124 | * | |
125 | * When a hardware partition number is given, the block device switches to | |
126 | * that hardware partition. | |
127 | * | |
128 | * @ifname: Interface name (e.g. "ide", "scsi") | |
129 | * @dev_str: Device and optional hw partition. This can either be a string | |
130 | * containing the device number (e.g. "2") or the device number | |
131 | * and hardware partition number (e.g. "2.4") for devices that | |
132 | * support it (currently only MMC). | |
133 | * @dev_desc: Returns a pointer to the block device on success | |
134 | * @return block device number (local to the interface), or -1 on error | |
135 | */ | |
136 | int blk_get_device_by_str(const char *ifname, const char *dev_str, | |
137 | struct blk_desc **dev_desc); | |
e35929e4 SG |
138 | |
139 | /** | |
140 | * blk_get_device_part_str() - Get a block device and partition | |
141 | * | |
142 | * This calls blk_get_device_by_str() to look up a device. It also looks up | |
143 | * a partition and returns information about it. | |
144 | * | |
145 | * @dev_part_str is in the format: | |
146 | * <dev>.<hw_part>:<part> where <dev> is the device number, | |
147 | * <hw_part> is the optional hardware partition number and | |
148 | * <part> is the partition number | |
149 | * | |
150 | * If ifname is "hostfs" then this function returns the sandbox host block | |
151 | * device. | |
152 | * | |
153 | * If ifname is ubi, then this function returns 0, with @info set to a | |
154 | * special UBI device. | |
155 | * | |
156 | * If @dev_part_str is NULL or empty or "-", then this function looks up | |
157 | * the "bootdevice" environment variable and uses that string instead. | |
158 | * | |
159 | * If the partition string is empty then the first partition is used. If the | |
160 | * partition string is "auto" then the first bootable partition is used. | |
161 | * | |
162 | * @ifname: Interface name (e.g. "ide", "scsi") | |
163 | * @dev_part_str: Device and partition string | |
164 | * @dev_desc: Returns a pointer to the block device on success | |
165 | * @info: Returns partition information | |
166 | * @allow_whole_dev: true to allow the user to select partition 0 | |
167 | * (which means the whole device), false to require a valid | |
168 | * partition number >= 1 | |
169 | * @return partition number, or -1 on error | |
170 | * | |
171 | */ | |
172 | int blk_get_device_part_str(const char *ifname, const char *dev_part_str, | |
173 | struct blk_desc **dev_desc, | |
174 | disk_partition_t *info, int allow_whole_dev); | |
87b8530f PK |
175 | |
176 | /** | |
177 | * part_get_info_by_name() - Search for a partition by name | |
178 | * among all available registered partitions | |
179 | * | |
180 | * @param dev_desc - block device descriptor | |
181 | * @param gpt_name - the specified table entry name | |
182 | * @param info - returns the disk partition info | |
183 | * | |
88b6329c AD |
184 | * @return - the partition number on match (starting on 1), -1 on no match, |
185 | * otherwise error | |
87b8530f PK |
186 | */ |
187 | int part_get_info_by_name(struct blk_desc *dev_desc, | |
188 | const char *name, disk_partition_t *info); | |
189 | ||
da2ee24d PK |
190 | /** |
191 | * part_set_generic_name() - create generic partition like hda1 or sdb2 | |
192 | * | |
193 | * Helper function for partition tables, which don't hold partition names | |
194 | * (DOS, ISO). Generates partition name out of the device type and partition | |
195 | * number. | |
196 | * | |
197 | * @dev_desc: pointer to the block device | |
198 | * @part_num: partition number for which the name is generated | |
199 | * @name: buffer where the name is written | |
200 | */ | |
201 | void part_set_generic_name(const struct blk_desc *dev_desc, | |
202 | int part_num, char *name); | |
203 | ||
d96a9804 | 204 | extern const struct block_drvr block_drvr[]; |
df3fc526 | 205 | #else |
db1d9e78 | 206 | static inline struct blk_desc *blk_get_dev(const char *ifname, int dev) |
99d2c205 | 207 | { return NULL; } |
4101f687 | 208 | static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; } |
012771d8 | 209 | |
3e8bd469 SG |
210 | static inline int part_get_info(struct blk_desc *dev_desc, int part, |
211 | disk_partition_t *info) { return -1; } | |
4bbcc965 RC |
212 | static inline int part_get_info_whole_disk(struct blk_desc *dev_desc, |
213 | disk_partition_t *info) | |
214 | { return -1; } | |
3e8bd469 SG |
215 | static inline void part_print(struct blk_desc *dev_desc) {} |
216 | static inline void part_init(struct blk_desc *dev_desc) {} | |
4101f687 | 217 | static inline void dev_print(struct blk_desc *dev_desc) {} |
ebac37cf SG |
218 | static inline int blk_get_device_by_str(const char *ifname, const char *dev_str, |
219 | struct blk_desc **dev_desc) | |
2023e608 | 220 | { return -1; } |
e35929e4 | 221 | static inline int blk_get_device_part_str(const char *ifname, |
10a37fd7 | 222 | const char *dev_part_str, |
4101f687 | 223 | struct blk_desc **dev_desc, |
10a37fd7 SW |
224 | disk_partition_t *info, |
225 | int allow_whole_dev) | |
99d2c205 | 226 | { *dev_desc = NULL; return -1; } |
df3fc526 | 227 | #endif |
012771d8 | 228 | |
96e5b03c SG |
229 | /* |
230 | * We don't support printing partition information in SPL and only support | |
231 | * getting partition information in a few cases. | |
232 | */ | |
233 | #ifdef CONFIG_SPL_BUILD | |
234 | # define part_print_ptr(x) NULL | |
d9b2678e | 235 | # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \ |
96e5b03c SG |
236 | defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION) |
237 | # define part_get_info_ptr(x) x | |
238 | # else | |
239 | # define part_get_info_ptr(x) NULL | |
240 | # endif | |
241 | #else | |
242 | #define part_print_ptr(x) x | |
243 | #define part_get_info_ptr(x) x | |
012771d8 WD |
244 | #endif |
245 | ||
012771d8 | 246 | |
96e5b03c SG |
247 | struct part_driver { |
248 | const char *name; | |
249 | int part_type; | |
87b8530f | 250 | const int max_entries; /* maximum number of entries to search */ |
012771d8 | 251 | |
96e5b03c SG |
252 | /** |
253 | * get_info() - Get information about a partition | |
254 | * | |
255 | * @dev_desc: Block device descriptor | |
256 | * @part: Partition number (1 = first) | |
257 | * @info: Returns partition information | |
258 | */ | |
259 | int (*get_info)(struct blk_desc *dev_desc, int part, | |
260 | disk_partition_t *info); | |
261 | ||
262 | /** | |
263 | * print() - Print partition information | |
264 | * | |
265 | * @dev_desc: Block device descriptor | |
266 | */ | |
267 | void (*print)(struct blk_desc *dev_desc); | |
268 | ||
269 | /** | |
270 | * test() - Test if a device contains this partition type | |
271 | * | |
272 | * @dev_desc: Block device descriptor | |
273 | * @return 0 if the block device appears to contain this partition | |
274 | * type, -ve if not | |
275 | */ | |
276 | int (*test)(struct blk_desc *dev_desc); | |
277 | }; | |
278 | ||
279 | /* Declare a new U-Boot partition 'driver' */ | |
280 | #define U_BOOT_PART_TYPE(__name) \ | |
281 | ll_entry_declare(struct part_driver, __name, part_driver) | |
c7de829c | 282 | |
bd42a942 | 283 | #if CONFIG_IS_ENABLED(EFI_PARTITION) |
40684ddb | 284 | #include <part_efi.h> |
07f3d789 | 285 | /* disk/part_efi.c */ |
40684ddb ŁM |
286 | /** |
287 | * write_gpt_table() - Write the GUID Partition Table to disk | |
288 | * | |
289 | * @param dev_desc - block device descriptor | |
290 | * @param gpt_h - pointer to GPT header representation | |
291 | * @param gpt_e - pointer to GPT partition table entries | |
292 | * | |
293 | * @return - zero on success, otherwise error | |
294 | */ | |
4101f687 | 295 | int write_gpt_table(struct blk_desc *dev_desc, |
40684ddb ŁM |
296 | gpt_header *gpt_h, gpt_entry *gpt_e); |
297 | ||
298 | /** | |
299 | * gpt_fill_pte(): Fill the GPT partition table entry | |
300 | * | |
47d7ee47 | 301 | * @param dev_desc - block device descriptor |
40684ddb ŁM |
302 | * @param gpt_h - GPT header representation |
303 | * @param gpt_e - GPT partition table entries | |
304 | * @param partitions - list of partitions | |
305 | * @param parts - number of partitions | |
306 | * | |
307 | * @return zero on success | |
308 | */ | |
47d7ee47 MR |
309 | int gpt_fill_pte(struct blk_desc *dev_desc, |
310 | gpt_header *gpt_h, gpt_entry *gpt_e, | |
311 | disk_partition_t *partitions, int parts); | |
40684ddb ŁM |
312 | |
313 | /** | |
314 | * gpt_fill_header(): Fill the GPT header | |
315 | * | |
316 | * @param dev_desc - block device descriptor | |
317 | * @param gpt_h - GPT header representation | |
318 | * @param str_guid - disk guid string representation | |
319 | * @param parts_count - number of partitions | |
320 | * | |
321 | * @return - error on str_guid conversion error | |
322 | */ | |
4101f687 | 323 | int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, |
40684ddb ŁM |
324 | char *str_guid, int parts_count); |
325 | ||
326 | /** | |
327 | * gpt_restore(): Restore GPT partition table | |
328 | * | |
329 | * @param dev_desc - block device descriptor | |
330 | * @param str_disk_guid - disk GUID | |
331 | * @param partitions - list of partitions | |
332 | * @param parts - number of partitions | |
333 | * | |
334 | * @return zero on success | |
335 | */ | |
4101f687 | 336 | int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, |
40684ddb | 337 | disk_partition_t *partitions, const int parts_count); |
0ff7e585 SR |
338 | |
339 | /** | |
340 | * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid | |
341 | * | |
342 | * @param dev_desc - block device descriptor | |
343 | * @param buf - buffer which contains the MBR and Primary GPT info | |
344 | * | |
345 | * @return - '0' on success, otherwise error | |
346 | */ | |
4101f687 | 347 | int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); |
0ff7e585 SR |
348 | |
349 | /** | |
350 | * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT | |
351 | * | |
352 | * @param dev_desc - block device descriptor | |
353 | * @param buf - buffer which contains the MBR and Primary GPT info | |
354 | * | |
355 | * @return - '0' on success, otherwise error | |
356 | */ | |
4101f687 | 357 | int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); |
cef68bf9 LM |
358 | |
359 | /** | |
360 | * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header | |
361 | * and partition table entries (PTE) | |
362 | * | |
363 | * As a side effect if sets gpt_head and gpt_pte so they point to GPT data. | |
364 | * | |
365 | * @param dev_desc - block device descriptor | |
366 | * @param gpt_head - pointer to GPT header data read from medium | |
367 | * @param gpt_pte - pointer to GPT partition table enties read from medium | |
368 | * | |
369 | * @return - '0' on success, otherwise error | |
370 | */ | |
4101f687 | 371 | int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, |
cef68bf9 LM |
372 | gpt_entry **gpt_pte); |
373 | ||
374 | /** | |
375 | * gpt_verify_partitions() - Function to check if partitions' name, start and | |
376 | * size correspond to '$partitions' env variable | |
377 | * | |
378 | * This function checks if on medium stored GPT data is in sync with information | |
379 | * provided in '$partitions' environment variable. Specificially, name, start | |
380 | * and size of the partition is checked. | |
381 | * | |
382 | * @param dev_desc - block device descriptor | |
383 | * @param partitions - partition data read from '$partitions' env variable | |
384 | * @param parts - number of partitions read from '$partitions' env variable | |
385 | * @param gpt_head - pointer to GPT header data read from medium | |
386 | * @param gpt_pte - pointer to GPT partition table enties read from medium | |
387 | * | |
388 | * @return - '0' on success, otherwise error | |
389 | */ | |
4101f687 | 390 | int gpt_verify_partitions(struct blk_desc *dev_desc, |
cef68bf9 LM |
391 | disk_partition_t *partitions, int parts, |
392 | gpt_header *gpt_head, gpt_entry **gpt_pte); | |
73d6d18b AC |
393 | |
394 | ||
395 | /** | |
396 | * get_disk_guid() - Function to read the GUID string from a device's GPT | |
397 | * | |
398 | * This function reads the GUID string from a block device whose descriptor | |
399 | * is provided. | |
400 | * | |
401 | * @param dev_desc - block device descriptor | |
402 | * @param guid - pre-allocated string in which to return the GUID | |
403 | * | |
404 | * @return - '0' on success, otherwise error | |
405 | */ | |
406 | int get_disk_guid(struct blk_desc *dev_desc, char *guid); | |
407 | ||
07f3d789 | 408 | #endif |
409 | ||
b0cf7339 | 410 | #if CONFIG_IS_ENABLED(DOS_PARTITION) |
b6dd69a4 PK |
411 | /** |
412 | * is_valid_dos_buf() - Ensure that a DOS MBR image is valid | |
413 | * | |
414 | * @param buf - buffer which contains the MBR | |
415 | * | |
416 | * @return - '0' on success, otherwise error | |
417 | */ | |
418 | int is_valid_dos_buf(void *buf); | |
419 | ||
420 | /** | |
421 | * write_mbr_partition() - write DOS MBR | |
422 | * | |
423 | * @param dev_desc - block device descriptor | |
424 | * @param buf - buffer which contains the MBR | |
425 | * | |
426 | * @return - '0' on success, otherwise error | |
427 | */ | |
428 | int write_mbr_partition(struct blk_desc *dev_desc, void *buf); | |
429 | ||
430 | #endif | |
431 | ||
432 | ||
012771d8 | 433 | #endif /* _PART_H */ |