Received-SPF: pass (google.com: domain of linux-kernel+bounces-213426-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>
Date: Thu, 13 Jun 2024 10:32:06 -0400
Subject: [PATCH v5 2/3] dt-bindings: mmc: Convert fsl-esdhc.txt to yaml
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240613-ls_waring_esdhc-v5-2-36644e2fe21c@nxp.com>
References: <20240613-ls_waring_esdhc-v5-0-36644e2fe21c@nxp.com>
In-Reply-To: <20240613-ls_waring_esdhc-v5-0-36644e2fe21c@nxp.com>
To: Ulf Hansson <ulf.hansson@linaro.org>, Rob Herring <robh@kernel.org>, 
 Krzysztof Kozlowski <krzk+dt@kernel.org>, 
 Conor Dooley <conor+dt@kernel.org>, Shawn Guo <shawnguo@kernel.org>
Cc: linux-mmc@vger.kernel.org, devicetree@vger.kernel.org, 
 linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, 
 imx@lists.linux.dev, Frank Li <Frank.Li@nxp.com>, 
 Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?SmNSQ0I0V05DS2plTVUrSE1veTFVZWQrUndrd2E0TE85Nis3QlhFQ3RlRkIw?=
 =?utf-8?B?VnlYNklTQzF4ekRxaUcyMnNwZGxyL0dGaGhLTEN6WmVLUjUzN2R2d3ZjZlZq?=
 =?utf-8?B?ekpTT2tIRTNTL2IrZEcrU0UzZS8raDM0a0xDN2Y3UmkzOEI5UEJUVGFvRmox?=
 =?utf-8?B?RUwwNVZLU2hNRjUvNzNZcHM1MkRHdnk4Y1NsSUczWW9CZnpEdFhiRFdCNlF0?=
 =?utf-8?B?bjd6bFdHdXlQenF5bGFtTURpSVFCUGZpeUhqUmx5clkwRExFNEpOVDRJbjgr?=
 =?utf-8?B?aE4wcDFWblN5OTRSN2htVVMrZGliU2daMEFmYzJiSTNCZ0hYVytHbVZCV2VI?=
 =?utf-8?B?T1Z4aU50UXdmWXI0dStHVGRHWkc2TXRVbml2NHFJejUrOWR2L1JNMU5ZbkEz?=
 =?utf-8?B?MlBMRDY4UHZyWXJSNjM2WXB2eVkvVjZsUU1sZnQzQmM1b3FCSjVxSks1N0VZ?=
 =?utf-8?B?eVM2aHFWMGVUakFpVEVFZDdNNDh1aEJMMGhSamVtbys5YlVBMk5iaysrcWEr?=
 =?utf-8?B?MFFjbmVYK04weHFwSmhPbnZmTE9xRjFycDI5Zy8rNk1wRGhqTUExR1hUNTRo?=
 =?utf-8?B?V3NmTEozM1o5N1M4dFU0MmJxMitUd2NaUEVHMHFQMklzVitNUjhzZ2dYaGRQ?=
 =?utf-8?B?eGVkWGkvbmtzT0tXdkdBVnR4bW53RHJzODFoSnh1NGt1Wm5JLzN6c0RlU0pp?=
 =?utf-8?B?S25DUHFTbEQ3M2wxbEUzZEhVQWlqOGhZRm56eUIzSVhYdnlsU2NaM2RmZFJ1?=
 =?utf-8?B?WWYvZVVJeUZMR0ZDaEhEQnRKS1hFdTR4cmIwaXQzREsrK2lLYmlQWFB3YzRq?=
 =?utf-8?B?M2xCYTJqMjk4RkRCaXROeUxEV0tRT0EzQ1Q1dDRtT1JQbWk4RHBBcUl1MmFr?=
 =?utf-8?B?SnBJNy9WZ0hjRFlsSGxKVlFEclBKK1NqcUtKbmtyRXZmUG9ldnJlaVZES2Vn?=
 =?utf-8?B?eHlmU0J4RzloOEREOVg2dlRvTXpPNDhMQVFrL2YyZ3JRSEZ1cmVxWmxhVVZM?=
 =?utf-8?B?bm1XYUF0TzB1bUJxZlgzSk1PRlNvVC9tOW4xeWJpdlNhcXh0Q052eHNEZnVi?=
 =?utf-8?B?Q1dSN04vZnVoMzREQXFKdEpINnpZcGtaU21CRWNEZXRGcnZnMUk1ei9Ceng3?=
 =?utf-8?B?L21Za3g2TmJ1WEFCdVphYWl4LzZtb2IxOWRhbnh0Y2RpdXpFQmwrdGVTT2h2?=
 =?utf-8?B?ZlFpVitnRzd0c1ZyejJuQ2xTbkF3RE9pWXhJeFR3V1R0dXo2N3JTSEcvaUlm?=
 =?utf-8?B?S0ZTQjZZN2tyYnNCZk9jMkt6WDd3RVc5TUxpRE8vUWJ2THhYNGtVeHJlMlJk?=
 =?utf-8?B?RjMxbVVYUmd4ZDlkN3JNWERzd3JjWnZOWGhHQXU5WG9yeGJ5bk1wRjVLS2N2?=
 =?utf-8?B?SkxJOS83U2ZKc2d4VlNXU3VSMzFSdytmY3JxU2xvT0o0QlFFbTI3UzdRT2Yy?=
 =?utf-8?B?cW15MnN4ZGxpTWhUcHhlWGhUcEQ5enBkY0pFRndhbjBPNVljMDNpZ2ZMbGc3?=
 =?utf-8?B?NU95L2p0R1NDK0dnYUp0QW1Od0xGWGY0WmhGaTgybnVMZWlHdHVTSEFXYnUy?=
 =?utf-8?B?Mlk1RmxFTk1STks4a05ZMU9LN05ZanVZUzluRnVSMk9UM2lYUWROUEVuRUdz?=
 =?utf-8?B?T21EVW9GcEYxZ1o5eFcwVFFoOURRZ0lqTlFUUGxzaW5jaDMxQjhEUVI2MGdo?=
 =?utf-8?B?WlN3YjcwcmVXYWZaTmpDVDBBNXJLc0JJcXY3U1ROSXlKa3YwUmE0MDk5MXBo?=
 =?utf-8?B?OTlTVzBGcDZVY1NnclNtR2hvN3FKWFBhc1ROU1VZcGhSRmUrSkUwQmY1Um5B?=
 =?utf-8?B?N3JSRFZwcnFEdlRqNVRTcVVINGNHam9sUW9qVUZaWjVHU0tkYStVSUkyVGJ3?=
 =?utf-8?B?N2FNU2xDVmVNcm5KM2JYZ0E3UUpobTFPZjhTa3Y5YWJrRXh3SXBPU0pVVkg4?=
 =?utf-8?B?bGJrN0RqNTg5Um1NNkhLeFFKZEtwRUxlb0xWQW00VlNrTTdvbHV4elpWNE9h?=
 =?utf-8?B?Rkt3RHBLSCt4Q1BCbDM0UDlhc20xL1J1VngxTTRwOWNhbHZqcFBSeGQ4dWcw?=
 =?utf-8?B?U092WU9BaGd5Mk9ORVFPOVpOa0dVaDBvRVJtQkRyZmR3SXFic2JCNmtlUGlL?=
 =?utf-8?Q?t1X1VGJmmvTWHTZBcW+c9ABXC?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9b5b6c5e-916c-416d-ac1e-08dc8bb5a90b
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Jun 2024 14:32:32.2353
 (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: A9CIPwo0p98HQRTcByjCU/34o7GdXU5kziOApPFyr34ecig6NPFg89aeDJLziUiQauKwoXpzoKujeWlmXh237w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8256

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.
- clock-frequency is not required now.
- Allow dma-coherence
- Add clocks

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
Change from v4 to v5
    - Add Krzysztof Kozlowski's review tag
Change from v3 to v4
    - Remove clock-frequency from required
    - Add dma-coherence
    - Add clocks
    - Not add Krzysztof Kozlowski review tag because some additional change.

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         | 105 +++++++++++++++++++++
 .../devicetree/bindings/mmc/fsl-esdhc.txt          |  52 ----------
 2 files changed, 105 insertions(+), 52 deletions(-)

diff --git a/Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml b/Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml
new file mode 100644
index 0000000000000..b86ffb53b18b5
--- /dev/null
+++ b/Documentation/devicetree/bindings/mmc/fsl,esdhc.yaml
@@ -0,0 +1,105 @@
+# 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
+
+  clocks:
+    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
+
+  dma-coherent: true
+
+  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
+
+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