Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   Viorel Suman <viorel.suman@nxp.com>
To:     Liam Girdwood <lgirdwood@gmail.com>,
        Mark Brown <broonie@kernel.org>,
        Rob Herring <robh+dt@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        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 <fabio.estevam@nxp.com>,
        Viorel Suman <viorel.suman@nxp.com>,
        "S.j. Wang" <shengjiu.wang@nxp.com>,
        Daniel Baluta <daniel.baluta@nxp.com>,
        Cosmin Samoila <cosmin.samoila@nxp.com>
CC:     "alsa-devel@alsa-project.org" <alsa-devel@alsa-project.org>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linuxppc-dev@lists.ozlabs.org" <linuxppc-dev@lists.ozlabs.org>,
        dl-linux-imx <linux-imx@nxp.com>,
        Viorel Suman <viorel.suman@gmail.com>
Subject: [PATCH v3 2/4] ASoC: add fsl_audmix DT binding documentation
Thread-Topic: [PATCH v3 2/4] ASoC: add fsl_audmix DT binding documentation
Thread-Index: AQHUrmKqT8wDihQUGEKdena01cgo8g==
Date:   Thu, 17 Jan 2019 12:46:29 +0000
Message-ID: <1547729177-14317-3-git-send-email-viorel.suman@nxp.com>
References: <1547729177-14317-1-git-send-email-viorel.suman@nxp.com>
In-Reply-To: <1547729177-14317-1-git-send-email-viorel.suman@nxp.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-messagesentrepresentingtype: 1
x-mailer: git-send-email 2.7.4
x-originating-ip: [95.76.156.53]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1;DB7PR04MB4251;6:OUx0AlIg1aiPSFBSbCSba/r8P21ZXPOZxgM7qjcbwcZbHIhnaQU2xeFZq0weyEIkk814bok0KMDUwLWtRt5uPgYdC4/xWpgdqrr8Qgchj2uFdqxwf9ZbmcAdk09CQp76Vd+gog0RolfEJtnwKc33IxRchJyQk7ElfGut51NnkdF/ovqZNnlFZmF1DLz4CvFJrng+lY3Ib+iNKgegeeQQ2N9GX43awXw1CQbemeH/Dq58jer7maIGPt4r4rQSgEzmBiPW/bNPm5mRQJks5aGL7+MSJUkY+Yf2UaZvtUE4DA//nxe2HFbRtZjD8MmLJ23xTz6gQqvhfxKCZG8S9yrxdSZiG6Lq/x5rt82exIlQhEPs7BVvWFAp+9qTY9KJVmNG9Uwhmn68jnDKJrdj0KwxjBsVWgirE2XBjKjXkkspI6rpDql89it1hsElsiAhqNFHDNrERFUUk6xx1dMIl/xGkw==;5:Rp7Lp/CV7ASXyrAylG+OCTG2dURas2ujFrNe+kMgt9qL8Wx04NnB5kUsg3RDonDJ/OAQhhqwRzvPuOBBei7XlbVqa2J4aCQQ8vkosfhNSqJAYXyw2jrhtrQ5vRssx2hf4pVL/s2Xa/dTo1EP4hN9DSbvNNwkH18OD1sIo1JOsK1pioQz64ilLv0WNS0+V/doAXAxQ7oEyCeoBtaB0mXEmg==;7:SmiX6EICS/H8mPlZOUFKCzP1FFLAL7OGTnAIG/UsutdvEiZM7d6S+uIeacyn/P1gJUgWfh/Y3OnMlGzkmPiNx2QgZ9GcKnHkIXWgJWCaiqjgNiE674olFFt2qyhEC3SvA8liKCJT/O8YO6e/PE3Jxw==
x-ms-office365-filtering-correlation-id: ebe7abd8-47f3-447e-8c99-08d67c79ccf8
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: BCL:0;PCL:0;RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600109)(711020)(4618075)(2017052603328)(7153060)(7193020);SRVR:DB7PR04MB4251;
x-ms-traffictypediagnostic: DB7PR04MB4251:
x-microsoft-antispam-prvs: <DB7PR04MB4251A686CC73FA07F3F89DCA92830@DB7PR04MB4251.eurprd04.prod.outlook.com>
x-forefront-prvs: 0920602B08
x-forefront-antispam-report: SFV:NSPM;SFS:(10009020)(136003)(39860400002)(376002)(346002)(396003)(366004)(189003)(199004)(305945005)(76176011)(6116002)(3846002)(14454004)(6512007)(6436002)(6486002)(7736002)(71200400001)(52116002)(6636002)(6506007)(386003)(86362001)(316002)(478600001)(71190400001)(54906003)(110136005)(106356001)(97736004)(105586002)(446003)(53936002)(66066001)(476003)(2906002)(4326008)(486006)(11346002)(14444005)(256004)(99286004)(81166006)(39060400002)(8676002)(2616005)(186003)(102836004)(26005)(44832011)(25786009)(5660300001)(7416002)(81156014)(8936002)(50226002)(68736007)(36756003)(921003)(1121003);DIR:OUT;SFP:1101;SCL:1;SRVR:DB7PR04MB4251;H:DB7PR04MB4699.eurprd04.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;MX:1;A:1;
received-spf: None (protection.outlook.com: nxp.com does not designate
 permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam-message-info: eiu/NeVR6zzGaVLuUJ8+EipeyhtfwUt68YalsrE40C6PbTcpvy5W1TUDbmXfbN61IlnesAqJ9r7V2nGBsEy1LknsouWPDzFO9rDySGuOwgL/yFnn1HIq4r1pSEiC7iYfK/jDMq1C9ZsDA0kYbOv0Pa4sPWxMhFoxrk0m20DpeAt0kuPCJVn8vRE5jVnqCIgc8Vdw832WAJUXRKQwDZDKcEO36HEbZUbAy45qBhSWqrYApgtYr7dOBuRISq7BnBmeeupjoUMaO4f5EjHaTYxlKpvaInm17s0w5mGRHj/SWybtux233vRJr+abdvdjc8pPVPejSE07DFrUjjJLwBUmPfa3FB92QiXlDlxV1p6YvsJQw8T/gt5Hz8KkkfsUIx/fv0NAzKKsVHMVvZitYAABQjjBzvrC8+gEM5E+19dY3wg=
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: ebe7abd8-47f3-447e-8c99-08d67c79ccf8
X-MS-Exchange-CrossTenant-originalarrivaltime: 17 Jan 2019 12:46:27.5763
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR04MB4251
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Add the DT binding documentation for NXP Audio Mixer
CPU DAI driver.

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

diff --git a/Documentation/devicetree/bindings/sound/fsl,audmix.txt b/Docum=
entation/devicetree/bindings/sound/fsl,audmix.txt
new file mode 100644
index 0000000..840b7e0
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/fsl,audmix.txt
@@ -0,0 +1,50 @@
+NXP Audio Mixer (AUDMIX).
+
+The Audio Mixer is a on-chip functional module that allows mixing of two
+audio streams into a single audio stream. Audio Mixer has two input serial
+audio interfaces. These are driven by two Synchronous Audio interface
+modules (SAI). Each input serial interface carries 8 audio channels in its
+frame in TDM manner. Mixer mixes audio samples of corresponding channels
+from two interfaces into a single sample. Before mixing, audio samples of
+two inputs can be attenuated based on configuration. The output of the
+Audio Mixer is also a serial audio interface. Like input interfaces it has
+the same TDM frame format. This output is used to drive the serial DAC TDM
+interface of audio codec and also sent to the external pins along with the
+receive path of normal audio SAI module for readback by the CPU.
+
+The output of Audio Mixer can be selected from any of the three streams
+ - serial audio input 1
+ - serial audio input 2
+ - mixed audio
+
+Mixing operation is independent of audio sample rate but the two audio
+input streams must have same audio sample rate with same number of channel=
s
+in TDM frame to be eligible for mixing.
+
+Device driver required properties:
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D
+  - compatible		: Compatible list, contains "fsl,imx8qm-audmix"
+
+  - reg			: Offset and length of the register set for the device.
+
+  - clocks		: Must contain an entry for each entry in clock-names.
+
+  - clock-names		: Must include the "ipg" for register access.
+
+  - power-domains	: Must contain the phandle to AUDMIX power domain node
+
+  - dais		: Must contain a list of phandles to AUDMIX connected
+			  DAIs. The current implementation requires two phandles
+			  to SAI interfaces to be provided, the first SAI in the
+			  list being used to route the AUDMIX output.
+
+Device driver configuration example:
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+  audmix: audmix@59840000 {
+    compatible =3D "fsl,imx8qm-audmix";
+    reg =3D <0x0 0x59840000 0x0 0x10000>;
+    clocks =3D <&clk IMX8QXP_AUD_AUDMIX_IPG>;
+    clock-names =3D "ipg";
+    power-domains =3D <&pd_audmix>;
+    dais =3D <&sai4>, <&sai5>;
+  };
--=20
2.7.4