Received-SPF: pass (google.com: domain of linux-kernel+bounces-203075-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Frank Li <Frank.Li@nxp.com>
To: krzk@kernel.org
Cc: Frank.Li@nxp.com,
	conor+dt@kernel.org,
	devicetree@vger.kernel.org,
	imx@lists.linux.dev,
	krzk+dt@kernel.org,
	linux-kernel@vger.kernel.org,
	linux-mmc@vger.kernel.org,
	robh@kernel.org,
	ulf.hansson@linaro.org
Subject: [PATCH v3 1/1] dt-bindings: mmc: Convert fsl-esdhc.txt to yaml
Date: Wed,  5 Jun 2024 14:50:46 -0400
Message-Id: <20240605185046.1057877-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?Ea58YeplY0xgHHaT2ch7slKkmHr8+k8c+yNG/TVegpA56HGCdTRzmaPk336Z?=
 =?us-ascii?Q?0Fgp5is3M0Kjnl9M2zphCk1CKkHh5UuX5F63WbAOgCqQwr6D/hYKLb5zTv/8?=
 =?us-ascii?Q?IEjAgP2LV2f4cZFYeYSogIKsjXb9bYB3be+i8N/0gBQaHILJK68tJngYpCHz?=
 =?us-ascii?Q?Mjt2bNcf2BC8oDSGvOBVBSrzCFCRd5+XWiTJfCog2YG4raET5km+0lvD+oRI?=
 =?us-ascii?Q?y+R9PAhdnYbhfJ2RnTmA2mFmtXfN+pBFLBCwMEPDlzdcg7dCpGTDKwft9QpN?=
 =?us-ascii?Q?QeIDPEdyOYKDDsAIWVCXYUYZwz9XcRMkV3OJikR1fqP44ftw0CCigz0ClHHf?=
 =?us-ascii?Q?sNCxI3j6xtOmTf58XjfGE+uhkTXCv7qjJhVfWG59IA+1J7F7aiB++BRTppxu?=
 =?us-ascii?Q?wXEY+tZ2rHOVDwfMjhLWIlY6x+4FmOAUagdJsawhogyDrpHF+8b3MthRBxdl?=
 =?us-ascii?Q?bVeMSotBVW1O6LjH7+PdpRnMyojLPZ6+1PHeqdwpnG07T2Jy9r/+pWE2LWj1?=
 =?us-ascii?Q?BrMScPXbp+3dNmg5TGEfpV8Q5F9VEfKkEXhEaCdib8wKmYpyo2+x2Dn8nhis?=
 =?us-ascii?Q?BjU78TjeIrqE3FWPeSOAumMTOCkE17WIcy7xtcvuXJ7IWCv+XfESKf5TrfIT?=
 =?us-ascii?Q?8lbutOV4XdujDd3h4j7ykY6W9Q6VsZ6XrfAyS2cR3DMGszFHPrjzIaKAJnjZ?=
 =?us-ascii?Q?2SgpwvviuK9/sOUVZT8HeRla61bew0HCmcqscplrpowRsSN/D3grbgQL39uK?=
 =?us-ascii?Q?r05HElcu6TqXn8fy/p2D255u9iZnL6bFgT0+3ebAHlaqXCcUTwDN8jT3oWag?=
 =?us-ascii?Q?dDs1pEIMsYPpW8gJYxueXHsNwYBrb8vDhnzR884/ZPAjDEsly4VPG3LB1sn1?=
 =?us-ascii?Q?aEUFc0Ah4UUfEzR+0IlwtIKkFTUs9VZ7Tx2OPx3LDe7kDLtVeVvbxrJgUDe8?=
 =?us-ascii?Q?YzRpOYE/AzszuCn84+e6hdUcQULbk41zwJ6U6CzL/rKJ8Ev4IjyfEQSTAUey?=
 =?us-ascii?Q?oUBL4hTNBO08JT8Lf6ScwkMUd5BB6tcoNmQIo88MnljmcR4LHm8jt0y1sFGt?=
 =?us-ascii?Q?SUBpzjy2MkwqlnqPGZrBOSXZ6bwcVgLM8JJs5wyzagHWln9d77XTVcw5gdk5?=
 =?us-ascii?Q?phuKAnls/VpCv/akVAUINN7GgnhW/hTxTzl61FQIrUY8opJqKncvjIOt7lvW?=
 =?us-ascii?Q?ynWSLWKS1UuRQamIyD49wYd2zM5vIsIWB/F9eVAcRcIiv543RvQ2XS5lfWEw?=
 =?us-ascii?Q?rV91KZkBtHY38jIYXGbVQ6q7yyLQq0fWw9dKelol5eedhT5nk27tRv6QYudX?=
 =?us-ascii?Q?jbcwKsul5f0l2Bfffh8zPNlKyPAeRmgj1EWVfESbdEdkdIcHkqV9NJyP0FqR?=
 =?us-ascii?Q?1z1dwIVRu17CRo+8/05YYjsYSqC5mSf3RE9HTCFFqqeQO0v7pfw1sa3fiOhC?=
 =?us-ascii?Q?jTTCcszfPNTfOGPQkTA72CKdKJBT9BwfTeH55G3TQw7Heh26Os7G//VJAN3E?=
 =?us-ascii?Q?nf4DobPVfwGw5m13eOF7HuuSSi3EpAwAzK+TUlFdNc3A4KDOq01p+mxnCphg?=
 =?us-ascii?Q?hL0BJ7cy0VZAuA/VUTJatUwSg0qtWXogxW2e19nw?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 596b7cfe-113f-47ed-ebd9-08dc8590729d
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jun 2024 18:51:02.6124
 (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: ikbRjn7jATn5I4LSB1u0PtOZtWctO79CqunReKxcSVcK5R2qDsf5QHw/Ntt/SLv5QKkWoMFmPsfdFl45wwutBw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GV1PR04MB10749

Convert layerscape fsl-esdhc binding doc from txt to yaml format.

Addtional change during convert:
- Deprecate "sdhci,wp-inverted", "sdhci,1-bit-only".
- Add "reg" and "interrupts" property.
- Change example "sdhci@2e000" to "mmc@2e000".
- Compatible string require fsl,<chip>-esdhc followed by fsl,esdhc to match
most existed dts file.
- Set clock-frequency to 100mhz in example.

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

Notes:
    Change from v2 to v3
    - add minItems and maxItems for voltage-ranges
    
    Change from v1 to v2
    - use filename fsl,esdhc.yaml
    - Add clock-frequency to required
    - change clock-frequency to 100mhz in example
    
    pass dt_binding_check
    make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j8  dt_binding_check DT_SCHEMA_FILES=fsl,esdhc.yaml
      SCHEMA  Documentation/devicetree/bindings/processed-schema.json
      CHKDT   Documentation/devicetree/bindings
      LINT    Documentation/devicetree/bindings
      DTEX    Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.example.dts
      DTC_CHK Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.example.dtb

 .../devicetree/bindings/mmc/fsl,esdhc.yaml    | 101 ++++++++++++++++++
 .../devicetree/bindings/mmc/fsl-esdhc.txt     |  52 ---------
 2 files changed, 101 insertions(+), 52 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml
 delete mode 100644 Documentation/devicetree/bindings/mmc/fsl-esdhc.txt

diff --git a/Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml b/Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml
new file mode 100644
index 0000000000000..9170456ebf5a2
--- /dev/null
+++ b/Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml
@@ -0,0 +1,101 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mmc/fsl,esdhc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale Enhanced Secure Digital Host Controller (eSDHC)
+
+description:
+  The Enhanced Secure Digital Host Controller provides an interface
+  for MMC, SD, and SDIO types of memory cards.
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - fsl,mpc8536-esdhc
+          - fsl,mpc8378-esdhc
+          - fsl,p2020-esdhc
+          - fsl,p4080-esdhc
+          - fsl,t1040-esdhc
+          - fsl,t4240-esdhc
+          - fsl,ls1012a-esdhc
+          - fsl,ls1028a-esdhc
+          - fsl,ls1088a-esdhc
+          - fsl,ls1043a-esdhc
+          - fsl,ls1046a-esdhc
+          - fsl,ls2080a-esdhc
+      - const: fsl,esdhc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clock-frequency:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: specifies eSDHC base clock frequency.
+
+  sdhci,wp-inverted:
+    $ref: /schemas/types.yaml#/definitions/flag
+    deprecated: true
+    description:
+      specifies that eSDHC controller reports
+      inverted write-protect state; New devices should use the generic
+      "wp-inverted" property.
+
+  sdhci,1-bit-only:
+    $ref: /schemas/types.yaml#/definitions/flag
+    deprecated: true
+    description:
+      specifies that a controller can only handle
+      1-bit data transfers. New devices should use the generic
+      "bus-width = <1>" property.
+
+  sdhci,auto-cmd12:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      specifies that a controller can only handle auto CMD12.
+
+  voltage-ranges:
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    items:
+      items:
+        - description: specifies minimum slot voltage (mV).
+        - description: specifies maximum slot voltage (mV).
+    minItems: 1
+    maxItems: 8
+
+  little-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      If the host controller is little-endian mode, specify
+      this property. The default endian mode is big-endian.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clock-frequency
+
+allOf:
+  - $ref: sdhci-common.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    mmc@2e000 {
+        compatible = "fsl,mpc8378-esdhc", "fsl,esdhc";
+        reg = <0x2e000 0x1000>;
+        interrupts = <42 0x8>;
+        interrupt-parent = <&ipic>;
+        /* Filled in by U-Boot */
+        clock-frequency = <100000000>;
+        voltage-ranges = <3300 3300>;
+    };
diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
deleted file mode 100644
index edb8cadb95412..0000000000000
--- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-* Freescale Enhanced Secure Digital Host Controller (eSDHC)
-
-The Enhanced Secure Digital Host Controller provides an interface
-for MMC, SD, and SDIO types of memory cards.
-
-This file documents differences between the core properties described
-by mmc.txt and the properties used by the sdhci-esdhc driver.
-
-Required properties:
-  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
-    Possible compatibles for PowerPC:
-	"fsl,mpc8536-esdhc"
-	"fsl,mpc8378-esdhc"
-	"fsl,p2020-esdhc"
-	"fsl,p4080-esdhc"
-	"fsl,t1040-esdhc"
-	"fsl,t4240-esdhc"
-    Possible compatibles for ARM:
-	"fsl,ls1012a-esdhc"
-	"fsl,ls1028a-esdhc"
-	"fsl,ls1088a-esdhc"
-	"fsl,ls1043a-esdhc"
-	"fsl,ls1046a-esdhc"
-	"fsl,ls2080a-esdhc"
-  - clock-frequency : specifies eSDHC base clock frequency.
-
-Optional properties:
-  - sdhci,wp-inverted : specifies that eSDHC controller reports
-    inverted write-protect state; New devices should use the generic
-    "wp-inverted" property.
-  - sdhci,1-bit-only : specifies that a controller can only handle
-    1-bit data transfers. New devices should use the generic
-    "bus-width = <1>" property.
-  - sdhci,auto-cmd12: specifies that a controller can only handle auto
-    CMD12.
-  - voltage-ranges : two cells are required, first cell specifies minimum
-    slot voltage (mV), second cell specifies maximum slot voltage (mV).
-    Several ranges could be specified.
-  - little-endian : If the host controller is little-endian mode, specify
-    this property. The default endian mode is big-endian.
-
-Example:
-
-sdhci@2e000 {
-	compatible = "fsl,mpc8378-esdhc", "fsl,esdhc";
-	reg = <0x2e000 0x1000>;
-	interrupts = <42 0x8>;
-	interrupt-parent = <&ipic>;
-	/* Filled in by U-Boot */
-	clock-frequency = <0>;
-	voltage-ranges = <3300 3300>;
-};
-- 
2.34.1