blob: db34bc6bb7d9788fc35ab9424896a911d0abc640 [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
Simon Glassc5f1d002023-08-24 13:55:31 -060083/* Accessors for struct disk_partition field ->uuid */
84extern char *__invalid_use_of_disk_partition_uuid;
85
86static inline const char *disk_partition_uuid(const struct disk_partition *info)
87{
88#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
89 return info->uuid;
90#else
91 return __invalid_use_of_disk_partition_uuid;
92#endif
93}
94
95static inline void disk_partition_set_uuid(struct disk_partition *info,
96 const char *val)
97{
98#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
99 strlcpy(info->uuid, val, UUID_STR_LEN + 1);
100#endif
101}
102
103static inline void disk_partition_clr_uuid(struct disk_partition *info)
104{
105#if CONFIG_IS_ENABLED(PARTITION_UUIDS)
106 *info->uuid = '\0';
107#endif
108}
109
Simon Glassbcd64542023-08-24 13:55:32 -0600110/* Accessors for struct disk_partition field ->type_guid */
Heinrich Schuchardt782c7f12023-09-02 09:35:21 +0200111extern char *__invalid_use_of_disk_partition_type_guid;
Simon Glassbcd64542023-08-24 13:55:32 -0600112
Heinrich Schuchardt782c7f12023-09-02 09:35:21 +0200113/**
114 * disk_partition_type_guid() - get partition type GUID
115 *
116 * By using this function to get the partition type GUID we can use
117 * 'if (IS_ENABLED(CONFIG_PARTITION_TYPE_GUID))' instead of
118 * '#ifdef CONFIG_PARTITION_TYPE_GUID'.
119 *
120 * @info: partition information
121 * Return: partition type GUID
122 */
Simon Glassbcd64542023-08-24 13:55:32 -0600123static inline const
Heinrich Schuchardt782c7f12023-09-02 09:35:21 +0200124char *disk_partition_type_guid(const struct disk_partition *info)
Simon Glassbcd64542023-08-24 13:55:32 -0600125{
126#ifdef CONFIG_PARTITION_TYPE_GUID
127 return info->type_guid;
128#else
Heinrich Schuchardt782c7f12023-09-02 09:35:21 +0200129 return __invalid_use_of_disk_partition_type_guid;
Simon Glassbcd64542023-08-24 13:55:32 -0600130#endif
131}
132
Heinrich Schuchardt782c7f12023-09-02 09:35:21 +0200133/**
134 * disk_partition_set_type_guid() - set partition type GUID
135 *
136 * By using this function to set the partition type GUID we can use
137 * 'if (IS_ENABLED(CONFIG_PARTITION_TYPE_GUID))' instead of
138 * '#ifdef CONFIG_PARTITION_TYPE_GUID'.
139 *
140 * @info: partition information
141 * @val: partition type GUID as string
142 */
Simon Glassbcd64542023-08-24 13:55:32 -0600143static inline void disk_partition_set_type_guid(struct disk_partition *info,
144 const char *val)
145{
146#ifdef CONFIG_PARTITION_TYPE_GUID
147 strlcpy(info->type_guid, val, UUID_STR_LEN + 1);
148#endif
149}
150
151static inline void disk_partition_clr_type_guid(struct disk_partition *info)
152{
153#ifdef CONFIG_PARTITION_TYPE_GUID
154 *info->type_guid = '\0';
155#endif
156}
157
Simon Glassb2b7e6c2023-08-24 13:55:33 -0600158/* Accessors for struct disk_partition field ->sys_ind */
159extern int __invalid_use_of_disk_partition_sys_ind;
160
161static inline uint disk_partition_sys_ind(const struct disk_partition *info)
162{
163#ifdef CONFIG_DOS_PARTITION
164 return info->sys_ind;
165#else
166 return __invalid_use_of_disk_partition_sys_ind;
167#endif
168}
169
Alison Chaiken09a49932017-07-04 11:18:50 -0700170struct disk_part {
171 int partnum;
Simon Glass05289792020-05-10 11:39:57 -0600172 struct disk_partition gpt_part_info;
Alison Chaiken09a49932017-07-04 11:18:50 -0700173 struct list_head list;
174};
175
Grant Likely735dd972007-02-20 09:04:34 +0100176/* Misc _get_dev functions */
AKASHI Takahiro37168e32022-04-19 10:01:53 +0900177#if CONFIG_IS_ENABLED(PARTITIONS)
Simon Glassfb1b7be2016-02-29 15:25:41 -0700178/**
Simon Glassdb1d9e72016-02-29 15:25:42 -0700179 * blk_get_dev() - get a pointer to a block device given its type and number
Simon Glassfb1b7be2016-02-29 15:25:41 -0700180 *
181 * Each interface allocates its own devices and typically struct blk_desc is
182 * contained with the interface's data structure. There is no global
183 * numbering for block devices, so the interface name must be provided.
184 *
185 * @ifname: Interface name (e.g. "ide", "scsi")
186 * @dev: Device number (0 for first device on that interface, 1 for
187 * second, etc.
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200188 * Return:
189 * pointer to the block device, or NULL if not available, or an error occurred.
Simon Glassfb1b7be2016-02-29 15:25:41 -0700190 */
Simon Glassdb1d9e72016-02-29 15:25:42 -0700191struct blk_desc *blk_get_dev(const char *ifname, int dev);
Simon Glassfb1b7be2016-02-29 15:25:41 -0700192
Simon Glass4101f682016-02-29 15:25:34 -0700193struct blk_desc *mg_disk_get_dev(int dev);
Grant Likely735dd972007-02-20 09:04:34 +0100194
Joshua Watt387f8be2023-07-03 08:39:54 -0500195/**
196 * part_get_info_by_type() - Get partitions from a block device using a specific
197 * partition driver
198 *
199 * Each interface allocates its own devices and typically struct blk_desc is
200 * contained with the interface's data structure. There is no global
201 * numbering for block devices, so the interface name must be provided.
202 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600203 * @desc: Block device descriptor
Joshua Watt387f8be2023-07-03 08:39:54 -0500204 * @part: Partition number to read
205 * @part_type: Partition driver to use, or PART_TYPE_UNKNOWN to automatically
206 * choose a driver
207 * @info: Returned partition information
208 *
209 * Return: 0 on success, negative errno on failure
210 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600211int part_get_info_by_type(struct blk_desc *desc, int part, int part_type,
Joshua Watt387f8be2023-07-03 08:39:54 -0500212 struct disk_partition *info);
Simon Glass5aab05d2023-08-24 13:55:24 -0600213int part_get_info(struct blk_desc *desc, int part,
Simon Glass05289792020-05-10 11:39:57 -0600214 struct disk_partition *info);
Rob Clark4bbcc962017-09-09 13:15:55 -0400215/**
216 * part_get_info_whole_disk() - get partition info for the special case of
217 * a partition occupying the entire disk.
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200218 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600219 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200220 * @info: returned partition information
221 * Return: 0 on success
Rob Clark4bbcc962017-09-09 13:15:55 -0400222 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600223int part_get_info_whole_disk(struct blk_desc *desc,
Simon Glass05289792020-05-10 11:39:57 -0600224 struct disk_partition *info);
Rob Clark4bbcc962017-09-09 13:15:55 -0400225
Simon Glass5aab05d2023-08-24 13:55:24 -0600226void part_print(struct blk_desc *desc);
227void part_init(struct blk_desc *desc);
228void dev_print(struct blk_desc *desc);
Simon Glassebac37c2016-02-29 15:25:43 -0700229
230/**
231 * blk_get_device_by_str() - Get a block device given its interface/hw partition
232 *
233 * Each interface allocates its own devices and typically struct blk_desc is
234 * contained with the interface's data structure. There is no global
235 * numbering for block devices, so the interface name must be provided.
236 *
237 * The hardware parition is not related to the normal software partitioning
238 * of a device - each hardware partition is effectively a separately
239 * accessible block device. When a hardware parition is selected on MMC the
240 * other hardware partitions become inaccessible. The same block device is
241 * used to access all hardware partitions, but its capacity may change when a
242 * different hardware partition is selected.
243 *
244 * When a hardware partition number is given, the block device switches to
245 * that hardware partition.
246 *
247 * @ifname: Interface name (e.g. "ide", "scsi")
248 * @dev_str: Device and optional hw partition. This can either be a string
249 * containing the device number (e.g. "2") or the device number
250 * and hardware partition number (e.g. "2.4") for devices that
251 * support it (currently only MMC).
Simon Glass5aab05d2023-08-24 13:55:24 -0600252 * @desc: Returns a pointer to the block device on success
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100253 * Return: block device number (local to the interface), or -1 on error
Simon Glassebac37c2016-02-29 15:25:43 -0700254 */
255int blk_get_device_by_str(const char *ifname, const char *dev_str,
Simon Glass5aab05d2023-08-24 13:55:24 -0600256 struct blk_desc **desc);
Simon Glasse35929e2016-02-29 15:25:44 -0700257
258/**
259 * blk_get_device_part_str() - Get a block device and partition
260 *
261 * This calls blk_get_device_by_str() to look up a device. It also looks up
262 * a partition and returns information about it.
263 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200264 * @dev_part_str is in the format <dev>.<hw_part>:<part> where
Simon Glasse35929e2016-02-29 15:25:44 -0700265 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200266 * * <dev> is the device number,
267 *
268 * * <hw_part> is the optional hardware partition number and
269 *
270 * * <part> is the partition number.
271 *
272 * If @ifname is "hostfs", then this function returns the sandbox host block
Simon Glasse35929e2016-02-29 15:25:44 -0700273 * device.
274 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200275 * If @ifname is "ubi", then this function returns 0, with @info set to a
Simon Glasse35929e2016-02-29 15:25:44 -0700276 * special UBI device.
277 *
278 * If @dev_part_str is NULL or empty or "-", then this function looks up
279 * the "bootdevice" environment variable and uses that string instead.
280 *
281 * If the partition string is empty then the first partition is used. If the
282 * partition string is "auto" then the first bootable partition is used.
283 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200284 * @ifname: Interface name (e.g. "ide", "scsi")
Simon Glasse35929e2016-02-29 15:25:44 -0700285 * @dev_part_str: Device and partition string
Simon Glass5aab05d2023-08-24 13:55:24 -0600286 * @desc: Returns a pointer to the block device on success
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200287 * @info: Returns partition information
Simon Glasse35929e2016-02-29 15:25:44 -0700288 * @allow_whole_dev: true to allow the user to select partition 0
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200289 * (which means the whole device), false to require a valid
290 * partition number >= 1
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100291 * Return: partition number, or -1 on error
Simon Glasse35929e2016-02-29 15:25:44 -0700292 *
293 */
294int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
Simon Glass5aab05d2023-08-24 13:55:24 -0600295 struct blk_desc **desc,
Simon Glass05289792020-05-10 11:39:57 -0600296 struct disk_partition *info, int allow_whole_dev);
Petr Kulhavy87b85302016-09-09 10:27:15 +0200297
298/**
299 * part_get_info_by_name() - Search for a partition by name
300 * among all available registered partitions
301 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600302 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200303 * @name: the specified table entry name
304 * @info: returns the disk partition info
Petr Kulhavy87b85302016-09-09 10:27:15 +0200305 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200306 * Return: the partition number on match (starting on 1), -1 on no match,
Alex Deymo88b63292017-04-02 01:49:50 -0700307 * otherwise error
Petr Kulhavy87b85302016-09-09 10:27:15 +0200308 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600309int part_get_info_by_name(struct blk_desc *desc, const char *name,
310 struct disk_partition *info);
Petr Kulhavy87b85302016-09-09 10:27:15 +0200311
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200312/**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200313 * part_get_info_by_dev_and_name_or_num() - Get partition info from dev number
314 * and part name, or dev number and
315 * part number.
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300316 *
317 * Parse a device number and partition description (either name or number)
318 * in the form of device number plus partition name separated by a "#"
319 * (like "device_num#partition_name") or a device number plus a partition number
320 * separated by a ":". For example both "0#misc" and "0:1" can be valid
321 * partition descriptions for a given interface. If the partition is found, sets
Simon Glass5aab05d2023-08-24 13:55:24 -0600322 * desc and part_info accordingly with the information of the partition.
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300323 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200324 * @dev_iface: Device interface
325 * @dev_part_str: Input partition description, like "0#misc" or "0:1"
Simon Glass5aab05d2023-08-24 13:55:24 -0600326 * @desc: Place to store the device description pointer
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200327 * @part_info: Place to store the partition information
328 * @allow_whole_dev: true to allow the user to select partition 0
329 * (which means the whole device), false to require a valid
330 * partition number >= 1
331 * Return: the partition number on success, or negative errno on error
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300332 */
333int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
334 const char *dev_part_str,
Simon Glass5aab05d2023-08-24 13:55:24 -0600335 struct blk_desc **desc,
Sean Anderson9f7bb282021-02-05 09:38:56 -0500336 struct disk_partition *part_info,
337 int allow_whole_dev);
Ruslan Trofymenko6eccd1f2019-07-05 15:37:31 +0300338
339/**
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200340 * part_set_generic_name() - create generic partition like hda1 or sdb2
341 *
342 * Helper function for partition tables, which don't hold partition names
343 * (DOS, ISO). Generates partition name out of the device type and partition
344 * number.
345 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600346 * @desc: pointer to the block device
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200347 * @part_num: partition number for which the name is generated
348 * @name: buffer where the name is written
349 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600350void part_set_generic_name(const struct blk_desc *desc, int part_num,
351 char *name);
Petr Kulhavyda2ee242016-09-09 10:27:17 +0200352
Alexander Grafd96a9802016-03-04 01:09:56 +0100353extern const struct block_drvr block_drvr[];
Matthew McClintockdf3fc522011-05-24 05:31:19 +0000354#else
Simon Glassdb1d9e72016-02-29 15:25:42 -0700355static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
Rob Herring99d2c202012-09-21 04:08:17 +0000356{ return NULL; }
Simon Glass4101f682016-02-29 15:25:34 -0700357static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
wdenk012771d2002-03-08 21:31:05 +0000358
Simon Glass5aab05d2023-08-24 13:55:24 -0600359static inline int part_get_info(struct blk_desc *desc, int part,
Simon Glass05289792020-05-10 11:39:57 -0600360 struct disk_partition *info) { return -1; }
Simon Glass5aab05d2023-08-24 13:55:24 -0600361static inline int part_get_info_whole_disk(struct blk_desc *desc,
Simon Glass05289792020-05-10 11:39:57 -0600362 struct disk_partition *info)
Rob Clark4bbcc962017-09-09 13:15:55 -0400363{ return -1; }
Simon Glass5aab05d2023-08-24 13:55:24 -0600364static inline void part_print(struct blk_desc *desc) {}
365static inline void part_init(struct blk_desc *desc) {}
366static inline void dev_print(struct blk_desc *desc) {}
Simon Glassebac37c2016-02-29 15:25:43 -0700367static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
Simon Glass5aab05d2023-08-24 13:55:24 -0600368 struct blk_desc **desc)
Stephen Warren2023e602012-09-21 09:50:56 +0000369{ return -1; }
Simon Glasse35929e2016-02-29 15:25:44 -0700370static inline int blk_get_device_part_str(const char *ifname,
Simon Glass05289792020-05-10 11:39:57 -0600371 const char *dev_part_str,
Simon Glass5aab05d2023-08-24 13:55:24 -0600372 struct blk_desc **desc,
Simon Glass05289792020-05-10 11:39:57 -0600373 struct disk_partition *info,
374 int allow_whole_dev)
Simon Glass5aab05d2023-08-24 13:55:24 -0600375{ *desc = NULL; return -1; }
AKASHI Takahiro2a0d1882022-04-19 10:01:54 +0900376
Simon Glass5aab05d2023-08-24 13:55:24 -0600377static inline int part_get_info_by_name(struct blk_desc *desc, const char *name,
AKASHI Takahiro2a0d1882022-04-19 10:01:54 +0900378 struct disk_partition *info)
379{
380 return -ENOENT;
381}
382
Sean Anderson71945272021-04-12 18:53:05 -0400383static inline int
384part_get_info_by_dev_and_name_or_num(const char *dev_iface,
385 const char *dev_part_str,
Simon Glass5aab05d2023-08-24 13:55:24 -0600386 struct blk_desc **desc,
Sean Anderson71945272021-04-12 18:53:05 -0400387 struct disk_partition *part_info,
388 int allow_whole_dev)
389{
Simon Glass5aab05d2023-08-24 13:55:24 -0600390 *desc = NULL;
Sean Anderson71945272021-04-12 18:53:05 -0400391 return -ENOSYS;
392}
Matthew McClintockdf3fc522011-05-24 05:31:19 +0000393#endif
wdenk012771d2002-03-08 21:31:05 +0000394
AKASHI Takahiro43855fd2022-04-19 10:05:09 +0900395struct udevice;
396/**
Simon Glass76c839f2022-10-20 18:22:52 -0600397 * disk_blk_read() - read blocks from a disk partition
398 *
399 * @dev: Device to read from (UCLASS_PARTITION)
400 * @start: Start block number to read in the partition (0=first)
401 * @blkcnt: Number of blocks to read
402 * @buffer: Destination buffer for data read
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200403 * Return: number of blocks read, or -ve error number (see the
Simon Glass76c839f2022-10-20 18:22:52 -0600404 * IS_ERR_VALUE() macro
405 */
406ulong disk_blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
407 void *buffer);
408
409/**
410 * disk_blk_write() - write to a disk partition
411 *
412 * @dev: Device to write to (UCLASS_PARTITION)
413 * @start: Start block number to write in the partition (0=first)
414 * @blkcnt: Number of blocks to write
415 * @buffer: Source buffer for data to write
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200416 * Return: number of blocks written, or -ve error number (see the
Simon Glass76c839f2022-10-20 18:22:52 -0600417 * IS_ERR_VALUE() macro
418 */
419ulong disk_blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
420 const void *buffer);
421
422/**
423 * disk_blk_erase() - erase a section of a disk partition
424 *
425 * @dev: Device to (partially) erase (UCLASS_PARTITION)
426 * @start: Start block number to erase in the partition (0=first)
427 * @blkcnt: Number of blocks to erase
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200428 * Return: number of blocks erased, or -ve error number (see the
Simon Glass76c839f2022-10-20 18:22:52 -0600429 * IS_ERR_VALUE() macro
430 */
431ulong disk_blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt);
AKASHI Takahiro59da9d42022-04-19 10:05:16 +0900432
Simon Glass96e5b032016-02-29 15:25:47 -0700433/*
434 * We don't support printing partition information in SPL and only support
435 * getting partition information in a few cases.
436 */
437#ifdef CONFIG_SPL_BUILD
438# define part_print_ptr(x) NULL
Tien Fong Cheef4b40922019-01-23 14:20:05 +0800439# if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
Simon Glass96e5b032016-02-29 15:25:47 -0700440 defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
441# define part_get_info_ptr(x) x
442# else
443# define part_get_info_ptr(x) NULL
444# endif
445#else
446#define part_print_ptr(x) x
447#define part_get_info_ptr(x) x
wdenk012771d2002-03-08 21:31:05 +0000448#endif
449
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200450/**
451 * struct part_driver - partition driver
452 */
Simon Glass96e5b032016-02-29 15:25:47 -0700453struct part_driver {
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200454 /** @name: partition name */
Simon Glass96e5b032016-02-29 15:25:47 -0700455 const char *name;
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200456 /** @part_type: (MBR) partition type */
Simon Glass96e5b032016-02-29 15:25:47 -0700457 int part_type;
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200458 /** @max_entries: maximum number of partition table entries */
459 const int max_entries;
Simon Glass96e5b032016-02-29 15:25:47 -0700460 /**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200461 * @get_info: Get information about a partition
Simon Glass96e5b032016-02-29 15:25:47 -0700462 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600463 * @get_info.desc: Block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200464 * @get_info.part: Partition number (1 = first)
465 * @get_info.info: Returns partition information
Simon Glass96e5b032016-02-29 15:25:47 -0700466 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600467 int (*get_info)(struct blk_desc *desc, int part,
Simon Glass05289792020-05-10 11:39:57 -0600468 struct disk_partition *info);
Simon Glass96e5b032016-02-29 15:25:47 -0700469
470 /**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200471 * @print: Print partition information
Simon Glass96e5b032016-02-29 15:25:47 -0700472 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600473 * @print.desc: Block device descriptor
Simon Glass96e5b032016-02-29 15:25:47 -0700474 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600475 void (*print)(struct blk_desc *desc);
Simon Glass96e5b032016-02-29 15:25:47 -0700476
477 /**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200478 * @test: Test if a device contains this partition type
Simon Glass96e5b032016-02-29 15:25:47 -0700479 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600480 * @test.desc: Block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200481 * @test.Return:
482 * 0 if the block device appears to contain this partition type,
483 * -ve if not
Simon Glass96e5b032016-02-29 15:25:47 -0700484 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600485 int (*test)(struct blk_desc *desc);
Simon Glass96e5b032016-02-29 15:25:47 -0700486};
487
488/* Declare a new U-Boot partition 'driver' */
489#define U_BOOT_PART_TYPE(__name) \
490 ll_entry_declare(struct part_driver, __name, part_driver)
wdenkc7de8292002-11-19 11:04:11 +0000491
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100492#include <part_efi.h>
Rob Clark0d6ab322017-09-13 18:05:24 -0400493
494#if CONFIG_IS_ENABLED(EFI_PARTITION)
richardretanubun07f3d782008-09-26 11:13:22 -0400495/* disk/part_efi.c */
Steve Rae60bf9412014-05-26 11:52:24 -0700496/**
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100497 * write_gpt_table() - Write the GUID Partition Table to disk
498 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600499 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200500 * @gpt_h: pointer to GPT header representation
501 * @gpt_e: pointer to GPT partition table entries
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100502 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200503 * Return: zero on success, otherwise error
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100504 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600505int write_gpt_table(struct blk_desc *desc, gpt_header *gpt_h, gpt_entry *gpt_e);
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100506
507/**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200508 * gpt_fill_pte() - Fill the GPT partition table entry
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100509 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600510 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200511 * @gpt_h: GPT header representation
512 * @gpt_e: GPT partition table entries
513 * @partitions: list of partitions
514 * @parts: number of partitions
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100515 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200516 * Return: zero on success
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100517 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600518int gpt_fill_pte(struct blk_desc *desc, gpt_header *gpt_h, gpt_entry *gpt_e,
Simon Glass05289792020-05-10 11:39:57 -0600519 struct disk_partition *partitions, int parts);
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100520
521/**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200522 * gpt_fill_header() - Fill the GPT header
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100523 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600524 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200525 * @gpt_h: GPT header representation
526 * @str_guid: disk guid string representation
527 * @parts_count: number of partitions
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100528 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200529 * Return: error on str_guid conversion error
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100530 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600531int gpt_fill_header(struct blk_desc *desc, gpt_header *gpt_h, char *str_guid,
532 int parts_count);
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100533
534/**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200535 * gpt_restore() - Restore GPT partition table
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100536 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600537 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200538 * @str_disk_guid: disk GUID
539 * @partitions: list of partitions
540 * @parts_count: number of partitions
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100541 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200542 * Return: 0 on success
Lukasz Majewski40684dd2012-12-11 11:09:46 +0100543 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600544int gpt_restore(struct blk_desc *desc, char *str_disk_guid,
Simon Glass05289792020-05-10 11:39:57 -0600545 struct disk_partition *partitions, const int parts_count);
Steve Rae0ff7e582014-12-12 15:51:54 -0800546
547/**
548 * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
549 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600550 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200551 * @buf: buffer which contains the MBR and Primary GPT info
Steve Rae0ff7e582014-12-12 15:51:54 -0800552 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200553 * Return: 0 on success, otherwise error
Steve Rae0ff7e582014-12-12 15:51:54 -0800554 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600555int is_valid_gpt_buf(struct blk_desc *desc, void *buf);
Steve Rae0ff7e582014-12-12 15:51:54 -0800556
557/**
558 * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
559 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600560 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200561 * @buf: buffer which contains the MBR and Primary GPT info
Steve Rae0ff7e582014-12-12 15:51:54 -0800562 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200563 * Return: 0 on success, otherwise error
Steve Rae0ff7e582014-12-12 15:51:54 -0800564 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600565int write_mbr_and_gpt_partitions(struct blk_desc *desc, void *buf);
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100566
567/**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200568 * gpt_verify_headers() - Read and check CRC32 of the GPT's header
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100569 * and partition table entries (PTE)
570 *
571 * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
572 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600573 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200574 * @gpt_head: pointer to GPT header data read from medium
575 * @gpt_pte: pointer to GPT partition table enties read from medium
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100576 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200577 * Return: 0 on success, otherwise error
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100578 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600579int gpt_verify_headers(struct blk_desc *desc, gpt_header *gpt_head,
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100580 gpt_entry **gpt_pte);
581
582/**
Philippe Reynes5c783b52022-04-22 17:46:48 +0200583 * gpt_repair_headers() - Function to repair the GPT's header
584 * and partition table entries (PTE)
585 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600586 * @desc: block device descriptor
Philippe Reynes5c783b52022-04-22 17:46:48 +0200587 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200588 * Return: 0 on success, otherwise error
Philippe Reynes5c783b52022-04-22 17:46:48 +0200589 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600590int gpt_repair_headers(struct blk_desc *desc);
Philippe Reynes5c783b52022-04-22 17:46:48 +0200591
592/**
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100593 * gpt_verify_partitions() - Function to check if partitions' name, start and
594 * size correspond to '$partitions' env variable
595 *
596 * This function checks if on medium stored GPT data is in sync with information
597 * provided in '$partitions' environment variable. Specificially, name, start
598 * and size of the partition is checked.
599 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600600 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200601 * @partitions: partition data read from '$partitions' env variable
602 * @parts: number of partitions read from '$partitions' env variable
603 * @gpt_head: pointer to GPT header data read from medium
604 * @gpt_pte: pointer to GPT partition table enties read from medium
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100605 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200606 * Return: 0 on success, otherwise error
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100607 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600608int gpt_verify_partitions(struct blk_desc *desc,
Simon Glass05289792020-05-10 11:39:57 -0600609 struct disk_partition *partitions, int parts,
Lukasz Majewskicef68bf2015-11-20 08:06:16 +0100610 gpt_header *gpt_head, gpt_entry **gpt_pte);
Alison Chaiken73d6d182017-06-25 16:43:23 -0700611
612
613/**
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200614 * get_disk_guid() - Read the GUID string from a device's GPT
Alison Chaiken73d6d182017-06-25 16:43:23 -0700615 *
616 * This function reads the GUID string from a block device whose descriptor
617 * is provided.
618 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600619 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200620 * @guid: pre-allocated string in which to return the GUID
Alison Chaiken73d6d182017-06-25 16:43:23 -0700621 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200622 * Return: 0 on success, otherwise error
Alison Chaiken73d6d182017-06-25 16:43:23 -0700623 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600624int get_disk_guid(struct blk_desc *desc, char *guid);
Alison Chaiken73d6d182017-06-25 16:43:23 -0700625
richardretanubun07f3d782008-09-26 11:13:22 -0400626#endif
627
Patrick Delaunayb0cf7332017-01-27 11:00:37 +0100628#if CONFIG_IS_ENABLED(DOS_PARTITION)
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200629/**
630 * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
631 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200632 * @buf: buffer which contains the MBR
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200633 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200634 * Return: 0 on success, otherwise error
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200635 */
636int is_valid_dos_buf(void *buf);
637
638/**
Marek Szyprowski92f1c892020-12-23 13:55:10 +0100639 * write_mbr_sector() - write DOS MBR
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200640 *
Simon Glass5aab05d2023-08-24 13:55:24 -0600641 * @desc: block device descriptor
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200642 * @buf: buffer which contains the MBR
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200643 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200644 * Return: 0 on success, otherwise error
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200645 */
Simon Glass5aab05d2023-08-24 13:55:24 -0600646int write_mbr_sector(struct blk_desc *desc, void *buf);
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200647
Marek Szyprowski20bd5ac2020-12-23 13:55:14 +0100648int write_mbr_partitions(struct blk_desc *dev,
649 struct disk_partition *p, int count, unsigned int disksig);
650int layout_mbr_partitions(struct disk_partition *p, int count,
651 lbaint_t total_sectors);
652
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200653#endif
654
AKASHI Takahiro37168e32022-04-19 10:01:53 +0900655#if CONFIG_IS_ENABLED(PARTITIONS)
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530656/**
657 * part_driver_get_count() - get partition driver count
658 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200659 * Return: number of partition drivers
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530660 */
661static inline int part_driver_get_count(void)
662{
663 return ll_entry_count(struct part_driver, part_driver);
664}
665
666/**
667 * part_driver_get_first() - get first partition driver
668 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200669 * Return: pointer to first partition driver on success, otherwise NULL
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530670 */
671static inline struct part_driver *part_driver_get_first(void)
672{
673 return ll_entry_start(struct part_driver, part_driver);
674}
675
Simon Glass125194e2023-07-15 21:38:47 -0600676/**
677 * part_get_type_by_name() - Get partition type by name
678 *
Heinrich Schuchardt5aae0212023-08-15 12:30:19 +0200679 * @name: Name of partition type to look up (not case-sensitive)
680 * Return:
681 * Corresponding partition type (PART\_TYPE\_...) or PART\_TYPE\_UNKNOWN
Simon Glass125194e2023-07-15 21:38:47 -0600682 */
683int part_get_type_by_name(const char *name);
684
Simon Glassf55aa442023-08-24 13:55:42 -0600685/**
686 * part_get_bootable() - Find the first bootable partition
687 *
688 * @desc: Block-device descriptor
689 * @return first bootable partition, or 0 if there is none
690 */
691int part_get_bootable(struct blk_desc *desc);
692
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530693#else
694static inline int part_driver_get_count(void)
695{ return 0; }
696
697static inline struct part_driver *part_driver_get_first(void)
698{ return NULL; }
Simon Glassf55aa442023-08-24 13:55:42 -0600699
700static inline bool part_get_bootable(struct blk_desc *desc)
701{ return false; }
702
Corneliu Doban12fc1f32020-11-09 11:49:16 +0530703#endif /* CONFIG_PARTITIONS */
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +0200704
wdenk012771d2002-03-08 21:31:05 +0000705#endif /* _PART_H */