riscv,sbi-mpxy-mbox.yaml

 1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
 2%YAML 1.2
 3---
 4$id: http://devicetree.org/schemas/mailbox/riscv,sbi-mpxy-mbox.yaml#
 5$schema: http://devicetree.org/meta-schemas/core.yaml#
 6
 7title: RISC-V SBI Message Proxy (MPXY) extension based mailbox
 8
 9maintainers:
10  - Anup Patel <anup@brainfault.org>
11
12description: |
13  The RISC-V SBI Message Proxy (MPXY) extension [1] allows supervisor
14  software to send messages through the SBI implementation (M-mode
15  firmware or HS-mode hypervisor). The underlying message protocol
16  and message format used by the supervisor software could be some
17  other standard protocol compatible with the SBI MPXY extension
18  (such as RISC-V Platform Management Interface (RPMI) [2]).
19
20  ===========================================
21  References
22  ===========================================
23
24  [1] RISC-V Supervisor Binary Interface (SBI) v3.0 (or higher)
25      https://github.com/riscv-non-isa/riscv-sbi-doc/releases
26
27  [2] RISC-V Platform Management Interface (RPMI) v1.0 (or higher)
28      https://github.com/riscv-non-isa/riscv-rpmi/releases
29
30properties:
31  compatible:
32    const: riscv,sbi-mpxy-mbox
33
34  "#mbox-cells":
35    const: 2
36    description:
37      The first cell specifies channel_id of the SBI MPXY channel,
38      the second cell specifies MSG_PROT_ID of the SBI MPXY channel
39
40required:
41  - compatible
42  - "#mbox-cells"
43
44additionalProperties: false
45
46examples:
47  - |
48    mailbox {
49          compatible = "riscv,sbi-mpxy-mbox";
50          #mbox-cells = <2>;
51    };