Skip to contentSkip to conversation

usb: phy: add usb phy notify port status API

PATCH Superseded Stanley Chang 3 participants 9 messages Jun 29, 2023 – Jul 3, 2023

Subsystems (3)

v6 of 9 Superseded Latest is v9 →

lore
Share & tools
lore
#0 lore raw

PATCH v6 1/5 usb: phy: add usb phy notify port status API

In Realtek SoC, the parameter of usb phy is designed to can dynamic tuning base on port status. Therefore, add a notify callback of phy driver when usb port status change.

The Realtek phy driver is designed to dynamically adjust disconnection level and calibrate phy parameters. When the device connected bit changes and when the disconnected bit changes, do port status change notification:

Check if portstatus is USB_PORT_STAT_CONNECTION and portchange is USB_PORT_STAT_C_CONNECTION.
1. The device is connected, the driver lowers the disconnection level and calibrates the phy parameters.
2. The device disconnects, the driver increases the disconnect level and calibrates the phy parameters.

When controller to notify connect that device is already ready. If we adjust the disconnection level in notify_connect, the disconnect may have been triggered at this stage. So we need to change that as early as possible. Therefore, we add an api to notify phy the port status changes.

---
v5 to v6 change:
No change
v4 to v5 change:
No change
v3 to v4 change:
Fix the warning for checkpatch with strict.
v2 to v3 change:
Add more comments about the reason for adding this api
v1 to v2 change:
No change

---
 drivers/usb/core/hub.c  | 13 +++++++++++++
 include/linux/usb/phy.h | 13 +++++++++++++
 2 files changed, 26 insertions(+)
drivers/usb/core/hub.c +13 -0
index 97a0f8faea6e..10f3364c3fc2 100644
@@ -614,6 +614,19 @@ static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
 		ret = 0;
 	}
 	mutex_unlock(&hub->status_mutex);
+
+	if (!ret) {
+		struct usb_device *hdev = hub->hdev;
+
+		if (hdev && !hdev->parent) {
+			struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
+
+			if (hcd->usb_phy)
+				usb_phy_notify_port_status(hcd->usb_phy,
+							   port1 - 1, *status, *change);
+		}
+	}
+
 	return ret;
 }
 
include/linux/usb/phy.h +13 -0
index e4de6bc1f69b..b513749582d7 100644
@@ -144,6 +144,10 @@ struct usb_phy {
 	 */
 	int	(*set_wakeup)(struct usb_phy *x, bool enabled);
 
+	/* notify phy port status change */
+	int	(*notify_port_status)(struct usb_phy *x, int port,
+				      u16 portstatus, u16 portchange);
+
 	/* notify phy connect status change */
 	int	(*notify_connect)(struct usb_phy *x,
 			enum usb_device_speed speed);
@@ -316,6 +320,15 @@ usb_phy_set_wakeup(struct usb_phy *x, bool enabled)
 		return 0;
 }
 
