Commit 840ac611 authored by Frank Li's avatar Frank Li Committed by Alexandre Belloni
Browse files

dt-bindings: rtc: Convert rtc-fsl-ftm-alarm.txt to yaml format



Convert dt-binding doc "rtc-fsl-ftm-alarm.txt" to yaml format.

Change example's reg to 32bit address and length.
Remove unrelated rcpm@1e34040 in example.

Signed-off-by: default avatarFrank Li <Frank.Li@nxp.com>
Reviewed-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20240528184359.2685109-1-Frank.Li@nxp.com


Signed-off-by: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
parent 86e9b508
Loading
Loading
Loading
Loading
+73 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/rtc/fsl,ls-ftm-alarm.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Freescale FlexTimer Module (FTM) Alarm

maintainers:
  - Frank Li <Frank.Li@nxp.com>

properties:
  compatible:
    enum:
      - fsl,ls1012a-ftm-alarm
      - fsl,ls1021a-ftm-alarm
      - fsl,ls1028a-ftm-alarm
      - fsl,ls1043a-ftm-alarm
      - fsl,ls1046a-ftm-alarm
      - fsl,ls1088a-ftm-alarm
      - fsl,ls208xa-ftm-alarm
      - fsl,lx2160a-ftm-alarm

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  fsl,rcpm-wakeup:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    items:
      - items:
          - description: phandle to rcpm node
          - description: bit mask of IPPDEXPCR0
          - description: bit mask of IPPDEXPCR1
          - description: bit mask of IPPDEXPCR2
          - description: bit mask of IPPDEXPCR3
          - description: bit mask of IPPDEXPCR4
          - description: bit mask of IPPDEXPCR5
          - description: bit mask of IPPDEXPCR6
        minItems: 1
    description:
      phandle to rcpm node, Please refer
      Documentation/devicetree/bindings/soc/fsl/rcpm.txt

  big-endian:
    $ref: /schemas/types.yaml#/definitions/flag
    description:
      If the host controller is big-endian mode, specify this property.
      The default endian mode is little-endian.

required:
  - compatible
  - reg
  - interrupts
  - fsl,rcpm-wakeup

allOf:
  - $ref: rtc.yaml#

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/arm-gic.h>

    rtc@2800000 {
        compatible = "fsl,ls1088a-ftm-alarm";
        reg = <0x2800000 0x10000>;
        fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
        interrupts = <GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>;
    };
+0 −36
Original line number Diff line number Diff line
Freescale FlexTimer Module (FTM) Alarm

Required properties:
- compatible : Should be "fsl,<chip>-ftm-alarm", the
	       supported chips include
	       "fsl,ls1012a-ftm-alarm"
	       "fsl,ls1021a-ftm-alarm"
	       "fsl,ls1028a-ftm-alarm"
	       "fsl,ls1043a-ftm-alarm"
	       "fsl,ls1046a-ftm-alarm"
	       "fsl,ls1088a-ftm-alarm"
	       "fsl,ls208xa-ftm-alarm"
	       "fsl,lx2160a-ftm-alarm"
- reg : Specifies base physical address and size of the register sets for the
  FlexTimer Module.
- interrupts : Should be the FlexTimer Module interrupt.
- fsl,rcpm-wakeup property and rcpm node : Please refer
	Documentation/devicetree/bindings/soc/fsl/rcpm.txt

Optional properties:
- big-endian: If the host controller is big-endian mode, specify this property.
  The default endian mode is little-endian.

Example:
rcpm: rcpm@1e34040 {
	compatible = "fsl,ls1088a-rcpm", "fsl,qoriq-rcpm-2.1+";
	reg = <0x0 0x1e34040 0x0 0x18>;
	#fsl,rcpm-wakeup-cells = <6>;
};

ftm_alarm0: timer@2800000 {
	compatible = "fsl,ls1088a-ftm-alarm";
	reg = <0x0 0x2800000 0x0 0x10000>;
	fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
	interrupts = <0 44 4>;
};