Received-SPF: pass (google.com: domain of linux-kernel+bounces-184163-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: Frank Li <Frank.Li@nxp.com>
To: Vinod Koul <vkoul@kernel.org>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	dmaengine@vger.kernel.org (open list:DMA GENERIC OFFLOAD ENGINE 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: fsl-qdma: Convert to yaml format
Date: Mon, 20 May 2024 16:39:06 -0400
Message-Id: <20240520203907.749347-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?Ab5s7F1rwXOQ+L/BdTO6c9zuoB6aFgTw5+78ZVr2S6hXIimvsAmlIpk3mbQe?=
 =?us-ascii?Q?oFqgGUBPjjErumKuruwK/W7swG5e6Ttx3m82HvkphYXiEHcG67++dQ2ZtWrM?=
 =?us-ascii?Q?eutz7RSvUpzgwK0ks9L3vsWhzUfOMkGvDLZPSG769G70mnpkr6X612P9wtSQ?=
 =?us-ascii?Q?genmyzY1aHf2PGf/lRF/j7LP4qurhCA5Gsi2M0E1AtyVn2T2k2rGrri2P9fR?=
 =?us-ascii?Q?U8RSk3EvUgxH8ECNjWqv6W16DX/i08wZ2Yd1w3Tx8yofVJVD1wSEeJ+jkSMH?=
 =?us-ascii?Q?KPwGfhl5SKT72DiNEB14zJf/CtNatL060KJkmDh1hEgxGvpwcOw8vcwunNIG?=
 =?us-ascii?Q?ERPYiDvAjaHB6LvPZrapFPVm9BBxg2n8WkK62bWsGePtdEStAxsatsondPCd?=
 =?us-ascii?Q?mcnV3kTBMHasnbdRRXDpRJhnjR6iO3USiYEMjFRT35hHlox+T604NUkg6yLh?=
 =?us-ascii?Q?hFEeFMSsHiqZjeAdNm1sW5wwr7x9T/xNaEhwgv4lHGxMBTIQ3Xckn0PSCGhy?=
 =?us-ascii?Q?RUon+M++3YCJNIrK2eIfmB6YV8p6igJRrJ99Lzy1tEEc2NfKnCO0jHTzlduI?=
 =?us-ascii?Q?GZ6E112hvbcdsV15m2B+St7VwMbXcOty2WMj4Oqn7Sr8UnrV7LO8Im3nYQkJ?=
 =?us-ascii?Q?J9qMvrbePn7tAL6ezvX0f68vMuiK6ZkR8cWHszfFqJckUyPjyJCj7OtqBmm8?=
 =?us-ascii?Q?R8nK0RnBBiYqFeoohg0Nu2aHuATd5UA+Jp4u1TrfwgD0uHJ7DL+N8yX5RJcy?=
 =?us-ascii?Q?Dzu88PpFZEbPrxkCLMEJeQoE3n8jnMWHiNNZuulDoJNNEBoJ6aNjFdW1Iztv?=
 =?us-ascii?Q?qqNc+jD4ufa/W3UAGIgRYWQMT3fv4WYye4jyp3NHxC6G2JVRh3NnoQMXu774?=
 =?us-ascii?Q?dH8eP10vf6hjK+pO0xG9CQn+k5fHlBqK0x5yQxqMkVrKegdRy4/3a2Uz/50d?=
 =?us-ascii?Q?+hQuQDf05rL8gmBy1u/xsxXNisP/G+Y32e4SSwr3WkjpRCMLx82X2Ntu7kSp?=
 =?us-ascii?Q?z3PqpmJLzdqLgq3THbWT8AVbXFc3TI6ds2cs+8E25vGw1xZHehxlz1v/YArU?=
 =?us-ascii?Q?Fa8Hbs6b+x3ejefBqOnM6x29+Hcwphq0mv0V+1ATgkhzAkzMaXFxNQRInM+w?=
 =?us-ascii?Q?z6TKnpuWdOO8Nujnd10JBV92dJTe1dXaT1EEMyPc5SP2jrEPWFT8F3tJKhMv?=
 =?us-ascii?Q?gkehtIhQUpUspl6bHVd0sbqbcNMSNlr52dInWVWHntUn2mf024EL14d91Aaq?=
 =?us-ascii?Q?zKm5AAQ88t8AGGTYxSrrMIWUUpiuQd4IR81XXFfmejLGvCb70KaPVr4Vzz5k?=
 =?us-ascii?Q?y0rOJLQ2oG0IgNLVUsPn0WRV83PxcIhUEAHA/mQX82scbV7uGSvUvKGA1Sir?=
 =?us-ascii?Q?VqddCXDN9CCi0TV9Z86s6TxelZnLwEUtGS2bDNAgGKL02Pj7vKnrrivmUzMI?=
 =?us-ascii?Q?a7AdZDZG2hnP6iQMOvQyO8Cfkz9Ti5gFsy8h8e0mgwdBB6Y3wYqW8XtSBVWe?=
 =?us-ascii?Q?hVTSnWPSjit2KCOTsUMaQxa2suF5gIa7chgrrzSa1oMTPDk6EYwIlvQf12sU?=
 =?us-ascii?Q?oXuXsXEEuRyIs9+nyLNghO6ssW8nlAsRPZatLNrq?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8578412c-526f-4175-d628-08dc790cef27
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 May 2024 20:39:24.0103
 (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: NCmLPXsa21WLwt6FG7/6NotT1CuJltOw95p4leHbC9yeRqu0TGNe1OCXguUtN6p/aEXzPbjornJ4kxjzMMhkWQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PR3PR04MB7385

Convert binding doc from txt to yaml.

Re-order interrupt-names to align example.
Add #dma-cell in example.
Change 'reg' in example to 32bit address.

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

Notes:
    Pass dt_binding_check:
    
    make dt_binding_check DT_SCHEMA_FILES=fsl-qdma.yaml
      SCHEMA  Documentation/devicetree/bindings/processed-schema.json
      CHKDT   Documentation/devicetree/bindings
      LINT    Documentation/devicetree/bindings
      DTEX    Documentation/devicetree/bindings/dma/fsl-qdma.example.dts
      DTC_CHK Documentation/devicetree/bindings/dma/fsl-qdma.example.dtb

 .../devicetree/bindings/dma/fsl-qdma.txt      |  58 ---------
 .../devicetree/bindings/dma/fsl-qdma.yaml     | 110 ++++++++++++++++++
 2 files changed, 110 insertions(+), 58 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/dma/fsl-qdma.txt
 create mode 100644 Documentation/devicetree/bindings/dma/fsl-qdma.yaml

diff --git a/Documentation/devicetree/bindings/dma/fsl-qdma.txt b/Documentation/devicetree/bindings/dma/fsl-qdma.txt
deleted file mode 100644
index da371c4d406ce..0000000000000
--- a/Documentation/devicetree/bindings/dma/fsl-qdma.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-NXP Layerscape SoC qDMA Controller
-==================================
-
-This device follows the generic DMA bindings defined in dma/dma.txt.
-
-Required properties:
-
-- compatible:		Must be one of
-			 "fsl,ls1021a-qdma": for LS1021A Board
-			 "fsl,ls1028a-qdma": for LS1028A Board
-			 "fsl,ls1043a-qdma": for ls1043A Board
-			 "fsl,ls1046a-qdma": for ls1046A Board
-- reg:			Should contain the register's base address and length.
-- interrupts:		Should contain a reference to the interrupt used by this
-			device.
-- interrupt-names:	Should contain interrupt names:
-			 "qdma-queue0": the block0 interrupt
-			 "qdma-queue1": the block1 interrupt
-			 "qdma-queue2": the block2 interrupt
-			 "qdma-queue3": the block3 interrupt
-			 "qdma-error":  the error interrupt
-- fsl,dma-queues:	Should contain number of queues supported.
-- dma-channels:	Number of DMA channels supported
-- block-number:	the virtual block number
-- block-offset:	the offset of different virtual block
-- status-sizes:	status queue size of per virtual block
-- queue-sizes:		command queue size of per virtual block, the size number
-			based on queues
-
-Optional properties:
-
-- dma-channels:		Number of DMA channels supported by the controller.
-- big-endian:		If present registers and hardware scatter/gather descriptors
-			of the qDMA are implemented in big endian mode, otherwise in little
-			mode.
-
-Examples:
-
-	qdma: dma-controller@8390000 {
-			compatible = "fsl,ls1021a-qdma";
-			reg = <0x0 0x8388000 0x0 0x1000>, /* Controller regs */
-			      <0x0 0x8389000 0x0 0x1000>, /* Status regs */
-			      <0x0 0x838a000 0x0 0x2000>; /* Block regs */
-			interrupts = <GIC_SPI 185 IRQ_TYPE_LEVEL_HIGH>,
-				     <GIC_SPI 76 IRQ_TYPE_LEVEL_HIGH>,
-				     <GIC_SPI 77 IRQ_TYPE_LEVEL_HIGH>;
-			interrupt-names = "qdma-error",
-				"qdma-queue0", "qdma-queue1";
-			dma-channels = <8>;
-			block-number = <2>;
-			block-offset = <0x1000>;
-			fsl,dma-queues = <2>;
-			status-sizes = <64>;
-			queue-sizes = <64 64>;
-			big-endian;
-		};
-
-DMA clients must use the format described in dma/dma.txt file.
diff --git a/Documentation/devicetree/bindings/dma/fsl-qdma.yaml b/Documentation/devicetree/bindings/dma/fsl-qdma.yaml
new file mode 100644
index 0000000000000..e6d24670ff893
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/fsl-qdma.yaml
@@ -0,0 +1,110 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/dma/fsl-qdma.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP Layerscape SoC qDMA Controller
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    enum:
+      - fsl,ls1021a-qdma
+      - fsl,ls1028a-qdma
+      - fsl,ls1043a-qdma
+      - fsl,ls1046a-qdma
+
+  reg:
+    items:
+      - description: Controller regs
+      - description: Status regs
+      - description: Block regs
+
+  interrupts:
+    minItems: 2
+    maxItems: 5
+
+  interrupt-names:
+    minItems: 2
+    items:
+      - const: qdma-error
+      - const: qdma-queue0
+      - const: qdma-queue1
+      - const: qdma-queue2
+      - const: qdma-queue3
+
+  dma-channels:
+    minItems: 1
+    maxItems: 64
+
+  fsl,dma-queues:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Should contain number of queues supported.
+
+  block-number:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: the virtual block number
+
+  block-offset:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: the offset of different virtual block
+
+  status-sizes:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: status queue size of per virtual block
+
+  queue-sizes:
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    description:
+      command queue size of per virtual block, the size number
+      based on queues
+
+  big-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      If present registers and hardware scatter/gather descriptors
+      of the qDMA are implemented in big endian mode, otherwise in little
+      mode.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+  - fsl,dma-queues
+  - block-number
+  - block-offset
+  - status-sizes
+  - queue-sizes
+
+unevaluatedProperties: false
+
+allOf:
+  - $ref: dma-controller.yaml#
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    dma-controller@8390000 {
+        compatible = "fsl,ls1021a-qdma";
+        reg = <0x8388000 0x1000>, /* Controller regs */
+              <0x8389000 0x1000>, /* Status regs */
+              <0x838a000 0x2000>; /* Block regs */
+        interrupts = <GIC_SPI 185 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 76 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 77 IRQ_TYPE_LEVEL_HIGH>;
+        interrupt-names = "qdma-error", "qdma-queue0", "qdma-queue1";
+        #dma-cells = <1>;
+        dma-channels = <8>;
+        block-number = <2>;
+        block-offset = <0x1000>;
+        status-sizes = <64>;
+        queue-sizes = <64 64>;
+        big-endian;
+        fsl,dma-queues = <2>;
+    };
+
-- 
2.34.1