From patchwork Tue Apr 7 18:43:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 46846 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f70.google.com (mail-wg0-f70.google.com [74.125.82.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 1BB4B20553 for ; Tue, 7 Apr 2015 18:44:59 +0000 (UTC) Received: by wghm4 with SMTP id m4sf14713162wgh.2 for ; Tue, 07 Apr 2015 11:44:58 -0700 (PDT) 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=QdWxEBbTE1pE2PQ28WXHHokUsXv5KNZoAc73wQN7Gv8=; b=ifAfqBhzH2GOoB6dRpHmrOBmO/XzZP9w1/ZuuZrRGz421Su9T675DXiXaq49hr51zi faZJ+ht1tuWFP/pMDnS6mXRXU++P1FQLzb6sIOzqN4afwDnAevX0rlbnhN/+nn0+EgAV M5r+i2lWIg9+Z5EmJxsCrg0Ol1mEM/h7NGuACE3/m4zNIhhS20xPF0DnR+WWXrWAjhwN QRZW38Ypqq9K80UPiRldoJrYy4l2tSOD0I4qvFItkoKaEfb/HWFgkB3IoJhjCe0ZOQDb BP6U8HcDTs7AWCBcYPYKeIDA3i/a8IQfDLxxsVttZIVYBI+ee+iZATDBKcJ381k77MGO 60Aw== X-Gm-Message-State: ALoCoQkg0rvO2MNlWsP7gJoaTbW7fm126esoQ6XXtIgqV58X2Zi3rIaNgJ63P9s0X+9sKT+kLWDp X-Received: by 10.113.11.3 with SMTP id ee3mr2155396lbd.9.1428432298288; Tue, 07 Apr 2015 11:44:58 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.27.194 with SMTP id v2ls95779lag.59.gmail; Tue, 07 Apr 2015 11:44:58 -0700 (PDT) X-Received: by 10.112.170.132 with SMTP id am4mr19499354lbc.89.1428432298052; Tue, 07 Apr 2015 11:44:58 -0700 (PDT) Received: from mail-lb0-f176.google.com (mail-lb0-f176.google.com. [209.85.217.176]) by mx.google.com with ESMTPS id xu8si6764428lab.86.2015.04.07.11.44.57 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 07 Apr 2015 11:44:57 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.176 as permitted sender) client-ip=209.85.217.176; Received: by lbbqq2 with SMTP id qq2so41078796lbb.3 for ; Tue, 07 Apr 2015 11:44:57 -0700 (PDT) X-Received: by 10.152.8.78 with SMTP id p14mr17174904laa.19.1428432297903; Tue, 07 Apr 2015 11:44:57 -0700 (PDT) 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.67.65 with SMTP id l1csp597762lbt; Tue, 7 Apr 2015 11:44:56 -0700 (PDT) X-Received: by 10.68.69.45 with SMTP id b13mr39332676pbu.150.1428432295847; Tue, 07 Apr 2015 11:44:55 -0700 (PDT) Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id p2si12676102pdp.131.2015.04.07.11.44.54; Tue, 07 Apr 2015 11:44:55 -0700 (PDT) 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 S1753573AbbDGSou (ORCPT + 27 others); Tue, 7 Apr 2015 14:44:50 -0400 Received: from mail-wi0-f181.google.com ([209.85.212.181]:36453 "EHLO mail-wi0-f181.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753447AbbDGSoN (ORCPT ); Tue, 7 Apr 2015 14:44:13 -0400 Received: by wizk4 with SMTP id k4so28364867wiz.1 for ; Tue, 07 Apr 2015 11:44:12 -0700 (PDT) X-Received: by 10.194.95.4 with SMTP id dg4mr41567367wjb.81.1428432252419; Tue, 07 Apr 2015 11:44:12 -0700 (PDT) Received: from localhost.localdomain ([81.134.86.156]) by mx.google.com with ESMTPSA id di9sm8816057wib.16.2015.04.07.11.44.10 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 07 Apr 2015 11:44:11 -0700 (PDT) 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, geert@linux-m68k.org Subject: [PATCH v6 4/4] clk: dt: Introduce binding for always-on clock support Date: Tue, 7 Apr 2015 19:43:59 +0100 Message-Id: <1428432239-4114-5-git-send-email-lee.jones@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1428432239-4114-1-git-send-email-lee.jones@linaro.org> References: <1428432239-4114-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.217.176 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/clock-bindings.txt | 38 ++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/Documentation/devicetree/bindings/clock/clock-bindings.txt b/Documentation/devicetree/bindings/clock/clock-bindings.txt index 06fc6d5..daf3323 100644 --- a/Documentation/devicetree/bindings/clock/clock-bindings.txt +++ b/Documentation/devicetree/bindings/clock/clock-bindings.txt @@ -44,6 +44,44 @@ For example: clocks by index. The names should reflect the clock output signal names for the device. +clock-always-on: Some hardware 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 a platform can fail irrecoverably as a + result. Usually the only way to recover from these failures + is to reboot. + + To avoid either of these two scenarios from catastrophically + disabling an otherwise perfectly healthy running system, + clocks can be identified as always-on using this property + from inside a clocksource's node. + + This property is not to be abused. It is only to be used to + protect platforms from being crippled by gated clocks, not + as a convenience function to avoid using the framework + correctly inside device drivers. + + Expected values are hardware clock indices. If the + clock-indices property (see below) is used, then supplied + values must correspond to one of the listed identifiers. + Using the clock-indices example below, hardware clock <2> + is missing, therefore it is considered invalid to then + list clock <2> as an always-on clock. + +For example: + + oscillator { + #clock-cells = <1>; + clock-output-names = "ckil", "ckih"; + clock-always-on = <0>, <1>; + }; + +- this node defines a device with two clock outputs, just as in the + example above. The only difference being that 'ckil' and 'ckih' + are now identified as an always-on clocks, so the framework will + know to never attempt to gate them. + clock-indices: If the identifying number for the clocks in the node is not linear from zero, then this allows the mapping of identifiers into the clock-output-names array.