Documentation/devicetree/bindings/misc/qemu,vcpu-stall-detector.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/misc/qemu,vcpu-stall-detector.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: VCPU stall detector
   8
   9 description:
  10   This binding describes a CPU stall detector mechanism for virtual CPUs
  11   which is accessed through MMIO.
  12
  13 maintainers:
  14   - Sebastian Ene <sebastianene@google.com>
  15
  16 properties:
  17   compatible:
  18     enum:
  19       - qemu,vcpu-stall-detector
  20
  21   reg:
  22     maxItems: 1
  23
  24   clock-frequency:
  25     $ref: /schemas/types.yaml#/definitions/uint32
  26     description: |
  27       The internal clock of the stall detector peripheral measure in Hz used
  28       to decrement its internal counter register on each tick.
  29       Defaults to 10 if unset.
  30     default: 10
  31
  32   timeout-sec:
  33     description: |
  34       The stall detector expiration timeout measured in seconds.
  35       Defaults to 8 if unset. Please note that it also takes into account the
  36       time spent while the VCPU is not running.
  37     default: 8
  38
  39 required:
  40   - compatible
  41
  42 additionalProperties: false
  43
  44 examples:
  45   - |
  46     vmwdt@9030000 {
  47       compatible = "qemu,vcpu-stall-detector";
  48       reg = <0x9030000 0x10000>;
  49       clock-frequency = <10>;
  50       timeout-sec = <8>;
  51     };