From: "Rob Herring (Arm)" <robh@kernel.org>
To: Krzysztof Kozlowski <krzk+dt@kernel.org>,
Conor Dooley <conor+dt@kernel.org>, Chen-Yu Tsai <wens@csie.org>,
Jernej Skrabec <jernej.skrabec@gmail.com>,
Samuel Holland <samuel@sholland.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
Viresh Kumar <viresh.kumar@linaro.org>,
Matthias Brugger <matthias.bgg@gmail.com>,
AngeloGioacchino Del Regno
<angelogioacchino.delregno@collabora.com>,
Vincenzo Frascino <vincenzo.frascino@arm.com>,
Liviu Dudau <liviu.dudau@arm.com>,
Sudeep Holla <sudeep.holla@arm.com>,
Lorenzo Pieralisi <lpieralisi@kernel.org>,
Bjorn Andersson <andersson@kernel.org>,
Konrad Dybcio <konradybcio@kernel.org>,
Thomas Bogendoerfer <tsbogend@alpha.franken.de>,
Viresh Kumar <vireshk@kernel.org>, Nishanth Menon <nm@ti.com>,
Stephen Boyd <sboyd@kernel.org>,
zhouyanjie@wanyeetech.com, Conor Dooley <conor@kernel.org>,
Nicolas Ferre <nicolas.ferre@microchip.com>,
Claudiu Beznea <claudiu.beznea@tuxon.dev>,
Steen Hegelund <Steen.Hegelund@microchip.com>,
Daniel Machon <daniel.machon@microchip.com>,
UNGLinuxDriver@microchip.com, Shawn Guo <shawnguo@kernel.org>,
Sascha Hauer <s.hauer@pengutronix.de>,
Pengutronix Kernel Team <kernel@pengutronix.de>,
Fabio Estevam <festevam@gmail.com>,
Heiko Stuebner <heiko@sntech.de>,
Neil Armstrong <neil.armstrong@linaro.org>,
Kevin Hilman <khilman@baylibre.com>,
Jerome Brunet <jbrunet@baylibre.com>,
Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
Geert Uytterhoeven <geert+renesas@glider.be>,
Magnus Damm <magnus.damm@gmail.com>
Cc: devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-sunxi@lists.linux.dev, linux-kernel@vger.kernel.org,
linux-pm@vger.kernel.org, linux-mediatek@lists.infradead.org,
linux-arm-msm@vger.kernel.org, linux-mips@vger.kernel.org,
imx@lists.linux.dev, linux-rockchip@lists.infradead.org,
linux-amlogic@lists.infradead.org,
linux-renesas-soc@vger.kernel.org
Subject: [PATCH 15/19] dt-bindings: arm/cpus: Re-wrap 'description' entries
Date: Thu, 03 Apr 2025 21:59:36 -0500 [thread overview]
Message-ID: <20250403-dt-cpu-schema-v1-15-076be7171a85@kernel.org> (raw)
In-Reply-To: <20250403-dt-cpu-schema-v1-0-076be7171a85@kernel.org>
Some of the 'description' entries have odd line wrapping and incorrect
YAML block modifiers. The 'description' entries should typically wrap
at 80 chars. Reformat the entries to follow that along with using '>'
modifiers as appropriate.
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
---
Documentation/devicetree/bindings/arm/cpus.yaml | 85 +++++++++++--------------
1 file changed, 36 insertions(+), 49 deletions(-)
diff --git a/Documentation/devicetree/bindings/arm/cpus.yaml b/Documentation/devicetree/bindings/arm/cpus.yaml
index 963a9320cba8..3e76de3e950d 100644
--- a/Documentation/devicetree/bindings/arm/cpus.yaml
+++ b/Documentation/devicetree/bindings/arm/cpus.yaml
@@ -10,9 +10,9 @@ maintainers:
- Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
description: |+
- The device tree allows to describe the layout of CPUs in a system through
- the "cpus" node, which in turn contains a number of subnodes (ie "cpu")
- defining properties for every cpu.
+ The device tree allows to describe the layout of CPUs in a system through the
+ "cpus" node, which in turn contains a number of subnodes (ie "cpu") defining
+ properties for every cpu.
Bindings for CPU nodes follow the Devicetree Specification, available from:
@@ -41,45 +41,40 @@ description: |+
properties:
reg:
maxItems: 1
- description: |
- Usage and definition depend on ARM architecture version and
- configuration:
+ description: >
+ Usage and definition depend on ARM architecture version and configuration:
- On uniprocessor ARM architectures previous to v7
- this property is required and must be set to 0.
+ On uniprocessor ARM architectures previous to v7 this property is required
+ and must be set to 0.
- On ARM 11 MPcore based systems this property is
- required and matches the CPUID[11:0] register bits.
+ On ARM 11 MPcore based systems this property is required and matches the
+ CPUID[11:0] register bits.
- Bits [11:0] in the reg cell must be set to
- bits [11:0] in CPU ID register.
+ Bits [11:0] in the reg cell must be set to bits [11:0] in CPU ID register.
All other bits in the reg cell must be set to 0.
- On 32-bit ARM v7 or later systems this property is
- required and matches the CPU MPIDR[23:0] register
- bits.
+ On 32-bit ARM v7 or later systems this property is required and matches
+ the CPU MPIDR[23:0] register bits.
- Bits [23:0] in the reg cell must be set to
- bits [23:0] in MPIDR.
+ Bits [23:0] in the reg cell must be set to bits [23:0] in MPIDR.
All other bits in the reg cell must be set to 0.
- On ARM v8 64-bit systems this property is required
- and matches the MPIDR_EL1 register affinity bits.
+ On ARM v8 64-bit systems this property is required and matches the
+ MPIDR_EL1 register affinity bits.
* If cpus node's #address-cells property is set to 2
- The first reg cell bits [7:0] must be set to
- bits [39:32] of MPIDR_EL1.
+ The first reg cell bits [7:0] must be set to bits [39:32] of
+ MPIDR_EL1.
- The second reg cell bits [23:0] must be set to
- bits [23:0] of MPIDR_EL1.
+ The second reg cell bits [23:0] must be set to bits [23:0] of
+ MPIDR_EL1.
* If cpus node's #address-cells property is set to 1
- The reg cell bits [23:0] must be set to bits [23:0]
- of MPIDR_EL1.
+ The reg cell bits [23:0] must be set to bits [23:0] of MPIDR_EL1.
All other bits in the reg cells must be set to 0.
@@ -278,29 +273,26 @@ properties:
$ref: /schemas/types.yaml#/definitions/phandle-array
items:
maxItems: 1
- description: |
- List of phandles to idle state nodes supported
- by this cpu (see ./idle-states.yaml).
+ description:
+ List of phandles to idle state nodes supported by this cpu (see
+ ./idle-states.yaml).
capacity-dmips-mhz:
description:
u32 value representing CPU capacity (see ../cpu/cpu-capacity.txt) in
- DMIPS/MHz, relative to highest capacity-dmips-mhz
- in the system.
+ DMIPS/MHz, relative to highest capacity-dmips-mhz in the system.
cci-control-port: true
dynamic-power-coefficient:
$ref: /schemas/types.yaml#/definitions/uint32
- description:
- A u32 value that represents the running time dynamic
- power coefficient in units of uW/MHz/V^2. The
- coefficient can either be calculated from power
+ description: >
+ A u32 value that represents the running time dynamic power coefficient in
+ units of uW/MHz/V^2. The coefficient can either be calculated from power
measurements or derived by analysis.
- The dynamic power consumption of the CPU is
- proportional to the square of the Voltage (V) and
- the clock frequency (f). The coefficient is used to
+ The dynamic power consumption of the CPU is proportional to the square of
+ the Voltage (V) and the clock frequency (f). The coefficient is used to
calculate the dynamic power as below -
Pdyn = dynamic-power-coefficient * V^2 * f
@@ -309,10 +301,6 @@ properties:
performance-domains:
maxItems: 1
- description:
- List of phandles and performance domain specifiers, as defined by
- bindings of the performance domain provider. See also
- dvfs/performance-domain.yaml.
power-domains:
description:
@@ -341,22 +329,21 @@ properties:
rockchip,pmu:
$ref: /schemas/types.yaml#/definitions/phandle
- description: |
+ description: >
Specifies the syscon node controlling the cpu core power domains.
- Optional for systems that have an "enable-method"
- property value of "rockchip,rk3066-smp"
- While optional, it is the preferred way to get access to
- the cpu-core power-domains.
+ Optional for systems that have an "enable-method" property value of
+ "rockchip,rk3066-smp". While optional, it is the preferred way to get
+ access to the cpu-core power-domains.
secondary-boot-reg:
$ref: /schemas/types.yaml#/definitions/uint32
- description: |
+ description: >
Required for systems that have an "enable-method" property value of
"brcm,bcm11351-cpu-method", "brcm,bcm23550" or "brcm,bcm-nsp-smp".
- This includes the following SoCs: |
- BCM11130, BCM11140, BCM11351, BCM28145, BCM28155, BCM21664, BCM23550
+ This includes the following SoCs:
+ BCM11130, BCM11140, BCM11351, BCM28145, BCM28155, BCM21664, BCM23550,
BCM58522, BCM58525, BCM58535, BCM58622, BCM58623, BCM58625, BCM88312
The secondary-boot-reg property is a u32 value that specifies the
--
2.47.2
next prev parent reply other threads:[~2025-04-04 3:00 UTC|newest]
Thread overview: 61+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-04 2:59 [PATCH 00/19] Arm cpu schema clean-ups Rob Herring (Arm)
2025-04-04 2:59 ` [PATCH 01/19] arm64: dts: allwinner: h5/h6: Drop spurious 'clock-latency-ns' properties Rob Herring (Arm)
2025-04-04 12:39 ` Andre Przywara
2025-04-10 6:43 ` Jernej Škrabec
2025-04-04 2:59 ` [PATCH 02/19] arm64: dts: broadcom: bcm2712: Use "l2-cache" for L2 cache node names Rob Herring (Arm)
2025-04-10 12:36 ` Philippe Mathieu-Daudé
2025-04-04 2:59 ` [PATCH 03/19] arm64: dts: morello: Fix-up cache nodes Rob Herring (Arm)
2025-04-10 12:37 ` Philippe Mathieu-Daudé
2025-04-10 14:12 ` Sudeep Holla
2025-04-04 2:59 ` [PATCH 04/19] arm64: dts: microchip: sparx5: Fix CPU node "enable-method" property dependencies Rob Herring (Arm)
2025-04-04 9:43 ` Daniel Machon
2025-04-04 2:59 ` [PATCH 05/19] arm64: dts: qcom: qdu1000: Fix qcom,freq-domain Rob Herring (Arm)
2025-04-04 20:28 ` Konrad Dybcio
2025-04-04 2:59 ` [PATCH 06/19] arm64: dts: qcom: msm8939: Fix CPU node "enable-method" property dependencies Rob Herring (Arm)
2025-04-04 12:04 ` Stephan Gerhold
2025-04-04 13:18 ` Rob Herring
2025-04-04 14:10 ` Rob Herring
2025-04-04 2:59 ` [PATCH 07/19] arm64: dts: qcom: msm8992-lg-h815: " Rob Herring (Arm)
2025-04-04 20:30 ` Konrad Dybcio
2025-04-04 20:32 ` Konrad Dybcio
2025-04-05 14:42 ` Alexander Reimelt
2025-04-04 2:59 ` [PATCH 08/19] arm: dts: qcom: msm8916: Move "qcom,acc" and "qcom,saw" to 32-bit .dtsi Rob Herring (Arm)
2025-04-04 2:59 ` [PATCH 09/19] arm: dts: qcom: sdx55/sdx65: Fix CPU power-domain-names Rob Herring (Arm)
2025-04-04 10:30 ` Ulf Hansson
2025-04-04 14:05 ` Rob Herring
2025-04-04 20:41 ` Konrad Dybcio
2025-04-07 16:27 ` Ulf Hansson
2025-04-09 18:35 ` Konrad Dybcio
2025-04-10 7:10 ` Stephan Gerhold
2025-04-10 16:25 ` Konrad Dybcio
2025-04-04 2:59 ` [PATCH 10/19] arm/arm64: dts: imx: Drop redundant CPU "clock-latency" Rob Herring (Arm)
2025-04-04 2:59 ` [PATCH 11/19] arm: dts: qcom: ipq4019: " Rob Herring (Arm)
2025-04-04 20:42 ` Konrad Dybcio
2025-04-04 2:59 ` [PATCH 12/19] arm: dts: rockchip: " Rob Herring (Arm)
2025-04-04 2:59 ` [PATCH 13/19] arm64: dts: amlogic: " Rob Herring (Arm)
2025-04-04 7:11 ` Neil Armstrong
2025-04-04 2:59 ` [PATCH 14/19] dt-bindings: arm/cpus: Add schemas for "enable-method" dependencies Rob Herring (Arm)
2025-04-04 14:56 ` Rob Herring (Arm)
2025-04-10 14:11 ` Rob Herring
2025-04-10 14:14 ` Dmitry Baryshkov
2025-04-07 12:28 ` Sudeep Holla
2025-04-04 2:59 ` Rob Herring (Arm) [this message]
2025-04-04 2:59 ` [PATCH 16/19] dt-bindings: Reference opp-v1 schema in CPU schemas Rob Herring (Arm)
2025-04-04 11:32 ` AngeloGioacchino Del Regno
2025-04-04 2:59 ` [PATCH 17/19] dt-bindings: arm/cpus: Add missing properties Rob Herring (Arm)
2025-04-04 11:32 ` AngeloGioacchino Del Regno
2025-04-04 2:59 ` [PATCH 18/19] dt-bindings: arm/cpus: Add power-domains constraints Rob Herring (Arm)
2025-04-04 10:36 ` Ulf Hansson
2025-04-04 13:09 ` Rob Herring
2025-04-07 16:23 ` Ulf Hansson
2025-04-07 16:50 ` Rob Herring
2025-04-08 12:17 ` Ulf Hansson
2025-04-07 12:30 ` Sudeep Holla
2025-04-07 12:49 ` Rob Herring
2025-04-07 16:18 ` Ulf Hansson
2025-04-04 11:35 ` AngeloGioacchino Del Regno
2025-04-04 2:59 ` [PATCH 19/19] dt-bindings: cpufreq: Drop redundant Mediatek binding Rob Herring (Arm)
2025-04-04 11:32 ` AngeloGioacchino Del Regno
2025-04-07 15:04 ` (subset) [PATCH 00/19] Arm cpu schema clean-ups Conor Dooley
2025-04-08 5:57 ` Viresh Kumar
2025-04-10 14:14 ` Rob Herring
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250403-dt-cpu-schema-v1-15-076be7171a85@kernel.org \
--to=robh@kernel.org \
--cc=Steen.Hegelund@microchip.com \
--cc=UNGLinuxDriver@microchip.com \
--cc=andersson@kernel.org \
--cc=angelogioacchino.delregno@collabora.com \
--cc=claudiu.beznea@tuxon.dev \
--cc=conor+dt@kernel.org \
--cc=conor@kernel.org \
--cc=daniel.machon@microchip.com \
--cc=devicetree@vger.kernel.org \
--cc=festevam@gmail.com \
--cc=geert+renesas@glider.be \
--cc=heiko@sntech.de \
--cc=imx@lists.linux.dev \
--cc=jbrunet@baylibre.com \
--cc=jernej.skrabec@gmail.com \
--cc=kernel@pengutronix.de \
--cc=khilman@baylibre.com \
--cc=konradybcio@kernel.org \
--cc=krzk+dt@kernel.org \
--cc=linux-amlogic@lists.infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=linux-mips@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-renesas-soc@vger.kernel.org \
--cc=linux-rockchip@lists.infradead.org \
--cc=linux-sunxi@lists.linux.dev \
--cc=liviu.dudau@arm.com \
--cc=lpieralisi@kernel.org \
--cc=magnus.damm@gmail.com \
--cc=martin.blumenstingl@googlemail.com \
--cc=matthias.bgg@gmail.com \
--cc=neil.armstrong@linaro.org \
--cc=nicolas.ferre@microchip.com \
--cc=nm@ti.com \
--cc=rafael@kernel.org \
--cc=s.hauer@pengutronix.de \
--cc=samuel@sholland.org \
--cc=sboyd@kernel.org \
--cc=shawnguo@kernel.org \
--cc=sudeep.holla@arm.com \
--cc=tsbogend@alpha.franken.de \
--cc=vincenzo.frascino@arm.com \
--cc=viresh.kumar@linaro.org \
--cc=vireshk@kernel.org \
--cc=wens@csie.org \
--cc=zhouyanjie@wanyeetech.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).