Skip to contentSkip to conversation

Geni based QUP controller binding cleanups

PATCH Applied Kuldeep Singh 4 participants 10 messages Apr 4, 2022 – May 3, 2022

Subsystems (6)
lore
Share & tools
lore
#0 lore raw

v2 cover Geni based QUP controller binding cleanups

v1 link:
https://lore.kernel.org/lkml/[email protected]/

Updates:
- Address Krzysztof's comments
- Drop patch 5/5 and merge with 4/5 of v1
- In-patch updates
---

Geni based QUP controller currently has child nodes bindings defined in same parent schema. Documentation of few other properties were also omitted intially. The list becomes too long with addition of these properties. Therefore, move out child bindings from parent schema to respective places as a part of cleanup process and update reference for it. Please note, individual bindings will now stand complete as previously some properties were defined in core and rest in parent schema.

This patchset adds individual bindings for uart and i2c controller, spi controller is taken care by Krzystof. SPI patches[1] are required for complete changes. Once all bindings gets places correctly, remove common properties defined in parent as the final step.

[1] https://lore.kernel.org/linux-devicetree/[email protected]/

Looking forward for feeback and review comments. Thanks!

Kuldeep Singh (4):
dt-bindings: I2C: Add Qualcomm Geni based QUP I2C bindings
dt-bindings: qcom: geni-se: Update I2C schema reference
dt-bindings: serial: Update Qualcomm geni based QUP UART bindings
dt-bindings: qcom: geni-se: Update UART schema reference

 .../bindings/i2c/qcom,i2c-geni-qcom.yaml      | 100 ++++++++++++++++++
 .../serial/qcom,serial-geni-qcom.yaml         |  86 +++++++++++++++
 .../bindings/soc/qcom/qcom,geni-se.yaml       |  77 +-------------
 3 files changed, 188 insertions(+), 75 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/i2c/qcom,i2c-geni-qcom.yaml
 create mode 100644 Documentation/devicetree/bindings/serial/qcom,serial-geni-qcom.yaml
Signature · 1 line
2.25.1
#1 lore raw

PATCH v2 1/4 dt-bindings: I2C: Add Qualcomm Geni based QUP I2C bindings

GENI(generic interface) based Qualcomm Universal Peripheral controller can support multiple serial interfaces like SPI,UART and I2C.

Unlike other I2C controllers, QUP I2C bindings are present in parent schema. Move it out from parent to an individual binding and let parent refer to child schema later on.

Please note, current schema isn't complete as it misses out few properties and thus, add these missing properties along the process.

---
v2:
- Change compatible from enum to const
- Drop clock-frequency description
- Sort nodes

---
 .../bindings/i2c/qcom,i2c-geni-qcom.yaml      | 100 ++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/qcom,i2c-geni-qcom.yaml
