Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review

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>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>

authored by

Douglas Anderson and committed by
Kishon Vijay Abraham I
2f2ce8fe 5b394b2d

+11 -8
+11 -8
Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt
··· 12 12 "qcom,sdm845-qmp-usb3-phy" for USB3 QMP V3 phy on sdm845, 13 13 "qcom,sdm845-qmp-usb3-uni-phy" for USB3 QMP V3 UNI phy on sdm845. 14 14 15 - - reg: 16 - - For "qcom,sdm845-qmp-usb3-phy": 17 - - index 0: address and length of register set for PHY's common serdes 18 - block. 19 - - named register "dp_com" (using reg-names): address and length of the 20 - DP_COM control block. 21 - - For all others: 22 - - offset and length of register set for PHY's common serdes block. 15 + - reg: 16 + - index 0: address and length of register set for PHY's common 17 + serdes block. 18 + - index 1: address and length of the DP_COM control block (for 19 + "qcom,sdm845-qmp-usb3-phy" only). 20 + 21 + - reg-names: 22 + - For "qcom,sdm845-qmp-usb3-phy": 23 + - Should be: "reg-base", "dp_com" 24 + - For all others: 25 + - The reg-names property shouldn't be defined. 23 26 24 27 - #clock-cells: must be 1 25 28 - Phy pll outputs a bunch of clocks for Tx, Rx and Pipe