This patch adds document for mediatek adsp mbox
Signed-off-by: Allen-KH Cheng <[email protected]>
---
.../bindings/mailbox/mtk,adsp-mbox.yaml | 71 +++++++++++++++++++
1 file changed, 71 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.yaml
diff --git a/Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.yaml b/Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.yaml
new file mode 100644
index 000000000000..d45b93025428
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.yaml
@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mailbox/mtk,adsp-mbox.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mediatek ADSP mailbox
+
+maintainers:
+ - Allen-KH Cheng <[email protected]>
+
+description: |
+ The MTK ADSP mailbox Inter-Processor Communication (IPC) enables the SoC
+ to ommunicate with ADSP by passing messages through two mailbox channels.
+ The MTK ADSP mailbox IPC also provides the ability for one processor to
+ signal the other processor using interrupts.
+
+properties:
+ compatible:
+ items:
+ - const: mediatek,mt8195-adsp-mbox
+
+ "#mbox-cells":
+ const: 1
+
+ reg:
+ items:
+ - description: adsp mbox0 registers
+ - description: adsp mbox1 registers
+
+ reg-names:
+ items:
+ - const: reg_mbox0
+ - const: reg_mbox1
+
+ interrupts:
+ items:
+ - description: adsp mbox0 interrupt
+ - description: adsp mbox1 interrupt
+
+ interrupt-names:
+ items:
+ - const: irq_mbox0
+ - const: irq_mbox1
+
+required:
+ - compatible
+ - "#mbox-cells"
+ - reg
+ - reg-names
+ - interrupts
+ - interrupt-names
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ adsp_mailbox@adsp_mailbox@10816000 {
+ compatible = "mediatek,mt8195-adsp-mbox";
+ #mbox-cells = <1>;
+ reg = <0 0x10816000 0 0x1000>,
+ <0 0x10817000 0 0x1000>;
+ reg-names = "reg_mbox0", "reg_mbox1";
+ interrupts = <GIC_SPI 702 IRQ_TYPE_LEVEL_HIGH 0>,
+ <GIC_SPI 703 IRQ_TYPE_LEVEL_HIGH 0>;
+ interrupt-names = "irq_mbox0", "irq_mbox0";
+ };
+
--
2.18.0
On Thu, 07 Oct 2021 21:06:41 +0800, Allen-KH Cheng wrote:
> This patch adds document for mediatek adsp mbox
>
> Signed-off-by: Allen-KH Cheng <[email protected]>
> ---
> .../bindings/mailbox/mtk,adsp-mbox.yaml | 71 +++++++++++++++++++
> 1 file changed, 71 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.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:
Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.example.dts:22.44-31.11: ERROR (node_name_format): /example-0/adsp_mailbox@adsp_mailbox@10816000: multiple '@' characters in node name
ERROR: Input tree has errors, aborting (use -f to force output)
make[1]: *** [scripts/Makefile.lib:385: Documentation/devicetree/bindings/mailbox/mtk,adsp-mbox.example.dt.yaml] Error 2
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1441: dt_binding_check] Error 2
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/1537694
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.