diff mbox series

[8/8] dt-bindings: soc: socionext: Add UniPhier AHCI glue layer

Message ID 20221129103509.9958-9-hayashi.kunihiko@socionext.com
State New
Headers
Series dt-bidnings: soc: Introduce UniPhier miscelaneous register blocks |

Commit Message

Kunihiko Hayashi Nov. 29, 2022, 10:35 a.m. UTC 
  Add DT binding schema for components belonging to the platform-specific
AHCI glue layer implemented in UniPhier SoCs.

This AHCI glue layer works as a sideband logic for the host controller,
including core reset, PHYs, and some signals to the controller.

Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
---
 .../socionext,uniphier-ahci-glue.yaml         | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/soc/socionext/socionext,uniphier-ahci-glue.yaml

Comments

Rob Herring Nov. 29, 2022, 1:32 p.m. UTC | #1 
On Tue, 29 Nov 2022 19:35:09 +0900, Kunihiko Hayashi wrote:
> Add DT binding schema for components belonging to the platform-specific
> AHCI glue layer implemented in UniPhier SoCs.
> 
> This AHCI glue layer works as a sideband logic for the host controller,
> including core reset, PHYs, and some signals to the controller.
> 
> Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
> ---
>  .../socionext,uniphier-ahci-glue.yaml         | 78 +++++++++++++++++++
>  1 file changed, 78 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/soc/socionext/socionext,uniphier-ahci-glue.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/phy/socionext,uniphier-ahci-phy.example.dtb: ahci-glue@65700000: 'reg' is a required property
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/soc/socionext/socionext,uniphier-ahci-glue.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20221129103509.9958-9-hayashi.kunihiko@socionext.com

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command.
Kunihiko Hayashi Dec. 1, 2022, 9:30 a.m. UTC | #2 
Hi Krzysztof,

On 2022/11/29 19:35, Kunihiko Hayashi wrote:
> Add DT binding schema for components belonging to the platform-specific
> AHCI glue layer implemented in UniPhier SoCs.
> 
> This AHCI glue layer works as a sideband logic for the host controller,
> including core reset, PHYs, and some signals to the controller.
> 
> Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>

(snip)

