From patchwork Mon May 11 10:20:06 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Thompson X-Patchwork-Id: 48233 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 C862421550 for ; Mon, 11 May 2015 10:20:24 +0000 (UTC) Received: by wgiv13 with SMTP id v13sf37881665wgi.3 for ; Mon, 11 May 2015 03:20:24 -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:x-original-sender:x-original-authentication-results :precedence:mailing-list:list-id:list-post:list-help:list-archive :list-unsubscribe; bh=JXnMzfNBR7hLYuymFZVD3/VgKrCaPaise11+q2SGTJU=; b=AQw3oJ6Q34Z8qlbYMR3o0jE9NCBRNxhAxR5YdOpSLdKuCGtCNhPheZ5RykcMRuafxW WuSJ8lPMZepyzb/Phu2zQ3c+ikCl9WFlGcovWWQ07Uuj4U1i/F0bggMwygXhwQtvZULS KXL0IXbAbUJfL7hwTY0ZTbLypBt17jwXRpRipR2i16k+ufc3/tqjA6OCreVN6OVq4MHK 0BIT/fI0IwALKCLE4AMu9EgEXQzd+QKLuWmoCkLRLt7FdwhM4ZReb/c4pxjqbKOVZyY3 uab3h05bs2sqFFWMTVoyZJNTORkN+i85LxtxnG1Y0tmS7N+1aUSuMyF4rAPuJScp3UOJ D+eg== X-Gm-Message-State: ALoCoQkxmyur6Pe+HSFlzqx9XjOVMJQaIsLEXN3vjAeT/kzeHl4z+qyBTmZuQFEo32rCXlF56B2G X-Received: by 10.112.219.200 with SMTP id pq8mr7006441lbc.7.1431339624048; Mon, 11 May 2015 03:20:24 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.121.98 with SMTP id lj2ls581709lab.94.gmail; Mon, 11 May 2015 03:20:23 -0700 (PDT) X-Received: by 10.153.7.104 with SMTP id db8mr7680364lad.124.1431339623908; Mon, 11 May 2015 03:20:23 -0700 (PDT) Received: from mail-la0-f54.google.com (mail-la0-f54.google.com. [209.85.215.54]) by mx.google.com with ESMTPS id k6si8107079lam.65.2015.05.11.03.20.23 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 11 May 2015 03:20:23 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) client-ip=209.85.215.54; Received: by labbd9 with SMTP id bd9so89862612lab.2 for ; Mon, 11 May 2015 03:20:23 -0700 (PDT) X-Received: by 10.152.2.227 with SMTP id 3mr7261383lax.73.1431339623822; Mon, 11 May 2015 03:20:23 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patches@linaro.org Received: by 10.112.108.230 with SMTP id hn6csp1418487lbb; Mon, 11 May 2015 03:20:23 -0700 (PDT) X-Received: by 10.180.206.229 with SMTP id lr5mr19483906wic.86.1431339623140; Mon, 11 May 2015 03:20:23 -0700 (PDT) Received: from mail-wg0-f49.google.com (mail-wg0-f49.google.com. [74.125.82.49]) by mx.google.com with ESMTPS id n6si21336447wja.2.2015.05.11.03.20.22 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 11 May 2015 03:20:23 -0700 (PDT) Received-SPF: pass (google.com: domain of daniel.thompson@linaro.org designates 74.125.82.49 as permitted sender) client-ip=74.125.82.49; Received: by wgic8 with SMTP id c8so96890045wgi.1 for ; Mon, 11 May 2015 03:20:22 -0700 (PDT) X-Received: by 10.180.20.12 with SMTP id j12mr18925254wie.4.1431339622854; Mon, 11 May 2015 03:20:22 -0700 (PDT) Received: from wychelm.lan (cpc4-aztw19-0-0-cust71.18-1.cable.virginm.net. [82.33.25.72]) by mx.google.com with ESMTPSA id r9sm22084155wjo.26.2015.05.11.03.20.21 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 11 May 2015 03:20:21 -0700 (PDT) From: Daniel Thompson To: Jonathan Corbet Cc: Daniel Thompson , linux-doc@vger.kernel.org, linux-clk@vger.kernel.org, linux-kernel@vger.kernel.org, patches@linaro.org, linaro-kernel@lists.linaro.org, Michael Turquette , Stephen Boyd Subject: [PATCH] clk: Update docs after removal of clk-private.h Date: Mon, 11 May 2015 11:20:06 +0100 Message-Id: <1431339606-16038-1-git-send-email-daniel.thompson@linaro.org> X-Mailer: git-send-email 2.1.0 X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: daniel.thompson@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.54 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Precedence: list Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org List-ID: X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , Currently Documentation/clk.txt describes an obsolete techinique to statically define struct clk objects. This capability was removed by b09d6d991025("clk: remove clk-private.h") and is no longer supported. The documentation describing the feature should be removed. Signed-off-by: Daniel Thompson Cc: Jonathan Corbet Cc: Michael Turquette Cc: Stephen Boyd --- Documentation/clk.txt | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) -- 2.1.0 diff --git a/Documentation/clk.txt b/Documentation/clk.txt index 0e4f90aa1c13..f463bdc37f88 100644 --- a/Documentation/clk.txt +++ b/Documentation/clk.txt @@ -230,30 +230,7 @@ clk_register(...) See the basic clock types in drivers/clk/clk-*.c for examples. - Part 5 - static initialization of clock data - -For platforms with many clocks (often numbering into the hundreds) it -may be desirable to statically initialize some clock data. This -presents a problem since the definition of struct clk should be hidden -from everyone except for the clock core in drivers/clk/clk.c. - -To get around this problem struct clk's definition is exposed in -include/linux/clk-private.h along with some macros for more easily -initializing instances of the basic clock types. These clocks must -still be initialized with the common clock framework via a call to -__clk_init. - -clk-private.h must NEVER be included by code which implements struct -clk_ops callbacks, nor must it be included by any logic which pokes -around inside of struct clk at run-time. To do so is a layering -violation. - -To better enforce this policy, always follow this simple rule: any -statically initialized clock data MUST be defined in a separate file -from the logic that implements its ops. Basically separate the logic -from the data and all is well. - - Part 6 - Disabling clock gating of unused clocks + Part 5 - Disabling clock gating of unused clocks Sometimes during development it can be useful to be able to bypass the default disabling of unused clocks. For example, if drivers aren't enabling @@ -264,7 +241,7 @@ are sorted out. To bypass this disabling, include "clk_ignore_unused" in the bootargs to the kernel. - Part 7 - Locking + Part 6 - Locking The common clock framework uses two global locks, the prepare lock and the enable lock.