+static inline int
+usb_phy_notify_port_status(struct usb_phy *x, int port, u16 portstatus, u16 portchange)
+{
+	if (x && x->notify_port_status)
+		return x->notify_port_status(x, port, portstatus, portchange);
+	else
+		return 0;
+}
+
 static inline int
 usb_phy_notify_connect(struct usb_phy *x, enum usb_device_speed speed)
 {
Signature · 1 line
2.34.1
#1 lore raw

PATCH v6 2/5 phy: realtek: usb: Add driver for the Realtek SoC USB 2.0 PHY

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 2.0 PHY transceivers.

---
v5 to v6 change:
No change
v4 to v5 change:
1. Remove the compatible realtek,usb2phy.
2. Add the compatible data for realtek,rtd1395-usb2phy-2port
3. Remove the set_parameter in debugfs.
4. Revise the error and debug log.
5. Modify the coding style based Krzysztof comments.
v3 to v4 change:
1. Remove the parameter and non hardware properties from dts. Add the compatible data included the config and parameter.
2. Fix the warning for checkpatch with strict.
3. Remove useless debug messages.
4. Fix the incorrect or useless "if() return" which pointer check.
5. Remove the phy power domain control due to we control on other driver.
v2 to v3 change:
1. Broken down into two patches, one for each of USB 2 & 3 PHY.
2. Removed parameter v1 support for simplification.
3. Use remove_new for driver remove callback.
v1 to v2 change:
1. Move the drivers to drivers/phy/ for generic phy driver
2. Use the generic phy driver api to initialize phy
3. Use readl/writel to instead phy_read/phy_write directly.
4. Use read_poll_timeout() in function utmi_wait_register.
5. Revised some coding styles.
6. fix the compiler warning for kernel test robot.

---
 drivers/phy/Kconfig                |    1 +
 drivers/phy/Makefile               |    1 +
 drivers/phy/realtek/Kconfig        |   14 +
 drivers/phy/realtek/Makefile       |    2 +
 drivers/phy/realtek/phy-rtk-usb2.c | 1329 ++++++++++++++++++++++++++++
 5 files changed, 1347 insertions(+)
 create mode 100644 drivers/phy/realtek/Kconfig
 create mode 100644 drivers/phy/realtek/Makefile
 create mode 100644 drivers/phy/realtek/phy-rtk-usb2.c
drivers/phy/Kconfig +1 -0
index f46e3148d286..6d04a0029c6c 100644
@@ -86,6 +86,7 @@ source "drivers/phy/motorola/Kconfig"
 source "drivers/phy/mscc/Kconfig"
 source "drivers/phy/qualcomm/Kconfig"
 source "drivers/phy/ralink/Kconfig"
+source "drivers/phy/realtek/Kconfig"
 source "drivers/phy/renesas/Kconfig"
 source "drivers/phy/rockchip/Kconfig"
 source "drivers/phy/samsung/Kconfig"
drivers/phy/Makefile +1 -0
index 54f312c10a40..ba7c100b14fc 100644
@@ -26,6 +26,7 @@ obj-y					+= allwinner/	\
 					   mscc/	\
 					   qualcomm/	\
 					   ralink/	\
+					   realtek/	\
 					   renesas/	\
 					   rockchip/	\
 					   samsung/	\
drivers/phy/realtek/Kconfig new file +14 -0
new file mode 100644
index 000000000000..2f2f453729d5
@@ -0,0 +1,14 @@
+# SPDX-License-Identifier: GPL-2.0
+#
+# Phy drivers for Realtek platforms
+#
+config PHY_RTK_RTD_USB2PHY
+	tristate "Realtek RTD USB2 PHY Transceiver Driver"
+	depends on USB_SUPPORT
+	select GENERIC_PHY
+	select USB_PHY
+	help
+	  Enable this to support Realtek SoC USB2 phy transceiver.
+	  The DHC (digital home center) RTD series SoCs used the Synopsys
+	  DWC3 USB IP. This driver will do the PHY initialization
+	  of the parameters.
drivers/phy/realtek/Makefile new file +2 -0
new file mode 100644
index 000000000000..cf5d440841a2
@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: GPL-2.0
+obj-$(CONFIG_PHY_RTK_RTD_USB2PHY)	+= phy-rtk-usb2.o
drivers/phy/realtek/phy-rtk-usb2.c new file +1329 -0

1,329 lines not on this page · raw message

Signature · 1 line
2.34.1
#2 lore raw

PATCH v6 3/5 phy: realtek: usb: Add driver for the Realtek SoC USB 3.0 PHY

In reply to Stanley Chang

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 3.0 PHY transceivers.

---
v5 to v6 change:
No change
v4 to v5 change:
1. Remove the compatible realtek,usb3phy.
2. Remove the set_parameter in debugfs.
3. Revise the error and debug log.
v3 to v4 change:
1. Remove the parameter and non hardware properties from dts. Add the compatible data included the config and parameter.
2. Fix the warning for checkpatch with strict.
3. Remove useless debug messages.
4. Fix the incorrect or useless "if() return" which pointer check.
v2 to v3 change:
1. Broken down into two patches, one for each of USB 2 & 3 PHY.
2. Removed parameter v1 support for simplification.
3. Used remove_new for driver remove callback.
v1 to v2 change:
1. Move the drivers to drivers/phy/ for generic phy driver
2. Use the generic phy driver api to initialize phy
3. Use readl/writel to instead phy_read/phy_write directly.
4. Use read_poll_timeout() in function utmi_wait_register.
5. Revised some coding styles.
6. fix the compiler warning for kernel test robot.

---
 drivers/phy/realtek/Kconfig        |  11 +
 drivers/phy/realtek/Makefile       |   1 +
 drivers/phy/realtek/phy-rtk-usb3.c | 766 +++++++++++++++++++++++++++++
 3 files changed, 778 insertions(+)
 create mode 100644 drivers/phy/realtek/phy-rtk-usb3.c
drivers/phy/realtek/Kconfig +11 -0
index 2f2f453729d5..a5a5a71edc9c 100644
@@ -12,3 +12,14 @@ config PHY_RTK_RTD_USB2PHY
 	  The DHC (digital home center) RTD series SoCs used the Synopsys
 	  DWC3 USB IP. This driver will do the PHY initialization
 	  of the parameters.
+
+config PHY_RTK_RTD_USB3PHY
+	tristate "Realtek RTD USB3 PHY Transceiver Driver"
+	depends on USB_SUPPORT
+	select GENERIC_PHY
+	select USB_PHY
+	help
+	  Enable this to support Realtek SoC USB3 phy transceiver.
+	  The DHC (digital home center) RTD series SoCs used the Synopsys
+	  DWC3 USB IP. This driver will do the PHY initialization
+	  of the parameters.
drivers/phy/realtek/Makefile +1 -0
index cf5d440841a2..ed7b47ff8a26 100644
@@ -1,2 +1,3 @@
 # SPDX-License-Identifier: GPL-2.0
 obj-$(CONFIG_PHY_RTK_RTD_USB2PHY)	+= phy-rtk-usb2.o
+obj-$(CONFIG_PHY_RTK_RTD_USB3PHY)	+= phy-rtk-usb3.o
drivers/phy/realtek/phy-rtk-usb3.c new file +766 -0

766 lines not on this page · raw message

Signature · 1 line
2.34.1
#3 lore raw

PATCH v6 4/5 dt-bindings: phy: realtek: Add the doc about the Realtek SoC USB 2.0 PHY

In reply to Stanley Chang

Add the documentation explain the property about Realtek USB PHY driver.

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 2.0 PHY transceivers.

---
v5 to v6 change:
Drop the redundant examples
Drop the label of example
v4 to v5 change:
1. Add more examples.
2. Remove the compatible realtek,usb2phy.
3. Revise the descriptor of the property.
4. Add the default of the property.
v3 to v4 change:
1. Remove the parameter and non hardware properties from dts.
2. Using the compatible data included the config and parameter in driver.
v2 to v3 change:
1. Broken down into two patches, one for each of USB 2 & 3.
2. Add more description about Realtek RTD SoCs architecture.
3. Removed parameter v1 support for simplification.
4. Revised the compatible name for fallback compatible.
5. Remove some properties that can be set in the driver.
v1 to v2 change:
Add phy-cells for generic phy driver

---
 .../bindings/phy/realtek,usb2phy.yaml         | 153 ++++++++++++++++++
 1 file changed, 153 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +153 -0
new file mode 100644
index 000000000000..773663bf5c62
@@ -0,0 +1,153 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Realtek Semiconductor Corporation
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/phy/realtek,usb2phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek DHC SoCs USB 2.0 PHY
+
+maintainers:
+  - Stanley Chang <[email protected]>
+
+description:
+  Realtek USB 2.0 PHY support the digital home center (DHC) RTD series SoCs.
+  The USB 2.0 PHY driver is designed to support the XHCI controller. The SoCs
+  support multiple XHCI controllers. One PHY device node maps to one XHCI
+  controller.
+
+  RTD1295/RTD1619 SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY and map one USB 3.0 PHY on some
+  controllers.
+  XHCI controller#0 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+
+  RTD1395 SoCs USB
+  The USB architecture includes two XHCI controllers.
+  The controller#0 has one USB 2.0 PHY. The controller#1 includes two USB 2.0
+  PHY.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+                               |- phy#1
+
+  RTD1319/RTD1619b SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY and map one USB 3.0 PHY on controllers#2.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+
+  RTD1319d SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each xhci maps to one USB 2.0 PHY and map one USB 3.0 PHY on controllers#0.
+  XHCI controller#0 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+
+  RTD1312c/RTD1315e SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+
+properties:
+  compatible:
+    enum:
+      - realtek,rtd1295-usb2phy
+      - realtek,rtd1312c-usb2phy
+      - realtek,rtd1315e-usb2phy
+      - realtek,rtd1319-usb2phy
+      - realtek,rtd1319d-usb2phy
+      - realtek,rtd1395-usb2phy
+      - realtek,rtd1395-usb2phy-2port
+      - realtek,rtd1619-usb2phy
+      - realtek,rtd1619b-usb2phy
+
+  reg:
+    items:
+      - description: PHY data registers
+      - description: PHY control registers
+
+  "#phy-cells":
+    const: 0
+
+  nvmem-cells:
+    maxItems: 2
+    description:
+      Phandles to nvmem cell that contains the trimming data.
+      If unspecified, default value is used.
+
+  nvmem-cell-names:
+    items:
+      - const: usb-dc-cal
+      - const: usb-dc-dis
+    description:
+      The following names, which correspond to each nvmem-cells.
+      usb-dc-cal is the driving level for each phy specified via efuse.
+      usb-dc-dis is the disconnection level for each phy specified via efuse.
+
+  realtek,inverse-hstx-sync-clock:
+    description:
+      For one of the phys of RTD1619b SoC, the synchronous clock of the
+      high-speed tx must be inverted.
+    type: boolean
+
+  realtek,driving-level:
+    description:
+      Control the magnitude of High speed Dp/Dm output swing.
+      For a different board or port, the original magnitude maybe not meet
+      the specification. In this situation we can adjust the value to meet
+      the specification.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 8
+    minimum: 0
+    maximum: 31
+
+  realtek,driving-compensate:
+    description:
+      For RTD1315e SoC, the driving level can be adjusted by reading the
+      efuse table. This property provides drive compensation.
+      If the magnitude of High speed Dp/Dm output swing still not meet the
+      specification, then we can set this value to meet the specification.
+    $ref: /schemas/types.yaml#/definitions/int32
+    default: 0
+    minimum: -8
+    maximum: 8
+
+  realtek,disconnection-compensate:
+    description:
+      This adjusts the disconnection level compensation for the different
+      boards with different disconnection level.
+    $ref: /schemas/types.yaml#/definitions/int32
+    default: 0
+    minimum: -8
+    maximum: 8
+
+required:
+  - compatible
+  - reg
+  - "#phy-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    usb-phy@13214 {
+        compatible = "realtek,rtd1619b-usb2phy";
+        reg = <0x13214 0x4>, <0x28280 0x4>;
+        #phy-cells = <0>;
+        nvmem-cells = <&otp_usb_port0_dc_cal>, <&otp_usb_port0_dc_dis>;
+        nvmem-cell-names = "usb-dc-cal", "usb-dc-dis";
+
+        realtek,inverse-hstx-sync-clock;
+        realtek,driving-level = <0xa>;
+        realtek,driving-compensate = <(-1)>;
+        realtek,disconnection-compensate = <(-1)>;
+    };
Signature · 1 line
2.34.1
maintainer
#4 lore raw

