blob: 0caceafc5f70800876d04c015496d4ff50c114ad [file] [log] [blame]
wdenk012771d2002-03-08 21:31:05 +00001/*
wdenk42dfe7a2004-03-14 22:25:36 +00002 * (C) Copyright 2000-2004
wdenk012771d2002-03-08 21:31:05 +00003 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denk3765b3e2013-10-07 13:07:26 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk012771d2002-03-08 21:31:05 +00006 */
7#ifndef _PART_H
8#define _PART_H
Grant Likely735dd972007-02-20 09:04:34 +01009
Simon Glass1a736612016-02-29 15:25:39 -070010#include <blk.h>
wdenk6e592382004-04-18 17:39:38 +000011#include <ide.h>
Alison Chaikendb9b6202017-06-25 16:43:17 -070012#include <uuid.h>
Alison Chaiken09a49932017-07-04 11:18:50 -070013#include <linux/list.h>
wdenk012771d2002-03-08 21:31:05 +000014
Alexander Grafd96a9802016-03-04 01:09:56 +010015struct block_drvr {
16 char *name;
Alexander Grafd96a9802016-03-04 01:09:56 +010017 int (*select_hwpart)(int dev_num, int hwpart);
18};
19
Egbert Eich0472fbf2013-04-09 21:11:56 +000020#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
21 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
22 ((x & 0xffff0000) ? 16 : 0))
23#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
Egbert Eichae1768a2013-04-09 06:03:36 +000024
wdenk012771d2002-03-08 21:31:05 +000025/* Part types */
wdenk42dfe7a2004-03-14 22:25:36 +000026#define PART_TYPE_UNKNOWN 0x00
wdenk012771d2002-03-08 21:31:05 +000027#define PART_TYPE_MAC 0x01
28#define PART_TYPE_DOS 0x02
29#define PART_TYPE_ISO 0x03
wdenk42dfe7a2004-03-14 22:25:36 +000030#define PART_TYPE_AMIGA 0x04
richardretanubun07f3d782008-09-26 11:13:22 -040031#define PART_TYPE_EFI 0x05
wdenkc7de8292002-11-19 11:04:11 +000032
Petr Kulhavy87b85302016-09-09 10:27:15 +020033/* maximum number of partition entries supported by search */
34#define DOS_ENTRY_NUMBERS 8
35#define ISO_ENTRY_NUMBERS 64
36#define MAC_ENTRY_NUMBERS 64
37#define AMIGA_ENTRY_NUMBERS 8
wdenkb0fce992003-06-29 21:03:46 +000038/*
39 * Type string for U-Boot bootable partitions
40 */
41#define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
42#define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
43
wdenk012771d2002-03-08 21:31:05 +000044/* device types */
wdenkb0fce992003-06-29 21:03:46 +000045#define DEV_TYPE_UNKNOWN 0xff /* not connected */
46#define DEV_TYPE_HARDDISK 0x00 /* harddisk */
wdenk42dfe7a2004-03-14 22:25:36 +000047#define DEV_TYPE_TAPE 0x01 /* Tape */
48#define DEV_TYPE_CDROM 0x05 /* CD-ROM */
49#define DEV_TYPE_OPDISK 0x07 /* optical disk */
wdenk012771d2002-03-08 21:31:05 +000050
Alison Chaiken92856b42017-06-25 16:43:18 -070051#define PART_NAME_LEN 32
52#define PART_TYPE_LEN 32
Alison Chaikene6faf212017-06-25 16:43:22 -070053#define MAX_SEARCH_PARTITIONS 64
Alison Chaiken92856b42017-06-25 16:43:18 -070054
wdenk42dfe7a2004-03-14 22:25:36 +000055typedef struct disk_partition {
Frederic Leroy04735e92013-06-26 18:11:25 +020056 lbaint_t start; /* # of first block in partition */
57 lbaint_t size; /* number of blocks in partition */
wdenk012771d2002-03-08 21:31:05 +000058 ulong blksz; /* block size in bytes */
Alison Chaiken92856b42017-06-25 16:43:18 -070059 uchar name[PART_NAME_LEN]; /* partition name */
60 uchar type[PART_TYPE_LEN]; /* string type description */
Rob Herring40e0e562012-08-23 11:31:43 +000061 int bootable; /* Active/Bootable flag is set */
Patrick Delaunayb331cd62017-01-27 11:00:42 +010062#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
Alison Chaikendb9b6202017-06-25 16:43:17 -070063 char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
Stephen Warren894bfbb2012-09-21 09:50:59 +000064#endif
Patrick Delaunay7561b252015-10-27 11:00:27 +010065#ifdef CONFIG_PARTITION_TYPE_GUID
Alison Chaikendb9b6202017-06-25 16:43:17 -070066 char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */
Patrick Delaunay7561b252015-10-27 11:00:27 +010067#endif
Dalon Westergreenf0fb4fa2017-02-10 17:15:34 -080068#ifdef CONFIG_DOS_PARTITION
69 uchar sys_ind; /* partition type */
70#endif
wdenk012771d2002-03-08 21:31:05 +000071} disk_partition_t;
72
Alison Chaiken09a49932017-07-04 11:18:50 -070073struct disk_part {
74 int partnum;
75 disk_partition_t gpt_part_info;
76 struct list_head list;
77};
78
Grant Likely735dd972007-02-20 09:04:34 +010079/* Misc _get_dev functions */
Matthew McClintockdf3fc522011-05-24 05:31:19 +000080#ifdef CONFIG_PARTITIONS
Simon Glassfb1b7be2016-02-29 15:25:41 -070081/**
Simon Glassdb1d9e72016-02-29 15:25:42 -070082 * blk_get_dev() - get a pointer to a block device given its type and number
Simon Glassfb1b7be2016-02-29 15:25:41 -070083 *
84 * Each interface allocates its own devices and typically struct blk_desc is
85 * contained with the interface's data structure. There is no global
86 * numbering for block devices, so the interface name must be provided.
87 *
88 * @ifname: Interface name (e.g. "ide", "scsi")
89 * @dev: Device number (0 for first device on that interface, 1 for
90 * second, etc.
91 * @return pointer to the block device, or NULL if not available, or an
92 * error occurred.
93 */
Simon Glassdb1d9e72016-02-29 15:25:42 -070094struct blk_desc *blk_get_dev(const char *ifname, int dev);
Simon Glassfb1b7be2016-02-29 15:25:41 -070095
Simon Glass4101f682016-02-29 15:25:34 -070096struct blk_desc *mg_disk_get_dev(int dev);
Simon Glass4101f682016-02-29 15:25:34 -070097int host_get_dev_err(int dev, struct blk_desc **blk_devp);
Grant Likely735dd972007-02-20 09:04:34 +010098
wdenk012771d2002-03-08 21:31:05 +000099/* disk/part.c */
Simon Glass3e8bd462016-02-29 15:25:48 -0700100int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
Rob Clark4bbcc962017-09-09 13:15:55 -0400101/**
102 * part_get_info_whole_disk() - get partition info for the special case of
103 * a partition occupying the entire disk.
104 */
105int part_get_info_whole_disk(struct blk_desc *dev_desc, disk_partition_t *info);
106
Simon Glass3e8bd462016-02-29 15:25:48 -0700107void part_print(struct blk_desc *dev_desc);
108void part_init(struct blk_desc *dev_desc);
Simon Glass4101f682016-02-29 15:25:34 -0700109void dev_print(struct blk_desc *dev_desc);
Simon Glassebac37c2016-02-29 15:25:43 -0700110
111/**
112 * blk_get_device_by_str() - Get a block device given its interface/hw partition
113 *
114 * Each interface allocates its own devices and typically struct blk_desc is
115 * contained with the interface's data structure. There is no global
116 * numbering for block devices, so the interface name must be provided.
117 *
118 * The hardware parition is not related to the normal software partitioning
119 * of a device - each hardware partition is effectively a separately
120 * accessible block device. When a hardware parition is selected on MMC the
121 * other hardware partitions become inaccessible. The same block device is
122 * used to access all hardware partitions, but its capacity may change when a
123 * different hardware partition is selected.
124 *
125 * When a hardware partition number is given, the block device switches to
126 * that hardware partition.
127 *
128 * @ifname: Interface name (e.g. "ide", "scsi")
129 * @dev_str: Device and optional hw partition. This can either be a string
130 * containing the device number (e.g. "2") or the device number
131 * and hardware partition number (e.g. "2.4") for devices that
132 * support it (currently only MMC).
133 * @dev_desc: Returns a pointer to the block device on success
134 * @return block device number (local to the interface), or -1 on error
135 */
136int blk_get_device_by_str(const char *ifname, const char *dev_str,
137 struct blk_desc **dev_desc);
Simon Glasse35929e2016-02-29 15:25:44 -0700138
139/**
140 * blk_get_device_part_str() - Get a block device and partition
141 *
142 * This calls blk_get_device_by_str() to look up a device. It also looks up
143 * a partition and returns information about it.
144 *
145 * @dev_part_str is in the format:
146 * <dev>.<hw_part>:<part> where <dev> is the device number,
147 * <hw_part> is the optional hardware partition number and
148 * <part> is the partition number
149 *
150 * If ifname is "hostfs" then this function returns the sandbox host block
151 * device.
152 *
153 * If ifname is ubi, then this function returns 0, with @info set to a
154 * special UBI device.
155 *
156 * If @dev_part_str is NULL or empty or "-", then this function looks up
157 * the "bootdevice" environment variable and uses that string instead.
158 *
159 * If the partition string is empty then the first partition is used. If the
160 * partition string is "auto" then the first bootable partition is used.
161 *
162 * @ifname: Interface name (e.g. "ide", "scsi")
163 * @dev_part_str: Device and partition string
164 * @dev_desc: Returns a pointer to the block device on success
165 * @info: Returns partition information
166 * @allow_whole_dev: true to allow the user to select partition 0
167 * (which means the whole device), false to require a valid
168 * partition number >= 1
169 * @return partition number, or -1 on error
170 *
171 */
172int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
173 struct blk_desc **dev_desc,
174 disk_partition_t *info, int allow_whole_dev);
Petr Kulhavy87b85302016-09-09 10:27:15 +0200175
176/**
Sam Protsenko30789092017-09-22 01:51:58 +0300177 * part_get_info_by_name_type() - Search for a partition by name
178 * for only specified partition type
179 *
180 * @param dev_desc - block device descriptor
181 * @param gpt_name - the specified table entry name
182 * @param info - returns the disk partition info
183 * @param part_type - only search in partitions of this type
184 *
185 * @return - the partition number on match (starting on 1), -1 on no match,
186 * otherwise error
187 */
188int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
189 disk_partition_t *info, int part_type);
190
191/**
Petr Kulhavy87b85302016-09-09 10:27:15 +0200192 * part_get_info_by_name() - Search for a partition by name
193 * among all available registered partitions
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 *
Alex Deymo88b63292017-04-02 01:49:50 -0700199 * @return - the partition number on match (starting on 1), -1 on no match,
200 * otherwise error
Petr Kulhavy87b85302016-09-09 10:27:15 +0200201 */
202int part_get_info_by_name(struct blk_desc *dev_desc,
203 const char *name, disk_partition_t *info);
204
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200205/**
206 * part_set_generic_name() - create generic partition like hda1 or sdb2
207 *
208 * Helper function for partition tables, which don't hold partition names
209 * (DOS, ISO). Generates partition name out of the device type and partition
210 * number.
211 *
212 * @dev_desc: pointer to the block device
213 * @part_num: partition number for which the name is generated
214 * @name: buffer where the name is written
215 */
216void part_set_generic_name(const struct blk_desc *dev_desc,
217 int part_num, char *name);
218
Alexander Grafd96a9802016-03-04 01:09:56 +0100219extern const struct block_drvr block_drvr[];
Matthew McClintockdf3fc522011-05-24 05:31:19 +0000220#else
Simon Glassdb1d9e72016-02-29 15:25:42 -0700221static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
Rob Herring99d2c202012-09-21 04:08:17 +0000222{ return NULL; }
Simon Glass4101f682016-02-29 15:25:34 -0700223static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
wdenk012771d2002-03-08 21:31:05 +0000224
Simon Glass3e8bd462016-02-29 15:25:48 -0700225static inline int part_get_info(struct blk_desc *dev_desc, int part,
226 disk_partition_t *info) { return -1; }
Rob Clark4bbcc962017-09-09 13:15:55 -0400227static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
228 disk_partition_t *info)
229{ return -1; }
Simon Glass3e8bd462016-02-29 15:25:48 -0700230static inline void part_print(struct blk_desc *dev_desc) {}
231static inline void part_init(struct blk_desc *dev_desc) {}
Simon Glass4101f682016-02-29 15:25:34 -0700232static inline void dev_print(struct blk_desc *dev_desc) {}
Simon Glassebac37c2016-02-29 15:25:43 -0700233static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
234 struct blk_desc **dev_desc)
Stephen Warren2023e602012-09-21 09:50:56 +0000235{ return -1; }
Simon Glasse35929e2016-02-29 15:25:44 -0700236static inline int blk_get_device_part_str(const char *ifname,
Stephen Warren10a37fd2012-09-21 09:50:57 +0000237 const char *dev_part_str,
Simon Glass4101f682016-02-29 15:25:34 -0700238 struct blk_desc **dev_desc,
Stephen Warren10a37fd2012-09-21 09:50:57 +0000239 disk_partition_t *info,
240 int allow_whole_dev)
Rob Herring99d2c202012-09-21 04:08:17 +0000241{ *dev_desc = NULL; return -1; }
Matthew McClintockdf3fc522011-05-24 05:31:19 +0000242#endif
wdenk012771d2002-03-08 21:31:05 +0000243
Simon Glass96e5b032016-02-29 15:25:47 -0700244/*
245 * We don't support printing partition information in SPL and only support
246 * getting partition information in a few cases.
247 */
248#ifdef CONFIG_SPL_BUILD
249# define part_print_ptr(x) NULL
Michal Simekd9b26782016-04-05 13:34:20 +0200250# if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
Simon Glass96e5b032016-02-29 15:25:47 -0700251 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
252# define part_get_info_ptr(x) x
253# else
254# define part_get_info_ptr(x) NULL
255# endif
256#else
257#define part_print_ptr(x) x
258#define part_get_info_ptr(x) x
wdenk012771d2002-03-08 21:31:05 +0000259#endif
260
wdenk012771d2002-03-08 21:31:05 +0000261
Simon Glass96e5b032016-02-29 15:25:47 -0700262struct part_driver {
263 const char *name;
264 int part_type;
Petr Kulhavy87b85302016-09-09 10:27:15 +0200265 const int max_entries; /* maximum number of entries to search */
wdenk012771d2002-03-08 21:31:05 +0000266
Simon Glass96e5b032016-02-29 15:25:47 -0700267 /**
268 * get_info() - Get information about a partition
269 *
270 * @dev_desc: Block device descriptor
271 * @part: Partition number (1 = first)
272 * @info: Returns partition information
273 */
274 int (*get_info)(struct blk_desc *dev_desc, int part,
275 disk_partition_t *info);
276
277 /**
278 * print() - Print partition information
279 *
280 * @dev_desc: Block device descriptor
281 */
282 void (*print)(struct blk_desc *dev_desc);
283
284 /**
285 * test() - Test if a device contains this partition type
286 *
287 * @dev_desc: Block device descriptor
288 * @return 0 if the block device appears to contain this partition
289 * type, -ve if not
290 */
291 int (*test)(struct blk_desc *dev_desc);
292};
293
294/* Declare a new U-Boot partition 'driver' */
295#define U_BOOT_PART_TYPE(__name) \
296 ll_entry_declare(struct part_driver, __name, part_driver)
wdenkc7de8292002-11-19 11:04:11 +0000297
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100298#include <part_efi.h>
Rob Clark0d6ab322017-09-13 18:05:24 -0400299
300#if CONFIG_IS_ENABLED(EFI_PARTITION)
richardretanubun07f3d782008-09-26 11:13:22 -0400301/* disk/part_efi.c */
Steve Rae60bf9412014-05-26 11:52:24 -0700302/**
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100303 * write_gpt_table() - Write the GUID Partition Table to disk
304 *
305 * @param dev_desc - block device descriptor
306 * @param gpt_h - pointer to GPT header representation
307 * @param gpt_e - pointer to GPT partition table entries
308 *
309 * @return - zero on success, otherwise error
310 */
Simon Glass4101f682016-02-29 15:25:34 -0700311int write_gpt_table(struct blk_desc *dev_desc,
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100312 gpt_header *gpt_h, gpt_entry *gpt_e);
313
314/**
315 * gpt_fill_pte(): Fill the GPT partition table entry
316 *
Maxime Ripard47d7ee42017-08-23 16:01:32 +0200317 * @param dev_desc - block device descriptor
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100318 * @param gpt_h - GPT header representation
319 * @param gpt_e - GPT partition table entries
320 * @param partitions - list of partitions
321 * @param parts - number of partitions
322 *
323 * @return zero on success
324 */
Maxime Ripard47d7ee42017-08-23 16:01:32 +0200325int gpt_fill_pte(struct blk_desc *dev_desc,
326 gpt_header *gpt_h, gpt_entry *gpt_e,
327 disk_partition_t *partitions, int parts);
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100328
329/**
330 * gpt_fill_header(): Fill the GPT header
331 *
332 * @param dev_desc - block device descriptor
333 * @param gpt_h - GPT header representation
334 * @param str_guid - disk guid string representation
335 * @param parts_count - number of partitions
336 *
337 * @return - error on str_guid conversion error
338 */
Simon Glass4101f682016-02-29 15:25:34 -0700339int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100340 char *str_guid, int parts_count);
341
342/**
343 * gpt_restore(): Restore GPT partition table
344 *
345 * @param dev_desc - block device descriptor
346 * @param str_disk_guid - disk GUID
347 * @param partitions - list of partitions
348 * @param parts - number of partitions
349 *
350 * @return zero on success
351 */
Simon Glass4101f682016-02-29 15:25:34 -0700352int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100353 disk_partition_t *partitions, const int parts_count);
Steve Rae0ff7e582014-12-12 15:51:54 -0800354
355/**
356 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
357 *
358 * @param dev_desc - block device descriptor
359 * @param buf - buffer which contains the MBR and Primary GPT info
360 *
361 * @return - '0' on success, otherwise error
362 */
Simon Glass4101f682016-02-29 15:25:34 -0700363int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
Steve Rae0ff7e582014-12-12 15:51:54 -0800364
365/**
366 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
367 *
368 * @param dev_desc - block device descriptor
369 * @param buf - buffer which contains the MBR and Primary GPT info
370 *
371 * @return - '0' on success, otherwise error
372 */
Simon Glass4101f682016-02-29 15:25:34 -0700373int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100374
375/**
376 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
377 * and partition table entries (PTE)
378 *
379 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
380 *
381 * @param dev_desc - block device descriptor
382 * @param gpt_head - pointer to GPT header data read from medium
383 * @param gpt_pte - pointer to GPT partition table enties read from medium
384 *
385 * @return - '0' on success, otherwise error
386 */
Simon Glass4101f682016-02-29 15:25:34 -0700387int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100388 gpt_entry **gpt_pte);
389
390/**
391 * gpt_verify_partitions() - Function to check if partitions' name, start and
392 * size correspond to '$partitions' env variable
393 *
394 * This function checks if on medium stored GPT data is in sync with information
395 * provided in '$partitions' environment variable. Specificially, name, start
396 * and size of the partition is checked.
397 *
398 * @param dev_desc - block device descriptor
399 * @param partitions - partition data read from '$partitions' env variable
400 * @param parts - number of partitions read from '$partitions' env variable
401 * @param gpt_head - pointer to GPT header data read from medium
402 * @param gpt_pte - pointer to GPT partition table enties read from medium
403 *
404 * @return - '0' on success, otherwise error
405 */
Simon Glass4101f682016-02-29 15:25:34 -0700406int gpt_verify_partitions(struct blk_desc *dev_desc,
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100407 disk_partition_t *partitions, int parts,
408 gpt_header *gpt_head, gpt_entry **gpt_pte);
Alison Chaiken73d6d182017-06-25 16:43:23 -0700409
410
411/**
412 * get_disk_guid() - Function to read the GUID string from a device's GPT
413 *
414 * This function reads the GUID string from a block device whose descriptor
415 * is provided.
416 *
417 * @param dev_desc - block device descriptor
418 * @param guid - pre-allocated string in which to return the GUID
419 *
420 * @return - '0' on success, otherwise error
421 */
422int get_disk_guid(struct blk_desc *dev_desc, char *guid);
423
richardretanubun07f3d782008-09-26 11:13:22 -0400424#endif
425
Patrick Delaunayb0cf7332017-01-27 11:00:37 +0100426#if CONFIG_IS_ENABLED(DOS_PARTITION)
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200427/**
428 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
429 *
430 * @param buf - buffer which contains the MBR
431 *
432 * @return - '0' on success, otherwise error
433 */
434int is_valid_dos_buf(void *buf);
435
436/**
437 * write_mbr_partition() - write DOS MBR
438 *
439 * @param dev_desc - block device descriptor
440 * @param buf - buffer which contains the MBR
441 *
442 * @return - '0' on success, otherwise error
443 */
444int write_mbr_partition(struct blk_desc *dev_desc, void *buf);
445
446#endif
447
448
wdenk012771d2002-03-08 21:31:05 +0000449#endif /* _PART_H */