LXR uboot/include/config_distro

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