一文搞懂 | Linux 時脈子系統

Clock 時鐘是 SoC 中的脈搏，它控制著各個部件按照各自的節奏運作。例如，CPU 主頻設定、串列埠的波特率設定、I2S 的取樣率設定、I2C 的速率設定等等。這些不同的 clock 設定都需要從某個或某幾個時鐘源頭而來，最後形成一顆時鐘樹。可以透過 cat /sys/kernel/debug/clk/clk_summary 指令查看這棵時鐘樹。

核心中使用 CCF 框架來管理 clock。如下圖所示，右邊是 clock 提供者，即 Clock Provider；中間是 CCF；左邊是裝置驅動的 clock 使用者，即 Clock Consumer。

Clock Provider

• 根節點一般是 Oscillator（主動振盪器）或 Crystal（被動振盪器）。
• 中間節點有很多種，包括PLL（鎖相環，用於提升頻率的），Divider（分頻器，用於降頻的），Mux（從多個clock path中選擇一個），Gate（用來控制ON/OFF的）。
• 葉節點是使用 clock 做為輸入的、有具體功能的 HW block。

根據 clock 的特點，clock framework 將 clock 分為 fixed rate、gate、devider、mux、fixed factor、composite 六類。

資料結構

#上面六類本質上都屬於clock device，核心把這些 clock HW block 的特性抽取出來，用 struct clk_hw 來表示，具體如下：

struct clk_hw {
  //指向CCF模块中对应 clock device 实例
 struct clk_core *core;
  //clk是访问clk_core的实例。每当consumer通过clk_get对CCF中的clock device（也就是clk_core）发起访

问的时候都需要获取一个句柄，也就是clk
 struct clk *clk;
  //clock provider driver初始化时的数据，数据被用来初始化clk_hw对应的clk_core数据结构。
 const struct clk_init_data *init;
};

struct clk_init_data {
  //该clock设备的名字
 const char  *name;
  //clock provider driver进行具体的 HW 操作
 const struct clk_ops *ops;
  //描述该clk_hw的拓扑结构
 const char  * const *parent_names;
 const struct clk_parent_data *parent_data;
 const struct clk_hw  **parent_hws;
 u8   num_parents;
 unsigned long  flags;
};

以固定頻率的振動器 fixed rate 為例，它的資料結構是：

struct clk_fixed_rate {
  //下面是fixed rate这种clock device特有的成员
  struct        clk_hw hw；
  //基类
  unsigned long    fixed_rate;
  unsigned long    fixed_accuracy;
  u8        flags;
};

其他的特定的clock device大概都是如此，這裡就不贅述了。

這裡用一張圖來描述這些資料結構之間的關係：

註冊方式

了解資料結構，我們再看下每類 clock device 的註冊方式。

1. fixed rate clock

這一類clock有固定的頻率，不能開關、不能調整頻率、不能選擇parent，是最簡單的一類clock。可以直接透過 DTS 配置的方式支援。也可以透過接口，可以直接註冊 fixed rate clock，如下：

CLK_OF_DECLARE(fixed_clk, "fixed-clock", of_fixed_clk_setup);

struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
                const char *parent_name, unsigned long flags,
                unsigned long fixed_rate);

2. gate clock

這一類clock只可開關（會提供.enable/.disable回呼），可使用下面介面註冊：

struct clk *clk_register_gate(struct device *dev, const char *name,
                const char *parent_name, unsigned long flags,
                void __iomem *reg, u8 bit_idx,
                u8 clk_gate_flags, spinlock_t *lock);

3. divider clock

這一類clock可以設定分頻值（因而會提供.recalc_rate/.set_rate/.round_rate回呼），可透過下面兩個介面註冊：

struct clk *clk_register_divider(struct device *dev, const char *name,
                const char *parent_name, unsigned long flags,
                void __iomem *reg, u8 shift, u8 width,
                u8 clk_divider_flags, spinlock_t *lock);
                
struct clk *clk_register_divider_table(struct device *dev, const char *name,
                const char *parent_name, unsigned long flags,
                void __iomem *reg, u8 shift, u8 width,
                u8 clk_divider_flags, const struct clk_div_table *table,
                spinlock_t *lock);

4. mux clock

這一類clock可以選擇多個parent，因為會實作.get_parent/.set_parent/.recalc_rate回調，可透過下面兩個介面註冊：

struct clk *clk_register_mux(struct device *dev, const char *name,
                const char **parent_names, u8 num_parents, unsigned long flags,
                void __iomem *reg, u8 shift, u8 width,
                u8 clk_mux_flags, spinlock_t *lock);
                
