From patchwork Wed Jan 10 10:35:36 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sumit Garg X-Patchwork-Id: 761432 Delivered-To: patch@linaro.org Received: by 2002:a5d:6e02:0:b0:337:62d3:c6d5 with SMTP id h2csp1807421wrz; Wed, 10 Jan 2024 02:36:18 -0800 (PST) X-Google-Smtp-Source: AGHT+IEVnWHi2BzF5IXz7cY16MASoPOoWMGBt4egFv3Aa81NL4aY1QCUDOcZfI7+pfUiWwW5Fy+I X-Received: by 2002:a05:600c:4fd2:b0:40d:7fbe:e966 with SMTP id o18-20020a05600c4fd200b0040d7fbee966mr411015wmq.40.1704882978229; Wed, 10 Jan 2024 02:36:18 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704882978; cv=none; d=google.com; s=arc-20160816; b=K6Po05qe81sSh2ZMWBn4uSfye1pYONKpBtii1QDynegzELnkStb0d5gNAJ/wRk4EiL cviGOUGS04+MyFiGkcNktSPtqr2J3EtFyTYjTelPotTVUZPNbhL0ivSg0PnOOQRIJLTj GU4+L1IgBxpI9hZ3AbRqCiNofyxKqPdc/8JMx13ZD1rKRThJ00bjtbtmVCboa7wIaN4M Z4bo1vyNVmdChL2262e+YGlCbHaRzP8D3W0XdIh5Erv6x7ZEoLpOYWBsUwgpLrSWKV9H Y31oOw0yOrg5cXBMPcq1SzPKoPZ8E0MYnkRXmxUQ84fKf8FXnlRdNDHBCYh596zBO5rb 3p+Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:message-id:date:subject:cc:to:from:dkim-signature; bh=vZxNzg5aBJZO2W0gAe8SFiVBufVY2+HM0fJnTFfujyE=; fh=g5mGBYdwcRCvgzx1fsOtMayuItbAc+o2ocuRoBH1vWU=; b=uHfq4fDBMTVwjfICnherubmaOT2yIHk8Z94+c7XYr3OiesA5xeufGxlDn3TEDEQ/3T B30nhjrsgZgjaFbPL/4epIDSeDLZF9wfV/94vG0ytLYdjq3OCOtkAEoq/w3/yUCUd3Mc fJnOJAMjl4Yxer721aVEoFKVHSJmfP7iQAVBkiDCaV0MWHyiRJG4QW1GW4PgHn1ODxAh XfTj9RpwA/HSVu72hpFEENr5TlKe08E6hlJ4+jpbj7sxFSc1l8CiP/3WVjshFZDLRfxN SevreyjA9Wpk7FPKsfsqJ+MeBFim1hrk9RRsEmwjRTe/93zAOBnuHfoG4EKhNGsDG3xc kdkA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=GEwLPFG+; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [85.214.62.61]) by mx.google.com with ESMTPS id p12-20020a7bcc8c000000b0040c28fb0351si567515wma.134.2024.01.10.02.36.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Jan 2024 02:36:18 -0800 (PST) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) client-ip=85.214.62.61; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=GEwLPFG+; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id C880D8797B; Wed, 10 Jan 2024 11:36:16 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="GEwLPFG+"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 3697C8797B; Wed, 10 Jan 2024 11:36:15 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: * X-Spam-Status: No, score=1.2 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_SBL_CSS,SPF_HELO_NONE, SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.2 Received: from mail-pl1-x635.google.com (mail-pl1-x635.google.com [IPv6:2607:f8b0:4864:20::635]) (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 8473F87A35 for ; Wed, 10 Jan 2024 11:36:10 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=sumit.garg@linaro.org Received: by mail-pl1-x635.google.com with SMTP id d9443c01a7336-1d4a980fdedso35560805ad.1 for ; Wed, 10 Jan 2024 02:36:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1704882968; x=1705487768; darn=lists.denx.de; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=vZxNzg5aBJZO2W0gAe8SFiVBufVY2+HM0fJnTFfujyE=; b=GEwLPFG+UUbxUhSOLPVZ/k5LzRDPnv0en4o0yhxFuQwWPYWzOqQq+Q+XFk1KP+xR4l UkNtKn7o7VyocuEk+X5CCAwFdpcYzavN/+WEJGAXdX8/TVunB1+xGGkAmY56bPQLqzbp 3t3Q2Xj8yJZz1dcgQRLaQZb9J48cdkpMJIhHTjpD9Og6gJ/Gkt2oWZdTWFfNSnXBvWTi YGqr8xfaZfDMWEzHJ6AeQgdmqJg9qDkHYhb1cAM4DKhwcdkeahillls1qOGpZbWmPe4k lLIjBow/RH5MQWIJRfVoppxrcDravs2IY2VFmI/MoYQuCrQL2YuCL9E+OaZ/1U3Oo0AE +gyQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704882968; x=1705487768; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=vZxNzg5aBJZO2W0gAe8SFiVBufVY2+HM0fJnTFfujyE=; b=cP+9IGzlUnXiBU1+fyOF2BGd8VG4JziHDzRyNPvffbIBZWQ297JxFTKyyUz5PI/oXQ dgp8USQrWVfOCnL8LyXV2aBppFbZGmS5kDyeWn5sdoSmzcF75mqZTrYP/g0KSMksNopR AHi6GOTnsrpQLRvM1CSnCmwLg3kUomn/kP4Nru5pn5XQH8A/H2cICpJtlPvlW80zin/T JWfGZFIonQYlsNBJNECYkSVEChg4crqh/Qdk0hFAZ5LEsCDbJcrXQRqS6FextU29lWif oDoXwLiiugav0BOmYxIP4XIp0jBCwr4Z5DiSPcmja4uVWoFpQD3+rxursffSn3nqpZRB F8Kw== X-Gm-Message-State: AOJu0YzziE+zUqpyQiV5Jvat4lBA4cWWbOLKsaIlEIKaoxNQK9tgUVSJ UJyEx1qB/1wAszaI01Ib/clR4FFqdW7AaD5Wd8agsdwuxDs= X-Received: by 2002:a17:903:4c2:b0:1d4:e011:789e with SMTP id jm2-20020a17090304c200b001d4e011789emr800937plb.78.1704882968410; Wed, 10 Jan 2024 02:36:08 -0800 (PST) Received: from sumit-X1.. ([223.178.208.66]) by smtp.gmail.com with ESMTPSA id i7-20020a17090332c700b001d38a7e6a30sm3332604plr.70.2024.01.10.02.36.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Jan 2024 02:36:07 -0800 (PST) From: Sumit Garg To: u-boot@lists.denx.de, u-boot-amlogic@groups.io, u-boot-custodians@lists.denx.de Cc: trini@konsulko.com, sjg@chromium.org, robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org, conor@kernel.org, neil.armstrong@linaro.org, caleb.connolly@linaro.org, ff@shokubai.tech, daniel.thompson@linaro.org, dgilmore@fedoraproject.org, pbrobinson@gmail.com, ilias.apalodimas@linaro.org, maxim.uvarov@linaro.org, b.galvani@gmail.com, xypron.glpk@gmx.de, michal.simek@amd.com, seanga2@gmail.com, rasmus.villemoes@prevas.dk, peng.fan@nxp.com, jh80.chung@samsung.com, rfried.dev@gmail.com, marex@denx.de, mibodhi@gmail.com, bb@ti.com, mark.kettenis@xs4all.nl, Sumit Garg Subject: [PATCH v4 00/11] An effort to bring DT bindings compliance within U-Boot Date: Wed, 10 Jan 2024 16:05:36 +0530 Message-Id: <20240110103547.719757-1-sumit.garg@linaro.org> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 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.8 at phobos.denx.de X-Virus-Status: Clean Changes in v4: -------------- - Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure. - Since we now have v6.7-dts tag available now, so switch subtree to that from its beginning. - Patch #2: Incorporate build fix to adjust Bindings Makefile rules to old U-Boot Kbuild infrastructure. - Patch #3: Incorporate fix to resolve rk3399 migration issue reported by Simon. - Patch #4: New patch to reuse upstream DT includes by U-Boot as per Brian's use-case for TI K3 SoCs. - Patch #5: Added a note to OF_UPSTREAM Kconfig option. - Patch #6: New patch to add script dts/update-dts-subtree.sh as per Rob's comments. - Patch #7: Separate patch to align documentation to use Kconfig symbols instead. - Patch #8: Clarify subtree uprev schedule as a separate documentation section. Also, fixed documentation typos. - Patch #9: Added commit description. Changes in v3: -------------- - Patch #4: Minor commit message update - Patch #5: Replace CONFIG_* with Kconfig options - Patch #7: Dropped Makefile portion and enabled OF_UPSTREAM for SoC instead. - Patch #1, #3, #6 and #8: Picked up review tags Changes in v2: -------------- - Patch #1: excluded gitab CI config check and added commit description. - Patch #3: s/UBOOT_DTSI_LOC/u_boot_dtsi_loc/ - Patch #4: s/DEVICE_TREE_LOC/dt_dir/ and s/U-boot/U-Boot/ - Patch #5: s/U-boot/U-Boot/ - Patch #6 and #7: Picked up review tags Prerequisite ------------ This patch series requires devicetree-rebasing git repo to be added as a subtree to the main U-Boot repo via: $ git subtree add --prefix dts/upstream \ git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \ v6.7-dts --squash Background ---------- This effort started while I was reviewing patch series corresponding to Qcom platforms [1] which was about to import modified devicetree source files from Linux kernel. I suppose keeping devicetree files sync with Linux kernel without any DT bindings schema validation has been a pain for U-Boot SoC/platform maintainers. There has been past discussions about a single DT repo but that hasn't come up and Linux kernel remained the place where DT source files as well as bindings are placed and maintained. However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel. In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as `dts/upstream` sub-directory. U-Boot will regularly sync `dts/upstream/` subtree whenever the next window opens with the next available kernel major release. `dts/update-dts-subtree.sh` script provides a wrapper around git subtree pull command, usage from the top level U-Boot source tree, run: $ ./dts/update-dts-subtree.sh The RFC/prototype for this series has been discussed with Linux DT maintainers as well as U-Boot maintainers here [4]. Now we would like to reach out to wider U-Boot community to seek feedback. [1] https://lore.kernel.org/all/CAFA6WYMLUD9cnkr=R0Uur+1UeTMkKjM2zDdMJtXb3nmrLk+pDg@mail.gmail.com/ [2] https://lore.kernel.org/all/CAL_JsqKEjv2tSGmT+0ZiO7_qbBfhTycbGnhJhYpKDFzfO9jzDg@mail.gmail.com/ [3] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/ [4] https://github.com/u-boot/u-boot/pull/451 Changes ------- Traditionally, U-Boot placed copies of devicetree source files from Linux kernel into `arch//dts/.dts` which can be selected via setting "" when prompted for `DEFAULT_DEVICE_TREE` by Kconfig. SoC/board maintainers are encouraged to migrate to use synced copies from `dts/upstream/src//`. To do that enable `OF_UPSTREAM` for the SoC being used via Kconfig and set up "/" when prompted for `DEFAULT_DEVICE_TREE` by Kconfig. An example have been shown for Amlogic meson-gxbb SoC and corresponding derived boards via patch #10 and #11. Devicetree bindings schema checks --------------------------------- With devicetee-rebasing Git subtree, the devicetree bindings are also regularly synced with Linux kernel as `dts/upstream/Bindings/` sub-directory. This allows U-Boot to run devicetree bindings schema checks which will bring compliance to U-Boot core/drivers regarding usage of devicetree. Dependencies ------------ The DT schema project must be installed in order to validate the DT schema binding documents and validate DTS files using the DT schema. The DT schema project can be installed with pip: $ pip3 install dtschema Note that 'dtschema' installation requires 'swig' and Python development files installed first. On Debian/Ubuntu systems: $ apt install swig python3-dev Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be installed. Ensure they are in your PATH (~/.local/bin by default). Recommended is also to install yamllint (used by dtschema when present). $ apt install yamllint Running checks -------------- In order to perform validation of DTB files, use the ``dtbs_check`` target: $ make dtbs_check It is also possible to run checks with a subset of matching schema files by setting the ``DT_SCHEMA_FILES`` variable to 1 or more specific schema files or patterns (partial match of a fixed string). Each file or pattern should be separated by ':'. $ make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml $ make dtbs_check DT_SCHEMA_FILES=/gpio/ $ make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml Sumit Garg (11): CI: Exclude devicetree-rebasing subtree for CONFIG checks Makefile: Add support for DT bindings schema checks scripts/Makefile.lib: Statically define *-u-boot.dtsi files location Makefile: Allow upstream DT subtree to provide DT includes dts: Add alternative location for upstream DTB builds dts: Add script to uprev dts/upstream subtree doc: devicetree: Align documentation to use Kconfig options doc: devicetree: Updates for devicetree-rebasing subtree MAINTAINERS: Add myself as devicetree-rebasing maintainer dts: meson-gxbb: Switch to using upstream DT dts: meson-gxbb: Drop redundant devicetree files .azure-pipelines.yml | 3 +- .gitlab-ci.yml | 3 +- MAINTAINERS | 5 + Makefile | 23 +- arch/arm/dts/Makefile | 8 - arch/arm/dts/meson-gxbb-kii-pro.dts | 140 ---- arch/arm/dts/meson-gxbb-nanopi-k2.dts | 426 ------------ arch/arm/dts/meson-gxbb-odroidc2.dts | 414 ----------- arch/arm/dts/meson-gxbb-p200.dts | 100 --- arch/arm/dts/meson-gxbb-p201.dts | 26 - arch/arm/dts/meson-gxbb-p20x.dtsi | 250 ------- arch/arm/dts/meson-gxbb-wetek-hub.dts | 58 -- arch/arm/dts/meson-gxbb-wetek-play2.dts | 119 ---- arch/arm/dts/meson-gxbb-wetek.dtsi | 292 -------- arch/arm/dts/meson-gxbb.dtsi | 870 ------------------------ arch/arm/mach-meson/Kconfig | 1 + configs/nanopi-k2_defconfig | 2 +- configs/odroid-c2_defconfig | 2 +- configs/p200_defconfig | 2 +- configs/p201_defconfig | 2 +- configs/videostrong-kii-pro_defconfig | 2 +- configs/wetek-hub_defconfig | 2 +- configs/wetek-play2_defconfig | 2 +- doc/develop/devicetree/control.rst | 158 +++-- dts/Kconfig | 16 + dts/Makefile | 17 +- dts/update-dts-subtree.sh | 24 + dts/upstream/Bindings/Makefile | 6 +- dts/upstream/src/arm64/Makefile | 14 + scripts/Makefile.lib | 49 +- 30 files changed, 256 insertions(+), 2780 deletions(-) delete mode 100644 arch/arm/dts/meson-gxbb-kii-pro.dts delete mode 100644 arch/arm/dts/meson-gxbb-nanopi-k2.dts delete mode 100644 arch/arm/dts/meson-gxbb-odroidc2.dts delete mode 100644 arch/arm/dts/meson-gxbb-p200.dts delete mode 100644 arch/arm/dts/meson-gxbb-p201.dts delete mode 100644 arch/arm/dts/meson-gxbb-p20x.dtsi delete mode 100644 arch/arm/dts/meson-gxbb-wetek-hub.dts delete mode 100644 arch/arm/dts/meson-gxbb-wetek-play2.dts delete mode 100644 arch/arm/dts/meson-gxbb-wetek.dtsi delete mode 100644 arch/arm/dts/meson-gxbb.dtsi create mode 100755 dts/update-dts-subtree.sh create mode 100644 dts/upstream/src/arm64/Makefile