Merge branch 'master' of git://git.denx.de/u-boot-socfpga

[platform/kernel/u-boot.git] / doc / README.distro

diff --git a/doc/README.distro b/doc/README.distro
index 019903e..f8e9752 100644 (file)
--- a/doc/README.distro
+++ b/doc/README.distro
@@ -1,9 +1,8 @@
+SPDX-License-Identifier: GPL-2.0+

 /*
  * (C) Copyright 2014 Red Hat Inc.
  * Copyright (c) 2014-2015, NVIDIA CORPORATION.  All rights reserved.
  * Copyright (C) 2015 K. Merker <merker@debian.org>
 /*
  * (C) Copyright 2014 Red Hat Inc.
  * Copyright (c) 2014-2015, NVIDIA CORPORATION.  All rights reserved.
  * Copyright (C) 2015 K. Merker <merker@debian.org>

- *
- * SPDX-License-Identifier:     GPL-2.0+

  */
 
 Generic Distro Configuration Concept
  */
 
 Generic Distro Configuration Concept


@@ -162,11 +161,15 @@ U-Boot Implementation
 Enabling the distro options
 ---------------------------
 
 Enabling the distro options
 ---------------------------
 

+In your board's defconfig, enable the DISTRO_DEFAULTS option by adding
+a line with "CONFIG_DISTRO_DEFAULTS=y". If you want to enable this
+from Kconfig itself, for e.g. all boards using a specific SoC then
+add a "imply DISTRO_DEFAULTS" to your SoC CONFIG option.
+

 In your board configuration file, include the following:
 
 ------------------------------------------------------------
 #ifndef CONFIG_SPL_BUILD
 In your board configuration file, include the following:
 
 ------------------------------------------------------------
 #ifndef CONFIG_SPL_BUILD

-#include <config_distro_defaults.h>

 #include <config_distro_bootcmd.h>
 #endif
 ------------------------------------------------------------
 #include <config_distro_bootcmd.h>
 #endif
 ------------------------------------------------------------


@@ -182,7 +185,7 @@ Finally, a few options that are mostly relevant only when using U-Boot-
 specific boot.scr scripts are enabled. This enables distros to generate a
 U-Boot-specific boot.scr script rather than extlinux.conf as the boot
 configuration file. While doing so is fully supported, and
 specific boot.scr scripts are enabled. This enables distros to generate a
 U-Boot-specific boot.scr script rather than extlinux.conf as the boot
 configuration file. While doing so is fully supported, and

-<config_distro_defaults.h> exposes enough parameterization to boot.scr to
+CONFIG_DISTRO_DEFAULTS exposes enough parameterization to boot.scr to

 allow for board-agnostic boot.scr content, this document recommends that
 distros generate extlinux.conf rather than boot.scr. extlinux.conf is intended
 to work across multiple bootloaders, whereas boot.scr will only work with
 allow for board-agnostic boot.scr content, this document recommends that
 distros generate extlinux.conf rather than boot.scr. extlinux.conf is intended
 to work across multiple bootloaders, whereas boot.scr will only work with


@@ -243,7 +246,7 @@ kernel_addr_r:
 
   A size of 16MB for the kernel is likely adequate.
 
 
   A size of 16MB for the kernel is likely adequate.
 

-pxe_addr_r:
+pxefile_addr_r:

 
   Mandatory. The location in RAM where extlinux.conf will be loaded to prior
   to processing.
 
   Mandatory. The location in RAM where extlinux.conf will be loaded to prior
   to processing.


@@ -349,6 +352,14 @@ boot_net_usb_start:
   device is not attached to USB, and you wish to increase boot speed by
   avoiding unnecessary actions.
 
   device is not attached to USB, and you wish to increase boot speed by
   avoiding unnecessary actions.
 

+boot_net_pci_enum:
+
+  If you want to prevent PCI enumeration by distro boot commands which execute
+  network operations, set the value to something innocuous, e.g. setenv
+  boot_net_pci_enum true. This would be useful if you know your Ethernet
+  device is not attached to PCI, and you wish to increase boot speed by
+  avoiding unnecessary actions.
+

 Interactively booting from a specific device at the u-boot prompt
 =================================================================
 
 Interactively booting from a specific device at the u-boot prompt
 =================================================================