Re: [PATCH v2 1/2] Documentation: bindings: add dt documentation for Rockchip PCIe PHY

From: Rob Herring
Date: Thu Jun 16 2016 - 14:46:39 EST


On Tue, Jun 14, 2016 at 10:27:46AM -0700, Doug Anderson wrote:
> Hi,
>
> On Mon, Jun 13, 2016 at 5:44 PM, Shawn Lin <shawn.lin@xxxxxxxxxxxxxx> wrote:
> > This patch adds a binding that describes the Rockchip PCIe PHY
> > found on Rockchip SoCs PCIe interface.
> >
> > Signed-off-by: Shawn Lin <shawn.lin@xxxxxxxxxxxxxx>
> >
> > ---
> >
> > Changes in v2:
> > - add clk and reset description
> > - remove unit-address
> >
> > .../devicetree/bindings/phy/rockchip-pcie-phy.txt | 32 ++++++++++++++++++++++
> > 1 file changed, 32 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/phy/rockchip-pcie-phy.txt
> >
> > diff --git a/Documentation/devicetree/bindings/phy/rockchip-pcie-phy.txt b/Documentation/devicetree/bindings/phy/rockchip-pcie-phy.txt
> > new file mode 100644
> > index 0000000..ad55c67
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/phy/rockchip-pcie-phy.txt
> > @@ -0,0 +1,32 @@
> > +Rockchip PCIE PHY
> > +-----------------------
> > +
> > +Required properties:
> > + - compatible: rockchip,rk3399-pcie-phy
> > + - #phy-cells: must be 0
> > + - clocks: Must contain an entry in clock-names.
> > + See ../clocks/clock-bindings.txt for details.
> > + - clock-names: Must be "refclk"
> > + - resets: Must contain an entry in reset-names.
> > + See ../reset/reset.txt for details.
> > + - reset-names: Must be "phy"
> > +
> > +Example:
> > +
> > +grf: syscon@ff770000 {
> > + compatible = "rockchip,rk3399-grf", "syscon", "simple-mfd";
> > + #address-cells = <1>;
> > + #size-cells = <1>;
> > +
> > + ...
> > +
> > + pcie-phy: phy {
>
> Just calling this node "phy" isn't a good idea. There will be
> multiple PHYs under the GRF and they can't all have a subnode named
> "phy".

There's no register range that can be associated with the phy?
>
> Also: at least in Rockchip device trees usually aliases use
> underscores whereas node names use dashes. I'm not actually sure what
> the official device tree policy is on this, but it's what I've seen
> done. So this should actually be:

Labels don't matter as they don't end up in the dtb. Node names should
be generic. though we've only defined a small set of generic names. And
yes, use '-' not '_'.

Rob