Merge https://gitlab.denx.de/u-boot/custodians/u-boot-sh
[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/list.h>
14
15 struct block_drvr {
16         char *name;
17         int (*select_hwpart)(int dev_num, int hwpart);
18 };
19
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))
24
25 /* Part types */
26 #define PART_TYPE_UNKNOWN       0x00
27 #define PART_TYPE_MAC           0x01
28 #define PART_TYPE_DOS           0x02
29 #define PART_TYPE_ISO           0x03
30 #define PART_TYPE_AMIGA         0x04
31 #define PART_TYPE_EFI           0x05
32
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
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
44 /* device types */
45 #define DEV_TYPE_UNKNOWN        0xff    /* not connected */
46 #define DEV_TYPE_HARDDISK       0x00    /* harddisk */
47 #define DEV_TYPE_TAPE           0x01    /* Tape */
48 #define DEV_TYPE_CDROM          0x05    /* CD-ROM */
49 #define DEV_TYPE_OPDISK         0x07    /* optical disk */
50
51 #define PART_NAME_LEN 32
52 #define PART_TYPE_LEN 32
53 #define MAX_SEARCH_PARTITIONS 64
54
55 #define PART_BOOTABLE                   ((int)BIT(0))
56 #define PART_EFI_SYSTEM_PARTITION       ((int)BIT(1))
57
58 struct disk_partition {
59         lbaint_t        start;  /* # of first block in partition        */
60         lbaint_t        size;   /* number of blocks in partition        */
61         ulong   blksz;          /* block size in bytes                  */
62         uchar   name[PART_NAME_LEN];    /* partition name                       */
63         uchar   type[PART_TYPE_LEN];    /* string type description              */
64         /*
65          * The bootable is a bitmask with the following fields:
66          *
67          * PART_BOOTABLE                the MBR bootable flag is set
68          * PART_EFI_SYSTEM_PARTITION    the partition is an EFI system partition
69          */
70         int     bootable;
71 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
72         char    uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
73 #endif
74 #ifdef CONFIG_PARTITION_TYPE_GUID
75         char    type_guid[UUID_STR_LEN + 1];    /* type GUID as string, if exists       */
76 #endif
77 #ifdef CONFIG_DOS_PARTITION
78         uchar   sys_ind;        /* partition type                       */
79 #endif
80 };
81
82 struct disk_part {
83         int partnum;
84         struct disk_partition gpt_part_info;
85         struct list_head list;
86 };
87
88 /* Misc _get_dev functions */
89 #ifdef CONFIG_PARTITIONS
90 /**
91  * blk_get_dev() - get a pointer to a block device given its type and number
92  *
93  * Each interface allocates its own devices and typically struct blk_desc is
94  * contained with the interface's data structure. There is no global
95  * numbering for block devices, so the interface name must be provided.
96  *
97  * @ifname:     Interface name (e.g. "ide", "scsi")
98  * @dev:        Device number (0 for first device on that interface, 1 for
99  *              second, etc.
100  * @return pointer to the block device, or NULL if not available, or an
101  *         error occurred.
102  */
103 struct blk_desc *blk_get_dev(const char *ifname, int dev);
104
105 struct blk_desc *mg_disk_get_dev(int dev);
106 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
107
108 /* disk/part.c */
109 int part_get_info(struct blk_desc *dev_desc, int part,
110                   struct disk_partition *info);
111 /**
112  * part_get_info_whole_disk() - get partition info for the special case of
113  * a partition occupying the entire disk.
114  */
115 int part_get_info_whole_disk(struct blk_desc *dev_desc,
116                              struct disk_partition *info);
117
118 void part_print(struct blk_desc *dev_desc);
119 void part_init(struct blk_desc *dev_desc);
120 void dev_print(struct blk_desc *dev_desc);
121
122 /**
123  * blk_get_device_by_str() - Get a block device given its interface/hw partition
124  *
125  * Each interface allocates its own devices and typically struct blk_desc is
126  * contained with the interface's data structure. There is no global
127  * numbering for block devices, so the interface name must be provided.
128  *
129  * The hardware parition is not related to the normal software partitioning
130  * of a device - each hardware partition is effectively a separately
131  * accessible block device. When a hardware parition is selected on MMC the
132  * other hardware partitions become inaccessible. The same block device is
133  * used to access all hardware partitions, but its capacity may change when a
134  * different hardware partition is selected.
135  *
136  * When a hardware partition number is given, the block device switches to
137  * that hardware partition.
138  *
139  * @ifname:     Interface name (e.g. "ide", "scsi")
140  * @dev_str:    Device and optional hw partition. This can either be a string
141  *              containing the device number (e.g. "2") or the device number
142  *              and hardware partition number (e.g. "2.4") for devices that
143  *              support it (currently only MMC).
144  * @dev_desc:   Returns a pointer to the block device on success
145  * @return block device number (local to the interface), or -1 on error
146  */
147 int blk_get_device_by_str(const char *ifname, const char *dev_str,
148                           struct blk_desc **dev_desc);
149
150 /**
151  * blk_get_device_part_str() - Get a block device and partition
152  *
153  * This calls blk_get_device_by_str() to look up a device. It also looks up
154  * a partition and returns information about it.
155  *
156  * @dev_part_str is in the format:
157  *      <dev>.<hw_part>:<part> where <dev> is the device number,
158  *      <hw_part> is the optional hardware partition number and
159  *      <part> is the partition number
160  *
161  * If ifname is "hostfs" then this function returns the sandbox host block
162  * device.
163  *
164  * If ifname is ubi, then this function returns 0, with @info set to a
165  * special UBI device.
166  *
167  * If @dev_part_str is NULL or empty or "-", then this function looks up
168  * the "bootdevice" environment variable and uses that string instead.
169  *
170  * If the partition string is empty then the first partition is used. If the
171  * partition string is "auto" then the first bootable partition is used.
172  *
173  * @ifname:     Interface name (e.g. "ide", "scsi")
174  * @dev_part_str:       Device and partition string
175  * @dev_desc:   Returns a pointer to the block device on success
176  * @info:       Returns partition information
177  * @allow_whole_dev:    true to allow the user to select partition 0
178  *              (which means the whole device), false to require a valid
179  *              partition number >= 1
180  * @return partition number, or -1 on error
181  *
182  */
183 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
184                             struct blk_desc **dev_desc,
185                             struct disk_partition *info, int allow_whole_dev);
186
187 /**
188  * part_get_info_by_name_type() - Search for a partition by name
189  *                                for only specified partition type
190  *
191  * @param dev_desc - block device descriptor
192  * @param gpt_name - the specified table entry name
193  * @param info - returns the disk partition info
194  * @param part_type - only search in partitions of this type
195  *
196  * @return - the partition number on match (starting on 1), -1 on no match,
197  * otherwise error
198  */
199 int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
200                                struct disk_partition *info, int part_type);
201
202 /**
203  * part_get_info_by_name() - Search for a partition by name
204  *                           among all available registered partitions
205  *
206  * @param dev_desc - block device descriptor
207  * @param gpt_name - the specified table entry name
208  * @param info - returns the disk partition info
209  *
210  * @return - the partition number on match (starting on 1), -1 on no match,
211  * otherwise error
212  */
213 int part_get_info_by_name(struct blk_desc *dev_desc,
214                               const char *name, struct disk_partition *info);
215
216 /**
217  * Get partition info from dev number + part name, or dev number + part number.
218  *
219  * Parse a device number and partition description (either name or number)
220  * in the form of device number plus partition name separated by a "#"
221  * (like "device_num#partition_name") or a device number plus a partition number
222  * separated by a ":". For example both "0#misc" and "0:1" can be valid
223  * partition descriptions for a given interface. If the partition is found, sets
224  * dev_desc and part_info accordingly with the information of the partition.
225  *
226  * @param[in] dev_iface Device interface
227  * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
228  * @param[out] dev_desc Place to store the device description pointer
229  * @param[out] part_info Place to store the partition information
230  * @return 0 on success, or a negative on error
231  */
232 int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
233                                          const char *dev_part_str,
234                                          struct blk_desc **dev_desc,
235                                          struct disk_partition *part_info);
236
237 /**
238  * part_set_generic_name() - create generic partition like hda1 or sdb2
239  *
240  * Helper function for partition tables, which don't hold partition names
241  * (DOS, ISO). Generates partition name out of the device type and partition
242  * number.
243  *
244  * @dev_desc:   pointer to the block device
245  * @part_num:   partition number for which the name is generated
246  * @name:       buffer where the name is written
247  */
248 void part_set_generic_name(const struct blk_desc *dev_desc,
249         int part_num, char *name);
250
251 extern const struct block_drvr block_drvr[];
252 #else
253 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
254 { return NULL; }
255 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
256
257 static inline int part_get_info(struct blk_desc *dev_desc, int part,
258                                 struct disk_partition *info) { return -1; }
259 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
260                                            struct disk_partition *info)
261 { return -1; }
262 static inline void part_print(struct blk_desc *dev_desc) {}
263 static inline void part_init(struct blk_desc *dev_desc) {}
264 static inline void dev_print(struct blk_desc *dev_desc) {}
265 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
266                                         struct blk_desc **dev_desc)
267 { return -1; }
268 static inline int blk_get_device_part_str(const char *ifname,
269                                           const char *dev_part_str,
270                                           struct blk_desc **dev_desc,
271                                           struct disk_partition *info,
272                                           int allow_whole_dev)
273 { *dev_desc = NULL; return -1; }
274 #endif
275
276 /*
277  * We don't support printing partition information in SPL and only support
278  * getting partition information in a few cases.
279  */
280 #ifdef CONFIG_SPL_BUILD
281 # define part_print_ptr(x)      NULL
282 # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
283         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
284 #  define part_get_info_ptr(x)  x
285 # else
286 #  define part_get_info_ptr(x)  NULL
287 # endif
288 #else
289 #define part_print_ptr(x)       x
290 #define part_get_info_ptr(x)    x
291 #endif
292
293
294 struct part_driver {
295         const char *name;
296         int part_type;
297         const int max_entries;  /* maximum number of entries to search */
298
299         /**
300          * get_info() - Get information about a partition
301          *
302          * @dev_desc:   Block device descriptor
303          * @part:       Partition number (1 = first)
304          * @info:       Returns partition information
305          */
306         int (*get_info)(struct blk_desc *dev_desc, int part,
307                         struct disk_partition *info);
308
309         /**
310          * print() - Print partition information
311          *
312          * @dev_desc:   Block device descriptor
313          */
314         void (*print)(struct blk_desc *dev_desc);
315
316         /**
317          * test() - Test if a device contains this partition type
318          *
319          * @dev_desc:   Block device descriptor
320          * @return 0 if the block device appears to contain this partition
321          *         type, -ve if not
322          */
323         int (*test)(struct blk_desc *dev_desc);
324 };
325
326 /* Declare a new U-Boot partition 'driver' */
327 #define U_BOOT_PART_TYPE(__name)                                        \
328         ll_entry_declare(struct part_driver, __name, part_driver)
329
330 #include <part_efi.h>
331
332 #if CONFIG_IS_ENABLED(EFI_PARTITION)
333 /* disk/part_efi.c */
334 /**
335  * write_gpt_table() - Write the GUID Partition Table to disk
336  *
337  * @param dev_desc - block device descriptor
338  * @param gpt_h - pointer to GPT header representation
339  * @param gpt_e - pointer to GPT partition table entries
340  *
341  * @return - zero on success, otherwise error
342  */
343 int write_gpt_table(struct blk_desc *dev_desc,
344                   gpt_header *gpt_h, gpt_entry *gpt_e);
345
346 /**
347  * gpt_fill_pte(): Fill the GPT partition table entry
348  *
349  * @param dev_desc - block device descriptor
350  * @param gpt_h - GPT header representation
351  * @param gpt_e - GPT partition table entries
352  * @param partitions - list of partitions
353  * @param parts - number of partitions
354  *
355  * @return zero on success
356  */
357 int gpt_fill_pte(struct blk_desc *dev_desc,
358                  gpt_header *gpt_h, gpt_entry *gpt_e,
359                  struct disk_partition *partitions, int parts);
360
361 /**
362  * gpt_fill_header(): Fill the GPT header
363  *
364  * @param dev_desc - block device descriptor
365  * @param gpt_h - GPT header representation
366  * @param str_guid - disk guid string representation
367  * @param parts_count - number of partitions
368  *
369  * @return - error on str_guid conversion error
370  */
371 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
372                 char *str_guid, int parts_count);
373
374 /**
375  * gpt_restore(): Restore GPT partition table
376  *
377  * @param dev_desc - block device descriptor
378  * @param str_disk_guid - disk GUID
379  * @param partitions - list of partitions
380  * @param parts - number of partitions
381  *
382  * @return zero on success
383  */
384 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
385                 struct disk_partition *partitions, const int parts_count);
386
387 /**
388  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
389  *
390  * @param dev_desc - block device descriptor
391  * @param buf - buffer which contains the MBR and Primary GPT info
392  *
393  * @return - '0' on success, otherwise error
394  */
395 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
396
397 /**
398  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
399  *
400  * @param dev_desc - block device descriptor
401  * @param buf - buffer which contains the MBR and Primary GPT info
402  *
403  * @return - '0' on success, otherwise error
404  */
405 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
406
407 /**
408  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
409  *                        and partition table entries (PTE)
410  *
411  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
412  *
413  * @param dev_desc - block device descriptor
414  * @param gpt_head - pointer to GPT header data read from medium
415  * @param gpt_pte - pointer to GPT partition table enties read from medium
416  *
417  * @return - '0' on success, otherwise error
418  */
419 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
420                        gpt_entry **gpt_pte);
421
422 /**
423  * gpt_verify_partitions() - Function to check if partitions' name, start and
424  *                           size correspond to '$partitions' env variable
425  *
426  * This function checks if on medium stored GPT data is in sync with information
427  * provided in '$partitions' environment variable. Specificially, name, start
428  * and size of the partition is checked.
429  *
430  * @param dev_desc - block device descriptor
431  * @param partitions - partition data read from '$partitions' env variable
432  * @param parts - number of partitions read from '$partitions' env variable
433  * @param gpt_head - pointer to GPT header data read from medium
434  * @param gpt_pte - pointer to GPT partition table enties read from medium
435  *
436  * @return - '0' on success, otherwise error
437  */
438 int gpt_verify_partitions(struct blk_desc *dev_desc,
439                           struct disk_partition *partitions, int parts,
440                           gpt_header *gpt_head, gpt_entry **gpt_pte);
441
442
443 /**
444  * get_disk_guid() - Function to read the GUID string from a device's GPT
445  *
446  * This function reads the GUID string from a block device whose descriptor
447  * is provided.
448  *
449  * @param dev_desc - block device descriptor
450  * @param guid - pre-allocated string in which to return the GUID
451  *
452  * @return - '0' on success, otherwise error
453  */
454 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
455
456 #endif
457
458 #if CONFIG_IS_ENABLED(DOS_PARTITION)
459 /**
460  * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
461  *
462  * @param buf - buffer which contains the MBR
463  *
464  * @return - '0' on success, otherwise error
465  */
466 int is_valid_dos_buf(void *buf);
467
468 /**
469  * write_mbr_sector() - write DOS MBR
470  *
471  * @param dev_desc - block device descriptor
472  * @param buf - buffer which contains the MBR
473  *
474  * @return - '0' on success, otherwise error
475  */
476 int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
477
478 int write_mbr_partitions(struct blk_desc *dev,
479                 struct disk_partition *p, int count, unsigned int disksig);
480 int layout_mbr_partitions(struct disk_partition *p, int count,
481                           lbaint_t total_sectors);
482
483 #endif
484
485 #ifdef CONFIG_PARTITIONS
486 /**
487  * part_driver_get_count() - get partition driver count
488  *
489  * @return - number of partition drivers
490  */
491 static inline int part_driver_get_count(void)
492 {
493         return ll_entry_count(struct part_driver, part_driver);
494 }
495
496 /**
497  * part_driver_get_first() - get first partition driver
498  *
499  * @return - pointer to first partition driver on success, otherwise NULL
500  */
501 static inline struct part_driver *part_driver_get_first(void)
502 {
503         return ll_entry_start(struct part_driver, part_driver);
504 }
505
506 #else
507 static inline int part_driver_get_count(void)
508 { return 0; }
509
510 static inline struct part_driver *part_driver_get_first(void)
511 { return NULL; }
512 #endif /* CONFIG_PARTITIONS */
513
514 #endif /* _PART_H */