Documentation/devicetree/bindings/i2c/qcom,i2c-geni-qcom.yaml new file +100 -0
new file mode 100644
index 000000000000..0e7ed00562e2
@@ -0,0 +1,100 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/i2c/qcom,i2c-geni-qcom.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm Geni based QUP I2C Controller
+
+maintainers:
+  - Andy Gross <[email protected]>
+  - Bjorn Andersson <[email protected]>
+
+allOf:
+  - $ref: /schemas/i2c/i2c-controller.yaml#
+
+properties:
+  compatible:
+    const: qcom,geni-i2c
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: se
+
+  clock-frequency:
+    default: 100000
+
+  dmas:
+    maxItems: 2
+
+  dma-names:
+    items:
+      - const: tx
+      - const: rx
+
+  interconnects:
+    maxItems: 3
+
+  interconnect-names:
+    items:
+      - const: qup-core
+      - const: qup-config
+      - const: qup-memory
+
+  interrupts:
+    maxItems: 1
+
+  pinctrl-0: true
+  pinctrl-1: true
+
+  pinctrl-names:
+    minItems: 1
+    items:
+      - const: default
+      - const: sleep
+
+  power-domains:
+    maxItems: 1
+
+  reg:
+    maxItems: 1
+
+  required-opps:
+    maxItems: 1
+
+required:
+  - compatible
+  - interrupts
+  - clocks
+  - clock-names
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/qcom,gcc-sc7180.h>
+    #include <dt-bindings/interconnect/qcom,sc7180.h>
+    #include <dt-bindings/power/qcom-rpmpd.h>
+
+    i2c@88000 {
+        compatible = "qcom,geni-i2c";
+        reg = <0x00880000 0x4000>;
+        clock-names = "se";
+        clocks = <&gcc GCC_QUPV3_WRAP0_S0_CLK>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&qup_i2c0_default>;
+        interrupts = <GIC_SPI 601 IRQ_TYPE_LEVEL_HIGH>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+        interconnects = <&qup_virt MASTER_QUP_CORE_0 0 &qup_virt SLAVE_QUP_CORE_0 0>,
+                        <&gem_noc MASTER_APPSS_PROC 0 &config_noc SLAVE_QUP_0 0>,
+                        <&aggre1_noc MASTER_QUP_0 0 &mc_virt SLAVE_EBI1 0>;
+        interconnect-names = "qup-core", "qup-config", "qup-memory";
+        power-domains = <&rpmhpd SC7180_CX>;
+        required-opps = <&rpmhpd_opp_low_svs>;
+    };
+...
Signature · 1 line
2.25.1
Reviewed-by on v2 1/4
#2 lore raw

Re: [PATCH v2 1/4] dt-bindings: I2C: Add Qualcomm Geni based QUP I2C bindings

Quoted 16 lines · Kuldeep Singh

GENI(generic interface) based Qualcomm Universal Peripheral controller can support multiple serial interfaces like SPI,UART and I2C.

Unlike other I2C controllers, QUP I2C bindings are present in parent schema. Move it out from parent to an individual binding and let parent refer to child schema later on.

Please note, current schema isn't complete as it misses out few properties and thus, add these missing properties along the process.

---
v2:
- Change compatible from enum to const
- Drop clock-frequency description
- Sort nodes

Quoted 5 lines
---
 .../bindings/i2c/qcom,i2c-geni-qcom.yaml      | 100 ++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/qcom,i2c-geni-qcom.yaml

Best regards,
Krzysztof

#3 lore raw

Re: [PATCH v2 1/4] dt-bindings: I2C: Add Qualcomm Geni based QUP I2C bindings

In reply to Kuldeep Singh
Quoted 10 lines · Kuldeep Singh

GENI(generic interface) based Qualcomm Universal Peripheral controller can support multiple serial interfaces like SPI,UART and I2C.

Unlike other I2C controllers, QUP I2C bindings are present in parent schema. Move it out from parent to an individual binding and let parent refer to child schema later on.

Please note, current schema isn't complete as it misses out few properties and thus, add these missing properties along the process.

Quoted 7 lines

---
v2:
- Change compatible from enum to const
- Drop clock-frequency description
- Sort nodes
---

Gentle ping to revive this thread.
Patch 2,3,4 are accepted in this series and this one is only left.

Bjorn, could you please help in picking this up if there are no further review comments. Thanks!

maintainer
#4 lore raw

Re: [PATCH v2 1/4] dt-bindings: I2C: Add Qualcomm Geni based QUP I2C bindings

In reply to Kuldeep Singh
Quoted 16 lines · Kuldeep Singh

GENI(generic interface) based Qualcomm Universal Peripheral controller can support multiple serial interfaces like SPI,UART and I2C.

Unlike other I2C controllers, QUP I2C bindings are present in parent schema. Move it out from parent to an individual binding and let parent refer to child schema later on.

Please note, current schema isn't complete as it misses out few properties and thus, add these missing properties along the process.

---
v2:
- Change compatible from enum to const
- Drop clock-frequency description
- Sort nodes

Quoted 5 lines
---
 .../bindings/i2c/qcom,i2c-geni-qcom.yaml      | 100 ++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/qcom,i2c-geni-qcom.yaml

This series should have been applied all together, but as it seems it's already in multiple trees, I've applied.

Rob

#5 lore raw

