From patchwork Tue Jun 23 18:00:01 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Moritz Fischer X-Patchwork-Id: 6662621 Return-Path: X-Original-To: patchwork-linux-arm@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 992CDC05AC for ; Tue, 23 Jun 2015 18:04:59 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 9384A20685 for ; Tue, 23 Jun 2015 18:04:58 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.9]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B120D20672 for ; Tue, 23 Jun 2015 18:04:57 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.80.1 #2 (Red Hat Linux)) id 1Z7SW0-0003WF-EK; Tue, 23 Jun 2015 18:01:44 +0000 Received: from mail-pa0-f41.google.com ([209.85.220.41]) by bombadil.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1Z7SV6-0002ew-TF for linux-arm-kernel@lists.infradead.org; Tue, 23 Jun 2015 18:00:50 +0000 Received: by padev16 with SMTP id ev16so11638324pad.0 for ; Tue, 23 Jun 2015 11:00:25 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=5zg4Ja6Q1aAwfdxMTTxCdufdIcQiiXrxGY0CsA7UlV4=; b=ebylL4wZJwAORS0V1IZZCILkQr9KcMxUUnh+qbUpJsYwhmVToeoN84uwnXBrho7xyF BdQmfJ6Q+mxJXlG5yUZhZ24ftkRtKjuCefTFf7j/hamNAt7q8hTKFVkHdFzppU/jx4Yl f3TUhwH1s9sdskSb93VZIqikkyMi7FRXOw6wNQ9ZcJ/vBfJZtR4zNELCfYG//RsHlWa/ a77aQ1CkNPYG1KiXqMZCI88QjPZcZGOxmtKcPjBSlq2btxTco7GeMi/IRgDMjZssqHrb m+nA1irw19qaocI5petV+MD7l+dj//G12jsWkOniZzo5VKAWX+rfbzA9nSQ5w+3szba/ 0Jlw== X-Gm-Message-State: ALoCoQn4HTcDFplidyVZkVIMGi8rq2cIgy0KFvVxpLz9QeCbgEy3kZ2OPpiPQdshSnyHOJgAnfN5 X-Received: by 10.70.94.69 with SMTP id da5mr10319532pdb.83.1435082425313; Tue, 23 Jun 2015 11:00:25 -0700 (PDT) Received: from fenrir.amer.corp.natinst.com (209-234-137-234.static.twtelecom.net. [209.234.137.234]) by mx.google.com with ESMTPSA id dc8sm24001581pdb.23.2015.06.23.11.00.22 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 23 Jun 2015 11:00:23 -0700 (PDT) From: Moritz Fischer To: jassisinghbrar@gmail.com Subject: [PATCHv5 1/2] dts: Adding docs for Xilinx LogiCORE IP mailbox driver. Date: Tue, 23 Jun 2015 11:00:01 -0700 Message-Id: <1435082402-29239-2-git-send-email-moritz.fischer@ettus.com> X-Mailer: git-send-email 2.4.2 In-Reply-To: <1435082402-29239-1-git-send-email-moritz.fischer@ettus.com> References: <1435082402-29239-1-git-send-email-moritz.fischer@ettus.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20150623_110049_078512_7BA70C5B X-CRM114-Status: GOOD ( 15.42 ) X-Spam-Score: -2.6 (--) Cc: mark.rutland@arm.com, devicetree@vger.kernel.org, Moritz Fischer , arnd@arndb.de, pawel.moll@arm.com, ijc+devicetree@hellion.org.uk, gregkh@linuxfoundation.org, mchehab@osg.samsung.com, linux-kernel@vger.kernel.org, michal.simek@xilinx.com, jingoohan1@gmail.com, robh+dt@kernel.org, linux-arm-kernel@lists.infradead.org, galak@codeaurora.org, joe@perches.com, akpm@linux-foundation.org, soren.brinkmann@xilinx.com X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.18-1 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Spam-Status: No, score=-5.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Changes from v4: - Changed mbox cells property from 1 to 0 - Fixed interrupt property Changes from v3: - Changed reg size to 0x100 Changes from v2: - Addressed Michal's stylistic comments - Fixed typo in compatible string Changes from v1: - Added common clock framework support Changes from v0: - Fixed example bindings Signed-off-by: Moritz Fischer Acked-by: Michal Simek --- .../devicetree/bindings/mailbox/xilinx-mailbox.txt | 44 ++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt diff --git a/Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt b/Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt new file mode 100644 index 0000000..269c026 --- /dev/null +++ b/Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt @@ -0,0 +1,44 @@ +Xilinx Mailbox Driver +===================== + +Required properties: +- compatible : "xlnx,mailbox-2.1". +- reg : physical base address of the mailbox and length of + memory mapped region. +- #mbox-cells : common mailbox binding property to identify the number + of cells required for the mailbox specifier, should be 1 +- clocks : phandle to clock provider +- clock-names : must be 'mbox' + +Optional properties: +- interrupt-parent : interrupt source phandle +- interrupts : interrupt number, The interrupt specifier format + depends on the interrupt controller parent. + +Example: + mbox: mailbox@40400000 { + compatible = "xlnx,mailbox-2.1"; + reg = <0x40400000 0x100>; + interrupt-parent = <&intc>; + interrupts = <0 32 1>; + #mbox-cells = <0>; + clocks = <&clkc 15>; + clock-names = "mbox"; + }; + +Mailbox client +=============== +"mboxes" and the optional "mbox-names" (please see +Documentation/devicetree/bindings/mailbox/mailbox.txt for details). Each value +of the mboxes property should contain a phandle to the mailbox controller +device node and second argument is the channel index. It must be 0 (hardware +support only one channel). The equivalent "mbox-names" property value can be +used to give a name to the communication channel to be used by the client user. + +Example: + mclient0: mclient0@400 { + compatible = "client-1.0"; + reg = <0x400 0x10>; + mbox-names = "mbox"; + mboxes = <&mbox 0>; + };