Linux clock子系統及驅動實例

在Linux驅動中，操作時鐘只需要簡單調用內核提供的通用接口即可，clock驅動通常是由芯片廠商開發的，在Linux啟動時clock驅動就已經初始化完成。

本篇介紹Linux clock子系統以及clock驅動的實現。

基本概念

晶振：晶源振蕩器，提供時鐘。

PLL ：Phase lock loop，鎖相環。用于提升頻率。

OSC ：oscillator的簡寫，振蕩器。

clock子系統

Linux的時鐘子系統由CCF（common clock framework）框架管理， CCF向上給用戶提供了通用的時鐘接口，向下給驅動開發者提供硬件操作的接口 。各結構體關系如下：

CCF框架比較簡單，只有這幾個結構體。 CCF框架分為了consumer、ccf和provider三部分。

consumer ：

時鐘的使用者，clock子系統向consumer的提供通用的時鐘API接口，使其可以屏蔽底層硬件差異。提供給consumer操作的API如下：

struct clk *clk_get(struct device *dev, const char *id);
struct clk *devm_clk_get(struct device *dev, const char *id);
int clk_enable(struct clk *clk);//使能時鐘，不會睡眠
void clk_disable(struct clk *clk);//使能時鐘，不會睡眠
unsigned long clk_get_rate(struct clk *clk);
void clk_put(struct clk *clk);
long clk_round_rate(struct clk *clk, unsigned long rate);
int clk_set_rate(struct clk *clk, unsigned long rate);
int clk_set_parent(struct clk *clk, struct clk *parent);
struct clk *clk_get_parent(struct clk *clk);
int clk_prepare(struct clk *clk);
void clk_unprepare(struct clk *clk);
int clk_prepare_enable(struct clk *clk) //使能時鐘，可能會睡眠
void clk_disable_unprepare(struct clk *clk) //禁止時鐘，可能會睡眠
unsigned long clk_get_rate(struct clk *clk) //獲取時鐘頻率

consumer在使用這些API時，必須先調用devm_clk_get()或clk_get()獲取一個struct clk *指針句柄，后續都通過傳入該句柄來操作，struct clk相當于實例化一個時鐘。

ccf ：

clock子系統的核心，用一個struct clk_core結構體表示，每個注冊設備都對應一個struct clk_core。

provider（時鐘的提供者） ：

struct clk_hw：表示一個具體的硬件時鐘。

struct clk_init_data：struct clk_hw結構體成員，用于表示該時鐘下的初始化數據，如時鐘名字name、操作函數ops等。

// include/linux/clk-provider.h
struct clk_hw{
 struct clk_core *core;
 struct clk *clk;
 const struct clk_init_data *init;
}

struct clk_init_data{
 const char *name;     //時鐘名字
 const struct clk_ops *ops;   //時鐘硬件操作函數集合
 const char *const *parent_names; //父時鐘名字
 const struct clk_parent_data *parent_data;
 const struct clk_hw **parent_hws;
 u8 num_parents;
 unsigned long flags;
}

struct clk_ops：時鐘硬件操作的函數集合，定義了操作硬件的回調函數，consumer在調用clk_set_rate()等API時會調用到struct clk_ops具體指向的函數，這個需要芯片廠商開發clock驅動時去實現。

//include/linux/clk-provider.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);
 int  (*save_context)(struct clk_hw *hw);
 void  (*restore_context)(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);
 int  (*get_duty_cycle)(struct clk_hw *hw,
       struct clk_duty *duty);
 int  (*set_duty_cycle)(struct clk_hw *hw,
       struct clk_duty *duty);
 int  (*init)(struct clk_hw *hw);
 void  (*terminate)(struct clk_hw *hw);
 void  (*debug_init)(struct clk_hw *hw, struct dentry *dentry);
};

struct clk_ops中每個函數功能在include/linux/clk-provider.h都有具體的說明，在開發clock驅動時，這些函數并不需要全部實現。下面列舉幾個最常用，也是經常需要實現的函數。

函數	說明
recalc_rate	通過查詢硬件，重新計算此時鐘的速率。可選，但建議——如果未設置此操作，則時鐘速率初始化為0。
round_rate	給定目標速率作為輸入，返回時鐘實際支持的最接近速率。
set_rate	更改此時鐘的速率。請求的速率由第二個參數指定，該參數通常應該是調用.round_rate返回。第三個參數給出了父速率，這對大多數.set_rate實現有幫助。成功返回0，否則返回-EERROR
enable	時鐘enable
disable	時鐘disable

