blob: 64d1d6c37860d7c1e939d4724a327a74f6074c85 [file] [log] [blame]
Simon Glassa16d87d2022-04-24 23:31:05 -06001/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright 2021 Google LLC
4 * Written by Simon Glass <sjg@chromium.org>
5 */
6
7#ifndef __bootflow_h
8#define __bootflow_h
9
Simon Glass660a9952023-01-17 10:48:11 -070010#include <bootdev.h>
Simon Glassd92bcc42023-01-06 08:52:42 -060011#include <dm/ofnode_decl.h>
Simon Glassa16d87d2022-04-24 23:31:05 -060012#include <linux/list.h>
13
Simon Glass0a2f6a32023-01-06 08:52:40 -060014struct bootstd_priv;
15struct expo;
16
Simon Glasscb2a5cd2023-01-17 10:48:17 -070017enum {
18 BOOTFLOW_MAX_USED_DEVS = 16,
19};
20
Simon Glassa16d87d2022-04-24 23:31:05 -060021/**
22 * enum bootflow_state_t - states that a particular bootflow can be in
23 *
24 * Only bootflows in state BOOTFLOWST_READY can be used to boot.
25 *
26 * See bootflow_state[] for the names for each of these
27 */
28enum bootflow_state_t {
29 BOOTFLOWST_BASE, /**< Nothing known yet */
30 BOOTFLOWST_MEDIA, /**< Media exists */
31 BOOTFLOWST_PART, /**< Partition exists */
32 BOOTFLOWST_FS, /**< Filesystem exists */
33 BOOTFLOWST_FILE, /**< Bootflow file exists */
34 BOOTFLOWST_READY, /**< Bootflow file loaded */
35
36 BOOTFLOWST_COUNT
37};
38
39/**
Simon Glassca84dc82023-02-22 12:17:04 -070040 * enum bootflow_flags_t - flags for bootflows
41 *
42 * @BOOTFLOWF_USE_PRIOR_FDT: Indicates that an FDT was not found by the bootmeth
43 * and it is using the prior-stage FDT, which is the U-Boot control FDT.
44 * This is only possible with the EFI bootmeth (distro-efi) and only when
45 * CONFIG_OF_HAS_PRIOR_STAGE is enabled
Simon Glass254c9342023-11-15 18:35:23 -070046 * @BOOTFLOWF_STATIC_BUF: Indicates that @bflow->buf is statically set, rather
47 * than being allocated by malloc().
Shantur Rathoreaab9cdb2023-11-19 16:55:00 +000048 * @BOOTFLOWF_USE_BUILTIN_FDT : Indicates that current bootflow uses built-in FDT
Simon Glassca84dc82023-02-22 12:17:04 -070049 */
50enum bootflow_flags_t {
51 BOOTFLOWF_USE_PRIOR_FDT = 1 << 0,
Simon Glass254c9342023-11-15 18:35:23 -070052 BOOTFLOWF_STATIC_BUF = 1 << 1,
Shantur Rathoreaab9cdb2023-11-19 16:55:00 +000053 BOOTFLOWF_USE_BUILTIN_FDT = 1 << 2,
Simon Glassca84dc82023-02-22 12:17:04 -070054};
55
56/**
Simon Glassa16d87d2022-04-24 23:31:05 -060057 * struct bootflow - information about a bootflow
58 *
Simon Glass1d8f8642024-11-15 16:19:11 -070059 * This is connected into a linked list:
Simon Glassa16d87d2022-04-24 23:31:05 -060060 *
Simon Glassa16d87d2022-04-24 23:31:05 -060061 * glob_sibling - links all bootflows in all bootdevs
62 *
Simon Glassa16d87d2022-04-24 23:31:05 -060063 * @glob_node: Points to siblings in the global list (all bootdev)
Quentin Schulz21a6aec2024-06-12 16:58:49 +020064 * @dev: Bootdev device which produced this bootflow, NULL for flows created by
65 * BOOTMETHF_GLOBAL bootmeths
Simon Glassa16d87d2022-04-24 23:31:05 -060066 * @blk: Block device which contains this bootflow, NULL if this is a network
Simon Glass4adeeb82023-01-17 10:47:59 -070067 * device or sandbox 'host' device
Simon Glassa16d87d2022-04-24 23:31:05 -060068 * @part: Partition number (0 for whole device)
69 * @fs_type: Filesystem type (FS_TYPE...) if this is fixed by the media, else 0.
70 * For example, the sandbox host-filesystem bootdev sets this to
71 * FS_TYPE_SANDBOX
72 * @method: Bootmethod device used to perform the boot and read files
73 * @name: Name of bootflow (allocated)
74 * @state: Current state (enum bootflow_state_t)
75 * @subdir: Subdirectory to fetch files from (with trailing /), or NULL if none
76 * @fname: Filename of bootflow file (allocated)
Simon Glass612b9cc2023-01-06 08:52:34 -060077 * @logo: Logo to display for this bootflow (BMP format)
78 * @logo_size: Size of the logo in bytes
Simon Glass254c9342023-11-15 18:35:23 -070079 * @buf: Bootflow file contents (allocated unless @flags & BOOTFLOWF_STATIC_BUF)
Simon Glassa16d87d2022-04-24 23:31:05 -060080 * @size: Size of bootflow file in bytes
81 * @err: Error number received (0 if OK)
Simon Glass72b7b192023-01-06 08:52:33 -060082 * @os_name: Name of the OS / distro being booted, or NULL if not known
83 * (allocated)
Simon Glass7b8c6342023-01-17 10:47:56 -070084 * @fdt_fname: Filename of FDT file
85 * @fdt_size: Size of FDT file
86 * @fdt_addr: Address of loaded fdt
Simon Glassca84dc82023-02-22 12:17:04 -070087 * @flags: Flags for the bootflow (see enum bootflow_flags_t)
Simon Glass33927522023-07-12 09:04:34 -060088 * @cmdline: OS command line, or NULL if not known (allocated)
Simon Glass63398b02023-07-12 09:04:36 -060089 * @x86_setup: Pointer to x86 setup block inside @buf, NULL if not present
Simon Glass7f75f232023-07-30 11:16:56 -060090 * @bootmeth_priv: Private data for the bootmeth
Simon Glassa16d87d2022-04-24 23:31:05 -060091 */
92struct bootflow {
Simon Glassa16d87d2022-04-24 23:31:05 -060093 struct list_head glob_node;
94 struct udevice *dev;
95 struct udevice *blk;
96 int part;
97 int fs_type;
98 struct udevice *method;
99 char *name;
100 enum bootflow_state_t state;
101 char *subdir;
102 char *fname;
Simon Glass612b9cc2023-01-06 08:52:34 -0600103 void *logo;
104 uint logo_size;
Simon Glassa16d87d2022-04-24 23:31:05 -0600105 char *buf;
106 int size;
107 int err;
Simon Glass72b7b192023-01-06 08:52:33 -0600108 char *os_name;
Simon Glass7b8c6342023-01-17 10:47:56 -0700109 char *fdt_fname;
110 int fdt_size;
111 ulong fdt_addr;
Simon Glassca84dc82023-02-22 12:17:04 -0700112 int flags;
Simon Glass33927522023-07-12 09:04:34 -0600113 char *cmdline;
Simon Glass5495aaf2023-07-30 11:17:00 -0600114 void *x86_setup;
Simon Glass7f75f232023-07-30 11:16:56 -0600115 void *bootmeth_priv;
Simon Glassa16d87d2022-04-24 23:31:05 -0600116};
117
118/**
Simon Glass99e68182023-02-22 12:17:03 -0700119 * enum bootflow_iter_flags_t - flags for the bootflow iterator
Simon Glassa16d87d2022-04-24 23:31:05 -0600120 *
Simon Glass99e68182023-02-22 12:17:03 -0700121 * @BOOTFLOWIF_FIXED: Only used fixed/internal media
122 * @BOOTFLOWIF_SHOW: Show each bootdev before scanning it; show each hunter
Simon Glassa21e7752023-01-17 10:48:06 -0700123 * before using it
Simon Glass99e68182023-02-22 12:17:03 -0700124 * @BOOTFLOWIF_ALL: Return bootflows with errors as well
125 * @BOOTFLOWIF_HUNT: Hunt for new bootdevs using the bootdrv hunters
Simon Glassa21e7752023-01-17 10:48:06 -0700126 *
127 * Internal flags:
Simon Glass99e68182023-02-22 12:17:03 -0700128 * @BOOTFLOWIF_SINGLE_DEV: (internal) Just scan one bootdev
129 * @BOOTFLOWIF_SKIP_GLOBAL: (internal) Don't scan global bootmeths
130 * @BOOTFLOWIF_SINGLE_UCLASS: (internal) Keep scanning through all devices in
Simon Glassde567b12023-01-17 10:48:09 -0700131 * this uclass (used with things like "mmc")
Simon Glass99e68182023-02-22 12:17:03 -0700132 * @BOOTFLOWIF_SINGLE_MEDIA: (internal) Scan one media device in the uclass (used
Simon Glassde567b12023-01-17 10:48:09 -0700133 * with things like "mmc1")
Nam Caocb0d3fb2024-02-21 13:41:44 +0100134 * @BOOTFLOWIF_SINGLE_PARTITION: (internal) Scan one partition in media device
135 * (used with things like "mmc1:3")
Simon Glassa16d87d2022-04-24 23:31:05 -0600136 */
Simon Glass99e68182023-02-22 12:17:03 -0700137enum bootflow_iter_flags_t {
138 BOOTFLOWIF_FIXED = 1 << 0,
139 BOOTFLOWIF_SHOW = 1 << 1,
140 BOOTFLOWIF_ALL = 1 << 2,
141 BOOTFLOWIF_HUNT = 1 << 3,
Simon Glassa21e7752023-01-17 10:48:06 -0700142
143 /*
144 * flags used internally by standard boot - do not set these when
145 * calling bootflow_scan_bootdev() etc.
146 */
Simon Glass99e68182023-02-22 12:17:03 -0700147 BOOTFLOWIF_SINGLE_DEV = 1 << 16,
148 BOOTFLOWIF_SKIP_GLOBAL = 1 << 17,
149 BOOTFLOWIF_SINGLE_UCLASS = 1 << 18,
150 BOOTFLOWIF_SINGLE_MEDIA = 1 << 19,
Nam Caocb0d3fb2024-02-21 13:41:44 +0100151 BOOTFLOWIF_SINGLE_PARTITION = 1 << 20,
Simon Glassa16d87d2022-04-24 23:31:05 -0600152};
153
154/**
Simon Glasse22fe922023-01-17 10:48:05 -0700155 * enum bootflow_meth_flags_t - flags controlling which bootmeths are used
156 *
157 * Used during iteration, e.g. by bootdev_find_by_label(), to determine which
158 * bootmeths are used for the current bootdev. The flags reset when the bootdev
159 * changes
160 *
161 * @BOOTFLOW_METHF_DHCP_ONLY: Only use dhcp (scripts and EFI)
162 * @BOOTFLOW_METHF_PXE_ONLY: Only use pxe (PXE boot)
Simon Glassde567b12023-01-17 10:48:09 -0700163 * @BOOTFLOW_METHF_SINGLE_DEV: Scan only a single bootdev (used for labels like
164 * "3"). This is used if a sequence number is provided instead of a label
165 * @BOOTFLOW_METHF_SINGLE_UCLASS: Scan all bootdevs in this one uclass (used
166 * with things like "mmc"). If this is not set, then the bootdev has an integer
167 * value in the label (like "mmc2")
Simon Glasse22fe922023-01-17 10:48:05 -0700168 */
169enum bootflow_meth_flags_t {
170 BOOTFLOW_METHF_DHCP_ONLY = 1 << 0,
171 BOOTFLOW_METHF_PXE_ONLY = 1 << 1,
Simon Glassde567b12023-01-17 10:48:09 -0700172 BOOTFLOW_METHF_SINGLE_DEV = 1 << 2,
173 BOOTFLOW_METHF_SINGLE_UCLASS = 1 << 3,
Simon Glasse22fe922023-01-17 10:48:05 -0700174};
175
176/**
Simon Glassa16d87d2022-04-24 23:31:05 -0600177 * struct bootflow_iter - state for iterating through bootflows
178 *
179 * This starts at with the first bootdev/partition/bootmeth and can be used to
180 * iterate through all of them.
181 *
182 * Iteration starts with the bootdev. The first partition (0, i.e. whole device)
183 * is scanned first. For partition 0, it iterates through all the available
184 * bootmeths to see which one(s) can provide a bootflow. Then it moves to
185 * parition 1 (if there is one) and the process continues. Once all partitions
186 * are examined, it moves to the next bootdev.
187 *
188 * Initially @max_part is 0, meaning that only the whole device (@part=0) can be
189 * used. During scanning, if a partition table is found, then @max_part is
190 * updated to a larger value, no less than the number of available partitions.
191 * This ensures that iteration works through all partitions on the bootdev.
192 *
Simon Glass99e68182023-02-22 12:17:03 -0700193 * @flags: Flags to use (see enum bootflow_iter_flags_t). If
194 * BOOTFLOWIF_GLOBAL_FIRST is enabled then the global bootmeths are being
195 * scanned, otherwise we have moved onto the bootdevs
Simon Glass484e4072023-01-17 10:48:14 -0700196 * @dev: Current bootdev, NULL if none. This is only ever updated in
197 * bootflow_iter_set_dev()
Simon Glassa16d87d2022-04-24 23:31:05 -0600198 * @part: Current partition number (0 for whole device)
199 * @method: Current bootmeth
200 * @max_part: Maximum hardware partition number in @dev, 0 if there is no
201 * partition table
Simon Glass64cbc5c2023-01-17 10:47:42 -0700202 * @first_bootable: First bootable partition, or 0 if none
Simon Glassa16d87d2022-04-24 23:31:05 -0600203 * @err: Error obtained from checking the last iteration. This is used to skip
204 * forward (e.g. to skip the current partition because it is not valid)
205 * -ESHUTDOWN: try next bootdev
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700206 * @num_devs: Number of bootdevs in @dev_used
207 * @max_devs: Maximum number of entries in @dev_used
208 * @dev_used: List of bootdevs used during iteration
Simon Glassac06b26a2023-01-17 10:48:10 -0700209 * @labels: List of labels to scan for bootdevs
210 * @cur_label: Current label being processed
Simon Glassa16d87d2022-04-24 23:31:05 -0600211 * @num_methods: Number of bootmeth devices in @method_order
212 * @cur_method: Current method number, an index into @method_order
Simon Glass73fcf512022-07-30 15:52:25 -0600213 * @first_glob_method: First global method, if any, else -1
Simon Glass660a9952023-01-17 10:48:11 -0700214 * @cur_prio: Current priority being scanned
Simon Glass73fcf512022-07-30 15:52:25 -0600215 * @method_order: List of bootmeth devices to use, in order. The normal methods
216 * appear first, then the global ones, if any
217 * @doing_global: true if we are iterating through the global bootmeths (which
218 * happens before the normal ones)
Simon Glass30fbeb52023-01-17 10:47:58 -0700219 * @method_flags: flags controlling which methods should be used for this @dev
220 * (enum bootflow_meth_flags_t)
Simon Glassa16d87d2022-04-24 23:31:05 -0600221 */
222struct bootflow_iter {
223 int flags;
224 struct udevice *dev;
225 int part;
226 struct udevice *method;
227 int max_part;
Simon Glass64cbc5c2023-01-17 10:47:42 -0700228 int first_bootable;
Simon Glassa16d87d2022-04-24 23:31:05 -0600229 int err;
230 int num_devs;
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700231 int max_devs;
232 struct udevice *dev_used[BOOTFLOW_MAX_USED_DEVS];
Simon Glassac06b26a2023-01-17 10:48:10 -0700233 const char *const *labels;
234 int cur_label;
Simon Glassa16d87d2022-04-24 23:31:05 -0600235 int num_methods;
236 int cur_method;
Simon Glass73fcf512022-07-30 15:52:25 -0600237 int first_glob_method;
Simon Glass660a9952023-01-17 10:48:11 -0700238 enum bootdev_prio_t cur_prio;
Simon Glassa16d87d2022-04-24 23:31:05 -0600239 struct udevice **method_order;
Simon Glass73fcf512022-07-30 15:52:25 -0600240 bool doing_global;
Simon Glass30fbeb52023-01-17 10:47:58 -0700241 int method_flags;
Simon Glassa16d87d2022-04-24 23:31:05 -0600242};
243
244/**
Simon Glass00501fc2022-10-20 18:22:51 -0600245 * bootflow_init() - Set up a bootflow struct
246 *
247 * The bootflow is zeroed and set to state BOOTFLOWST_BASE
248 *
249 * @bflow: Struct to set up
250 * @bootdev: Bootdev to use
251 * @meth: Bootmeth to use
252 */
253void bootflow_init(struct bootflow *bflow, struct udevice *bootdev,
254 struct udevice *meth);
255
256/**
Simon Glassa16d87d2022-04-24 23:31:05 -0600257 * bootflow_iter_init() - Reset a bootflow iterator
258 *
259 * This sets everything to the starting point, ready for use.
260 *
261 * @iter: Place to store private info (inited by this call)
Simon Glass99e68182023-02-22 12:17:03 -0700262 * @flags: Flags to use (see enum bootflow_iter_flags_t)
Simon Glassa16d87d2022-04-24 23:31:05 -0600263 */
264void bootflow_iter_init(struct bootflow_iter *iter, int flags);
265
266/**
267 * bootflow_iter_uninit() - Free memory used by an interator
268 *
269 * @iter: Iterator to free
270 */
271void bootflow_iter_uninit(struct bootflow_iter *iter);
272
273/**
Simon Glass03fcbf92022-04-24 23:31:09 -0600274 * bootflow_iter_drop_bootmeth() - Remove a bootmeth from an iterator
275 *
276 * Update the iterator so that the bootmeth will not be used again while this
277 * iterator is in use
278 *
279 * @iter: Iterator to update
280 * @bmeth: Boot method to remove
281 */
282int bootflow_iter_drop_bootmeth(struct bootflow_iter *iter,
283 const struct udevice *bmeth);
284
285/**
Simon Glass5d3d44f2023-01-17 10:48:16 -0700286 * bootflow_scan_first() - find the first bootflow for a device or label
Simon Glassa16d87d2022-04-24 23:31:05 -0600287 *
Simon Glass99e68182023-02-22 12:17:03 -0700288 * If @flags includes BOOTFLOWIF_ALL then bootflows with errors are returned too
Simon Glassa16d87d2022-04-24 23:31:05 -0600289 *
290 * @dev: Boot device to scan, NULL to work through all of them until it
Simon Glass943d38c2022-07-30 15:52:24 -0600291 * finds one that can supply a bootflow
Simon Glassba3d5372023-01-17 10:48:15 -0700292 * @label: Label to control the scan, NULL to work through all devices
293 * until it finds one that can supply a bootflow
Simon Glassa16d87d2022-04-24 23:31:05 -0600294 * @iter: Place to store private info (inited by this call)
Simon Glass99e68182023-02-22 12:17:03 -0700295 * @flags: Flags for iterator (enum bootflow_iter_flags_t). Note that if
296 * @dev is NULL, then BOOTFLOWIF_SKIP_GLOBAL is set automatically by this
297 * function
Simon Glassa16d87d2022-04-24 23:31:05 -0600298 * @bflow: Place to put the bootflow if found
299 * Return: 0 if found, -ENODEV if no device, other -ve on other error
300 * (iteration can continue)
301 */
Simon Glass5d3d44f2023-01-17 10:48:16 -0700302int bootflow_scan_first(struct udevice *dev, const char *label,
303 struct bootflow_iter *iter, int flags,
Simon Glassa16d87d2022-04-24 23:31:05 -0600304 struct bootflow *bflow);
305
306/**
307 * bootflow_scan_next() - find the next bootflow
308 *
309 * This works through the available bootdev devices until it finds one that
310 * can supply a bootflow. It then returns that bootflow
311 *
312 * @iter: Private info (as set up by bootflow_scan_first())
313 * @bflow: Place to put the bootflow if found
314 * Return: 0 if found, -ENODEV if no device, -ESHUTDOWN if no more bootflows,
315 * other -ve on other error (iteration can continue)
316 */
317int bootflow_scan_next(struct bootflow_iter *iter, struct bootflow *bflow);
318
319/**
320 * bootflow_first_glob() - Get the first bootflow from the global list
321 *
322 * Returns the first bootflow in the global list, no matter what bootflow it is
323 * attached to
324 *
325 * @bflowp: Returns a pointer to the bootflow
326 * Return: 0 if found, -ENOENT if there are no bootflows
327 */
328int bootflow_first_glob(struct bootflow **bflowp);
329
330/**
331 * bootflow_next_glob() - Get the next bootflow from the global list
332 *
333 * Returns the next bootflow in the global list, no matter what bootflow it is
334 * attached to
335 *
336 * @bflowp: On entry, the last bootflow returned , e.g. from
337 * bootflow_first_glob()
338 * Return: 0 if found, -ENOENT if there are no more bootflows
339 */
340int bootflow_next_glob(struct bootflow **bflowp);
341
342/**
343 * bootflow_free() - Free memory used by a bootflow
344 *
345 * This frees fields within @bflow, but not the @bflow pointer itself
346 */
347void bootflow_free(struct bootflow *bflow);
348
349/**
350 * bootflow_boot() - boot a bootflow
351 *
352 * @bflow: Bootflow to boot
353 * Return: -EPROTO if bootflow has not been loaded, -ENOSYS if the bootflow
354 * type is not supported, -EFAULT if the boot returned without an error
355 * when we are expecting it to boot, -ENOTSUPP if trying method resulted in
356 * finding out that is not actually supported for this boot and should not
357 * be tried again unless something changes
358 */
359int bootflow_boot(struct bootflow *bflow);
360
361/**
Simon Glass6d8f95b2023-08-10 19:33:18 -0600362 * bootflow_read_all() - Read all bootflow files
363 *
364 * Some bootmeths delay reading of large files until booting is requested. This
365 * causes those files to be read.
366 *
367 * @bflow: Bootflow to read
368 * Return: result of trying to read
369 */
370int bootflow_read_all(struct bootflow *bflow);
371
372/**
Simon Glassa16d87d2022-04-24 23:31:05 -0600373 * bootflow_run_boot() - Try to boot a bootflow
374 *
375 * @iter: Current iteration (or NULL if none). Used to disable a bootmeth if the
376 * boot returns -ENOTSUPP
377 * @bflow: Bootflow to boot
378 * Return: result of trying to boot
379 */
380int bootflow_run_boot(struct bootflow_iter *iter, struct bootflow *bflow);
381
382/**
383 * bootflow_state_get_name() - Get the name of a bootflow state
384 *
385 * @state: State to check
386 * Return: name, or "?" if invalid
387 */
388const char *bootflow_state_get_name(enum bootflow_state_t state);
389
Simon Glass03fcbf92022-04-24 23:31:09 -0600390/**
391 * bootflow_remove() - Remove a bootflow and free its memory
392 *
393 * This updates the linked lists containing the bootflow then frees it.
394 *
395 * @bflow: Bootflow to remove
396 */
397void bootflow_remove(struct bootflow *bflow);
398
399/**
Simon Glass18c50402023-01-17 10:47:54 -0700400 * bootflow_iter_check_blk() - Check that a bootflow uses a block device
Simon Glass03fcbf92022-04-24 23:31:09 -0600401 *
402 * This checks the bootdev in the bootflow to make sure it uses a block device
403 *
404 * Return: 0 if OK, -ENOTSUPP if some other device is used (e.g. ethernet)
405 */
Simon Glass18c50402023-01-17 10:47:54 -0700406int bootflow_iter_check_blk(const struct bootflow_iter *iter);
Simon Glass03fcbf92022-04-24 23:31:09 -0600407
408/**
Mattijs Korpershoekfc420be2024-07-10 10:40:03 +0200409 * bootflow_iter_check_mmc() - Check that a bootflow uses a MMC device
410 *
411 * This checks the bootdev in the bootflow to make sure it uses a mmc device
412 *
413 * Return: 0 if OK, -ENOTSUPP if some other device is used (e.g. ethernet)
414 */
415int bootflow_iter_check_mmc(const struct bootflow_iter *iter);
416
417/**
Simon Glass215be682023-01-17 10:48:03 -0700418 * bootflow_iter_check_sf() - Check that a bootflow uses SPI FLASH
419 *
420 * This checks the bootdev in the bootflow to make sure it uses SPI flash
421 *
422 * Return: 0 if OK, -ENOTSUPP if some other device is used (e.g. ethernet)
423 */
424int bootflow_iter_check_sf(const struct bootflow_iter *iter);
425
426/**
Simon Glass18c50402023-01-17 10:47:54 -0700427 * bootflow_iter_check_net() - Check that a bootflow uses a network device
Simon Glass03fcbf92022-04-24 23:31:09 -0600428 *
429 * This checks the bootdev in the bootflow to make sure it uses a network
430 * device
431 *
432 * Return: 0 if OK, -ENOTSUPP if some other device is used (e.g. MMC)
433 */
Simon Glass18c50402023-01-17 10:47:54 -0700434int bootflow_iter_check_net(const struct bootflow_iter *iter);
Simon Glass03fcbf92022-04-24 23:31:09 -0600435
436/**
Simon Glass18c50402023-01-17 10:47:54 -0700437 * bootflow_iter_check_system() - Check that a bootflow uses the bootstd device
Simon Glass03fcbf92022-04-24 23:31:09 -0600438 *
439 * This checks the bootdev in the bootflow to make sure it uses the bootstd
440 * device
441 *
442 * Return: 0 if OK, -ENOTSUPP if some other device is used (e.g. MMC)
443 */
Simon Glass18c50402023-01-17 10:47:54 -0700444int bootflow_iter_check_system(const struct bootflow_iter *iter);
Simon Glass03fcbf92022-04-24 23:31:09 -0600445
Simon Glass0a2f6a32023-01-06 08:52:40 -0600446/**
447 * bootflow_menu_new() - Create a new bootflow menu
448 *
449 * @expp: Returns the expo created
450 * Returns 0 on success, -ve on error
451 */
452int bootflow_menu_new(struct expo **expp);
453
454/**
Simon Glassd92bcc42023-01-06 08:52:42 -0600455 * bootflow_menu_apply_theme() - Apply a theme to a bootmenu
456 *
457 * @exp: Expo to update
458 * @node: Node containing the theme information
459 * Returns 0 on success, -ve on error
460 */
461int bootflow_menu_apply_theme(struct expo *exp, ofnode node);
462
463/**
Simon Glass0a2f6a32023-01-06 08:52:40 -0600464 * bootflow_menu_run() - Create and run a menu of available bootflows
465 *
466 * @std: Bootstd information
467 * @text_mode: Uses a text-based menu suitable for a serial port
468 * @bflowp: Returns chosen bootflow (set to NULL if nothing is chosen)
469 * @return 0 if an option was chosen, -EAGAIN if nothing was chosen, -ve on
470 * error
471 */
472int bootflow_menu_run(struct bootstd_priv *std, bool text_mode,
473 struct bootflow **bflowp);
474
Simon Glassa08adca2023-07-12 09:04:38 -0600475#define BOOTFLOWCL_EMPTY ((void *)1)
476
477/**
478 * cmdline_set_arg() - Update or read an argument in a cmdline string
479 *
480 * Handles updating a single arg in a cmdline string, returning it in a supplied
481 * buffer; also reading an arg from a cmdline string
482 *
483 * When updating, consecutive spaces are squashed as are spaces at the start and
484 * end.
485 *
486 * @buf: Working buffer to use (initial contents are ignored). Use NULL when
487 * reading
488 * @maxlen: Length of working buffer. Use 0 when reading
489 * @cmdline: Command line to update, in the form:
490 *
491 * fred mary= jane=123 john="has spaces"
492 *
493 * @set_arg: Argument to set or read (may or may not exist)
494 * @new_val: Value for the new argument. May not include quotes (") but may
495 * include embedded spaces, in which case it will be quoted when added to the
496 * command line. Use NULL to delete the argument from @cmdline, BOOTFLOWCL_EMPTY
497 * to set it to an empty value (no '=' sign after arg), "" to add an '=' sign
498 * but with an empty value. Use NULL when reading.
499 * @posp: Ignored when setting an argument; when getting an argument, returns
500 * the start position of its value in @cmdline, after the first quote, if any
501 *
502 * Return:
503 * For updating:
504 * length of new buffer (including \0 terminator) on success, -ENOENT if
505 * @new_val is NULL and @set_arg does not exist in @from, -EINVAL if a
506 * quoted arg-value in @from is not terminated with a quote, -EBADF if
507 * @new_val has spaces but does not start and end with quotes (or it has
508 * quotes in the middle of the string), -E2BIG if @maxlen is too small
509 * For reading:
510 * length of arg value (excluding quotes), -ENOENT if not found
511 */
512int cmdline_set_arg(char *buf, int maxlen, const char *cmdline,
513 const char *set_arg, const char *new_val, int *posp);
514
Simon Glass55a2da32023-07-12 09:04:39 -0600515/**
516 * bootflow_cmdline_set_arg() - Set a single argument for a bootflow
517 *
518 * Update the allocated cmdline and set the bootargs variable
519 *
520 * @bflow: Bootflow to update
521 * @arg: Argument to update (e.g. "console")
522 * @val: Value to set (e.g. "ttyS2") or NULL to delete the argument if present,
523 * "" to set it to an empty value (e.g. "console=") and BOOTFLOWCL_EMPTY to add
524 * it without any value ("initrd")
525 * @set_env: true to set the "bootargs" environment variable too
526 *
527 * Return: 0 if OK, -ENOMEM if out of memory
528 */
529int bootflow_cmdline_set_arg(struct bootflow *bflow, const char *arg,
530 const char *val, bool set_env);
531
532/**
533 * cmdline_get_arg() - Read an argument from a cmdline
534 *
535 * @cmdline: Command line to read, in the form:
536 *
537 * fred mary= jane=123 john="has spaces"
538 * @arg: Argument to read (may or may not exist)
539 * @posp: Returns position of argument (after any leading quote) if present
540 * Return: Length of argument value excluding quotes if found, -ENOENT if not
541 * found
542 */
543int cmdline_get_arg(const char *cmdline, const char *arg, int *posp);
544
545/**
546 * bootflow_cmdline_get_arg() - Read an argument from a cmdline
547 *
548 * @bootflow: Bootflow to read from
549 * @arg: Argument to read (may or may not exist)
550 * @valp: Returns a pointer to the argument (after any leading quote) if present
551 * Return: Length of argument value excluding quotes if found, -ENOENT if not
552 * found
553 */
554int bootflow_cmdline_get_arg(struct bootflow *bflow, const char *arg,
555 const char **val);
556
Simon Glasscd91e992023-07-12 09:04:42 -0600557/**
558 * bootflow_cmdline_auto() - Automatically set a value for a known argument
559 *
560 * This handles a small number of known arguments, for Linux in particular. It
561 * adds suitable kernel parameters automatically, e.g. to enable the console.
562 *
563 * @bflow: Bootflow to update
564 * @arg: Name of argument to set (e.g. "earlycon" or "console")
565 * Return: 0 if OK -ve on error
566 */
567int bootflow_cmdline_auto(struct bootflow *bflow, const char *arg);
568
Simon Glassa16d87d2022-04-24 23:31:05 -0600569#endif