xref: /kernel/linux/linux-6.6/Documentation/devicetree/bindings/rtc/brcm,brcmstb-waketimer.yaml

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

title: Broadcom STB wake-up Timer

maintainers:
  - Florian Fainelli <f.fainelli@gmail.com>

description:
  The Broadcom STB wake-up timer provides a 27Mhz resolution timer, with the
  ability to wake up the system from low-power suspend/standby modes and
  optionally generate RTC alarm interrupts.

allOf:
  - $ref: rtc.yaml#

properties:
  compatible:
    const: brcm,brcmstb-waketimer

  reg:
    maxItems: 1

  interrupts:
    minItems: 1
    items:
      - description: the TIMER interrupt
      - description: the ALARM interrupt
    description:
      The TIMER interrupt wakes the system from low-power suspend/standby modes.
      An ALARM interrupt may be specified to interrupt the CPU when an RTC alarm
      is enabled.

  clocks:
    description: clock reference in the 27MHz domain
    maxItems: 1

additionalProperties: false

examples:
  - |
    rtc@f041a080 {
        compatible = "brcm,brcmstb-waketimer";
        reg = <0xf041a080 0x14>;
        interrupts-extended = <&aon_pm_l2_intc 0x04>,
                              <&upg_aux_aon_intr2_intc 0x08>;
        clocks = <&upg_fixed>;
    };