From patchwork Tue Aug 19 04:38:58 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Xiubo Li X-Patchwork-Id: 381227 Return-Path: X-Original-To: incoming-dt@patchwork.ozlabs.org Delivered-To: patchwork-incoming-dt@bilbo.ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 88F301400FA for ; Tue, 19 Aug 2014 14:43:30 +1000 (EST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752600AbaHSEn3 (ORCPT ); Tue, 19 Aug 2014 00:43:29 -0400 Received: from mail-by2lp0244.outbound.protection.outlook.com ([207.46.163.244]:7646 "EHLO na01-by2-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752720AbaHSEn3 (ORCPT ); Tue, 19 Aug 2014 00:43:29 -0400 Received: from DM2PR0301MB0623.namprd03.prod.outlook.com (25.160.95.27) by DM2PR0301MB0687.namprd03.prod.outlook.com (25.160.96.25) with Microsoft SMTP Server (TLS) id 15.0.995.14; Tue, 19 Aug 2014 04:43:27 +0000 Received: from BN3PR0301CA0049.namprd03.prod.outlook.com (25.160.152.145) by DM2PR0301MB0623.namprd03.prod.outlook.com (25.160.95.27) with Microsoft SMTP Server (TLS) id 15.0.1010.18; Tue, 19 Aug 2014 04:43:25 +0000 Received: from BN1AFFO11FD013.protection.gbl (2a01:111:f400:7c10::179) by BN3PR0301CA0049.outlook.office365.com (2a01:111:e400:401e::17) with Microsoft SMTP Server (TLS) id 15.0.1010.18 via Frontend Transport; Tue, 19 Aug 2014 04:43:24 +0000 Received: from tx30smr01.am.freescale.net (192.88.168.50) by BN1AFFO11FD013.mail.protection.outlook.com (10.58.52.73) with Microsoft SMTP Server (TLS) id 15.0.1010.11 via Frontend Transport; Tue, 19 Aug 2014 04:43:24 +0000 Received: from titan.ap.freescale.net ([10.192.208.233]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id s7J4h8ko007905; Mon, 18 Aug 2014 21:43:21 -0700 From: Xiubo Li To: CC: , , , , , , , Xiubo Li , Varka Bhadram Subject: [PATCH 3/3] Document: fsl-sai: Adjust the document making it read more comfortably. Date: Tue, 19 Aug 2014 12:38:58 +0800 Message-ID: <1408423138-19880-4-git-send-email-Li.Xiubo@freescale.com> X-Mailer: git-send-email 1.8.5 In-Reply-To: <1408423138-19880-1-git-send-email-Li.Xiubo@freescale.com> References: <1408423138-19880-1-git-send-email-Li.Xiubo@freescale.com> X-EOPAttributedMessage: 0 X-Forefront-Antispam-Report: CIP:192.88.168.50; CTRY:US; IPV:CAL; IPV:NLI; EFV:NLI; SFV:NSPM; SFS:(10019006)(6009001)(199003)(189002)(85306004)(74662001)(104166001)(81542001)(97736001)(89996001)(85852003)(86362001)(74502001)(31966008)(50466002)(229853001)(81342001)(62966002)(50986999)(76176999)(110136001)(87286001)(84676001)(99396002)(87936001)(92726001)(93916002)(92566001)(83072002)(21056001)(88136002)(80022001)(26826002)(50226001)(19580395003)(4396001)(6806004)(64706001)(68736004)(47776003)(19580405001)(102836001)(44976005)(20776003)(83322001)(79102001)(36756003)(48376002)(104016003)(107046002)(95666004)(77982001)(106466001)(46102001)(2351001)(105606002)(77156001)(76482001); DIR:OUT; SFP:1102; SCL:1; SRVR:DM2PR0301MB0623; H:tx30smr01.am.freescale.net; FPR:; MLV:ovrnspm; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; MIME-Version: 1.0 X-Microsoft-Antispam: BCL:0;PCL:0;RULEID:;UriScan:; X-Forefront-PRVS: 0308EE423E Received-SPF: Fail (protection.outlook.com: domain of freescale.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=Li.Xiubo@freescale.com; X-Microsoft-Antispam: BCL:0;PCL:0;RULEID: X-OriginatorOrg: freescale.com Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org Signed-off-by: Xiubo Li Cc: Varka Bhadram Reviewed-by: Varka Bhadram --- .../devicetree/bindings/sound/fsl-sai.txt | 54 ++++++++++++---------- 1 file changed, 29 insertions(+), 25 deletions(-) diff --git a/Documentation/devicetree/bindings/sound/fsl-sai.txt b/Documentation/devicetree/bindings/sound/fsl-sai.txt index e25ef38..cd2930e 100644 --- a/Documentation/devicetree/bindings/sound/fsl-sai.txt +++ b/Documentation/devicetree/bindings/sound/fsl-sai.txt @@ -7,30 +7,34 @@ codec/DSP interfaces. Required properties: -- compatible: Compatible list, contains "fsl,vf610-sai" or "fsl,imx6sx-sai". -- reg: Offset and length of the register set for the device. -- clocks: Must contain an entry for each entry in clock-names. +- compatible: Compatible list, contains "fsl,vf610-sai" or "fsl,imx6sx-sai". +- 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 "bus" for register access and "mclk1" "mclk2" - "mclk3" for bit clock and frame clock providing. -- dmas : Generic dma devicetree binding as described in - Documentation/devicetree/bindings/dma/dma.txt. -- dma-names : Two dmas have to be defined, "tx" and "rx". -- pinctrl-names: Must contain a "default" entry. -- pinctrl-NNN: One property must exist for each entry in pinctrl-names. - See ../pinctrl/pinctrl-bindings.txt for details of the property values. -- big-endian: Boolean property, required if all the SAI device registers - are big-endian rather than little-endian. -- msb-first: Configures whether the LSB or the MSB is transmitted first for - the fifo data. If this property is absent, the LSB is transmitted first as - default, or the MSB is transmitted first. -- fsl,sai-synchronous-rx: This is a boolean property. If present, indicating - that SAI will work in the synchronous mode (sync Tx with Rx) which means - both the transimitter and receiver will send and receive data by following - receiver's bit clocks and frame sync clocks. -- fsl,sai-asynchronous: This is a boolean property. If present, indicating - that SAI will work in the asynchronous mode, which means both transimitter - and receiver will send and receive data by following their own bit clocks - and frame sync clocks separately. + "mclk3" for bit clock and frame clock providing. +- dmas : Generic dma devicetree binding as described in + Documentation/devicetree/bindings/dma/dma.txt. +- dma-names : Two dmas have to be defined, "tx" and "rx". +- pinctrl-names:Must contain a "default" entry. +- pinctrl-NNN: One property must exist for each entry in pinctrl-names. + See ../pinctrl/pinctrl-bindings.txt for details of the property + avalues. +- big-endian: Boolean property, required if all the SAI device registers + are big-endian rather than little-endian. +- msb-first: Configures whether the LSB or the MSB is transmitted first for + the fifo data. If this property is absent, the LSB is transmitted + first as default, or the MSB is transmitted first. +- fsl,sai-synchronous-rx: + This is a boolean property. If present, indicating + that SAI will work in the synchronous mode (sync Tx with Rx) + which means both the transimitter and receiver will send and + receive data by following receiver's bit clocks and frame sync + clocks. +- fsl,sai-asynchronous: + This is a boolean property. If present, indicating that SAI will + work in the asynchronous mode, which means both transimitter and + receiver will send and receive data by following their own bit + clocks and frame sync clocks separately. Note: - If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the @@ -40,7 +44,7 @@ Note: - fsl,sai-asynchronous and fsl,sai-synchronous-rx are exclusive. Example: -sai2: sai@40031000 { + sai2: sai@40031000 { compatible = "fsl,vf610-sai"; reg = <0x40031000 0x1000>; pinctrl-names = "default"; @@ -54,4 +58,4 @@ sai2: sai@40031000 { <&edma0 0 VF610_EDMA_MUXID0_SAI2_RX>; big-endian; msb-first; -}; + };