Re: [PATCH v6 4/5] dt-bindings: phy: realtek: Add the doc about the Realtek SoC USB 2.0 PHY

Quoted 1 line · Stanley Chang

Add the documentation explain the property about Realtek USB PHY driver.

In the subject, drop "the doc about the". It's redundant. And perhaps add 'DHC RTD SoC' if this isn't for *all* Realtek SoCs.

Quoted 2 lines

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 2.0 PHY transceivers.

driver? This is a binding for the h/w.

Quoted 37 lines

---
v5 to v6 change:
Drop the redundant examples
Drop the label of example
v4 to v5 change:
1. Add more examples.
2. Remove the compatible realtek,usb2phy.
3. Revise the descriptor of the property.
4. Add the default of the property.
v3 to v4 change:
1. Remove the parameter and non hardware properties from dts.
2. Using the compatible data included the config and parameter in driver.
v2 to v3 change:
1. Broken down into two patches, one for each of USB 2 & 3.
2. Add more description about Realtek RTD SoCs architecture.
3. Removed parameter v1 support for simplification.
4. Revised the compatible name for fallback compatible.
5. Remove some properties that can be set in the driver.
v1 to v2 change:
Add phy-cells for generic phy driver

---
 .../bindings/phy/realtek,usb2phy.yaml         | 153 ++++++++++++++++++
 1 file changed, 153 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +3 -0
