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