include/config_distro_bootcmd.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2014
   4  * NVIDIA Corporation <www.nvidia.com>
   5  *
   6  * Copyright 2014 Red Hat, Inc.
   7  */
   8
   9 #ifndef _CONFIG_CMD_DISTRO_BOOTCMD_H
  10 #define _CONFIG_CMD_DISTRO_BOOTCMD_H
  11
  12 /*
  13  * A note on error handling: It is possible for BOOT_TARGET_DEVICES to
  14  * reference a device that is not enabled in the U-Boot configuration, e.g.
  15  * it may include MMC in the list without CONFIG_CMD_MMC being enabled. Given
  16  * that BOOT_TARGET_DEVICES is a macro that's expanded by the C pre-processor
  17  * at compile time, it's not  possible to detect and report such problems via
  18  * a simple #ifdef/#error combination. Still, the code needs to report errors.
  19  * The best way I've found to do this is to make BOOT_TARGET_DEVICES expand to
  20  * reference a non-existent symbol, and have the name of that symbol encode
  21  * the error message. Consequently, this file contains references to e.g.
  22  * BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC. Given the
  23  * prevalence of capitals here, this looks like a pre-processor macro and
  24  * hence seems like it should be all capitals, but it's really an error
  25  * message that includes some other pre-processor symbols in the text.
  26  */
  27
  28 #define BOOTENV_SHARED_BLKDEV_BODY(devtypel) \
  29                 "if " #devtypel " dev ${devnum}; then " \
  30                         "setenv devtype " #devtypel "; " \
  31                         "run scan_dev_for_boot_part; " \
  32                 "fi\0"
  33
  34 #define BOOTENV_SHARED_BLKDEV(devtypel) \
  35         #devtypel "_boot=" \
  36         BOOTENV_SHARED_BLKDEV_BODY(devtypel)
  37
  38 #define BOOTENV_DEV_BLKDEV(devtypeu, devtypel, instance) \
  39         "bootcmd_" #devtypel #instance "=" \
  40                 "setenv devnum " #instance "; " \
  41                 "run " #devtypel "_boot\0"
  42
  43 #define BOOTENV_DEV_NAME_BLKDEV(devtypeu, devtypel, instance) \
  44         #devtypel #instance " "
  45
  46 #ifdef CONFIG_SANDBOX
  47 #define BOOTENV_SHARED_HOST     BOOTENV_SHARED_BLKDEV(host)
  48 #define BOOTENV_DEV_HOST        BOOTENV_DEV_BLKDEV
  49 #define BOOTENV_DEV_NAME_HOST   BOOTENV_DEV_NAME_BLKDEV
  50 #else
  51 #define BOOTENV_SHARED_HOST
  52 #define BOOTENV_DEV_HOST \
  53         BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
  54 #define BOOTENV_DEV_NAME_HOST \
  55         BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
  56 #endif
  57
  58 #ifdef CONFIG_CMD_MMC
  59 #define BOOTENV_SHARED_MMC      BOOTENV_SHARED_BLKDEV(mmc)
  60 #define BOOTENV_DEV_MMC         BOOTENV_DEV_BLKDEV
  61 #define BOOTENV_DEV_NAME_MMC    BOOTENV_DEV_NAME_BLKDEV
  62 #else
  63 #define BOOTENV_SHARED_MMC
  64 #define BOOTENV_DEV_MMC \
  65         BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
  66 #define BOOTENV_DEV_NAME_MMC \
  67         BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
  68 #endif
  69
  70 #ifdef CONFIG_CMD_UBIFS
  71 #define BOOTENV_SHARED_UBIFS \
  72         "ubifs_boot=" \
  73                 "env exists bootubipart || " \
  74                         "env set bootubipart UBI; " \
  75                 "env exists bootubivol || " \
  76                         "env set bootubivol boot; " \
  77                 "if ubi part ${bootubipart} && " \
  78                         "ubifsmount ubi${devnum}:${bootubivol}; " \
  79                 "then " \
  80                         "setenv devtype ubi; " \
  81                         "run scan_dev_for_boot; " \
  82                 "fi\0"
  83 #define BOOTENV_DEV_UBIFS       BOOTENV_DEV_BLKDEV
  84 #define BOOTENV_DEV_NAME_UBIFS  BOOTENV_DEV_NAME_BLKDEV
  85 #else
  86 #define BOOTENV_SHARED_UBIFS
  87 #define BOOTENV_DEV_UBIFS \
  88         BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
  89 #define BOOTENV_DEV_NAME_UBIFS \
  90         BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
  91 #endif
  92
  93 #ifdef CONFIG_EFI_LOADER
  94 #if defined(CONFIG_ARM64)
  95 #define BOOTEFI_NAME "bootaa64.efi"
  96 #elif defined(CONFIG_ARM)
  97 #define BOOTEFI_NAME "bootarm.efi"
  98 #elif defined(CONFIG_X86_RUN_32BIT)
  99 #define BOOTEFI_NAME "bootia32.efi"
 100 #elif defined(CONFIG_X86_RUN_64BIT)
 101 #define BOOTEFI_NAME "bootx64.efi"
 102 #endif
 103 #endif
 104
 105 #ifdef BOOTEFI_NAME
 106 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
 107 /*
 108  * On 32bit ARM systems there is a reasonable number of systems that follow
 109  * the $soc-$board$boardver.dtb name scheme for their device trees. Use that
 110  * scheme if we don't have an explicit fdtfile variable.
 111  */
 112 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK                                  \
 113         "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then "               \
 114           "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; "           \
 115         "fi; "
 116 #else
 117 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
 118 #endif
 119
 120
 121 #define BOOTENV_SHARED_EFI                                                \
 122         "boot_efi_binary="                                                \
 123                 "if fdt addr ${fdt_addr_r}; then "                        \
 124                         "bootefi bootmgr ${fdt_addr_r};"                  \
 125                 "else "                                                   \
 126                         "bootefi bootmgr ${fdtcontroladdr};"              \
 127                 "fi;"                                                     \
 128                 "load ${devtype} ${devnum}:${distro_bootpart} "           \
 129                         "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; "      \
 130                 "if fdt addr ${fdt_addr_r}; then "                        \
 131                         "bootefi ${kernel_addr_r} ${fdt_addr_r};"         \
 132                 "else "                                                   \
 133                         "bootefi ${kernel_addr_r} ${fdtcontroladdr};"     \
 134                 "fi\0"                                                    \
 135         \
 136         "load_efi_dtb="                                                   \
 137                 "load ${devtype} ${devnum}:${distro_bootpart} "           \
 138                         "${fdt_addr_r} ${prefix}${efi_fdtfile}\0"         \
 139         \
 140         "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0"                        \
 141         "scan_dev_for_efi="                                               \
 142                 "setenv efi_fdtfile ${fdtfile}; "                         \
 143                 BOOTENV_EFI_SET_FDTFILE_FALLBACK                          \
 144                 "for prefix in ${efi_dtb_prefixes}; do "                  \
 145                         "if test -e ${devtype} "                          \
 146                                         "${devnum}:${distro_bootpart} "   \
 147                                         "${prefix}${efi_fdtfile}; then "  \
 148                                 "run load_efi_dtb; "                      \
 149                         "fi;"                                             \
 150                 "done;"                                                   \
 151                 "if test -e ${devtype} ${devnum}:${distro_bootpart} "     \
 152                                         "efi/boot/"BOOTEFI_NAME"; then "  \
 153                                 "echo Found EFI removable media binary "  \
 154                                         "efi/boot/"BOOTEFI_NAME"; "       \
 155                                 "run boot_efi_binary; "                   \
 156                                 "echo EFI LOAD FAILED: continuing...; "   \
 157                 "fi; "                                                    \
 158                 "setenv efi_fdtfile\0"
 159 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
 160 #else
 161 #define BOOTENV_SHARED_EFI
 162 #define SCAN_DEV_FOR_EFI
 163 #endif
 164
 165 #ifdef CONFIG_SATA
 166 #define BOOTENV_SHARED_SATA     BOOTENV_SHARED_BLKDEV(sata)
 167 #define BOOTENV_DEV_SATA        BOOTENV_DEV_BLKDEV
 168 #define BOOTENV_DEV_NAME_SATA   BOOTENV_DEV_NAME_BLKDEV
 169 #else
 170 #define BOOTENV_SHARED_SATA
 171 #define BOOTENV_DEV_SATA \
 172         BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
 173 #define BOOTENV_DEV_NAME_SATA \
 174         BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
 175 #endif
 176
 177 #ifdef CONFIG_SCSI
 178 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
 179 #define BOOTENV_SET_SCSI_NEED_INIT "setenv scsi_need_init; "
 180 #define BOOTENV_SHARED_SCSI \
 181         "scsi_init=" \
 182                 "if ${scsi_need_init}; then " \
 183                         "setenv scsi_need_init false; " \
 184                         "scsi scan; " \
 185                 "fi\0" \
 186         \
 187         "scsi_boot=" \
 188                 BOOTENV_RUN_SCSI_INIT \
 189                 BOOTENV_SHARED_BLKDEV_BODY(scsi)
 190 #define BOOTENV_DEV_SCSI        BOOTENV_DEV_BLKDEV
 191 #define BOOTENV_DEV_NAME_SCSI   BOOTENV_DEV_NAME_BLKDEV
 192 #else
 193 #define BOOTENV_RUN_SCSI_INIT
 194 #define BOOTENV_SET_SCSI_NEED_INIT
 195 #define BOOTENV_SHARED_SCSI
 196 #define BOOTENV_DEV_SCSI \
 197         BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
 198 #define BOOTENV_DEV_NAME_SCSI \
 199         BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
 200 #endif
 201
 202 #ifdef CONFIG_IDE
 203 #define BOOTENV_SHARED_IDE      BOOTENV_SHARED_BLKDEV(ide)
 204 #define BOOTENV_DEV_IDE         BOOTENV_DEV_BLKDEV
 205 #define BOOTENV_DEV_NAME_IDE    BOOTENV_DEV_NAME_BLKDEV
 206 #else
 207 #define BOOTENV_SHARED_IDE
 208 #define BOOTENV_DEV_IDE \
 209         BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
 210 #define BOOTENV_DEV_NAME_IDE \
 211         BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
 212 #endif
 213
 214 #if defined(CONFIG_DM_PCI)
 215 #define BOOTENV_RUN_NET_PCI_ENUM "run boot_net_pci_enum; "
 216 #define BOOTENV_SHARED_PCI \
 217         "boot_net_pci_enum=pci enum\0"
 218 #else
 219 #define BOOTENV_RUN_NET_PCI_ENUM
 220 #define BOOTENV_SHARED_PCI
 221 #endif
 222
 223 #ifdef CONFIG_CMD_USB
 224 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
 225 #define BOOTENV_SHARED_USB \
 226         "boot_net_usb_start=usb start\0" \
 227         "usb_boot=" \
 228                 "usb start; " \
 229                 BOOTENV_SHARED_BLKDEV_BODY(usb)
 230 #define BOOTENV_DEV_USB         BOOTENV_DEV_BLKDEV
 231 #define BOOTENV_DEV_NAME_USB    BOOTENV_DEV_NAME_BLKDEV
 232 #else
 233 #define BOOTENV_RUN_NET_USB_START
 234 #define BOOTENV_SHARED_USB
 235 #define BOOTENV_DEV_USB \
 236         BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
 237 #define BOOTENV_DEV_NAME_USB \
 238         BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
 239 #endif
 240
 241 #if defined(CONFIG_CMD_DHCP)
 242 #if defined(CONFIG_EFI_LOADER)
 243 #if defined(CONFIG_ARM64)
 244 #define BOOTENV_EFI_PXE_ARCH "0xb"
 245 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
 246 #elif defined(CONFIG_ARM)
 247 #define BOOTENV_EFI_PXE_ARCH "0xa"
 248 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
 249 #elif defined(CONFIG_X86)
 250 /* Always assume we're running 64bit */
 251 #define BOOTENV_EFI_PXE_ARCH "0x7"
 252 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
 253 #else
 254 #error Please specify an EFI client identifier
 255 #endif
 256
 257 /*
 258  * Ask the dhcp server for an EFI binary. If we get one, check for a
 259  * device tree in the same folder. Then boot everything. If the file was
 260  * not an EFI binary, we just return from the bootefi command and continue.
 261  */
 262 #define BOOTENV_EFI_RUN_DHCP \
 263         "setenv efi_fdtfile ${fdtfile}; "                                 \
 264         BOOTENV_EFI_SET_FDTFILE_FALLBACK                                  \
 265         "setenv efi_old_vci ${bootp_vci};"                                \
 266         "setenv efi_old_arch ${bootp_arch};"                              \
 267         "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";"                       \
 268         "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";"                     \
 269         "if dhcp ${kernel_addr_r}; then "                                 \
 270                 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};"              \
 271                 "if fdt addr ${fdt_addr_r}; then "                        \
 272                         "bootefi ${kernel_addr_r} ${fdt_addr_r}; "        \
 273                 "else "                                                   \
 274                         "bootefi ${kernel_addr_r} ${fdtcontroladdr};"     \
 275                 "fi;"                                                     \
 276         "fi;"                                                             \
 277         "setenv bootp_vci ${efi_old_vci};"                                \
 278         "setenv bootp_arch ${efi_old_arch};"                              \
 279         "setenv efi_fdtfile;"                                             \
 280         "setenv efi_old_arch;"                                            \
 281         "setenv efi_old_vci;"
 282 #else
 283 #define BOOTENV_EFI_RUN_DHCP
 284 #endif
 285 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
 286         "bootcmd_dhcp=" \
 287                 BOOTENV_RUN_NET_USB_START \
 288                 BOOTENV_RUN_NET_PCI_ENUM \
 289                 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
 290                         "source ${scriptaddr}; " \
 291                 "fi;" \
 292                 BOOTENV_EFI_RUN_DHCP \
 293                 "\0"
 294 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
 295         "dhcp "
 296 #else
 297 #define BOOTENV_DEV_DHCP \
 298         BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
 299 #define BOOTENV_DEV_NAME_DHCP \
 300         BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
 301 #endif
 302
 303 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
 304 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
 305         "bootcmd_pxe=" \
 306                 BOOTENV_RUN_NET_USB_START \
 307                 BOOTENV_RUN_NET_PCI_ENUM \
 308                 "dhcp; " \
 309                 "if pxe get; then " \
 310                         "pxe boot; " \
 311                 "fi\0"
 312 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
 313         "pxe "
 314 #else
 315 #define BOOTENV_DEV_PXE \
 316         BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
 317 #define BOOTENV_DEV_NAME_PXE \
 318         BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
 319 #endif
 320
 321 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
 322         BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
 323 #define BOOTENV_BOOT_TARGETS \
 324         "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
 325
 326 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
 327         BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
 328 #define BOOTENV \
 329         BOOTENV_SHARED_HOST \
 330         BOOTENV_SHARED_MMC \
 331         BOOTENV_SHARED_PCI \
 332         BOOTENV_SHARED_USB \
 333         BOOTENV_SHARED_SATA \
 334         BOOTENV_SHARED_SCSI \
 335         BOOTENV_SHARED_IDE \
 336         BOOTENV_SHARED_UBIFS \
 337         BOOTENV_SHARED_EFI \
 338         "boot_prefixes=/ /boot/\0" \
 339         "boot_scripts=boot.scr.uimg boot.scr\0" \
 340         "boot_script_dhcp=boot.scr.uimg\0" \
 341         BOOTENV_BOOT_TARGETS \
 342         \
 343         "boot_extlinux="                                                  \
 344                 "sysboot ${devtype} ${devnum}:${distro_bootpart} any "    \
 345                         "${scriptaddr} ${prefix}extlinux/extlinux.conf\0" \
 346         \
 347         "scan_dev_for_extlinux="                                          \
 348                 "if test -e ${devtype} "                                  \
 349                                 "${devnum}:${distro_bootpart} "           \
 350                                 "${prefix}extlinux/extlinux.conf; then "  \
 351                         "echo Found ${prefix}extlinux/extlinux.conf; "    \
 352                         "run boot_extlinux; "                             \
 353                         "echo SCRIPT FAILED: continuing...; "             \
 354                 "fi\0"                                                    \
 355         \
 356         "boot_a_script="                                                  \
 357                 "load ${devtype} ${devnum}:${distro_bootpart} "           \
 358                         "${scriptaddr} ${prefix}${script}; "              \
 359                 "source ${scriptaddr}\0"                                  \
 360         \
 361         "scan_dev_for_scripts="                                           \
 362                 "for script in ${boot_scripts}; do "                      \
 363                         "if test -e ${devtype} "                          \
 364                                         "${devnum}:${distro_bootpart} "   \
 365                                         "${prefix}${script}; then "       \
 366                                 "echo Found U-Boot script "               \
 367                                         "${prefix}${script}; "            \
 368                                 "run boot_a_script; "                     \
 369                                 "echo SCRIPT FAILED: continuing...; "     \
 370                         "fi; "                                            \
 371                 "done\0"                                                  \
 372         \
 373         "scan_dev_for_boot="                                              \
 374                 "echo Scanning ${devtype} "                               \
 375                                 "${devnum}:${distro_bootpart}...; "       \
 376                 "for prefix in ${boot_prefixes}; do "                     \
 377                         "run scan_dev_for_extlinux; "                     \
 378                         "run scan_dev_for_scripts; "                      \
 379                 "done;"                                                   \
 380                 SCAN_DEV_FOR_EFI                                          \
 381                 "\0"                                                      \
 382         \
 383         "scan_dev_for_boot_part="                                         \
 384                 "part list ${devtype} ${devnum} -bootable devplist; "     \
 385                 "env exists devplist || setenv devplist 1; "              \
 386                 "for distro_bootpart in ${devplist}; do "                 \
 387                         "if fstype ${devtype} "                           \
 388                                         "${devnum}:${distro_bootpart} "   \
 389                                         "bootfstype; then "               \
 390                                 "run scan_dev_for_boot; "                 \
 391                         "fi; "                                            \
 392                 "done\0"                                                  \
 393         \
 394         BOOT_TARGET_DEVICES(BOOTENV_DEV)                                  \
 395         \
 396         "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT                      \
 397                 "for target in ${boot_targets}; do "                      \
 398                         "run bootcmd_${target}; "                         \
 399                 "done\0"
 400
 401 #ifndef CONFIG_BOOTCOMMAND
 402 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
 403 #endif
 404
 405 #endif  /* _CONFIG_CMD_DISTRO_BOOTCMD_H */