PATCH v2 2/4 dt-bindings: qcom: geni-se: Update I2C schema reference

In reply to Kuldeep Singh

We now have geni based QUP I2C controller binding in place as dt-bindigs/i2c/qcom,i2c-geni-qcom.yaml similar to other controllers, update reference in parent schema and while at it, also remove properties defined for the controller from common wrapper.

---
v2:
- s/i2c/I2C
- s/commown/common
- Add Krzysztof's R-b tag

---
 .../bindings/soc/qcom/qcom,geni-se.yaml       | 26 +------------------
 1 file changed, 1 insertion(+), 25 deletions(-)
Documentation/devicetree/bindings/soc/qcom/qcom,geni-se.yaml +1 -25
index 95fcb43675d6..e6073923e03a 100644
@@ -128,31 +128,7 @@ patternProperties:
   "i2c@[0-9a-f]+$":
     type: object
     description: GENI serial engine based I2C controller.
-    $ref: /schemas/i2c/i2c-controller.yaml#
-
-    properties:
-      compatible:
-        enum:
-          - qcom,geni-i2c
-
-      interrupts:
-        maxItems: 1
-
-      "#address-cells":
-        const: 1
-
-      "#size-cells":
-        const: 0
-
-      clock-frequency:
-        description: Desired I2C bus clock frequency in Hz.
-        default: 100000
-
-    required:
-      - compatible
-      - interrupts
-      - "#address-cells"
-      - "#size-cells"
+    $ref: /schemas/i2c/qcom,i2c-geni-qcom.yaml#
 
   "serial@[0-9a-f]+$":
     type: object
Signature · 1 line
2.25.1
#6 lore raw

Re: (subset) [PATCH v2 2/4] dt-bindings: qcom: geni-se: Update I2C schema reference

Quoted 6 lines · Kuldeep Singh

We now have geni based QUP I2C controller binding in place as dt-bindigs/i2c/qcom,i2c-geni-qcom.yaml similar to other controllers, update reference in parent schema and while at it, also remove properties defined for the controller from common wrapper.

Applied, thanks!

[2/4] dt-bindings: qcom: geni-se: Update I2C schema reference

      commit: fcf2c0f7cbcad29f1decb88567e54c2451b60ba5

Best regards,

Signature · 1 line
Bjorn Andersson <[email protected]>
#7 lore raw

PATCH v2 3/4 dt-bindings: serial: Update Qualcomm geni based QUP UART bindings

In reply to Kuldeep Singh

Similar to I2C controller, move geni based QUP UART controller binding out from parent schema to an individual binding and let parent refer to child schema later on. UART binding also stand incomplete right now similar to I2C, complete it along this process.

---
v2:
- s/i2c/I2C
- s/uart/UART
- Sort nodes alphabetically
- Add Krzystof's Rb tag

---
 .../serial/qcom,serial-geni-qcom.yaml         | 86 +++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/serial/qcom,serial-geni-qcom.yaml
Documentation/devicetree/bindings/serial/qcom,serial-geni-qcom.yaml new file +86 -0
new file mode 100644
index 000000000000..05a6999808d1
@@ -0,0 +1,86 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/serial/qcom,serial-geni-qcom.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm Geni based QUP UART interface
+
+maintainers:
+  - Andy Gross <[email protected]>
+  - Bjorn Andersson <[email protected]>
+
+allOf:
+  - $ref: /schemas/serial/serial.yaml#
+
+properties:
+  compatible:
+    enum:
+      - qcom,geni-uart
+      - qcom,geni-debug-uart
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: se
+
+  interconnects:
+    maxItems: 2
+
+  interconnect-names:
+    items:
+      - const: qup-core
+      - const: qup-config
+
+  interrupts:
+    minItems: 1
+    items:
+      - description: UART core irq
+      - description: Wakeup irq (RX GPIO)
+
+  operating-points-v2: true
+
+  pinctrl-0: true
+  pinctrl-1: true
+
+  pinctrl-names:
+    minItems: 1
+    items:
+      - const: default
+      - const: sleep
+
+  power-domains:
+    maxItems: 1
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - clocks
+  - clock-names
+  - interrupts
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/qcom,gcc-sc7180.h>
+    #include <dt-bindings/interconnect/qcom,sc7180.h>
+
+    serial@a88000 {
+        compatible = "qcom,geni-uart";
+        reg = <0xa88000 0x7000>;
+        interrupts = <GIC_SPI 355 IRQ_TYPE_LEVEL_HIGH>;
+        clock-names = "se";
+        clocks = <&gcc GCC_QUPV3_WRAP0_S0_CLK>;
+        pinctrl-0 = <&qup_uart0_default>;
+        pinctrl-names = "default";
+        interconnects = <&qup_virt MASTER_QUP_CORE_0 0 &qup_virt SLAVE_QUP_CORE_0 0>,
+                        <&gem_noc MASTER_APPSS_PROC 0 &config_noc SLAVE_QUP_0 0>;
+        interconnect-names = "qup-core", "qup-config";
+    };
+...
Signature · 1 line
2.25.1
#8 lore raw

