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=-14.5 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,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 E9006C432BE for ; Sat, 28 Aug 2021 16:46:42 +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 195F560E97 for ; Sat, 28 Aug 2021 16:46:42 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 195F560E97 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 5A87F832FA; Sat, 28 Aug 2021 18:46: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=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="lLi4cl01"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 5FA87832FA; Sat, 28 Aug 2021 18:46:38 +0200 (CEST) Received: from mail-il1-x12f.google.com (mail-il1-x12f.google.com [IPv6:2607:f8b0:4864:20::12f]) (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 201D6829C3 for ; Sat, 28 Aug 2021 18:46:34 +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-il1-x12f.google.com with SMTP id z2so10776854iln.0 for ; Sat, 28 Aug 2021 09:46:34 -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:mime-version :content-transfer-encoding; bh=Bpc9FMIdWwG8/zFjWJtHaWaz2F1NObMQi/h2/wr+SlA=; b=lLi4cl01hUzI4RvjHKpoFjXQz03ZZp/pHGaBAX5w1ziuylpgM93qSOjYW2p/D+jar+ NBnN2Td/NWLZH4wgzjk+L4tk6olbnIHJhkBhAeovpVV5wuM9yjrpjNT+HiyFmHApw/Pn I7GAIyt0tYa+2nMvGad9m9FEiHFyAZn55b3YI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Bpc9FMIdWwG8/zFjWJtHaWaz2F1NObMQi/h2/wr+SlA=; b=XAPSUYJLzF1QH3CCGVOzw0YOuuAE5q0GSHMnM3CSat04MH3toguQlpqYGiQ1mVWy3V VZu+/5TlavzwjRPk8sClCiBgaVYJMUAAxzOkYXTOkqUne0lxklKCReBwLM1XVJO2TAMu 8K7xC0ft9oIInCxgGL3L21EnulBXyykCycDXwQdFmQBfOaZVD1dTJAie7JY8NlJa/rWd DtrwTiHyqyRYQjSLEuD+sG1p/288K6+pcZco7T+lNoBUYqsxmayZeSGS+xdsvQJHIPhV dtdCIe8798D4FJvEQxgMeFoE3kyYKqNaUDYqfYx7xZetAVlcjdPVz+wvYS0VVHZt6EgB qy7w== X-Gm-Message-State: AOAM532eaRmEOrfS9jZRNGDciXnmeRyQv2JQtg1LUeVH2F3VC1xdihjE esTYYH4sm/DjRo5u2Tlogs6U8DrLAqjQrA== X-Google-Smtp-Source: ABdhPJy8Cj1EnCeq8LwVZIs7fMGrrEUeJsrgmfP0g6MXNSeou+/xIV90TxfupBTvo3/HCl5qH3/BHw== X-Received: by 2002:a92:7114:: with SMTP id m20mr9976612ilc.114.1630169192166; Sat, 28 Aug 2021 09:46:32 -0700 (PDT) Received: from kiwi.bld.corp.google.com (c-67-190-101-114.hsd1.co.comcast.net. [67.190.101.114]) by smtp.gmail.com with ESMTPSA id x15sm5327378ilp.23.2021.08.28.09.46.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 28 Aug 2021 09:46:31 -0700 (PDT) From: Simon Glass To: U-Boot Mailing List Cc: Heinrich Schuchardt , Ilias Apalodimas , Mark Kettenis , Tom Rini , Sean Anderson , Simon Glass , Bin Meng Subject: [PATCH v2 0/3] doc: Clarify how U-Boot makes use of devicetree Date: Sat, 28 Aug 2021 10:46:26 -0600 Message-Id: <20210828164630.81050-1-sjg@chromium.org> X-Mailer: git-send-email 2.33.0.259.gc128427fd7-goog 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 This series includes a documentation update to clarify how U-Boot makes use of devicetree and its requirements when working with other firmware projects. Once agreed it should provide more clarity in this area, which seems to have devolved into a confusing mire recently. My goal here is to sort out this area one and for all, clearly documenting the use cases and implications of them. I hope that the end result of this (substantial) effort will be a shared understanding of how to move forward in U-Boot and hopefully some ideas for firmware in general. It also cleans up the config binding since this has got a bit out-of-date. Changes in v2: - Add a new patch to tidy up the /config bindings - Add new patch to document remaining runtime-config options - Fix typos per Sean (thank you!) and a few others - Add a 'Use of U-Boot /config node' section - Drop mention of dm-verity since that actually uses the kernel cmdline - Explain that OF_BOARD will still work after these changes (in 'Once this bug is fixed...' paragraph) - Expand a bit on the reason why the 'Current situation' is bad - Clarify in a second place that Linux and U-Boot use the same devicetree in 'To be clear, while U-Boot...' - Expand on why we should have rules for other projects in 'Devicetree in another project' - Add a comment as to why devicetree in U-Boot is not 'bad design' - Reword 'in-tree U-Boot devicetree' to 'devicetree source in U-Boot' - Rewrite 'Devicetree generated on-the-fly in another project' to cover points raised on v1 - Add 'Why does U-Boot have its nodes and properties?' - Add 'Why not have two devicetrees?' Simon Glass (3): doc: Tidy up the bindings for the config/ node doc: Complete the list of available runtime-config options RFC: doc: Add documentation about devicetree usage doc/develop/index.rst | 1 + doc/develop/package/devicetree.rst | 563 ++++++++++++++++++++++++++++ doc/develop/package/index.rst | 1 + doc/device-tree-bindings/config.txt | 83 +++- 4 files changed, 632 insertions(+), 16 deletions(-) create mode 100644 doc/develop/package/devicetree.rst -- 2.33.0.259.gc128427fd7-goog