Documentation/devicetree/bindings/rtc/ti,omap-rtc.yaml

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

title: Texas Instruments OMAP Real Time Clock

maintainers:
  - Keerthy <j-keerthy@ti.com>
  - Afzal Mohammed <afzal@ti.com>

description:
  The OMAP RTC is a year/month/day/hours/minutes/seconds BCD clock with
  century-range alarm matching, driven by the 32kHz clock.

properties:
  compatible:
    oneOf:
      - const: ti,da830-rtc
      - items:
          - const: ti,am3352-rtc
          - const: ti,da830-rtc
      - items:
          - const: ti,am4372-rtc
          - const: ti,am3352-rtc
          - const: ti,da830-rtc

  reg:
    maxItems: 1

  interrupts:
    minItems: 2
    maxItems: 2

  system-power-controller:
    type: boolean
    description:
      Indicates that this RTC controls system power via the pmic_power_en pin.

  clocks:
    minItems: 1
    maxItems: 2

  clock-names:
    minItems: 1
    items:
      - enum: [ext-clk, int-clk]
      - const: int-clk

  pinctrl-0:
    description:
      Phandle to pin configuration for the external wakeup pins.

  pinctrl-names:
    minItems: 1

  ti,hwmods:
    $ref: /schemas/types.yaml#/definitions/string
    description:
      Name of the hwmod associated with the RTC.
    const: rtc
    deprecated: true

patternProperties:
  "^ext-wakeup(-[0-9]+)?$":
    type: object

    description:
      Child node describing external wakeup pin configuration.

    properties:
      pins:
        pattern: '^ext_wakeup[0-3]$'

      input-enable:
        type: boolean
        description:
          Enables the external wakeup input on the selected pin.

      ti,active-high:
        type: boolean
        description:
          Sets the wakeup input polarity to active high. By default the
          input is active low.

    required:
      - pins

    additionalProperties: false

required:
  - compatible
  - reg
  - interrupts

allOf:
  - $ref: rtc.yaml#
  - if:
      not:
        properties:
          compatible:
            contains:
              const: ti,am3352-rtc
    then:
      properties:
        system-power-controller: false
      patternProperties:
        "^ext-wakeup(-[0-9]+)?$": false

unevaluatedProperties: false

examples:
  - |
    rtc@23000 {
        compatible = "ti,da830-rtc";
        reg = <0x23000 0x1000>;
        interrupts = <19>, <19>;
        clocks = <&clk_32768_ck>;
        clock-names = "int-clk";
    };

  - |
    rtc@0 {
        compatible = "ti,am3352-rtc", "ti,da830-rtc";
        reg = <0x0 0x1000>;
        interrupts = <75>, <76>;
        system-power-controller;
        clocks = <&clk_32k_rtc>, <&clk_32768_ck>;
        clock-names = "ext-clk", "int-clk";

        pinctrl-0 = <&ext_wakeup>;
        pinctrl-names = "default";

        ext-wakeup {
            pins = "ext_wakeup0";
            input-enable;
            ti,active-high;
        };
    };