À l'origine, il fait partie du code source du noyau Linux, il sera donc traité comme GPLv2 (reconnaissance qu'il devrait l'être).
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.
Ce document détaille le cadre général de clk et comment rendre ce cadre unique sur toutes les plates-formes. Il n'y a pas de description détaillée de l'API d'horloge dans ʻinclude / linux / clk.h`, mais elle en inclura probablement.
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.
Le framework clk commun est l'interface qui contrôle les nœuds d'horloge qui sont en vigueur sur divers appareils aujourd'hui. Il fournit une synchronisation d'horloge, un ajustement de débit, un multiplexage ou d'autres opérations. Ce cadre est activé par l'option CONFIG_COMMON_CLK.
The interface itself is divided into two halves, each shielded from the details of its counterpart.
Cette interface elle-même peut être grossièrement divisée en deux parties. Chacun protège des détails de la pièce correspondante.
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.
Le premier est une définition commune des structures clk. La structure clk intègre la comptabilité et l'infrastructure au niveau du cadre qui ont traditionnellement été répliquées sur diverses plates-formes.
Second is a common implementation of the clk.h api, defined in
drivers/clk/clk.c.
La seconde est une implémentation courante de l'api clk.h définie dans drivers / clk / clk.c.
Finally there is struct clk_ops, whose operations are invoked by the clk api implementation.
Enfin, il existe une structure clk_ops, qui est appelée par l'implémentation de l'api clk.
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.
La seconde moitié de l'interface se compose de rappels spécifiques au matériel enregistrés dans la structure clk_ops et des structures spécifiques au matériel correspondantes nécessaires pour modéliser une horloge particulière.
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.
Le reste de ce document fait référence à certains des callbacks contenus dans la structure clk_ops. Désigne des implémentations spécifiques au matériel telles que .enable et .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.
De même, la structure clk_foo sert d'abréviation pratique pour les implémentations spécifiques au matériel du matériel fictif "foo".
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.
La structure clk_hw intègre les deux moitiés de cette interface. Il est défini dans la structure clk_foo et est pointé vers la structure clk_core.
This allows for easy navigation between the two discrete halves of the common clock interface.
Cela facilite la navigation entre les deux moitiés distinctes de l'interface d'horloge commune.
Common data structures and api
Below is the common struct clk_core definition from
drivers/clk/clk.c, modified for brevity::
Voici la structure commune clk_core définie dans drivers / clk / clk.c. Il a été modifié par souci de concision.
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.
Les membres ci-dessus constituent le cœur de la topologie de l'arborescence clk. L'API clk elle-même définit certaines fonctions de l'interface du pilote pour contrôler la structure clk. Cette API est documentée dans ʻinclude / linux / clk.h`.
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::
Les plates-formes et les pilotes de périphérique qui utilisent la structure commune clk_core utilisent des pointeurs vers la structure clk_ops au sein de la structure clk_core pour effectuer un traitement spécifique au matériel tel que défini dans clk-providor.h.
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.
La force de la structure commune clk_core est qu'elle a elle-même une abstraction pour les bits spécifiques au matériel avec des pointeurs .ops et .hw. L'inverse est également vrai.
To illustrate consider the simple gateable clk implementation in
drivers/clk/clk-gate.c::
Illustre le simple déclenchement d'horloge possible implémenté dans drivers / clk / clk-gate.c.
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.
La structure clk_gate contient la structure clk_hw en tant que connaissance spécifique au matériel concernant les registres et les bits pour contrôler le déclenchement de l'horloge.
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.
Il n'y a pas besoin de topologie d'horloge ou de comptabilité, comme enable_count ou notifier_count. Tout cela est géré par un code de cadre commun et une structure clk_core.
Let's walk through enabling this clk from driver code::
Vérifions la procédure pour activer cette structure clk à partir du code du pilote.
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::
Le graphe d'appel clk_enable est très concis.
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::
Et la définition de clk_get_set_bit est la suivante.
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::
Où to_clk_gate est défini comme suit:
#define to_clk_gate(_hw) container_of(_hw, struct clk_gate, hw)
This pattern of abstraction is used for every clock hardware representation.
Ce modèle d'abstraction est utilisé dans toutes les représentations matérielles d'horloge.
Supporting your own clk hardware
When implementing support for a new type of clock it is only necessary to include the following header::
Lors de la mise en œuvre pour prendre en charge le nouveau type d'horloge, incluez simplement l'en-tête ci-dessous.
#include <linux/clk-provider.h>
To construct a clk hardware structure for your platform you must define the following::
Pour configurer la structure matérielle clk de votre plate-forme, vous avez besoin des définitions suivantes:
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::
Pour tirer parti des avantages de l'utilisation des données, clk a besoin d'un support pour les bons contrôles.
struct clk_ops clk_foo_ops = {
.enable = &clk_foo_enable,
.disable = &clk_foo_disable,
};
Implement the above functions using container_of::
Implémentez la fonction ci-dessus en utilisant 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.
Vous trouverez ci-dessous une matrice détaillant si clk_ops sont nécessaires pour cette horloge en fonction des capacités matérielles.
A cell marked as "y" means mandatory, a cell marked as "n" implies that either including that callback is invalid or otherwise unnecessary.
La cellule marquée "y" est obligatoire et le "n" signifie si le rappel est invalide ou non requis.
Empty cells are either optional or must be evaluated on a case-by-case basis.
Les cellules vides doivent être évaluées comme facultatives ou au cas par cas.
.. 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] Requis soit par round_rate, soit par determine_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::
Enfin, une fonction d'enregistrement spécifique au matériel est utilisée pour enregistrer l'horloge au moment de l'exécution. Cette fonction remplit simplement les données de la structure clk_foo et indique à Framwork les paramètres généraux de la structure clk lors du prochain appel.
clk_register(...)
See the basic clock types in
drivers/clk/clk-*.cfor examples.
Veuillez vous référer au type d'horloge de base dans 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.
Lors du développement, il est souvent utile de désactiver l'horloge par défaut.
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.
Par exemple, si le pilote n'active pas correctement l'horloge, mais s'appuie sur les avantages du chargeur de démarrage, le contournement de la désactivation continuera de fonctionner tant que le problème est résolu.
To bypass this disabling, include "clk_ignore_unused" in the bootargs to the kernel.
Pour contourner cette invalidation, incluez "clk_ignore_unused" dans les bootargs du noyau.
Locking
The common clock framework uses two global locks, the prepare lock and the enable lock.
Le framework d'horloge commun utilise deux verrous globaux. préparer le verrouillage et activer le verrouillage.
The enable lock is a spinlock and is held across calls to the .enable, .disable operations.
Le verrou d'activation est un verrou tournant, qui est maintenu lors de l'exécution d'opérations .activer ou .désactiver.
Those operations are thus not allowed to sleep, and calls to the clk_enable(), clk_disable() API functions are allowed in atomic context.
Par conséquent, ces opérations ne peuvent pas dormir et les API clk_enable () et cld_disable () peuvent être appelées dans le contexte atomique.
.
For clk_is_enabled() API, it is also designed to be allowed to be used in atomic context.
De plus, l'API clk_is_enable () est conçue pour être utilisée dans un contexte atomique.
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.
Mais à moins que vous ne souhaitiez faire autre chose avec les informations d'état d'activation du maintien de verrouillage pendant que le noyau maintient le verrou d'activation.
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.
Sinon, vérifier si l'horloge est activée est une lecture unique de l'état activé, qui libère le verrou afin que vous puissiez facilement le changer après le retour de la fonction.
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.
Par conséquent, les utilisateurs de cette API doivent synchroniser leurs lectures de rejet avec celles qu'ils utilisent afin que l'état d'activation ne change pas entre-temps.
.
The prepare lock is a mutex and is held across calls to all other operations.
Le verrou de préparation est un mutex et est maintenu lors de l'appel d'autres opérations.
All those operations are allowed to sleep, and calls to the corresponding API functions are not allowed in atomic context.
Toutes ces opérations peuvent dormir et les appels de fonction API correspondants ne sont pas autorisés dans un contexte atomique.
This effectively divides operations in two groups from a locking perspective.
Cela divise efficacement le processus en deux groupes dans une perspective de verrouillage.
.
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.
Le pilote n'a pas à protéger manuellement les ressources partagées par un groupe d'enquêteurs, que les ressources soient ou non partagées par plusieurs horloges.
However, access to resources that are shared between operations of the two groups needs to be protected by the drivers.
Cependant, l'accès aux ressources partagées entre les opérations des deux groupes doit être protégé par le pilote.
An example of such a resource would be a register that controls both the clock rate and the clock enable/disable state.
Un exemple d'une telle ressource est un registre qui contrôle à la fois la fréquence d'horloge et l'état activé / désactivé de l'horloge.
.
The clock framework is reentrant, in that a driver is allowed to call clock framework functions from within its implementation of clock operations.
Le cadre d'horloge est réentrant en ce que le pilote peut l'appeler à partir de l'implémentation de l'opération d'horloge.
This can for instance cause a .set_rate operation of one clock being called from within the .set_rate operation of another clock.
Cela peut entraîner, par exemple, une opération .set_rate sur une horloge à appeler depuis une opération .set_rate sur une autre horloge.
This case must be considered in the driver implementations, but the code flow is usually controlled by the driver in that case.
Ce cas doit être pris en compte dans l'implémentation du pilote. Cependant, le flux de code est généralement contrôlé par le pilote dans de tels cas.
.
Note that locking must also be considered when code outside of the common clock framework needs to access resources used by the clock operations.
Gardez à l'esprit que si du code externe dans le cadre d'horloge commun doit accéder aux ressources utilisées pour les opérations d'horloge, le verrouillage doit également être envisagé.
This is considered out of scope of this document.
Cela sort du cadre de ce document.
Recommended Posts