Documentation/translations/zh_CN/cpu-freq/cpu-drivers.rst

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