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=-17.2 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 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 AFF79C433EF for ; Fri, 10 Sep 2021 16:58:10 +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 0A175610F8 for ; Fri, 10 Sep 2021 16:58:09 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0A175610F8 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=konsulko.com 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 99887836CA; Fri, 10 Sep 2021 18:58:07 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=konsulko.com 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=konsulko.com header.i=@konsulko.com header.b="IsYKFtQ2"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 46A56836CB; Fri, 10 Sep 2021 18:58:06 +0200 (CEST) Received: from mail-qt1-x829.google.com (mail-qt1-x829.google.com [IPv6:2607:f8b0:4864:20::829]) (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 75B4B836C5 for ; Fri, 10 Sep 2021 18:58:00 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=trini@konsulko.com Received: by mail-qt1-x829.google.com with SMTP id s15so1995127qta.10 for ; Fri, 10 Sep 2021 09:58:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=konsulko.com; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=tI3TAmM/HCTXDtPGDedWjrXkmK/yDMvxlUedG/4TW+0=; b=IsYKFtQ2pwg+i4mdS6XhYtP9jVEc+G4B377Vnzor0THspdW38aG7nmqg7CqB/MKmQi thn5Y0odTWs9xDdolLAt3MNyMbQO/8WJvdnH9kBHXqAs3DvEPjctjENAn5SZZ6TnhaA/ 0oielJcxkjVXrDzvFBZhBdo92ACnDxAf+sEiI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=tI3TAmM/HCTXDtPGDedWjrXkmK/yDMvxlUedG/4TW+0=; b=0/ffvPz7fS1dvCSp0/mjmlzGfPJn8oMe2VZR7PzxoSiMlWwtgmkFLl8LA/pFSFch9f US9oxUGdgm3YKBOniNaFIQPhwde/3QNsZudgANQ1xqKRkw5v9+R80rAXD8dCOJ333H+G DnelpxklP+CikgJIgghOXAeQeUeC/M5aA3aGJo7CjYCyBDAAh656m0H+RWy9niXuON5G hMpCFpBu5rf/vBY+PbX5+OAa1j9P2hw6ExYCPUQlHz/YcTV6lnd9QJv0/JK8kjipriG6 7t7qH7bFKbUcdJhO6IVdbMY/YZvz39vbjYKECXGOfTD9oR3RpQtiwzF0q9OrynQke6FO gr9Q== X-Gm-Message-State: AOAM531lUpLtZrokkSMzH8YTC9do9Gw5lMwLnK0OwcX2+NrHG3WU/Va3 w4NXvYmotPEZ0rgV9PVed/UmbXEDjGEvCg== X-Google-Smtp-Source: ABdhPJztSd3pibsfIQCn+tjNZhxHevZCEDTUHtXz7mydu1dHMngY0dJMEGvqpzN4/fQdwRJS+NvZZA== X-Received: by 2002:ac8:7d4e:: with SMTP id h14mr8875506qtb.404.1631293078941; Fri, 10 Sep 2021 09:57:58 -0700 (PDT) Received: from bill-the-cat (2603-6081-7b01-cbda-55fd-c014-b2c6-676a.res6.spectrum.com. [2603:6081:7b01:cbda:55fd:c014:b2c6:676a]) by smtp.gmail.com with ESMTPSA id j26sm3962572qki.26.2021.09.10.09.57.57 (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 10 Sep 2021 09:57:58 -0700 (PDT) Date: Fri, 10 Sep 2021 12:57:56 -0400 From: Tom Rini To: Heinrich Schuchardt Cc: Simon Glass , U-Boot Mailing List , Sean Anderson , Mark Kettenis , Ilias Apalodimas , =?iso-8859-1?Q?Fran=E7ois?= Ozog , Bill Mills , Marcel Ziswiler Subject: Re: [PATCH v3 3/3] RFC: doc: Add documentation about devicetree usage Message-ID: <20210910165756.GQ12964@bill-the-cat> References: <20210909201033.755713-1-sjg@chromium.org> <20210909201033.755713-4-sjg@chromium.org> <20210910123420.GL12964@bill-the-cat> <20210910163725.GP12964@bill-the-cat> <633f58d5-4615-66d6-2875-9ee9a4492d4b@gmx.de> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="oZv4yqUxWy6Z3hn+" Content-Disposition: inline In-Reply-To: <633f58d5-4615-66d6-2875-9ee9a4492d4b@gmx.de> X-Clacks-Overhead: GNU Terry Pratchett User-Agent: Mutt/1.9.4 (2018-02-28) 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 --oZv4yqUxWy6Z3hn+ Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Sep 10, 2021 at 06:50:16PM +0200, Heinrich Schuchardt wrote: >=20 >=20 > On 9/10/21 6:37 PM, Tom Rini wrote: > > On Fri, Sep 10, 2021 at 06:28:36PM +0200, Heinrich Schuchardt wrote: > > >=20 > > >=20 > > > On 9/10/21 2:34 PM, Tom Rini wrote: > > > > On Fri, Sep 10, 2021 at 10:38:17AM +0200, Heinrich Schuchardt wrote: > > > > >=20 > > > > >=20 > > > > > On 9/9/21 10:10 PM, Simon Glass wrote: > > > > > > At present some of the ideas and techniques behind devicetree i= n U-Boot > > > > > > are assumed, implied or unsaid. Add some documentation to cover= how > > > > > > devicetree is build, how it can be modified and the rules about= using > > > > > > the various CONFIG_OF_... options. > > > > > >=20 > > > > > > Signed-off-by: Simon Glass > > > > > > Reviewed-by: Marcel Ziswiler > > > > > > --- > > > > > >=20 > > > > > > Changes in v3: > > > > > > - 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' > > > > > >=20 > > > > > > Changes in v2: > > > > > > - 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 desi= gn' > > > > > > - 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?' > > > > > >=20 > > > > > > doc/develop/index.rst | 1 + > > > > > > doc/develop/package/devicetree.rst | 583 ++++++++++++++++++= +++++++++++ > > > > > > doc/develop/package/index.rst | 1 + > > > > > > 3 files changed, 585 insertions(+) > > > > > > create mode 100644 doc/develop/package/devicetree.rst > > > > > >=20 > > > > > > diff --git a/doc/develop/index.rst b/doc/develop/index.rst > > > > > > index 83c929babda..d5ad8f9fe53 100644 > > > > > > --- a/doc/develop/index.rst > > > > > > +++ b/doc/develop/index.rst > > > > > > @@ -36,6 +36,7 @@ Packaging > > > > > > :maxdepth: 1 > > > > > >=20 > > > > > > package/index > > > > > > + package/devicetree > > > > > >=20 > > > > > > Testing > > > > > > ------- > > > > > > diff --git a/doc/develop/package/devicetree.rst b/doc/develop/p= ackage/devicetree.rst > > > > > > new file mode 100644 > > > > > > index 00000000000..b1bd310d906 > > > > > > --- /dev/null > > > > > > +++ b/doc/develop/package/devicetree.rst > > > > > > @@ -0,0 +1,583 @@ > > > > > > +.. SPDX-License-Identifier: GPL-2.0+ > > > > > > + > > > > > > +Updating the devicetree > > > > > > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D > > > > > > + > > > > > > +Note: This documentation describes how things are today, mostl= y, with some > > > > > > +mention of things that need to be fixed. It is not intended to= point the way to > > > > > > +what might be done in the future. That should be the subject o= f discussions on > > > > > > +the mailing list. > > > > > > + > > > > > > +U-Boot uses devicetree for runtime configuration and storing r= equired blobs or > > > > > > +any other information it needs to operate. It is possible to u= pdate the > > > > > > +devicetree separately from actually building U-Boot. This prov= ides a good degree > > > > > > +of control and flexibility for firmware that uses U-Boot in co= njunction with > > > > > > +other project. > > > > > > + > > > > > > +There are many reasons why it is useful to modify the devicetr= ee after building > > > > > > +it: > > > > > > + > > > > > > +- Configuration can be changed, e.g. which UART to use > > > > > > +- A serial number can be added > > > > > > +- Public keys can be added to allow image verification > > > > > > +- Console output can be changed (e.g. to select serial or vidc= onsole) > > > > > > + > > > > > > +This section describes how to work with devicetree to accompli= sh your goals. > > > > > > + > > > > > > +See also :doc:`../devicetree/control` for a basic summary of t= he available > > > > > > +features. > > > > > > + > > > > > > + > > > > > > +Devicetree source > > > > > > +----------------- > > > > > > + > > > > > > +Every board in U-Boot must include a devicetree sufficient to = build and boot > > > > > > +that board on suitable hardware (or emulation). This is specif= ied using the > > > > > > +`CONFIG DEFAULT_DEVICE_TREE` option. > > > > > > + > > > > > > + > > > > > > +Current situation (August 2021) > > > > > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > > > > > + > > > > > > +As an aside, at present U-Boot allows `CONFIG_DEFAULT_DEVICE_T= REE` to be empty, > > > > > > +e.g. if `CONFIG_OF_BOARD` or `CONFIG_OF_PRIOR_STAGE` are used.= This has > > > > > > +unfortunately created an enormous amount of confusion and some= wasted effort. > > > > > > +This was not intended and this bug will be fixed soon. > > > > > > + > > > > > > +Some of the problems created are: > > > > > > + > > > > > > +- It is not obvious that the devicetree is coming from another= project > > > > > > + > > > > > > +- There is no way to see even a sample devicetree for these pl= atform in U-Boot, > > > > > > + so it is hard to know what is going on, e.g. which devices a= re typically > > > > > > + present > > > > > > + > > > > > > +- The other project may not provide a way to support U-Boot's = requirements for > > > > > > + devicetree, such as the /config node. Note: On the U-Boot ma= iling list, this > > > > > > + was only discovered after weeks of discussion and confusion > > > > > > + > > > > > > +- For QEMU specifically, consulting two QEMU source files is r= equired, for which > > > > > > + there are no references in U-Boot documentation. The code is= generating a > > > > > > + devicetree, with some control from command-line args, but it= is not clear > > > > > > + how to add properties required by U-Boot. > > > > > > + > > > > > > +Specifically on the changes in U-Boot: > > > > > > + > > > > > > +- `CONFIG_OF_BOARD` was added in rpi_patch_ for Raspberry Pi, = which does have > > > > > > + an in-tree devicetree, but this feature has since been used = for boards that > > > > > > + don't > > > > > > +- `CONFIG_OF_PRIOR_STAGE` was added in bcm_patch_ as part of a= larger Broadcom > > > > > > + change with a tag indicating it only affected one board, so = the change in > > > > > > + behaviour was not noticed at the time. It has since been use= d by RISC-V qemu > > > > > > + boards. > > > > > > + > > > > > > +Note: It is not clear that we actually need both of these. Pos= sibly > > > > > > +`CONFIG_OF_BOARD` can be dropped. > > > > > > + > > > > > > +Once this bug is fixed, CONFIG_OF_BOARD and CONFIG_OF_PRIOR_ST= AGE will override > > > > >=20 > > > > > What does "bug" refer to? Above you describe the current design n= ot a bug. > > > >=20 > > > > The bug is that we have two options to provide seemingly the same > > > > functionality. Is there a functional difference between CONFIG_OF_= BOARD > > > > and CONFIG_OF_PRIOR_STAGE ? > >=20 > > Does this clarify your question? Again, does this clarify or answer your question? > > > > > > +(at runtime) the devicetree supplied with U-Boot, but will oth= erwise use > > > > > > +CONFIG_OF_SEPARATE for the in-tree build. So these two will be= come options, > > > > > > +moving out of the 'choice' in `dts/Kconfig`. To be clear, the = devicetree in the > > > > > > +U-Boot tree may be largely for documentation and build-testing= purposes, if at > > > > > > +runtime the devicetree if provided by another project. But the= in-tree > > > > > > +devicetree is packaged with U-Boot as a fallback if it does no= t get one from a > > > > > > +prior stage at runtime. This does not create two devicetrees t= hat need to be > > > > > > +merged, or anything like that. If the prior stage provides one= , it is used as > > > > > > +is, with the one provided by U-Boot being ignored. > > > > > > + > > > > > > +This means that there is a basic devicetree build in the U-Boo= t tree, for > > > > > > +build-testing, consistency and documentation purposes, but at = runtime U-Boot can > > > > > > +accept its devicetree from another source. > > > > >=20 > > > > > The incoming devicetree may not contain any U-Boot specific stuff= =2E So > > > > > don't you need the buildtime devicetree for all of this informati= on at > > > > > runtime? E.g. you were requesting to move certificate blobs into = the > > > > > build-time devicetree. > > > >=20 > > > > This is wrong because (a) no, there's no functional reason the prior > > > > stage cannot populate / be pre-populated with what we need and (b) = we're > > > > documenting what we have today. > > >=20 > > > The problem is not functional but organizational. The prior boot stage > > > may be burnt into PROM while U-Boot is on an SD-card. > > >=20 > > > Don't expect that on a board where you could install EDK II or U-Boot= or > > > anything else the prior boot stage cares about U-Boot. > > >=20 > > > How could a prior boot stage possibly know years ahead what is not ev= en > > > yet supported in U-Boot when the prior boot stage is created? > >=20 > > I don't follow you, sorry. Or perhaps, if you %s/U-Boot/Linux/ the > > above, what's your answer then? >=20 > The boot ROM is burnt into the SoC at production. You don't want to > unsolder it if you don't like the devicetree in the boot ROM. >=20 > Equally there should be no need to replace TF-A when moving from U-Boot > v2020.10 to v2040.10 during the lifetime of a car. >=20 > This is why we cannot expect anything from a prior boot stage but an > accurate description of the hardware and the prior boot stage itself. OK. But again, %s/U-Boot/Linux/ and then what? Or are you saying the device tree that's burned in shouldn't be used for Linux either? --=20 Tom --oZv4yqUxWy6Z3hn+ Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQGzBAABCgAdFiEEGjx/cOCPqxcHgJu/FHw5/5Y0tywFAmE7jo0ACgkQFHw5/5Y0 tyz3HAv8C3gcKXiac5BG2+S6QIyZ5z3UYcSHf4jsA88CmJG+KaI8jyelegammhwz +IgaOZhCf7t8q5kzY4vG+Xhto+aQrNsXhGyfA2cAanknM4Hdhtnb4JjjeLrNjcu5 bGO/4wf9b/hUj8rV3CffuYY41CP0PBJZdkIZ8GrMMmYmamJDkcWFNvHTLzCGAJCU U1nbKUll3VQ+HM2YUSujg2vykpVasWkl8s4/+m6hiNdg1Zl0rriR2Hze2TzEd+9l ROMOb/5N+BUotpuFIa/nqfr4HMdEGy9HhXd7TP11hm2V4GLS6qo4KKutXFbRAuxX PnBF08r5/hXrSkUOlJF5MB/n7CBABv3zxHy5NXnBW/qfao51kTmMxmAcNTKw3y57 qMYfpEQEEJ870CFXr9YzzHVM689D0ysbFgzhDyip5gXuFTcCyQBmU74+3Ezj78Wo wGB3melAZeE9jQRHsKn6Jf2uHewDNyhgJ086UNCOvyezF2qQ4p65NBUFRVEQMzUe cncLSW3A =jLIA -----END PGP SIGNATURE----- --oZv4yqUxWy6Z3hn+--