18b6d5ae8SYanteng Si.. SPDX-License-Identifier: GPL-2.0 28b6d5ae8SYanteng Si 38b6d5ae8SYanteng Si.. include:: ../disclaimer-zh_CN.rst 48b6d5ae8SYanteng Si 58137a49eSYanteng Si:Original: Documentation/cpu-freq/cpu-drivers.rst 68137a49eSYanteng Si 78137a49eSYanteng Si:翻译: 88137a49eSYanteng Si 98137a49eSYanteng Si 司延腾 Yanteng Si <siyanteng@loongson.cn> 108b6d5ae8SYanteng Si 11c5801123STang Yizhou:校译: 12c5801123STang Yizhou 13c5801123STang Yizhou 唐艺舟 Tang Yizhou <tangyeechou@gmail.com> 148b6d5ae8SYanteng Si 158b6d5ae8SYanteng Si======================================= 168b6d5ae8SYanteng Si如何实现一个新的CPUFreq处理器驱动程序？ 178b6d5ae8SYanteng Si======================================= 188b6d5ae8SYanteng Si 198b6d5ae8SYanteng Si作者: 208b6d5ae8SYanteng Si 218b6d5ae8SYanteng Si 228b6d5ae8SYanteng Si - Dominik Brodowski <linux@brodo.de> 238b6d5ae8SYanteng Si - Rafael J. Wysocki <rafael.j.wysocki@intel.com> 248b6d5ae8SYanteng Si - Viresh Kumar <viresh.kumar@linaro.org> 258b6d5ae8SYanteng Si 268b6d5ae8SYanteng Si.. Contents 278b6d5ae8SYanteng Si 288b6d5ae8SYanteng Si 1. 怎么做？ 298b6d5ae8SYanteng Si 1.1 初始化 308b6d5ae8SYanteng Si 1.2 Per-CPU 初始化 318b6d5ae8SYanteng Si 1.3 验证 328b6d5ae8SYanteng Si 1.4 target/target_index 或 setpolicy? 338b6d5ae8SYanteng Si 1.5 target/target_index 348b6d5ae8SYanteng Si 1.6 setpolicy 358b6d5ae8SYanteng Si 1.7 get_intermediate 与 target_intermediate 368b6d5ae8SYanteng Si 2. 频率表助手 378b6d5ae8SYanteng Si 388b6d5ae8SYanteng Si 398b6d5ae8SYanteng Si 408b6d5ae8SYanteng Si1. 怎么做？ 418b6d5ae8SYanteng Si=========== 428b6d5ae8SYanteng Si 43c5801123STang Yizhou如果，你刚刚得到了一个全新的CPU/芯片组及其数据手册，并希望为这个CPU/芯片组添加cpufreq 448b6d5ae8SYanteng Si支持？很好，这里有一些至关重要的提示： 458b6d5ae8SYanteng Si 468b6d5ae8SYanteng Si 478b6d5ae8SYanteng Si1.1 初始化 488b6d5ae8SYanteng Si---------- 498b6d5ae8SYanteng Si 50c5801123STang Yizhou首先，在 __initcall level 7 (module_init())或更靠后的函数中检查这个内核是否 518b6d5ae8SYanteng Si运行在正确的CPU和正确的芯片组上。如果是，则使用cpufreq_register_driver()向 528b6d5ae8SYanteng SiCPUfreq核心层注册一个cpufreq_driver结构体。 538b6d5ae8SYanteng Si 548b6d5ae8SYanteng Si结构体cpufreq_driver应该包含什么成员? 558b6d5ae8SYanteng Si 568b6d5ae8SYanteng Si .name - 驱动的名字。 578b6d5ae8SYanteng Si 588b6d5ae8SYanteng Si .init - 一个指向per-policy初始化函数的指针。 598b6d5ae8SYanteng Si 608b6d5ae8SYanteng Si .verify - 一个指向"verification"函数的指针。 618b6d5ae8SYanteng Si 628b6d5ae8SYanteng Si .setpolicy 或 .fast_switch 或 .target 或 .target_index - 差异见 638b6d5ae8SYanteng Si 下文。 648b6d5ae8SYanteng Si 65c5801123STang Yizhou其它可选成员 668b6d5ae8SYanteng Si 67c5801123STang Yizhou .flags - 给cpufreq核心的提示。 688b6d5ae8SYanteng Si 69c5801123STang Yizhou .driver_data - cpufreq驱动程序的特有数据。 708b6d5ae8SYanteng Si 718b6d5ae8SYanteng Si .get_intermediate 和 target_intermediate - 用于在改变CPU频率时切换到稳定 728b6d5ae8SYanteng Si 的频率。 738b6d5ae8SYanteng Si 748b6d5ae8SYanteng Si .get - 返回CPU的当前频率。 758b6d5ae8SYanteng Si 768b6d5ae8SYanteng Si .bios_limit - 返回HW/BIOS对CPU的最大频率限制值。 778b6d5ae8SYanteng Si 78c5801123STang Yizhou .exit - 一个指向per-policy清理函数的指针，该函数在CPU热插拔过程的CPU_POST_DEAD 798b6d5ae8SYanteng Si 阶段被调用。 808b6d5ae8SYanteng Si 818b6d5ae8SYanteng Si .suspend - 一个指向per-policy暂停函数的指针，该函数在关中断且在该策略的调节器停止 828b6d5ae8SYanteng Si 后被调用。 838b6d5ae8SYanteng Si 84c5801123STang Yizhou .resume - 一个指向per-policy恢复函数的指针，该函数在关中断且在调节器再一次启动前被 858b6d5ae8SYanteng Si 调用。 868b6d5ae8SYanteng Si 87*4f774c4aSBjorn Andersson .ready - 一个指向per-policy准备函数的指针，该函数在策略完全初始化之后被调用。 88*4f774c4aSBjorn Andersson 89c5801123STang Yizhou .attr - 一个指向NULL结尾的"struct freq_attr"列表的指针，该列表允许导出值到 908b6d5ae8SYanteng Si sysfs。 918b6d5ae8SYanteng Si 928b6d5ae8SYanteng Si .boost_enabled - 如果设置，则启用提升(boost)频率。 938b6d5ae8SYanteng Si 948b6d5ae8SYanteng Si .set_boost - 一个指向per-policy函数的指针，该函数用来开启/关闭提升(boost)频率功能。 958b6d5ae8SYanteng Si 968b6d5ae8SYanteng Si 978b6d5ae8SYanteng Si1.2 Per-CPU 初始化 988b6d5ae8SYanteng Si------------------ 998b6d5ae8SYanteng Si 100c5801123STang Yizhou每当一个新的CPU被注册到设备模型中，或者当cpufreq驱动注册自身之后，如果此CPU的cpufreq策 101c5801123STang Yizhou略不存在，则会调用per-policy的初始化函数cpufreq_driver.init。请注意，.init()和.exit()例程 102c5801123STang Yizhou只为某个策略调用一次，而不是对该策略管理的每个CPU调用一次。它需要一个 ``struct cpufreq_policy 1038b6d5ae8SYanteng Si*policy`` 作为参数。现在该怎么做呢？ 1048b6d5ae8SYanteng Si 1058b6d5ae8SYanteng Si如果有必要，请在你的CPU上激活CPUfreq功能支持。 1068b6d5ae8SYanteng Si 107c5801123STang Yizhou然后，驱动程序必须填写以下值: 1088b6d5ae8SYanteng Si 1098b6d5ae8SYanteng Si+-----------------------------------+--------------------------------------+ 110c5801123STang Yizhou|policy->cpuinfo.min_freq和 | 该CPU支持的最低和最高频率（kHz） | 111c5801123STang Yizhou|policy->cpuinfo.max_freq | | 1128b6d5ae8SYanteng Si| | | 1138b6d5ae8SYanteng Si+-----------------------------------+--------------------------------------+ 114c5801123STang Yizhou|policy->cpuinfo.transition_latency | CPU在两个频率之间切换所需的时间，以 | 115c5801123STang Yizhou| | 纳秒为单位（如不适用，设定为 | 1168b6d5ae8SYanteng Si| | CPUFREQ_ETERNAL） | 117c5801123STang Yizhou| | | 1188b6d5ae8SYanteng Si+-----------------------------------+--------------------------------------+ 1198b6d5ae8SYanteng Si|policy->cur | 该CPU当前的工作频率(如适用) | 1208b6d5ae8SYanteng Si| | | 1218b6d5ae8SYanteng Si+-----------------------------------+--------------------------------------+ 122c5801123STang Yizhou|policy->min, | 必须包含该CPU的"默认策略"。稍后 | 123c5801123STang Yizhou|policy->max, | 会用这些值调用 | 124c5801123STang Yizhou|policy->policy and, if necessary, | cpufreq_driver.verify和下面函数 | 125c5801123STang Yizhou|policy->governor | 之一：cpufreq_driver.setpolicy或 | 1268b6d5ae8SYanteng Si| | cpufreq_driver.target/target_index | 1278b6d5ae8SYanteng Si| | | 1288b6d5ae8SYanteng Si+-----------------------------------+--------------------------------------+ 129c5801123STang Yizhou|policy->cpus | 该policy通过DVFS框架影响的全部CPU | 130c5801123STang Yizhou| | (即与本CPU共享"时钟/电压"对)构成 | 131c5801123STang Yizhou| | 掩码(同时包含在线和离线CPU)，用掩码 | 132c5801123STang Yizhou| | 更新本字段 | 1338b6d5ae8SYanteng Si| | | 1348b6d5ae8SYanteng Si+-----------------------------------+--------------------------------------+ 1358b6d5ae8SYanteng Si 136c5801123STang Yizhou对于设置其中的一些值(cpuinfo.min[max]_freq, policy->min[max])，频率表辅助函数可能会有帮 1378b6d5ae8SYanteng Si助。关于它们的更多信息，请参见第2节。 1388b6d5ae8SYanteng Si 1398b6d5ae8SYanteng Si 1408b6d5ae8SYanteng Si1.3 验证 1418b6d5ae8SYanteng Si-------- 1428b6d5ae8SYanteng Si 143c5801123STang Yizhou当用户决定设置一个新的策略(由"policy,governor,min,max组成")时，必须对这个策略进行验证， 1448b6d5ae8SYanteng Si以便纠正不兼容的值。为了验证这些值，cpufreq_verify_within_limits(``struct cpufreq_policy 1458b6d5ae8SYanteng Si*policy``, ``unsigned int min_freq``, ``unsigned int max_freq``)函数可能会有帮助。 146c5801123STang Yizhou关于频率表辅助函数的详细内容请参见第2节。 1478b6d5ae8SYanteng Si 1488b6d5ae8SYanteng Si您需要确保至少有一个有效频率（或工作范围）在 policy->min 和 policy->max 范围内。如果有必 149c5801123STang Yizhou要，先增大policy->max，只有在没有解决方案的情况下，才减小policy->min。 1508b6d5ae8SYanteng Si 1518b6d5ae8SYanteng Si 1528b6d5ae8SYanteng Si1.4 target 或 target_index 或 setpolicy 或 fast_switch? 1538b6d5ae8SYanteng Si------------------------------------------------------- 1548b6d5ae8SYanteng Si 155c5801123STang Yizhou大多数cpufreq驱动甚至大多数CPU频率升降算法只允许将CPU频率设置为预定义的固定值。对于这些，你 1568b6d5ae8SYanteng Si可以使用->target()，->target_index()或->fast_switch()回调。 1578b6d5ae8SYanteng Si 158c5801123STang Yizhou有些具有硬件调频能力的处理器可以自行依据某些限制来切换CPU频率。它们应使用->setpolicy()回调。 1598b6d5ae8SYanteng Si 1608b6d5ae8SYanteng Si 1618b6d5ae8SYanteng Si1.5. target/target_index 1628b6d5ae8SYanteng Si------------------------ 1638b6d5ae8SYanteng Si 1648b6d5ae8SYanteng Sitarget_index调用有两个参数： ``struct cpufreq_policy * policy`` 和 ``unsigned int`` 165c5801123STang Yizhou索引(用于索引频率表项)。 1668b6d5ae8SYanteng Si 1678b6d5ae8SYanteng Si当调用这里时，CPUfreq驱动必须设置新的频率。实际频率必须由freq_table[index].frequency决定。 1688b6d5ae8SYanteng Si 169c5801123STang Yizhou在发生错误的情况下总是应该恢复到之前的频率(即policy->restore_freq)，即使我们已经切换到了 170c5801123STang Yizhou中间频率。 1718b6d5ae8SYanteng Si 1728b6d5ae8SYanteng Si已弃用 1738b6d5ae8SYanteng Si---------- 174c5801123STang Yizhoutarget调用有三个参数。``struct cpufreq_policy * policy``, unsigned int target_frequency, 1758b6d5ae8SYanteng Siunsigned int relation. 1768b6d5ae8SYanteng Si 1778b6d5ae8SYanteng SiCPUfreq驱动在调用这里时必须设置新的频率。实际的频率必须使用以下规则来确定。 1788b6d5ae8SYanteng Si 179c5801123STang Yizhou- 尽量贴近"目标频率"。 1808b6d5ae8SYanteng Si- policy->min <= new_freq <= policy->max (这必须是有效的!!!) 1818b6d5ae8SYanteng Si- 如果 relation==CPUFREQ_REL_L，尝试选择一个高于或等于 target_freq 的 new_freq。("L代表 1828b6d5ae8SYanteng Si 最低，但不能低于") 1838b6d5ae8SYanteng Si- 如果 relation==CPUFREQ_REL_H，尝试选择一个低于或等于 target_freq 的 new_freq。("H代表 1848b6d5ae8SYanteng Si 最高，但不能高于") 1858b6d5ae8SYanteng Si 186c5801123STang Yizhou这里，频率表辅助函数可能会帮助你 -- 详见第2节。 1878b6d5ae8SYanteng Si 1888b6d5ae8SYanteng Si1.6. fast_switch 1898b6d5ae8SYanteng Si---------------- 1908b6d5ae8SYanteng Si 1918b6d5ae8SYanteng Si这个函数用于从调度器的上下文进行频率切换。并非所有的驱动都要实现它，因为不允许在这个回调中睡眠。这 1928b6d5ae8SYanteng Si个回调必须经过高度优化，以尽可能快地进行切换。 1938b6d5ae8SYanteng Si 1948b6d5ae8SYanteng Si这个函数有两个参数： ``struct cpufreq_policy *policy`` 和 ``unsigned int target_frequency``。 1958b6d5ae8SYanteng Si 1968b6d5ae8SYanteng Si 1978b6d5ae8SYanteng Si1.7 setpolicy 1988b6d5ae8SYanteng Si------------- 1998b6d5ae8SYanteng Si 2008b6d5ae8SYanteng Sisetpolicy调用只需要一个 ``struct cpufreq_policy * policy`` 作为参数。需要将处理器内或芯片组内动态频 2018b6d5ae8SYanteng Si率切换的下限设置为policy->min，上限设置为policy->max，如果支持的话，当policy->policy为 202c5801123STang YizhouCPUFREQ_POLICY_PERFORMANCE时选择面向性能的设置，为CPUFREQ_POLICY_POWERSAVE时选择面向省电的设置。 2038b6d5ae8SYanteng Si也可以查看drivers/cpufreq/longrun.c中的参考实现。 2048b6d5ae8SYanteng Si 2058b6d5ae8SYanteng Si1.8 get_intermediate 和 target_intermediate 2068b6d5ae8SYanteng Si-------------------------------------------- 2078b6d5ae8SYanteng Si 208c5801123STang Yizhou仅适用于未设置 target_index() 和 CPUFREQ_ASYNC_NOTIFICATION 的驱动。 2098b6d5ae8SYanteng Si 2108b6d5ae8SYanteng Siget_intermediate应该返回一个平台想要切换到的稳定的中间频率，target_intermediate()应该将CPU设置为 211c5801123STang Yizhou该频率，然后再跳转到'index'对应的频率。cpufreq核心会负责发送通知，驱动不必在 212c5801123STang Yizhoutarget_intermediate()或target_index()中处理它们。 2138b6d5ae8SYanteng Si 214c5801123STang Yizhou在驱动程序不想为某个目标频率切换到中间频率的情况下，它们可以让get_intermediate()返回'0'。 215c5801123STang Yizhou在这种情况下，cpufreq核心将直接调用->target_index()。 2168b6d5ae8SYanteng Si 217c5801123STang Yizhou注意：->target_index()应该在发生失败的情况下将频率恢复到policy->restore_freq， 218c5801123STang Yizhou因为cpufreq核心会为此发送通知。 2198b6d5ae8SYanteng Si 2208b6d5ae8SYanteng Si 221c5801123STang Yizhou2. 频率表辅助函数 222c5801123STang Yizhou================= 2238b6d5ae8SYanteng Si 224c5801123STang Yizhou由于大多数支持cpufreq的处理器只允许被设置为几个特定的频率，因此，"频率表"和一些相关函数可能会辅助处理器驱动 225c5801123STang Yizhou程序的一些工作。这样的"频率表"是一个由struct cpufreq_frequency_table的条目构成的数组，"driver_data"成员包 226c5801123STang Yizhou含驱动程序的专用值，"frequency"成员包含了相应的频率，此外还有标志成员。在表的最后，需要添加一个 227c5801123STang Yizhoucpufreq_frequency_table条目，频率设置为CPUFREQ_TABLE_END。如果想跳过表中的一个条目，则将频率设置为 228c5801123STang YizhouCPUFREQ_ENTRY_INVALID。这些条目不需要按照任何特定的顺序排序，如果排序了，cpufreq核心执行DVFS会更快一点， 2298b6d5ae8SYanteng Si因为搜索最佳匹配会更快。 2308b6d5ae8SYanteng Si 231c5801123STang Yizhou如果在policy->freq_table字段中包含一个有效的频率表指针，频率表就会被cpufreq核心自动验证。 2328b6d5ae8SYanteng Si 2338b6d5ae8SYanteng Sicpufreq_frequency_table_verify()保证至少有一个有效的频率在policy->min和policy->max范围内，并且所有其他 234c5801123STang Yizhou准则都被满足。这对->verify调用很有帮助。 2358b6d5ae8SYanteng Si 236c5801123STang Yizhoucpufreq_frequency_table_target()是对应于->target阶段的频率表辅助函数。只要把值传递给这个函数，这个函数就会返 2378b6d5ae8SYanteng Si回包含CPU要设置的频率的频率表条目。 2388b6d5ae8SYanteng Si 2398b6d5ae8SYanteng Si以下宏可以作为cpufreq_frequency_table的迭代器。 2408b6d5ae8SYanteng Si 2418b6d5ae8SYanteng Sicpufreq_for_each_entry(pos, table) - 遍历频率表的所有条目。 2428b6d5ae8SYanteng Si 2438b6d5ae8SYanteng Sicpufreq_for_each_valid_entry(pos, table) - 该函数遍历所有条目，不包括CPUFREQ_ENTRY_INVALID频率。 244c5801123STang Yizhou使用参数"pos" -- 一个 ``cpufreq_frequency_table *`` 作为循环指针，使用参数"table" -- 作为你想迭代 2458b6d5ae8SYanteng Si的 ``cpufreq_frequency_table *`` 。 2468b6d5ae8SYanteng Si 2478b6d5ae8SYanteng Si例如:: 2488b6d5ae8SYanteng Si 2498b6d5ae8SYanteng Si struct cpufreq_frequency_table *pos, *driver_freq_table; 2508b6d5ae8SYanteng Si 2518b6d5ae8SYanteng Si cpufreq_for_each_entry(pos, driver_freq_table) { 2528b6d5ae8SYanteng Si /* Do something with pos */ 2538b6d5ae8SYanteng Si pos->frequency = ... 2548b6d5ae8SYanteng Si } 2558b6d5ae8SYanteng Si 256c5801123STang Yizhou如果你需要在driver_freq_table中处理pos的位置，不要做指针减法，因为它的代价相当高。作为替代，使用宏 2578b6d5ae8SYanteng Sicpufreq_for_each_entry_idx() 和 cpufreq_for_each_valid_entry_idx() 。 258