* [PATCH] dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review
@ 2018-08-07 5:14 Douglas Anderson
2018-08-14 20:12 ` Rob Herring
0 siblings, 1 reply; 2+ messages in thread
From: Douglas Anderson @ 2018-08-07 5:14 UTC (permalink / raw)
To: Rob Herring, Kishon Vijay Abraham I
Cc: Douglas Anderson, devicetree, linux-kernel, Manu Gautam,
Mark Rutland, Varadarajan Narayanan
After the commit 8b1087fa3a27 ("phy: qcom-qmp: Fix dts bindings to
reflect reality") landed there was some review feedback that 'reg'
should have been documented differently. Fix it as per review
feedback.
As per that feedback:
- Subject should have been 'dt-bindings: phy:' which this patch now
has.
- We should leave no ambiguity in the ordering of 'reg' ranges even if
'reg-names' are also specified.
- Normally using reg-names is discouraged unless there's a strong
reason it's needed (like if there are optional ranges). In this
case reg-names wasn't needed but the driver already landed relying
on reg-names so we'll just document it and move on.
Fixes: 8b1087fa3a27 ("phy: qcom-qmp: Fix dts bindings to reflect reality")
Suggested-by: Rob Herring <robh@kernel.org>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
---
.../devicetree/bindings/phy/qcom-qmp-phy.txt | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt b/Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt
index 0c7629e88bf3..2b161bf15d5d 100644
--- a/Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt
+++ b/Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt
@@ -12,14 +12,17 @@ Required properties:
"qcom,sdm845-qmp-usb3-phy" for USB3 QMP V3 phy on sdm845,
"qcom,sdm845-qmp-usb3-uni-phy" for USB3 QMP V3 UNI phy on sdm845.
- - reg:
- - For "qcom,sdm845-qmp-usb3-phy":
- - index 0: address and length of register set for PHY's common serdes
- block.
- - named register "dp_com" (using reg-names): address and length of the
- DP_COM control block.
- - For all others:
- - offset and length of register set for PHY's common serdes block.
+- reg:
+ - index 0: address and length of register set for PHY's common
+ serdes block.
+ - index 1: address and length of the DP_COM control block (for
+ "qcom,sdm845-qmp-usb3-phy" only).
+
+- reg-names:
+ - For "qcom,sdm845-qmp-usb3-phy":
+ - Should be: "reg-base", "dp_com"
+ - For all others:
+ - The reg-names property shouldn't be defined.
- #clock-cells: must be 1
- Phy pll outputs a bunch of clocks for Tx, Rx and Pipe
--
2.18.0.597.ga71716f1ad-goog
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review
2018-08-07 5:14 [PATCH] dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review Douglas Anderson
@ 2018-08-14 20:12 ` Rob Herring
0 siblings, 0 replies; 2+ messages in thread
From: Rob Herring @ 2018-08-14 20:12 UTC (permalink / raw)
To: Douglas Anderson
Cc: Kishon Vijay Abraham I, Douglas Anderson, devicetree,
linux-kernel, Manu Gautam, Mark Rutland, Varadarajan Narayanan
On Mon, 6 Aug 2018 22:14:12 -0700, Douglas Anderson <dianders@chromium.org> wrote:
> After the commit 8b1087fa3a27 ("phy: qcom-qmp: Fix dts bindings to
> reflect reality") landed there was some review feedback that 'reg'
> should have been documented differently. Fix it as per review
> feedback.
>
> As per that feedback:
> - Subject should have been 'dt-bindings: phy:' which this patch now
> has.
> - We should leave no ambiguity in the ordering of 'reg' ranges even if
> 'reg-names' are also specified.
> - Normally using reg-names is discouraged unless there's a strong
> reason it's needed (like if there are optional ranges). In this
> case reg-names wasn't needed but the driver already landed relying
> on reg-names so we'll just document it and move on.
>
> Fixes: 8b1087fa3a27 ("phy: qcom-qmp: Fix dts bindings to reflect reality")
> Suggested-by: Rob Herring <robh@kernel.org>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
>
> .../devicetree/bindings/phy/qcom-qmp-phy.txt | 19 +++++++++++--------
> 1 file changed, 11 insertions(+), 8 deletions(-)
>
Reviewed-by: Rob Herring <robh@kernel.org>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-08-14 20:12 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-08-07 5:14 [PATCH] dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review Douglas Anderson
2018-08-14 20:12 ` Rob Herring
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).