xref: /kernel/linux/linux-6.6/Documentation/devicetree/bindings/mailbox/amlogic,meson-gxbb-mhu.yaml

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
# Copyright 2019 BayLibre, SAS
%YAML 1.2
---
$id: http://devicetree.org/schemas/mailbox/amlogic,meson-gxbb-mhu.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Amlogic Meson Message-Handling-Unit Controller

maintainers:
  - Neil Armstrong <neil.armstrong@linaro.org>

description: |
  The Amlogic's Meson SoCs Message-Handling-Unit (MHU) is a mailbox controller
  that has 3 independent channels/links to communicate with remote processor(s).
  MHU links are hardwired on a platform. A link raises interrupt for any
  received data. However, there is no specified way of knowing if the sent
  data has been read by the remote. This driver assumes the sender polls
  STAT register and the remote clears it after having read the data.

properties:
  compatible:
    enum:
      - amlogic,meson-gxbb-mhu

  reg:
    maxItems: 1

  interrupts:
    minItems: 3
    description:
      Contains the interrupt information corresponding to each of the 3 links
      of MHU.

  "#mbox-cells":
    const: 1

required:
  - compatible
  - reg
  - interrupts
  - "#mbox-cells"

additionalProperties: false

examples:
  - |
    mailbox@c883c404 {
          compatible = "amlogic,meson-gxbb-mhu";
          reg = <0xc883c404 0x4c>;
          interrupts = <208>, <209>, <210>;
          #mbox-cells = <1>;
    };