new file mode 100644
index 000000000000..773663bf5c62
@@ -0,0 +1,153 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Realtek Semiconductor Corporation
+%YAML 1.2

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 13

Quoted 10 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +10 -0
+---
+$id: http://devicetree.org/schemas/phy/realtek,usb2phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek DHC SoCs USB 2.0 PHY
+
+maintainers:
+  - Stanley Chang <[email protected]>
+
+description:

You need '|' if formatting (line breaks) are important.

Quoted 76 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +76 -0
+  Realtek USB 2.0 PHY support the digital home center (DHC) RTD series SoCs.
+  The USB 2.0 PHY driver is designed to support the XHCI controller. The SoCs
+  support multiple XHCI controllers. One PHY device node maps to one XHCI
+  controller.
+
+  RTD1295/RTD1619 SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY and map one USB 3.0 PHY on some
+  controllers.
+  XHCI controller#0 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+
+  RTD1395 SoCs USB
+  The USB architecture includes two XHCI controllers.
+  The controller#0 has one USB 2.0 PHY. The controller#1 includes two USB 2.0
+  PHY.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+                               |- phy#1
+
+  RTD1319/RTD1619b SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY and map one USB 3.0 PHY on controllers#2.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+
+  RTD1319d SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each xhci maps to one USB 2.0 PHY and map one USB 3.0 PHY on controllers#0.
+  XHCI controller#0 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+
+  RTD1312c/RTD1315e SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+
+properties:
+  compatible:
+    enum:
+      - realtek,rtd1295-usb2phy
+      - realtek,rtd1312c-usb2phy
+      - realtek,rtd1315e-usb2phy
+      - realtek,rtd1319-usb2phy
+      - realtek,rtd1319d-usb2phy
+      - realtek,rtd1395-usb2phy
+      - realtek,rtd1395-usb2phy-2port
+      - realtek,rtd1619-usb2phy
+      - realtek,rtd1619b-usb2phy
+
+  reg:
+    items:
+      - description: PHY data registers
+      - description: PHY control registers
+
+  "#phy-cells":
+    const: 0
+
+  nvmem-cells:
+    maxItems: 2
+    description:
+      Phandles to nvmem cell that contains the trimming data.
+      If unspecified, default value is used.
+
+  nvmem-cell-names:
+    items:
+      - const: usb-dc-cal

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 99

