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