Received-SPF: pass (google.com: domain of linux-kernel+bounces-184201-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Frank Li <Frank.Li@nxp.com>
To: Alexandre Belloni <alexandre.belloni@bootlin.com>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	linux-rtc@vger.kernel.org (open list:REAL TIME CLOCK (RTC) SUBSYSTEM),
	devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS),
	linux-kernel@vger.kernel.org (open list)
Cc: imx@lists.linux.dev
Subject: [PATCH 1/1] dt-bindings: rtc: Convert rtc-fsl-ftm-alarm.txt to yaml format
Date: Mon, 20 May 2024 17:46:13 -0400
Message-Id: <20240520214614.863539-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?fqpxM9a1rNH4pwFKsIdgk6TRorb4SrnPVPndohbnwd2KFTt4jtKPTfokJN1I?=
 =?us-ascii?Q?gfezV+pD4hxV36XrD5PYNK2M8VnsgU0bkzeFkY0AN7L5s5W88ugVRfi/Zdis?=
 =?us-ascii?Q?ECWjfY52A2kQr54bkRY2G1bmTDikOiVh3kCfFGmCay4xiewIzOY/a5t0BIbj?=
 =?us-ascii?Q?jncLrYb1FkgI4kETTwfdrhiIVwvwA15SvpsnM8eqc/E3xhXl7UtRQlY0+rqK?=
 =?us-ascii?Q?PHu24nP0BXvE22edsXDQ9G1tzNMlS/oStPDo46Yip39NjGVAeICPsDaba4Gs?=
 =?us-ascii?Q?jpkMartYp0bfmTPuXxZc7olvwJneTy1HUI1iQbJOmZST+L4VRisr8qvFOUG8?=
 =?us-ascii?Q?hzFVchrhy3tmCOluJzLGsZ1Fw7aZm71iNgc3kQRU2Xt1zhEUfHhEi+fRRQXn?=
 =?us-ascii?Q?0uDzt9b/Vlu+7zUMBMmDe2WcaP3PmXl0T5QB+dyi+stJEJj5ZBNXYGxa8SyS?=
 =?us-ascii?Q?PwvFnBusWR9EU0mTvcjoBUakVxV2ACVYej75uNVRhUwxHpxLhNpG9mHtttFY?=
 =?us-ascii?Q?F32Sprx9Gvbm/3InV/P+jM/qZKk4sOy03DQ4jRtockDbTnYVi/ll65/Y+9TJ?=
 =?us-ascii?Q?6Y861wPRl2HBJzb5Spc57IiVCYLL1SnDviW2eAjeBvcSUDYbznhKgnzSSncS?=
 =?us-ascii?Q?X3zn75jrHHa3zwkmb7w/abanu1jVLOQTDdPMM0U99eWPzJMD97TLv+L3WUi/?=
 =?us-ascii?Q?tf64erUeMZoOrsCGnzrlXfGgAMUfGClK/ix5iA35St2mK0p4bgrV/qoIrCp0?=
 =?us-ascii?Q?qmsCax+n1p5R8i756F6y1thAv7BaiUd+b6rYySjCX0GENJzvOXwTrqIguTd8?=
 =?us-ascii?Q?8ZE2Qog2DpUHhXV3YcKrKMUPkNHWrBtklhDdcZ8z0S4tZ9+DInShqm2BWVAk?=
 =?us-ascii?Q?h0HA3YKaXXAxo5gNPVyO2Y6VJw6zUnnFKXdhIMcRLdvplhFHvEH1469pJm3l?=
 =?us-ascii?Q?5zby7rA0UTkh26HezYVLffkS1eAjuEgVMT0j3ZUjrkTM3rriBmWI+0p8fFbQ?=
 =?us-ascii?Q?UJEkQY9rWbac2JPN3LvsC4RPBD1zQ6iK4ij37uCksRZRDVAMaYMEovdCziOk?=
 =?us-ascii?Q?kJu8XlgTIrVA03qSke1NPMMrcgt0p1LtBXmD749C6iV5BYoAtDYTRF8vM+i+?=
 =?us-ascii?Q?wuEIGNffFTXt9466bJdUAcfTtG8zR6yPDRPEz6ZbSswpp9O9xCbBqTIaRK03?=
 =?us-ascii?Q?9r4DcUdAgyG2WsZeyQ92IQg2G8S/Ma+4QfEANecZ7T2O+QbYLMEx4sarQY6L?=
 =?us-ascii?Q?WB8teOYoZNCn3scqaMWONq33sUdfgQca9edFy0EcdqXDCq/09+eM0tJO1ghr?=
 =?us-ascii?Q?S0ntIjhw5BKn5u29mH6uDpNjTOOf6UoQLxavb5V8wO7xv69EXDcu1Ut1n6kR?=
 =?us-ascii?Q?d3vN4fjUMOCXJDHhYP9tLSL2pf3q08j7s2GAzhPNDwrMwHCwCkV/NCYNkplS?=
 =?us-ascii?Q?3/ltvGpbIa7NzfOy4dJ0llDYRN+Ku97TRFmQPFUsNXqTGR6EkEquVd4orbkx?=
 =?us-ascii?Q?39EFRJ2Aj/qNMp6kxTJwoyuz7SdmXdeK4vPOeMDlc3TDO1gJ9LRl5eVE+S1w?=
 =?us-ascii?Q?jIvoYn9MblN/wCWbJJHWaEPEaZGGN5NBJDAIBH6x?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 28fc1ad9-c050-4521-39ac-08dc79164e27
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 May 2024 21:46:28.8735
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Ddu/ttQpWJhPbCbV6Jf3izJhkc+YsSup0vaJ5o4HSqBbM17DbACAQJmxEjqXJB3jsqwGfz1uLoFMu6IQ7TkzWA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM7PR04MB7112

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: Frank Li <Frank.Li@nxp.com>
---

Notes:
    make dt_binding_check DT_SCHEMA_FILES=rtc-fsl-ftm-alarm.yaml
      SCHEMA  Documentation/devicetree/bindings/processed-schema.json
      CHKDT   Documentation/devicetree/bindings
      LINT    Documentation/devicetree/bindings
      DTEX    Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dts
      DTC_CHK Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dtb

 .../bindings/rtc/rtc-fsl-ftm-alarm.txt        | 36 -----------
 .../bindings/rtc/rtc-fsl-ftm-alarm.yaml       | 61 +++++++++++++++++++
 2 files changed, 61 insertions(+), 36 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
 create mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml

diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
deleted file mode 100644
index fffac74999da6..0000000000000
--- a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-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>;
-};
diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
new file mode 100644
index 0000000000000..69b44e9920033
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/rtc-fsl-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:
+    description:
+      Specifies base physical address and size of the register sets for the
+      FlexTimer Module.
+    maxItems: 1
+
+  interrupts:
+    description: Should be the FlexTimer Module interrupt.
+    maxItems: 1
+
+  fsl,rcpm-wakeup:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    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
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    timer@2800000 {
+        compatible = "fsl,ls1088a-ftm-alarm";
+        reg = <0x2800000 0x10000>;
+        fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
+        interrupts = <0 44 4>;
+    };
-- 
2.34.1