時鐘API的使用

對于一般的驅動開發（非clock驅動），我們只需要在dts中配置時鐘，然后在驅動調用通用的時鐘API接口即可。

1、設備樹中配置時鐘

mmc0:mmc0@0x12345678{
  compatible = "xx,xx-mmc0";
  ......
  clocks = ;//指定mmc0的時鐘來自PERI_MCI0，PERI_MCI0的父時鐘是peri
  clocks-names = "mmc0"; //時鐘名，調用devm_clk_get獲取時鐘時，可以傳入該名字
        ......
 };

以mmc的設備節點為例，上述mmc0指定了時鐘來自PERI_MCI0，PERI_MCI0的父時鐘是peri，并將所指定的時鐘給它命名為"mmc0"。

2、驅動中使用API接口

簡單的使用：

/* 1、獲取時鐘 */
host-?>clk = devm_clk_get(&pdev-?>dev, NULL); //或者devm_clk_get(&pdev-?>dev, "mmc0")
 if (IS_ERR(host-?>clk)) {
  dev_err(dev, "failed to find clock source\\n");
  ret = PTR_ERR(host-?>clk);
  goto probe_out_free_dev;
 }

/* 2、使能時鐘 */
ret = clk_prepare_enable(host-?>clk);
if (ret) {
 dev_err(dev, "failed to enable clock source.\\n");
 goto probe_out_free_dev;
}

probe_out_free_dev:
 kfree(host);

在驅動中操作時鐘，第一步需要獲取struct clk指針句柄，后續都通過該指針進行操作，例如：設置頻率：

ret = clk_set_rate(host- >clk, 300000);

獲得頻率：

ret = clk_get_rate(host- >clk);

注意：devm_clk_get()的兩個參數是二選一，可以都傳入，也可以只傳入一個參數。

像i2c、mmc等這些外設驅動，通常只需要使能門控即可，因為這些外設并不是時鐘源，它們只有開關。如果直接調用clk_ser_rate函數設置頻率，clk_set_rate會向上傳遞，即設置它的父時鐘頻率。例如在該例子中直接調用clk_set_rate函數，最終設置的是時鐘源peri的頻率。

clock驅動實例

clock驅動在時鐘子系統中屬于provider，provider是時鐘的提供者，即具體的clock驅動。

clock驅動在Linux剛啟動的時候就要完成，比initcall都要早期，因此clock驅動是在內核中進行實現。 在內核的drivers/clk目錄下，可以看到各個芯片廠商對各自芯片clock驅動的實現：

下面以一個簡單的時鐘樹，舉例說明一個芯片的時鐘驅動的大致實現過程：

1、時鐘樹

通常來說，一個芯片的時鐘樹是比較固定的，例如，以下時鐘樹：

時鐘樹的 根節點一般是晶振時鐘 ，上圖根節點為24M晶振時鐘。根節點下面是PLL，PLL用于提升頻率。PPL0下又分頻給PERI、DSP和ISP。PLL1分頻給DDR和ENC。

對于PLL來說，PLL的頻率可以通過寄存器設置，但通常是固定的，所以PLL屬于 固定時鐘 。

對PERI、DSP等模塊來說，它們的頻率來自于PLL的分頻，因此這些模塊的時鐘屬于 分頻時鐘 。

2、設備樹

設備樹中表示一個時鐘源，應有如下屬性，例如24M晶振時鐘：

clocks{
 osc24M:osc24M{
  compatible = "fixed-clock";
  #clock-cells = 0?>;
  clock-output-name = "osc24M";
  clock-frequency = 24000000?>;
 };
};

屬性	說明
compatible	驅動匹配名字
#clock-cells	提供輸出時鐘的路數。#clock-cells為0時，代表輸出一路時鐘#clock-cells為1時，代表輸出2路時鐘。
#clock-output-names	輸出時鐘的名字
#clock-frequency	輸出時鐘的頻率

3、驅動實現

clock驅動編寫的基本步驟：

實現struct clk_ops相關成員函數
定義分配struct clk_onecell_data結構體，初始化相關數據
定義分配struct clk_init_data結構體，初始化相關數據
調用clk_register將時鐘注冊進框架
調用clk_register_clkdev注冊時鐘設備
調用of_clk_add_provider，將clk provider存放到of_clk_provider鏈表中管理
調用CLK_OF_DECLARE聲明驅動

fixed_clk固定時鐘實現

fixed_clk針對像PLL這種具有固定頻率的時鐘，對于PLL，我們只需要實現.recalc_rate函數。