PATCH v2 4/4 dt-bindings: qcom: geni-se: Update UART schema reference

In reply to Kuldeep Singh

We now have geni based QUP UART controller individual binding, update reference in parent schema and remove properties from common wrapper.

With removal of last child node schema, remove common properties of all the controllers as they have become obsolete now.

---
v2:
- s/uart/UART
- Reword commit description
- Add Krzysztof's Rb tag
- Merge patch 5/5 of v1 series to this one:
https://lore.kernel.org/lkml/[email protected]/

---
 .../bindings/soc/qcom/qcom,geni-se.yaml       | 51 +------------------
 1 file changed, 1 insertion(+), 50 deletions(-)
Documentation/devicetree/bindings/soc/qcom/qcom,geni-se.yaml +1 -50
index e6073923e03a..c8e1a4a87ba8 100644
@@ -64,39 +64,6 @@ required:
   - ranges
 
 patternProperties:
-  "^.*@[0-9a-f]+$":
-    type: object
-    description: Common properties for GENI Serial Engine based I2C, SPI and
-                 UART controller.
-
-    properties:
-      reg:
-        description: GENI Serial Engine register address and length.
-        maxItems: 1
-
-      clock-names:
-        const: se
-
-      clocks:
-        description: Serial engine core clock needed by the device.
-        maxItems: 1
-
-      interconnects:
-        minItems: 2
-        maxItems: 3
-
-      interconnect-names:
-        minItems: 2
-        items:
-          - const: qup-core
-          - const: qup-config
-          - const: qup-memory
-
-    required:
-      - reg
-      - clock-names
-      - clocks
-
   "spi@[0-9a-f]+$":
     type: object
     description: GENI serial engine based SPI controller. SPI in master mode
@@ -133,23 +100,7 @@ patternProperties:
   "serial@[0-9a-f]+$":
     type: object
     description: GENI Serial Engine based UART Controller.
-    $ref: /schemas/serial.yaml#
-
-    properties:
-      compatible:
-        enum:
-          - qcom,geni-uart
-          - qcom,geni-debug-uart
-
-      interrupts:
-        minItems: 1
-        items:
-          - description: UART core irq
-          - description: Wakeup irq (RX GPIO)
-
-    required:
-      - compatible
-      - interrupts
+    $ref: /schemas/serial/qcom,serial-geni-qcom.yaml#
 
 additionalProperties: false
 
Signature · 1 line
2.25.1
#9 lore raw

Re: (subset) [PATCH v2 4/4] dt-bindings: qcom: geni-se: Update UART schema reference

Quoted 8 lines · Kuldeep Singh

We now have geni based QUP UART controller individual binding, update reference in parent schema and remove properties from common wrapper.

With removal of last child node schema, remove common properties of all the controllers as they have become obsolete now.

[...]

Applied, thanks!

[4/4] dt-bindings: qcom: geni-se: Update UART schema reference

      commit: 6579f39290bf056442850094b8f4b95163c17996

Best regards,

Signature · 1 line
Bjorn Andersson <[email protected]>