> +examples:
> +  - |
> +    sata-controller@65700000 {
> +        compatible = "socionext,uniphier-pxs3-ahci-glue", "simple-mfd";
> +        reg = <0x65b00000 0x400>;
> +        #address-cells = <1>;
> +        #size-cells = <1>;
> +        ranges = <0 0x65700000 0x100>;

In PATCH 7/8, you suggested that the node name of "USB glue layer" should
changes to the generic node name "usb@...".

However, in case of this "AHCI glue layer", I can't change "sata-controller"
to the generic node name "sata@...", because ata/sata-common.yaml has pattern
"^sata(@.*)?$", and the changed node matches this pattern unintentionally.

This layer isn't a sata host controller, so it's hard to give a generic name
to this node. I'd like you opinion.

Thank you,

---
Best Regards
Kunihiko Hayashi
Krzysztof Kozlowski Dec. 2, 2022, 12:08 p.m. UTC | #3 
On 01/12/2022 10:30, Kunihiko Hayashi wrote:
> Hi Krzysztof,
> 
> On 2022/11/29 19:35, Kunihiko Hayashi wrote:
>> Add DT binding schema for components belonging to the platform-specific
>> AHCI glue layer implemented in UniPhier SoCs.
>>
>> This AHCI glue layer works as a sideband logic for the host controller,
>> including core reset, PHYs, and some signals to the controller.
>>
>> Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
> 
> (snip)
> 
>> +examples:
>> +  - |
>> +    sata-controller@65700000 {
>> +        compatible = "socionext,uniphier-pxs3-ahci-glue", "simple-mfd";
>> +        reg = <0x65b00000 0x400>;
>> +        #address-cells = <1>;
>> +        #size-cells = <1>;
>> +        ranges = <0 0x65700000 0x100>;
> 
> In PATCH 7/8, you suggested that the node name of "USB glue layer" should
> changes to the generic node name "usb@...".
> 
> However, in case of this "AHCI glue layer", I can't change "sata-controller"
> to the generic node name "sata@...", because ata/sata-common.yaml has pattern
> "^sata(@.*)?$", and the changed node matches this pattern unintentionally.
> 
> This layer isn't a sata host controller, so it's hard to give a generic name
> to this node. I'd like you opinion.

Yeah, I think it's fine. We do not have good names for such nodes.

Best regards,
Krzysztof
Kunihiko Hayashi Dec. 2, 2022, 12:14 p.m. UTC | #4 
On 2022/12/02 21:08, Krzysztof Kozlowski wrote:
> On 01/12/2022 10:30, Kunihiko Hayashi wrote:
>> Hi Krzysztof,
>>
>> On 2022/11/29 19:35, Kunihiko Hayashi wrote:
>>> Add DT binding schema for components belonging to the platform-specific
>>> AHCI glue layer implemented in UniPhier SoCs.
>>>
>>> This AHCI glue layer works as a sideband logic for the host controller,
>>> including core reset, PHYs, and some signals to the controller.
>>>
>>> Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
>>
>> (snip)
>>
>>> +examples:
>>> +  - |
>>> +    sata-controller@65700000 {
>>> +        compatible = "socionext,uniphier-pxs3-ahci-glue", "simple-mfd";
>>> +        reg = <0x65b00000 0x400>;
>>> +        #address-cells = <1>;
>>> +        #size-cells = <1>;
>>> +        ranges = <0 0x65700000 0x100>;
>>
>> In PATCH 7/8, you suggested that the node name of "USB glue layer" should
>> changes to the generic node name "usb@...".
>>
>> However, in case of this "AHCI glue layer", I can't change
>> "sata-controller"
>> to the generic node name "sata@...", because ata/sata-common.yaml has
>> pattern
>> "^sata(@.*)?$", and the changed node matches this pattern unintentionally.
>>
>> This layer isn't a sata host controller, so it's hard to give a generic
>> name
>> to this node. I'd like you opinion.
> 
> Yeah, I think it's fine. We do not have good names for such nodes.

OK, I leave the name for this node.

Thank you,

---
Best Regards
Kunihiko Hayashi
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/soc/socionext/socionext,uniphier-ahci-glue.yaml b/Documentation/devicetree/bindings/soc/socionext/socionext,uniphier-ahci-glue.yaml
new file mode 100644
index 000000000000..bf37be8a778d
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/socionext/socionext,uniphier-ahci-glue.yaml
@@ -0,0 +1,78 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/soc/socionext/socionext,uniphier-ahci-glue.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Socionext UniPhier SoC AHCI glue layer
+
+maintainers:
+  - Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
+
+description: |+
+  AHCI glue layer implemented on Socionext UniPhier SoCs is a sideband
+  logic handling signals to AHCI host controller inside AHCI component.
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - socionext,uniphier-pro4-ahci-glue
+          - socionext,uniphier-pxs2-ahci-glue
+          - socionext,uniphier-pxs3-ahci-glue
+      - const: simple-mfd
+
+  reg:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 1
+
+  ranges: true
+
+patternProperties:
+  "^reset-controller@[0-9a-f]+$":
+    $ref: /schemas/reset/socionext,uniphier-glue-reset.yaml#
+
+  "phy@[0-9a-f]+$":
+    $ref: /schemas/phy/socionext,uniphier-ahci-phy.yaml#
+
+required:
+  - compatible
+  - reg
+
+additionalProperties:
+  type: object
+
+examples:
+  - |
+    sata-controller@65700000 {
+        compatible = "socionext,uniphier-pxs3-ahci-glue", "simple-mfd";
+        reg = <0x65b00000 0x400>;
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges = <0 0x65700000 0x100>;
+
+        reset-controller@0 {
+            compatible = "socionext,uniphier-pxs3-ahci-reset";
+            reg = <0x0 0x4>;
+            clock-names = "link";
+            clocks = <&sys_clk 28>;
+            reset-names = "link";
+            resets = <&sys_rst 28>;
+            #reset-cells = <1>;
+        };
+
+        phy@10 {
+            compatible = "socionext,uniphier-pxs3-ahci-phy";
+            reg = <0x10 0x10>;
+            clock-names = "link", "phy";
+            clocks = <&sys_clk 28>, <&sys_clk 30>;
+            reset-names = "link", "phy";
+            resets = <&sys_rst 28>, <&sys_rst 30>;
+            #phy-cells = <0>;
+        };
+    };