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.1 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 3400AC433F5 for ; Thu, 9 Sep 2021 20:10:46 +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 94D4D61104 for ; Thu, 9 Sep 2021 20:10:45 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 94D4D61104 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 B9DA283544; Thu, 9 Sep 2021 22:10:43 +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="cw3z1ZYA"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id C818F83547; Thu, 9 Sep 2021 22:10:41 +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 6D5A883543 for ; Thu, 9 Sep 2021 22:10:38 +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 n5so4229570wro.12 for ; Thu, 09 Sep 2021 13:10:38 -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=Gco5ArLg6zxye1x1JXcS/0Vo8tSALgB1kPEEj0a8LTU=; b=cw3z1ZYAbv7TTKcNHlqVgsPvoYAqI0R1lfnlIrBSn1Te+ginLLx947Sgb3+L4h46hh FUei9a+3nXLVEP91W1ytHbOeobhPk0BKiH78wFDSLsihcAkthmzGYxrUvbaN++ETW54b D9ERRkdcK5K5+CKANgxHh66nYtv8q/esAF/k8= 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:mime-version :content-transfer-encoding; bh=Gco5ArLg6zxye1x1JXcS/0Vo8tSALgB1kPEEj0a8LTU=; b=erEUiuVgnnCCL/IiBpeQLXAq1/tQFym+RWdAAQUjBtCaLzhbdRvErJWu8EJFE25+9E mRdkmQO5FSkfT09NuMbrJnKFIXZfxsRZz8JtyVuPexU5SYaZdTaRArRVpeS30PFu7V7D Mi8BQ5Z8P8KBf8gxXbIAauEFcl/gGOlioYDAQ+wDs5CoBTj7slPbtgM5hWdybwuJlduW PMDui/j1o2fXVjwxuVpoO2OB/gHdYwlC+TdboJHUZIz2ZcFJXAAn8/91GzP/pji8RFgZ LlYLOoSAyRWR94Z63T1GlUllvu+d/x0uGO5M4f9bMlOwbZLGNCRhWQtGc5Puy+hg01/1 OrKg== X-Gm-Message-State: AOAM5334DqZ7qTtWpjQ7sBYoWqBVZdhWUZlvzwNALDhpUG8d8wZYx4XY Prlk6vZlJ6nQ2oLYDgW2Fmju8Opcl5F5nw== X-Google-Smtp-Source: ABdhPJwCYCzcbM7Vx03bEp52a+UEmTtTamvylqkrRwz/WWxxXEMJJe6VWwCI0Oz/w/1FweqzbHYfPw== X-Received: by 2002:adf:e404:: with SMTP id g4mr5692221wrm.143.1631218237592; Thu, 09 Sep 2021 13:10:37 -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.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 09 Sep 2021 13:10:36 -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 Subject: [PATCH v3 0/3] doc: Clarify how U-Boot makes use of devicetree Date: Thu, 9 Sep 2021 14:10:30 -0600 Message-Id: <20210909201033.755713-1-sjg@chromium.org> X-Mailer: git-send-email 2.33.0.309.g3052b89438-goog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 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 v3: - Add missing period - Fix 'bootsercure' typo - Fix typos linst suppled receive EFL - Drop 'and' before 'self-defeating' - Reword mention of control of QEMU's devicetree generation - Add mention of dropping CONFIG_OF_BOARD - Clarify the 'Once this bug is fixed' paragraph a bit - Expand ways that CONFIG_OF_PRIOR_STAGE can support the U-Boot devicetree - Add a note at the top explaining that his patch covers 'now', not 'future' - Add note 'Note: Some boards use a devicetree in U-Boot which does not match' 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 | 583 ++++++++++++++++++++++++++++ doc/develop/package/index.rst | 1 + doc/device-tree-bindings/config.txt | 83 +++- 4 files changed, 652 insertions(+), 16 deletions(-) create mode 100644 doc/develop/package/devicetree.rst -- 2.33.0.309.g3052b89438-goog