Merge tag 'fsl-qoriq-2023-7-13' of https://source.denx.de/u-boot/custodians/u-boot...
[platform/kernel/u-boot.git] / include / part.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2000-2004
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  */
6 #ifndef _PART_H
7 #define _PART_H
8
9 #include <blk.h>
10 #include <ide.h>
11 #include <uuid.h>
12 #include <linker_lists.h>
13 #include <linux/errno.h>
14 #include <linux/list.h>
15
16 struct block_drvr {
17         char *name;
18         int (*select_hwpart)(int dev_num, int hwpart);
19 };
20
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))
25
26 /* Part types */
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
33
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
39 /*
40  * Type string for U-Boot bootable partitions
41  */
42 #define BOOT_PART_TYPE  "U-Boot"        /* primary boot partition type  */
43 #define BOOT_PART_COMP  "PPCBoot"       /* PPCBoot compatibility type   */
44
45 /* device types */
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 */
51
52 #define PART_NAME_LEN 32
53 #define PART_TYPE_LEN 32
54 #define MAX_SEARCH_PARTITIONS 128
55
56 #define PART_BOOTABLE                   ((int)BIT(0))
57 #define PART_EFI_SYSTEM_PARTITION       ((int)BIT(1))
58
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              */
65         /*
66          * The bootable is a bitmask with the following fields:
67          *
68          * PART_BOOTABLE                the MBR bootable flag is set
69          * PART_EFI_SYSTEM_PARTITION    the partition is an EFI system partition
70          */
71         int     bootable;
72 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
73         char    uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
74 #endif
75 #ifdef CONFIG_PARTITION_TYPE_GUID
76         char    type_guid[UUID_STR_LEN + 1];    /* type GUID as string, if exists       */
77 #endif
78 #ifdef CONFIG_DOS_PARTITION
79         uchar   sys_ind;        /* partition type                       */
80 #endif
81 };
82
83 struct disk_part {
84         int partnum;
85         struct disk_partition gpt_part_info;
86         struct list_head list;
87 };
88
89 /* Misc _get_dev functions */
90 #if CONFIG_IS_ENABLED(PARTITIONS)
91 /**
92  * blk_get_dev() - get a pointer to a block device given its type and number
93  *
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.
97  *
98  * @ifname:     Interface name (e.g. "ide", "scsi")
99  * @dev:        Device number (0 for first device on that interface, 1 for
100  *              second, etc.
101  * Return: pointer to the block device, or NULL if not available, or an
102  *         error occurred.
103  */
104 struct blk_desc *blk_get_dev(const char *ifname, int dev);
105
106 struct blk_desc *mg_disk_get_dev(int dev);
107
108 /**
109  * part_get_info_by_type() - Get partitions from a block device using a specific
110  * partition driver
111  *
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.
115  *
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
119  *              choose a driver
120  * @info:       Returned partition information
121  *
122  * Return: 0 on success, negative errno on failure
123  */
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);
128 /**
129  * part_get_info_whole_disk() - get partition info for the special case of
130  * a partition occupying the entire disk.
131  */
132 int part_get_info_whole_disk(struct blk_desc *dev_desc,
133                              struct disk_partition *info);
134
135 void part_print(struct blk_desc *dev_desc);
136 void part_init(struct blk_desc *dev_desc);
137 void dev_print(struct blk_desc *dev_desc);
138
139 /**
140  * blk_get_device_by_str() - Get a block device given its interface/hw partition
141  *
142  * Each interface allocates its own devices and typically struct blk_desc is
143  * contained with the interface's data structure. There is no global
144  * numbering for block devices, so the interface name must be provided.
145  *
146  * The hardware parition is not related to the normal software partitioning
147  * of a device - each hardware partition is effectively a separately
148  * accessible block device. When a hardware parition is selected on MMC the
149  * other hardware partitions become inaccessible. The same block device is
150  * used to access all hardware partitions, but its capacity may change when a
151  * different hardware partition is selected.
152  *
153  * When a hardware partition number is given, the block device switches to
154  * that hardware partition.
155  *
156  * @ifname:     Interface name (e.g. "ide", "scsi")
157  * @dev_str:    Device and optional hw partition. This can either be a string
158  *              containing the device number (e.g. "2") or the device number
159  *              and hardware partition number (e.g. "2.4") for devices that
160  *              support it (currently only MMC).
161  * @dev_desc:   Returns a pointer to the block device on success
162  * Return: block device number (local to the interface), or -1 on error
163  */
164 int blk_get_device_by_str(const char *ifname, const char *dev_str,
165                           struct blk_desc **dev_desc);
166
167 /**
168  * blk_get_device_part_str() - Get a block device and partition
169  *
170  * This calls blk_get_device_by_str() to look up a device. It also looks up
171  * a partition and returns information about it.
172  *
173  * @dev_part_str is in the format:
174  *      <dev>.<hw_part>:<part> where <dev> is the device number,
175  *      <hw_part> is the optional hardware partition number and
176  *      <part> is the partition number
177  *
178  * If ifname is "hostfs" then this function returns the sandbox host block
179  * device.
180  *
181  * If ifname is ubi, then this function returns 0, with @info set to a
182  * special UBI device.
183  *
184  * If @dev_part_str is NULL or empty or "-", then this function looks up
185  * the "bootdevice" environment variable and uses that string instead.
186  *
187  * If the partition string is empty then the first partition is used. If the
188  * partition string is "auto" then the first bootable partition is used.
189  *
190  * @ifname:     Interface name (e.g. "ide", "scsi")
191  * @dev_part_str:       Device and partition string
192  * @dev_desc:   Returns a pointer to the block device on success
193  * @info:       Returns partition information
194  * @allow_whole_dev:    true to allow the user to select partition 0
195  *              (which means the whole device), false to require a valid
196  *              partition number >= 1
197  * Return: partition number, or -1 on error
198  *
199  */
200 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
201                             struct blk_desc **dev_desc,
202                             struct disk_partition *info, int allow_whole_dev);
203
204 /**
205  * part_get_info_by_name_type() - Search for a partition by name
206  *                                for only specified partition type
207  *
208  * @param dev_desc - block device descriptor
209  * @param gpt_name - the specified table entry name
210  * @param info - returns the disk partition info
211  * @param part_type - only search in partitions of this type
212  *
213  * Return: - the partition number on match (starting on 1), -1 on no match,
214  * otherwise error
215  */
216 int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
217                                struct disk_partition *info, int part_type);
218
219 /**
220  * part_get_info_by_name() - Search for a partition by name
221  *                           among all available registered partitions
222  *
223  * @param dev_desc - block device descriptor
224  * @param gpt_name - the specified table entry name
225  * @param info - returns the disk partition info
226  *
227  * Return: - the partition number on match (starting on 1), -1 on no match,
228  * otherwise error
229  */
230 int part_get_info_by_name(struct blk_desc *dev_desc,
231                               const char *name, struct disk_partition *info);
232
233 /**
234  * Get partition info from dev number + part name, or dev number + part number.
235  *
236  * Parse a device number and partition description (either name or number)
237  * in the form of device number plus partition name separated by a "#"
238  * (like "device_num#partition_name") or a device number plus a partition number
239  * separated by a ":". For example both "0#misc" and "0:1" can be valid
240  * partition descriptions for a given interface. If the partition is found, sets
241  * dev_desc and part_info accordingly with the information of the partition.
242  *
243  * @param[in] dev_iface Device interface
244  * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
245  * @param[out] dev_desc Place to store the device description pointer
246  * @param[out] part_info Place to store the partition information
247  * @param[in] allow_whole_dev true to allow the user to select partition 0
248  *              (which means the whole device), false to require a valid
249  *              partition number >= 1
250  * Return: the partition number on success, or negative errno on error
251  */
252 int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
253                                          const char *dev_part_str,
254                                          struct blk_desc **dev_desc,
255                                          struct disk_partition *part_info,
256                                          int allow_whole_dev);
257
258 /**
259  * part_set_generic_name() - create generic partition like hda1 or sdb2
260  *
261  * Helper function for partition tables, which don't hold partition names
262  * (DOS, ISO). Generates partition name out of the device type and partition
263  * number.
264  *
265  * @dev_desc:   pointer to the block device
266  * @part_num:   partition number for which the name is generated
267  * @name:       buffer where the name is written
268  */
269 void part_set_generic_name(const struct blk_desc *dev_desc,
270         int part_num, char *name);
271
272 extern const struct block_drvr block_drvr[];
273 #else
274 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
275 { return NULL; }
276 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
277
278 static inline int part_get_info(struct blk_desc *dev_desc, int part,
279                                 struct disk_partition *info) { return -1; }
280 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
281                                            struct disk_partition *info)
282 { return -1; }
283 static inline void part_print(struct blk_desc *dev_desc) {}
284 static inline void part_init(struct blk_desc *dev_desc) {}
285 static inline void dev_print(struct blk_desc *dev_desc) {}
286 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
287                                         struct blk_desc **dev_desc)
288 { return -1; }
289 static inline int blk_get_device_part_str(const char *ifname,
290                                           const char *dev_part_str,
291                                           struct blk_desc **dev_desc,
292                                           struct disk_partition *info,
293                                           int allow_whole_dev)
294 { *dev_desc = NULL; return -1; }
295
296 static inline int part_get_info_by_name_type(struct blk_desc *dev_desc,
297                                              const char *name,
298                                              struct disk_partition *info,
299                                              int part_type)
300 {
301         return -ENOENT;
302 }
303
304 static inline int part_get_info_by_name(struct blk_desc *dev_desc,
305                                         const char *name,
306                                         struct disk_partition *info)
307 {
308         return -ENOENT;
309 }
310
311 static inline int
312 part_get_info_by_dev_and_name_or_num(const char *dev_iface,
313                                      const char *dev_part_str,
314                                      struct blk_desc **dev_desc,
315                                      struct disk_partition *part_info,
316                                      int allow_whole_dev)
317 {
318         *dev_desc = NULL;
319         return -ENOSYS;
320 }
321 #endif
322
323 /**
324  * part_get_bootable() - Find the first bootable partition
325  *
326  * @desc: Block-device descriptor
327  * @return first bootable partition, or 0 if there is none
328  */
329 int part_get_bootable(struct blk_desc *desc);
330
331 struct udevice;
332 /**
333  * part_create_block_devices - Create block devices for disk partitions
334  *
335  * Create UCLASS_PARTITION udevices for each of disk partitions in @parent
336  *
337  * @blk_dev:    Whole disk device
338  */
339 int part_create_block_devices(struct udevice *blk_dev);
340
341 /**
342  * disk_blk_read() - read blocks from a disk partition
343  *
344  * @dev:        Device to read from (UCLASS_PARTITION)
345  * @start:      Start block number to read in the partition (0=first)
346  * @blkcnt:     Number of blocks to read
347  * @buffer:     Destination buffer for data read
348  * Returns: number of blocks read, or -ve error number (see the
349  * IS_ERR_VALUE() macro
350  */
351 ulong disk_blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
352                     void *buffer);
353
354 /**
355  * disk_blk_write() - write to a disk partition
356  *
357  * @dev:        Device to write to (UCLASS_PARTITION)
358  * @start:      Start block number to write in the partition (0=first)
359  * @blkcnt:     Number of blocks to write
360  * @buffer:     Source buffer for data to write
361  * Returns: number of blocks written, or -ve error number (see the
362  * IS_ERR_VALUE() macro
363  */
364 ulong disk_blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
365                      const void *buffer);
366
367 /**
368  * disk_blk_erase() - erase a section of a disk partition
369  *
370  * @dev:        Device to (partially) erase (UCLASS_PARTITION)
371  * @start:      Start block number to erase in the partition (0=first)
372  * @blkcnt:     Number of blocks to erase
373  * Returns: number of blocks erased, or -ve error number (see the
374  * IS_ERR_VALUE() macro
375  */
376 ulong disk_blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt);
377
378 /*
379  * We don't support printing partition information in SPL and only support
380  * getting partition information in a few cases.
381  */
382 #ifdef CONFIG_SPL_BUILD
383 # define part_print_ptr(x)      NULL
384 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
385         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
386 #  define part_get_info_ptr(x)  x
387 # else
388 #  define part_get_info_ptr(x)  NULL
389 # endif
390 #else
391 #define part_print_ptr(x)       x
392 #define part_get_info_ptr(x)    x
393 #endif
394
395
396 struct part_driver {
397         const char *name;
398         int part_type;
399         const int max_entries;  /* maximum number of entries to search */
400
401         /**
402          * get_info() - Get information about a partition
403          *
404          * @dev_desc:   Block device descriptor
405          * @part:       Partition number (1 = first)
406          * @info:       Returns partition information
407          */
408         int (*get_info)(struct blk_desc *dev_desc, int part,
409                         struct disk_partition *info);
410
411         /**
412          * print() - Print partition information
413          *
414          * @dev_desc:   Block device descriptor
415          */
416         void (*print)(struct blk_desc *dev_desc);
417
418         /**
419          * test() - Test if a device contains this partition type
420          *
421          * @dev_desc:   Block device descriptor
422          * @return 0 if the block device appears to contain this partition
423          *         type, -ve if not
424          */
425         int (*test)(struct blk_desc *dev_desc);
426 };
427
428 /* Declare a new U-Boot partition 'driver' */
429 #define U_BOOT_PART_TYPE(__name)                                        \
430         ll_entry_declare(struct part_driver, __name, part_driver)
431
432 #include <part_efi.h>
433
434 #if CONFIG_IS_ENABLED(EFI_PARTITION)
435 /* disk/part_efi.c */
436 /**
437  * write_gpt_table() - Write the GUID Partition Table to disk
438  *
439  * @param dev_desc - block device descriptor
440  * @param gpt_h - pointer to GPT header representation
441  * @param gpt_e - pointer to GPT partition table entries
442  *
443  * Return: - zero on success, otherwise error
444  */
445 int write_gpt_table(struct blk_desc *dev_desc,
446                   gpt_header *gpt_h, gpt_entry *gpt_e);
447
448 /**
449  * gpt_fill_pte(): Fill the GPT partition table entry
450  *
451  * @param dev_desc - block device descriptor
452  * @param gpt_h - GPT header representation
453  * @param gpt_e - GPT partition table entries
454  * @param partitions - list of partitions
455  * @param parts - number of partitions
456  *
457  * Return: zero on success
458  */
459 int gpt_fill_pte(struct blk_desc *dev_desc,
460                  gpt_header *gpt_h, gpt_entry *gpt_e,
461                  struct disk_partition *partitions, int parts);
462
463 /**
464  * gpt_fill_header(): Fill the GPT header
465  *
466  * @param dev_desc - block device descriptor
467  * @param gpt_h - GPT header representation
468  * @param str_guid - disk guid string representation
469  * @param parts_count - number of partitions
470  *
471  * Return: - error on str_guid conversion error
472  */
473 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
474                 char *str_guid, int parts_count);
475
476 /**
477  * gpt_restore(): Restore GPT partition table
478  *
479  * @param dev_desc - block device descriptor
480  * @param str_disk_guid - disk GUID
481  * @param partitions - list of partitions
482  * @param parts - number of partitions
483  *
484  * Return: zero on success
485  */
486 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
487                 struct disk_partition *partitions, const int parts_count);
488
489 /**
490  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
491  *
492  * @param dev_desc - block device descriptor
493  * @param buf - buffer which contains the MBR and Primary GPT info
494  *
495  * Return: - '0' on success, otherwise error
496  */
497 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
498
499 /**
500  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
501  *
502  * @param dev_desc - block device descriptor
503  * @param buf - buffer which contains the MBR and Primary GPT info
504  *
505  * Return: - '0' on success, otherwise error
506  */
507 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
508
509 /**
510  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
511  *                        and partition table entries (PTE)
512  *
513  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
514  *
515  * @param dev_desc - block device descriptor
516  * @param gpt_head - pointer to GPT header data read from medium
517  * @param gpt_pte - pointer to GPT partition table enties read from medium
518  *
519  * Return: - '0' on success, otherwise error
520  */
521 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
522                        gpt_entry **gpt_pte);
523
524 /**
525  * gpt_repair_headers() - Function to repair the GPT's header
526  *                        and partition table entries (PTE)
527  *
528  * @param dev_desc - block device descriptor
529  *
530  * Return: - '0' on success, otherwise error
531  */
532 int gpt_repair_headers(struct blk_desc *dev_desc);
533
534 /**
535  * gpt_verify_partitions() - Function to check if partitions' name, start and
536  *                           size correspond to '$partitions' env variable
537  *
538  * This function checks if on medium stored GPT data is in sync with information
539  * provided in '$partitions' environment variable. Specificially, name, start
540  * and size of the partition is checked.
541  *
542  * @param dev_desc - block device descriptor
543  * @param partitions - partition data read from '$partitions' env variable
544  * @param parts - number of partitions read from '$partitions' env variable
545  * @param gpt_head - pointer to GPT header data read from medium
546  * @param gpt_pte - pointer to GPT partition table enties read from medium
547  *
548  * Return: - '0' on success, otherwise error
549  */
550 int gpt_verify_partitions(struct blk_desc *dev_desc,
551                           struct disk_partition *partitions, int parts,
552                           gpt_header *gpt_head, gpt_entry **gpt_pte);
553
554
555 /**
556  * get_disk_guid() - Function to read the GUID string from a device's GPT
557  *
558  * This function reads the GUID string from a block device whose descriptor
559  * is provided.
560  *
561  * @param dev_desc - block device descriptor
562  * @param guid - pre-allocated string in which to return the GUID
563  *
564  * Return: - '0' on success, otherwise error
565  */
566 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
567
568 #endif
569
570 #if CONFIG_IS_ENABLED(DOS_PARTITION)
571 /**
572  * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
573  *
574  * @param buf - buffer which contains the MBR
575  *
576  * Return: - '0' on success, otherwise error
577  */
578 int is_valid_dos_buf(void *buf);
579
580 /**
581  * write_mbr_sector() - write DOS MBR
582  *
583  * @param dev_desc - block device descriptor
584  * @param buf - buffer which contains the MBR
585  *
586  * Return: - '0' on success, otherwise error
587  */
588 int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
589
590 int write_mbr_partitions(struct blk_desc *dev,
591                 struct disk_partition *p, int count, unsigned int disksig);
592 int layout_mbr_partitions(struct disk_partition *p, int count,
593                           lbaint_t total_sectors);
594
595 #endif
596
597 #if CONFIG_IS_ENABLED(PARTITIONS)
598 /**
599  * part_driver_get_count() - get partition driver count
600  *
601  * Return: - number of partition drivers
602  */
603 static inline int part_driver_get_count(void)
604 {
605         return ll_entry_count(struct part_driver, part_driver);
606 }
607
608 /**
609  * part_driver_get_first() - get first partition driver
610  *
611  * Return: - pointer to first partition driver on success, otherwise NULL
612  */
613 static inline struct part_driver *part_driver_get_first(void)
614 {
615         return ll_entry_start(struct part_driver, part_driver);
616 }
617
618 /**
619  * part_get_type_by_name() - Get partition type by name
620  *
621  * @name: Name of partition type to look up (not case-sensitive)
622  * Returns: Corresponding partition type (PART_TYPE_...) or PART_TYPE_UNKNOWN if
623  * not known
624  */
625 int part_get_type_by_name(const char *name);
626
627 #else
628 static inline int part_driver_get_count(void)
629 { return 0; }
630
631 static inline struct part_driver *part_driver_get_first(void)
632 { return NULL; }
633 #endif /* CONFIG_PARTITIONS */
634
635 #endif /* _PART_H */