include/config_distro_bootcmd.h

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