xref: /openbmc/u-boot/include/part.h (revision 4810400e)
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 
62 /* Part types */
63 #define PART_TYPE_UNKNOWN	0x00
64 #define PART_TYPE_MAC		0x01
65 #define PART_TYPE_DOS		0x02
66 #define PART_TYPE_ISO		0x03
67 #define PART_TYPE_AMIGA		0x04
68 #define PART_TYPE_EFI		0x05
69 
70 /*
71  * Type string for U-Boot bootable partitions
72  */
73 #define BOOT_PART_TYPE	"U-Boot"	/* primary boot partition type	*/
74 #define BOOT_PART_COMP	"PPCBoot"	/* PPCBoot compatibility type	*/
75 
76 /* device types */
77 #define DEV_TYPE_UNKNOWN	0xff	/* not connected */
78 #define DEV_TYPE_HARDDISK	0x00	/* harddisk */
79 #define DEV_TYPE_TAPE		0x01	/* Tape */
80 #define DEV_TYPE_CDROM		0x05	/* CD-ROM */
81 #define DEV_TYPE_OPDISK		0x07	/* optical disk */
82 
83 typedef struct disk_partition {
84 	lbaint_t	start;	/* # of first block in partition	*/
85 	lbaint_t	size;	/* number of blocks in partition	*/
86 	ulong	blksz;		/* block size in bytes			*/
87 	uchar	name[32];	/* partition name			*/
88 	uchar	type[32];	/* string type description		*/
89 	int	bootable;	/* Active/Bootable flag is set		*/
90 #ifdef CONFIG_PARTITION_UUIDS
91 	char	uuid[37];	/* filesystem UUID as string, if exists	*/
92 #endif
93 } disk_partition_t;
94 
95 /* Misc _get_dev functions */
96 #ifdef CONFIG_PARTITIONS
97 block_dev_desc_t *get_dev(const char *ifname, int dev);
98 block_dev_desc_t* ide_get_dev(int dev);
99 block_dev_desc_t* sata_get_dev(int dev);
100 block_dev_desc_t* scsi_get_dev(int dev);
101 block_dev_desc_t* usb_stor_get_dev(int dev);
102 block_dev_desc_t* mmc_get_dev(int dev);
103 block_dev_desc_t* systemace_get_dev(int dev);
104 block_dev_desc_t* mg_disk_get_dev(int dev);
105 
106 /* disk/part.c */
107 int get_partition_info (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
108 void print_part (block_dev_desc_t *dev_desc);
109 void  init_part (block_dev_desc_t *dev_desc);
110 void dev_print(block_dev_desc_t *dev_desc);
111 int get_device(const char *ifname, const char *dev_str,
112 	       block_dev_desc_t **dev_desc);
113 int get_device_and_partition(const char *ifname, const char *dev_part_str,
114 			     block_dev_desc_t **dev_desc,
115 			     disk_partition_t *info, int allow_whole_dev);
116 #else
117 static inline block_dev_desc_t *get_dev(const char *ifname, int dev)
118 { return NULL; }
119 static inline block_dev_desc_t* ide_get_dev(int dev) { return NULL; }
120 static inline block_dev_desc_t* sata_get_dev(int dev) { return NULL; }
121 static inline block_dev_desc_t* scsi_get_dev(int dev) { return NULL; }
122 static inline block_dev_desc_t* usb_stor_get_dev(int dev) { return NULL; }
123 static inline block_dev_desc_t* mmc_get_dev(int dev) { return NULL; }
124 static inline block_dev_desc_t* systemace_get_dev(int dev) { return NULL; }
125 static inline block_dev_desc_t* mg_disk_get_dev(int dev) { return NULL; }
126 
127 static inline int get_partition_info (block_dev_desc_t * dev_desc, int part,
128 	disk_partition_t *info) { return -1; }
129 static inline void print_part (block_dev_desc_t *dev_desc) {}
130 static inline void  init_part (block_dev_desc_t *dev_desc) {}
131 static inline void dev_print(block_dev_desc_t *dev_desc) {}
132 static inline int get_device(const char *ifname, const char *dev_str,
133 	       block_dev_desc_t **dev_desc)
134 { return -1; }
135 static inline int get_device_and_partition(const char *ifname,
136 					   const char *dev_part_str,
137 					   block_dev_desc_t **dev_desc,
138 					   disk_partition_t *info,
139 					   int allow_whole_dev)
140 { *dev_desc = NULL; return -1; }
141 #endif
142 
143 #ifdef CONFIG_MAC_PARTITION
144 /* disk/part_mac.c */
145 int get_partition_info_mac (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
146 void print_part_mac (block_dev_desc_t *dev_desc);
147 int   test_part_mac (block_dev_desc_t *dev_desc);
148 #endif
149 
150 #ifdef CONFIG_DOS_PARTITION
151 /* disk/part_dos.c */
152 int get_partition_info_dos (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
153 void print_part_dos (block_dev_desc_t *dev_desc);
154 int   test_part_dos (block_dev_desc_t *dev_desc);
155 #endif
156 
157 #ifdef CONFIG_ISO_PARTITION
158 /* disk/part_iso.c */
159 int get_partition_info_iso (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
160 void print_part_iso (block_dev_desc_t *dev_desc);
161 int   test_part_iso (block_dev_desc_t *dev_desc);
162 #endif
163 
164 #ifdef CONFIG_AMIGA_PARTITION
165 /* disk/part_amiga.c */
166 int get_partition_info_amiga (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
167 void print_part_amiga (block_dev_desc_t *dev_desc);
168 int   test_part_amiga (block_dev_desc_t *dev_desc);
169 #endif
170 
171 #ifdef CONFIG_EFI_PARTITION
172 #include <part_efi.h>
173 /* disk/part_efi.c */
174 int get_partition_info_efi (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
175 void print_part_efi (block_dev_desc_t *dev_desc);
176 int   test_part_efi (block_dev_desc_t *dev_desc);
177 
178 /**
179  * write_gpt_table() - Write the GUID Partition Table to disk
180  *
181  * @param dev_desc - block device descriptor
182  * @param gpt_h - pointer to GPT header representation
183  * @param gpt_e - pointer to GPT partition table entries
184  *
185  * @return - zero on success, otherwise error
186  */
187 int write_gpt_table(block_dev_desc_t *dev_desc,
188 		  gpt_header *gpt_h, gpt_entry *gpt_e);
189 
190 /**
191  * gpt_fill_pte(): Fill the GPT partition table entry
192  *
193  * @param gpt_h - GPT header representation
194  * @param gpt_e - GPT partition table entries
195  * @param partitions - list of partitions
196  * @param parts - number of partitions
197  *
198  * @return zero on success
199  */
200 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
201 		disk_partition_t *partitions, int parts);
202 
203 /**
204  * gpt_fill_header(): Fill the GPT header
205  *
206  * @param dev_desc - block device descriptor
207  * @param gpt_h - GPT header representation
208  * @param str_guid - disk guid string representation
209  * @param parts_count - number of partitions
210  *
211  * @return - error on str_guid conversion error
212  */
213 int gpt_fill_header(block_dev_desc_t *dev_desc, gpt_header *gpt_h,
214 		char *str_guid, int parts_count);
215 
216 /**
217  * gpt_restore(): Restore GPT partition table
218  *
219  * @param dev_desc - block device descriptor
220  * @param str_disk_guid - disk GUID
221  * @param partitions - list of partitions
222  * @param parts - number of partitions
223  *
224  * @return zero on success
225  */
226 int gpt_restore(block_dev_desc_t *dev_desc, char *str_disk_guid,
227 		disk_partition_t *partitions, const int parts_count);
228 #endif
229 
230 #endif /* _PART_H */
231