xref: /openbmc/u-boot/include/part.h (revision 4d764244)
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 
12 typedef struct block_dev_desc {
13 	int		if_type;	/* type of the interface */
14 	int		dev;		/* device number */
15 	unsigned char	part_type;	/* partition type */
16 	unsigned char	target;		/* target SCSI ID */
17 	unsigned char	lun;		/* target LUN */
18 	unsigned char	type;		/* device type */
19 	unsigned char	removable;	/* removable device */
20 #ifdef CONFIG_LBA48
21 	unsigned char	lba48;		/* device can use 48bit addr (ATA/ATAPI v7) */
22 #endif
23 	lbaint_t	lba;		/* number of blocks */
24 	unsigned long	blksz;		/* block size */
25 	int		log2blksz;	/* for convenience: log2(blksz) */
26 	char		vendor [40+1];	/* IDE model, SCSI Vendor */
27 	char		product[20+1];	/* IDE Serial no, SCSI product */
28 	char		revision[8+1];	/* firmware revision */
29 	unsigned long	(*block_read)(int dev,
30 				      lbaint_t start,
31 				      lbaint_t blkcnt,
32 				      void *buffer);
33 	unsigned long	(*block_write)(int dev,
34 				       lbaint_t start,
35 				       lbaint_t blkcnt,
36 				       const void *buffer);
37 	unsigned long   (*block_erase)(int dev,
38 				       lbaint_t start,
39 				       lbaint_t blkcnt);
40 	void		*priv;		/* driver private struct pointer */
41 }block_dev_desc_t;
42 
43 #define BLOCK_CNT(size, block_dev_desc) (PAD_COUNT(size, block_dev_desc->blksz))
44 #define PAD_TO_BLOCKSIZE(size, block_dev_desc) \
45 	(PAD_SIZE(size, block_dev_desc->blksz))
46 #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
47 		 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
48 		 ((x & 0xffff0000) ? 16 : 0))
49 #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
50 
51 /* Interface types: */
52 #define IF_TYPE_UNKNOWN		0
53 #define IF_TYPE_IDE		1
54 #define IF_TYPE_SCSI		2
55 #define IF_TYPE_ATAPI		3
56 #define IF_TYPE_USB		4
57 #define IF_TYPE_DOC		5
58 #define IF_TYPE_MMC		6
59 #define IF_TYPE_SD		7
60 #define IF_TYPE_SATA		8
61 #define IF_TYPE_HOST		9
62 #define IF_TYPE_MAX		10	/* Max number of IF_TYPE_* supported */
63 
64 /* Part types */
65 #define PART_TYPE_UNKNOWN	0x00
66 #define PART_TYPE_MAC		0x01
67 #define PART_TYPE_DOS		0x02
68 #define PART_TYPE_ISO		0x03
69 #define PART_TYPE_AMIGA		0x04
70 #define PART_TYPE_EFI		0x05
71 
72 /*
73  * Type string for U-Boot bootable partitions
74  */
75 #define BOOT_PART_TYPE	"U-Boot"	/* primary boot partition type	*/
76 #define BOOT_PART_COMP	"PPCBoot"	/* PPCBoot compatibility type	*/
77 
78 /* device types */
79 #define DEV_TYPE_UNKNOWN	0xff	/* not connected */
80 #define DEV_TYPE_HARDDISK	0x00	/* harddisk */
81 #define DEV_TYPE_TAPE		0x01	/* Tape */
82 #define DEV_TYPE_CDROM		0x05	/* CD-ROM */
83 #define DEV_TYPE_OPDISK		0x07	/* optical disk */
84 
85 typedef struct disk_partition {
86 	lbaint_t	start;	/* # of first block in partition	*/
87 	lbaint_t	size;	/* number of blocks in partition	*/
88 	ulong	blksz;		/* block size in bytes			*/
89 	uchar	name[32];	/* partition name			*/
90 	uchar	type[32];	/* string type description		*/
91 	int	bootable;	/* Active/Bootable flag is set		*/
92 #ifdef CONFIG_PARTITION_UUIDS
93 	char	uuid[37];	/* filesystem UUID as string, if exists	*/
94 #endif
95 } disk_partition_t;
96 
97 /* Misc _get_dev functions */
98 #ifdef CONFIG_PARTITIONS
99 block_dev_desc_t *get_dev(const char *ifname, int dev);
100 block_dev_desc_t* ide_get_dev(int dev);
101 block_dev_desc_t* sata_get_dev(int dev);
102 block_dev_desc_t* scsi_get_dev(int dev);
103 block_dev_desc_t* usb_stor_get_dev(int dev);
104 block_dev_desc_t* mmc_get_dev(int dev);
105 block_dev_desc_t* systemace_get_dev(int dev);
106 block_dev_desc_t* mg_disk_get_dev(int dev);
107 block_dev_desc_t *host_get_dev(int dev);
108 int host_get_dev_err(int dev, block_dev_desc_t **blk_devp);
109 
110 /* disk/part.c */
111 int get_partition_info (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
112 void print_part (block_dev_desc_t *dev_desc);
113 void  init_part (block_dev_desc_t *dev_desc);
114 void dev_print(block_dev_desc_t *dev_desc);
115 int get_device(const char *ifname, const char *dev_str,
116 	       block_dev_desc_t **dev_desc);
117 int get_device_and_partition(const char *ifname, const char *dev_part_str,
118 			     block_dev_desc_t **dev_desc,
119 			     disk_partition_t *info, int allow_whole_dev);
120 #else
121 static inline block_dev_desc_t *get_dev(const char *ifname, int dev)
122 { return NULL; }
123 static inline block_dev_desc_t* ide_get_dev(int dev) { return NULL; }
124 static inline block_dev_desc_t* sata_get_dev(int dev) { return NULL; }
125 static inline block_dev_desc_t* scsi_get_dev(int dev) { return NULL; }
126 static inline block_dev_desc_t* usb_stor_get_dev(int dev) { return NULL; }
127 static inline block_dev_desc_t* mmc_get_dev(int dev) { return NULL; }
128 static inline block_dev_desc_t* systemace_get_dev(int dev) { return NULL; }
129 static inline block_dev_desc_t* mg_disk_get_dev(int dev) { return NULL; }
130 static inline block_dev_desc_t *host_get_dev(int dev) { return NULL; }
131 
132 static inline int get_partition_info (block_dev_desc_t * dev_desc, int part,
133 	disk_partition_t *info) { return -1; }
134 static inline void print_part (block_dev_desc_t *dev_desc) {}
135 static inline void  init_part (block_dev_desc_t *dev_desc) {}
136 static inline void dev_print(block_dev_desc_t *dev_desc) {}
137 static inline int get_device(const char *ifname, const char *dev_str,
138 	       block_dev_desc_t **dev_desc)
139 { return -1; }
140 static inline int get_device_and_partition(const char *ifname,
141 					   const char *dev_part_str,
142 					   block_dev_desc_t **dev_desc,
143 					   disk_partition_t *info,
144 					   int allow_whole_dev)
145 { *dev_desc = NULL; return -1; }
146 #endif
147 
148 #ifdef CONFIG_MAC_PARTITION
149 /* disk/part_mac.c */
150 int get_partition_info_mac (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
151 void print_part_mac (block_dev_desc_t *dev_desc);
152 int   test_part_mac (block_dev_desc_t *dev_desc);
153 #endif
154 
155 #ifdef CONFIG_DOS_PARTITION
156 /* disk/part_dos.c */
157 int get_partition_info_dos (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
158 void print_part_dos (block_dev_desc_t *dev_desc);
159 int   test_part_dos (block_dev_desc_t *dev_desc);
160 #endif
161 
162 #ifdef CONFIG_ISO_PARTITION
163 /* disk/part_iso.c */
164 int get_partition_info_iso (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
165 void print_part_iso (block_dev_desc_t *dev_desc);
166 int   test_part_iso (block_dev_desc_t *dev_desc);
167 #endif
168 
169 #ifdef CONFIG_AMIGA_PARTITION
170 /* disk/part_amiga.c */
171 int get_partition_info_amiga (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
172 void print_part_amiga (block_dev_desc_t *dev_desc);
173 int   test_part_amiga (block_dev_desc_t *dev_desc);
174 #endif
175 
176 #ifdef CONFIG_EFI_PARTITION
177 #include <part_efi.h>
178 /* disk/part_efi.c */
179 int get_partition_info_efi (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
180 void print_part_efi (block_dev_desc_t *dev_desc);
181 int   test_part_efi (block_dev_desc_t *dev_desc);
182 
183 /**
184  * write_gpt_table() - Write the GUID Partition Table to disk
185  *
186  * @param dev_desc - block device descriptor
187  * @param gpt_h - pointer to GPT header representation
188  * @param gpt_e - pointer to GPT partition table entries
189  *
190  * @return - zero on success, otherwise error
191  */
192 int write_gpt_table(block_dev_desc_t *dev_desc,
193 		  gpt_header *gpt_h, gpt_entry *gpt_e);
194 
195 /**
196  * gpt_fill_pte(): Fill the GPT partition table entry
197  *
198  * @param gpt_h - GPT header representation
199  * @param gpt_e - GPT partition table entries
200  * @param partitions - list of partitions
201  * @param parts - number of partitions
202  *
203  * @return zero on success
204  */
205 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
206 		disk_partition_t *partitions, int parts);
207 
208 /**
209  * gpt_fill_header(): Fill the GPT header
210  *
211  * @param dev_desc - block device descriptor
212  * @param gpt_h - GPT header representation
213  * @param str_guid - disk guid string representation
214  * @param parts_count - number of partitions
215  *
216  * @return - error on str_guid conversion error
217  */
218 int gpt_fill_header(block_dev_desc_t *dev_desc, gpt_header *gpt_h,
219 		char *str_guid, int parts_count);
220 
221 /**
222  * gpt_restore(): Restore GPT partition table
223  *
224  * @param dev_desc - block device descriptor
225  * @param str_disk_guid - disk GUID
226  * @param partitions - list of partitions
227  * @param parts - number of partitions
228  *
229  * @return zero on success
230  */
231 int gpt_restore(block_dev_desc_t *dev_desc, char *str_disk_guid,
232 		disk_partition_t *partitions, const int parts_count);
233 #endif
234 
235 #endif /* _PART_H */
236