Received-SPF: pass (google.com: domain of linux-kernel+bounces-193016-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: Frank Li <Frank.Li@nxp.com>
To: =?UTF-8?q?Uwe=20Kleine-K=C3=B6nig?= <ukleinek@kernel.org>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	linux-pwm@vger.kernel.org (open list:PWM 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: pwm: fsl-ftm: Convert to yaml format
Date: Tue, 28 May 2024 16:20:24 -0400
Message-Id: <20240528202025.2919358-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?gXSnCrBfW+rEHaTZsUI/iGohdVV35uo9ahdlEl3l8Z+KTALxCK5bCRs1qt1/?=
 =?us-ascii?Q?RFL+RtGTngaogqt0tIr3ClnFUk5zntMadbqPEDXL3g0RCAo/Wrt+jT3xcMqO?=
 =?us-ascii?Q?UMKbmxMmYk8Qb1Kjp3BKhqDeJe5rw/lnte2u61cTe7iOLTBqiLlQVttU08Mz?=
 =?us-ascii?Q?SwMMBeGGDAWgnCi/QZaWy2Vk669COlA9pB3ZmLNxDoVbMvNMrSzR0uPnIVdG?=
 =?us-ascii?Q?GlpzAnq6XFUNVVjvOod/pNqP/Dm4W55c1N9lbT7dKRrboqXgzG0pwzqEs4B4?=
 =?us-ascii?Q?0sGCEDH3L41vcYqKulHObRy5gQ9Oobxee3V+eDOE7VBatgnAW16p/2MZORjh?=
 =?us-ascii?Q?NUJ9RqcSfIGXXLAWpIW9MTcFzGD5Dl9utOE9gVSqvcLJk4Q8B80V0skF7Q0z?=
 =?us-ascii?Q?0Qecq43W4yayHgMPxZK5W3uKlcIxpK+UCehGud/X7HHEj48FUykuRHbP778b?=
 =?us-ascii?Q?2hMBM+iGY9vNeMtZE+KDJusMgd7mZPVqVf1TR4dSdJJ0fnZNKaCIIJuO7fCT?=
 =?us-ascii?Q?/mTrZUDWAjTE3UHI+DEQRoxya7Vc9iutGK0W98T787COL6Kdcgax/iuFyUjL?=
 =?us-ascii?Q?+D39/XP3e6sooulndipWQDhQ9tvZxx/L4rhZU59bdj5woqNIdGZHxpl+lUY2?=
 =?us-ascii?Q?G7pYyIGUBnTrjC3xA+OZtPPoomLZcRnrTAlZaQKECVO0uKqgYlnx5//Ec9Sf?=
 =?us-ascii?Q?1yacc7dgyJjRCYH0Py4UHGwakW13U8mRcxVrJwEG13ny08Znjdc/VXLdOKiE?=
 =?us-ascii?Q?i1H8OiC0sWIKm+QDqBFp2EXQqPF7AGxsUUvhH1aPbfuCdBkidCg5kSPrPAC+?=
 =?us-ascii?Q?8hnNEsWDy51W40xiwILFjlsutdUWVl/VqeWXltWqJ7srWDBK0FOdxkJPzxXM?=
 =?us-ascii?Q?MXP+Psvvr8+TSgtlfMxznsXZfDLAFGWBOuKfEpeAwF9JGK6RpW/ReJponfm5?=
 =?us-ascii?Q?R0xsdOam/xj92LqGKGxQA65/dK/OcPf9tlQHgYyqUvQkM+wEJsIhbAymhpjJ?=
 =?us-ascii?Q?AOuIw0qQ8BkJ5De0eiytKoptiugDxqMjIQerkQ7oK/9SsKYBEaeAiPTk2EyA?=
 =?us-ascii?Q?kzdF3eZgk3LnpXAk+TWHZqfybidO7HlpCmF3IH9BwA3oTMp5tOLmemNK8vsf?=
 =?us-ascii?Q?yUqoIZEp4LhcqlWhYpVEKAlhd7vxFz9lT0e6qoMxEADmmezaC/Ai2uv49DWT?=
 =?us-ascii?Q?gi0bdWel2ayQFbdorE3DPhhNS1WYOgc2j3zZloZsNQ5fVjN7Ibg4NJRjR905?=
 =?us-ascii?Q?rrr8n6laIQHjhlT86yn+cIzM+53c14gUmwjsajbiO5qiYRq/IEqI4DASM8n8?=
 =?us-ascii?Q?l7FqJb+UqDrZgqgeqdS3vWKPyYr1dQL/z7WV9zP8SRpQAiRGCveWGtdNtbAG?=
 =?us-ascii?Q?nzzyiJSgwhKRecLqpUh+uiLnA4F08WC1N+MrpfFAOmcPr2JIii/mHsDj0Y8j?=
 =?us-ascii?Q?JZ6TJ2sUkqG7t17cd/VFeJ+SyOfcXYKwcdZP9zV2TR7VVukDMR3o/y+5Vdo6?=
 =?us-ascii?Q?Qaux5hG4/FoTR6i5Sv+iBFy8mJjJzcfKFCtnY9m8Ab8/26RkG6LwkxwPLJsD?=
 =?us-ascii?Q?Qw2X99LiizHvlC1EiitvvUhgbkUbpV7fzGkbL9CH?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d0a42932-a0c0-49d5-e717-08dc7f53a47f
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 May 2024 20:20:40.0113
 (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: UoA2KSX3nf33WodX794dopRggzDDWTUH8NUIYLwoX1TIaVvEm23JGDfPOtb5NmC3sw/CrCvovtLgCLylHuwd4w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM9PR04MB8972

Convert dt-bindings pwm-fsl-ftm.txt to yaml format.

Additional change during convert:
- "big-endian" is not required property.
- Add "sleep" to pinctrl-names.
- Change pinctrl-NNN to pinctrl-0 and pinctrl-1.
- Remove label "pwm0" in example.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

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

 .../bindings/pwm/fsl,vf610-ftm-pwm.yaml       | 92 +++++++++++++++++++
 .../devicetree/bindings/pwm/pwm-fsl-ftm.txt   | 55 -----------
 2 files changed, 92 insertions(+), 55 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/pwm/fsl,vf610-ftm-pwm.yaml
 delete mode 100644 Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt

diff --git a/Documentation/devicetree/bindings/pwm/fsl,vf610-ftm-pwm.yaml b/Documentation/devicetree/bindings/pwm/fsl,vf610-ftm-pwm.yaml
new file mode 100644
index 0000000000000..7f9f72d95e7a3
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/fsl,vf610-ftm-pwm.yaml
@@ -0,0 +1,92 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/fsl,vf610-ftm-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale FlexTimer Module (FTM) PWM controller
+
+description: |
+  The same FTM PWM device can have a different endianness on different SoCs. The
+  device tree provides a property to describing this so that an operating system
+  device driver can handle all variants of the device. Refer to the table below
+  for the endianness of the FTM PWM block as integrated into the existing SoCs:
+
+  SoC     | FTM-PWM endianness
+  --------+-------------------
+  Vybrid  | LE
+  LS1     | BE
+  LS2     | LE
+
+  Please see ../regmap/regmap.txt for more detail about how to specify endian
+  modes in device tree.
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    enum:
+      - fsl,vf610-ftm-pwm
+      - fsl,imx8qm-ftm-pwm
+
+  reg:
+    maxItems: 1
+
+  "#pwm-cells":
+    const: 3
+
+  clocks:
+    minItems: 4
+    maxItems: 4
+
+  clock-names:
+    items:
+      - const: ftm_sys
+      - const: ftm_ext
+      - const: ftm_fix
+      - const: ftm_cnt_clk_en
+
+  pinctrl-0: true
+  pinctrl-1: true
+
+  pinctrl-names:
+    minItems: 1
+    items:
+      - const: default
+      - const: sleep
+
+  big-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Boolean property, required if the FTM PWM registers use a big-
+      endian rather than little-endian layout.
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+
+allOf:
+  - $ref: pwm.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/vf610-clock.h>
+
+    pwm@40038000 {
+        compatible = "fsl,vf610-ftm-pwm";
+        reg = <0x40038000 0x1000>;
+        #pwm-cells = <3>;
+        clocks = <&clks VF610_CLK_FTM0>,
+                 <&clks VF610_CLK_FTM0_EXT_SEL>,
+                 <&clks VF610_CLK_FTM0_FIX_SEL>,
+                 <&clks VF610_CLK_FTM0_EXT_FIX_EN>;
+        clock-names = "ftm_sys", "ftm_ext", "ftm_fix", "ftm_cnt_clk_en";
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_pwm0_1>;
+        big-endian;
+    };
diff --git a/Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt b/Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt
deleted file mode 100644
index 36532cd5ab25b..0000000000000
--- a/Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-Freescale FlexTimer Module (FTM) PWM controller
-
-The same FTM PWM device can have a different endianness on different SoCs. The
-device tree provides a property to describing this so that an operating system
-device driver can handle all variants of the device. Refer to the table below
-for the endianness of the FTM PWM block as integrated into the existing SoCs:
-
-	SoC     | FTM-PWM endianness
-	--------+-------------------
-	Vybrid  | LE
-	LS1     | BE
-	LS2     | LE
-
-Please see ../regmap/regmap.txt for more detail about how to specify endian
-modes in device tree.
-
-
-Required properties:
-- compatible : should be "fsl,<soc>-ftm-pwm" and one of the following
-   compatible strings:
-  - "fsl,vf610-ftm-pwm" for PWM compatible with the one integrated on VF610
-  - "fsl,imx8qm-ftm-pwm" for PWM compatible with the one integrated on i.MX8QM
-- reg: Physical base address and length of the controller's registers
-- #pwm-cells: Should be 3. See pwm.yaml in this directory for a description of
-  the cells format.
-- clock-names: Should include the following module clock source entries:
-    "ftm_sys" (module clock, also can be used as counter clock),
-    "ftm_ext" (external counter clock),
-    "ftm_fix" (fixed counter clock),
-    "ftm_cnt_clk_en" (external and fixed counter clock enable/disable).
-- clocks: Must contain a phandle and clock specifier for each entry in
-  clock-names, please see clock/clock-bindings.txt for details of the property
-  values.
-- pinctrl-names: Must contain a "default" entry.
-- pinctrl-NNN: One property must exist for each entry in pinctrl-names.
-  See pinctrl/pinctrl-bindings.txt for details of the property values.
-- big-endian: Boolean property, required if the FTM PWM registers use a big-
-  endian rather than little-endian layout.
-
-Example:
-
-pwm0: pwm@40038000 {
-		compatible = "fsl,vf610-ftm-pwm";
-		reg = <0x40038000 0x1000>;
-		#pwm-cells = <3>;
-		clock-names = "ftm_sys", "ftm_ext",
-				"ftm_fix", "ftm_cnt_clk_en";
-		clocks = <&clks VF610_CLK_FTM0>,
-			<&clks VF610_CLK_FTM0_EXT_SEL>,
-			<&clks VF610_CLK_FTM0_FIX_SEL>,
-			<&clks VF610_CLK_FTM0_EXT_FIX_EN>;
-		pinctrl-names = "default";
-		pinctrl-0 = <&pinctrl_pwm0_1>;
-		big-endian;
-};
-- 
2.34.1