1.. SPDX-License-Identifier: GPL-2.0
2
3.. include:: ../disclaimer-zh_CN.rst
4
5:Original: Documentation/cpu-freq/cpu-drivers.rst
6
7:翻译:
8
9 司延腾 Yanteng Si <siyanteng@loongson.cn>
10
11:校译:
12
13 唐艺舟 Tang Yizhou <tangyeechou@gmail.com>
14
15=======================================
16如何实现一个新的CPUFreq处理器驱动程序？
17=======================================
18
19作者:
20
21
22	- Dominik Brodowski  <linux@brodo.de>
23	- Rafael J. Wysocki <rafael.j.wysocki@intel.com>
24	- Viresh Kumar <viresh.kumar@linaro.org>
25
26.. Contents
27
28   1.   怎么做？
29   1.1  初始化
30   1.2  Per-CPU 初始化
31   1.3  验证
32   1.4  target/target_index 或 setpolicy?
33   1.5  target/target_index
34   1.6  setpolicy
35   1.7  get_intermediate 与 target_intermediate
36   2.   频率表助手
37
38
39
401. 怎么做？
41===========
42
43如果，你刚刚得到了一个全新的CPU/芯片组及其数据手册，并希望为这个CPU/芯片组添加cpufreq
44支持？很好，这里有一些至关重要的提示：
45
46
471.1 初始化
48----------
49
50首先，在 __initcall level 7 (module_init())或更靠后的函数中检查这个内核是否
51运行在正确的CPU和正确的芯片组上。如果是，则使用cpufreq_register_driver()向
52CPUfreq核心层注册一个cpufreq_driver结构体。
53
54结构体cpufreq_driver应该包含什么成员?
55
56 .name - 驱动的名字。
57
58 .init - 一个指向per-policy初始化函数的指针。
59
60 .verify - 一个指向"verification"函数的指针。
61
62 .setpolicy 或 .fast_switch 或 .target 或 .target_index - 差异见
63 下文。
64
65其它可选成员
66
67 .flags - 给cpufreq核心的提示。
68
69 .driver_data - cpufreq驱动程序的特有数据。
70
71 .get_intermediate 和 target_intermediate - 用于在改变CPU频率时切换到稳定
72 的频率。
73
74 .get - 返回CPU的当前频率。
75
76 .bios_limit - 返回HW/BIOS对CPU的最大频率限制值。
77
78 .exit - 一个指向per-policy清理函数的指针，该函数在CPU热插拔过程的CPU_POST_DEAD
79 阶段被调用。
80
81 .suspend - 一个指向per-policy暂停函数的指针，该函数在关中断且在该策略的调节器停止
82 后被调用。
83
84 .resume - 一个指向per-policy恢复函数的指针，该函数在关中断且在调节器再一次启动前被
85 调用。
86
87 .ready - 一个指向per-policy准备函数的指针，该函数在策略完全初始化之后被调用。
88
89 .attr - 一个指向NULL结尾的"struct freq_attr"列表的指针，该列表允许导出值到
90 sysfs。
91
92 .boost_enabled - 如果设置，则启用提升(boost)频率。
93
94 .set_boost - 一个指向per-policy函数的指针，该函数用来开启/关闭提升(boost)频率功能。
95
96
971.2 Per-CPU 初始化
98------------------
99
100每当一个新的CPU被注册到设备模型中，或者当cpufreq驱动注册自身之后，如果此CPU的cpufreq策
101略不存在，则会调用per-policy的初始化函数cpufreq_driver.init。请注意，.init()和.exit()例程
102只为某个策略调用一次，而不是对该策略管理的每个CPU调用一次。它需要一个 ``struct cpufreq_policy
103*policy`` 作为参数。现在该怎么做呢？
104
105如果有必要，请在你的CPU上激活CPUfreq功能支持。
106
107然后，驱动程序必须填写以下值:
108
109+-----------------------------------+--------------------------------------+
110|policy->cpuinfo.min_freq和         | 该CPU支持的最低和最高频率（kHz）     |
111|policy->cpuinfo.max_freq           |                                      |
112|                                   |                                      |
113+-----------------------------------+--------------------------------------+
114|policy->cpuinfo.transition_latency | CPU在两个频率之间切换所需的时间，以  |
115|                                   | 纳秒为单位（如不适用，设定为         |
116|                                   | CPUFREQ_ETERNAL）                    |
117|                                   |                                      |
118+-----------------------------------+--------------------------------------+
119|policy->cur                        | 该CPU当前的工作频率(如适用)          |
120|                                   |                                      |
121+-----------------------------------+--------------------------------------+
122|policy->min,                       | 必须包含该CPU的"默认策略"。稍后      |
123|policy->max,                       | 会用这些值调用                       |
124|policy->policy and, if necessary,  | cpufreq_driver.verify和下面函数      |
125|policy->governor                   | 之一：cpufreq_driver.setpolicy或     |
126|                                   | cpufreq_driver.target/target_index   |
127|                                   |                                      |
128+-----------------------------------+--------------------------------------+
129|policy->cpus                       | 该policy通过DVFS框架影响的全部CPU    |
130|                                   | (即与本CPU共享"时钟/电压"对)构成     |
131|                                   | 掩码(同时包含在线和离线CPU)，用掩码  |
132|                                   | 更新本字段                           |
133|                                   |                                      |
134+-----------------------------------+--------------------------------------+
135
136对于设置其中的一些值(cpuinfo.min[max]_freq, policy->min[max])，频率表辅助函数可能会有帮
137助。关于它们的更多信息，请参见第2节。
138
139
1401.3 验证
141--------
142
143当用户决定设置一个新的策略(由"policy,governor,min,max组成")时，必须对这个策略进行验证，
144以便纠正不兼容的值。为了验证这些值，cpufreq_verify_within_limits(``struct cpufreq_policy
145*policy``, ``unsigned int min_freq``, ``unsigned int max_freq``)函数可能会有帮助。
146关于频率表辅助函数的详细内容请参见第2节。
147
148您需要确保至少有一个有效频率（或工作范围）在 policy->min 和 policy->max 范围内。如果有必
149要，先增大policy->max，只有在没有解决方案的情况下，才减小policy->min。
150
151
1521.4 target 或 target_index 或 setpolicy 或 fast_switch?
153-------------------------------------------------------
154
155大多数cpufreq驱动甚至大多数CPU频率升降算法只允许将CPU频率设置为预定义的固定值。对于这些，你
156可以使用->target()，->target_index()或->fast_switch()回调。
157
158有些具有硬件调频能力的处理器可以自行依据某些限制来切换CPU频率。它们应使用->setpolicy()回调。
159
160
1611.5. target/target_index
162------------------------
163
164target_index调用有两个参数： ``struct cpufreq_policy * policy`` 和 ``unsigned int``
165索引(用于索引频率表项)。
166
167当调用这里时，CPUfreq驱动必须设置新的频率。实际频率必须由freq_table[index].frequency决定。
168
169在发生错误的情况下总是应该恢复到之前的频率(即policy->restore_freq)，即使我们已经切换到了
170中间频率。
171
172已弃用
173----------
174target调用有三个参数。``struct cpufreq_policy * policy``, unsigned int target_frequency,
175unsigned int relation.
176
177CPUfreq驱动在调用这里时必须设置新的频率。实际的频率必须使用以下规则来确定。
178
179- 尽量贴近"目标频率"。
180- policy->min <= new_freq <= policy->max (这必须是有效的!!!)
181- 如果 relation==CPUFREQ_REL_L，尝试选择一个高于或等于 target_freq 的 new_freq。("L代表
182  最低，但不能低于")
183- 如果 relation==CPUFREQ_REL_H，尝试选择一个低于或等于 target_freq 的 new_freq。("H代表
184  最高，但不能高于")
185
186这里，频率表辅助函数可能会帮助你 -- 详见第2节。
187
1881.6. fast_switch
189----------------
190
191这个函数用于从调度器的上下文进行频率切换。并非所有的驱动都要实现它，因为不允许在这个回调中睡眠。这
192个回调必须经过高度优化，以尽可能快地进行切换。
193
194这个函数有两个参数： ``struct cpufreq_policy *policy`` 和 ``unsigned int target_frequency``。
195
196
1971.7 setpolicy
198-------------
199
200setpolicy调用只需要一个 ``struct cpufreq_policy * policy`` 作为参数。需要将处理器内或芯片组内动态频
201率切换的下限设置为policy->min，上限设置为policy->max，如果支持的话，当policy->policy为
202CPUFREQ_POLICY_PERFORMANCE时选择面向性能的设置，为CPUFREQ_POLICY_POWERSAVE时选择面向省电的设置。
203也可以查看drivers/cpufreq/longrun.c中的参考实现。
204
2051.8 get_intermediate 和 target_intermediate
206--------------------------------------------
207
208仅适用于未设置 target_index() 和 CPUFREQ_ASYNC_NOTIFICATION 的驱动。
209
210get_intermediate应该返回一个平台想要切换到的稳定的中间频率，target_intermediate()应该将CPU设置为
211该频率，然后再跳转到'index'对应的频率。cpufreq核心会负责发送通知，驱动不必在
212target_intermediate()或target_index()中处理它们。
213
214在驱动程序不想为某个目标频率切换到中间频率的情况下，它们可以让get_intermediate()返回'0'。
215在这种情况下，cpufreq核心将直接调用->target_index()。
216
217注意：->target_index()应该在发生失败的情况下将频率恢复到policy->restore_freq，
218因为cpufreq核心会为此发送通知。
219
220
2212. 频率表辅助函数
222=================
223
224由于大多数支持cpufreq的处理器只允许被设置为几个特定的频率，因此，"频率表"和一些相关函数可能会辅助处理器驱动
225程序的一些工作。这样的"频率表"是一个由struct cpufreq_frequency_table的条目构成的数组，"driver_data"成员包
226含驱动程序的专用值，"frequency"成员包含了相应的频率，此外还有标志成员。在表的最后，需要添加一个
227cpufreq_frequency_table条目，频率设置为CPUFREQ_TABLE_END。如果想跳过表中的一个条目，则将频率设置为
228CPUFREQ_ENTRY_INVALID。这些条目不需要按照任何特定的顺序排序，如果排序了，cpufreq核心执行DVFS会更快一点，
229因为搜索最佳匹配会更快。
230
231如果在policy->freq_table字段中包含一个有效的频率表指针，频率表就会被cpufreq核心自动验证。
232
233cpufreq_frequency_table_verify()保证至少有一个有效的频率在policy->min和policy->max范围内，并且所有其他
234准则都被满足。这对->verify调用很有帮助。
235
236cpufreq_frequency_table_target()是对应于->target阶段的频率表辅助函数。只要把值传递给这个函数，这个函数就会返
237回包含CPU要设置的频率的频率表条目。
238
239以下宏可以作为cpufreq_frequency_table的迭代器。
240
241cpufreq_for_each_entry(pos, table) - 遍历频率表的所有条目。
242
243cpufreq_for_each_valid_entry(pos, table) - 该函数遍历所有条目，不包括CPUFREQ_ENTRY_INVALID频率。
244使用参数"pos" -- 一个 ``cpufreq_frequency_table *`` 作为循环指针，使用参数"table" -- 作为你想迭代
245的 ``cpufreq_frequency_table *`` 。
246
247例如::
248
249	struct cpufreq_frequency_table *pos, *driver_freq_table;
250
251	cpufreq_for_each_entry(pos, driver_freq_table) {
252		/* Do something with pos */
253		pos->frequency = ...
254	}
255
256如果你需要在driver_freq_table中处理pos的位置，不要做指针减法，因为它的代价相当高。作为替代，使用宏
257cpufreq_for_each_entry_idx() 和 cpufreq_for_each_valid_entry_idx() 。
258