Received-SPF: pass (google.com: domain of linux-kernel+bounces-192873-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Frank Li <Frank.Li@nxp.com>
To: krzk@kernel.org
Cc: Frank.li@nxp.com,
	alexandre.belloni@bootlin.com,
	conor+dt@kernel.org,
	devicetree@vger.kernel.org,
	imx@lists.linux.dev,
	krzk+dt@kernel.org,
	linux-kernel@vger.kernel.org,
	linux-rtc@vger.kernel.org,
	robh@kernel.org
Subject: [PATCH v2 1/1] dt-bindings: rtc: Convert rtc-fsl-ftm-alarm.txt to yaml format
Date: Tue, 28 May 2024 14:43:59 -0400
Message-Id: <20240528184359.2685109-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?+zMWMh3b0VEagZD8S9JAV13xZXd2izO6cFNKtjpfpkZDZBAULCeF3F4kaGmc?=
 =?us-ascii?Q?5wKxo/cnA7khF+jo7CLCaJPgAHvNVxU4tIS3ZXB2+TZqmMZUlWPxJGKtdf7A?=
 =?us-ascii?Q?Kjs6vMhNOLvNfrShk+g/2fiwBAGBJ6wjAjfZKebwN3pek+vCZ9JmQMZ1PvfS?=
 =?us-ascii?Q?LySrjxF8ZjXkEozxrLewMkMd6B9LjuofBMKSMBuYNU7D9k6ZoSB2CBXQfW1S?=
 =?us-ascii?Q?OOo9T6mAm3XO4Ujit66kaZaykMZSyKIj7GyYbCGgKMS40VSaPOGtGe1zHkOq?=
 =?us-ascii?Q?W0r2J/IFCCjepgvgs2rTdRt99uZif3UTzQZgz5rnY5w+CWnvZuc8XXi0CYoA?=
 =?us-ascii?Q?SDk07+IdwS0rrkeGZXXxgHvrLhfsZxw1cVmY36t4hQrYDkvF87cBr4uWPAep?=
 =?us-ascii?Q?Oj0ByoduEMTpZk26wC7oketAPL9n8wDGC4rMuVUavcFB9wJqDSo7Xj/hj7ma?=
 =?us-ascii?Q?gmw91xlSCRICdmUg5VaXyeqriECGBumiZogy6CtM6xjwYy4vaEstYayBBC0s?=
 =?us-ascii?Q?9P18yQg/VpFSQf2YLWeVNb6Jgkl8gfmCQqPa2iztQETxJxmIByYW1GFWGEAl?=
 =?us-ascii?Q?CDRn9vSHMK9uqGV0IRpUQOKjr2zu3LCTA8+DDfN8SoCmtgZEyJox9nI3l9sB?=
 =?us-ascii?Q?3PYcNrQ526NKqJS4bjFZcex+E/SCbN2MZPm2rPNoUih3olaYxHefqJpT2gaU?=
 =?us-ascii?Q?CLJOewajeRsv8BbfKEcHN5cFWrRxlWtteyTQWD8nwkI4sOs2jw7xIqbJ7q3k?=
 =?us-ascii?Q?Xn5M2L01BOkGfm4j4fTu7N5nL6nK+Hltkgl3qpRWzDqowgmzvPcH74cf/uIi?=
 =?us-ascii?Q?FfIpnHKssNolVCWwSjEWiKksGzq4ycGRljj0R+ezr4/EyhCPGqJw/JnAyuw8?=
 =?us-ascii?Q?5bk4pSzljwpXerzZ1644ai+6PeT5OnilyO5etA2S/tlWJWeBd0NZgvU47ih1?=
 =?us-ascii?Q?En5w7OEZkc8KC6LKFEtkmfFNwaYPiq/9gTZhoh2PPqg/bZD54d0G9X0Gx6dZ?=
 =?us-ascii?Q?WGHtabFkg1zKcGHPYwla1O2i42fdI6sgXucWlc056hwgOsPckxZaAYDKliy3?=
 =?us-ascii?Q?mcKa57yAu6czpHO3oN8oQoP5kPUzSZqxQk4vFdc5obm6uUTerdhDPOuqSgZ0?=
 =?us-ascii?Q?srG6PhCFIp0ZpGbEpCgpOa8thndFhLo1vYhEGaTjSLTCffSnnFUuTMx0menO?=
 =?us-ascii?Q?JwMFgNGljkHI5AlEVsci3Zh1YXAjV3W1+AZj5R7GxlvXuYh95fBOuMYkvfmX?=
 =?us-ascii?Q?KU2M1AEKGo08ZdQL/SfXDTUJgvoK78VQHCRr5sfJnByasD4XZUGrVo3b2DZN?=
 =?us-ascii?Q?+NKom50WobNBkxw4QhrTJdPvi0CUfEVv5+fOnL1c7TM8GO8vV3FoAtMfLED6?=
 =?us-ascii?Q?n7Cruscx9gSc0T+0UVeAtcWyfzNzTwQPUDxyaXuG1fNu+lmsF/OtMaTXVhjh?=
 =?us-ascii?Q?HQhi4aoLEz8CIxDxs6VYEK08HiIdbfVcEKUyrVec/qmeqaEqkDL5iQVfCwoQ?=
 =?us-ascii?Q?bAhE1t7Vw0AZFJFnMuvHaZmFmYxf7ywaMN5DqQHykpoz8aC+RL+d8Cu/GyxE?=
 =?us-ascii?Q?1SR4NZ3sSyKHRTALbcmwyxUBwD/iVCfs3t1WHbp3?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5e8b4dc9-7dd7-49ff-2e63-08dc7f462cb7
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 May 2024 18:44:15.6307
 (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: wiALtqZgG+j53aBA4Qpjzg2gGaGmN5BHc9pHZTX8YaJGcGfDdpcTj2ZhK0lyo7MWylhfX0fy3sexRPCfcyUn8g==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM7PR04MB6856

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:
    Change from v1 to v2
    - file name change to fsl,ls-ftm-alarm.yaml
    - drop description for reg and interrupt
    - add descript items for fsl,rcpm-wakeup
    - add allof rtc.yaml
    - example use node name 'rtc'
    - example interrupt include gic.h
    
    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/fsl,ls-ftm-alarm.yaml        | 73 +++++++++++++++++++
 .../bindings/rtc/rtc-fsl-ftm-alarm.txt        | 36 ---------
 2 files changed, 73 insertions(+), 36 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/rtc/fsl,ls-ftm-alarm.yaml
 delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt

diff --git a/Documentation/devicetree/bindings/rtc/fsl,ls-ftm-alarm.yaml b/Documentation/devicetree/bindings/rtc/fsl,ls-ftm-alarm.yaml
new file mode 100644
index 0000000000000..388102ae30cd8
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/fsl,ls-ftm-alarm.yaml
@@ -0,0 +1,73 @@
+# 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>;
+    };
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>;
-};
-- 
2.34.1