]> git.ipfire.org Git - thirdparty/u-boot.git/blame - include/part.h
dm: part: Drop the common.h header
[thirdparty/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
6e592385 10#include <ide.h>
012771d8 11
4101f687 12struct blk_desc {
42dfe7a1 13 int if_type; /* type of the interface */
d049cc7f
WD
14 int dev; /* device number */
15 unsigned char part_type; /* partition type */
42dfe7a1
WD
16 unsigned char target; /* target SCSI ID */
17 unsigned char lun; /* target LUN */
873cc1d7 18 unsigned char hwpart; /* HW partition, e.g. for eMMC */
42dfe7a1
WD
19 unsigned char type; /* device type */
20 unsigned char removable; /* removable device */
21#ifdef CONFIG_LBA48
22 unsigned char lba48; /* device can use 48bit addr (ATA/ATAPI v7) */
23#endif
985889b1 24 lbaint_t lba; /* number of blocks */
42dfe7a1 25 unsigned long blksz; /* block size */
0472fbfd 26 int log2blksz; /* for convenience: log2(blksz) */
d049cc7f 27 char vendor [40+1]; /* IDE model, SCSI Vendor */
2a4741d9
MZ
28 char product[20+1]; /* IDE Serial no, SCSI product */
29 char revision[8+1]; /* firmware revision */
4101f687 30 unsigned long (*block_read)(struct blk_desc *block_dev,
ff8fef56 31 lbaint_t start,
6e592385 32 lbaint_t blkcnt,
eb867a76 33 void *buffer);
4101f687 34 unsigned long (*block_write)(struct blk_desc *block_dev,
ff8fef56 35 lbaint_t start,
53758fa2
GL
36 lbaint_t blkcnt,
37 const void *buffer);
4101f687 38 unsigned long (*block_erase)(struct blk_desc *block_dev,
ff8fef56 39 lbaint_t start,
e6f99a56 40 lbaint_t blkcnt);
c7057b52 41 void *priv; /* driver private struct pointer */
7c4213f6 42};
b0fce99b 43
4101f687
SG
44#define BLOCK_CNT(size, blk_desc) (PAD_COUNT(size, blk_desc->blksz))
45#define PAD_TO_BLOCKSIZE(size, blk_desc) \
46 (PAD_SIZE(size, blk_desc->blksz))
0472fbfd
EE
47#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
48 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
49 ((x & 0xffff0000) ? 16 : 0))
50#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
ae1768a7 51
012771d8 52/* Interface types: */
b0fce99b
WD
53#define IF_TYPE_UNKNOWN 0
54#define IF_TYPE_IDE 1
012771d8
WD
55#define IF_TYPE_SCSI 2
56#define IF_TYPE_ATAPI 3
b0fce99b
WD
57#define IF_TYPE_USB 4
58#define IF_TYPE_DOC 5
7205e407 59#define IF_TYPE_MMC 6
c95219fa 60#define IF_TYPE_SD 7
c7057b52 61#define IF_TYPE_SATA 8
f4d8de48
HN
62#define IF_TYPE_HOST 9
63#define IF_TYPE_MAX 10 /* Max number of IF_TYPE_* supported */
b0fce99b 64
012771d8 65/* Part types */
42dfe7a1 66#define PART_TYPE_UNKNOWN 0x00
012771d8
WD
67#define PART_TYPE_MAC 0x01
68#define PART_TYPE_DOS 0x02
69#define PART_TYPE_ISO 0x03
42dfe7a1 70#define PART_TYPE_AMIGA 0x04
07f3d789 71#define PART_TYPE_EFI 0x05
c7de829c 72
b0fce99b
WD
73/*
74 * Type string for U-Boot bootable partitions
75 */
76#define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
77#define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
78
012771d8 79/* device types */
b0fce99b
WD
80#define DEV_TYPE_UNKNOWN 0xff /* not connected */
81#define DEV_TYPE_HARDDISK 0x00 /* harddisk */
42dfe7a1
WD
82#define DEV_TYPE_TAPE 0x01 /* Tape */
83#define DEV_TYPE_CDROM 0x05 /* CD-ROM */
84#define DEV_TYPE_OPDISK 0x07 /* optical disk */
012771d8 85
42dfe7a1 86typedef struct disk_partition {
04735e9c
FL
87 lbaint_t start; /* # of first block in partition */
88 lbaint_t size; /* number of blocks in partition */
012771d8
WD
89 ulong blksz; /* block size in bytes */
90 uchar name[32]; /* partition name */
91 uchar type[32]; /* string type description */
40e0e568 92 int bootable; /* Active/Bootable flag is set */
894bfbbf
SW
93#ifdef CONFIG_PARTITION_UUIDS
94 char uuid[37]; /* filesystem UUID as string, if exists */
95#endif
7561b258
PD
96#ifdef CONFIG_PARTITION_TYPE_GUID
97 char type_guid[37]; /* type GUID as string, if exists */
98#endif
012771d8
WD
99} disk_partition_t;
100
735dd97b 101/* Misc _get_dev functions */
df3fc526 102#ifdef CONFIG_PARTITIONS
4101f687
SG
103struct blk_desc *get_dev(const char *ifname, int dev);
104struct blk_desc *ide_get_dev(int dev);
105struct blk_desc *sata_get_dev(int dev);
106struct blk_desc *scsi_get_dev(int dev);
107struct blk_desc *usb_stor_get_dev(int dev);
108struct blk_desc *mmc_get_dev(int dev);
d2356284 109int mmc_select_hwpart(int dev_num, int hwpart);
4101f687
SG
110struct blk_desc *systemace_get_dev(int dev);
111struct blk_desc *mg_disk_get_dev(int dev);
112struct blk_desc *host_get_dev(int dev);
113int host_get_dev_err(int dev, struct blk_desc **blk_devp);
735dd97b 114
012771d8 115/* disk/part.c */
4101f687
SG
116int get_partition_info(struct blk_desc *dev_desc, int part,
117 disk_partition_t *info);
118void print_part(struct blk_desc *dev_desc);
119void init_part(struct blk_desc *dev_desc);
120void dev_print(struct blk_desc *dev_desc);
2023e608 121int get_device(const char *ifname, const char *dev_str,
4101f687 122 struct blk_desc **dev_desc);
10a37fd7 123int get_device_and_partition(const char *ifname, const char *dev_part_str,
4101f687 124 struct blk_desc **dev_desc,
10a37fd7 125 disk_partition_t *info, int allow_whole_dev);
df3fc526 126#else
4101f687 127static inline struct blk_desc *get_dev(const char *ifname, int dev)
99d2c205 128{ return NULL; }
4101f687
SG
129static inline struct blk_desc *ide_get_dev(int dev) { return NULL; }
130static inline struct blk_desc *sata_get_dev(int dev) { return NULL; }
131static inline struct blk_desc *scsi_get_dev(int dev) { return NULL; }
132static inline struct blk_desc *usb_stor_get_dev(int dev) { return NULL; }
133static inline struct blk_desc *mmc_get_dev(int dev) { return NULL; }
d2356284 134static inline int mmc_select_hwpart(int dev_num, int hwpart) { return -1; }
4101f687
SG
135static inline struct blk_desc *systemace_get_dev(int dev) { return NULL; }
136static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
137static inline struct blk_desc *host_get_dev(int dev) { return NULL; }
012771d8 138
4101f687
SG
139static inline int get_partition_info(struct blk_desc *dev_desc, int part,
140 disk_partition_t *info) { return -1; }
141static inline void print_part(struct blk_desc *dev_desc) {}
142static inline void init_part(struct blk_desc *dev_desc) {}
143static inline void dev_print(struct blk_desc *dev_desc) {}
2023e608 144static inline int get_device(const char *ifname, const char *dev_str,
4101f687 145 struct blk_desc **dev_desc)
2023e608 146{ return -1; }
99d2c205 147static inline int get_device_and_partition(const char *ifname,
10a37fd7 148 const char *dev_part_str,
4101f687 149 struct blk_desc **dev_desc,
10a37fd7
SW
150 disk_partition_t *info,
151 int allow_whole_dev)
99d2c205 152{ *dev_desc = NULL; return -1; }
df3fc526 153#endif
012771d8
WD
154
155#ifdef CONFIG_MAC_PARTITION
156/* disk/part_mac.c */
4101f687
SG
157int get_partition_info_mac(struct blk_desc *dev_desc, int part,
158 disk_partition_t *info);
159void print_part_mac(struct blk_desc *dev_desc);
160int test_part_mac(struct blk_desc *dev_desc);
012771d8
WD
161#endif
162
163#ifdef CONFIG_DOS_PARTITION
164/* disk/part_dos.c */
4101f687
SG
165int get_partition_info_dos(struct blk_desc *dev_desc, int part,
166 disk_partition_t *info);
167void print_part_dos(struct blk_desc *dev_desc);
168int test_part_dos(struct blk_desc *dev_desc);
012771d8
WD
169#endif
170
171#ifdef CONFIG_ISO_PARTITION
172/* disk/part_iso.c */
4101f687
SG
173int get_partition_info_iso(struct blk_desc *dev_desc, int part,
174 disk_partition_t *info);
175void print_part_iso(struct blk_desc *dev_desc);
176int test_part_iso(struct blk_desc *dev_desc);
012771d8
WD
177#endif
178
c7de829c
WD
179#ifdef CONFIG_AMIGA_PARTITION
180/* disk/part_amiga.c */
4101f687
SG
181int get_partition_info_amiga(struct blk_desc *dev_desc, int part,
182 disk_partition_t *info);
183void print_part_amiga(struct blk_desc *dev_desc);
184int test_part_amiga(struct blk_desc *dev_desc);
c7de829c
WD
185#endif
186
07f3d789 187#ifdef CONFIG_EFI_PARTITION
40684ddb 188#include <part_efi.h>
07f3d789 189/* disk/part_efi.c */
4101f687
SG
190int get_partition_info_efi(struct blk_desc *dev_desc, int part,
191 disk_partition_t *info);
60bf9416
SR
192/**
193 * get_partition_info_efi_by_name() - Find the specified GPT partition table entry
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 - '0' on match, '-1' on no match, otherwise error
200 */
4101f687 201int get_partition_info_efi_by_name(struct blk_desc *dev_desc,
60bf9416 202 const char *name, disk_partition_t *info);
4101f687
SG
203void print_part_efi(struct blk_desc *dev_desc);
204int test_part_efi(struct blk_desc *dev_desc);
40684ddb
ŁM
205
206/**
207 * write_gpt_table() - Write the GUID Partition Table to disk
208 *
209 * @param dev_desc - block device descriptor
210 * @param gpt_h - pointer to GPT header representation
211 * @param gpt_e - pointer to GPT partition table entries
212 *
213 * @return - zero on success, otherwise error
214 */
4101f687 215int write_gpt_table(struct blk_desc *dev_desc,
40684ddb
ŁM
216 gpt_header *gpt_h, gpt_entry *gpt_e);
217
218/**
219 * gpt_fill_pte(): Fill the GPT partition table entry
220 *
221 * @param gpt_h - GPT header representation
222 * @param gpt_e - GPT partition table entries
223 * @param partitions - list of partitions
224 * @param parts - number of partitions
225 *
226 * @return zero on success
227 */
228int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
229 disk_partition_t *partitions, int parts);
230
231/**
232 * gpt_fill_header(): Fill the GPT header
233 *
234 * @param dev_desc - block device descriptor
235 * @param gpt_h - GPT header representation
236 * @param str_guid - disk guid string representation
237 * @param parts_count - number of partitions
238 *
239 * @return - error on str_guid conversion error
240 */
4101f687 241int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
40684ddb
ŁM
242 char *str_guid, int parts_count);
243
244/**
245 * gpt_restore(): Restore GPT partition table
246 *
247 * @param dev_desc - block device descriptor
248 * @param str_disk_guid - disk GUID
249 * @param partitions - list of partitions
250 * @param parts - number of partitions
251 *
252 * @return zero on success
253 */
4101f687 254int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
40684ddb 255 disk_partition_t *partitions, const int parts_count);
0ff7e585
SR
256
257/**
258 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
259 *
260 * @param dev_desc - block device descriptor
261 * @param buf - buffer which contains the MBR and Primary GPT info
262 *
263 * @return - '0' on success, otherwise error
264 */
4101f687 265int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
0ff7e585
SR
266
267/**
268 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
269 *
270 * @param dev_desc - block device descriptor
271 * @param buf - buffer which contains the MBR and Primary GPT info
272 *
273 * @return - '0' on success, otherwise error
274 */
4101f687 275int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
cef68bf9
LM
276
277/**
278 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
279 * and partition table entries (PTE)
280 *
281 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
282 *
283 * @param dev_desc - block device descriptor
284 * @param gpt_head - pointer to GPT header data read from medium
285 * @param gpt_pte - pointer to GPT partition table enties read from medium
286 *
287 * @return - '0' on success, otherwise error
288 */
4101f687 289int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
cef68bf9
LM
290 gpt_entry **gpt_pte);
291
292/**
293 * gpt_verify_partitions() - Function to check if partitions' name, start and
294 * size correspond to '$partitions' env variable
295 *
296 * This function checks if on medium stored GPT data is in sync with information
297 * provided in '$partitions' environment variable. Specificially, name, start
298 * and size of the partition is checked.
299 *
300 * @param dev_desc - block device descriptor
301 * @param partitions - partition data read from '$partitions' env variable
302 * @param parts - number of partitions read from '$partitions' env variable
303 * @param gpt_head - pointer to GPT header data read from medium
304 * @param gpt_pte - pointer to GPT partition table enties read from medium
305 *
306 * @return - '0' on success, otherwise error
307 */
4101f687 308int gpt_verify_partitions(struct blk_desc *dev_desc,
cef68bf9
LM
309 disk_partition_t *partitions, int parts,
310 gpt_header *gpt_head, gpt_entry **gpt_pte);
07f3d789 311#endif
312
012771d8 313#endif /* _PART_H */