redonkable
/
remarkable-linux
1
0
Fork 0
Code Releases Activity

clk.txt: standardize document format 

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Use section/title markups;
- Use :Author: for authorship;
- Mark literals and literal blocks;
- Mark tables;
- Use ReST notation for footnotes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
zero-colors
Mauro Carvalho Chehab 2017-05-14 09:15:12 -03:00 committed by Jonathan Corbet
parent f1d8b71c5f
commit f68ac62d11
1 changed files with 106 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

189
Documentation/clk.txt
View File

@ -1,12 +1,16 @@
The Common Clk Framework ========================
Mike Turquette <mturquette@ti.com> The Common Clk Framework
========================
:Author: Mike Turquette <mturquette@ti.com>
This document endeavours to explain the common clk framework details, This document endeavours to explain the common clk framework details,
and how to port a platform over to this framework. It is not yet a and how to port a platform over to this framework. It is not yet a
detailed explanation of the clock api in include/linux/clk.h, but detailed explanation of the clock api in include/linux/clk.h, but
perhaps someday it will include that information. perhaps someday it will include that information.
Part 1 - introduction and interface split Introduction and interface split
================================
The common clk framework is an interface to control the clock nodes The common clk framework is an interface to control the clock nodes
available on various devices today. This may come in the form of clock available on various devices today. This may come in the form of clock
@ -35,10 +39,11 @@ is defined in struct clk_foo and pointed to within struct clk_core. This
allows for easy navigation between the two discrete halves of the common allows for easy navigation between the two discrete halves of the common
clock interface. clock interface.
Part 2 - common data structures and api Common data structures and api
==============================
Below is the common struct clk_core definition from Below is the common struct clk_core definition from
drivers/clk/clk.c, modified for brevity: drivers/clk/clk.c, modified for brevity::
struct clk_core { struct clk_core {
const char *name; const char *name;
@ -59,7 +64,7 @@ struct clk. That api is documented in include/linux/clk.h.
Platforms and devices utilizing the common struct clk_core use the struct Platforms and devices utilizing the common struct clk_core use the struct
clk_ops pointer in struct clk_core to perform the hardware-specific parts of clk_ops pointer in struct clk_core to perform the hardware-specific parts of
the operations defined in clk-provider.h: the operations defined in clk-provider.h::
struct clk_ops { struct clk_ops {
int (*prepare)(struct clk_hw *hw); int (*prepare)(struct clk_hw *hw);
@ -95,19 +100,20 @@ the operations defined in clk-provider.h:
struct dentry *dentry); struct dentry *dentry);
}; };
Part 3 - hardware clk implementations Hardware clk implementations
============================
The strength of the common struct clk_core comes from its .ops and .hw pointers The strength of the common struct clk_core comes from its .ops and .hw pointers
which abstract the details of struct clk from the hardware-specific bits, and which abstract the details of struct clk from the hardware-specific bits, and
vice versa. To illustrate consider the simple gateable clk implementation in vice versa. To illustrate consider the simple gateable clk implementation in
drivers/clk/clk-gate.c: drivers/clk/clk-gate.c::
struct clk_gate { struct clk_gate {
struct clk_hw hw; struct clk_hw hw;
void __iomem *reg; void __iomem *reg;
u8 bit_idx; u8 bit_idx;
... ...
}; };
struct clk_gate contains struct clk_hw hw as well as hardware-specific struct clk_gate contains struct clk_hw hw as well as hardware-specific
knowledge about which register and bit controls this clk's gating. knowledge about which register and bit controls this clk's gating.
@ -115,7 +121,7 @@ Nothing about clock topology or accounting, such as enable_count or
notifier_count, is needed here. That is all handled by the common notifier_count, is needed here. That is all handled by the common
framework code and struct clk_core. framework code and struct clk_core.
Let's walk through enabling this clk from driver code: Let's walk through enabling this clk from driver code::
struct clk *clk; struct clk *clk;
clk = clk_get(NULL, "my_gateable_clk"); clk = clk_get(NULL, "my_gateable_clk");
@ -123,70 +129,71 @@ Let's walk through enabling this clk from driver code:
clk_prepare(clk); clk_prepare(clk);
clk_enable(clk); clk_enable(clk);
The call graph for clk_enable is very simple: The call graph for clk_enable is very simple::
clk_enable(clk); clk_enable(clk);
clk->ops->enable(clk->hw); clk->ops->enable(clk->hw);
[resolves to...] [resolves to...]
clk_gate_enable(hw); clk_gate_enable(hw);
[resolves struct clk gate with to_clk_gate(hw)] [resolves struct clk gate with to_clk_gate(hw)]
clk_gate_set_bit(gate); clk_gate_set_bit(gate);
And the definition of clk_gate_set_bit: And the definition of clk_gate_set_bit::
static void clk_gate_set_bit(struct clk_gate *gate) static void clk_gate_set_bit(struct clk_gate *gate)
{ {
u32 reg; u32 reg;
reg = __raw_readl(gate->reg); reg = __raw_readl(gate->reg);
reg |= BIT(gate->bit_idx); reg |= BIT(gate->bit_idx);
writel(reg, gate->reg); writel(reg, gate->reg);
} }
Note that to_clk_gate is defined as: Note that to_clk_gate is defined as::
#define to_clk_gate(_hw) container_of(_hw, struct clk_gate, hw) #define to_clk_gate(_hw) container_of(_hw, struct clk_gate, hw)
This pattern of abstraction is used for every clock hardware This pattern of abstraction is used for every clock hardware
representation. representation.
Part 4 - supporting your own clk hardware Supporting your own clk hardware
================================
When implementing support for a new type of clock it is only necessary to When implementing support for a new type of clock it is only necessary to
include the following header: include the following header::
#include <linux/clk-provider.h> #include <linux/clk-provider.h>
To construct a clk hardware structure for your platform you must define To construct a clk hardware structure for your platform you must define
the following: the following::
struct clk_foo { struct clk_foo {
struct clk_hw hw; struct clk_hw hw;
... hardware specific data goes here ... ... hardware specific data goes here ...
}; };
To take advantage of your data you'll need to support valid operations To take advantage of your data you'll need to support valid operations
for your clk: for your clk::
struct clk_ops clk_foo_ops { struct clk_ops clk_foo_ops {
.enable = &clk_foo_enable; .enable = &clk_foo_enable;
.disable = &clk_foo_disable; .disable = &clk_foo_disable;
}; };
Implement the above functions using container_of: Implement the above functions using container_of::
#define to_clk_foo(_hw) container_of(_hw, struct clk_foo, hw) #define to_clk_foo(_hw) container_of(_hw, struct clk_foo, hw)
int clk_foo_enable(struct clk_hw *hw) int clk_foo_enable(struct clk_hw *hw)
{ {
struct clk_foo *foo; struct clk_foo *foo;
foo = to_clk_foo(hw); foo = to_clk_foo(hw);
... perform magic on foo ... ... perform magic on foo ...
return 0; return 0;
}; };
Below is a matrix detailing which clk_ops are mandatory based upon the Below is a matrix detailing which clk_ops are mandatory based upon the
hardware capabilities of that clock. A cell marked as "y" means hardware capabilities of that clock. A cell marked as "y" means
@ -194,41 +201,56 @@ mandatory, a cell marked as "n" implies that either including that
callback is invalid or otherwise unnecessary. Empty cells are either callback is invalid or otherwise unnecessary. Empty cells are either
optional or must be evaluated on a case-by-case basis. optional or must be evaluated on a case-by-case basis.
clock hardware characteristics .. table:: clock hardware characteristics
-----------------------------------------------------------
| gate | change rate | single parent | multiplexer | root | +----------------+------+-------------+---------------+-------------+------+
|------|-------------|---------------|-------------|------| | | gate | change rate | single parent | multiplexer | root |
.prepare | | | | | | +================+======+=============+===============+=============+======+
.unprepare | | | | | | |.prepare | | | | | |
| | | | | | +----------------+------+-------------+---------------+-------------+------+
.enable | y | | | | | |.unprepare | | | | | |
.disable | y | | | | | +----------------+------+-------------+---------------+-------------+------+
.is_enabled | y | | | | | +----------------+------+-------------+---------------+-------------+------+
| | | | | | |.enable | y | | | | |
.recalc_rate | | y | | | | +----------------+------+-------------+---------------+-------------+------+
.round_rate | | y [1] | | | | |.disable | y | | | | |
.determine_rate | | y [1] | | | | +----------------+------+-------------+---------------+-------------+------+
.set_rate | | y | | | | |.is_enabled | y | | | | |
| | | | | | +----------------+------+-------------+---------------+-------------+------+
.set_parent | | | n | y | n | +----------------+------+-------------+---------------+-------------+------+
.get_parent | | | n | y | n | |.recalc_rate | | y | | | |
| | | | | | +----------------+------+-------------+---------------+-------------+------+
.recalc_accuracy| | | | | | |.round_rate | | y [1]_ | | | |
| | | | | | +----------------+------+-------------+---------------+-------------+------+
.init | | | | | | |.determine_rate | | y [1]_ | | | |
----------------------------------------------------------- +----------------+------+-------------+---------------+-------------+------+
[1] either one of round_rate or determine_rate is required. |.set_rate | | y | | | |
+----------------+------+-------------+---------------+-------------+------+
+----------------+------+-------------+---------------+-------------+------+
|.set_parent | | | n | y | n |
+----------------+------+-------------+---------------+-------------+------+
|.get_parent | | | n | y | n |
+----------------+------+-------------+---------------+-------------+------+
+----------------+------+-------------+---------------+-------------+------+
|.recalc_accuracy| | | | | |
+----------------+------+-------------+---------------+-------------+------+
+----------------+------+-------------+---------------+-------------+------+
|.init | | | | | |
+----------------+------+-------------+---------------+-------------+------+
.. [1] either one of round_rate or determine_rate is required.
Finally, register your clock at run-time with a hardware-specific Finally, register your clock at run-time with a hardware-specific
registration function. This function simply populates struct clk_foo's registration function. This function simply populates struct clk_foo's
data and then passes the common struct clk parameters to the framework data and then passes the common struct clk parameters to the framework
with a call to: with a call to::
clk_register(...) clk_register(...)
See the basic clock types in drivers/clk/clk-*.c for examples. See the basic clock types in ``drivers/clk/clk-*.c`` for examples.
Part 5 - Disabling clock gating of unused clocks Disabling clock gating of unused clocks
=======================================
Sometimes during development it can be useful to be able to bypass the 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 default disabling of unused clocks. For example, if drivers aren't enabling
@ -239,7 +261,8 @@ are sorted out.
To bypass this disabling, include "clk_ignore_unused" in the bootargs to the To bypass this disabling, include "clk_ignore_unused" in the bootargs to the
kernel. kernel.
Part 6 - Locking Locking
=======
The common clock framework uses two global locks, the prepare lock and the The common clock framework uses two global locks, the prepare lock and the
enable lock. enable lock.