Re: [PATCH v4 5/9] dt-bindings: soc: mediatek: convert pwrap documentation

Il 08/11/22 19:43, Alexandre Mergnat ha scritto:

I say that the maintainer for pwrap is Flora Fu [off-list ref]....

+
+description: |
+  On MediaTek SoCs the PMIC is connected via SPI. The SPI master interface
+  is not directly visible to the CPU, but only through the PMIC wrapper
+  inside the SoC. The communication between the SoC and the PMIC can
+  optionally be encrypted. Also a non standard Dual IO SPI mode can be
+  used to increase speed.
+
+  IP Pairing
+
+  On MT8135 the pins of some SoC internal peripherals can be on the PMIC.
+  The signals of these pins are routed over the SPI bus using the pwrap
+  bridge. In the binding description below the properties needed for bridging
+  are marked with "IP Pairing". These are optional on SoCs which do not support
+  IP Pairing
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - mediatek,mt2701-pwrap

..snip..

+  interrupts:
+    maxItems: 1
+    description: IRQ for pwrap in SOC

description: PMIC Wrapper interrupt

+
+  clocks: true
+
+  clock-names: true
+
+  resets:
+    minItems: 1
+    items:
+      - description: PMIC wrapper reset
+      - description: IP pairing reset
+
+  reset-names:
+    minItems: 1
+    items:
+      - const: pwrap
+      - const: pwrap-bridge
+
+  pmic:
+    type: object
+
+allOf:
+  - if:

if `resets` is present, reset-names is *required*...

+      properties:
+        compatible:
+          contains:
+            const: mediatek,mt8365-pwrap
+    then:
+      properties:
+        pmic:
+          $ref: /schemas/mfd/mediatek,mt6357.yaml#
+
+        clocks:
+          items:
+            - description: SPI bus clock
+            - description: Main module clock
+            - description: System module clock
+            - description: Timer module clock
+        clock-names:
+          items:
+            - const: spi
+            - const: wrap
+            - const: sys
+            - const: tmr

For clocks and clock-names... you can declare that globally and set
`minItems: 2` for both: this means that the first two items are mandatory,
but the last two are not.

If you really want to force a validation error when using mediatek,mt8365-pwrap
and not providing `sys` and `tmr` clocks, you can just override minItems.

+    else:
+      properties:
+        pmic:
+          description: |

You don't need this '|'.

+            List of child nodes that specify the regulators.
+            See ../../mfd/mt6397.txt for more details.
+
+        clocks:
+          items:
+            - description: SPI bus clock
+            - description: Main module clock
+        clock-names:
+          items:
+            - const: spi
+            - const: wrap
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - interrupts
+  - clocks
+  - clock-names
+
+additionalProperties: true
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/reset/mt8135-resets.h>
+
+    soc {
+      #address-cells = <2>;
+      #size-cells = <2>;
+      pwrap@1000f000 {
+          compatible = "mediatek,mt8135-pwrap";
+          reg = <0 0x1000f000 0 0x1000>, <0 0x11017000 0 0x1000>;
+          reg-names = "pwrap", "pwrap-bridge";
+          interrupts = <GIC_SPI 128 IRQ_TYPE_LEVEL_HIGH>;
+          resets = <&infracfg MT8135_INFRA_PMIC_WRAP_RST>,
+              <&pericfg MT8135_PERI_PWRAP_BRIDGE_SW_RST>;

Fix indentation please

           resets = <&infracfg MT8135_INFRA_PMIC_WRAP_RST>,
                    <&pericfg MT8135_PERI_PWRAP_BRIDGE_SW_RST>;

+          reset-names = "pwrap", "pwrap-bridge";
+          clocks = <&clk26m>, <&clk26m>;

...and also, clocks/clock-names before resets/reset-names please.

+          clock-names = "spi", "wrap";
+
+          pmic {
+            compatible = "mediatek,mt6397";
+          };
+      };
+    };

Regards,
Angelo