]> git.sur5r.net Git - u-boot/blob - include/part.h
dm: core: make fixed-clock dt scan live dt compatible
[u-boot] / include / part.h
1 /*
2  * (C) Copyright 2000-2004
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  */
7 #ifndef _PART_H
8 #define _PART_H
9
10 #include <blk.h>
11 #include <ide.h>
12 #include <uuid.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 typedef struct disk_partition {
56         lbaint_t        start;  /* # of first block in partition        */
57         lbaint_t        size;   /* number of blocks in partition        */
58         ulong   blksz;          /* block size in bytes                  */
59         uchar   name[PART_NAME_LEN];    /* partition name                       */
60         uchar   type[PART_TYPE_LEN];    /* string type description              */
61         int     bootable;       /* Active/Bootable flag is set          */
62 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
63         char    uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
64 #endif
65 #ifdef CONFIG_PARTITION_TYPE_GUID
66         char    type_guid[UUID_STR_LEN + 1];    /* type GUID as string, if exists       */
67 #endif
68 #ifdef CONFIG_DOS_PARTITION
69         uchar   sys_ind;        /* partition type                       */
70 #endif
71 } disk_partition_t;
72
73 struct disk_part {
74         int partnum;
75         disk_partition_t gpt_part_info;
76         struct list_head list;
77 };
78
79 /* Misc _get_dev functions */
80 #ifdef CONFIG_PARTITIONS
81 /**
82  * blk_get_dev() - get a pointer to a block device given its type and number
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  */
94 struct blk_desc *blk_get_dev(const char *ifname, int dev);
95
96 struct blk_desc *mg_disk_get_dev(int dev);
97 int host_get_dev_err(int dev, struct blk_desc **blk_devp);
98
99 /* disk/part.c */
100 int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
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
107 void part_print(struct blk_desc *dev_desc);
108 void part_init(struct blk_desc *dev_desc);
109 void dev_print(struct blk_desc *dev_desc);
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);
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);
175
176 /**
177  * part_get_info_by_name_type() - Search for a partition by name
178  *                                for only specified partition type
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  * @param part_type - only search in partitions of this type
184  *
185  * @return - the partition number on match (starting on 1), -1 on no match,
186  * otherwise error
187  */
188 int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
189                                disk_partition_t *info, int part_type);
190
191 /**
192  * part_get_info_by_name() - Search for a partition by name
193  *                           among all available registered partitions
194  *
195  * @param dev_desc - block device descriptor
196  * @param gpt_name - the specified table entry name
197  * @param info - returns the disk partition info
198  *
199  * @return - the partition number on match (starting on 1), -1 on no match,
200  * otherwise error
201  */
202 int part_get_info_by_name(struct blk_desc *dev_desc,
203                               const char *name, disk_partition_t *info);
204
205 /**
206  * part_set_generic_name() - create generic partition like hda1 or sdb2
207  *
208  * Helper function for partition tables, which don't hold partition names
209  * (DOS, ISO). Generates partition name out of the device type and partition
210  * number.
211  *
212  * @dev_desc:   pointer to the block device
213  * @part_num:   partition number for which the name is generated
214  * @name:       buffer where the name is written
215  */
216 void part_set_generic_name(const struct blk_desc *dev_desc,
217         int part_num, char *name);
218
219 extern const struct block_drvr block_drvr[];
220 #else
221 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
222 { return NULL; }
223 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
224
225 static inline int part_get_info(struct blk_desc *dev_desc, int part,
226                                 disk_partition_t *info) { return -1; }
227 static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
228                                            disk_partition_t *info)
229 { return -1; }
230 static inline void part_print(struct blk_desc *dev_desc) {}
231 static inline void part_init(struct blk_desc *dev_desc) {}
232 static inline void dev_print(struct blk_desc *dev_desc) {}
233 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
234                                         struct blk_desc **dev_desc)
235 { return -1; }
236 static inline int blk_get_device_part_str(const char *ifname,
237                                            const char *dev_part_str,
238                                            struct blk_desc **dev_desc,
239                                            disk_partition_t *info,
240                                            int allow_whole_dev)
241 { *dev_desc = NULL; return -1; }
242 #endif
243
244 /*
245  * We don't support printing partition information in SPL and only support
246  * getting partition information in a few cases.
247  */
248 #ifdef CONFIG_SPL_BUILD
249 # define part_print_ptr(x)      NULL
250 # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
251         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
252 #  define part_get_info_ptr(x)  x
253 # else
254 #  define part_get_info_ptr(x)  NULL
255 # endif
256 #else
257 #define part_print_ptr(x)       x
258 #define part_get_info_ptr(x)    x
259 #endif
260
261
262 struct part_driver {
263         const char *name;
264         int part_type;
265         const int max_entries;  /* maximum number of entries to search */
266
267         /**
268          * get_info() - Get information about a partition
269          *
270          * @dev_desc:   Block device descriptor
271          * @part:       Partition number (1 = first)
272          * @info:       Returns partition information
273          */
274         int (*get_info)(struct blk_desc *dev_desc, int part,
275                         disk_partition_t *info);
276
277         /**
278          * print() - Print partition information
279          *
280          * @dev_desc:   Block device descriptor
281          */
282         void (*print)(struct blk_desc *dev_desc);
283
284         /**
285          * test() - Test if a device contains this partition type
286          *
287          * @dev_desc:   Block device descriptor
288          * @return 0 if the block device appears to contain this partition
289          *         type, -ve if not
290          */
291         int (*test)(struct blk_desc *dev_desc);
292 };
293
294 /* Declare a new U-Boot partition 'driver' */
295 #define U_BOOT_PART_TYPE(__name)                                        \
296         ll_entry_declare(struct part_driver, __name, part_driver)
297
298 #include <part_efi.h>
299
300 #if CONFIG_IS_ENABLED(EFI_PARTITION)
301 /* disk/part_efi.c */
302 /**
303  * write_gpt_table() - Write the GUID Partition Table to disk
304  *
305  * @param dev_desc - block device descriptor
306  * @param gpt_h - pointer to GPT header representation
307  * @param gpt_e - pointer to GPT partition table entries
308  *
309  * @return - zero on success, otherwise error
310  */
311 int write_gpt_table(struct blk_desc *dev_desc,
312                   gpt_header *gpt_h, gpt_entry *gpt_e);
313
314 /**
315  * gpt_fill_pte(): Fill the GPT partition table entry
316  *
317  * @param dev_desc - block device descriptor
318  * @param gpt_h - GPT header representation
319  * @param gpt_e - GPT partition table entries
320  * @param partitions - list of partitions
321  * @param parts - number of partitions
322  *
323  * @return zero on success
324  */
325 int gpt_fill_pte(struct blk_desc *dev_desc,
326                  gpt_header *gpt_h, gpt_entry *gpt_e,
327                  disk_partition_t *partitions, int parts);
328
329 /**
330  * gpt_fill_header(): Fill the GPT header
331  *
332  * @param dev_desc - block device descriptor
333  * @param gpt_h - GPT header representation
334  * @param str_guid - disk guid string representation
335  * @param parts_count - number of partitions
336  *
337  * @return - error on str_guid conversion error
338  */
339 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
340                 char *str_guid, int parts_count);
341
342 /**
343  * gpt_restore(): Restore GPT partition table
344  *
345  * @param dev_desc - block device descriptor
346  * @param str_disk_guid - disk GUID
347  * @param partitions - list of partitions
348  * @param parts - number of partitions
349  *
350  * @return zero on success
351  */
352 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
353                 disk_partition_t *partitions, const int parts_count);
354
355 /**
356  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
357  *
358  * @param dev_desc - block device descriptor
359  * @param buf - buffer which contains the MBR and Primary GPT info
360  *
361  * @return - '0' on success, otherwise error
362  */
363 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
364
365 /**
366  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
367  *
368  * @param dev_desc - block device descriptor
369  * @param buf - buffer which contains the MBR and Primary GPT info
370  *
371  * @return - '0' on success, otherwise error
372  */
373 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
374
375 /**
376  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
377  *                        and partition table entries (PTE)
378  *
379  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
380  *
381  * @param dev_desc - block device descriptor
382  * @param gpt_head - pointer to GPT header data read from medium
383  * @param gpt_pte - pointer to GPT partition table enties read from medium
384  *
385  * @return - '0' on success, otherwise error
386  */
387 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
388                        gpt_entry **gpt_pte);
389
390 /**
391  * gpt_verify_partitions() - Function to check if partitions' name, start and
392  *                           size correspond to '$partitions' env variable
393  *
394  * This function checks if on medium stored GPT data is in sync with information
395  * provided in '$partitions' environment variable. Specificially, name, start
396  * and size of the partition is checked.
397  *
398  * @param dev_desc - block device descriptor
399  * @param partitions - partition data read from '$partitions' env variable
400  * @param parts - number of partitions read from '$partitions' env variable
401  * @param gpt_head - pointer to GPT header data read from medium
402  * @param gpt_pte - pointer to GPT partition table enties read from medium
403  *
404  * @return - '0' on success, otherwise error
405  */
406 int gpt_verify_partitions(struct blk_desc *dev_desc,
407                           disk_partition_t *partitions, int parts,
408                           gpt_header *gpt_head, gpt_entry **gpt_pte);
409
410
411 /**
412  * get_disk_guid() - Function to read the GUID string from a device's GPT
413  *
414  * This function reads the GUID string from a block device whose descriptor
415  * is provided.
416  *
417  * @param dev_desc - block device descriptor
418  * @param guid - pre-allocated string in which to return the GUID
419  *
420  * @return - '0' on success, otherwise error
421  */
422 int get_disk_guid(struct blk_desc *dev_desc, char *guid);
423
424 #endif
425
426 #if CONFIG_IS_ENABLED(DOS_PARTITION)
427 /**
428  * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
429  *
430  * @param buf - buffer which contains the MBR
431  *
432  * @return - '0' on success, otherwise error
433  */
434 int is_valid_dos_buf(void *buf);
435
436 /**
437  * write_mbr_partition() - write DOS MBR
438  *
439  * @param dev_desc - block device descriptor
440  * @param buf - buffer which contains the MBR
441  *
442  * @return - '0' on success, otherwise error
443  */
444 int write_mbr_partition(struct blk_desc *dev_desc, void *buf);
445
446 #endif
447
448
449 #endif /* _PART_H */