]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/part.h
dm: blk: Rename get_dev() to blk_get_dev()
[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
0472fbfd
EE
13#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
14 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
15 ((x & 0xffff0000) ? 16 : 0))
16#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
ae1768a7 17
012771d8 18/* Part types */
42dfe7a1 19#define PART_TYPE_UNKNOWN 0x00
012771d8
WD
20#define PART_TYPE_MAC 0x01
21#define PART_TYPE_DOS 0x02
22#define PART_TYPE_ISO 0x03
42dfe7a1 23#define PART_TYPE_AMIGA 0x04
07f3d789 24#define PART_TYPE_EFI 0x05
c7de829c 25
b0fce99b
WD
26/*
27 * Type string for U-Boot bootable partitions
28 */
29#define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
30#define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
31
012771d8 32/* device types */
b0fce99b
WD
33#define DEV_TYPE_UNKNOWN 0xff /* not connected */
34#define DEV_TYPE_HARDDISK 0x00 /* harddisk */
42dfe7a1
WD
35#define DEV_TYPE_TAPE 0x01 /* Tape */
36#define DEV_TYPE_CDROM 0x05 /* CD-ROM */
37#define DEV_TYPE_OPDISK 0x07 /* optical disk */
012771d8 38
42dfe7a1 39typedef struct disk_partition {
04735e9c
FL
40 lbaint_t start; /* # of first block in partition */
41 lbaint_t size; /* number of blocks in partition */
012771d8
WD
42 ulong blksz; /* block size in bytes */
43 uchar name[32]; /* partition name */
44 uchar type[32]; /* string type description */
40e0e568 45 int bootable; /* Active/Bootable flag is set */
894bfbbf
SW
46#ifdef CONFIG_PARTITION_UUIDS
47 char uuid[37]; /* filesystem UUID as string, if exists */
48#endif
7561b258
PD
49#ifdef CONFIG_PARTITION_TYPE_GUID
50 char type_guid[37]; /* type GUID as string, if exists */
51#endif
012771d8
WD
52} disk_partition_t;
53
735dd97b 54/* Misc _get_dev functions */
df3fc526 55#ifdef CONFIG_PARTITIONS
fb1b7be9 56/**
db1d9e78 57 * blk_get_dev() - get a pointer to a block device given its type and number
fb1b7be9
SG
58 *
59 * Each interface allocates its own devices and typically struct blk_desc is
60 * contained with the interface's data structure. There is no global
61 * numbering for block devices, so the interface name must be provided.
62 *
63 * @ifname: Interface name (e.g. "ide", "scsi")
64 * @dev: Device number (0 for first device on that interface, 1 for
65 * second, etc.
66 * @return pointer to the block device, or NULL if not available, or an
67 * error occurred.
68 */
db1d9e78 69struct blk_desc *blk_get_dev(const char *ifname, int dev);
4101f687
SG
70struct blk_desc *ide_get_dev(int dev);
71struct blk_desc *sata_get_dev(int dev);
72struct blk_desc *scsi_get_dev(int dev);
73struct blk_desc *usb_stor_get_dev(int dev);
74struct blk_desc *mmc_get_dev(int dev);
fb1b7be9
SG
75
76/**
77 * mmc_select_hwpart() - Select the MMC hardware partiion on an MMC device
78 *
79 * MMC devices can support partitioning at the hardware level. This is quite
80 * separate from the normal idea of software-based partitions. MMC hardware
81 * partitions must be explicitly selected. Once selected only the region of
82 * the device covered by that partition is accessible.
83 *
84 * The MMC standard provides for two boot partitions (numbered 1 and 2),
85 * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
86 *
87 * @dev_num: Block device number (struct blk_desc->dev value)
88 * @hwpart: Hardware partition number to select. 0 means the raw device,
89 * 1 is the first partition, 2 is the second, etc.
90 * @return 0 if OK, other value for an error
91 */
d2356284 92int mmc_select_hwpart(int dev_num, int hwpart);
4101f687
SG
93struct blk_desc *systemace_get_dev(int dev);
94struct blk_desc *mg_disk_get_dev(int dev);
95struct blk_desc *host_get_dev(int dev);
96int host_get_dev_err(int dev, struct blk_desc **blk_devp);
735dd97b 97
012771d8 98/* disk/part.c */
4101f687
SG
99int get_partition_info(struct blk_desc *dev_desc, int part,
100 disk_partition_t *info);
101void print_part(struct blk_desc *dev_desc);
102void init_part(struct blk_desc *dev_desc);
103void dev_print(struct blk_desc *dev_desc);
2023e608 104int get_device(const char *ifname, const char *dev_str,
4101f687 105 struct blk_desc **dev_desc);
10a37fd7 106int get_device_and_partition(const char *ifname, const char *dev_part_str,
4101f687 107 struct blk_desc **dev_desc,
10a37fd7 108 disk_partition_t *info, int allow_whole_dev);
df3fc526 109#else
db1d9e78 110static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
99d2c205 111{ return NULL; }
4101f687
SG
112static inline struct blk_desc *ide_get_dev(int dev) { return NULL; }
113static inline struct blk_desc *sata_get_dev(int dev) { return NULL; }
114static inline struct blk_desc *scsi_get_dev(int dev) { return NULL; }
115static inline struct blk_desc *usb_stor_get_dev(int dev) { return NULL; }
116static inline struct blk_desc *mmc_get_dev(int dev) { return NULL; }
d2356284 117static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
4101f687
SG
118static inline struct blk_desc *systemace_get_dev(int dev) { return NULL; }
119static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
120static inline struct blk_desc *host_get_dev(int dev) { return NULL; }
012771d8 121
4101f687
SG
122static inline int get_partition_info(struct blk_desc *dev_desc, int part,
123 disk_partition_t *info) { return -1; }
124static inline void print_part(struct blk_desc *dev_desc) {}
125static inline void init_part(struct blk_desc *dev_desc) {}
126static inline void dev_print(struct blk_desc *dev_desc) {}
2023e608 127static inline int get_device(const char *ifname, const char *dev_str,
4101f687 128 struct blk_desc **dev_desc)
2023e608 129{ return -1; }
99d2c205 130static inline int get_device_and_partition(const char *ifname,
10a37fd7 131 const char *dev_part_str,
4101f687 132 struct blk_desc **dev_desc,
10a37fd7
SW
133 disk_partition_t *info,
134 int allow_whole_dev)
99d2c205 135{ *dev_desc = NULL; return -1; }
df3fc526 136#endif
012771d8
WD
137
138#ifdef CONFIG_MAC_PARTITION
139/* disk/part_mac.c */
4101f687
SG
140int get_partition_info_mac(struct blk_desc *dev_desc, int part,
141 disk_partition_t *info);
142void print_part_mac(struct blk_desc *dev_desc);
143int test_part_mac(struct blk_desc *dev_desc);
012771d8
WD
144#endif
145
146#ifdef CONFIG_DOS_PARTITION
147/* disk/part_dos.c */
4101f687
SG
148int get_partition_info_dos(struct blk_desc *dev_desc, int part,
149 disk_partition_t *info);
150void print_part_dos(struct blk_desc *dev_desc);
151int test_part_dos(struct blk_desc *dev_desc);
012771d8
WD
152#endif
153
154#ifdef CONFIG_ISO_PARTITION
155/* disk/part_iso.c */
4101f687
SG
156int get_partition_info_iso(struct blk_desc *dev_desc, int part,
157 disk_partition_t *info);
158void print_part_iso(struct blk_desc *dev_desc);
159int test_part_iso(struct blk_desc *dev_desc);
012771d8
WD
160#endif
161
c7de829c
WD
162#ifdef CONFIG_AMIGA_PARTITION
163/* disk/part_amiga.c */
4101f687
SG
164int get_partition_info_amiga(struct blk_desc *dev_desc, int part,
165 disk_partition_t *info);
166void print_part_amiga(struct blk_desc *dev_desc);
167int test_part_amiga(struct blk_desc *dev_desc);
c7de829c
WD
168#endif
169
07f3d789 170#ifdef CONFIG_EFI_PARTITION
40684ddb 171#include <part_efi.h>
07f3d789 172/* disk/part_efi.c */
4101f687
SG
173int get_partition_info_efi(struct blk_desc *dev_desc, int part,
174 disk_partition_t *info);
60bf9416
SR
175/**
176 * get_partition_info_efi_by_name() - Find the specified GPT partition table entry
177 *
178 * @param dev_desc - block device descriptor
179 * @param gpt_name - the specified table entry name
180 * @param info - returns the disk partition info
181 *
182 * @return - '0' on match, '-1' on no match, otherwise error
183 */
4101f687 184int get_partition_info_efi_by_name(struct blk_desc *dev_desc,
60bf9416 185 const char *name, disk_partition_t *info);
4101f687
SG
186void print_part_efi(struct blk_desc *dev_desc);
187int test_part_efi(struct blk_desc *dev_desc);
40684ddb
ŁM
188
189/**
190 * write_gpt_table() - Write the GUID Partition Table to disk
191 *
192 * @param dev_desc - block device descriptor
193 * @param gpt_h - pointer to GPT header representation
194 * @param gpt_e - pointer to GPT partition table entries
195 *
196 * @return - zero on success, otherwise error
197 */
4101f687 198int write_gpt_table(struct blk_desc *dev_desc,
40684ddb
ŁM
199 gpt_header *gpt_h, gpt_entry *gpt_e);
200
201/**
202 * gpt_fill_pte(): Fill the GPT partition table entry
203 *
204 * @param gpt_h - GPT header representation
205 * @param gpt_e - GPT partition table entries
206 * @param partitions - list of partitions
207 * @param parts - number of partitions
208 *
209 * @return zero on success
210 */
211int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
212 disk_partition_t *partitions, int parts);
213
214/**
215 * gpt_fill_header(): Fill the GPT header
216 *
217 * @param dev_desc - block device descriptor
218 * @param gpt_h - GPT header representation
219 * @param str_guid - disk guid string representation
220 * @param parts_count - number of partitions
221 *
222 * @return - error on str_guid conversion error
223 */
4101f687 224int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
40684ddb
ŁM
225 char *str_guid, int parts_count);
226
227/**
228 * gpt_restore(): Restore GPT partition table
229 *
230 * @param dev_desc - block device descriptor
231 * @param str_disk_guid - disk GUID
232 * @param partitions - list of partitions
233 * @param parts - number of partitions
234 *
235 * @return zero on success
236 */
4101f687 237int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
40684ddb 238 disk_partition_t *partitions, const int parts_count);
0ff7e585
SR
239
240/**
241 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
242 *
243 * @param dev_desc - block device descriptor
244 * @param buf - buffer which contains the MBR and Primary GPT info
245 *
246 * @return - '0' on success, otherwise error
247 */
4101f687 248int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
0ff7e585
SR
249
250/**
251 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
252 *
253 * @param dev_desc - block device descriptor
254 * @param buf - buffer which contains the MBR and Primary GPT info
255 *
256 * @return - '0' on success, otherwise error
257 */
4101f687 258int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
cef68bf9
LM
259
260/**
261 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
262 * and partition table entries (PTE)
263 *
264 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
265 *
266 * @param dev_desc - block device descriptor
267 * @param gpt_head - pointer to GPT header data read from medium
268 * @param gpt_pte - pointer to GPT partition table enties read from medium
269 *
270 * @return - '0' on success, otherwise error
271 */
4101f687 272int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
cef68bf9
LM
273 gpt_entry **gpt_pte);
274
275/**
276 * gpt_verify_partitions() - Function to check if partitions' name, start and
277 * size correspond to '$partitions' env variable
278 *
279 * This function checks if on medium stored GPT data is in sync with information
280 * provided in '$partitions' environment variable. Specificially, name, start
281 * and size of the partition is checked.
282 *
283 * @param dev_desc - block device descriptor
284 * @param partitions - partition data read from '$partitions' env variable
285 * @param parts - number of partitions read from '$partitions' env variable
286 * @param gpt_head - pointer to GPT header data read from medium
287 * @param gpt_pte - pointer to GPT partition table enties read from medium
288 *
289 * @return - '0' on success, otherwise error
290 */
4101f687 291int gpt_verify_partitions(struct blk_desc *dev_desc,
cef68bf9
LM
292 disk_partition_t *partitions, int parts,
293 gpt_header *gpt_head, gpt_entry **gpt_pte);
07f3d789 294#endif
295
012771d8 296#endif /* _PART_H */