Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31;
From:   Chancel Liu <chancel.liu@nxp.com>
To:     lgirdwood@gmail.com, broonie@kernel.org, robh+dt@kernel.org,
        krzysztof.kozlowski+dt@linaro.org, conor+dt@kernel.org,
        shawnguo@kernel.org, s.hauer@pengutronix.de, kernel@pengutronix.de,
        festevam@gmail.com, linux-imx@nxp.com, devicetree@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        alsa-devel@alsa-project.org
Cc:     Chancel Liu <chancel.liu@nxp.com>
Subject: [PATCH v2 3/3] ASoC: dt-bindings: fsl,mqs: Convert format to json-schema
Date:   Tue, 10 Oct 2023 21:38:38 +0800
Message-Id: <20231010133838.799714-4-chancel.liu@nxp.com>
In-Reply-To: <20231010133838.799714-1-chancel.liu@nxp.com>
References: <20231010133838.799714-1-chancel.liu@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?84QAUXvUdIoWIlF6p1iJfI1GWDvxh8QrQKH9BzNkxaPNOoqskMjTNW9aF7xE?=
 =?us-ascii?Q?ccFbqFo+KMtZqkX9cjoQBBtZHdSWn6WkKkExNGydj88EryUX2etDrway8kKN?=
 =?us-ascii?Q?wUdABIhoSebq1nAzXEyFtSmB5iUVH+aeITpkOVdA14w0CF5k5fYu+Z4Y41mX?=
 =?us-ascii?Q?dnrYeiG2FqvnXtDYI+OMDtC5uh2d9lzJA3f9tes3Q1Pu6PXGbk0QbjUwXm4V?=
 =?us-ascii?Q?v4UvVn4gBA1gmm8CNBlvdTxbgj1Bo4n/OCfoCga7rTpndjL+orM4DvjA4ye3?=
 =?us-ascii?Q?wJ5VL97OQQA+cXquoaUO0po0YWVaEjpk1lIGWrmfswDzNbfz4wl15GJDacIN?=
 =?us-ascii?Q?iN5qIAegAtNhLC4tnkwOSryI50IM91k+aBNoG01WvUB87zMRhpmj4XGk2Sp3?=
 =?us-ascii?Q?WxUDDEdebbzVuJZwHGdLurEja/bUktaO5LCFDSxq7OXANnkIHt7BTfLuDnIl?=
 =?us-ascii?Q?f8i1NVfgwOr5WgqXp3Iyn+qAz5V+nrthskfBwddcj6rw1wsHrSa8+6Hz1/TP?=
 =?us-ascii?Q?dKlznBgAuWmpLAtsqGb4vooEjaslm6vfL0/4kTS/GsXydyzh0mrO04RjV7+a?=
 =?us-ascii?Q?2OKNzVosJG8z7KfRQjdyDP84BKYEQQw9EcmCKuUU1+jDpfBdW/mn3fDsFdCn?=
 =?us-ascii?Q?ruv4zenqpEVlCp5l+AxWFu0HglVwX0YCO2ZDS32fW62xMNFY/P1CyquaGd+S?=
 =?us-ascii?Q?myL8eXltut74TRUdpjO4Iye7i5N11WHiA4qAXb4LVaV+GNamNGl+Fl62Bo8U?=
 =?us-ascii?Q?iA8ARRnNNmHrBOwAhLnQ1AytQAYHCrSX/w7+ZkIRCHQhNROfGuFs0WzSjlOU?=
 =?us-ascii?Q?D2f0MGvjwxkQsNB+VCc/ujRS2KKwmi7A72+YEdh1zkKlTCoyrw+vh2HkeQHU?=
 =?us-ascii?Q?X8urN84Dbn4hQQ30OQjsZznnNaaLfUkeVwpw699trhwP4VNzotNfkKvggwvb?=
 =?us-ascii?Q?N0jgYSUFsL/0OHgahe4NHfuiuZrz/azrRYp4aPt2RL3VAz6cB8dwoIJ94FSn?=
 =?us-ascii?Q?s78PNEHoWMM00X7MaqtofF/3TMaN/FeyYx2dkLCNwxizLH822NizNX+on/PS?=
 =?us-ascii?Q?HgxOSgZUiHYTzXK9kRpFdT057Ni2LqSGCL7x5WqDft1SS8SYFWydKvkT1RHQ?=
 =?us-ascii?Q?U8pDAg/SM4lSGU5SQMJ1h44Q0sx4i5AG3yU453QBqjnrq+g1DksuxwTqp7K+?=
 =?us-ascii?Q?ktgEisomVw173kqlTyrIwMMvkqrivZ7eKsxM030eDzJrwd/gt6Dixbyiu8vU?=
 =?us-ascii?Q?po+FjKPD3jC/cikcUwS1G6QQ+Za2amol/HuHTfCTL5kjDPP1iq7mt05nmMO+?=
 =?us-ascii?Q?uHUa9ElFCZbOQ4jMSP1jb5/t/W9e8kVtysBFYh7T/h3A85ou+w/qBXqfKqiS?=
 =?us-ascii?Q?zwIQCGG+I9MpMPqPcfaZv3m6/6e/8KG8v5BwYdtbOP/n27xr3252hyG+xsTv?=
 =?us-ascii?Q?hsnlJxNL8pkiJEwQkolI337TwBOe4A9xczbFr9eEKa3WnBMgl/ZTK8yDwKCe?=
 =?us-ascii?Q?QBITk424qL9HBhtdFZVNP9x3MYhpOcxGfhk+9T9YZGslTcbx8+4jIkH6FBgK?=
 =?us-ascii?Q?SYTAfkZoD2BS+Rv/GV+CPc0CVMfmnUI2OIqw//6Q?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 13b6ae65-6c5c-4f96-11cc-08dbc9964eb0
