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