struct clk *clk_register_mux_table(struct device *dev, const char *name,
                const char **parent_names, u8 num_parents, unsigned long flags,
                void __iomem *reg, u8 shift, u32 mask,
                u8 clk_mux_flags, u32 *table, spinlock_t *lock);

5. fixed factor clock

#這一類clock具有固定的factor（即multiplier和divider），clock的頻率是由parent clock的頻率，乘以mul，除以div，多用於一些具有固定分頻係數的clock。由於parent clock的頻率可以改變，因而fix factor clock也可該改變頻率，因此也會提供.recalc_rate/.set_rate/.round_rate等回呼。可透過下面介面註冊：

struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
                const char *parent_name, unsigned long flags,
                unsigned int mult, unsigned int div);

6. composite clock

顧名思義，就是mux、divider、gate等clock的組合，可透過下面介面註冊：

struct clk *clk_register_composite(struct device *dev, const char *name,
                const char **parent_names, int num_parents,
                struct clk_hw *mux_hw, const struct clk_ops *mux_ops,
                struct clk_hw *rate_hw, const struct clk_ops *rate_ops,
                struct clk_hw *gate_hw, const struct clk_ops *gate_ops,
                unsigned long flags);

這些註冊函數最終都會透過函數 clk_register 註冊到 Common Clock Framework 中，傳回為 struct clk 指標。如下圖所示：

接著將傳回的 struct clk 指針，儲存在一個數組中，並呼叫 of_clk_add_provider 接口，告知 Common Clock Framework。

Clock Consumer

获取 clock

即通过 clock 名称获取 struct clk 指针的过程，由 clk_get、devm_clk_get、clk_get_sys、of_clk_get、of_clk_get_by_name、of_clk_get_from_provider 等接口负责实现，这里以 clk_get 为例，分析其实现过程：

struct clk *clk_get(struct device *dev, const char *con_id)
{
 const char *dev_id = dev ? dev_name(dev) : NULL;
 struct clk *clk;

 if (dev) {
  //通过扫描所有“clock-names”中的值，和传入的name比较，如果相同，获得它的index（即“clock-names”中的

第几个），调用of_clk_get，取得clock指针。
  clk = __of_clk_get_by_name(dev->of_node, dev_id, con_id);
  if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
   return clk;
 }

 return clk_get_sys(dev_id, con_id);
}
struct clk *of_clk_get(struct device_node *np, int index)
{
        struct of_phandle_args clkspec;
        struct clk *clk;
        int rc;
 
        if (index return ERR_PTR(-EINVAL);
 
        rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index,
                                        &clkspec);
        if (rc)
                return ERR_PTR(rc);
       //获取clock指针
        clk = of_clk_get_from_provider(&clkspec);
        of_node_put(clkspec.np);
        return clk;
}

of_clk_get_from_provider 通过便利 of_clk_providers 链表，并调用每一个 provider 的 get 回调函数，获取 clock 指针。如下：

struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec)
{
        struct of_clk_provider *provider;
        struct clk *clk = ERR_PTR(-ENOENT);
 
        /* Check if we have such a provider in our array */
        mutex_lock(&of_clk_lock);
        list_for_each_entry(provider, &of_clk_providers, link) {
                if (provider->node == clkspec->np)
                        clk = provider->get(clkspec, provider->data);
                if (!IS_ERR(clk))
                        break;
        }
        mutex_unlock(&of_clk_lock);
 
        return clk;
}

至此，Consumer 与 Provider 里讲的 of_clk_add_provider 对应起来了。

操作 clock

//启动clock前的准备工作/停止clock后的善后工作。可能会睡眠。
int clk_prepare(struct clk *clk)
void clk_unprepare(struct clk *clk)
 
//启动/停止clock。不会睡眠。
static inline int clk_enable(struct clk *clk)
static inline void clk_disable(struct clk *clk)

//clock频率的获取和设置
static inline unsigned long clk_get_rate(struct 
clk *clk)
static inline int clk_set_rate(struct clk *clk, unsigned long rate)
static inline long clk_round_rate(struct clk *clk, unsigned long rate)

//获取/选择clock的parent clock
static inline int clk_set_parent(struct clk *clk, struct clk *parent)
static inline struct clk *clk_get_parent(struct clk *clk)
 
//将clk_prepare和clk_enable组合起来，一起调用。将clk_disable和clk_unprepare组合起来，一起调用
static inline int clk_prepare_enable(struct clk *clk)
static inline void clk_disable_unprepare(struct clk *clk)

总结

以上是一文搞懂 | Linux 時脈子系統的詳細內容。更多資訊請關注PHP中文網其他相關文章！