From patchwork Sat Mar 21 13:15:38 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Karsten Merker X-Patchwork-Id: 452939 X-Patchwork-Delegate: trini@ti.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from theia.denx.de (theia.denx.de [85.214.87.163]) by ozlabs.org (Postfix) with ESMTP id DCDEA140134 for ; Sun, 22 Mar 2015 00:16:29 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 8C45F4B62B; Sat, 21 Mar 2015 14:16:28 +0100 (CET) Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 3STnK7SLqWmA; Sat, 21 Mar 2015 14:16:28 +0100 (CET) Received: from theia.denx.de (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 202104A046; Sat, 21 Mar 2015 14:16:28 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id A7B5C4A039 for ; Sat, 21 Mar 2015 14:16:19 +0100 (CET) Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id BV3OBbmbL9pj for ; Sat, 21 Mar 2015 14:16:19 +0100 (CET) X-policyd-weight: NOT_IN_SBL_XBL_SPAMHAUS=-1.5 NOT_IN_SPAMCOP=-1.5 NOT_IN_BL_NJABL=-1.5 (only DNSBL check requested) Received: from mout.kundenserver.de (mout.kundenserver.de [212.227.17.10]) by theia.denx.de (Postfix) with ESMTPS id 04B98A7428 for ; Sat, 21 Mar 2015 14:16:15 +0100 (CET) Received: from excalibur.cnev.de ([84.44.187.62]) by mrelayeu.kundenserver.de (mreue104) with ESMTPSA (Nemesis) id 0MSrBt-1YyE0O3EDV-00Rq19; Sat, 21 Mar 2015 14:16:05 +0100 Received: from localhost ([127.0.0.1] helo=excalibur.cnev.de) by excalibur.cnev.de with esmtp (Exim 4.80) (envelope-from ) id 1YZJG0-0002Aq-O5; Sat, 21 Mar 2015 14:16:04 +0100 From: Karsten Merker To: Stephen Warren , Tom Rini Date: Sat, 21 Mar 2015 14:15:38 +0100 Message-Id: <1426943738-8326-2-git-send-email-merker@debian.org> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1426943738-8326-1-git-send-email-merker@debian.org> References: <550B395E.40509@wwwdotorg.org> <1426943738-8326-1-git-send-email-merker@debian.org> X-Provags-ID: V03:K0:4PntkChYPEMVU5HDNliZc2DuB8V85pbgn+7Xo6b02HcBoBqxQ7Y 5v1knNPx5P4wtqF+97CdjUIezwwpGbBzFNeoEeha8iZ5uP1Cbd00Gmt/rINAb7mUiYBhR9Q BdgFyOGkIcQE9rzsiyFhD1Wxo9A9BzpsmcGhOpZd8T8FRnbibk/PjkgcC47Wt7hG3RIQBth 7vdoKNxe3yAkczKcnY6Cw== X-UI-Out-Filterresults: notjunk:1; Cc: Dennis Gilmore , u-boot@lists.denx.de, Karsten Merker Subject: [U-Boot] [PATCH V2] Document config_distro_bootcmd environment variables for interactive booting. X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.15 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" config_distro_bootcmd.h defines a common boot environment for multiple platforms, including several environment variables that are intended for interactive use by an end-user. Document which variables are considered public interfaces that must remain compatible in future u-boot versions. Signed-off-by: Karsten Merker Acked-by: Stephen Warren --- doc/README.distro | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/doc/README.distro b/doc/README.distro index dd0f1c7..0308a4c 100644 --- a/doc/README.distro +++ b/doc/README.distro @@ -1,6 +1,7 @@ /* * (C) Copyright 2014 Red Hat Inc. * Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved. + * Copyright (C) 2015 K. Merker * * SPDX-License-Identifier: GPL-2.0+ */ @@ -339,3 +340,49 @@ scan_dev_for_scripts: If you want to disable boot.scr on all disks, set the value to something innocuous, e.g. setenv scan_dev_for_scripts true. + + +Interactively booting from a specific device at the u-boot prompt +================================================================= + +For interactively booting from a user-selected device at the u-boot command +prompt, the environment provides predefined bootcmd_ variables for +every target defined in boot_targets, which can be run be the user. + +If the target is a storage device, the format of the target is always +, e.g. mmc0. Specifying the device number is +mandatory for storage devices, even if only support for a single instance +of the storage device is actually implemented. + +For network targets (dhcp, pxe), only the device type gets specified; +they do not have a device number. + +Examples: + + - run bootcmd_usb0 + boots from the first USB mass storage device + + - run bootcmd_mmc1 + boots from the second MMC device + + - run bootcmd_pxe + boots by tftp using a pxelinux.cfg + +The list of possible targets consists of: + +- network targets + * dhcp + * pxe + +- storage targets (to which a device number must be appended) + * mmc + * sata + * scsi + * ide + * usb + +Other *boot* variables than the ones defined above are only for internal use +of the boot environment and are not guaranteed to exist or work in the same +way in future u-boot versions. In particular the _boot +variables (e.g. mmc_boot, usb_boot) are a strictly internal implementation +detail and must not be used as a public interface.