Add the YAML documentation for Realtek DHC (Digital Home Center) SoCs.
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202311180921.ayKhiFHL-lkp@intel.com/
CC: Thomas Gleixner <tglx@linutronix.de>
CC: Marc Zyngier <maz@kernel.org>
CC: Rob Herring <robh+dt@kernel.org>
CC: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
CC: Conor Dooley <conor+dt@kernel.org>
CC: linux-kernel@vger.kernel.org
CC: devicetree@vger.kernel.org
Signed-off-by: James Tai <james.tai@realtek.com>
---
v2 to v3 change:
- Retested the bindings using the new version of the dtschema
- Fixed the order of property items
- Removed redundant files and replaced them with 'realtek,intc.yaml'
- Replaced 'interrupts-extended' with 'interrupts'
- Added a description for 'interrupts'
- Reduced the example code
v1 to v2 change:
- Tested the bindings using 'make dt_binding_check'
- Fixed code style issues
.../interrupt-controller/realtek,intc.yaml | 76 +++++++++++++++++++
1 file changed, 76 insertions(+)
create mode 100644 Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml
diff --git a/Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml b/Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml
new file mode 100644
index 000000000000..3aa863b1549d
--- /dev/null
+++ b/Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/interrupt-controller/realtek,intc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek DHC SoCs Interrupt Controller
+
+maintainers:
+ - James Tai <james.tai@realtek.com>
+
+description:
+ This interrupt controller is a component of Realtek DHC (Digital Home Center)
+ SoCs and is designed to receive interrupts from peripheral devices.
+
+ Each DHC SoC has two sets of interrupt controllers, each capable of
+ handling up to 32 interrupts.
+
+allOf:
+ - $ref: /schemas/interrupt-controller.yaml#
+
+properties:
+ compatible:
+ enum:
+ - realtek,rtd1319-intc-iso
+ - realtek,rtd1319-intc-misc
+ - realtek,rtd1319d-intc-iso
+ - realtek,rtd1319d-intc-misc
+ - realtek,rtd1325-intc-iso
+ - realtek,rtd1325-intc-misc
+ - realtek,rtd1619b-intc-iso
+ - realtek,rtd1619b-intc-misc
+
+ reg:
+ maxItems: 1
+
+ interrupt-controller: true
+
+ '#interrupt-cells':
+ const: 1
+
+ '#address-cells':
+ const: 0
+
+ interrupts:
+ description: |
+ Contains the GIC SPI IRQs mapped to the external interrupt lines.
+ minItems: 2
+ maxItems: 4
+
+required:
+ - compatible
+ - reg
+ - interrupt-controller
+ - '#interrupt-cells'
+ - '#address-cells'
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+ realtek_iso_intc: interrupt-controller@40 {
+ compatible = "realtek,rtd1319-intc-iso";
+ reg = <0x00 0x40>;
+ interrupt-parent = <&gic>;
+ interrupts = <GIC_SPI 41 IRQ_TYPE_LEVEL_HIGH>,
+ <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
+ interrupt-controller;
+ #address-cells = <0>;
+ #interrupt-cells = <1>;
+ };
+...
--
2.25.1On 29/11/2023 06:43, James Tai wrote: > Add the YAML documentation for Realtek DHC (Digital Home Center) SoCs. > > Reported-by: kernel test robot <lkp@intel.com> > Closes: https://lore.kernel.org/oe-kbuild-all/202311180921.ayKhiFHL-lkp@intel.com/ Drop both. They are not applicable to this patch. > CC: Thomas Gleixner <tglx@linutronix.de> > CC: Marc Zyngier <maz@kernel.org> > CC: Rob Herring <robh+dt@kernel.org> > CC: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org> > CC: Conor Dooley <conor+dt@kernel.org> > CC: linux-kernel@vger.kernel.org > CC: devicetree@vger.kernel.org Please drop the autogenerated scripts/get_maintainer.pl CC-entries from commit msg. There is no single need to store automated output of get_maintainers.pl in the git log. It can be easily re-created at any given time, thus its presence in the git history is redundant and obfuscates the log. If you need it for your own patch management purposes, keep it under the --- separator. > Signed-off-by: James Tai <james.tai@realtek.com> > --- > v2 to v3 change: > - Retested the bindings using the new version of the dtschema > - Fixed the order of property items > - Removed redundant files and replaced them with 'realtek,intc.yaml' > - Replaced 'interrupts-extended' with 'interrupts' > - Added a description for 'interrupts' > - Reduced the example code > > v1 to v2 change: > - Tested the bindings using 'make dt_binding_check' > - Fixed code style issues > > .../interrupt-controller/realtek,intc.yaml | 76 +++++++++++++++++++ > 1 file changed, 76 insertions(+) > create mode 100644 Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml > > diff --git a/Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml b/Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml > new file mode 100644 > index 000000000000..3aa863b1549d > --- /dev/null > +++ b/Documentation/devicetree/bindings/interrupt-controller/realtek,intc.yaml > @@ -0,0 +1,76 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/interrupt-controller/realtek,intc.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Realtek DHC SoCs Interrupt Controller > + > +maintainers: > + - James Tai <james.tai@realtek.com> > + > +description: > + This interrupt controller is a component of Realtek DHC (Digital Home Center) > + SoCs and is designed to receive interrupts from peripheral devices. > + > + Each DHC SoC has two sets of interrupt controllers, each capable of > + handling up to 32 interrupts. > + > +allOf: > + - $ref: /schemas/interrupt-controller.yaml# > + > +properties: > + compatible: > + enum: > + - realtek,rtd1319-intc-iso > + - realtek,rtd1319-intc-misc > + - realtek,rtd1319d-intc-iso > + - realtek,rtd1319d-intc-misc > + - realtek,rtd1325-intc-iso > + - realtek,rtd1325-intc-misc > + - realtek,rtd1619b-intc-iso > + - realtek,rtd1619b-intc-misc > + > + reg: > + maxItems: 1 > + > + interrupt-controller: true > + > + '#interrupt-cells': > + const: 1 > + > + '#address-cells': > + const: 0 > + > + interrupts: > + description: | > + Contains the GIC SPI IRQs mapped to the external interrupt lines. > + minItems: 2 > + maxItems: 4 My previous comments were not addressed. Why lines are not described (items: description:)? Are they all the same? Why you did not respond to clarify this comment? The rest of my comment here was also ignored. You cannot just ignore comments, but must respond to them or implement them. To clarify: I expect allOf: block after required: constraining the interrupts per variant. Best regards, Krzysztof
Hi Krzysztof, >On 29/11/2023 06:43, James Tai wrote: >> Add the YAML documentation for Realtek DHC (Digital Home Center) SoCs. >> >> Reported-by: kernel test robot <lkp@intel.com> >> Closes: >> https://lore.kernel.org/oe-kbuild-all/202311180921.ayKhiFHL-lkp@intel. >> com/ > >Drop both. They are not applicable to this patch. > Okay. I will drop them. >> CC: Thomas Gleixner <tglx@linutronix.de> >> CC: Marc Zyngier <maz@kernel.org> > >> CC: Rob Herring <robh+dt@kernel.org> >> CC: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org> >> CC: Conor Dooley <conor+dt@kernel.org> >> CC: linux-kernel@vger.kernel.org >> CC: devicetree@vger.kernel.org > >Please drop the autogenerated scripts/get_maintainer.pl CC-entries from >commit msg. There is no single need to store automated output of >get_maintainers.pl in the git log. It can be easily re-created at any given time, >thus its presence in the git history is redundant and obfuscates the log. > >If you need it for your own patch management purposes, keep it under the >--- separator. > I will move the CC-entries under the '---' separator. >My previous comments were not addressed. Why lines are not described >(items: description:)? Are they all the same? Why you did not respond to clarify >this comment? > I've addressed the previous comments and will include a description for each line in the next patches. I misunderstood your meaning, so I did not provide a clear response. >The rest of my comment here was also ignored. You cannot just ignore >comments, but must respond to them or implement them. > I will improve this part. >To clarify: I expect allOf: block after required: constraining the interrupts per >variant. > I will adjust it in next patches. Regards, James
© 2016 - 2025 Red Hat, Inc.