[v2] dt-bindings: phy: mediatek: tphy: add a property for power-domains

Commit Message

Macpaul Lin Oct. 11, 2024, 6:48 a.m. UTC

MediaTek TPHY should be existed in a power-domains.
So we add property 'power-domains' and set 'maxItems: 1' in the
DT Schema.

A reminder is also added to the description of 'power-domains'
property.

Signed-off-by: Macpaul Lin <[e-mail]>
Reviewed-by: AngeloGioacchino Del Regno <[e-mail]>
---
 .../devicetree/bindings/phy/mediatek,tphy.yaml         | 10 ++++++++++
 1 file changed, 10 insertions(+)

Changes for v2:
 - Add a reminder in description of 'power-domains' property.
 - Fix commit message from v1.

Comments

Krzysztof Kozlowski Oct. 11, 2024, 2:56 p.m. UTC | #1

On 11/10/2024 08:48, Macpaul Lin wrote:
> MediaTek TPHY should be existed in a power-domains.

should be part of power domain, hm?

> So we add property 'power-domains' and set 'maxItems: 1' in the
> DT Schema.

Entire commit msg would benefit from Google Doc/office or ChatGpt/AI
grammar correction.

Many of us, including myself, are not native speakers so use tools when
needed for that.

> 
> A reminder is also added to the description of 'power-domains'
> property.

Use imperative. See longer explanation here:
https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95


Acked-by: Krzysztof Kozlowski <[e-mail]>

Best regards,
Krzysztof

Patch

diff --git a/Documentation/devicetree/bindings/phy/mediatek,tphy.yaml b/Documentation/devicetree/bindings/phy/mediatek,tphy.yaml
index 423b7c4e62f2..6be3aa4557e5 100644
--- a/Documentation/devicetree/bindings/phy/mediatek,tphy.yaml
+++ b/Documentation/devicetree/bindings/phy/mediatek,tphy.yaml
@@ -125,6 +125,16 @@  properties:
     $ref: /schemas/types.yaml#/definitions/uint32
     default: 28
 
+  power-domains:
+    description:
+      The TPHY of MediaTek should exist within a power domain. The
+      developer should be aware that the hardware design of MediaTek TPHY
+      does not require the addition of MTCMOS. If the power to the TPHY
+      is turned off, it will impact other functions. From the current
+      perspective of USB hardware design, even if MTCMOS is added to the
+      TPHY, it should remain always on.
+    maxItems: 1
+
 # Required child node:
 patternProperties:
   "^(usb|pcie|sata)-phy@[0-9a-f]+$":