电源管理入门-12 clock驱动

电源管理的两个大方面就是电压和时钟。Clock 时钟就是 SoC 中的脉搏由它来控制各个部件按各自的节奏跳动。比如CPU主频设置串口的波特率设置I2S的采样率设置I2C的速率设置等等。这些不同的clock设置都需要从某个或某几个时钟源头而来最终开枝散叶形成一棵时钟树。1. clock驱动构架Linux的时钟子系统由CCFcommon clock framework框架管理CCF向上给用户提供了通用的时钟接口向下给驱动开发者提供硬件操作的接口。这个也是一个consumer、framework、provide****r的模式。其中其provider会比较复杂一些但是往往是由芯片厂商提供我们编写设备驱动要使用调频的时候只需要在consumer里面进行配置使用就可以了。1.1 Clock Provider介绍在SoC上器件很多会形成一个时钟树如下所示根节点一般是Oscillator有源振荡器或者Crystal无源振荡器。中间节点有很多种包括PLL锁相环用于提升频率的Divider分频器用于降频的Mux从多个clock path中选择一个Gate用来控制ON/OFF的。叶节点是使用 clock 作为输入的、有具体功能的 HW block。可通过cat /sys/kernel/debug/clk/clk_summary 查看这棵时钟树。image.png1.2 clock 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)//获取时钟频率2. Clock Provider根据 clock 的特点clock framework 将 clock 分为fixed rate、gate、devider、mux、fixed factor、composite六类。2.1 数据结构表示上面六类本质上都属于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硬件的表示也是如此。2.2 clock provider注册初始化clock驱动在时钟子系统中属于providerprovider是时钟的提供者即具体的clock驱动。clock驱动在Linux刚启动的时候就要完成比initcall都要早期因此clock驱动是在内核中进行实现。这里也叫clock device例如上面说的fixed rate属于硬件提供服务的。在其启动的时候根据DTS里面的配置进行注册。例如fixed rateCLK_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);其他的device如下clk_register_gate clk_register_divider clk_register_divider_table clk_register_mux clk_register_mux_table clk_register_fixed_factor clk_register_composite这些注册函数最终都会通过函数clk_register注册到 Common Clock Framework 中返回为 struct clk 指针。如下所示在内核的drivers/clk目录下可以看到各个芯片厂商对各自芯片clock驱动的实现2.3 DTS配置例如时钟源clocks{osc24M:osc24M{compatiblefixed-clock;#clock-cells 0;clock-output-nameosc24M;clock-frequency24000000;};};属性说明compatible驱动匹配名字#clock-cells提供输出时钟的路数。#clock-cells为0时代表输出一路时钟 #clock-cells为1时代表输出2路时钟。#clock-output-names输出时钟的名字#clock-frequency输出时钟的频率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声明驱动2.4 clock驱动实现举例这里以fixed_clk为例fixed_clk针对像PLL这种具有固定频率的时钟对于PLL我们只需要实现.recalc_rate函数。设备树#define PLL0_CLK 0clocks{osc24M:osc24M{compatiblefixed-clock;#clock-cells 0;clock-output-namesosc24M;clock-frequency24000000;};pll0:pll0{compatiblexx, choogle-fixed-clk;#clock-cells 0;clock-idPLL0_CLK;clock-frequency1000000000;clock-output-namespll0;clocksosc24M;};};驱动#include linux/clk-provier.h#include linux/clkdev.h#include linux/clk.h#include linux/module.h#include linux/of.h#include linux/of_address.h#include linux/platform_device.h#include linux/slab.h#include linux/delay.h#define CLOCK_BASE 0X12340000#define CLOCK_SIZE 0X1000struct xx_fixed_clk{void __iomem *reg;//保存映射后寄存器基址 unsigned long fixed_rate;//频率 intid;//clockidstruct clk_hw*;} static unsigned long xx_pll0_fixed_clk_recalc_rate(struct clk_hw *hw, unsigned long parent_rate){unsigned long recalc_rate;//硬件操作查询寄存器获得分频系数计算频率然后返回returnrecalc_rate;}static struct clk_ops xx_pll0_fixed_clk_ops{.recalc_ratexx_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_clkkzalloc(sizeof(*fixed_clk), GFP_KERNEL);if(!fixed_clk)returnERR_PTR(-ENOMEM);//初始化struct clk_init_data数据 init.namename;init.flagsCLK_IS_BASIC;init.parent_namesparent_name ?parent_name:NULL;init.num_parentsparent_name ?1:0;fixed_clk-regres_reg;//保存映射后的基址 fixed_clk-fixed_ratefixed_rate;//保存频率 fixed_clk-idid;//保存clockidfixed_clk-hw.initinit;//时钟注册 clkclk_register(NULL,fixed_clk-hw);if(IS_ERR(clk))kfree(fixed_clk);returnclk;}static void __init of_xx_fixed_clk_init(struct device_node *np){struct clk_onecell_data *clk_data;const char *clk_namenp-name;const char *parent_nameof_clk_get_parent_name(np,0);void __iomem *res_regioremap(CLOCK_BASE, CLOCK_SIZE);//寄存器基址映射 u32 rate-1;int clock_id, index, number;clk_datakmalloc(sizeof(struct clk_onecell_data), GFP_KERNEL);if(!clk_data)return;numberof_property_count_u32_elems(np,clock-id);clk_data-clkskcalloc(number, sizeof(struct clk*), GFP_KERNEL);if(!clk_data-clks)goto err_free_data;of_property_read_u32(np,clock-frequency,rate);/** * 操作寄存器初始化PLL时钟频率 *......*/for(index0;indexnumber;index){of_property_read_string_index(np,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_numnumber;if(number1){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);3. clock consumer主要就是获取clock和操作clock。3.1 获取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_iddev ? 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)returnclk;}returnclk_get_sys(dev_id, con_id);}3.2 操作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)3.3 实例操作我们在驱动consumer开发的时候需要使用clock这时需要在DTS里面配置例如mmc设备mmc0:mmc00x12345678{compatiblexx,xx-mmc0;......clocksperi PERI_MCI0;//指定mmc0的时钟来自PERI_MCI0PERI_MCI0的父时钟是peri clocks-namesmmc0;//时钟名调用devm_clk_get获取时钟时可以传入该名字......};以mmc的设备节点为例上述mmc0指定了时钟来自PERI_MCI0PERI_MCI0的父时钟是peri并将所指定的时钟给它命名为mmc0。使用方法如下/*1、获取时钟 */ host-clkdevm_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);retPTR_ERR(host-clk);goto probe_out_free_dev;}/*2、使能时钟 */ retclk_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指针句柄后续都通过该指针进行操作例如设置频率retclk_set_rate(host-clk,300000);获得频率retclk_get_rate(host-clk);注意devm_clk_get()的两个参数是二选一可以都传入也可以只传入一个参数。像i2c、mmc等这些外设驱动通常只需要使能门控即可因为这些外设并不是时钟源它们只有开关。如果直接调用clk_ser_rate函数设置频率clk_set_rate会向上传递即设置它的父时钟频率。例如在该例子中直接调用clk_set_rate函数最终设置的是时钟源peri的频率。4. SoC硬件中的使用在硬件中一般将clock的控制和reset搞到一起形成一个CRUclock reset unit。每个子系统例如NPU需要有自己独立的CRUCRU里面有PLL参考https://cloud.tencent.com/developer/article/1928685https://zhuanlan.zhihu.com/p/605593587https://bbs.16rd.com/thread-572748-1-1.html后记电源管理写了这么多篇慢慢套路就可以摸清楚了抓住主要构架思路剩下的就是招式问题了。DTS、consumerframework、provier、硬件树形组织等。先弄清楚这些东西不论调试什么问题就比较快了。“啥都懂一点啥都不精通干啥都能干干啥啥不是专业入门劝退堪称程序员杂家”。欢迎各位自己有博客公众号的留言申请转载多谢后续会继续更新纯干货分析欢迎分享给朋友欢迎点赞、收藏、在看、划线和评论交流公众号“那路谈OS与SoC嵌入式软件”欢迎关注个人文章汇总https://thatway1989.github.io