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