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 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 174C5C77B7C for ; Wed, 31 May 2023 06:30:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:Content-Type: List-Subscribe:List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id: In-Reply-To:MIME-Version:References:Message-ID:Subject:Cc:To:From:Date: Reply-To:Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date :Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=8zqj2MQLfkuPuO5gsUKa5c7zIPL/qrRQpo0qdDzV3UI=; b=sSQ+O68gFRU1sWNc8dc3HTwjba ptGVCasVHfdk4C3JePpkhKqzcT6jg3pG0WDqm8B0ZGv6DJuu9c/XCLFgczfH4GYtlLTKewsRfxJXA 4dJXOcD4mRhnD5Kpab9/PCF4tc4ZuJpIaliGaGu3fYScaVp1UHif9oBI3oEmxsQAniuxhGZM1zhGz YfRxJwpYkfe25J1vOy+dYpQuvBrmXJmwPyvZs8fgbvAaHKdcda97P4S9GwphleYl6jsfsRIOXJKcd bdaw62aglXXNtBS+CfQuDgO66so0y5OUatuTnnoQxvCjiQemIReoahoauTvlhS1P7iVWopQx1P5nl 8CIiPHEA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1q4FLe-00GIRA-2G; Wed, 31 May 2023 06:30:18 +0000 Received: from mail-pf1-x42b.google.com ([2607:f8b0:4864:20::42b]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1q4FLb-00GIOz-1y; Wed, 31 May 2023 06:30:17 +0000 Received: by mail-pf1-x42b.google.com with SMTP id d2e1a72fcca58-64d426e63baso6036029b3a.0; Tue, 30 May 2023 23:30:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1685514613; x=1688106613; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=QHVa7qx0Y3jBTDZnlucyg01NugOE8nypPp8hA0hG/dw=; b=HBH9612+2knX82fth45xbRKdCtfbPytavOp7WDk3ypzmYifLwc5eSyA3HGAQYFHRRw Rx3ZoRcpPfx6aXxB2NnoCD0SooWD2XfgJKo6vCg6yvpzgKgjPEyuGpEeECuEoGXil24C 4T7PgMvN24poTJ/gY7VvIDIaYep+7oKknut0Y/bvoGVhjCAc+E2XqzdtoB9PYY9YEIvS Yy0WWxmCA79lvGp6Pp5eiInla7i5k4scmIxumtqZaqpQuWBTuZFlZ664xJpod0ZM4B6+ IgFIXhokFbKrziQXE+qFffqETujdtoUY1hUXshSPC/rYzoqabCFax8vCM4DDOwz6Wppz 2lGg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1685514613; x=1688106613; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=QHVa7qx0Y3jBTDZnlucyg01NugOE8nypPp8hA0hG/dw=; b=JFuwTbsV2BcHm6UTYAZa6PxptT/vLgmD5Aaqw4E+/eVF5qApbpSiO5sU4hmD+LjW/r HBeC6kerUz6/V7xEu6J296B+ds2MCG0oOMnSH8GjlU/qedviJA+tH+FHgIGqzhEyCUbk qo2A0rmZkxGqjztpJonIDV1TRV7w2rky5FeVVtGKDmGVpyHOEOAdpbtCtbK7nKFn7ljl xHQUf9ayDLY7biMJDKTwl0cdX6lLszPmsvHqkf/qPfLVJmepu6FYIYrEc6Yl3XBCshxE doRIGIMV/jieRd3YVv8mATm7bMUC1gY0F9S5J/bGpZoA2nqfRWOe8hevItj4iAnD3FLE Fcuw== X-Gm-Message-State: AC+VfDzESVOFh3DKTRLZXh9IFgDOHf0J8wUQQhjcOrUw/SQv6+T4r7c2 zmkt4htUSo22tqfUat0ZDvbqTdwUovI= X-Google-Smtp-Source: ACHHUZ6l5RP0/ikc0bFoEqIOE7+0cjfMDe2SeELiqdDqA2CVkgeJsXgs0LfWt6L7uCReI1sEult8/g== X-Received: by 2002:a05:6a20:918a:b0:10b:7400:cef7 with SMTP id v10-20020a056a20918a00b0010b7400cef7mr5828869pzd.17.1685514612988; Tue, 30 May 2023 23:30:12 -0700 (PDT) Received: from debian.me (subs02-180-214-232-81.three.co.id. [180.214.232.81]) by smtp.gmail.com with ESMTPSA id b15-20020aa7810f000000b0064ceb16a1a2sm2586467pfi.182.2023.05.30.23.30.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 May 2023 23:30:12 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 5E445106A0B; Wed, 31 May 2023 13:30:08 +0700 (WIB) Date: Wed, 31 May 2023 13:30:07 +0700 From: Bagas Sanjaya To: Conor Dooley , soc@kernel.org Cc: conor@kernel.org, corbet@lwn.net, devicetree@vger.kernel.org, krzysztof.kozlowski+dt@linaro.org, linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-riscv@lists.infradead.org, olof@lixom.net, palmer@dabbelt.com, robh+dt@kernel.org, arnd@arndb.de Subject: Re: [PATCH v2] Documentation/process: add soc maintainer handbook Message-ID: References: <20230530-multiple-whooping-ee5706fceb67@wendy> MIME-Version: 1.0 In-Reply-To: <20230530-multiple-whooping-ee5706fceb67@wendy> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230530_233015_668691_579F6985 X-CRM114-Status: GOOD ( 35.84 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: multipart/mixed; boundary="===============0588867253651770690==" Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org --===============0588867253651770690== Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="yfE+yvsUjvQ597xx" Content-Disposition: inline --yfE+yvsUjvQ597xx Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Tue, May 30, 2023 at 01:49:36PM +0100, Conor Dooley wrote: > diff --git a/Documentation/process/maintainer-soc.rst b/Documentation/pro= cess/maintainer-soc.rst > new file mode 100644 > index 000000000000..9683c7d199b2 > --- /dev/null > +++ b/Documentation/process/maintainer-soc.rst > @@ -0,0 +1,178 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +.. _maintainer-soc: > + > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +SoC Subsystem > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +Overview > +-------- > + > +The SoC subsystem is a place of aggregation for SoC-specific code. > +The main components of the subsystem are: > + > +* devicetrees for 32- & 64-bit ARM and RISC-V > +* 32-bit ARM board files (arch/arm/mach*) > +* 32- & 64-bit ARM defconfigs > +* SoC specific drivers across architectures, in particular for 32- & 64-= bit > + ARM, RISC-V and Loongarch > + > +These "SoC specific drivers" do not include clock, GPIO etc drivers that= have > +other top-level maintainers. The drivers/soc/ directory is generally mea= nt > +for kernel-internal drivers that are used by other drivers to provide SoC > +specific functionality like identifying a SoC revision or interfacing wi= th > +power domains. > + > +The SoC subsystem also serves as an intermediate location for changes to > +drivers/bus, drivers/firmware, drivers/reset and drivers/memory. The ad= dition > +of new platforms, or the removal of existing ones, often go through the = SoC > +tree as a dedicated branch covering multiple subsystems. > + > +The main SoC tree is housed on git.kernel.org: > + https://git.kernel.org/pub/scm/linux/kernel/git/soc/soc.git/ > + > +Clearly this is quite a wide range of topics, which no one person, or ev= en > +small group of people are capable of maintaining. Instead, the SoC subs= ystem > +is comprised of many submaintainers, each taking care of individual plat= forms > +and driver sub-directories. > +In this regard, "platform" usually refers to a series of SoCs from a giv= en > +vendor, for example, Nvidia's series of Tegra SoCs. Many submaintainers= operate > +on a vendor level, responsible for multiple product lines. For several = reasons, > +including acquisitions/different business units in a company, things vary > +significantly here. The various submaintainers are documented in the > +MAINTAINERS file. > + > +Most of these submaintainers have their own trees where they stage patch= es, > +sending pull requests to the main SoC tree. These trees are usually, bu= t not > +always, listed in MAINTAINERS. The main SoC maintainers can be reached = via the > +alias soc@kernel.org if there is no platform-specific maintainer, or if = they > +are unresponsive. > + > +What the SoC tree is not, however, is a location for architecture specif= ic code > +changes. Each architecture has it's own maintainers that are responsibl= e for > +architectural details, cpu errata and the like. > + > +Information for (new) Submaintainers > +------------------------------------ > + > +As new platforms spring up, they often bring with them new submaintainer= s, > +many of whom work for the silicon vendor, and may not be familiar with t= he > +process. > + > +Devicetree ABI Stability > +~~~~~~~~~~~~~~~~~~~~~~~~ > + > +Perhaps one of the most important things to highlight is that dt-bindings > +document the ABI between the devicetree and the kernel. Please see > +:ref:`devicetree-abi` more information on the ABI. > + > +If changes are being made to a devicetree that are incompatible with old > +kernels, the devicetree patch should not be applied until the driver is,= or an Until the incompatible driver changes are merged? > +appropriate time later. Most importantly, any incompatible changes shou= ld be > +clearly pointed out in the patch description and pull request, along wit= h the > +expected impact on existing users, such as bootloaders or other operating > +systems. > + > +Driver Branch Dependencies > +~~~~~~~~~~~~~~~~~~~~~~~~~~ > + > +A common problem is synchronizing changes between device drivers and dev= icetree > +files, even if a change is compatible in both directions, this may requi= re > +coordinating how the changes get merged through different maintainer tre= es. > + > +Usually the branch that includes a driver change will also include the > +corresponding change to the devicetree binding description, to ensure th= ey are > +in fact compatible. This means that the devicetree branch can end up ca= using > +warnings in the "make dtbs_check" step. If a devicetree change depends = on > +missing additions to a header file in include/dt-bindings/, it will fail= the > +"make dtbs" step and not get merged. Sounds like passing `make dtbs` is a merging requirement. > +Pull requests for bugfixes for the current release can be sent at any ti= me, but > +again having multiple smaller branches is better than trying to combine = too many > +patches into one pull request. > + > +The subject line of a pull request should begin with "[GIT PULL]" and ma= de using > +a signed tag, rather than a branch. This tag should contain a short des= cription > +summarising the changes in the pull request. For more detail on sending= pull > +requests, please see :ref:`pullrequests`. As jon had said, I simply prefer to write the last cross-ref as: ``` =2E.. For more details on sending pull requests, see Documentation/maintain= er/pull-requests.rst. ``` Thanks. --=20 An old man doll... just what I always wanted! - Clara --yfE+yvsUjvQ597xx Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZHbpaQAKCRD2uYlJVVFO o2CWAP9q7oPy97dPSpBlxmb3b8mi73z4mh1PJl8kp27n5DmHDAEA+JxXgVRwCfXd gpWxS2SpGlRx9lJqq4W6qaQbA+LF1Ac= =uOGN -----END PGP SIGNATURE----- --yfE+yvsUjvQ597xx-- --===============0588867253651770690== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel --===============0588867253651770690==--