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 v4 2/3] ASoC: add fsl_audmix DT binding documentation
Thread-Topic: [PATCH v4 2/3] ASoC: add fsl_audmix DT binding documentation
Thread-Index: AQHUskOjyw34cq16q0ecl8TZoyZj1A==
Date:   Tue, 22 Jan 2019 11:14:27 +0000
Message-ID: <1548155654-12985-3-git-send-email-viorel.suman@nxp.com>
References: <1548155654-12985-1-git-send-email-viorel.suman@nxp.com>
In-Reply-To: <1548155654-12985-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;VI1PR04MB5422;6:6vXyixJzRr536t6FlJyyGj660fqoyAUEHNB8xgdiP552zB5RziJ3T09tYZT29OnakuDJ6fXK/aNL374kzcjmS9L3q8Vv2Bui3nbqGYuQKItcxb2rqqCRhUfR3RA9eA5wNz5OMAvnrMHoGcI/uIlL/TJTG9VR+5YzaPKbDpQPkbvp0xNDktXHYQj4P9fHnCfbMeN2/Fcw7xVXxp5MqwjH5slPRx/tJlNFIhkrigoOwzkr5YkzEsMWZDFbgYmbdaHemycRUHDja47o2EUrkFScLDYWTtoYhKNqIeGxc0Co9sP52DcHSvl8kIcWmsJGy0KWL2hTyOUcpxqTWU7FKClsBYX8m6XlJo/GYo+wmFnJjNz+aAhEgW7btU7InNTQhKY934AO53jUrOELgDfpTdvz8ve08tZXJNE5MWBB+tiJlt+wKuSm3VpZxk9tet+hMlykqDN+gXPJC1q8eN8KPcKZiQ==;5:cUimCHdxBj5XMD4DLgcZCLt27TKjUsBIkiQCpbwMVVVhEfbBQBct4L/WM9MbWyz71vETC5nTikT4qq4+NM4qQ8y4SOjqER2qSWJRe69zEk/KwGRgC1Db7YAea8nfmcgT9ugsFndSamMtl5QuFhBCCxrUUCdzYacjsyMjJrbh0dyRWe6ZEck95vFqm++aPCpYfX9gnZrIaj31482K1xOxVA==;7:L95kri6dsAGcJlwAaWxCpCCNxnfKRnAvJNL1+Lq5pMRh0d0MnW9kLjC6qy0ZktkklIB796EUKdAA8dJPnn7L9ZwghE8BIbMZa2tFb+TTw8GFq+nuAAZN9i7hkWIdJyIZywX1imw9VOkWbyTpqS76yA==
x-ms-office365-filtering-correlation-id: ca960435-dc1e-4e8f-8411-08d6805ac5f9
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: BCL:0;PCL:0;RULEID:(2390118)(7020095)(4652040)(8989299)(5600109)(711020)(4618075)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(2017052603328)(7153060)(7193020);SRVR:VI1PR04MB5422;
x-ms-traffictypediagnostic: VI1PR04MB5422:
x-microsoft-antispam-prvs: <VI1PR04MB54225F81E3D9BD89BD865C6592980@VI1PR04MB5422.eurprd04.prod.outlook.com>
x-forefront-prvs: 0925081676
x-forefront-antispam-report: SFV:NSPM;SFS:(10009020)(366004)(136003)(39860400002)(376002)(346002)(396003)(199004)(189003)(316002)(8936002)(86362001)(6636002)(36756003)(50226002)(110136005)(6486002)(14454004)(54906003)(6436002)(99286004)(6116002)(97736004)(7416002)(81166006)(81156014)(3846002)(478600001)(2906002)(44832011)(8676002)(68736007)(66066001)(105586002)(106356001)(7736002)(305945005)(25786009)(26005)(6346003)(186003)(71190400001)(256004)(486006)(39060400002)(2616005)(4326008)(476003)(6512007)(6506007)(446003)(386003)(53936002)(71200400001)(14444005)(11346002)(102836004)(52116002)(76176011)(921003)(1121003);DIR:OUT;SFP:1101;SCL:1;SRVR:VI1PR04MB5422;H:VI1PR04MB4704.eurprd04.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;A:1;MX:1;
received-spf: None (protection.outlook.com: nxp.com does not designate
 permitted sender hosts)
authentication-results: spf=none (sender IP is )
 smtp.mailfrom=viorel.suman@nxp.com; 
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam-message-info: ZwIRHBS5FhKnP8LsAsMEgdG2wsr7ILX/TEoAx6SShzQLTXIiMumOGL1ma7jYLfUCYH6WeV1ym3ncJmHTBWmZAVpDLryw7UfS+A8dPYeOTfw6QM+P+Us1ZWSIPD29cFH4uuPpeAzpFs3XC7DDlVp/rlUV0ifj7CMv6bVa3Tu1eD1S82w56eIddjajPi/cN0grCHcnbo4j3hnaByxkQtngZNaIzu0HR96sRa1swhlD8/jBmqlBVA6CMysQ6FEU0cngWZ0CYIIMYltvqg2WwbSWbmH9Yoho++YtvxsBHclefamGAK36JnFFbPHkgTeLdyE4lMYKqtiia4uZVngPmeZ7E8UeJMIkQ4nsk19rhN8QjI/O0sU0l9ZPxHH6tu0AJgGaYm5fVreIZfTP99WFc/0qvD670j6MSaBuk+ITnxf0Sww=
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: ca960435-dc1e-4e8f-8411-08d6805ac5f9
X-MS-Exchange-CrossTenant-originalarrivaltime: 22 Jan 2019 11:14:26.3078
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB5422
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       | 54 ++++++++++++++++++=
++++
 1 file changed, 54 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..45f807e
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/fsl,audmix.txt
@@ -0,0 +1,54 @@
+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.
+
+  - model		: Must contain machine driver name which will configure
+			  and instantiate the appropriate audio card.
+
+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>;
+    model =3D "imx-audmix";
+  };
--=20
2.7.4