X-MS-Exchange-CrossTenant-AuthSource: DB9PR04MB9498.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Oct 2023 13:39:20.7007
 (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: Wdh87vkZqCKvKbb4/17S8M6Nz86yjOLxztbeJvxydduU4RnyzdKYXbk5Jn3jV8Ni33h24TfxTbvj5JxvBih6Eg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GVXPR04MB9831
X-Spam-Status: No, score=2.7 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on morse.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (morse.vger.email [0.0.0.0]); Tue, 10 Oct 2023 06:43:11 -0700 (PDT)
X-Spam-Level: **

Convert NXP medium quality sound (MQS) device tree binding
documentation to json-schema.

Signed-off-by: Chancel Liu <chancel.liu@nxp.com>
---
 .../devicetree/bindings/sound/fsl,mqs.txt     |  36 ------
 .../devicetree/bindings/sound/fsl,mqs.yaml    | 113 ++++++++++++++++++
 2 files changed, 113 insertions(+), 36 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/fsl,mqs.txt
 create mode 100644 Documentation/devicetree/bindings/sound/fsl,mqs.yaml

diff --git a/Documentation/devicetree/bindings/sound/fsl,mqs.txt b/Documentation/devicetree/bindings/sound/fsl,mqs.txt
deleted file mode 100644
index d66284b8bef2..000000000000
--- a/Documentation/devicetree/bindings/sound/fsl,mqs.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-fsl,mqs audio CODEC
-
-Required properties:
-  - compatible : Must contain one of "fsl,imx6sx-mqs", "fsl,codec-mqs"
-		"fsl,imx8qm-mqs", "fsl,imx8qxp-mqs", "fsl,imx93-mqs".
-  - clocks : A list of phandles + clock-specifiers, one for each entry in
-	     clock-names
-  - clock-names : "mclk" - must required.
-		  "core" - required if compatible is "fsl,imx8qm-mqs", it
-		           is for register access.
-  - gpr : A phandle of General Purpose Registers in IOMUX Controller.
-	  Required if compatible is "fsl,imx6sx-mqs".
-
-Required if compatible is "fsl,imx8qm-mqs":
-  - power-domains: A phandle of PM domain provider node.
-  - reg: Offset and length of the register set for the device.
-
-Example:
-
-mqs: mqs {
-	compatible = "fsl,imx6sx-mqs";
-	gpr = <&gpr>;
-	clocks = <&clks IMX6SX_CLK_SAI1>;
-	clock-names = "mclk";
-	status = "disabled";
-};
-
-mqs: mqs@59850000 {
-	compatible = "fsl,imx8qm-mqs";
-	reg = <0x59850000 0x10000>;
-	clocks = <&clk IMX8QM_AUD_MQS_IPG>,
-		 <&clk IMX8QM_AUD_MQS_HMCLK>;
-	clock-names = "core", "mclk";
-	power-domains = <&pd_mqs0>;
-	status = "disabled";
-};
diff --git a/Documentation/devicetree/bindings/sound/fsl,mqs.yaml b/Documentation/devicetree/bindings/sound/fsl,mqs.yaml
new file mode 100644
index 000000000000..c697b97f888e
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/fsl,mqs.yaml
@@ -0,0 +1,113 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/fsl,mqs.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP Medium Quality Sound (MQS)
+
+maintainers:
+  - Shengjiu Wang <shengjiu.wang@nxp.com>
+  - Chancel Liu <chancel.liu@nxp.com>
+
+description: |
+  Medium quality sound (MQS) is used to generate medium quality audio
+  via a standard GPIO in the pinmux, allowing the user to connect
+  stereo speakers or headphones to a power amplifier without an
+  additional DAC chip.
+
+properties:
+  compatible:
+    enum:
+      - fsl,imx6sx-mqs
+      - fsl,codec-mqs
+      - fsl,imx8qm-mqs
+      - fsl,imx8qxp-mqs
+      - fsl,imx93-mqs
+
+  clocks:
+    minItems: 1
+    maxItems: 2
+
+  clock-names:
+    minItems: 1
+    maxItems: 2
+
+  gpr:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: The phandle to the General Purpose Register (GPR) node
+
+  reg:
+    maxItems: 1
+
+  power-domains:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+required:
+  - compatible
+  - clocks
+  - clock-names
+
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+            const: fsl,imx8qm-mqs
+    then:
+      properties:
+        clocks:
+          items:
+            - description: Master clock
+            - description: Clock for register access
+        clock-names:
+          items:
+            - const: mclk
+            - const: core
+      required:
+        - reg
+        - power-domains
+    else:
+      properties:
+        clocks:
+          items:
+            - description: Master clock
+        clock-names:
+          items:
+            - const: mclk
+
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - fsl,imx6sx-mqs
+              - fsl,imx93-mqs
+    then:
+      required:
+        - gpr
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/imx6sx-clock.h>
+    mqs0: mqs {
+        compatible = "fsl,imx6sx-mqs";
+        gpr = <&gpr>;
+        clocks = <&clks IMX6SX_CLK_SAI1>;
+        clock-names = "mclk";
+    };
+
+  - |
+    #include <dt-bindings/firmware/imx/rsrc.h>
+    mqs1: mqs@59850000 {
+        compatible = "fsl,imx8qm-mqs";
+        reg = <0x59850000 0x10000>;
+        clocks = <&mqs0_lpcg 0>, <&mqs0_lpcg 1>;
+        clock-names = "mclk", "core";
+        power-domains = <&pd IMX_SC_R_MQS_0>;
+    };
-- 
2.25.1