Documentation/devicetree/bindings/bus/microsoft,vmbus.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/bus/microsoft,vmbus.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Microsoft Hyper-V VMBus

maintainers:
  - Saurabh Sengar <ssengar@linux.microsoft.com>

description:
  VMBus is a software bus that implements the protocols for communication
  between the root or host OS and guest OS'es (virtual machines).

properties:
  compatible:
    const: microsoft,vmbus

  ranges: true

  '#address-cells':
    const: 2

  '#size-cells':
    const: 1

  dma-coherent: true

  interrupts:
    maxItems: 1
    description: Interrupt is used to report a message from the host.

required:
  - compatible
  - ranges
  - interrupts
  - '#address-cells'
  - '#size-cells'

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    soc {
        #address-cells = <2>;
        #size-cells = <1>;
        bus {
            compatible = "simple-bus";
            #address-cells = <2>;
            #size-cells = <1>;
            ranges;

            vmbus@ff0000000 {
                compatible = "microsoft,vmbus";
                #address-cells = <2>;
                #size-cells = <1>;
                ranges = <0x0f 0xf0000000 0x0f 0xf0000000 0x10000000>;
                dma-coherent;
                interrupt-parent = <&gic>;
                interrupts = <GIC_PPI 2 IRQ_TYPE_EDGE_RISING>;
            };
        };
    };