From patchwork Wed Feb 1 16:53:55 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christopher Bostic X-Patchwork-Id: 9550181 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 09C4260425 for ; Wed, 1 Feb 2017 16:57:41 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id EBD6628425 for ; Wed, 1 Feb 2017 16:57:40 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id DEFE328458; Wed, 1 Feb 2017 16:57:40 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=2.0 tests=BAYES_00 autolearn=ham version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [65.50.211.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 8F7E428425 for ; Wed, 1 Feb 2017 16:57:39 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.87 #1 (Red Hat Linux)) id 1cYyDt-0001LB-LF; Wed, 01 Feb 2017 16:57:33 +0000 Received: from mx0b-001b2d01.pphosted.com ([148.163.158.5] helo=mx0a-001b2d01.pphosted.com) by bombadil.infradead.org with esmtps (Exim 4.87 #1 (Red Hat Linux)) id 1cYyDc-0000ai-Ct for linux-arm-kernel@lists.infradead.org; Wed, 01 Feb 2017 16:57:21 +0000 Received: from pps.filterd (m0098419.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.20/8.16.0.20) with SMTP id v11Gs5iQ066530 for ; Wed, 1 Feb 2017 11:56:55 -0500 Received: from e17.ny.us.ibm.com (e17.ny.us.ibm.com [129.33.205.207]) by mx0b-001b2d01.pphosted.com with ESMTP id 28bguy00j9-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Wed, 01 Feb 2017 11:56:55 -0500 Received: from localhost by e17.ny.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 1 Feb 2017 11:56:54 -0500 Received: from d01dlp02.pok.ibm.com (9.56.250.167) by e17.ny.us.ibm.com (146.89.104.204) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Wed, 1 Feb 2017 11:56:50 -0500 Received: from b01cxnp22035.gho.pok.ibm.com (b01cxnp22035.gho.pok.ibm.com [9.57.198.25]) by d01dlp02.pok.ibm.com (Postfix) with ESMTP id 14A546E801D; Wed, 1 Feb 2017 11:56:22 -0500 (EST) Received: from b01ledav002.gho.pok.ibm.com (b01ledav002.gho.pok.ibm.com [9.57.199.107]) by b01cxnp22035.gho.pok.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id v11GuoxO42664170; Wed, 1 Feb 2017 16:56:50 GMT Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id E080B124052; Wed, 1 Feb 2017 11:56:49 -0500 (EST) Received: from Christophers-MacBook-Pro.local.com (unknown [9.81.201.28]) by b01ledav002.gho.pok.ibm.com (Postfix) with ESMTP id 4465912404C; Wed, 1 Feb 2017 11:56:41 -0500 (EST) From: Christopher Bostic To: robh+dt@kernel.org, mark.rutland@arm.com, linux@armlinux.org.uk, gregkh@linuxfoundation.org, mturquette@baylibre.com, geert+renesas@glider.be, devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org, joel@jms.id.au, linux-kernel@vger.kernel.org, andrew@aj.id.au, alistair@popple.id.au, benh@kernel.crashing.org Subject: [PATCH v3 15/18] drivers/fsi: Add FSI bus documentation Date: Wed, 1 Feb 2017 10:53:55 -0600 X-Mailer: git-send-email 2.10.1 (Apple Git-78) In-Reply-To: <20170201165358.45415-1-cbostic@linux.vnet.ibm.com> References: <20170201165358.45415-1-cbostic@linux.vnet.ibm.com> X-TM-AS-GCONF: 00 X-Content-Scanned: Fidelis XPS MAILER x-cbid: 17020116-0040-0000-0000-000002852F0C X-IBM-SpamModules-Scores: X-IBM-SpamModules-Versions: BY=3.00006537; HX=3.00000240; KW=3.00000007; PH=3.00000004; SC=3.00000201; SDB=6.00815769; UDB=6.00398295; IPR=6.00593211; BA=6.00005108; NDR=6.00000001; ZLA=6.00000005; ZF=6.00000009; ZB=6.00000000; ZP=6.00000000; ZH=6.00000000; ZU=6.00000002; MB=3.00014138; XFM=3.00000011; UTC=2017-02-01 16:56:54 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 17020116-0041-0000-0000-000006783878 Message-Id: <20170201165358.45415-16-cbostic@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:, , definitions=2017-02-01_13:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 suspectscore=0 malwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1612050000 definitions=main-1702010167 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20170201_085716_931146_876398BC X-CRM114-Status: GOOD ( 16.24 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Chris Bostic MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP From: Chris Bostic Add details on the basic functions of the FSI serial bus. Signed-off-by: Chris Bostic --- Documentation/devicetree/bindings/fsi/fsi.txt | 54 +++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 Documentation/devicetree/bindings/fsi/fsi.txt diff --git a/Documentation/devicetree/bindings/fsi/fsi.txt b/Documentation/devicetree/bindings/fsi/fsi.txt new file mode 100644 index 0000000..7fa2394 --- /dev/null +++ b/Documentation/devicetree/bindings/fsi/fsi.txt @@ -0,0 +1,54 @@ +FSI: Flexible Support processor Interface + +FSI is a two line serial bus capable of running at speeds up to 166 MHz. +The lines consist of a clock responsible for synchronizing the target device +(slave) with the master which is responsible for all transactions on the bus. +The master owns the clock line and is the only side allowed to change its +state. The second line, SDA, is a data line that conveys information to/from +the slave who samples based on the clock line. The data line is +bi-directional. + +The master initiates communication by sending a command to the slave and +depending on the type of command will allow the slave to control the bus +to return requested data. All commands are CRC protected. The slave upon +receipt of a command will determine if the CRC is correct and discard +the data if noise has corrupted the line. In the same manner the master +will verify the CRC received from the slave. + +Types of commands: +Read 32 bit: Read a 32 bit word from a specified address on the slave. +Read 16 bit: Read a 16 bit 'half word' from a specified address on the slave. +read 8 bit: Read a byte from a specified address on the slave. +Write 32,16,8 bit: Write to a specified address on the slave with the provided + data. +BREAK: Initialize the slave's logic to receive commands. +TERM: Terminate the slave's error lockout to resume communications + after an error on the bus is detected. +D-POLL: Poll the slave to determine when it is no longer buy processing + a previous command. +I-POLL: Interrupt signal check. Master queries slave to see if any + interrupts are asserting. + +High fanout capability: +FSI buses can be chained together in 'hub' configurations to expand the +available communications channels and thus allow connetion to more slaves. + + +Typical implementation + + FSI master ----- slave with local FSI master (hub) ------- downstream slave + + +Each two line combination of a clock and data line is collectively referred +to as a 'FSI link'. Depending on hardware the primary FSI master may support +up to 64 links. Hub FSI masters can support at most 8 links. Total number +of supported slaves can grow exponentially depending on how many hubs are +placed in the path. Presently only two hubs in the chain are allowed but +in the future this may be expanded. + +The slave hardware logic responsible for decoding FSI master commands is +contained in a CFAM (Common Field replaceable unit Access Macro). Up to +4 slaves or CFAMs can be connected on each FSI link. CFAMs in addition +to the slave logic (or engine) can contain other functions that allow access +via FSI. Common additional functionality includes I2C masters, GPIO +controllers, UARTs, etc...