From: Karl Li <karl.li@mediatek.com>

Add devicetree binding for apu-mailbox.

MediaTek APU (AI Processing Unit) is a microcontroller unit
designed for AI acceleration tasks. The MediaTek APU-Mailbox
facilitates communication with the APU microcontroller.

Signed-off-by: Karl Li <karl.li@mediatek.com>
---
 .../mailbox/mediatek,apu-mailbox.yaml         | 60 +++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml

diff --git a/Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml
new file mode 100644
index 000000000000..fdb0dec5fb78
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml
@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mailbox/mediatek,apu-mailbox.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MediaTek APU mailbox
+
+maintainers:
+  - Karl Li <Karl.Li@mediatek.com>
+
+description:
+  MediaTek APU (AI Processing Unit) is a microcontroller unit
+  designed for AI acceleration tasks. The MediaTek APU-Mailbox
+  facilitates communication with the APU microcontroller.
+  Within the MediaTek APU subsystem, a message passing mechanism is
+  built on top of the mailbox system. The mailbox only has limited
+  space for each message. The firmware expects the message header
+  from the mailbox, while the message body is passed through some
+  fixed shared memory.
+
+properties:
+  compatible:
+    const: mediatek,mt8196-apu-mailbox
+
+  "#mbox-cells":
+    const: 1
+    description:
+      The cell describe which channel the device will use.
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - "#mbox-cells"
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    soc {
+      #address-cells = <2>;
+      #size-cells = <2>;
+
+      mailbox@4c200000 {
+        compatible = "mediatek,mt8196-apu-mailbox";
+        reg = <0 0x4c200000 0 0xfffff>;
+        interrupts = <GIC_SPI 638 IRQ_TYPE_LEVEL_HIGH 0>;
+        #mbox-cells = <1>;
+      };
+    };
-- 
2.18.0

On Mon, Dec 30, 2024 at 11:43:35AM +0800, Karl.Li wrote:
> From: Karl Li <karl.li@mediatek.com>
> 
> Add devicetree binding for apu-mailbox.

A nit, subject: drop second/last, redundant "dt-bindings". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

I already asked for this.

> 
> MediaTek APU (AI Processing Unit) is a microcontroller unit
> designed for AI acceleration tasks. The MediaTek APU-Mailbox
> facilitates communication with the APU microcontroller.

Please wrap commit message according to Linux coding style / submission
process (neither too early nor over the limit):
https://elixir.bootlin.com/linux/v6.4-rc1/source/Documentation/process/submitting-patches.rst#L597




> 
> Signed-off-by: Karl Li <karl.li@mediatek.com>
> ---
>  .../mailbox/mediatek,apu-mailbox.yaml         | 60 +++++++++++++++++++
>  1 file changed, 60 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml
> 
> diff --git a/Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml
> new file mode 100644
> index 000000000000..fdb0dec5fb78
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mailbox/mediatek,apu-mailbox.yaml


Use compatible as filename.


Best regards,
Krzysztof