Prepare v2024.10
[platform/kernel/u-boot.git] / cmd / ab_select.c
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright (C) 2017 The Android Open Source Project
4  */
5
6 #include <android_ab.h>
7 #include <command.h>
8 #include <env.h>
9 #include <part.h>
10
11 static int do_ab_select(struct cmd_tbl *cmdtp, int flag, int argc,
12                         char *const argv[])
13 {
14         int ret;
15         struct blk_desc *dev_desc;
16         struct disk_partition part_info;
17         char slot[2];
18         bool dec_tries = true;
19
20         if (argc < 4)
21                 return CMD_RET_USAGE;
22
23         for (int i = 4; i < argc; i++) {
24                 if (strcmp(argv[i], "--no-dec") == 0) {
25                         dec_tries = false;
26                 } else {
27                         return CMD_RET_USAGE;
28                 }
29         }
30
31         /* Lookup the "misc" partition from argv[2] and argv[3] */
32         if (part_get_info_by_dev_and_name_or_num(argv[2], argv[3],
33                                                  &dev_desc, &part_info,
34                                                  false) < 0) {
35                 return CMD_RET_FAILURE;
36         }
37
38         ret = ab_select_slot(dev_desc, &part_info, dec_tries);
39         if (ret < 0) {
40                 printf("Android boot failed, error %d.\n", ret);
41                 return CMD_RET_FAILURE;
42         }
43
44         /* Android standard slot names are 'a', 'b', ... */
45         slot[0] = BOOT_SLOT_NAME(ret);
46         slot[1] = '\0';
47         env_set(argv[1], slot);
48         printf("ANDROID: Booting slot: %s\n", slot);
49         return CMD_RET_SUCCESS;
50 }
51
52 U_BOOT_CMD(ab_select, 5, 0, do_ab_select,
53            "Select the slot used to boot from and register the boot attempt.",
54            "<slot_var_name> <interface> <dev[:part|#part_name]> [--no-dec]\n"
55            "    - Load the slot metadata from the partition 'part' on\n"
56            "      device type 'interface' instance 'dev' and store the active\n"
57            "      slot in the 'slot_var_name' variable. This also updates the\n"
58            "      Android slot metadata with a boot attempt, which can cause\n"
59            "      successive calls to this function to return a different result\n"
60            "      if the returned slot runs out of boot attempts.\n"
61            "    - If 'part_name' is passed, preceded with a # instead of :, the\n"
62            "      partition name whose label is 'part_name' will be looked up in\n"
63            "      the partition table. This is commonly the \"misc\" partition.\n"
64            "    - If '--no-dec' is set, the number of tries remaining will not\n"
65            "      decremented for the selected boot slot\n"
66 );