Quoted 10 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +10 -0
+      - const: usb-dc-dis
+    description:
+      The following names, which correspond to each nvmem-cells.
+      usb-dc-cal is the driving level for each phy specified via efuse.
+      usb-dc-dis is the disconnection level for each phy specified via efuse.
+
+  realtek,inverse-hstx-sync-clock:
+    description:
+      For one of the phys of RTD1619b SoC, the synchronous clock of the
+      high-speed tx must be inverted.

"invert" assumes I know what non-inverted means. I do not. Better to state in terms of active high, low, falling edge, rising edge, etc.

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 107

Quoted 8 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +8 -0
+    type: boolean
+
+  realtek,driving-level:
+    description:
+      Control the magnitude of High speed Dp/Dm output swing.
+      For a different board or port, the original magnitude maybe not meet
+      the specification. In this situation we can adjust the value to meet
+      the specification.

What are the units?

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 113

Quoted 6 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 8
+    minimum: 0
+    maximum: 31
+
+  realtek,driving-compensate:

compensate what?

Quoted 43 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +40 -0
+    description:
+      For RTD1315e SoC, the driving level can be adjusted by reading the
+      efuse table. This property provides drive compensation.
+      If the magnitude of High speed Dp/Dm output swing still not meet the
+      specification, then we can set this value to meet the specification.
+    $ref: /schemas/types.yaml#/definitions/int32
+    default: 0
+    minimum: -8
+    maximum: 8
+
+  realtek,disconnection-compensate:
+    description:
+      This adjusts the disconnection level compensation for the different
+      boards with different disconnection level.
+    $ref: /schemas/types.yaml#/definitions/int32
+    default: 0
+    minimum: -8
+    maximum: 8
+
+required:
+  - compatible
+  - reg
+  - "#phy-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    usb-phy@13214 {
+        compatible = "realtek,rtd1619b-usb2phy";
+        reg = <0x13214 0x4>, <0x28280 0x4>;
+        #phy-cells = <0>;
+        nvmem-cells = <&otp_usb_port0_dc_cal>, <&otp_usb_port0_dc_dis>;
+        nvmem-cell-names = "usb-dc-cal", "usb-dc-dis";
+
+        realtek,inverse-hstx-sync-clock;
+        realtek,driving-level = <0xa>;
+        realtek,driving-compensate = <(-1)>;
+        realtek,disconnection-compensate = <(-1)>;
+    };
Signature · 1 line
2.34.1
#5 lore raw

RE: [PATCH v6 4/5] dt-bindings: phy: realtek: Add the doc about the Realtek SoC USB 2.0 PHY

Hi Rob,

Quoted 10 lines · Stanley Chang
Quoted 1 line

Add the documentation explain the property about Realtek USB PHY driver.

In the subject, drop "the doc about the". It's redundant. And perhaps add 'DHC RTD SoC' if this isn't for *all* Realtek SoCs.

Quoted 2 lines

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 2.0 PHY transceivers.

driver? This is a binding for the h/w.

I mean, the driver is drivers/phy/realtek/phy-rtk-usb2.c
I will revise as
dt-bindings: phy: realtek: Add the Realtek DHC RTD SoC USB 2.0 PHY