設備樹：

#define PLL0_CLK 0

clocks{
 osc24M:osc24M{
  compatible = "fixed-clock";
  #clock-cells = 0?>;
  clock-output-names = "osc24M";
  clock-frequency = 24000000?>;
 };
 pll0:pll0{
  compatible = "xx, choogle-fixed-clk";
  #clock-cells = 0?>;
  clock-id = ;
  clock-frequency = 1000000000?>;
  clock-output-names = "pll0";
  clocks = ;
 };
};

驅動：

#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 

#define CLOCK_BASE 0X12340000
#define CLOCK_SIZE 0X1000

struct xx_fixed_clk{
    void __iomem *reg;//保存映射后寄存器基址
    unsigned long fixed_rate;//頻率
    int id;//clock id
    struct clk_hw*;
}；
static unsigned long xx_pll0_fixed_clk_recalc_rate(struct clk_hw *hw, unsigned long parent_rate)
{
 unsigned long recalc_rate;
 //硬件操作：查詢寄存器，獲得分頻系數，計算頻率然后返回
 return recalc_rate;
}

static struct clk_ops xx_pll0_fixed_clk_ops = {
 .recalc_rate  =   xx_pll0_fixed_clk_recalc_rate,
};

struct clk_ops *xx_fixed_clk_ops[] = {
 &xx_pll0_fixed_clk_ops,
};

struct clk * __init xx_register_fixed_clk(const char *name, const char *parent_name,
       void __iomem *res_reg, u32 fixed_rate, int id, 
       const struct clk_ops *ops)
{
 struct xx_fixed_clk *fixed_clk;
 struct clk *clk;
 struct clk_init_data init = {};

 fixed_clk = kzalloc(sizeof(*fixed_clk), GFP_KERNEL);
 if (!fixed_clk)
  return ERR_PTR(-ENOMEM);

    //初始化struct clk_init_data數據
 init.name = name;
 init.flags = CLK_IS_BASIC;
 init.parent_names = parent_name ? &parent_name : NULL;
 init.num_parents = parent_name ? 1 : 0;

 fixed_clk-?>reg = res_reg;//保存映射后的基址
 fixed_clk-?>fixed_rate = fixed_rate;//保存頻率
 fixed_clk-?>id = id;//保存clock id

 fixed_clk-?>hw.init = &init;

    //時鐘注冊
 clk = clk_register(NULL, &fixed_clk-?>hw);
 if (IS_ERR(clk))
  kfree(fixed_clk);

 return clk;
}

static void __init of_xx_fixed_clk_init(struct device_node *np)
{
 struct clk_onecell_data *clk_data;
 const char *clk_name = np-?>name;
 
 const char *parent_name = of_clk_get_parent_name(np, 0);
 void __iomem *res_reg = ioremap(CLOCK_BASE, CLOCK_SIZE);//寄存器基址映射

 u32 rate = -1;
 int clock_id, index, number;

 clk_data = kmalloc(sizeof(struct clk_onecell_data), GFP_KERNEL);
 if (!clk_data )
  return;

 number = of_property_count_u32_elems(np, "clock-id");
 clk_data-?>clks = kcalloc(number, sizeof(struct clk*), GFP_KERNEL);
 if (!clk_data-?>clks)
  goto err_free_data;

 of_property_read_u32(np, "clock-frequency", &rate);


 /**
 * 操作寄存器：初始化PLL時鐘頻率
 * ......
 */

 for (index=0; index"clock-output-names", index, &clk_name);
  of_property_read_u32_index(np, "clock-id", index, &clock_id);

  clk_data-?>clks[index] = xx_register_fixed_clk(clk_name, parent_name, 
       res_reg, rate, clock_id, ak_fixed_clk_ops[pll_id]);
  if (IS_ERR(clk_data-?>clks[index])) {
   pr_err("%s register fixed clk failed: clk_name:%s, index = %d\\n",
     __func__, clk_name, index);
   WARN_ON(true);
   continue;
  }
  clk_register_clkdev(clk_data-?>clks[index], clk_name, NULL);//注冊時鐘設備
 }

 clk_data-?>clk_num = number;
 if (number == 1) {
  of_clk_add_provider(np, of_clk_src_simple_get, clk_data-?>clks[0]);
 } else {
  of_clk_add_provider(np, of_clk_src_onecell_get, clk_data);
 }
 return;

err_free_data:
 kfree(clk_data);

}

CLK_OF_DECLARE(xx_fixed_clk, "xx,xx-fixed-clk", of_xx_fixed_clk_init);