dm: systemace: Drop the get_dev() function
[platform/kernel/u-boot.git] / 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
13 struct block_drvr {
14         char *name;
15         struct blk_desc* (*get_dev)(int dev);
16         int (*select_hwpart)(int dev_num, int hwpart);
17 };
18
19 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
20                  ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
21                  ((x & 0xffff0000) ? 16 : 0))
22 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
23
24 /* Part types */
25 #define PART_TYPE_UNKNOWN       0x00
26 #define PART_TYPE_MAC           0x01
27 #define PART_TYPE_DOS           0x02
28 #define PART_TYPE_ISO           0x03
29 #define PART_TYPE_AMIGA         0x04
30 #define PART_TYPE_EFI           0x05
31
32 /*
33  * Type string for U-Boot bootable partitions
34  */
35 #define BOOT_PART_TYPE  "U-Boot"        /* primary boot partition type  */
36 #define BOOT_PART_COMP  "PPCBoot"       /* PPCBoot compatibility type   */
37
38 /* device types */
39 #define DEV_TYPE_UNKNOWN        0xff    /* not connected */
40 #define DEV_TYPE_HARDDISK       0x00    /* harddisk */
41 #define DEV_TYPE_TAPE           0x01    /* Tape */
42 #define DEV_TYPE_CDROM          0x05    /* CD-ROM */
43 #define DEV_TYPE_OPDISK         0x07    /* optical disk */
44
45 typedef struct disk_partition {
46         lbaint_t        start;  /* # of first block in partition        */
47         lbaint_t        size;   /* number of blocks in partition        */
48         ulong   blksz;          /* block size in bytes                  */
49         uchar   name[32];       /* partition name                       */
50         uchar   type[32];       /* string type description              */
51         int     bootable;       /* Active/Bootable flag is set          */
52 #ifdef CONFIG_PARTITION_UUIDS
53         char    uuid[37];       /* filesystem UUID as string, if exists */
54 #endif
55 #ifdef CONFIG_PARTITION_TYPE_GUID
56         char    type_guid[37];  /* type GUID as string, if exists       */
57 #endif
58 } disk_partition_t;
59
60 /* Misc _get_dev functions */
61 #ifdef CONFIG_PARTITIONS
62 /**
63  * blk_get_dev() - get a pointer to a block device given its type and number
64  *
65  * Each interface allocates its own devices and typically struct blk_desc is
66  * contained with the interface's data structure. There is no global
67  * numbering for block devices, so the interface name must be provided.
68  *
69  * @ifname:     Interface name (e.g. "ide", "scsi")
70  * @dev:        Device number (0 for first device on that interface, 1 for
71  *              second, etc.
72  * @return pointer to the block device, or NULL if not available, or an
73  *         error occurred.
74  */
75 struct blk_desc *blk_get_dev(const char *ifname, int dev);
76
77 /**
78  * mmc_select_hwpart() - Select the MMC hardware partiion on an MMC device
79  *
80  * MMC devices can support partitioning at the hardware level. This is quite
81  * separate from the normal idea of software-based partitions. MMC hardware
82  * partitions must be explicitly selected. Once selected only the region of
83  * the device covered by that partition is accessible.
84  *
85  * The MMC standard provides for two boot partitions (numbered 1 and 2),
86  * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
87  *
88  * @dev_num:    Block device number (struct blk_desc->dev value)
89  * @hwpart:     Hardware partition number to select. 0 means the raw device,
90  *              1 is the first partition, 2 is the second, etc.
91  * @return 0 if OK, other value for an error
92  */
93 int mmc_select_hwpart(int dev_num, int hwpart);
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);
97
98 /* disk/part.c */
99 int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
100 void part_print(struct blk_desc *dev_desc);
101 void part_init(struct blk_desc *dev_desc);
102 void dev_print(struct blk_desc *dev_desc);
103
104 /**
105  * blk_get_device_by_str() - Get a block device given its interface/hw partition
106  *
107  * Each interface allocates its own devices and typically struct blk_desc is
108  * contained with the interface's data structure. There is no global
109  * numbering for block devices, so the interface name must be provided.
110  *
111  * The hardware parition is not related to the normal software partitioning
112  * of a device - each hardware partition is effectively a separately
113  * accessible block device. When a hardware parition is selected on MMC the
114  * other hardware partitions become inaccessible. The same block device is
115  * used to access all hardware partitions, but its capacity may change when a
116  * different hardware partition is selected.
117  *
118  * When a hardware partition number is given, the block device switches to
119  * that hardware partition.
120  *
121  * @ifname:     Interface name (e.g. "ide", "scsi")
122  * @dev_str:    Device and optional hw partition. This can either be a string
123  *              containing the device number (e.g. "2") or the device number
124  *              and hardware partition number (e.g. "2.4") for devices that
125  *              support it (currently only MMC).
126  * @dev_desc:   Returns a pointer to the block device on success
127  * @return block device number (local to the interface), or -1 on error
128  */
129 int blk_get_device_by_str(const char *ifname, const char *dev_str,
130                           struct blk_desc **dev_desc);
131
132 /**
133  * blk_get_device_part_str() - Get a block device and partition
134  *
135  * This calls blk_get_device_by_str() to look up a device. It also looks up
136  * a partition and returns information about it.
137  *
138  * @dev_part_str is in the format:
139  *      <dev>.<hw_part>:<part> where <dev> is the device number,
140  *      <hw_part> is the optional hardware partition number and
141  *      <part> is the partition number
142  *
143  * If ifname is "hostfs" then this function returns the sandbox host block
144  * device.
145  *
146  * If ifname is ubi, then this function returns 0, with @info set to a
147  * special UBI device.
148  *
149  * If @dev_part_str is NULL or empty or "-", then this function looks up
150  * the "bootdevice" environment variable and uses that string instead.
151  *
152  * If the partition string is empty then the first partition is used. If the
153  * partition string is "auto" then the first bootable partition is used.
154  *
155  * @ifname:     Interface name (e.g. "ide", "scsi")
156  * @dev_part_str:       Device and partition string
157  * @dev_desc:   Returns a pointer to the block device on success
158  * @info:       Returns partition information
159  * @allow_whole_dev:    true to allow the user to select partition 0
160  *              (which means the whole device), false to require a valid
161  *              partition number >= 1
162  * @return partition number, or -1 on error
163  *
164  */
165 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
166                             struct blk_desc **dev_desc,
167                             disk_partition_t *info, int allow_whole_dev);
168 extern const struct block_drvr block_drvr[];
169 #else
170 static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
171 { return NULL; }
172 static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
173 static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
174 static inline struct blk_desc *host_get_dev(int dev) { return NULL; }
175
176 static inline int part_get_info(struct blk_desc *dev_desc, int part,
177                                 disk_partition_t *info) { return -1; }
178 static inline void part_print(struct blk_desc *dev_desc) {}
179 static inline void part_init(struct blk_desc *dev_desc) {}
180 static inline void dev_print(struct blk_desc *dev_desc) {}
181 static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
182                                         struct blk_desc **dev_desc)
183 { return -1; }
184 static inline int blk_get_device_part_str(const char *ifname,
185                                            const char *dev_part_str,
186                                            struct blk_desc **dev_desc,
187                                            disk_partition_t *info,
188                                            int allow_whole_dev)
189 { *dev_desc = NULL; return -1; }
190 #endif
191
192 /*
193  * We don't support printing partition information in SPL and only support
194  * getting partition information in a few cases.
195  */
196 #ifdef CONFIG_SPL_BUILD
197 # define part_print_ptr(x)      NULL
198 # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
199         defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
200 #  define part_get_info_ptr(x)  x
201 # else
202 #  define part_get_info_ptr(x)  NULL
203 # endif
204 #else
205 #define part_print_ptr(x)       x
206 #define part_get_info_ptr(x)    x
207 #endif
208
209
210 struct part_driver {
211         const char *name;
212         int part_type;
213
214         /**
215          * get_info() - Get information about a partition
216          *
217          * @dev_desc:   Block device descriptor
218          * @part:       Partition number (1 = first)
219          * @info:       Returns partition information
220          */
221         int (*get_info)(struct blk_desc *dev_desc, int part,
222                         disk_partition_t *info);
223
224         /**
225          * print() - Print partition information
226          *
227          * @dev_desc:   Block device descriptor
228          */
229         void (*print)(struct blk_desc *dev_desc);
230
231         /**
232          * test() - Test if a device contains this partition type
233          *
234          * @dev_desc:   Block device descriptor
235          * @return 0 if the block device appears to contain this partition
236          *         type, -ve if not
237          */
238         int (*test)(struct blk_desc *dev_desc);
239 };
240
241 /* Declare a new U-Boot partition 'driver' */
242 #define U_BOOT_PART_TYPE(__name)                                        \
243         ll_entry_declare(struct part_driver, __name, part_driver)
244
245 #ifdef CONFIG_EFI_PARTITION
246 #include <part_efi.h>
247 /* disk/part_efi.c */
248 /**
249  * part_get_info_efi_by_name() - Find the specified GPT partition table entry
250  *
251  * @param dev_desc - block device descriptor
252  * @param gpt_name - the specified table entry name
253  * @param info - returns the disk partition info
254  *
255  * @return - '0' on match, '-1' on no match, otherwise error
256  */
257 int part_get_info_efi_by_name(struct blk_desc *dev_desc,
258                               const char *name, disk_partition_t *info);
259
260 /**
261  * write_gpt_table() - Write the GUID Partition Table to disk
262  *
263  * @param dev_desc - block device descriptor
264  * @param gpt_h - pointer to GPT header representation
265  * @param gpt_e - pointer to GPT partition table entries
266  *
267  * @return - zero on success, otherwise error
268  */
269 int write_gpt_table(struct blk_desc *dev_desc,
270                   gpt_header *gpt_h, gpt_entry *gpt_e);
271
272 /**
273  * gpt_fill_pte(): Fill the GPT partition table entry
274  *
275  * @param gpt_h - GPT header representation
276  * @param gpt_e - GPT partition table entries
277  * @param partitions - list of partitions
278  * @param parts - number of partitions
279  *
280  * @return zero on success
281  */
282 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
283                 disk_partition_t *partitions, int parts);
284
285 /**
286  * gpt_fill_header(): Fill the GPT header
287  *
288  * @param dev_desc - block device descriptor
289  * @param gpt_h - GPT header representation
290  * @param str_guid - disk guid string representation
291  * @param parts_count - number of partitions
292  *
293  * @return - error on str_guid conversion error
294  */
295 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
296                 char *str_guid, int parts_count);
297
298 /**
299  * gpt_restore(): Restore GPT partition table
300  *
301  * @param dev_desc - block device descriptor
302  * @param str_disk_guid - disk GUID
303  * @param partitions - list of partitions
304  * @param parts - number of partitions
305  *
306  * @return zero on success
307  */
308 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
309                 disk_partition_t *partitions, const int parts_count);
310
311 /**
312  * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
313  *
314  * @param dev_desc - block device descriptor
315  * @param buf - buffer which contains the MBR and Primary GPT info
316  *
317  * @return - '0' on success, otherwise error
318  */
319 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
320
321 /**
322  * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
323  *
324  * @param dev_desc - block device descriptor
325  * @param buf - buffer which contains the MBR and Primary GPT info
326  *
327  * @return - '0' on success, otherwise error
328  */
329 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
330
331 /**
332  * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
333  *                        and partition table entries (PTE)
334  *
335  * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
336  *
337  * @param dev_desc - block device descriptor
338  * @param gpt_head - pointer to GPT header data read from medium
339  * @param gpt_pte - pointer to GPT partition table enties read from medium
340  *
341  * @return - '0' on success, otherwise error
342  */
343 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
344                        gpt_entry **gpt_pte);
345
346 /**
347  * gpt_verify_partitions() - Function to check if partitions' name, start and
348  *                           size correspond to '$partitions' env variable
349  *
350  * This function checks if on medium stored GPT data is in sync with information
351  * provided in '$partitions' environment variable. Specificially, name, start
352  * and size of the partition is checked.
353  *
354  * @param dev_desc - block device descriptor
355  * @param partitions - partition data read from '$partitions' env variable
356  * @param parts - number of partitions read from '$partitions' env variable
357  * @param gpt_head - pointer to GPT header data read from medium
358  * @param gpt_pte - pointer to GPT partition table enties read from medium
359  *
360  * @return - '0' on success, otherwise error
361  */
362 int gpt_verify_partitions(struct blk_desc *dev_desc,
363                           disk_partition_t *partitions, int parts,
364                           gpt_header *gpt_head, gpt_entry **gpt_pte);
365 #endif
366
367 #endif /* _PART_H */