Add the documentation explain the property about Realtek USB PHY driver.

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller and uses phy-rtk-usb2 as driver for USB 2.0 PHY transceiver..

Quoted 11 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 13

Quoted 9 lines

+$id: http://devicetree.org/schemas/phy/realtek,usb2phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +7 -0
+
+title: Realtek DHC SoCs USB 2.0 PHY
+
+maintainers:
+  - Stanley Chang <[email protected]>
+
+description:

You need '|' if formatting (line breaks) are important.

I think I need it. I will add it.

Quoted 7 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 99

Quoted 4 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +4 -0
+  realtek,inverse-hstx-sync-clock:
+    description:
+      For one of the phys of RTD1619b SoC, the synchronous clock of the
+      high-speed tx must be inverted.

"invert" assumes I know what non-inverted means. I do not. Better to state in terms of active high, low, falling edge, rising edge, etc.

Meaning, the clock must be reversed.

Quoted 7 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml

Quoted 7 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    type: boolean
+
+  realtek,driving-level:
+    description:
+      Control the magnitude of High speed Dp/Dm output swing.
+      For a different board or port, the original magnitude maybe not
Quoted 5 lines

meet

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 107

Quoted 2 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +2 -0
+      the specification. In this situation we can adjust the value to meet
+      the specification.

What are the units?

There is no unit. It is only a gain for adjusting the magnitude.

Quoted 8 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 113

Quoted 6 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 8
+    minimum: 0
+    maximum: 31
+
+  realtek,driving-compensate:

compensate what?

It is to compensate the driving level. In other word, to adjust the driving level.

Thanks,
Stanley

#6 lore raw

Re: [PATCH v6 4/5] dt-bindings: phy: realtek: Add the doc about the Realtek SoC USB 2.0 PHY

Quoted 13 lines · Stanley Chang[昌育德]

Hi Rob,

Quoted 10 lines · Stanley Chang
Quoted 1 line

Add the documentation explain the property about Realtek USB PHY driver.

In the subject, drop "the doc about the". It's redundant. And perhaps add 'DHC RTD SoC' if this isn't for *all* Realtek SoCs.

Quoted 2 lines

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 2.0 PHY transceivers.

driver? This is a binding for the h/w.

Quoted 8 lines

I mean, the driver is drivers/phy/realtek/phy-rtk-usb2.c
I will revise as
dt-bindings: phy: realtek: Add the Realtek DHC RTD SoC USB 2.0 PHY

Add the documentation explain the property about Realtek USB PHY driver.

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller and uses phy-rtk-usb2 as driver for USB 2.0 PHY transceiver..

No, you should mention nothing to do with how a particular operating system chooses to structure its code here. Bindings describe hardware, and the commit message should reflect that.

Quoted 20 lines
Quoted 12 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 13

Quoted 10 lines

+$id: http://devicetree.org/schemas/phy/realtek,usb2phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +7 -0
+
+title: Realtek DHC SoCs USB 2.0 PHY
+
+maintainers:
+  - Stanley Chang <[email protected]>
+
+description:

You need '|' if formatting (line breaks) are important.

I think I need it. I will add it.

Quoted 5 lines
Quoted 4 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +4 -0
+  realtek,inverse-hstx-sync-clock:
+    description:
+      For one of the phys of RTD1619b SoC, the synchronous clock of the
+      high-speed tx must be inverted.
Quoted 4 lines
Quoted 2 lines

"invert" assumes I know what non-inverted means. I do not. Better to state in terms of active high, low, falling edge, rising edge, etc.

Meaning, the clock must be reversed.

Maybe that means something to Rob, but "reversed" doesn't seem any more meaningful than inverse. I agree that it should be described in terms of "active high" etc, as they have well understood meanings.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    type: boolean
+
+  realtek,driving-level:
+    description:
+      Control the magnitude of High speed Dp/Dm output swing.
+      For a different board or port, the original magnitude maybe not
Quoted 7 lines
Quoted 5 lines

meet

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 107

Quoted 2 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +2 -0
+      the specification. In this situation we can adjust the value to meet
+      the specification.

What are the units?

There is no unit. It is only a gain for adjusting the magnitude.

Gain has units too.

Quoted 10 lines
Quoted 8 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 113

Quoted 6 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 8
+    minimum: 0
+    maximum: 31
+
+  realtek,driving-compensate:

compensate what?

It is to compensate the driving level.

Should it be called "driving-level-compensate" then?

Quoted 1 line

In other word, to adjust the driving level.

So, "realtek,driving-level" sets the gain and "realtek,driving-compensate" adjusts the driving level. By that logic, is this also a gain?

