xref: /linux/Documentation/devicetree/bindings/ptp/amazon,vmclock.yaml (revision c17ee635fd3a482b2ad2bf5e269755c2eae5f25e)
1*1d5a6604SDavid Woodhouse# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2*1d5a6604SDavid Woodhouse%YAML 1.2
3*1d5a6604SDavid Woodhouse---
4*1d5a6604SDavid Woodhouse$id: http://devicetree.org/schemas/ptp/amazon,vmclock.yaml#
5*1d5a6604SDavid Woodhouse$schema: http://devicetree.org/meta-schemas/core.yaml#
6*1d5a6604SDavid Woodhouse
7*1d5a6604SDavid Woodhousetitle: Virtual Machine Clock
8*1d5a6604SDavid Woodhouse
9*1d5a6604SDavid Woodhousemaintainers:
10*1d5a6604SDavid Woodhouse  - David Woodhouse <dwmw2@infradead.org>
11*1d5a6604SDavid Woodhouse
12*1d5a6604SDavid Woodhousedescription:
13*1d5a6604SDavid Woodhouse  The vmclock device provides a precise clock source and allows for
14*1d5a6604SDavid Woodhouse  accurate timekeeping across live migration and snapshot/restore
15*1d5a6604SDavid Woodhouse  operations. The full specification of the shared data structure is
16*1d5a6604SDavid Woodhouse  available at https://uapi-group.org/specifications/specs/vmclock/
17*1d5a6604SDavid Woodhouse
18*1d5a6604SDavid Woodhouseproperties:
19*1d5a6604SDavid Woodhouse  compatible:
20*1d5a6604SDavid Woodhouse    const: amazon,vmclock
21*1d5a6604SDavid Woodhouse
22*1d5a6604SDavid Woodhouse  reg:
23*1d5a6604SDavid Woodhouse    description:
24*1d5a6604SDavid Woodhouse      Specifies the shared memory region containing the vmclock_abi structure.
25*1d5a6604SDavid Woodhouse    maxItems: 1
26*1d5a6604SDavid Woodhouse
27*1d5a6604SDavid Woodhouse  interrupts:
28*1d5a6604SDavid Woodhouse    description:
29*1d5a6604SDavid Woodhouse      Interrupt used to notify when the contents of the vmclock_abi structure
30*1d5a6604SDavid Woodhouse      have been updated.
31*1d5a6604SDavid Woodhouse    maxItems: 1
32*1d5a6604SDavid Woodhouse
33*1d5a6604SDavid Woodhouserequired:
34*1d5a6604SDavid Woodhouse  - compatible
35*1d5a6604SDavid Woodhouse  - reg
36*1d5a6604SDavid Woodhouse
37*1d5a6604SDavid WoodhouseadditionalProperties: false
38*1d5a6604SDavid Woodhouse
39*1d5a6604SDavid Woodhouseexamples:
40*1d5a6604SDavid Woodhouse  - |
41*1d5a6604SDavid Woodhouse    #include <dt-bindings/interrupt-controller/arm-gic.h>
42*1d5a6604SDavid Woodhouse    ptp@80000000 {
43*1d5a6604SDavid Woodhouse      compatible = "amazon,vmclock";
44*1d5a6604SDavid Woodhouse      reg = <0x80000000 0x1000>;
45*1d5a6604SDavid Woodhouse      interrupts = <GIC_SPI 36 IRQ_TYPE_EDGE_RISING>;
46*1d5a6604SDavid Woodhouse    };
47