From patchwork Wed Feb 18 16:15:01 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 44788 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f71.google.com (mail-wg0-f71.google.com [74.125.82.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id A233A21573 for ; Wed, 18 Feb 2015 16:15:58 +0000 (UTC) Received: by mail-wg0-f71.google.com with SMTP id b13sf1449498wgh.2 for ; Wed, 18 Feb 2015 08:15:57 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:delivered-to:from:to:cc:subject :date:message-id:in-reply-to:references:sender:precedence:list-id :x-original-sender:x-original-authentication-results:mailing-list :list-post:list-help:list-archive:list-unsubscribe; bh=9ZVyj5sEZXn9hDxUUV98L2jpsM5WUdSRGyrjj/5VaDo=; b=dfm5jaknk0bQKVMIKOX1fWe1HjnPh/6rDA3w9q2B3RPm+dqrkTG0scEnbUdursDD3t saEgfGSpR6xw5c5BRDnPxwp8Y1yWPTQTnGqn70keSXv39aGl9pA7WitlyV3GpVYsS5xo mj2dSoCKRaroM7pbR0ZV2UwE8JQJ3TdN6KRdpXjVTjXP/7ItOwtlrM1ou1+2nh/+dUVE 6u0Afv44j5wWSvF8PEfqC34Tc9VeQ2y/L5w0bOaern6FOv8swLYa64JRJRBwxdObt2FI Z4fGp8Tj9Sb9IBkfCytQS8X1kfFwhmSGkcjQWilbRjR0PWdUVVwV90gLpGnARNvGFMlV YGsg== X-Gm-Message-State: ALoCoQkT1v/3kxQApoorsTVyaAX/jQIQuzy8XH27zkxs3JJlQT8o2VsJDKHk90dIjWTEe8HJqxtm X-Received: by 10.180.182.44 with SMTP id eb12mr471791wic.4.1424276157884; Wed, 18 Feb 2015 08:15:57 -0800 (PST) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.37.227 with SMTP id b3ls34246lak.58.gmail; Wed, 18 Feb 2015 08:15:57 -0800 (PST) X-Received: by 10.152.45.37 with SMTP id j5mr7360510lam.31.1424276157695; Wed, 18 Feb 2015 08:15:57 -0800 (PST) Received: from mail-la0-f42.google.com (mail-la0-f42.google.com. [209.85.215.42]) by mx.google.com with ESMTPS id f10si13601692lbv.119.2015.02.18.08.15.57 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 18 Feb 2015 08:15:57 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.42 as permitted sender) client-ip=209.85.215.42; Received: by labgq15 with SMTP id gq15so2173250lab.6 for ; Wed, 18 Feb 2015 08:15:57 -0800 (PST) X-Received: by 10.112.56.139 with SMTP id a11mr132830lbq.36.1424276157505; Wed, 18 Feb 2015 08:15:57 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.35.133 with SMTP id h5csp2948411lbj; Wed, 18 Feb 2015 08:15:56 -0800 (PST) X-Received: by 10.69.31.170 with SMTP id kn10mr218244pbd.16.1424276155696; Wed, 18 Feb 2015 08:15:55 -0800 (PST) Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id h6si1449316pdm.58.2015.02.18.08.15.54; Wed, 18 Feb 2015 08:15:55 -0800 (PST) Received-SPF: none (google.com: linux-kernel-owner@vger.kernel.org does not designate permitted sender hosts) client-ip=209.132.180.67; Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753023AbbBRQPu (ORCPT + 28 others); Wed, 18 Feb 2015 11:15:50 -0500 Received: from mail-we0-f175.google.com ([74.125.82.175]:39295 "EHLO mail-we0-f175.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752848AbbBRQPP (ORCPT ); Wed, 18 Feb 2015 11:15:15 -0500 Received: by wesx3 with SMTP id x3so2109733wes.6 for ; Wed, 18 Feb 2015 08:15:13 -0800 (PST) X-Received: by 10.180.95.97 with SMTP id dj1mr1455792wib.43.1424276113699; Wed, 18 Feb 2015 08:15:13 -0800 (PST) Received: from localhost.localdomain (host109-148-233-190.range109-148.btcentralplus.com. [109.148.233.190]) by mx.google.com with ESMTPSA id dx11sm30384677wjb.23.2015.02.18.08.15.12 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 18 Feb 2015 08:15:12 -0800 (PST) From: Lee Jones To: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org Cc: lee.jones@linaro.org, kernel@stlinux.com, mturquette@linaro.org, sboyd@codeaurora.org, devicetree@vger.kernel.org Subject: [PATCH v2 4/4] clk: dt: Introduce always-on clock domain documentation Date: Wed, 18 Feb 2015 16:15:01 +0000 Message-Id: <1424276101-30137-5-git-send-email-lee.jones@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1424276101-30137-1-git-send-email-lee.jones@linaro.org> References: <1424276101-30137-1-git-send-email-lee.jones@linaro.org> Sender: linux-kernel-owner@vger.kernel.org Precedence: list List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: lee.jones@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.42 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , Signed-off-by: Lee Jones --- .../devicetree/bindings/clock/clk-domain.txt | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 Documentation/devicetree/bindings/clock/clk-domain.txt diff --git a/Documentation/devicetree/bindings/clock/clk-domain.txt b/Documentation/devicetree/bindings/clock/clk-domain.txt new file mode 100644 index 0000000..b86772f5 --- /dev/null +++ b/Documentation/devicetree/bindings/clock/clk-domain.txt @@ -0,0 +1,35 @@ +Always-on Clock Domain + +Some hardware is contains bunches of clocks which must never be +turned off. If drivers a) fail to obtain a reference to any of +these or b) give up a previously obtained reference during suspend, +the common clk framework will attempt to disable them and the +hardware can fail irrecoverably. Usually, the only way to recover +from these failures is to restart. + +To avoid either of these two scenarios from catastrophically +disabling an otherwise perfectly healthy running system, we have +implemented a clock domain where clocks are consumed and references +are taken, thus preventing them from being shut down by the +framework. + +We use the generic clock bindings found in: + Documentation/devicetree/bindings/clock/clock-bindings.txt + +Required properties: +- compatible : Must be "always-on-clk-domain" + +Example: + +clk-domain { + compatible = "always-on-clk-domain"; + clocks = <&clk_s_c0_flexgen CLK_EXT2F_A9>, + <&clk_s_c0_flexgen CLK_COMPO_DVP>, + <&clk_s_c0_flexgen CLK_MMC_1>, + <&clk_s_c0_flexgen CLK_ICN_SBC>, + <&clk_s_c0_flexgen CLK_ICN_LMI>, + <&clk_s_c0_flexgen CLK_ICN_CPU>, + <&clk_s_c0_flexgen CLK_TX_ICN_DMU>, + <&clk_s_a0_flexgen CLK_IC_LMI0>, + <&clk_m_a9>; +};