Also this property is only for the RTD1315e? That should be described in/constrained by the binding itself, not in the text description alone IMO.

#7 lore raw

RE: [PATCH v6 4/5] dt-bindings: phy: realtek: Add the doc about the Realtek SoC USB 2.0 PHY

Hi Conor,

Quoted 18 lines · Stanley Chang[昌育德]
Quoted 17 lines

Hi Rob,

Quoted 10 lines · Stanley Chang
Quoted 1 line

Add the documentation explain the property about Realtek USB PHY driver.

In the subject, drop "the doc about the". It's redundant. And perhaps add 'DHC RTD SoC' if this isn't for *all* Realtek SoCs.

Quoted 2 lines

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 2.0 PHY transceivers.

driver? This is a binding for the h/w.

I mean, the driver is drivers/phy/realtek/phy-rtk-usb2.c
I will revise as
dt-bindings: phy: realtek: Add the Realtek DHC RTD SoC USB 2.0 PHY

Quoted 8 lines
Quoted 4 lines

Add the documentation explain the property about Realtek USB PHY driver.

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller and uses phy-rtk-usb2 as driver for USB 2.0 PHY transceiver..

No, you should mention nothing to do with how a particular operating system chooses to structure its code here. Bindings describe hardware, and the commit message should reflect that.

Okay. I should remove any related driver description.
Here, only describe the hardware about SoCs.
For example,
dt-bindings: phy: realtek: Add the Realtek DHC RTD SoC USB 2.0 PHY

Document the USB PHY bindings for Realtek SoCs. Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller and using USB 2.0 PHY transceiver.

Quoted 20 lines
Quoted 20 lines
Quoted 12 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 13

Quoted 10 lines

+$id: http://devicetree.org/schemas/phy/realtek,usb2phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +7 -0
+
+title: Realtek DHC SoCs USB 2.0 PHY
+
+maintainers:
+  - Stanley Chang <[email protected]>
+
+description:

You need '|' if formatting (line breaks) are important.

I think I need it. I will add it.

Quoted 5 lines
Quoted 4 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +4 -0
+  realtek,inverse-hstx-sync-clock:
+    description:
+      For one of the phys of RTD1619b SoC, the synchronous clock of the
+      high-speed tx must be inverted.
Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

"invert" assumes I know what non-inverted means. I do not. Better to state in terms of active high, low, falling edge, rising edge, etc.

Meaning, the clock must be reversed.

Maybe that means something to Rob, but "reversed" doesn't seem any more meaningful than inverse. I agree that it should be described in terms of "active high" etc, as they have well understood meanings.

Here I describe a clock sequence is "inverted", not "high" or "low". Add the property, then hstx-sync-clock sequence is being inverted.

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml

Quoted 6 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    type: boolean
+
+  realtek,driving-level:
+    description:
+      Control the magnitude of High speed Dp/Dm output swing.
+      For a different board or port, the original magnitude maybe not

meet

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml line 107

Quoted 2 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +2 -0
+      the specification. In this situation we can adjust the value to meet
+      the specification.

What are the units?

There is no unit. It is only a gain for adjusting the magnitude.

Gain has units too.

The magnitude of High speed Dp/Dm output is voltage.

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 6 lines
Documentation/devicetree/bindings/phy/realtek,usb2phy.yaml new file +6 -0
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 8
+    minimum: 0
+    maximum: 31
+
+  realtek,driving-compensate:
Quoted 5 lines
Quoted 3 lines
Quoted 1 line

compensate what?

It is to compensate the driving level.

Should it be called "driving-level-compensate" then?

Yes, it can be named "driving-level-compensate".
I will rename it.

Quoted 5 lines
Quoted 1 line

In other word, to adjust the driving level.

So, "realtek,driving-level" sets the gain and "realtek,driving-compensate" adjusts the driving level. By that logic, is this also a gain?

Yes, the real driving level is
driving level (reading from otp) + driving-level-compensate.

Quoted 4 lines

Also this property is only for the RTD1315e? That should be described in/constrained by the binding itself, not in the text description alone IMO.

Does your meaning is as follows?
if:
properties:
compatible:
contains:
enum:
- realtek,rtd1315e-usb2phy
then:
properties:
realtek,driving-level-compensate:
description:
For RTD1315e SoC, the driving level can be adjusted by reading the efuse table. This property provides drive compensation. If the magnitude of High speed Dp/Dm output swing still not meet the specification, then we can set this value to meet the specification.
$ref: /schemas/types.yaml#/definitions/int32
default: 0
minimum: -8
maximum: 8

