From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-19.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 161F0C433F5 for ; Thu, 9 Sep 2021 20:10:54 +0000 (UTC) Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 7971E61179 for ; Thu, 9 Sep 2021 20:10:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 7971E61179 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=chromium.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=lists.denx.de Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 3743683549; Thu, 9 Sep 2021 22:10:49 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; unprotected) header.d=chromium.org header.i=@chromium.org header.b="OTo/ggw3"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id AB18283543; Thu, 9 Sep 2021 22:10:43 +0200 (CEST) Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id A95F583545 for ; Thu, 9 Sep 2021 22:10:39 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=sjg@chromium.org Received: by mail-wr1-x432.google.com with SMTP id z4so4251913wrr.6 for ; Thu, 09 Sep 2021 13:10:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=D/UwSz05KU2ocUc3gZJ4qYhQeME9nx3zM2KTCSR1pxw=; b=OTo/ggw3RzuGwwgCsKj/USj+Hl+RTVRQ4uO3/8ar6PEqLDhQ6v5E6C9iDJ5zw+SA1m XTtWYL6TwewBvmPovvF52UW69LmLei3s9jXBnntKJ20b5plKA8cqGNwK9UW1RnOuNY1Y X+u5if3k1B7MBG8EEqH2NwNxeEwCXSwDyx8P0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=D/UwSz05KU2ocUc3gZJ4qYhQeME9nx3zM2KTCSR1pxw=; b=x8TOphX+9ZrvnifuVqr/G9qOn2tE5d/fapCX9K4oE50EJzGKQGqGiz6cFDuP3ajKaW NThJZfNc8fFBml6LFM9HzQWwevsVUb5qFDQwRFXd0zh6hhSI0xVlpL+GQeWmYfGTknBf h1ZgdLF/U3awcNkN1PV2VML4RnAgp4sUSu+zOfBJT9mmAJBGJ8LGMc+B+WNFFGO45/ow Ksb8VHS/jr4s1R29lQOGSSsXB00gJmL1KXJ98E9VV+3Kd04/5sVIYHaaBmPsqY4OvXYK bNWHWM3kclETcvViylinhp8vaIScHGF49KnsM5FyUILam2BnxrfSnrgVO3H0r/8jc5sG xNJw== X-Gm-Message-State: AOAM5333kr3e4GeKiJM9ht9Tjqolfut0mOYX4QlkhCqhNm3snQcJf615 lMmwHqpbJGo85Sc3tTYGDpESlDb1y7sHZg== X-Google-Smtp-Source: ABdhPJx6o/d3ARtXfhVOA2zRRvZ52sF7XDsh39N8hbBWUNXAbyhXaxCnwsSV3rPAeZHFmsx6ptFVkg== X-Received: by 2002:a5d:58e9:: with SMTP id f9mr5604316wrd.154.1631218238839; Thu, 09 Sep 2021 13:10:38 -0700 (PDT) Received: from sjg1.guest.simonstonehall.com ([51.52.197.18]) by smtp.gmail.com with ESMTPSA id j25sm2723704wrc.12.2021.09.09.13.10.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 09 Sep 2021 13:10:38 -0700 (PDT) From: Simon Glass To: U-Boot Mailing List Cc: Sean Anderson , Mark Kettenis , Heinrich Schuchardt , Ilias Apalodimas , =?UTF-8?q?Fran=C3=A7ois=20Ozog?= , Tom Rini , Bill Mills , Simon Glass , Marcel Ziswiler Subject: [PATCH v3 1/3] doc: Tidy up the bindings for the config/ node Date: Thu, 9 Sep 2021 14:10:31 -0600 Message-Id: <20210909201033.755713-2-sjg@chromium.org> X-Mailer: git-send-email 2.33.0.309.g3052b89438-goog In-Reply-To: <20210909201033.755713-1-sjg@chromium.org> References: <20210909201033.755713-1-sjg@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.2 at phobos.denx.de X-Virus-Status: Clean Sort these and add a type so it is clear how to set the value. Add a note about usage to the top. Correct the 'no-keyboard' binding which is missing a prefix. Signed-off-by: Simon Glass Reviewed-by: Marcel Ziswiler --- Note that some uses a u-boot prefix and some don't. Once [1] is applied we may want to update this to always use the prefix, or never. Another option would be to call the node u-boot,config. and drop the prefix. This has the advantage of complying with the devicetree spec, at little cost. [1] https://patchwork.ozlabs.org/project/uboot/patch/20210807132413.3513724-2-sjg@chromium.org/ Changes in v3: - Add missing period Changes in v2: - Add a new patch to tidy up the /config bindings doc/device-tree-bindings/config.txt | 46 ++++++++++++++++------------- 1 file changed, 26 insertions(+), 20 deletions(-) diff --git a/doc/device-tree-bindings/config.txt b/doc/device-tree-bindings/config.txt index 6cdc16da5b5..f704eb695f5 100644 --- a/doc/device-tree-bindings/config.txt +++ b/doc/device-tree-bindings/config.txt @@ -5,15 +5,15 @@ A number of run-time configuration options are provided in the /config node of the control device tree. You can access these using fdtdec_get_config_int(), fdtdec_get_config_bool() and fdtdec_get_config_string(). -Available options are: - -silent-console - If present and non-zero, the console is silenced by default on boot. +These options are designed to affect the operation of U-Boot at runtime. +Runtime-configuration items can help avoid proliferation of different builds +with only minor changes, e.g. enabling and disabling console output. Items +here should be those that can usefully be set by the build system after U-Boot +is built. -no-keyboard - Tells U-Boot not to expect an attached keyboard with a VGA console +Available options are: -u-boot,efi-partition-entries-offset +u-boot,efi-partition-entries-offset (int) If present, this provides an offset (in bytes, from the start of a device) that should be skipped over before the partition entries. This is used by the EFI/GPT partition implementation when a device @@ -21,17 +21,8 @@ u-boot,efi-partition-entries-offset This setting will override any values configured via Kconfig. -u-boot,mmc-env-partition - if present, the environment shall be placed at the last - CONFIG_ENV_SIZE blocks of the partition on the - CONFIG_SYS_MMC_ENV_DEV. - - if u-boot,mmc-env-offset* is present, this setting will take - precedence. In that case, only if the partition is not found, - mmc-env-offset* will be tried. - -u-boot,mmc-env-offset -u-boot,mmc-env-offset-redundant +u-boot,mmc-env-offset (int) +u-boot,mmc-env-offset-redundant (int) If present, the values of the 'u-boot,mmc-env-offset' and/or of the u-boot,mmc-env-offset-redundant' properties overrides CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND, respectively, @@ -42,12 +33,27 @@ u-boot,mmc-env-offset-redundant will point at the beginning of a LBA and values that are not LBA-aligned will be rounded up to the next LBA address. -u-boot,spl-payload-offset +u-boot,mmc-env-partition (int) + if present, the environment shall be placed at the last + CONFIG_ENV_SIZE blocks of the partition on the + CONFIG_SYS_MMC_ENV_DEV. + + if u-boot,mmc-env-offset* is present, this setting will take + precedence. In that case, only if the partition is not found, + mmc-env-offset* will be tried. + +u-boot,no-keyboard (bool) + Tells U-Boot not to expect an attached keyboard with a VGA console. + +silent-console (int) + If present and non-zero, the console is silenced by default on boot. + +u-boot,spl-payload-offset (int) If present (and SPL is controlled by the device-tree), this allows to override the CONFIG_SYS_SPI_U_BOOT_OFFS setting using a value from the device-tree. -sysreset-gpio +sysreset-gpio (string) If present (and supported by the specific board), indicates a GPIO that can be set to trigger a system reset. It is assumed that such a system reset will effect a complete platform reset, -- 2.33.0.309.g3052b89438-goog