blob: 6922e7e0c4e753760215f77e101e110c6bad1d31 [file] [log] [blame]
Simon Glassa8f5be12022-04-24 23:31:09 -06001// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright 2021 Google LLC
4 * Written by Simon Glass <sjg@chromium.org>
5 */
6
7#define LOG_CATEGORY UCLASS_BOOTSTD
8
9#include <common.h>
10#include <bootdev.h>
11#include <bootflow.h>
12#include <bootmeth.h>
13#include <bootstd.h>
14#include <dm.h>
Simon Glassd42243f2023-07-12 09:04:35 -060015#include <env_internal.h>
Simon Glassa8f5be12022-04-24 23:31:09 -060016#include <malloc.h>
Simon Glass33ebcb42023-07-12 09:04:42 -060017#include <serial.h>
Simon Glassa8f5be12022-04-24 23:31:09 -060018#include <dm/device-internal.h>
19#include <dm/uclass-internal.h>
20
21/* error codes used to signal running out of things */
22enum {
23 BF_NO_MORE_PARTS = -ESHUTDOWN,
24 BF_NO_MORE_DEVICES = -ENODEV,
25};
26
27/**
28 * bootflow_state - name for each state
29 *
30 * See enum bootflow_state_t for what each of these means
31 */
32static const char *const bootflow_state[BOOTFLOWST_COUNT] = {
33 "base",
34 "media",
35 "part",
36 "fs",
37 "file",
38 "ready",
39};
40
41const char *bootflow_state_get_name(enum bootflow_state_t state)
42{
43 /* This doesn't need to be a useful name, since it will never occur */
44 if (state < 0 || state >= BOOTFLOWST_COUNT)
45 return "?";
46
47 return bootflow_state[state];
48}
49
50int bootflow_first_glob(struct bootflow **bflowp)
51{
52 struct bootstd_priv *std;
53 int ret;
54
55 ret = bootstd_get_priv(&std);
56 if (ret)
57 return ret;
58
59 if (list_empty(&std->glob_head))
60 return -ENOENT;
61
62 *bflowp = list_first_entry(&std->glob_head, struct bootflow,
63 glob_node);
64
65 return 0;
66}
67
68int bootflow_next_glob(struct bootflow **bflowp)
69{
70 struct bootstd_priv *std;
71 struct bootflow *bflow = *bflowp;
72 int ret;
73
74 ret = bootstd_get_priv(&std);
75 if (ret)
76 return ret;
77
78 *bflowp = NULL;
79
80 if (list_is_last(&bflow->glob_node, &std->glob_head))
81 return -ENOENT;
82
83 *bflowp = list_entry(bflow->glob_node.next, struct bootflow, glob_node);
84
85 return 0;
86}
87
88void bootflow_iter_init(struct bootflow_iter *iter, int flags)
89{
90 memset(iter, '\0', sizeof(*iter));
Simon Glass2b80bc12022-07-30 15:52:25 -060091 iter->first_glob_method = -1;
Simon Glassa8f5be12022-04-24 23:31:09 -060092 iter->flags = flags;
Simon Glassa950f282023-01-17 10:48:17 -070093
94 /* remember the first bootdevs we see */
95 iter->max_devs = BOOTFLOW_MAX_USED_DEVS;
Simon Glassa8f5be12022-04-24 23:31:09 -060096}
97
98void bootflow_iter_uninit(struct bootflow_iter *iter)
99{
Simon Glassa8f5be12022-04-24 23:31:09 -0600100 free(iter->method_order);
101}
102
103int bootflow_iter_drop_bootmeth(struct bootflow_iter *iter,
104 const struct udevice *bmeth)
105{
106 /* We only support disabling the current bootmeth */
107 if (bmeth != iter->method || iter->cur_method >= iter->num_methods ||
108 iter->method_order[iter->cur_method] != bmeth)
109 return -EINVAL;
110
111 memmove(&iter->method_order[iter->cur_method],
112 &iter->method_order[iter->cur_method + 1],
113 (iter->num_methods - iter->cur_method - 1) * sizeof(void *));
114
115 iter->num_methods--;
116
117 return 0;
118}
119
Simon Glass47aedc22023-01-17 10:48:14 -0700120/**
121 * bootflow_iter_set_dev() - switch to the next bootdev when iterating
122 *
123 * This sets iter->dev, records the device in the dev_used[] list and shows a
124 * message if required
125 *
126 * @iter: Iterator to update
127 * @dev: Bootdev to use, or NULL if there are no more
128 */
Simon Glassa8f5be12022-04-24 23:31:09 -0600129static void bootflow_iter_set_dev(struct bootflow_iter *iter,
Simon Glass47aedc22023-01-17 10:48:14 -0700130 struct udevice *dev, int method_flags)
Simon Glassa8f5be12022-04-24 23:31:09 -0600131{
Simon Glass2b80bc12022-07-30 15:52:25 -0600132 struct bootmeth_uc_plat *ucp = dev_get_uclass_plat(iter->method);
133
Simon Glass47aedc22023-01-17 10:48:14 -0700134 log_debug("iter: Setting dev to %s, flags %x\n",
135 dev ? dev->name : "(none)", method_flags);
Simon Glassa8f5be12022-04-24 23:31:09 -0600136 iter->dev = dev;
Simon Glass47aedc22023-01-17 10:48:14 -0700137 iter->method_flags = method_flags;
138
Simon Glassa950f282023-01-17 10:48:17 -0700139 if (IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
140 /* record the device for later */
141 if (dev && iter->num_devs < iter->max_devs)
142 iter->dev_used[iter->num_devs++] = dev;
143
Simon Glass4f806f32023-02-22 12:17:03 -0700144 if ((iter->flags & (BOOTFLOWIF_SHOW | BOOTFLOWIF_SINGLE_DEV)) ==
145 BOOTFLOWIF_SHOW) {
Simon Glassa950f282023-01-17 10:48:17 -0700146 if (dev)
147 printf("Scanning bootdev '%s':\n", dev->name);
148 else if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) &&
149 ucp->flags & BOOTMETHF_GLOBAL)
150 printf("Scanning global bootmeth '%s':\n",
151 iter->method->name);
152 else
153 printf("No more bootdevs\n");
154 }
Simon Glassa8f5be12022-04-24 23:31:09 -0600155 }
156}
157
158/**
Simon Glass16e19352023-10-23 00:02:12 -0700159 * scan_next_in_uclass() - Scan for the next bootdev in the same media uclass
160 *
161 * Move through the following bootdevs until we find another in this media
162 * uclass, or run out
163 *
164 * @devp: On entry, the device to check, on exit the new device, or NULL if
165 * there is none
166 */
167static void scan_next_in_uclass(struct udevice **devp)
168{
169 struct udevice *dev = *devp;
170 enum uclass_id cur_id = device_get_uclass_id(dev->parent);
171
172 do {
173 uclass_find_next_device(&dev);
174 } while (dev && cur_id != device_get_uclass_id(dev->parent));
175
176 *devp = dev;
177}
178
179/**
Simon Glassa8f5be12022-04-24 23:31:09 -0600180 * iter_incr() - Move to the next item (method, part, bootdev)
181 *
182 * Return: 0 if OK, BF_NO_MORE_DEVICES if there are no more bootdevs
183 */
184static int iter_incr(struct bootflow_iter *iter)
185{
186 struct udevice *dev;
Simon Glass2b80bc12022-07-30 15:52:25 -0600187 bool inc_dev = true;
188 bool global;
Simon Glassa8f5be12022-04-24 23:31:09 -0600189 int ret;
190
Simon Glass47aedc22023-01-17 10:48:14 -0700191 log_debug("entry: err=%d\n", iter->err);
Simon Glass2b80bc12022-07-30 15:52:25 -0600192 global = iter->doing_global;
193
Simon Glassa8f5be12022-04-24 23:31:09 -0600194 if (iter->err == BF_NO_MORE_DEVICES)
195 return BF_NO_MORE_DEVICES;
196
197 if (iter->err != BF_NO_MORE_PARTS) {
198 /* Get the next boothmethod */
199 if (++iter->cur_method < iter->num_methods) {
200 iter->method = iter->method_order[iter->cur_method];
201 return 0;
202 }
Simon Glass2b80bc12022-07-30 15:52:25 -0600203
204 /*
205 * If we have finished scanning the global bootmeths, start the
206 * normal bootdev scan
207 */
208 if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && global) {
209 iter->num_methods = iter->first_glob_method;
210 iter->doing_global = false;
211
212 /*
213 * Don't move to the next dev as we haven't tried this
214 * one yet!
215 */
216 inc_dev = false;
217 }
Simon Glassa8f5be12022-04-24 23:31:09 -0600218 }
219
220 /* No more bootmeths; start at the first one, and... */
221 iter->cur_method = 0;
222 iter->method = iter->method_order[iter->cur_method];
223
224 if (iter->err != BF_NO_MORE_PARTS) {
225 /* ...select next partition */
226 if (++iter->part <= iter->max_part)
227 return 0;
228 }
229
Simon Glass47aedc22023-01-17 10:48:14 -0700230 /* No more partitions; start at the first one and... */
Simon Glassa8f5be12022-04-24 23:31:09 -0600231 iter->part = 0;
232
233 /*
234 * Note: as far as we know, there is no partition table on the next
235 * bootdev, so set max_part to 0 until we discover otherwise. See
236 * bootdev_find_in_blk() for where this is set.
237 */
238 iter->max_part = 0;
239
240 /* ...select next bootdev */
Simon Glass4f806f32023-02-22 12:17:03 -0700241 if (iter->flags & BOOTFLOWIF_SINGLE_DEV) {
Simon Glassa8f5be12022-04-24 23:31:09 -0600242 ret = -ENOENT;
Simon Glassa8f5be12022-04-24 23:31:09 -0600243 } else {
Simon Glass47aedc22023-01-17 10:48:14 -0700244 int method_flags;
245
246 ret = 0;
247 dev = iter->dev;
248 log_debug("inc_dev=%d\n", inc_dev);
249 if (!inc_dev) {
Simon Glass91943ff2023-01-17 10:48:15 -0700250 ret = bootdev_setup_iter(iter, NULL, &dev,
251 &method_flags);
252 } else if (IS_ENABLED(CONFIG_BOOTSTD_FULL) &&
Simon Glass4f806f32023-02-22 12:17:03 -0700253 (iter->flags & BOOTFLOWIF_SINGLE_UCLASS)) {
Simon Glass16e19352023-10-23 00:02:12 -0700254 scan_next_in_uclass(&dev);
Simon Glass91943ff2023-01-17 10:48:15 -0700255 if (!dev) {
256 log_debug("finished uclass %s\n",
257 dev_get_uclass_name(dev));
258 ret = -ENODEV;
259 }
260 } else if (IS_ENABLED(CONFIG_BOOTSTD_FULL) &&
Simon Glass4f806f32023-02-22 12:17:03 -0700261 iter->flags & BOOTFLOWIF_SINGLE_MEDIA) {
Simon Glass91943ff2023-01-17 10:48:15 -0700262 log_debug("next in single\n");
263 method_flags = 0;
264 do {
265 /*
266 * Move to the next bootdev child of this media
267 * device. This ensures that we cover all the
268 * available SCSI IDs and LUNs.
269 */
270 device_find_next_child(&dev);
271 log_debug("- next %s\n",
272 dev ? dev->name : "(none)");
273 } while (dev && device_get_uclass_id(dev) !=
274 UCLASS_BOOTDEV);
275 if (!dev) {
276 log_debug("finished uclass %s\n",
277 dev_get_uclass_name(dev));
278 ret = -ENODEV;
279 }
Simon Glass2b80bc12022-07-30 15:52:25 -0600280 } else {
Simon Glass47aedc22023-01-17 10:48:14 -0700281 log_debug("labels %p\n", iter->labels);
282 if (iter->labels) {
Simon Glass7a790f02023-10-23 00:02:13 -0700283 /*
284 * when the label is "mmc" we want to scan all
285 * mmc bootdevs, not just the first. See
286 * bootdev_find_by_label() where this flag is
287 * set up
288 */
289 if (iter->method_flags &
290 BOOTFLOW_METHF_SINGLE_UCLASS) {
291 scan_next_in_uclass(&dev);
292 log_debug("looking for next device %s: %s\n",
293 iter->dev->name,
294 dev ? dev->name : "<none>");
295 } else {
296 dev = NULL;
297 }
298 if (!dev) {
299 log_debug("looking at next label\n");
300 ret = bootdev_next_label(iter, &dev,
301 &method_flags);
302 }
Simon Glass47aedc22023-01-17 10:48:14 -0700303 } else {
304 ret = bootdev_next_prio(iter, &dev);
305 method_flags = 0;
306 }
307 }
308 log_debug("ret=%d, dev=%p %s\n", ret, dev,
309 dev ? dev->name : "none");
310 if (ret) {
311 bootflow_iter_set_dev(iter, NULL, 0);
312 } else {
Simon Glass965020c2023-01-28 15:00:19 -0700313 /*
314 * Probe the bootdev. This does not probe any attached
315 * block device, since they are siblings
316 */
Simon Glass2b80bc12022-07-30 15:52:25 -0600317 ret = device_probe(dev);
Simon Glass47aedc22023-01-17 10:48:14 -0700318 log_debug("probe %s %d\n", dev->name, ret);
Simon Glass2b80bc12022-07-30 15:52:25 -0600319 if (!log_msg_ret("probe", ret))
Simon Glass47aedc22023-01-17 10:48:14 -0700320 bootflow_iter_set_dev(iter, dev, method_flags);
Simon Glass2b80bc12022-07-30 15:52:25 -0600321 }
Simon Glassa8f5be12022-04-24 23:31:09 -0600322 }
323
324 /* if there are no more bootdevs, give up */
325 if (ret)
326 return log_msg_ret("incr", BF_NO_MORE_DEVICES);
327
328 return 0;
329}
330
331/**
332 * bootflow_check() - Check if a bootflow can be obtained
333 *
334 * @iter: Provides part, bootmeth to use
335 * @bflow: Bootflow to update on success
336 * Return: 0 if OK, -ENOSYS if there is no bootflow support on this device,
337 * BF_NO_MORE_PARTS if there are no more partitions on bootdev
338 */
339static int bootflow_check(struct bootflow_iter *iter, struct bootflow *bflow)
340{
341 struct udevice *dev;
342 int ret;
343
Simon Glass2b80bc12022-07-30 15:52:25 -0600344 if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && iter->doing_global) {
Simon Glass47aedc22023-01-17 10:48:14 -0700345 bootflow_iter_set_dev(iter, NULL, 0);
Simon Glass2b80bc12022-07-30 15:52:25 -0600346 ret = bootmeth_get_bootflow(iter->method, bflow);
347 if (ret)
348 return log_msg_ret("glob", ret);
349
350 return 0;
351 }
352
Simon Glassa8f5be12022-04-24 23:31:09 -0600353 dev = iter->dev;
354 ret = bootdev_get_bootflow(dev, iter, bflow);
355
356 /* If we got a valid bootflow, return it */
357 if (!ret) {
Simon Glass4de979f2023-07-12 09:04:32 -0600358 log_debug("Bootdev '%s' part %d method '%s': Found bootflow\n",
Simon Glassa8f5be12022-04-24 23:31:09 -0600359 dev->name, iter->part, iter->method->name);
360 return 0;
361 }
362
363 /* Unless there is nothing more to try, move to the next device */
364 else if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
Simon Glass4de979f2023-07-12 09:04:32 -0600365 log_debug("Bootdev '%s' part %d method '%s': Error %d\n",
Simon Glassa8f5be12022-04-24 23:31:09 -0600366 dev->name, iter->part, iter->method->name, ret);
367 /*
368 * For 'all' we return all bootflows, even
369 * those with errors
370 */
Simon Glass4f806f32023-02-22 12:17:03 -0700371 if (iter->flags & BOOTFLOWIF_ALL)
Simon Glassa8f5be12022-04-24 23:31:09 -0600372 return log_msg_ret("all", ret);
373 }
374 if (ret)
375 return log_msg_ret("check", ret);
376
377 return 0;
378}
379
Simon Glass4b7cb052023-01-17 10:48:16 -0700380int bootflow_scan_first(struct udevice *dev, const char *label,
381 struct bootflow_iter *iter, int flags,
382 struct bootflow *bflow)
Simon Glassa8f5be12022-04-24 23:31:09 -0600383{
384 int ret;
385
Simon Glass91943ff2023-01-17 10:48:15 -0700386 if (dev || label)
Simon Glass4f806f32023-02-22 12:17:03 -0700387 flags |= BOOTFLOWIF_SKIP_GLOBAL;
Simon Glassa8f5be12022-04-24 23:31:09 -0600388 bootflow_iter_init(iter, flags);
389
Simon Glass47aedc22023-01-17 10:48:14 -0700390 /*
391 * Set up the ordering of bootmeths. This sets iter->doing_global and
392 * iter->first_glob_method if we are starting with the global bootmeths
393 */
Simon Glass4f806f32023-02-22 12:17:03 -0700394 ret = bootmeth_setup_iter_order(iter, !(flags & BOOTFLOWIF_SKIP_GLOBAL));
Simon Glassa8f5be12022-04-24 23:31:09 -0600395 if (ret)
396 return log_msg_ret("obmeth", -ENODEV);
397
398 /* Find the first bootmeth (there must be at least one!) */
399 iter->method = iter->method_order[iter->cur_method];
Simon Glass47aedc22023-01-17 10:48:14 -0700400
401 if (!IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) || !iter->doing_global) {
402 struct udevice *dev = NULL;
403 int method_flags;
404
Simon Glass91943ff2023-01-17 10:48:15 -0700405 ret = bootdev_setup_iter(iter, label, &dev, &method_flags);
Simon Glass47aedc22023-01-17 10:48:14 -0700406 if (ret)
407 return log_msg_ret("obdev", -ENODEV);
408
409 bootflow_iter_set_dev(iter, dev, method_flags);
410 }
Simon Glassa8f5be12022-04-24 23:31:09 -0600411
412 ret = bootflow_check(iter, bflow);
413 if (ret) {
Simon Glassf738c732023-01-17 10:48:18 -0700414 log_debug("check - ret=%d\n", ret);
Simon Glassa8f5be12022-04-24 23:31:09 -0600415 if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
Simon Glass4f806f32023-02-22 12:17:03 -0700416 if (iter->flags & BOOTFLOWIF_ALL)
Simon Glassa8f5be12022-04-24 23:31:09 -0600417 return log_msg_ret("all", ret);
418 }
419 iter->err = ret;
420 ret = bootflow_scan_next(iter, bflow);
421 if (ret)
422 return log_msg_ret("get", ret);
423 }
424
425 return 0;
426}
427
Simon Glassa8f5be12022-04-24 23:31:09 -0600428int bootflow_scan_next(struct bootflow_iter *iter, struct bootflow *bflow)
429{
430 int ret;
431
432 do {
433 ret = iter_incr(iter);
Simon Glassf738c732023-01-17 10:48:18 -0700434 log_debug("iter_incr: ret=%d\n", ret);
Simon Glassa8f5be12022-04-24 23:31:09 -0600435 if (ret == BF_NO_MORE_DEVICES)
436 return log_msg_ret("done", ret);
437
438 if (!ret) {
439 ret = bootflow_check(iter, bflow);
Simon Glassf738c732023-01-17 10:48:18 -0700440 log_debug("check - ret=%d\n", ret);
Simon Glassa8f5be12022-04-24 23:31:09 -0600441 if (!ret)
442 return 0;
443 iter->err = ret;
444 if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
Simon Glass4f806f32023-02-22 12:17:03 -0700445 if (iter->flags & BOOTFLOWIF_ALL)
Simon Glassa8f5be12022-04-24 23:31:09 -0600446 return log_msg_ret("all", ret);
447 }
448 } else {
Simon Glassf738c732023-01-17 10:48:18 -0700449 log_debug("incr failed, err=%d\n", ret);
Simon Glassa8f5be12022-04-24 23:31:09 -0600450 iter->err = ret;
451 }
452
453 } while (1);
454}
455
Simon Glassb190deb2022-10-20 18:22:51 -0600456void bootflow_init(struct bootflow *bflow, struct udevice *bootdev,
457 struct udevice *meth)
458{
459 memset(bflow, '\0', sizeof(*bflow));
460 bflow->dev = bootdev;
461 bflow->method = meth;
462 bflow->state = BOOTFLOWST_BASE;
463}
464
Simon Glassa8f5be12022-04-24 23:31:09 -0600465void bootflow_free(struct bootflow *bflow)
466{
467 free(bflow->name);
468 free(bflow->subdir);
469 free(bflow->fname);
470 free(bflow->buf);
Simon Glass2175e762023-01-06 08:52:33 -0600471 free(bflow->os_name);
Simon Glass7638c852023-01-17 10:47:56 -0700472 free(bflow->fdt_fname);
Simon Glass76bd6842023-07-30 11:16:56 -0600473 free(bflow->bootmeth_priv);
Simon Glassa8f5be12022-04-24 23:31:09 -0600474}
475
476void bootflow_remove(struct bootflow *bflow)
477{
Simon Glasseccb25c2022-07-30 15:52:23 -0600478 if (bflow->dev)
479 list_del(&bflow->bm_node);
Simon Glassa8f5be12022-04-24 23:31:09 -0600480 list_del(&bflow->glob_node);
481
482 bootflow_free(bflow);
483 free(bflow);
484}
485
Simon Glassc2792242023-08-10 19:33:18 -0600486#if CONFIG_IS_ENABLED(BOOTSTD_FULL)
487int bootflow_read_all(struct bootflow *bflow)
488{
489 int ret;
490
491 if (bflow->state != BOOTFLOWST_READY)
492 return log_msg_ret("rd", -EPROTO);
493
494 ret = bootmeth_read_all(bflow->method, bflow);
495 if (ret)
496 return log_msg_ret("rd2", ret);
497
498 return 0;
499}
500#endif /* BOOTSTD_FULL */
501
Simon Glassa8f5be12022-04-24 23:31:09 -0600502int bootflow_boot(struct bootflow *bflow)
503{
504 int ret;
505
506 if (bflow->state != BOOTFLOWST_READY)
507 return log_msg_ret("load", -EPROTO);
508
509 ret = bootmeth_boot(bflow->method, bflow);
510 if (ret)
511 return log_msg_ret("boot", ret);
512
513 /*
514 * internal error, should not get here since we should have booted
515 * something or returned an error
516 */
517
518 return log_msg_ret("end", -EFAULT);
519}
520
521int bootflow_run_boot(struct bootflow_iter *iter, struct bootflow *bflow)
522{
523 int ret;
524
525 printf("** Booting bootflow '%s' with %s\n", bflow->name,
526 bflow->method->name);
Simon Glass47dd6b42023-02-22 12:17:04 -0700527 if (IS_ENABLED(CONFIG_OF_HAS_PRIOR_STAGE) &&
528 (bflow->flags & BOOTFLOWF_USE_PRIOR_FDT))
529 printf("Using prior-stage device tree\n");
Simon Glassa8f5be12022-04-24 23:31:09 -0600530 ret = bootflow_boot(bflow);
531 if (!IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
532 printf("Boot failed (err=%d)\n", ret);
533 return ret;
534 }
535
536 switch (ret) {
537 case -EPROTO:
538 printf("Bootflow not loaded (state '%s')\n",
539 bootflow_state_get_name(bflow->state));
540 break;
541 case -ENOSYS:
542 printf("Boot method '%s' not supported\n", bflow->method->name);
543 break;
544 case -ENOTSUPP:
545 /* Disable this bootflow for this iteration */
546 if (iter) {
547 int ret2;
548
549 ret2 = bootflow_iter_drop_bootmeth(iter, bflow->method);
550 if (!ret2) {
551 printf("Boot method '%s' failed and will not be retried\n",
552 bflow->method->name);
553 }
554 }
555
556 break;
557 default:
558 printf("Boot failed (err=%d)\n", ret);
559 break;
560 }
561
562 return ret;
563}
564
Simon Glass865328c2023-01-17 10:47:54 -0700565int bootflow_iter_check_blk(const struct bootflow_iter *iter)
Simon Glassa8f5be12022-04-24 23:31:09 -0600566{
567 const struct udevice *media = dev_get_parent(iter->dev);
568 enum uclass_id id = device_get_uclass_id(media);
569
570 log_debug("uclass %d: %s\n", id, uclass_get_name(id));
Simon Glass9c6d57d2023-01-28 15:00:25 -0700571 if (id != UCLASS_ETH && id != UCLASS_BOOTSTD && id != UCLASS_QFW)
Simon Glassa8f5be12022-04-24 23:31:09 -0600572 return 0;
573
574 return -ENOTSUPP;
575}
576
Simon Glass0c1f4a92023-01-17 10:48:03 -0700577int bootflow_iter_check_sf(const struct bootflow_iter *iter)
578{
579 const struct udevice *media = dev_get_parent(iter->dev);
580 enum uclass_id id = device_get_uclass_id(media);
581
582 log_debug("uclass %d: %s\n", id, uclass_get_name(id));
583 if (id == UCLASS_SPI_FLASH)
584 return 0;
585
586 return -ENOTSUPP;
587}
588
Simon Glass865328c2023-01-17 10:47:54 -0700589int bootflow_iter_check_net(const struct bootflow_iter *iter)
Simon Glassa8f5be12022-04-24 23:31:09 -0600590{
591 const struct udevice *media = dev_get_parent(iter->dev);
592 enum uclass_id id = device_get_uclass_id(media);
593
594 log_debug("uclass %d: %s\n", id, uclass_get_name(id));
595 if (id == UCLASS_ETH)
596 return 0;
597
598 return -ENOTSUPP;
599}
600
Simon Glass865328c2023-01-17 10:47:54 -0700601int bootflow_iter_check_system(const struct bootflow_iter *iter)
Simon Glassa8f5be12022-04-24 23:31:09 -0600602{
603 const struct udevice *media = dev_get_parent(iter->dev);
604 enum uclass_id id = device_get_uclass_id(media);
605
606 log_debug("uclass %d: %s\n", id, uclass_get_name(id));
607 if (id == UCLASS_BOOTSTD)
608 return 0;
609
610 return -ENOTSUPP;
611}
Simon Glassd42243f2023-07-12 09:04:35 -0600612
613/**
614 * bootflow_cmdline_set() - Set the command line for a bootflow
615 *
616 * @value: New command-line string
617 * Returns 0 if OK, -ENOENT if no current bootflow, -ENOMEM if out of memory
618 */
619int bootflow_cmdline_set(struct bootflow *bflow, const char *value)
620{
621 char *cmdline = NULL;
622
623 if (value) {
624 cmdline = strdup(value);
625 if (!cmdline)
626 return -ENOMEM;
627 }
628
629 free(bflow->cmdline);
630 bflow->cmdline = cmdline;
631
632 return 0;
633}
634
635#ifdef CONFIG_BOOTSTD_FULL
636/**
637 * on_bootargs() - Update the cmdline of a bootflow
638 */
639static int on_bootargs(const char *name, const char *value, enum env_op op,
640 int flags)
641{
642 struct bootstd_priv *std;
643 struct bootflow *bflow;
644 int ret;
645
646 ret = bootstd_get_priv(&std);
647 if (ret)
648 return 0;
649 bflow = std->cur_bootflow;
650 if (!bflow)
651 return 0;
652
653 switch (op) {
654 case env_op_create:
655 case env_op_overwrite:
656 ret = bootflow_cmdline_set(bflow, value);
657 if (ret && ret != ENOENT)
658 return 1;
659 return 0;
660 case env_op_delete:
661 bootflow_cmdline_set(bflow, NULL);
662 fallthrough;
663 default:
664 return 0;
665 }
666}
667U_BOOT_ENV_CALLBACK(bootargs, on_bootargs);
668#endif
Simon Glassd07861c2023-07-12 09:04:38 -0600669
670/**
671 * copy_in() - Copy a string into a cmdline buffer
672 *
673 * @buf: Buffer to copy into
674 * @end: End of buffer (pointer to char after the end)
675 * @arg: String to copy from
676 * @len: Number of chars to copy from @arg (note that this is not usually the
677 * sane as strlen(arg) since the string may contain following arguments)
678 * @new_val: Value to put after arg, or BOOTFLOWCL_EMPTY to use an empty value
679 * with no '=' sign
680 * Returns: Number of chars written to @buf
681 */
682static int copy_in(char *buf, char *end, const char *arg, int len,
683 const char *new_val)
684{
685 char *to = buf;
686
687 /* copy the arg name */
688 if (to + len >= end)
689 return -E2BIG;
690 memcpy(to, arg, len);
691 to += len;
692
693 if (new_val == BOOTFLOWCL_EMPTY) {
694 /* no value */
695 } else {
696 bool need_quote = strchr(new_val, ' ');
697 len = strlen(new_val);
698
699 /* need space for value, equals sign and maybe two quotes */
700 if (to + 1 + (need_quote ? 2 : 0) + len >= end)
701 return -E2BIG;
702 *to++ = '=';
703 if (need_quote)
704 *to++ = '"';
705 memcpy(to, new_val, len);
706 to += len;
707 if (need_quote)
708 *to++ = '"';
709 }
710
711 return to - buf;
712}
713
714int cmdline_set_arg(char *buf, int maxlen, const char *cmdline,
715 const char *set_arg, const char *new_val, int *posp)
716{
717 bool found_arg = false;
718 const char *from;
719 char *to, *end;
720 int set_arg_len;
721 char empty = '\0';
722 int ret;
723
724 from = cmdline ?: &empty;
725
726 /* check if the value has quotes inside */
727 if (new_val && new_val != BOOTFLOWCL_EMPTY && strchr(new_val, '"'))
728 return -EBADF;
729
730 set_arg_len = strlen(set_arg);
731 for (to = buf, end = buf + maxlen; *from;) {
732 const char *val, *arg_end, *val_end, *p;
733 bool in_quote;
734
735 if (to >= end)
736 return -E2BIG;
737 while (*from == ' ')
738 from++;
739 if (!*from)
740 break;
741
742 /* find the end of this arg */
743 val = NULL;
744 arg_end = NULL;
745 val_end = NULL;
746 in_quote = false;
747 for (p = from;; p++) {
748 if (in_quote) {
749 if (!*p)
750 return -EINVAL;
751 if (*p == '"')
752 in_quote = false;
753 continue;
754 }
Simon Glass19248dc2023-10-25 07:17:36 +1300755 if (*p == '=' && !arg_end) {
Simon Glassd07861c2023-07-12 09:04:38 -0600756 arg_end = p;
757 val = p + 1;
758 } else if (*p == '"') {
759 in_quote = true;
760 } else if (!*p || *p == ' ') {
761 val_end = p;
762 if (!arg_end)
763 arg_end = p;
764 break;
765 }
766 }
767 /*
768 * At this point val_end points to the end of the value, or the
769 * last char after the arg name, if there is no label.
770 * arg_end is the char after the arg name
771 * val points to the value, or NULL if there is none
772 * char after the value.
773 *
774 * fred=1234
775 * ^ ^^ ^
776 * from || |
777 * / \ \
778 * arg_end val val_end
779 */
780 log_debug("from %s arg_end %ld val %ld val_end %ld\n", from,
781 (long)(arg_end - from), (long)(val - from),
782 (long)(val_end - from));
783
784 if (to != buf) {
785 if (to >= end)
786 return -E2BIG;
787 *to++ = ' ';
788 }
789
790 /* if this is the target arg, update it */
Simon Glass19248dc2023-10-25 07:17:36 +1300791 if (arg_end - from == set_arg_len &&
792 !strncmp(from, set_arg, set_arg_len)) {
Simon Glassd07861c2023-07-12 09:04:38 -0600793 if (!buf) {
794 bool has_quote = val_end[-1] == '"';
795
796 /*
797 * exclude any start/end quotes from
798 * calculations
799 */
800 if (!val)
801 val = val_end;
802 *posp = val - cmdline + has_quote;
803 return val_end - val - 2 * has_quote;
804 }
805 found_arg = true;
806 if (!new_val) {
807 /* delete this arg */
808 from = val_end + (*val_end == ' ');
809 log_debug("delete from: %s\n", from);
810 if (to != buf)
811 to--; /* drop the space we added */
812 continue;
813 }
814
815 ret = copy_in(to, end, from, arg_end - from, new_val);
816 if (ret < 0)
817 return ret;
818 to += ret;
819
820 /* if not the target arg, copy it unchanged */
821 } else if (to) {
822 int len;
823
824 len = val_end - from;
825 if (to + len >= end)
826 return -E2BIG;
827 memcpy(to, from, len);
828 to += len;
829 }
830 from = val_end;
831 }
832
833 /* If we didn't find the arg, add it */
834 if (!found_arg) {
835 /* trying to delete something that is not there */
836 if (!new_val || !buf)
837 return -ENOENT;
838 if (to >= end)
839 return -E2BIG;
840
841 /* add a space to separate it from the previous arg */
842 if (to != buf && to[-1] != ' ')
843 *to++ = ' ';
844 ret = copy_in(to, end, set_arg, set_arg_len, new_val);
845 log_debug("ret=%d, to: %s buf: %s\n", ret, to, buf);
846 if (ret < 0)
847 return ret;
848 to += ret;
849 }
850
851 /* delete any trailing space */
852 if (to > buf && to[-1] == ' ')
853 to--;
854
855 if (to >= end)
856 return -E2BIG;
857 *to++ = '\0';
858
859 return to - buf;
860}
Simon Glass82c09382023-07-12 09:04:39 -0600861
862int bootflow_cmdline_set_arg(struct bootflow *bflow, const char *set_arg,
863 const char *new_val, bool set_env)
864{
865 char buf[2048];
866 char *cmd = NULL;
867 int ret;
868
869 ret = cmdline_set_arg(buf, sizeof(buf), bflow->cmdline, set_arg,
870 new_val, NULL);
871 if (ret < 0)
872 return ret;
873
874 ret = bootflow_cmdline_set(bflow, buf);
875 if (*buf) {
876 cmd = strdup(buf);
877 if (!cmd)
878 return -ENOMEM;
879 }
880 free(bflow->cmdline);
881 bflow->cmdline = cmd;
882
883 if (set_env) {
884 ret = env_set("bootargs", bflow->cmdline);
885 if (ret)
886 return ret;
887 }
888
889 return 0;
890}
891
892int cmdline_get_arg(const char *cmdline, const char *arg, int *posp)
893{
894 int ret;
895
896 ret = cmdline_set_arg(NULL, 1, cmdline, arg, NULL, posp);
897
898 return ret;
899}
900
901int bootflow_cmdline_get_arg(struct bootflow *bflow, const char *arg,
902 const char **val)
903{
904 int ret;
905 int pos;
906
907 ret = cmdline_get_arg(bflow->cmdline, arg, &pos);
908 if (ret < 0)
909 return ret;
910 *val = bflow->cmdline + pos;
911
912 return ret;
913}
Simon Glass33ebcb42023-07-12 09:04:42 -0600914
915int bootflow_cmdline_auto(struct bootflow *bflow, const char *arg)
916{
917 struct serial_device_info info;
918 char buf[50];
919 int ret;
920
921 ret = serial_getinfo(gd->cur_serial_dev, &info);
922 if (ret)
923 return ret;
924
925 *buf = '\0';
926 if (!strcmp("earlycon", arg)) {
927 snprintf(buf, sizeof(buf),
928 "uart8250,mmio32,%#lx,%dn8", info.addr,
929 info.baudrate);
930 } else if (!strcmp("console", arg)) {
931 snprintf(buf, sizeof(buf),
932 "ttyS0,%dn8", info.baudrate);
933 }
934
935 if (!*buf) {
936 printf("Unknown param '%s\n", arg);
937 return -ENOENT;
938 }
939
940 ret = bootflow_cmdline_set_arg(bflow, arg, buf, true);
941 if (ret)
942 return ret;
943
944 return 0;
945}