Thanks,
Stanley

#8 lore raw

PATCH v6 5/5 dt-bindings: phy: realtek: Add the doc about the Realtek SoC USB 3.0 PHY

In reply to Stanley Chang

Add the documentation explain the property about Realtek USB PHY driver.

Realtek DHC (digital home center) RTD SoCs support DWC3 XHCI USB controller. Added the driver to drive the USB 3.0 PHY transceivers.

---
v5 to v6 change:
Drop the labels of example.
v4 to v5 change:
1. Remove the compatible realtek,usb3phy.
2. Add the default of the property.
v3 to v4 change:
1. Remove the parameter and non hardware properties from dts.
2. Using the compatible data included the config and parameter in driver.
v2 to v3 change:
1. Broken down into two patches, one for each of USB 2 & 3.
2. Add more description about Realtek RTD SoCs architecture.
3. Removed parameter v1 support for simplification.
4. Revised the compatible name for fallback compatible.
5. Remove some properties that can be set in the driver.
v1 to v2 change:
Add phy-cells for generic phy driver

---
 .../bindings/phy/realtek,usb3phy.yaml         | 107 ++++++++++++++++++
 1 file changed, 107 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/realtek,usb3phy.yaml
Documentation/devicetree/bindings/phy/realtek,usb3phy.yaml new file +107 -0
new file mode 100644
index 000000000000..1a6cdc1ee073
@@ -0,0 +1,107 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Realtek Semiconductor Corporation
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/phy/realtek,usb3phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek DHC SoCs USB 3.0 PHY
+
+maintainers:
+  - Stanley Chang <[email protected]>
+
+description:
+  Realtek USB 3.0 PHY support the digital home center (DHC) RTD series SoCs.
+  The USB 3.0 PHY driver is designed to support the XHCI controller. The SoCs
+  support multiple XHCI controllers. One PHY device node maps to one XHCI
+  controller.
+
+  RTD1295/RTD1619 SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY and map one USB 3.0 PHY on some
+  controllers.
+  XHCI controller#0 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+
+  RTD1319/RTD1619b SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each XHCI maps to one USB 2.0 PHY and map one USB 3.0 PHY on controllers#2.
+  XHCI controller#0 -- usb2phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+
+  RTD1319d SoCs USB
+  The USB architecture includes three XHCI controllers.
+  Each xhci maps to one USB 2.0 PHY and map one USB 3.0 PHY on controllers#0.
+  XHCI controller#0 -- usb2phy -- phy#0
+                    |- usb3phy -- phy#0
+  XHCI controller#1 -- usb2phy -- phy#0
+  XHCI controller#2 -- usb2phy -- phy#0
+
+properties:
+  compatible:
+    enum:
+      - realtek,rtd1295-usb3phy
+      - realtek,rtd1319-usb3phy
+      - realtek,rtd1319d-usb3phy
+      - realtek,rtd1619-usb3phy
+      - realtek,rtd1619b-usb3phy
+
+  reg:
+    maxItems: 1
+
+  "#phy-cells":
+    const: 0
+
+  nvmem-cells:
+    maxItems: 1
+    description: A phandle to the tx lfps swing trim data provided by
+      a nvmem device, if unspecified, default values shall be used.
+
+  nvmem-cell-names:
+    items:
+      - const: usb_u3_tx_lfps_swing_trim
+
+  realtek,amplitude-control-coarse-tuning:
+    description:
+      This adjusts the signal amplitude for normal operation and beacon LFPS.
+      This value is a parameter for coarse tuning.
+      For different boards, if the default value is inappropriate, this
+      property can be assigned to adjust.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 255
+    minimum: 0
+    maximum: 255
+
+  realtek,amplitude-control-fine-tuning:
+    description:
+      This adjusts the signal amplitude for normal operation and beacon LFPS.
+      This value is used for fine-tuning parameters.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 65535
+    minimum: 0
+    maximum: 65535
+
+required:
+  - compatible
+  - reg
+  - "#phy-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    usb-phy@13e10 {
+        compatible = "realtek,rtd1319d-usb3phy";
+        reg = <0x13e10 0x4>;
+        #phy-cells = <0>;
+
+        nvmem-cells = <&otp_usb_u3_tx_lfps_swing_trim>;
+        nvmem-cell-names = "usb_u3_tx_lfps_swing_trim";
+
+        realtek,amplitude-control-coarse-tuning = <0x77>;
+    };
Signature · 1 line
2.34.1