From patchwork Mon Jun 24 19:01:27 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Loc Ho X-Patchwork-Id: 2773061 Return-Path: X-Original-To: patchwork-linux-arm@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 9B0FB9F245 for ; Mon, 24 Jun 2013 19:05:02 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 486B12023A for ; Mon, 24 Jun 2013 19:05:01 +0000 (UTC) Received: from casper.infradead.org (casper.infradead.org [85.118.1.10]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 086CB20234 for ; Mon, 24 Jun 2013 19:05:00 +0000 (UTC) Received: from merlin.infradead.org ([2001:4978:20e::2]) by casper.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1UrC2k-0005Xw-QZ; Mon, 24 Jun 2013 19:03:16 +0000 Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.80.1 #2 (Red Hat Linux)) id 1UrC2L-000282-80; Mon, 24 Jun 2013 19:02:49 +0000 Received: from exprod5og119.obsmtp.com ([64.18.0.189]) by merlin.infradead.org with smtp (Exim 4.80.1 #2 (Red Hat Linux)) id 1UrC1q-000250-WA for linux-arm-kernel@lists.infradead.org; Mon, 24 Jun 2013 19:02:21 +0000 Received: from mail-pa0-f42.google.com ([209.85.220.42]) (using TLSv1) by exprod5ob119.postini.com ([64.18.4.12]) with SMTP ID DSNKUciXpTksiztdsq/sHQDtqa3ItgA3I0f0@postini.com; Mon, 24 Jun 2013 12:02:18 PDT Received: by mail-pa0-f42.google.com with SMTP id rl6so11487954pac.15 for ; Mon, 24 Jun 2013 12:01:57 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references :x-gm-message-state; bh=ct77CL0pcZcq33BTBif9YZsCmpwJ4dBsUy95UkD7rQI=; b=LKgJ5HWFDVaPtVNfG9NP2q/qaa15Sh2TeoBqmbi0jRbx8XrgD4BP4rt+0yvdQ84cmo 8We9DoQJgEF4Zm1sXnPLKo6boki1g1i1TNWmTwgxGUJs1vPTXDLpm9kcaMtpvmb2Nz7a PPnGf8oL+cYgfiX+uNaBl/eHVmSsxEFvt3LHGTaXjLz3HrnP4LapxGCrhGQYWSnjkrsx P/zH/xqGP7tP3XGkiytwEO0+fRhtFu20W+HwFq79AIX8CNYR5vj9drHwC7VbXfoYm8Ne xyDijfx83ezbd3K9lmst1g0zxi5u/GE2mNl1hafp7Uw3y4siusf7YVFffwCnKpb/L3Ck GYmA== X-Received: by 10.66.163.99 with SMTP id yh3mr28717645pab.22.1372100517508; Mon, 24 Jun 2013 12:01:57 -0700 (PDT) X-Received: by 10.66.163.99 with SMTP id yh3mr28717636pab.22.1372100517429; Mon, 24 Jun 2013 12:01:57 -0700 (PDT) Received: from localhost ([198.137.200.11]) by mx.google.com with ESMTPSA id bs3sm19312111pbc.42.2013.06.24.12.01.55 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 24 Jun 2013 12:01:56 -0700 (PDT) From: Loc Ho To: mark.rutland@arm.com Subject: [PATCH v3 3/3] Documentation: Add documentation for APM X-Gene clock binding Date: Mon, 24 Jun 2013 13:01:27 -0600 Message-Id: <1372100487-9367-4-git-send-email-lho@apm.com> X-Mailer: git-send-email 1.5.5 In-Reply-To: <1372100487-9367-3-git-send-email-lho@apm.com> References: <1372100487-9367-1-git-send-email-lho@apm.com> <1372100487-9367-2-git-send-email-lho@apm.com> <1372100487-9367-3-git-send-email-lho@apm.com> X-Gm-Message-State: ALoCoQmCq4Y/STZHnpjR89c7wHCrf7NZFSY1KBxKwV4a9JuGnNWgMpufh7CjIpCD4t6/zcXq2gGJO1GFY7fu30SlhdtBGlojH6b/XWXGo0YipNlNH1lX9homI2kUR5+l8YSaVUdOMcejzcnAL+TDB30JvpeYmbVhKG33Z+BAqjf1tHOehWgZf//FadKe1Mt7T2atS3lUWh4m X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20130624_150219_277849_DBFC81E6 X-CRM114-Status: GOOD ( 12.18 ) X-Spam-Score: -1.9 (-) Cc: fkan@apm.com, mturquette@linaro.org, Catalin.Marinas@arm.com, Loc Ho , ksankaran@apm.com, vkale@apm.com, linux-arm-kernel@lists.infradead.org X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.15 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.3 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 Documentation: Add documentation for APM X-Gene clock binding with PLL and device clocks. Signed-off-by: Loc Ho Signed-off-by: Kumar Sankaran Signed-off-by: Vinayak Kale Signed-off-by: Feng Kan --- Documentation/devicetree/bindings/clock/xgene.txt | 90 +++++++++++++++++++++ 1 files changed, 90 insertions(+), 0 deletions(-) create mode 100644 Documentation/devicetree/bindings/clock/xgene.txt diff --git a/Documentation/devicetree/bindings/clock/xgene.txt b/Documentation/devicetree/bindings/clock/xgene.txt new file mode 100644 index 0000000..4f864bd --- /dev/null +++ b/Documentation/devicetree/bindings/clock/xgene.txt @@ -0,0 +1,90 @@ +Device Tree Clock bindings for APM X-Gene + +This binding uses the common clock binding[1]. + +[1] Documentation/devicetree/bindings/clock/clock-bindings.txt + +Required properties: +- compatible : shall be one of the following: + "apm,xgene-socpll-clock" - for a X-Gene SoC PLL clock + "apm,xgene-pcppll-clock" - for a X-Gene PCP PLL clock + "apm,xgene-device-clock" - for a X-Gene device clock + +Required properties for SoC or PCP PLL clocks: +- reg : shall be the physical PLL register address for the pll clock. +- clocks : shall be the input parent clock phandle for the clock. This should + be the reference clock. +- #clock-cells : shall be set to 1. +- clock-output-names : shall be the name of the PLL referenced by derive + clock. +Optional properties for PLL clocks: +- clock-names : shall be the name of the PLL. If missing, use the device name. + +Required properties for device clocks: +- reg : shall be the physical CSR reset address base and physical CSR divider + address base. If one does not exist, specify 0 for address and 0 for + size. +- clocks : shall be the input parent clock phandle for the clock. +- #clock-cells : shall be set to 1. +- clock-output-names : shall be the name of the device referenced. +Optional properties for device clocks: +- clock-names : shall be the name of the device clock. If missing, use the + device name. +- flags : Any clock flags. ie. use 0x8 to leave clock un-touch if not + referenced. Default is 0. +- csr-offset : Offset to the CSR reset register from the reset address base. + Default is 0. +- csr-mask : CSR reset mask bit. Default is 0xF. +- enable-offset : Offset to the enable register from the reset address base. + Default is 0x8. +- enable-mask : CSR enable mask bit. Default is 0xF. +- divider-offset : Offset to the divider CSR register from the divider base. + Default is 0x0. +- divider-width : Width of the divider register. Default is 0. +- divider-shift : Bit shift of the divider register. Default is 0. + +For example: + + pcppll: pcppll@17000100 { + compatible = "apm,xgene-pcppll-clock"; + #clock-cells = <1>; + clocks = <&refclk 0>; + clock-names = "pcppll"; + reg = <0x0 0x17000100 0x0 0x1000>; + clock-output-names = "pcppll"; + type = <0>; + }; + + socpll: socpll@17000120 { + compatible = "apm,xgene-socpll-clock"; + #clock-cells = <1>; + clocks = <&refclk 0>; + clock-names = "socpll"; + reg = <0x0 0x17000120 0x0 0x1000>; + clock-output-names = "socpll"; + type = <1>; + }; + + qmlclk: qmlclk { + compatible = "apm,xgene-device-clock"; + #clock-cells = <1>; + clocks = <&socplldiv2 0>; + clock-names = "qmlclk"; + reg = <0x0 0x1703C000 0x0 0x1000 + 0x0 0x00000000 0x0 0x0000>; + clock-output-names = "qmlclk"; + }; + + ethclk: ethclk { + compatible = "apm,xgene-device-clock"; + #clock-cells = <1>; + clocks = <&socplldiv2 0>; + clock-names = "ethclk"; + reg = <0x0 0x00000000 0x0 0x0000 + 0x0 0x17000000 0x0 0x1000>; + divider-offset = <0x238>; + divider-width = <0x9>; + divider-shift = <0x0>; + clock-output-names = "ethclk"; + }; +