Ursprünglich ist es Teil des Quellcodes des Linux-Kernels, daher wird es als GPLv2 behandelt (Anerkennung, dass es sein sollte).
https://www.kernel.org/doc/html/latest/index.html
Licensing documentation
The following describes the license of the Linux kernel source code (GPLv2), how to properly mark the license of individual files in the source tree, as well as links to the full license text.
https://www.kernel.org/doc/html/latest/process/license-rules.html#kernel-licensing
https://www.kernel.org/doc/html/latest/driver-api/clk.html
The Common Clk Framework
Author: Mike Turquette [email protected]
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 detailed explanation of the clock api in
include/linux/clk.h, but perhaps someday it will include that information.
Dieses Dokument beschreibt das allgemeine clk-Framework und wie dieses Framework plattformübergreifend einzigartig gemacht werden kann. Es gibt keine detaillierte Beschreibung der Clock-API in "include / linux / clk.h", aber es wird wahrscheinlich einige enthalten.
Introduction and interface split
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 gating, rate adjustment, muxing or other operations. This framework is enabled with the CONFIG_COMMON_CLK option.
Das gemeinsame clk-Framework ist die Schnittstelle, die die Taktknoten steuert, die heute auf verschiedenen Geräten wirksam sind. Es bietet Clock Gating, Ratenanpassung, Muxing oder andere Operationen. Dieses Rahmenwerk wird durch die Option CONFIG_COMMON_CLK aktiviert.
The interface itself is divided into two halves, each shielded from the details of its counterpart.
Diese Schnittstelle selbst kann grob in zwei Teile unterteilt werden. Jeder schützt vor den Details des entsprechenden Teils.
First is the common definition of struct clk which unifies the framework-level accounting and infrastructure that has traditionally been duplicated across a variety of platforms.
Die erste ist eine gebräuchliche Definition von clk-Strukturen. Die clk-Struktur integriert die Buchhaltung und Infrastruktur auf Framework-Ebene, die traditionell auf verschiedenen Plattformen repliziert wurden.
Second is a common implementation of the clk.h api, defined in
drivers/clk/clk.c.
Die zweite ist eine übliche Implementierung der API "clk.h", die in "drivers / clk / clk.c" definiert ist.
Finally there is struct clk_ops, whose operations are invoked by the clk api implementation.
Schließlich gibt es eine clk_ops-Struktur, die von der clk-API-Implementierung aufgerufen wird.
The second half of the interface is comprised of the hardware-specific callbacks registered with struct clk_ops and the corresponding hardware-specific structures needed to model a particular clock.
Die zweite Hälfte der Schnittstelle besteht aus hardwarespezifischen Rückrufen, die in der Struktur clk_ops registriert sind, und den entsprechenden hardwarespezifischen Strukturen, die zum Modellieren einer bestimmten Uhr erforderlich sind.
For the remainder of this document any reference to a callback in struct clk_ops, such as .enable or .set_rate, implies the hardware-specific implementation of that code.
Der Rest dieses Dokuments verweist auf einige der in der Struktur clk_ops enthaltenen Rückrufe. Bedeutet hardwarespezifische Implementierungen wie .enable und .set_rate.
Likewise, references to struct clk_foo serve as a convenient shorthand for the implementation of the hardware-specific bits for the hypothetical "foo" hardware.
In ähnlicher Weise dient die Struktur clk_foo als bequeme Abkürzung für hardwarespezifische Implementierungen von fiktiver "foo" -Hardware.
Tying the two halves of this interface together is struct clk_hw, which is defined in struct clk_foo and pointed to within struct clk_core.
Die Struktur clk_hw integriert die beiden Hälften dieser Schnittstelle. Es ist in der Struktur clk_foo definiert und wird in der Struktur clk_core angezeigt.
This allows for easy navigation between the two discrete halves of the common clock interface.
Dies erleichtert das Navigieren zwischen den beiden getrennten Hälften der gemeinsamen Taktschnittstelle.
Common data structures and api
Below is the common struct clk_core definition from
drivers/clk/clk.c, modified for brevity::
Unten finden Sie die allgemeine clk_core-Struktur, die in "drivers / clk / clk.c" definiert ist. Es wurde der Kürze halber modifiziert.
struct clk_core {
const char *name;
const struct clk_ops *ops;
struct clk_hw *hw;
struct module *owner;
struct clk_core *parent;
const char **parent_names;
struct clk_core **parents;
u8 num_parents;
u8 new_parent_index;
...
};
The members above make up the core of the clk tree topology. The clk api itself defines several driver-facing functions which operate on struct clk. That api is documented in
include/linux/clk.h.
Die oben genannten Elemente bilden den Kern der clk-Baumtopologie. Die clk-API selbst definiert einige Funktionen der Treiberschnittstelle zur Steuerung der clk-Struktur. Diese API ist unter "include / linux / clk.h" dokumentiert.
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 the operations defined in clk-provider.h::
Plattformen und Gerätetreiber, die die gemeinsame clk_core-Struktur verwenden, verwenden Zeiger auf die clk_ops-Struktur innerhalb der clk_core-Struktur, um eine hardwarespezifische Verarbeitung durchzuführen, wie in clk-providor.h definiert.
struct clk_ops {
int (*prepare)(struct clk_hw *hw);
void (*unprepare)(struct clk_hw *hw);
int (*is_prepared)(struct clk_hw *hw);
void (*unprepare_unused)(struct clk_hw *hw);
int (*enable)(struct clk_hw *hw);
void (*disable)(struct clk_hw *hw);
int (*is_enabled)(struct clk_hw *hw);
void (*disable_unused)(struct clk_hw *hw);
unsigned long (*recalc_rate)(struct clk_hw *hw,
unsigned long parent_rate);
long (*round_rate)(struct clk_hw *hw,
unsigned long rate,
unsigned long *parent_rate);
int (*determine_rate)(struct clk_hw *hw,
struct clk_rate_request *req);
int (*set_parent)(struct clk_hw *hw, u8 index);
u8 (*get_parent)(struct clk_hw *hw);
int (*set_rate)(struct clk_hw *hw,
unsigned long rate,
unsigned long parent_rate);
int (*set_rate_and_parent)(struct clk_hw *hw,
unsigned long rate,
unsigned long parent_rate,
u8 index);
unsigned long (*recalc_accuracy)(struct clk_hw *hw,
unsigned long parent_accuracy);
int (*get_phase)(struct clk_hw *hw);
int (*set_phase)(struct clk_hw *hw, int degrees);
void (*init)(struct clk_hw *hw);
void (*debug_init)(struct clk_hw *hw,
struct dentry *dentry);
};
Hardware clk implementations
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 vice versa.
Die Stärke der gemeinsamen clk_core-Struktur besteht darin, dass sie selbst eine Abstraktion für hardwarespezifische Bits durch .ops- und .hw-Zeiger ist. Das Gegenteil ist auch der Fall.
To illustrate consider the simple gateable clk implementation in
drivers/clk/clk-gate.c::
Veranschaulicht das einfache Clock-Gating, das in "drivers / clk / clk-gate.c" implementiert ist.
struct clk_gate {
struct clk_hw hw;
void __iomem *reg;
u8 bit_idx;
...
};
struct clk_gate contains struct clk_hw hw as well as hardware-specific knowledge about which register and bit controls this clk's gating.
Die clk_gate-Struktur enthält die clk_hw-Struktur als hardwarespezifisches Wissen über die Register und Bits zur Steuerung des Gatings der Uhr.
Nothing about clock topology or accounting, such as enable_count or notifier_count, is needed here. That is all handled by the common framework code and struct clk_core.
Es ist keine Uhrentopologie oder -abrechnung erforderlich, z. B. enable_count oder notifier_count. Dies alles wird durch einen gemeinsamen Framework-Code und eine gemeinsame clk_core-Struktur erledigt.
Let's walk through enabling this clk from driver code::
Lassen Sie uns die Prozedur überprüfen, um diese clk-Struktur aus dem Treibercode zu aktivieren.
struct clk *clk;
clk = clk_get(NULL, "my_gateable_clk");
clk_prepare(clk);
clk_enable(clk);
The call graph for clk_enable is very simple::
Das Aufrufdiagramm clk_enable ist sehr übersichtlich.
clk_enable(clk);
clk->ops->enable(clk->hw);
[resolves to...]
clk_gate_enable(hw);
[resolves struct clk gate with to_clk_gate(hw)]
clk_gate_set_bit(gate);
And the definition of clk_gate_set_bit::
Die Definition von clk_get_set_bit lautet wie folgt.
static void clk_gate_set_bit(struct clk_gate *gate)
{
u32 reg;
reg = __raw_readl(gate->reg);
reg |= BIT(gate->bit_idx);
writel(reg, gate->reg);
}
Note that to_clk_gate is defined as::
Wobei to_clk_gate wie folgt definiert ist:
#define to_clk_gate(_hw) container_of(_hw, struct clk_gate, hw)
This pattern of abstraction is used for every clock hardware representation.
Dieses Abstraktionsmuster wird in allen Hardware-Darstellungen der Uhr verwendet.
Supporting your own clk hardware
When implementing support for a new type of clock it is only necessary to include the following header::
Fügen Sie bei der Implementierung zur Unterstützung des neuen Uhrentyps einfach den folgenden Header ein.
#include <linux/clk-provider.h>
To construct a clk hardware structure for your platform you must define the following::
Um die clk-Hardwarestruktur für Ihre Plattform zu konfigurieren, benötigen Sie die folgenden Definitionen:
struct clk_foo {
struct clk_hw hw;
... hardware specific data goes here ...
};
To take advantage of your data you'll need to support valid operations for your clk::
Um die Vorteile der Verwendung von Daten nutzen zu können, benötigt clk Unterstützung für die richtigen Steuerelemente.
struct clk_ops clk_foo_ops = {
.enable = &clk_foo_enable,
.disable = &clk_foo_disable,
};
Implement the above functions using container_of::
Implementieren Sie die obige Funktion mit container_of.
#define to_clk_foo(_hw) container_of(_hw, struct clk_foo, hw)
int clk_foo_enable(struct clk_hw *hw)
{
struct clk_foo *foo;
foo = to_clk_foo(hw);
... perform magic on foo ...
return 0;
};
Below is a matrix detailing which clk_ops are mandatory based upon the hardware capabilities of that clock.
Unten finden Sie eine Matrix, in der detailliert angegeben ist, ob clk_ops für diese Uhr basierend auf den Hardwarefunktionen erforderlich sind.
A cell marked as "y" means mandatory, a cell marked as "n" implies that either including that callback is invalid or otherwise unnecessary.
Die mit "y" gekennzeichnete Zelle ist erforderlich und "n" bedeutet, ob der Rückruf ungültig ist oder nicht.
Empty cells are either optional or must be evaluated on a case-by-case basis.
Leere Zellen sollten als optional oder von Fall zu Fall bewertet werden.
.. table:: clock hardware characteristics
+----------------+------+-------------+---------------+-------------+------+
| | gate | change rate | single parent | multiplexer | root |
+================+======+=============+===============+=============+======+
|.prepare | | | | | |
+----------------+------+-------------+---------------+-------------+------+
|.unprepare | | | | | |
+----------------+------+-------------+---------------+-------------+------+
+----------------+------+-------------+---------------+-------------+------+
|.enable | y | | | | |
+----------------+------+-------------+---------------+-------------+------+
|.disable | y | | | | |
+----------------+------+-------------+---------------+-------------+------+
|.is_enabled | y | | | | |
+----------------+------+-------------+---------------+-------------+------+
+----------------+------+-------------+---------------+-------------+------+
|.recalc_rate | | y | | | |
+----------------+------+-------------+---------------+-------------+------+
|.round_rate | | y [1]_ | | | |
+----------------+------+-------------+---------------+-------------+------+
|.determine_rate | | y [1]_ | | | |
+----------------+------+-------------+---------------+-------------+------+
|.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.
[1] Erforderlich entweder für round_rate oder determin_rate
Finally, register your clock at run-time with a hardware-specific registration function.
This function simply populates struct clk_foo's data and then passes the common struct clk parameters to the framework with a call to::
Schließlich wird eine hardwarespezifische Registrierungsfunktion verwendet, um die Uhr zur Laufzeit zu registrieren. Diese Funktion füllt einfach die Strukturdaten von clk_foo und teilt beim nächsten Aufruf die allgemeinen clk-Strukturparameter von framwork mit.
clk_register(...)
See the basic clock types in
drivers/clk/clk-*.cfor examples.
Bitte beziehen Sie sich auf den grundlegenden Uhrentyp in drivers / clk / clk- *. C.
Disabling clock gating of unused clocks
Sometimes during development it can be useful to be able to bypass the default disabling of unused clocks.
Während der Entwicklung ist es oft nützlich, die Uhr standardmäßig zu deaktivieren.
For example, if drivers aren't enabling clocks properly but rely on them being on from the bootloader, bypassing the disabling means that the driver will remain functional while the issues are sorted out.
Wenn der Treiber beispielsweise die Uhr nicht ordnungsgemäß aktiviert, sich jedoch auf die Vorteile des Bootloaders stützt, funktioniert die Umgehung der Deaktivierung weiterhin, solange das Problem behoben ist.
To bypass this disabling, include "clk_ignore_unused" in the bootargs to the kernel.
Um diese Ungültigmachung zu umgehen, fügen Sie "clk_ignore_unused" in die Kernel-Bootargs ein.
Locking
The common clock framework uses two global locks, the prepare lock and the enable lock.
Das Common Clock Framework verwendet zwei globale Sperren. Sperre vorbereiten und Sperre aktivieren.
The enable lock is a spinlock and is held across calls to the .enable, .disable operations.
Die Aktivierungssperre ist eine Drehsperre, die während der Ausführung von Aktivierungs- oder Deaktivierungsvorgängen gehalten wird.
Those operations are thus not allowed to sleep, and calls to the clk_enable(), clk_disable() API functions are allowed in atomic context.
Daher können diese Operationen nicht in den Ruhezustand versetzt werden, und die APIs clk_enable () und cld_disable () dürfen im atomaren Kontext aufgerufen werden.
.
For clk_is_enabled() API, it is also designed to be allowed to be used in atomic context.
Außerdem kann die API clk_is_enable () in einem atomaren Kontext verwendet werden.
However, it doesn't really make any sense to hold the enable lock in core, unless you want to do something else with the information of the enable state with that lock held.
Es sei denn, Sie möchten etwas anderes mit den Statusinformationen zum Aktivieren der Sperre tun, während der Kern die Aktivierungssperre hält.
Otherwise, seeing if a clk is enabled is a one-shot read of the enabled state, which could just as easily change after the function returns because the lock is released.
Andernfalls wird überprüft, ob die Uhr aktiviert ist, und der aktivierte Status wird einmalig gelesen. Dadurch wird die Sperre aufgehoben, sodass Sie sie nach Rückkehr der Funktion problemlos ändern können.
Thus the user of this API needs to handle synchronizing the read of the state with whatever they're using it for to make sure that the enable state doesn't change during that time.
Daher sollten Benutzer dieser API ihre Entlassungslesungen mit den von ihnen verwendeten synchronisieren, damit sich der Aktivierungsstatus in der Zwischenzeit nicht ändert.
.
The prepare lock is a mutex and is held across calls to all other operations.
Die Vorbereitungssperre ist ein Mutex und wird beim Aufrufen anderer Operationen gehalten.
All those operations are allowed to sleep, and calls to the corresponding API functions are not allowed in atomic context.
Alle diese Operationen können in den Ruhezustand versetzt werden, und die entsprechenden API-Funktionsaufrufe sind im atomaren Kontext nicht zulässig.
This effectively divides operations in two groups from a locking perspective.
Dadurch wird der Prozess aus Sicht der Sperrung effektiv in zwei Gruppen aufgeteilt.
.
Drivers don't need to manually protect resources shared between the operations of one group, regardless of whether those resources are shared by multiple clocks or not.
Der Treiber muss die von einer Gruppe von Ermittlern gemeinsam genutzten Ressourcen nicht manuell schützen, unabhängig davon, ob die Ressourcen von mehreren Uhren gemeinsam genutzt werden.
However, access to resources that are shared between operations of the two groups needs to be protected by the drivers.
Der Zugriff auf Ressourcen, die von den Vorgängen der beiden Gruppen gemeinsam genutzt werden, muss jedoch vom Treiber geschützt werden.
An example of such a resource would be a register that controls both the clock rate and the clock enable/disable state.
Ein Beispiel für eine solche Ressource ist ein Register, das sowohl die Taktrate als auch den aktivierten / deaktivierten Zustand der Uhr steuert.
.
The clock framework is reentrant, in that a driver is allowed to call clock framework functions from within its implementation of clock operations.
Das Clock-Framework ist insofern wiedereintrittsfähig, als der Treiber es innerhalb der Implementierung der Clock-Operation aufrufen kann.
This can for instance cause a .set_rate operation of one clock being called from within the .set_rate operation of another clock.
Dies kann beispielsweise dazu führen, dass eine .set_rate-Operation für einen Takt aus einer .set_rate-Operation für einen anderen Takt aufgerufen wird.
This case must be considered in the driver implementations, but the code flow is usually controlled by the driver in that case.
Dieser Fall sollte bei der Treiberimplementierung berücksichtigt werden. In solchen Fällen wird der Codefluss jedoch normalerweise vom Treiber gesteuert.
.
Note that locking must also be considered when code outside of the common clock framework needs to access resources used by the clock operations.
Beachten Sie, dass auch das Sperren in Betracht gezogen werden sollte, wenn externer Code im allgemeinen Clock-Framework auf die für Clock-Operationen verwendeten Ressourcen zugreifen muss.
This is considered out of scope of this document.
Es liegt außerhalb des Geltungsbereichs dieses Dokuments.
Recommended Posts