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 #endif
  95 #endif
  96
  97 #ifdef BOOTEFI_NAME
  98 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
  99 /*
 100  * On 32bit ARM systems there is a reasonable number of systems that follow
 101  * the $soc-$board$boardver.dtb name scheme for their device trees. Use that
 102  * scheme if we don't have an explicit fdtfile variable.
 103  */
 104 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK                                  \
 105         "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then "               \
 106           "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; "           \
 107         "fi; "
 108 #else
 109 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
 110 #endif
 111
 112
 113 #define BOOTENV_SHARED_EFI                                                \
 114         "boot_efi_binary="                                                \
 115                 "if fdt addr ${fdt_addr_r}; then "                        \
 116                         "bootefi bootmgr ${fdt_addr_r};"                  \
 117                 "else "                                                   \
 118                         "bootefi bootmgr ${fdtcontroladdr};"              \
 119                 "fi;"                                                     \
 120                 "load ${devtype} ${devnum}:${distro_bootpart} "           \
 121                         "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; "      \
 122                 "if fdt addr ${fdt_addr_r}; then "                        \
 123                         "bootefi ${kernel_addr_r} ${fdt_addr_r};"         \
 124                 "else "                                                    \
 125                         "bootefi ${kernel_addr_r} ${fdtcontroladdr};"     \
 126                 "fi\0"                                                    \
 127         \
 128         "load_efi_dtb="                                                   \
 129                 "load ${devtype} ${devnum}:${distro_bootpart} "           \
 130                         "${fdt_addr_r} ${prefix}${efi_fdtfile}\0"         \
 131         \
 132         "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0"                        \
 133         "scan_dev_for_efi="                                               \
 134                 "setenv efi_fdtfile ${fdtfile}; "                         \
 135                 BOOTENV_EFI_SET_FDTFILE_FALLBACK                          \
 136                 "for prefix in ${efi_dtb_prefixes}; do "                  \
 137                         "if test -e ${devtype} "                          \
 138                                         "${devnum}:${distro_bootpart} "   \
 139                                         "${prefix}${efi_fdtfile}; then "  \
 140                                 "run load_efi_dtb; "                      \
 141                         "fi;"                                             \
 142                 "done;"                                                   \
 143                 "if test -e ${devtype} ${devnum}:${distro_bootpart} "     \
 144                                         "efi/boot/"BOOTEFI_NAME"; then "  \
 145                                 "echo Found EFI removable media binary "  \
 146                                         "efi/boot/"BOOTEFI_NAME"; "       \
 147                                 "run boot_efi_binary; "                   \
 148                                 "echo EFI LOAD FAILED: continuing...; "   \
 149                 "fi; "                                                    \
 150                 "setenv efi_fdtfile\0"
 151 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
 152 #else
 153 #define BOOTENV_SHARED_EFI
 154 #define SCAN_DEV_FOR_EFI
 155 #endif
 156
 157 #ifdef CONFIG_SATA
 158 #define BOOTENV_SHARED_SATA     BOOTENV_SHARED_BLKDEV(sata)
 159 #define BOOTENV_DEV_SATA        BOOTENV_DEV_BLKDEV
 160 #define BOOTENV_DEV_NAME_SATA   BOOTENV_DEV_NAME_BLKDEV
 161 #else
 162 #define BOOTENV_SHARED_SATA
 163 #define BOOTENV_DEV_SATA \
 164         BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
 165 #define BOOTENV_DEV_NAME_SATA \
 166         BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
 167 #endif
 168
 169 #ifdef CONFIG_SCSI
 170 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
 171 #define BOOTENV_SET_SCSI_NEED_INIT "setenv scsi_need_init; "
 172 #define BOOTENV_SHARED_SCSI \
 173         "scsi_init=" \
 174                 "if ${scsi_need_init}; then " \
 175                         "setenv scsi_need_init false; " \
 176                         "scsi scan; " \
 177                 "fi\0" \
 178         \
 179         "scsi_boot=" \
 180                 BOOTENV_RUN_SCSI_INIT \
 181                 BOOTENV_SHARED_BLKDEV_BODY(scsi)
 182 #define BOOTENV_DEV_SCSI        BOOTENV_DEV_BLKDEV
 183 #define BOOTENV_DEV_NAME_SCSI   BOOTENV_DEV_NAME_BLKDEV
 184 #else
 185 #define BOOTENV_RUN_SCSI_INIT
 186 #define BOOTENV_SET_SCSI_NEED_INIT
 187 #define BOOTENV_SHARED_SCSI
 188 #define BOOTENV_DEV_SCSI \
 189         BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
 190 #define BOOTENV_DEV_NAME_SCSI \
 191         BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
 192 #endif
 193
 194 #ifdef CONFIG_IDE
 195 #define BOOTENV_SHARED_IDE      BOOTENV_SHARED_BLKDEV(ide)
 196 #define BOOTENV_DEV_IDE         BOOTENV_DEV_BLKDEV
 197 #define BOOTENV_DEV_NAME_IDE    BOOTENV_DEV_NAME_BLKDEV
 198 #else
 199 #define BOOTENV_SHARED_IDE
 200 #define BOOTENV_DEV_IDE \
 201         BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
 202 #define BOOTENV_DEV_NAME_IDE \
 203         BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
 204 #endif
 205
 206 #if defined(CONFIG_DM_PCI)
 207 #define BOOTENV_RUN_NET_PCI_ENUM "run boot_net_pci_enum; "
 208 #define BOOTENV_SHARED_PCI \
 209         "boot_net_pci_enum=pci enum\0"
 210 #else
 211 #define BOOTENV_RUN_NET_PCI_ENUM
 212 #define BOOTENV_SHARED_PCI
 213 #endif
 214
 215 #ifdef CONFIG_CMD_USB
 216 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
 217 #define BOOTENV_SHARED_USB \
 218         "boot_net_usb_start=usb start\0" \
 219         "usb_boot=" \
 220                 "usb start; " \
 221                 BOOTENV_SHARED_BLKDEV_BODY(usb)
 222 #define BOOTENV_DEV_USB         BOOTENV_DEV_BLKDEV
 223 #define BOOTENV_DEV_NAME_USB    BOOTENV_DEV_NAME_BLKDEV
 224 #else
 225 #define BOOTENV_RUN_NET_USB_START
 226 #define BOOTENV_SHARED_USB
 227 #define BOOTENV_DEV_USB \
 228         BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
 229 #define BOOTENV_DEV_NAME_USB \
 230         BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
 231 #endif
 232
 233 #if defined(CONFIG_CMD_DHCP)
 234 #if defined(CONFIG_EFI_LOADER)
 235 #if defined(CONFIG_ARM64)
 236 #define BOOTENV_EFI_PXE_ARCH "0xb"
 237 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
 238 #elif defined(CONFIG_ARM)
 239 #define BOOTENV_EFI_PXE_ARCH "0xa"
 240 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
 241 #elif defined(CONFIG_X86)
 242 /* Always assume we're running 64bit */
 243 #define BOOTENV_EFI_PXE_ARCH "0x7"
 244 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
 245 #else
 246 #error Please specify an EFI client identifier
 247 #endif
 248
 249 /*
 250  * Ask the dhcp server for an EFI binary. If we get one, check for a
 251  * device tree in the same folder. Then boot everything. If the file was
 252  * not an EFI binary, we just return from the bootefi command and continue.
 253  */
 254 #define BOOTENV_EFI_RUN_DHCP \
 255         "setenv efi_fdtfile ${fdtfile}; "                                 \
 256         BOOTENV_EFI_SET_FDTFILE_FALLBACK                                  \
 257         "setenv efi_old_vci ${bootp_vci};"                                \
 258         "setenv efi_old_arch ${bootp_arch};"                              \
 259         "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";"                       \
 260         "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";"                     \
 261         "if dhcp ${kernel_addr_r}; then "                                 \
 262                 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};"              \
 263                 "if fdt addr ${fdt_addr_r}; then "                        \
 264                         "bootefi ${kernel_addr_r} ${fdt_addr_r}; "        \
 265                 "else "                                                   \
 266                         "bootefi ${kernel_addr_r} ${fdtcontroladdr};"     \
 267                 "fi;"                                                     \
 268         "fi;"                                                             \
 269         "setenv bootp_vci ${efi_old_vci};"                                \
 270         "setenv bootp_arch ${efi_old_arch};"                              \
 271         "setenv efi_fdtfile;"                                             \
 272         "setenv efi_old_arch;"                                            \
 273         "setenv efi_old_vci;"
 274 #else
 275 #define BOOTENV_EFI_RUN_DHCP
 276 #endif
 277 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
 278         "bootcmd_dhcp=" \
 279                 BOOTENV_RUN_NET_USB_START \
 280                 BOOTENV_RUN_NET_PCI_ENUM \
 281                 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
 282                         "source ${scriptaddr}; " \
 283                 "fi;" \
 284                 BOOTENV_EFI_RUN_DHCP \
 285                 "\0"
 286 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
 287         "dhcp "
 288 #else
 289 #define BOOTENV_DEV_DHCP \
 290         BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
 291 #define BOOTENV_DEV_NAME_DHCP \
 292         BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
 293 #endif
 294
 295 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
 296 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
 297         "bootcmd_pxe=" \
 298                 BOOTENV_RUN_NET_USB_START \
 299                 BOOTENV_RUN_NET_PCI_ENUM \
 300                 "dhcp; " \
 301                 "if pxe get; then " \
 302                         "pxe boot; " \
 303                 "fi\0"
 304 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
 305         "pxe "
 306 #else
 307 #define BOOTENV_DEV_PXE \
 308         BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
 309 #define BOOTENV_DEV_NAME_PXE \
 310         BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
 311 #endif
 312
 313 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
 314         BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
 315 #define BOOTENV_BOOT_TARGETS \
 316         "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
 317
 318 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
 319         BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
 320 #define BOOTENV \
 321         BOOTENV_SHARED_HOST \
 322         BOOTENV_SHARED_MMC \
 323         BOOTENV_SHARED_PCI \
 324         BOOTENV_SHARED_USB \
 325         BOOTENV_SHARED_SATA \
 326         BOOTENV_SHARED_SCSI \
 327         BOOTENV_SHARED_IDE \
 328         BOOTENV_SHARED_UBIFS \
 329         BOOTENV_SHARED_EFI \
 330         "boot_prefixes=/ /boot/\0" \
 331         "boot_scripts=boot.scr.uimg boot.scr\0" \
 332         "boot_script_dhcp=boot.scr.uimg\0" \
 333         BOOTENV_BOOT_TARGETS \
 334         \
 335         "boot_extlinux="                                                  \
 336                 "sysboot ${devtype} ${devnum}:${distro_bootpart} any "    \
 337                         "${scriptaddr} ${prefix}extlinux/extlinux.conf\0" \
 338         \
 339         "scan_dev_for_extlinux="                                          \
 340                 "if test -e ${devtype} "                                  \
 341                                 "${devnum}:${distro_bootpart} "           \
 342                                 "${prefix}extlinux/extlinux.conf; then "  \
 343                         "echo Found ${prefix}extlinux/extlinux.conf; "    \
 344                         "run boot_extlinux; "                             \
 345                         "echo SCRIPT FAILED: continuing...; "             \
 346                 "fi\0"                                                    \
 347         \
 348         "boot_a_script="                                                  \
 349                 "load ${devtype} ${devnum}:${distro_bootpart} "           \
 350                         "${scriptaddr} ${prefix}${script}; "              \
 351                 "source ${scriptaddr}\0"                                  \
 352         \
 353         "scan_dev_for_scripts="                                           \
 354                 "for script in ${boot_scripts}; do "                      \
 355                         "if test -e ${devtype} "                          \
 356                                         "${devnum}:${distro_bootpart} "   \
 357                                         "${prefix}${script}; then "       \
 358                                 "echo Found U-Boot script "               \
 359                                         "${prefix}${script}; "            \
 360                                 "run boot_a_script; "                     \
 361                                 "echo SCRIPT FAILED: continuing...; "     \
 362                         "fi; "                                            \
 363                 "done\0"                                                  \
 364         \
 365         "scan_dev_for_boot="                                              \
 366                 "echo Scanning ${devtype} "                               \
 367                                 "${devnum}:${distro_bootpart}...; "       \
 368                 "for prefix in ${boot_prefixes}; do "                     \
 369                         "run scan_dev_for_extlinux; "                     \
 370                         "run scan_dev_for_scripts; "                      \
 371                 "done;"                                                   \
 372                 SCAN_DEV_FOR_EFI                                          \
 373                 "\0"                                                      \
 374         \
 375         "scan_dev_for_boot_part="                                         \
 376                 "part list ${devtype} ${devnum} -bootable devplist; "     \
 377                 "env exists devplist || setenv devplist 1; "              \
 378                 "for distro_bootpart in ${devplist}; do "                 \
 379                         "if fstype ${devtype} "                           \
 380                                         "${devnum}:${distro_bootpart} "   \
 381                                         "bootfstype; then "               \
 382                                 "run scan_dev_for_boot; "                 \
 383                         "fi; "                                            \
 384                 "done\0"                                                  \
 385         \
 386         BOOT_TARGET_DEVICES(BOOTENV_DEV)                                  \
 387         \
 388         "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT                      \
 389                 "for target in ${boot_targets}; do "                      \
 390                         "run bootcmd_${target}; "                         \
 391                 "done\0"
 392
 393 #ifndef CONFIG_BOOTCOMMAND
 394 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
 395 #endif
 396
 397 #endif  /* _CONFIG_CMD_DISTRO_BOOTCMD_H */