Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Joy Zou <joy.zou@nxp.com>
To:     vkoul@kernel.org
Cc:     shengjiu.wang@nxp.com, robh+dt@kernel.org,
        krzysztof.kozlowski+dt@linaro.org, shawnguo@kernel.org,
        s.hauer@pengutronix.de, kernel@pengutronix.de, festevam@gmail.com,
        linux-imx@nxp.com, dmaengine@vger.kernel.org,
        devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-kernel@vger.kernel.org
Subject: [PATCH V2 1/2] bindings: fsl-imx-sdma: Document 'HDMI Audio' transfer
Date:   Tue, 24 May 2022 16:03:37 +0800
Message-Id: <20220524080337.1322240-1-joy.zou@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?31MxfXFila+yeTpcLypV+d6PaNNUjJfJNXkgiU0rv7Tvak3vFPjD8baSPHJR?=
 =?us-ascii?Q?KaRNgWXsoKOHp6NV1DrELAxA8kvLqpX3js7S8f8dQIekPTRrlfV9OLmvcVcW?=
 =?us-ascii?Q?KRpSH83BXBFiyUok/eh+JtNLzESCPr4tjE6/iNvblN5rxazv2p9EHa8Rnk/T?=
 =?us-ascii?Q?Cw+A9hMcqsfRleY95eWz6o2qsDo/BxpROjN2QJquSSUUSGIGZLfemqu+Clgi?=
 =?us-ascii?Q?QEFW+K359ZF8UU9DhLS8mP+ChUXP+Pf/KhMI9ucny1lesLSPLCAvej+xviS4?=
 =?us-ascii?Q?Yd71Rq9UOXDimvfjhI1Wzh9rA1fzWjOh0qAwZiW+BACMyd9Q06sQuwMOpTAj?=
 =?us-ascii?Q?OlEZNlVq4VEpc5Na6BQ8VF86XxqQd5OgwDZP7k/zko63r0xQNHouuhqusmt7?=
 =?us-ascii?Q?u/Qk7THlYxGwPaoCbNkySyDPxYJl6wrFu4qogI7NlnwLs96eEwGOWmsCla4I?=
 =?us-ascii?Q?9jZcJBerMpJgIEDcekVTfWKBPxzK7WfTE+miWga0yJYGDscKhSQt3X4nD3ty?=
 =?us-ascii?Q?IZCcC47qKof/o0g/HqzU+wTpSSaxOHYzWXiMvGQcOlvHrUAx+hs7U6khFYS4?=
 =?us-ascii?Q?IttlsH7c3IEJnYC8+rHtnjB0DF75URmC0SnckDm3ELIUbS2eza5s4Tku2/5t?=
 =?us-ascii?Q?iPGINlQytPeY02xc3vsG7T/P1gzrms3SwOJk16IgBgJGq6DEYe9ZQ13KATe5?=
 =?us-ascii?Q?qYvZiUA9O4cPimeLzkW5ARUvrgTNCfpgDQDzBCS7u+TjUSFGzdZHSbC3/YMF?=
 =?us-ascii?Q?PkO0B3E+ACoTPscYFIbuzFpy6UJXWVN3K4qJn3QkJG9WImcMLJHVp5aixqmG?=
 =?us-ascii?Q?2Kk+UHO9P89QNt/ooR7rsbOeTDLmT+a67QnXlQ3IrBwLJl+Et3iQkE2ij+1I?=
 =?us-ascii?Q?KHhymuUraLKe9bL0M5PuFfEgZjWApR5hTc+ZJUZNABEdYi9gNHMqkNq1pduH?=
 =?us-ascii?Q?Pp8k7m1tgA3hNbttnEQEuSy3K1mqmxZmlp5ixEAvjNjDTYiHp0Lmkw+J6P+M?=
 =?us-ascii?Q?q0wdLuoyM3r/wz1igOp/3dFFfncpg3m5d55m8cEwfuBZTcHdOdGlTGKyNb8e?=
 =?us-ascii?Q?XNcwL0ar4s9oA6CcrczIuAazyEuhuHIffhXEYn/c0hq23M5IJWN6En9H7tvN?=
 =?us-ascii?Q?LP2p6xqxivwjj55jj3ORHJlq7qst3FklGdD2mLHDryzMpI0lhfn1+w98xyQ0?=
 =?us-ascii?Q?179q5FMw/H815ND7jjtDAFBYcWog9quBMdZPg07slcmlQGalF1yUAQ6fBjbR?=
 =?us-ascii?Q?lUOQ4a1VSwn3XlClO2Qh+oh88EAtGfJqDTCWZTBckybaQV9zatRwXfHlH2rH?=
 =?us-ascii?Q?Y8GWRM1ZWRDYzuTZauXai7+vC7w/Cq4DBzqySECZS3xKuFXEMQR7heRH5tGF?=
 =?us-ascii?Q?h2DXPQggb3wfCeihr5HIcF7XD7Zj0qTU9L8hUiQOVI1ChnhldVIYpL6ns0ia?=
 =?us-ascii?Q?PsZ1mt19bUj6ur7QwPjwdAmLhDv4G/HMNgkHT+6PgSupzliesD+J+FaotBe6?=
 =?us-ascii?Q?19o+5M95dQo6fjMW1gFFC/R/diqAsfKwK/VuQHtKhA3nSKFHgZeJSwyGMBOP?=
 =?us-ascii?Q?V+hrXjxy05akaXAO+DvCTJDWC64hBfnjWMi3hk4PsaYZjz413A3IHnVJNi93?=
 =?us-ascii?Q?3z7NHAEHs1GPwlDdEK9VirfFYBJHA1EHPnXfHxs753Zw8KTsCsZuna6G+bS8?=
 =?us-ascii?Q?qcAriDkrEKhFsakFwGG1EXJBWCwvatSmmHTJIWLAZ5o871pNwUInEttx0il4?=
 =?us-ascii?Q?tPajtlUMIw=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 67dd724b-be02-4ca5-95d5-08da3d5bbd87
