Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   "Viorel Suman (OSS)" <viorel.suman@oss.nxp.com>
To:     Liam Girdwood <lgirdwood@gmail.com>,
        Mark Brown <broonie@kernel.org>,
        Rob Herring <robh+dt@kernel.org>,
        Jaroslav Kysela <perex@perex.cz>,
        Takashi Iwai <tiwai@suse.com>, Timur Tabi <timur@kernel.org>,
        Nicolin Chen <nicoleotsuka@gmail.com>,
        Xiubo Li <Xiubo.Lee@gmail.com>,
        Fabio Estevam <festevam@gmail.com>,
        Shengjiu Wang <shengjiu.wang@gmail.com>,
        Philipp Zabel <p.zabel@pengutronix.de>,
        Cosmin-Gabriel Samoila <cosmin.samoila@nxp.com>,
        Viorel Suman <viorel.suman@nxp.com>,
        Matthias Schiffer <matthias.schiffer@ew.tq-group.com>,
        alsa-devel@alsa-project.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org
Cc:     NXP Linux Team <linux-imx@nxp.com>,
        Viorel Suman <viorel.suman@gmail.com>
Subject: [PATCH v3 2/2] ASoC: dt-bindings: fsl_xcvr: Add document for XCVR
Date:   Tue, 29 Sep 2020 12:19:27 +0300
Message-Id: <1601371167-32239-3-git-send-email-viorel.suman@oss.nxp.com>
In-Reply-To: <1601371167-32239-1-git-send-email-viorel.suman@oss.nxp.com>
References: <1601371167-32239-1-git-send-email-viorel.suman@oss.nxp.com>
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
Received: from fsr-ub1664-116.ea.freescale.net (83.217.231.2) by AM0PR03CA0065.eurprd03.prod.outlook.com (2603:10a6:208::42) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.3412.22 via Frontend Transport; Tue, 29 Sep 2020 09:19:57 +0000
X-Mailer: git-send-email 2.7.4
X-Originating-IP: [83.217.231.2]
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-HT: Tenant
X-MS-Office365-Filtering-Correlation-Id: eac94021-844d-4d7d-6198-08d86458d69c
X-MS-TrafficTypeDiagnostic: VI1PR04MB4078:
X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True
X-MS-Exchange-Transport-Forked: True
X-Microsoft-Antispam-PRVS: <VI1PR04MB4078B640595F87BC916B6324D3320@VI1PR04MB4078.eurprd04.prod.outlook.com>
X-MS-Oob-TLC-OOBClassifiers: OLM:3044;
X-MS-Exchange-SenderADCheck: 1
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: R9dncesucQUk9t1yvA2KrPRdh705lxpDQDL5F+nb0ZUIxrlgshf+jWS7yFla6Y8x6x5lrp2HtxWWzk7dCtZXkYV9HUTPCwpFET39zqtD56NYp52m8wQ0lhnjGkXtu3kjMFWUujcAPLRikkaT411VKcHRLifnhAZmDuVhNMeZnm483yDTOcfA5eUWHScb2R1czpVh01xsnUfbj23ca4U9PldRLrmkUTtIDTFePE14fSWRLkQ5cb9ms2jXPVq2KOnusV9iuMLRUp4y+m3KQLHVueVNUxlPlggMFdJdLOWHUolaDc1cPqM8SNdlykYzZfG+qZfPDcaqi9F2qhwOAjXav/5dXZ4AJk/KtlRvrHmIwC8psbgXL8r5h9a1+Q+KOxygb67Bneczr8h+Yqmm1eRujlo/V9RndFqftUE+5GnBvj9JtwkCTCrQpmzMiOEHVy51AoTaGLmkkVHzR+1aRS8ynbc1oNBlCNBDe6IvJmh5E484PgwmHI7qKvH/IQbuVK59
X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:VI1PR0401MB2272.eurprd04.prod.outlook.com;PTR:;CAT:NONE;SFS:(4636009)(396003)(376002)(346002)(366004)(136003)(39860400002)(66556008)(66476007)(186003)(66946007)(7416002)(26005)(2906002)(16526019)(6512007)(5660300002)(966005)(8676002)(6486002)(956004)(316002)(2616005)(86362001)(478600001)(54906003)(110136005)(6506007)(8936002)(83380400001)(52116002)(6666004)(4326008)(921003);DIR:OUT;SFP:1101;
X-MS-Exchange-AntiSpam-MessageData: hFQ9/d/sYd62Skm3Y7WaF8RwOV/qEidt39xkCy/46QbMsgr2i6+qotCIqcPOqtPc9lQBeINcoKY8vBrZkS0GjfJGzX4jHcJK5Ce/3W0Fmp6FQOTAm7zTee1aUjJCRBIAOAl4uQjIf7SAm3V1zsyK0Z3tEP413lCvn4m1RWbTPonff+Aw/encrvEXlBGIf/Bm981ee7X7Vpg+/n2x+rGWL1+Qz2OiZG1D8Aiaf8Xn3XrYD9LLWmGjduQWyXfxH+N1KlXr5PSfs3zg2N225vtMeTyW4cdK7lI1+iEnpr5APPuWZ3TG3kQIEKabsn6gBdkLqRvoKFlKc7IRaIhE/Pr77u+qIrUKRCVzfMwaskiG/wyezgmRu3HoVDWsVkyDvO3NMMUX1eqJC8yjqsZM1Z6prnzowZvFF6xxV+4YzrumSGCCGxiqYQP+pEwuGjus4UoaZI/gd7d6w7PaB/vfIJTntHydlfrDRyXsar/l2U0of6kI5GPyS7DOm+1r7lPxdaojAjnqgYnxPcdLAj1I2lUawpsY/vfSW8H2phygTDSuQPuoVimmvi80Nw7l8AIOKtbS+RSYLaAs9cjZR61YRHfHMAhYCH837Y3x8mFVj+PV+kfvHqgf1Nt6WYSkgxE99RPGomAsetR44cc6rp3Io+ZS/Q==
X-OriginatorOrg: oss.nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: eac94021-844d-4d7d-6198-08d86458d69c
X-MS-Exchange-CrossTenant-AuthSource: VI1PR0401MB2272.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Sep 2020 09:19:59.5716
 (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: fPjuqaknNhAj22TfvoCGFyNG04VErN1Vrg1ursgRPvSYbREQAUIfkeAKeSkCXQMaa8JPusBb0KefYDxZhJg2OA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB4078
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

From: Viorel Suman <viorel.suman@nxp.com>

XCVR (Audio Transceiver) is a new IP module found on i.MX8MP.

Signed-off-by: Viorel Suman <viorel.suman@nxp.com>
---
 .../devicetree/bindings/sound/fsl,xcvr.yaml        | 103 +++++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/fsl,xcvr.yaml

diff --git a/Documentation/devicetree/bindings/sound/fsl,xcvr.yaml b/Documentation/devicetree/bindings/sound/fsl,xcvr.yaml
new file mode 100644
index 00000000..8abab2d
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/fsl,xcvr.yaml
@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/fsl,xcvr.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP Audio Transceiver (XCVR) Controller
+
+maintainers:
+  - Viorel Suman <viorel.suman@nxp.com>
+
+properties:
+  $nodename:
+    pattern: "^xcvr@.*"
+
+  compatible:
+    const: fsl,imx8mp-xcvr
+
+  reg:
+    items:
+      - description: 20K RAM for code and data
+      - description: registers space
+      - description: RX FIFO address
+      - description: TX FIFO address
+
+  reg-names:
+    items:
+      - const: ram
+      - const: regs
+      - const: rxfifo
+      - const: txfifo
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: Peripheral clock
+      - description: PHY clock
+      - description: SPBA clock
+      - description: PLL clock
+
+  clock-names:
+    items:
+      - const: ipg
+      - const: phy
+      - const: spba
+      - const: pll_ipg
+
+  dmas:
+    maxItems: 2
+
+  dma-names:
+    items:
+      - const: rx
+      - const: tx
+
+  firmware-name:
+    $ref: /schemas/types.yaml#/definitions/string
+    const: imx/xcvr/xcvr-imx8mp.bin
+    description: |
+      Should contain the name of the default firmware image
+      file located on the firmware search path
+
+  resets:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - interrupts
+  - clocks
+  - clock-names
+  - dmas
+  - dma-names
+  - firmware-name
+  - resets
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/imx8mp-clock.h>
+    #include <dt-bindings/reset/imx8mp-reset.h>
+
+    xcvr: xcvr@30cc0000 {
+           compatible = "fsl,imx8mp-xcvr";
+           reg = <0x30cc0000 0x800>,
+                 <0x30cc0800 0x400>,
+                 <0x30cc0c00 0x080>,
+                 <0x30cc0e00 0x080>;
+           reg-names = "ram", "regs", "rxfifo", "txfifo";
+           interrupts = <0x0 128 IRQ_TYPE_LEVEL_HIGH>;
+           clocks = <&audiomix_clk IMX8MP_CLK_AUDIOMIX_EARC_IPG>,
+                    <&audiomix_clk IMX8MP_CLK_AUDIOMIX_EARC_PHY>,
+                    <&audiomix_clk IMX8MP_CLK_AUDIOMIX_SPBA2_ROOT>,
+                    <&audiomix_clk IMX8MP_CLK_AUDIOMIX_AUDPLL_ROOT>;
+           clock-names = "ipg", "phy", "spba", "pll_ipg";
+           dmas = <&sdma2 30 2 0>, <&sdma2 31 2 0>;
+           dma-names = "rx", "tx";
+           firmware-name = "imx/xcvr/xcvr-imx8mp.bin";
+           resets = <&audiomix_reset 0>;
+    };
-- 
2.7.4