blob: be75c73549554f530b8539d81c0bff0232e22c98 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk012771d2002-03-08 21:31:05 +00002/*
wdenk42dfe7a2004-03-14 22:25:36 +00003 * (C) Copyright 2000-2004
wdenk012771d2002-03-08 21:31:05 +00004 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenk012771d2002-03-08 21:31:05 +00005 */
6#ifndef _PART_H
7#define _PART_H
Grant Likely735dd972007-02-20 09:04:34 +01008
Simon Glass1a736612016-02-29 15:25:39 -07009#include <blk.h>
wdenk6e592382004-04-18 17:39:38 +000010#include <ide.h>
Alison Chaikendb9b6202017-06-25 16:43:17 -070011#include <uuid.h>
Corneliu Doban12fc1f32020-11-09 11:49:16 +053012#include <linker_lists.h>
AKASHI Takahirofd3654d2022-04-19 10:01:52 +090013#include <linux/errno.h>
Alison Chaiken09a49932017-07-04 11:18:50 -070014#include <linux/list.h>
wdenk012771d2002-03-08 21:31:05 +000015
Alexander Grafd96a9802016-03-04 01:09:56 +010016struct block_drvr {
17 char *name;
Alexander Grafd96a9802016-03-04 01:09:56 +010018 int (*select_hwpart)(int dev_num, int hwpart);
19};
20
Egbert Eich0472fbf2013-04-09 21:11:56 +000021#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
22 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
23 ((x & 0xffff0000) ? 16 : 0))
24#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
Egbert Eichae1768a2013-04-09 06:03:36 +000025
wdenk012771d2002-03-08 21:31:05 +000026/* Part types */
wdenk42dfe7a2004-03-14 22:25:36 +000027#define PART_TYPE_UNKNOWN 0x00
wdenk012771d2002-03-08 21:31:05 +000028#define PART_TYPE_MAC 0x01
29#define PART_TYPE_DOS 0x02
30#define PART_TYPE_ISO 0x03
wdenk42dfe7a2004-03-14 22:25:36 +000031#define PART_TYPE_AMIGA 0x04
richardretanubun07f3d782008-09-26 11:13:22 -040032#define PART_TYPE_EFI 0x05
wdenkc7de8292002-11-19 11:04:11 +000033
Petr Kulhavy87b85302016-09-09 10:27:15 +020034/* maximum number of partition entries supported by search */
35#define DOS_ENTRY_NUMBERS 8
36#define ISO_ENTRY_NUMBERS 64
37#define MAC_ENTRY_NUMBERS 64
38#define AMIGA_ENTRY_NUMBERS 8
wdenkb0fce992003-06-29 21:03:46 +000039/*
40 * Type string for U-Boot bootable partitions
41 */
42#define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
43#define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
44
wdenk012771d2002-03-08 21:31:05 +000045/* device types */
wdenkb0fce992003-06-29 21:03:46 +000046#define DEV_TYPE_UNKNOWN 0xff /* not connected */
47#define DEV_TYPE_HARDDISK 0x00 /* harddisk */
wdenk42dfe7a2004-03-14 22:25:36 +000048#define DEV_TYPE_TAPE 0x01 /* Tape */
49#define DEV_TYPE_CDROM 0x05 /* CD-ROM */
50#define DEV_TYPE_OPDISK 0x07 /* optical disk */
wdenk012771d2002-03-08 21:31:05 +000051
Alison Chaiken92856b42017-06-25 16:43:18 -070052#define PART_NAME_LEN 32
53#define PART_TYPE_LEN 32
Heinrich Schuchardtbc314f82022-01-11 16:03:38 +010054#define MAX_SEARCH_PARTITIONS 128
Alison Chaiken92856b42017-06-25 16:43:18 -070055
Heinrich Schuchardt25801ac2020-03-19 13:49:34 +010056#define PART_BOOTABLE ((int)BIT(0))
57#define PART_EFI_SYSTEM_PARTITION ((int)BIT(1))
58
Simon Glass05289792020-05-10 11:39:57 -060059struct disk_partition {
Frederic Leroy04735e92013-06-26 18:11:25 +020060 lbaint_t start; /* # of first block in partition */
61 lbaint_t size; /* number of blocks in partition */
wdenk012771d2002-03-08 21:31:05 +000062 ulong blksz; /* block size in bytes */
Alison Chaiken92856b42017-06-25 16:43:18 -070063 uchar name[PART_NAME_LEN]; /* partition name */
64 uchar type[PART_TYPE_LEN]; /* string type description */
Heinrich Schuchardt25801ac2020-03-19 13:49:34 +010065 /*
66 * The bootable is a bitmask with the following fields:
67 *
68 * PART_BOOTABLE the MBR bootable flag is set
69 * PART_EFI_SYSTEM_PARTITION the partition is an EFI system partition
70 */
71 int bootable;
Patrick Delaunayb331cd62017-01-27 11:00:42 +010072#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
Alison Chaikendb9b6202017-06-25 16:43:17 -070073 char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
Stephen Warren894bfbb2012-09-21 09:50:59 +000074#endif
Patrick Delaunay7561b252015-10-27 11:00:27 +010075#ifdef CONFIG_PARTITION_TYPE_GUID
Alison Chaikendb9b6202017-06-25 16:43:17 -070076 char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */
Patrick Delaunay7561b252015-10-27 11:00:27 +010077#endif
Dalon Westergreenf0fb4fa2017-02-10 17:15:34 -080078#ifdef CONFIG_DOS_PARTITION
Wolfgang Denk0cf207e2021-09-27 17:42:39 +020079 uchar sys_ind; /* partition type */
Dalon Westergreenf0fb4fa2017-02-10 17:15:34 -080080#endif
Simon Glass05289792020-05-10 11:39:57 -060081};
wdenk012771d2002-03-08 21:31:05 +000082
Alison Chaiken09a49932017-07-04 11:18:50 -070083struct disk_part {
84 int partnum;
Simon Glass05289792020-05-10 11:39:57 -060085 struct disk_partition gpt_part_info;
Alison Chaiken09a49932017-07-04 11:18:50 -070086 struct list_head list;
87};
88
Grant Likely735dd972007-02-20 09:04:34 +010089/* Misc _get_dev functions */
AKASHI Takahiro37168e32022-04-19 10:01:53 +090090#if CONFIG_IS_ENABLED(PARTITIONS)
Simon Glassfb1b7be2016-02-29 15:25:41 -070091/**
Simon Glassdb1d9e72016-02-29 15:25:42 -070092 * blk_get_dev() - get a pointer to a block device given its type and number
Simon Glassfb1b7be2016-02-29 15:25:41 -070093 *
94 * Each interface allocates its own devices and typically struct blk_desc is
95 * contained with the interface's data structure. There is no global
96 * numbering for block devices, so the interface name must be provided.
97 *
98 * @ifname: Interface name (e.g. "ide", "scsi")
99 * @dev: Device number (0 for first device on that interface, 1 for
100 * second, etc.
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100101 * Return: pointer to the block device, or NULL if not available, or an
Simon Glassfb1b7be2016-02-29 15:25:41 -0700102 * error occurred.
103 */
Simon Glassdb1d9e72016-02-29 15:25:42 -0700104struct blk_desc *blk_get_dev(const char *ifname, int dev);
Simon Glassfb1b7be2016-02-29 15:25:41 -0700105
Simon Glass4101f682016-02-29 15:25:34 -0700106struct blk_desc *mg_disk_get_dev(int dev);
Grant Likely735dd972007-02-20 09:04:34 +0100107
wdenk012771d2002-03-08 21:31:05 +0000108/* disk/part.c */
Simon Glass05289792020-05-10 11:39:57 -0600109int part_get_info(struct blk_desc *dev_desc, int part,
110 struct disk_partition *info);
Rob Clark4bbcc962017-09-09 13:15:55 -0400111/**
112 * part_get_info_whole_disk() - get partition info for the special case of
113 * a partition occupying the entire disk.
114 */
Simon Glass05289792020-05-10 11:39:57 -0600115int part_get_info_whole_disk(struct blk_desc *dev_desc,
116 struct disk_partition *info);
Rob Clark4bbcc962017-09-09 13:15:55 -0400117
Simon Glass3e8bd462016-02-29 15:25:48 -0700118void part_print(struct blk_desc *dev_desc);
119void part_init(struct blk_desc *dev_desc);
Simon Glass4101f682016-02-29 15:25:34 -0700120void dev_print(struct blk_desc *dev_desc);
Simon Glassebac37c2016-02-29 15:25:43 -0700121
122/**
123 * blk_get_device_by_str() - Get a block device given its interface/hw partition
124 *
125 * Each interface allocates its own devices and typically struct blk_desc is
126 * contained with the interface's data structure. There is no global
127 * numbering for block devices, so the interface name must be provided.
128 *
129 * The hardware parition is not related to the normal software partitioning
130 * of a device - each hardware partition is effectively a separately
131 * accessible block device. When a hardware parition is selected on MMC the
132 * other hardware partitions become inaccessible. The same block device is
133 * used to access all hardware partitions, but its capacity may change when a
134 * different hardware partition is selected.
135 *
136 * When a hardware partition number is given, the block device switches to
137 * that hardware partition.
138 *
139 * @ifname: Interface name (e.g. "ide", "scsi")
140 * @dev_str: Device and optional hw partition. This can either be a string
141 * containing the device number (e.g. "2") or the device number
142 * and hardware partition number (e.g. "2.4") for devices that
143 * support it (currently only MMC).
144 * @dev_desc: Returns a pointer to the block device on success
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100145 * Return: block device number (local to the interface), or -1 on error
Simon Glassebac37c2016-02-29 15:25:43 -0700146 */
147int blk_get_device_by_str(const char *ifname, const char *dev_str,
148 struct blk_desc **dev_desc);
Simon Glasse35929e2016-02-29 15:25:44 -0700149
150/**
151 * blk_get_device_part_str() - Get a block device and partition
152 *
153 * This calls blk_get_device_by_str() to look up a device. It also looks up
154 * a partition and returns information about it.
155 *
156 * @dev_part_str is in the format:
157 * <dev>.<hw_part>:<part> where <dev> is the device number,
158 * <hw_part> is the optional hardware partition number and
159 * <part> is the partition number
160 *
161 * If ifname is "hostfs" then this function returns the sandbox host block
162 * device.
163 *
164 * If ifname is ubi, then this function returns 0, with @info set to a
165 * special UBI device.
166 *
167 * If @dev_part_str is NULL or empty or "-", then this function looks up
168 * the "bootdevice" environment variable and uses that string instead.
169 *
170 * If the partition string is empty then the first partition is used. If the
171 * partition string is "auto" then the first bootable partition is used.
172 *
173 * @ifname: Interface name (e.g. "ide", "scsi")
174 * @dev_part_str: Device and partition string
175 * @dev_desc: Returns a pointer to the block device on success
176 * @info: Returns partition information
177 * @allow_whole_dev: true to allow the user to select partition 0
178 * (which means the whole device), false to require a valid
179 * partition number >= 1
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100180 * Return: partition number, or -1 on error
Simon Glasse35929e2016-02-29 15:25:44 -0700181 *
182 */
183int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
184 struct blk_desc **dev_desc,
Simon Glass05289792020-05-10 11:39:57 -0600185 struct disk_partition *info, int allow_whole_dev);
Petr Kulhavy87b85302016-09-09 10:27:15 +0200186
187/**
Sam Protsenko30789092017-09-22 01:51:58 +0300188 * part_get_info_by_name_type() - Search for a partition by name
189 * for only specified partition type
190 *
191 * @param dev_desc - block device descriptor
192 * @param gpt_name - the specified table entry name
193 * @param info - returns the disk partition info
194 * @param part_type - only search in partitions of this type
195 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100196 * Return: - the partition number on match (starting on 1), -1 on no match,
Sam Protsenko30789092017-09-22 01:51:58 +0300197 * otherwise error
198 */
199int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
Simon Glass05289792020-05-10 11:39:57 -0600200 struct disk_partition *info, int part_type);
Sam Protsenko30789092017-09-22 01:51:58 +0300201
202/**
Petr Kulhavy87b85302016-09-09 10:27:15 +0200203 * part_get_info_by_name() - Search for a partition by name
204 * among all available registered partitions
205 *
206 * @param dev_desc - block device descriptor
207 * @param gpt_name - the specified table entry name
208 * @param info - returns the disk partition info
209 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100210 * Return: - the partition number on match (starting on 1), -1 on no match,
Alex Deymo88b63292017-04-02 01:49:50 -0700211 * otherwise error
Petr Kulhavy87b85302016-09-09 10:27:15 +0200212 */
213int part_get_info_by_name(struct blk_desc *dev_desc,
Simon Glass05289792020-05-10 11:39:57 -0600214 const char *name, struct disk_partition *info);
Petr Kulhavy87b85302016-09-09 10:27:15 +0200215
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200216/**
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300217 * Get partition info from dev number + part name, or dev number + part number.
218 *
219 * Parse a device number and partition description (either name or number)
220 * in the form of device number plus partition name separated by a "#"
221 * (like "device_num#partition_name") or a device number plus a partition number
222 * separated by a ":". For example both "0#misc" and "0:1" can be valid
223 * partition descriptions for a given interface. If the partition is found, sets
224 * dev_desc and part_info accordingly with the information of the partition.
225 *
226 * @param[in] dev_iface Device interface
227 * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
228 * @param[out] dev_desc Place to store the device description pointer
229 * @param[out] part_info Place to store the partition information
Sean Anderson9f7bb282021-02-05 09:38:56 -0500230 * @param[in] allow_whole_dev true to allow the user to select partition 0
231 * (which means the whole device), false to require a valid
232 * partition number >= 1
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100233 * Return: the partition number on success, or negative errno on error
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300234 */
235int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
236 const char *dev_part_str,
237 struct blk_desc **dev_desc,
Sean Anderson9f7bb282021-02-05 09:38:56 -0500238 struct disk_partition *part_info,
239 int allow_whole_dev);
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300240
241/**
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200242 * part_set_generic_name() - create generic partition like hda1 or sdb2
243 *
244 * Helper function for partition tables, which don't hold partition names
245 * (DOS, ISO). Generates partition name out of the device type and partition
246 * number.
247 *
248 * @dev_desc: pointer to the block device
249 * @part_num: partition number for which the name is generated
250 * @name: buffer where the name is written
251 */
252void part_set_generic_name(const struct blk_desc *dev_desc,
253 int part_num, char *name);
254
Alexander Grafd96a9802016-03-04 01:09:56 +0100255extern const struct block_drvr block_drvr[];
Matthew McClintockdf3fc522011-05-24 05:31:19 +0000256#else
Simon Glassdb1d9e72016-02-29 15:25:42 -0700257static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
Rob Herring99d2c202012-09-21 04:08:17 +0000258{ return NULL; }
Simon Glass4101f682016-02-29 15:25:34 -0700259static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
wdenk012771d2002-03-08 21:31:05 +0000260
Simon Glass3e8bd462016-02-29 15:25:48 -0700261static inline int part_get_info(struct blk_desc *dev_desc, int part,
Simon Glass05289792020-05-10 11:39:57 -0600262 struct disk_partition *info) { return -1; }
Rob Clark4bbcc962017-09-09 13:15:55 -0400263static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
Simon Glass05289792020-05-10 11:39:57 -0600264 struct disk_partition *info)
Rob Clark4bbcc962017-09-09 13:15:55 -0400265{ return -1; }
Simon Glass3e8bd462016-02-29 15:25:48 -0700266static inline void part_print(struct blk_desc *dev_desc) {}
267static inline void part_init(struct blk_desc *dev_desc) {}
Simon Glass4101f682016-02-29 15:25:34 -0700268static inline void dev_print(struct blk_desc *dev_desc) {}
Simon Glassebac37c2016-02-29 15:25:43 -0700269static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
270 struct blk_desc **dev_desc)
Stephen Warren2023e602012-09-21 09:50:56 +0000271{ return -1; }
Simon Glasse35929e2016-02-29 15:25:44 -0700272static inline int blk_get_device_part_str(const char *ifname,
Simon Glass05289792020-05-10 11:39:57 -0600273 const char *dev_part_str,
274 struct blk_desc **dev_desc,
275 struct disk_partition *info,
276 int allow_whole_dev)
Rob Herring99d2c202012-09-21 04:08:17 +0000277{ *dev_desc = NULL; return -1; }
AKASHI Takahiro2a0d1882022-04-19 10:01:54 +0900278
279static inline int part_get_info_by_name_type(struct blk_desc *dev_desc,
280 const char *name,
281 struct disk_partition *info,
282 int part_type)
283{
284 return -ENOENT;
285}
286
287static inline int part_get_info_by_name(struct blk_desc *dev_desc,
288 const char *name,
289 struct disk_partition *info)
290{
291 return -ENOENT;
292}
293
Sean Anderson71945272021-04-12 18:53:05 -0400294static inline int
295part_get_info_by_dev_and_name_or_num(const char *dev_iface,
296 const char *dev_part_str,
297 struct blk_desc **dev_desc,
298 struct disk_partition *part_info,
299 int allow_whole_dev)
300{
301 *dev_desc = NULL;
302 return -ENOSYS;
303}
Matthew McClintockdf3fc522011-05-24 05:31:19 +0000304#endif
wdenk012771d2002-03-08 21:31:05 +0000305
Simon Glassdcffa442023-01-17 10:47:41 -0700306/**
307 * part_get_bootable() - Find the first bootable partition
308 *
309 * @desc: Block-device descriptor
310 * @return first bootable partition, or 0 if there is none
311 */
312int part_get_bootable(struct blk_desc *desc);
313
AKASHI Takahiro43855fd2022-04-19 10:05:09 +0900314struct udevice;
315/**
316 * part_create_block_devices - Create block devices for disk partitions
317 *
318 * Create UCLASS_PARTITION udevices for each of disk partitions in @parent
319 *
320 * @blk_dev: Whole disk device
321 */
322int part_create_block_devices(struct udevice *blk_dev);
323
Simon Glass76c839f2022-10-20 18:22:52 -0600324/**
325 * disk_blk_read() - read blocks from a disk partition
326 *
327 * @dev: Device to read from (UCLASS_PARTITION)
328 * @start: Start block number to read in the partition (0=first)
329 * @blkcnt: Number of blocks to read
330 * @buffer: Destination buffer for data read
331 * Returns: number of blocks read, or -ve error number (see the
332 * IS_ERR_VALUE() macro
333 */
334ulong disk_blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
335 void *buffer);
336
337/**
338 * disk_blk_write() - write to a disk partition
339 *
340 * @dev: Device to write to (UCLASS_PARTITION)
341 * @start: Start block number to write in the partition (0=first)
342 * @blkcnt: Number of blocks to write
343 * @buffer: Source buffer for data to write
344 * Returns: number of blocks written, or -ve error number (see the
345 * IS_ERR_VALUE() macro
346 */
347ulong disk_blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
348 const void *buffer);
349
350/**
351 * disk_blk_erase() - erase a section of a disk partition
352 *
353 * @dev: Device to (partially) erase (UCLASS_PARTITION)
354 * @start: Start block number to erase in the partition (0=first)
355 * @blkcnt: Number of blocks to erase
356 * Returns: number of blocks erased, or -ve error number (see the
357 * IS_ERR_VALUE() macro
358 */
359ulong disk_blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt);
AKASHI Takahiro59da9d42022-04-19 10:05:16 +0900360
Simon Glass96e5b032016-02-29 15:25:47 -0700361/*
362 * We don't support printing partition information in SPL and only support
363 * getting partition information in a few cases.
364 */
365#ifdef CONFIG_SPL_BUILD
366# define part_print_ptr(x) NULL
Tien Fong Cheef4b40922019-01-23 14:20:05 +0800367# if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
Simon Glass96e5b032016-02-29 15:25:47 -0700368 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
369# define part_get_info_ptr(x) x
370# else
371# define part_get_info_ptr(x) NULL
372# endif
373#else
374#define part_print_ptr(x) x
375#define part_get_info_ptr(x) x
wdenk012771d2002-03-08 21:31:05 +0000376#endif
377
wdenk012771d2002-03-08 21:31:05 +0000378
Simon Glass96e5b032016-02-29 15:25:47 -0700379struct part_driver {
380 const char *name;
381 int part_type;
Petr Kulhavy87b85302016-09-09 10:27:15 +0200382 const int max_entries; /* maximum number of entries to search */
wdenk012771d2002-03-08 21:31:05 +0000383
Simon Glass96e5b032016-02-29 15:25:47 -0700384 /**
385 * get_info() - Get information about a partition
386 *
387 * @dev_desc: Block device descriptor
388 * @part: Partition number (1 = first)
389 * @info: Returns partition information
390 */
391 int (*get_info)(struct blk_desc *dev_desc, int part,
Simon Glass05289792020-05-10 11:39:57 -0600392 struct disk_partition *info);
Simon Glass96e5b032016-02-29 15:25:47 -0700393
394 /**
395 * print() - Print partition information
396 *
397 * @dev_desc: Block device descriptor
398 */
399 void (*print)(struct blk_desc *dev_desc);
400
401 /**
402 * test() - Test if a device contains this partition type
403 *
404 * @dev_desc: Block device descriptor
405 * @return 0 if the block device appears to contain this partition
406 * type, -ve if not
407 */
408 int (*test)(struct blk_desc *dev_desc);
409};
410
411/* Declare a new U-Boot partition 'driver' */
412#define U_BOOT_PART_TYPE(__name) \
413 ll_entry_declare(struct part_driver, __name, part_driver)
wdenkc7de8292002-11-19 11:04:11 +0000414
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100415#include <part_efi.h>
Rob Clark0d6ab322017-09-13 18:05:24 -0400416
417#if CONFIG_IS_ENABLED(EFI_PARTITION)
richardretanubun07f3d782008-09-26 11:13:22 -0400418/* disk/part_efi.c */
Steve Rae60bf9412014-05-26 11:52:24 -0700419/**
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100420 * write_gpt_table() - Write the GUID Partition Table to disk
421 *
422 * @param dev_desc - block device descriptor
423 * @param gpt_h - pointer to GPT header representation
424 * @param gpt_e - pointer to GPT partition table entries
425 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100426 * Return: - zero on success, otherwise error
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100427 */
Simon Glass4101f682016-02-29 15:25:34 -0700428int write_gpt_table(struct blk_desc *dev_desc,
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100429 gpt_header *gpt_h, gpt_entry *gpt_e);
430
431/**
432 * gpt_fill_pte(): Fill the GPT partition table entry
433 *
Maxime Ripard47d7ee42017-08-23 16:01:32 +0200434 * @param dev_desc - block device descriptor
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100435 * @param gpt_h - GPT header representation
436 * @param gpt_e - GPT partition table entries
437 * @param partitions - list of partitions
438 * @param parts - number of partitions
439 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100440 * Return: zero on success
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100441 */
Maxime Ripard47d7ee42017-08-23 16:01:32 +0200442int gpt_fill_pte(struct blk_desc *dev_desc,
443 gpt_header *gpt_h, gpt_entry *gpt_e,
Simon Glass05289792020-05-10 11:39:57 -0600444 struct disk_partition *partitions, int parts);
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100445
446/**
447 * gpt_fill_header(): Fill the GPT header
448 *
449 * @param dev_desc - block device descriptor
450 * @param gpt_h - GPT header representation
451 * @param str_guid - disk guid string representation
452 * @param parts_count - number of partitions
453 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100454 * Return: - error on str_guid conversion error
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100455 */
Simon Glass4101f682016-02-29 15:25:34 -0700456int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100457 char *str_guid, int parts_count);
458
459/**
460 * gpt_restore(): Restore GPT partition table
461 *
462 * @param dev_desc - block device descriptor
463 * @param str_disk_guid - disk GUID
464 * @param partitions - list of partitions
465 * @param parts - number of partitions
466 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100467 * Return: zero on success
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100468 */
Simon Glass4101f682016-02-29 15:25:34 -0700469int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
Simon Glass05289792020-05-10 11:39:57 -0600470 struct disk_partition *partitions, const int parts_count);
Steve Rae0ff7e582014-12-12 15:51:54 -0800471
472/**
473 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
474 *
475 * @param dev_desc - block device descriptor
476 * @param buf - buffer which contains the MBR and Primary GPT info
477 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100478 * Return: - '0' on success, otherwise error
Steve Rae0ff7e582014-12-12 15:51:54 -0800479 */
Simon Glass4101f682016-02-29 15:25:34 -0700480int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
Steve Rae0ff7e582014-12-12 15:51:54 -0800481
482/**
483 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
484 *
485 * @param dev_desc - block device descriptor
486 * @param buf - buffer which contains the MBR and Primary GPT info
487 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100488 * Return: - '0' on success, otherwise error
Steve Rae0ff7e582014-12-12 15:51:54 -0800489 */
Simon Glass4101f682016-02-29 15:25:34 -0700490int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100491
492/**
493 * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
494 * and partition table entries (PTE)
495 *
496 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
497 *
498 * @param dev_desc - block device descriptor
499 * @param gpt_head - pointer to GPT header data read from medium
500 * @param gpt_pte - pointer to GPT partition table enties read from medium
501 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100502 * Return: - '0' on success, otherwise error
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100503 */
Simon Glass4101f682016-02-29 15:25:34 -0700504int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100505 gpt_entry **gpt_pte);
506
507/**
Philippe Reynes5c783b52022-04-22 17:46:48 +0200508 * gpt_repair_headers() - Function to repair the GPT's header
509 * and partition table entries (PTE)
510 *
511 * @param dev_desc - block device descriptor
512 *
513 * Return: - '0' on success, otherwise error
514 */
515int gpt_repair_headers(struct blk_desc *dev_desc);
516
517/**
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100518 * gpt_verify_partitions() - Function to check if partitions' name, start and
519 * size correspond to '$partitions' env variable
520 *
521 * This function checks if on medium stored GPT data is in sync with information
522 * provided in '$partitions' environment variable. Specificially, name, start
523 * and size of the partition is checked.
524 *
525 * @param dev_desc - block device descriptor
526 * @param partitions - partition data read from '$partitions' env variable
527 * @param parts - number of partitions read from '$partitions' env variable
528 * @param gpt_head - pointer to GPT header data read from medium
529 * @param gpt_pte - pointer to GPT partition table enties read from medium
530 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100531 * Return: - '0' on success, otherwise error
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100532 */
Simon Glass4101f682016-02-29 15:25:34 -0700533int gpt_verify_partitions(struct blk_desc *dev_desc,
Simon Glass05289792020-05-10 11:39:57 -0600534 struct disk_partition *partitions, int parts,
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100535 gpt_header *gpt_head, gpt_entry **gpt_pte);
Alison Chaiken73d6d182017-06-25 16:43:23 -0700536
537
538/**
539 * get_disk_guid() - Function to read the GUID string from a device's GPT
540 *
541 * This function reads the GUID string from a block device whose descriptor
542 * is provided.
543 *
544 * @param dev_desc - block device descriptor
545 * @param guid - pre-allocated string in which to return the GUID
546 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100547 * Return: - '0' on success, otherwise error
Alison Chaiken73d6d182017-06-25 16:43:23 -0700548 */
549int get_disk_guid(struct blk_desc *dev_desc, char *guid);
550
richardretanubun07f3d782008-09-26 11:13:22 -0400551#endif
552
Patrick Delaunayb0cf7332017-01-27 11:00:37 +0100553#if CONFIG_IS_ENABLED(DOS_PARTITION)
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200554/**
555 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
556 *
557 * @param buf - buffer which contains the MBR
558 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100559 * Return: - '0' on success, otherwise error
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200560 */
561int is_valid_dos_buf(void *buf);
562
563/**
Marek Szyprowski92f1c892020-12-23 13:55:10 +0100564 * write_mbr_sector() - write DOS MBR
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200565 *
566 * @param dev_desc - block device descriptor
567 * @param buf - buffer which contains the MBR
568 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100569 * Return: - '0' on success, otherwise error
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200570 */
Marek Szyprowski92f1c892020-12-23 13:55:10 +0100571int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200572
Marek Szyprowski20bd5ac2020-12-23 13:55:14 +0100573int write_mbr_partitions(struct blk_desc *dev,
574 struct disk_partition *p, int count, unsigned int disksig);
575int layout_mbr_partitions(struct disk_partition *p, int count,
576 lbaint_t total_sectors);
577
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200578#endif
579
AKASHI Takahiro37168e32022-04-19 10:01:53 +0900580#if CONFIG_IS_ENABLED(PARTITIONS)
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530581/**
582 * part_driver_get_count() - get partition driver count
583 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100584 * Return: - number of partition drivers
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530585 */
586static inline int part_driver_get_count(void)
587{
588 return ll_entry_count(struct part_driver, part_driver);
589}
590
591/**
592 * part_driver_get_first() - get first partition driver
593 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100594 * Return: - pointer to first partition driver on success, otherwise NULL
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530595 */
596static inline struct part_driver *part_driver_get_first(void)
597{
598 return ll_entry_start(struct part_driver, part_driver);
599}
600
601#else
602static inline int part_driver_get_count(void)
603{ return 0; }
604
605static inline struct part_driver *part_driver_get_first(void)
606{ return NULL; }
607#endif /* CONFIG_PARTITIONS */
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200608
wdenk012771d2002-03-08 21:31:05 +0000609#endif /* _PART_H */