X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB5925.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 May 2022 08:02:25.9631
 (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: ZqJj9HlID1xvp7koF8quSLzj+Vd5KQr6bES1ioCi6eRiVdeqhSyAM9DjBGeTK+My
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB5279
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Add HDMI Audio transfer type.

convert the sdma bindings txt into yaml in v2.

Signed-off-by: Joy Zou <joy.zou@nxp.com>
---
Changes since v1:
convert the sdma bindings txt into yaml in v2.
---
 .../devicetree/bindings/dma/fsl-imx-sdma.yaml | 135 ++++++++++++++++++
 1 file changed, 135 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dma/fsl-imx-sdma.yaml

diff --git a/Documentation/devicetree/bindings/dma/fsl-imx-sdma.yaml b/Documentation/devicetree/bindings/dma/fsl-imx-sdma.yaml
new file mode 100644
index 000000000000..5b4f7a09a395
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/fsl-imx-sdma.yaml
@@ -0,0 +1,135 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/dma/fsl-imx-sdma.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale Smart Direct Memory Access (SDMA) Controller for i.MX
+
+maintainers:
+  - Vinod Koul <vkoul@kernel.org>
+
+allOf:
+  - $ref: "dma-controller.yaml#"
+
+# Everything else is described in the common file
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - fsl,imx25-sdma
+          - fsl,imx31-sdma
+          - fsl,imx31-to1-sdma
+          - fsl,imx31-to2-sdma
+          - fsl,imx35-to1-sdma
+          - fsl,imx35-to2-sdma
+          - fsl,imx51-sdma
+          - fsl,imx53-sdma
+          - fsl,imx6q-sdma
+          - fsl,imx7d-sdma
+          - fsl,imx6sx-sdma
+          - fsl,imx6ul-sdma
+          - fsl,imx8mm-sdma
+          - fsl,imx8mn-sdma
+          - fsl,imx8mp-sdma
+      - enum:
+          - fsl,imx35-sdma
+          - fsl,imx8mq-sdma
+
+  reg:
+    description: Should contain SDMA registers location and length
+
+  interrupts:
+    description: Should contain SDMA interrupt
+
+  fsl,sdma-ram-script-name:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: Should contain the full path of SDMA RAM scripts firmware.
+
+  "#dma-cells":
+    const: 3
+    description: |
+      The first cell: request/event ID
+
+      The second cell: peripheral types ID
+        enum:
+          - MCU domain SSI: 0
+          - Shared SSI: 1
+          - MMC: 2
+          - SDHC: 3
+          - MCU domain UART: 4
+          - Shared UART: 5
+          - FIRI: 6
+          - MCU domain CSPI: 7
+          - Shared CSPI: 8
+          - SIM: 9
+          - ATA: 10
+          - CCM: 11
+          - External peripheral: 12
+          - Memory Stick Host Controller: 13
+          - Shared Memory Stick Host Controller: 14
+          - DSP: 15
+          - Memory: 16
+          - FIFO type Memory: 17
+          - SPDIF: 18
+          - IPU Memory: 19
+          - ASRC: 20
+          - ESAI: 21
+          - SSI Dual FIFO: 22
+              description: needs firmware more than ver 2
+          - Shared ASRC: 23
+          - SAI: 24
+          - HDMI Audio: 25
+
+       The third cell: transfer priority ID
+         enum:
+           - High: 0
+           - Medium: 1
+           - Low: 2
+
+  gpr:
+    description: The phandle to the General Purpose Register (GPR) node
+
+  fsl,sdma-event-remap:
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    description: |
+      Register bits of sdma event remap, the format is <reg shift val>.
+      - reg: the GPR register offset
+      - shift: the bit position inside the GPR register
+      - val: the value of the bit (0 or 1)
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - fsl,sdma-ram-script-name
+  - "#dma-cells"
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    sdma: dma-controller@83fb0000 {
+      compatible = "fsl,imx51-sdma", "fsl,imx35-sdma";
+      reg = <0x83fb0000 0x4000>;
+      interrupts = <6>;
+      #dma-cells = <3>;
+      fsl,sdma-ram-script-name = "sdma-imx51.bin";
+    };
+
+#DMA clients connected to the i.MX SDMA controller must use the format
+#described in the dma-controller.yaml file.
+  - |
+    ssi2: ssi@70014000 {
+      compatible = "fsl,imx51-ssi", "fsl,imx21-ssi";
+      reg = <0x70014000 0x4000>;
+      interrupts = <30>;
+      clocks = <&clks 49>;
+      dmas = <&sdma 24 1 0>,
+             <&sdma 25 1 0>;
+      dma-names = "rx", "tx";
+      fsl,fifo-depth = <15>;
+    };
+
+...
-- 
2.25.1