| Message ID | 20240209181831.104687-4-sebastian.reichel@collabora.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | RK3588 USBDP support | expand |
Hi, Am Freitag, 9. Februar 2024, 19:17:19 CET schrieb Sebastian Reichel: > Add device tree binding document for Rockchip USBDP Combo PHY > with Samsung IP block. > > Co-developed-by: Frank Wang <frank.wang@rock-chips.com> > Signed-off-by: Frank Wang <frank.wang@rock-chips.com> > Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com> looks ok to me overall, but I stumbled over some spelling below. > --- > .../bindings/phy/phy-rockchip-usbdp.yaml | 166 ++++++++++++++++++ > 1 file changed, 166 insertions(+) > create mode 100644 Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml > > diff --git a/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml b/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml > new file mode 100644 > index 000000000000..3375a3099038 > --- /dev/null > +++ b/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml > @@ -0,0 +1,166 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/phy/phy-rockchip-usbdp.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Rockchip USBDP Combo PHY with Samsung IP block > + > +maintainers: > + - Frank Wang <frank.wang@rock-chips.com> > + - Zhang Yubing <yubing.zhang@rock-chips.com> > + > +properties: > + compatible: > + enum: > + - rockchip,rk3588-usbdp-phy > + > + reg: > + maxItems: 1 > + > + clocks: > + maxItems: 4 > + > + clock-names: > + items: > + - const: refclk > + - const: immortal > + - const: pclk > + - const: utmi > + > + resets: > + maxItems: 5 > + > + reset-names: > + items: > + - const: init > + - const: cmn > + - const: lane > + - const: pcs_apb > + - const: pma_apb > + > + rockchip,dp-lane-mux: > + $ref: /schemas/types.yaml#/definitions/uint32-array > + minItems: 2 > + maxItems: 4 > + description: > + An array of physical Tyep-C lanes indexes. Position of an entry determines nit: Type-C lane indexes > + the dp lane index, while the value of an entry indicater physical Type-C lane. nit: indicates instead of indicater? > + The support dp lanes number are 2 or 4. e.g. for 2 lanes dp lanes map, we could nit: The supported dp lane numbers ... ? > + have "rockchip,dp-lane-mux = <2, 3>;", assuming dp lane0 on Type-C phy lane2, > + dp lane1 on Type-C phy lane3. For 4 lanes dp lanes map, we could have > + "rockchip,dp-lane-mux = <0, 1, 2, 3>;", assuming dp lane0 on Type-C phy lane0, > + dp lane1 on Type-C phy lane1, dp lane2 on Type-C phy lane2, dp lane3 on Type-C > + phy lane3. If dp lane map by DisplayPort Alt mode, this property is not need. > + > + rockchip,u2phy-grf: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + Phandle to the syscon managing the 'usb2 phy general register files'. > + > + rockchip,usb-grf: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + Phandle to the syscon managing the 'usb general register files'. > + > + rockchip,usbdpphy-grf: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + Phandle to the syscon managing the 'usbdp phy general register files'. > + > + rockchip,vo-grf: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + Phandle to the syscon managing the 'video output general register files'. > + When select the dp lane mapping will request its phandle. > + > + sbu1-dc-gpios: > + description: > + GPIO connected to the SBU1 line of the USB-C connector via a big resistor > + (~100K) to apply a DC offset for signalling the connector orientation. > + > + sbu2-dc-gpios: > + description: > + GPIO connected to the SBU2 line of the USB-C connector via a big resistor > + (~100K) to apply a DC offset for signalling the connector orientation. > + > + orientation-switch: > + description: Flag the port as possible handler of orientation switching > + type: boolean > + > + mode-switch: > + description: Flag the port as possible handle of altmode switching nit: also a handler ... aka add an r ? Heiko
On Fri, Feb 09, 2024 at 11:17:40PM +0100, Heiko Stübner wrote: > Am Freitag, 9. Februar 2024, 19:17:19 CET schrieb Sebastian Reichel: > > + rockchip,dp-lane-mux: Why "mux" and not "map"? > > + $ref: /schemas/types.yaml#/definitions/uint32-array > > + minItems: 2 > > + maxItems: 4 > > + description: > > + An array of physical Tyep-C lanes indexes. Position of an entry determines > > nit: Type-C lane indexes > > > + the dp lane index, while the value of an entry indicater physical Type-C lane. > > nit: indicates instead of indicater? If we are talking nits, the first use of "dp" should be "DisplayPort (DP)" and s/dp/DP/ elsewhere. > > > + The support dp lanes number are 2 or 4. e.g. for 2 lanes dp lanes map, we could > > nit: The supported dp lane numbers ... ? > > > > + have "rockchip,dp-lane-mux = <2, 3>;", assuming dp lane0 on Type-C phy lane2, > > + dp lane1 on Type-C phy lane3. For 4 lanes dp lanes map, we could have > > + "rockchip,dp-lane-mux = <0, 1, 2, 3>;", assuming dp lane0 on Type-C phy lane0, > > + dp lane1 on Type-C phy lane1, dp lane2 on Type-C phy lane2, dp lane3 on Type-C > > + phy lane3. And > If dp lane map by DisplayPort Alt mode, this property is not need. "If DP lanes are mapped by" "not needed." Cheers, Conor.
diff --git a/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml b/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml new file mode 100644 index 000000000000..3375a3099038 --- /dev/null +++ b/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml @@ -0,0 +1,166 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/phy/phy-rockchip-usbdp.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Rockchip USBDP Combo PHY with Samsung IP block + +maintainers: + - Frank Wang <frank.wang@rock-chips.com> + - Zhang Yubing <yubing.zhang@rock-chips.com> + +properties: + compatible: + enum: + - rockchip,rk3588-usbdp-phy + + reg: + maxItems: 1 + + clocks: + maxItems: 4 + + clock-names: + items: + - const: refclk + - const: immortal + - const: pclk + - const: utmi + + resets: + maxItems: 5 + + reset-names: + items: + - const: init + - const: cmn + - const: lane + - const: pcs_apb + - const: pma_apb + + rockchip,dp-lane-mux: + $ref: /schemas/types.yaml#/definitions/uint32-array + minItems: 2 + maxItems: 4 + description: + An array of physical Tyep-C lanes indexes. Position of an entry determines + the dp lane index, while the value of an entry indicater physical Type-C lane. + The support dp lanes number are 2 or 4. e.g. for 2 lanes dp lanes map, we could + have "rockchip,dp-lane-mux = <2, 3>;", assuming dp lane0 on Type-C phy lane2, + dp lane1 on Type-C phy lane3. For 4 lanes dp lanes map, we could have + "rockchip,dp-lane-mux = <0, 1, 2, 3>;", assuming dp lane0 on Type-C phy lane0, + dp lane1 on Type-C phy lane1, dp lane2 on Type-C phy lane2, dp lane3 on Type-C + phy lane3. If dp lane map by DisplayPort Alt mode, this property is not need. + + rockchip,u2phy-grf: + $ref: /schemas/types.yaml#/definitions/phandle + description: + Phandle to the syscon managing the 'usb2 phy general register files'. + + rockchip,usb-grf: + $ref: /schemas/types.yaml#/definitions/phandle + description: + Phandle to the syscon managing the 'usb general register files'. + + rockchip,usbdpphy-grf: + $ref: /schemas/types.yaml#/definitions/phandle + description: + Phandle to the syscon managing the 'usbdp phy general register files'. + + rockchip,vo-grf: + $ref: /schemas/types.yaml#/definitions/phandle + description: + Phandle to the syscon managing the 'video output general register files'. + When select the dp lane mapping will request its phandle. + + sbu1-dc-gpios: + description: + GPIO connected to the SBU1 line of the USB-C connector via a big resistor + (~100K) to apply a DC offset for signalling the connector orientation. + + sbu2-dc-gpios: + description: + GPIO connected to the SBU2 line of the USB-C connector via a big resistor + (~100K) to apply a DC offset for signalling the connector orientation. + + orientation-switch: + description: Flag the port as possible handler of orientation switching + type: boolean + + mode-switch: + description: Flag the port as possible handle of altmode switching + type: boolean + + dp-port: + type: object + additionalProperties: false + + properties: + "#phy-cells": + const: 0 + + required: + - "#phy-cells" + + usb3-port: + type: object + additionalProperties: false + + properties: + "#phy-cells": + const: 0 + + required: + - "#phy-cells" + + port: + $ref: /schemas/graph.yaml#/properties/port + description: + A port node to link the PHY to a TypeC controller for the purpose of + handling orientation switching. + +required: + - compatible + - reg + - clocks + - clock-names + - resets + - reset-names + - dp-port + - usb3-port + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/rockchip,rk3588-cru.h> + #include <dt-bindings/reset/rockchip,rk3588-cru.h> + + usbdp_phy0: phy@fed80000 { + compatible = "rockchip,rk3588-usbdp-phy"; + reg = <0xfed80000 0x10000>; + rockchip,u2phy-grf = <&usb2phy0_grf>; + rockchip,usb-grf = <&usb_grf>; + rockchip,usbdpphy-grf = <&usbdpphy0_grf>; + rockchip,vo-grf = <&vo0_grf>; + clocks = <&cru CLK_USBDPPHY_MIPIDCPPHY_REF>, + <&cru CLK_USBDP_PHY0_IMMORTAL>, + <&cru PCLK_USBDPPHY0>, + <&u2phy0>; + clock-names = "refclk", "immortal", "pclk", "utmi"; + resets = <&cru SRST_USBDP_COMBO_PHY0_INIT>, + <&cru SRST_USBDP_COMBO_PHY0_CMN>, + <&cru SRST_USBDP_COMBO_PHY0_LANE>, + <&cru SRST_USBDP_COMBO_PHY0_PCS>, + <&cru SRST_P_USBDPPHY0>; + reset-names = "init", "cmn", "lane", "pcs_apb", "pma_apb"; + + usbdp_phy0_dp: dp-port { + #phy-cells = <0>; + }; + + usbdp_phy0_u3: usb3-port { + #phy-cells = <0>; + }; + };