0001 .. SPDX-License-Identifier: GPL-2.0
0002 .. include:: ../disclaimer-zh_CN.rst
0003
0004 :Original: Documentation/power/opp.rst
0005
0006 :翻译:
0007
0008 唐艺舟 Tang Yizhou <tangyeechou@gmail.com>
0009
0010 ======================
0011 操作性能值（OPP）库
0012 ======================
0013
0014 (C) 2009-2010 Nishanth Menon <nm@ti.com>, 德州仪器公司
0015
0016 .. 目录
0017
0018 1. 简介
0019 2. OPP链表初始注册
0020 3. OPP搜索函数
0021 4. OPP可用性控制函数
0022 5. OPP数据检索函数
0023 6. 数据结构
0024
0025 1. 简介
0026 =======
0027
0028 1.1 何为操作性能值（OPP）？
0029 ------------------------------
0030
0031 当今复杂的单片系统（SoC）由多个子模块组成，这些子模块会联合工作。在一个执行不同用例
0032 的操作系统中，并不是SoC中的所有模块都需要一直以最高频率工作。为了促成这一点，SoC中
0033 的子模块被分组为不同域，允许一些域以较低的电压和频率运行，而其它域则以较高的“电压/
0034 频率对”运行。
0035
0036 设备按域支持的由频率电压对组成的离散的元组的集合，被称为操作性能值（组），或OPPs。
0037
0038 举例来说：
0039
0040 让我们考虑一个支持下述频率、电压值的内存保护单元（MPU）设备：
0041 {300MHz，最低电压为1V}, {800MHz，最低电压为1.2V}, {1GHz，最低电压为1.3V}
0042
0043 我们能将它们表示为3个OPP，如下述{Hz, uV}元组（译注：频率的单位是赫兹，电压的单位是
0044 微伏）。
0045
0046 - {300000000, 1000000}
0047 - {800000000, 1200000}
0048 - {1000000000, 1300000}
0049
0050 1.2 操作性能值库
0051 ----------------
0052
0053 OPP库提供了一组辅助函数来组织和查询OPP信息。该库位于drivers/opp/目录下，其头文件
0054 位于include/linux/pm_opp.h中。OPP库可以通过开启CONFIG_PM_OPP来启用。某些SoC，
0055 如德州仪器的OMAP框架允许在不需要cpufreq的情况下可选地在某一OPP下启动。
0056
0057 OPP库的典型用法如下::
0058
0059 （用户） -> 注册一个默认的OPP集合 -> （库）
0060 （SoC框架） -> 在必要的情况下，对某些OPP进行修改 -> OPP layer
0061 -> 搜索/检索信息的查询 ->
0062
0063 OPP层期望每个域由一个唯一的设备指针来表示。SoC框架在OPP层为每个设备注册了一组初始
0064 OPP。这个链表的长度被期望是一个最优化的小数字，通常每个设备大约5个。初始链表包含了
0065 一个OPP集合，这个集合被期望能在系统中安全使能。
0066
0067 关于OPP可用性的说明
0068 ^^^^^^^^^^^^^^^^^^^
0069
0070 随着系统的运行，SoC框架可能会基于各种外部因素选择让某些OPP在每个设备上可用或不可用，
0071 示例：温度管理或其它异常场景中，SoC框架可能会选择禁用一个较高频率的OPP以安全地继续
0072 运行，直到该OPP被重新启用（如果可能）。
0073
0074 OPP库在它的实现中达成了这个概念。以下操作函数只能对可用的OPP使用：
0075 dev_pm_opp_find_freq_{ceil, floor}, dev_pm_opp_get_voltage,
0076 dev_pm_opp_get_freq, dev_pm_opp_get_opp_count。
0077
0078 dev_pm_opp_find_freq_exact是用来查找OPP指针的，该指针可被用在dev_pm_opp_enable/
0079 disable函数，使一个OPP在被需要时变为可用。
0080
0081 警告：如果对一个设备调用dev_pm_opp_enable/disable函数，OPP库的用户应该使用
0082 dev_pm_opp_get_opp_count来刷新OPP的可用性计数。触发这些的具体机制，或者对有依赖的
0083 子系统（比如cpufreq）的通知机制，都是由使用OPP库的SoC特定框架酌情处理的。在这些操作
0084 中，同样需要注意刷新cpufreq表。
0085
0086 2. OPP链表初始注册
0087 ==================
0088 SoC的实现会迭代调用dev_pm_opp_add函数来增加每个设备的OPP。预期SoC框架将以最优的
0089 方式注册OPP条目 - 典型的数字范围小于5。通过注册OPP生成的OPP链表，在整个设备运行过程
0090 中由OPP库维护。SoC框架随后可以使用dev_pm_opp_enable / disable函数动态地
0091 控制OPP的可用性。
0092
0093 dev_pm_opp_add
0094 为设备指针所指向的特定域添加一个新的OPP。OPP是用频率和电压定义的。一旦完成
0095 添加，OPP被认为是可用的，可以用dev_pm_opp_enable/disable函数来控制其可用性。
0096 OPP库内部用dev_pm_opp结构体存储并管理这些信息。这个函数可以被SoC框架根据SoC
0097 的使用环境的需求来定义一个最优链表。
0098
0099 警告：
0100 不要在中断上下文使用这个函数。
0101
0102 示例::
0103
0104 soc_pm_init()
0105 {
0106 /* 做一些事情 */
0107 r = dev_pm_opp_add(mpu_dev, 1000000, 900000);
0108 if (!r) {
0109 pr_err("%s: unable to register mpu opp(%d)\n", r);
0110 goto no_cpufreq;
0111 }
0112 /* 做一些和cpufreq相关的事情 */
0113 no_cpufreq:
0114 /* 做剩余的事情 */
0115 }
0116
0117 3. OPP搜索函数
0118 ==============
0119 cpufreq等高层框架对频率进行操作，为了将频率映射到相应的OPP，OPP库提供了便利的函数
0120 来搜索OPP库内部管理的OPP链表。这些搜索函数如果找到匹配的OPP，将返回指向该OPP的指针，
0121 否则返回错误。这些错误预计由标准的错误检查，如IS_ERR()来处理，并由调用者采取适当的
0122 行动。
0123
0124 这些函数的调用者应在使用完OPP后调用dev_pm_opp_put()。否则，OPP的内存将永远不会
0125 被释放，并导致内存泄露。
0126
0127 dev_pm_opp_find_freq_exact
0128 根据 *精确的* 频率和可用性来搜索OPP。这个函数对默认不可用的OPP特别有用。
0129 例子：在SoC框架检测到更高频率可用的情况下，它可以使用这个函数在调用
0130 dev_pm_opp_enable之前找到OPP::
0131
0132 opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
0133 dev_pm_opp_put(opp);
0134 /* 不要操作指针.. 只是做有效性检查.. */
0135 if (IS_ERR(opp)) {
0136 pr_err("frequency not disabled!\n");
0137 /* 触发合适的操作.. */
0138 } else {
0139 dev_pm_opp_enable(dev,1000000000);
0140 }
0141
0142 注意：
0143 这是唯一一个可以搜索不可用OPP的函数。
0144
0145 dev_pm_opp_find_freq_floor
0146 搜索一个 *最多* 提供指定频率的可用OPP。这个函数在搜索较小的匹配或按频率
0147 递减的顺序操作OPP信息时很有用。
0148 例子：要找的一个设备的最高OPP::
0149
0150 freq = ULONG_MAX;
0151 opp = dev_pm_opp_find_freq_floor(dev, &freq);
0152 dev_pm_opp_put(opp);
0153
0154 dev_pm_opp_find_freq_ceil
0155 搜索一个 *最少* 提供指定频率的可用OPP。这个函数在搜索较大的匹配或按频率
0156 递增的顺序操作OPP信息时很有用。
0157 例1：找到一个设备最小的OPP::
0158
0159 freq = 0;
0160 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
0161 dev_pm_opp_put(opp);
0162
0163 例: 一个SoC的cpufreq_driver->target的简易实现::
0164
0165 soc_cpufreq_target(..)
0166 {
0167 /* 做策略检查等操作 */
0168 /* 找到和请求最接近的频率 */
0169 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
0170 dev_pm_opp_put(opp);
0171 if (!IS_ERR(opp))
0172 soc_switch_to_freq_voltage(freq);
0173 else
0174 /* 当不能满足请求时，要做的事 */
0175 /* 做其它事 */
0176 }
0177
0178 4. OPP可用性控制函数
0179 ====================
0180 在OPP库中注册的默认OPP链表也许无法满足所有可能的场景。OPP库提供了一套函数来修改
0181 OPP链表中的某个OPP的可用性。这使得SoC框架能够精细地动态控制哪一组OPP是可用于操作
0182 的。设计这些函数的目的是在诸如考虑温度时 *暂时地* 删除某个OPP（例如，在温度下降
0183 之前不要使用某OPP）。
0184
0185 警告：
0186 不要在中断上下文使用这些函数。
0187
0188 dev_pm_opp_enable
0189 使一个OPP可用于操作。
0190 例子：假设1GHz的OPP只有在SoC温度低于某个阈值时才可用。SoC框架的实现可能
0191 会选择做以下事情::
0192
0193 if (cur_temp < temp_low_thresh) {
0194 /* 若1GHz未使能，则使能 */
0195 opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
0196 dev_pm_opp_put(opp);
0197 /* 仅仅是错误检查 */
0198 if (!IS_ERR(opp))
0199 ret = dev_pm_opp_enable(dev, 1000000000);
0200 else
0201 goto try_something_else;
0202 }
0203
0204 dev_pm_opp_disable
0205 使一个OPP不可用于操作。
0206 例子：假设1GHz的OPP只有在SoC温度高于某个阈值时才可用。SoC框架的实现可能
0207 会选择做以下事情::
0208
0209 if (cur_temp > temp_high_thresh) {
0210 /* 若1GHz已使能，则关闭 */
0211 opp = dev_pm_opp_find_freq_exact(dev, 1000000000, true);
0212 dev_pm_opp_put(opp);
0213 /* 仅仅是错误检查 */
0214 if (!IS_ERR(opp))
0215 ret = dev_pm_opp_disable(dev, 1000000000);
0216 else
0217 goto try_something_else;
0218 }
0219
0220 5. OPP数据检索函数
0221 ==================
0222 由于OPP库对OPP信息进行了抽象化处理，因此需要一组函数来从dev_pm_opp结构体中提取
0223 信息。一旦使用搜索函数检索到一个OPP指针，以下函数就可以被SoC框架用来检索OPP层
0224 内部描述的信息。
0225
0226 dev_pm_opp_get_voltage
0227 检索OPP指针描述的电压。
0228 例子: 当cpufreq切换到到不同频率时，SoC框架需要用稳压器框架将OPP描述
0229 的电压设置到提供电压的电源管理芯片中::
0230
0231 soc_switch_to_freq_voltage(freq)
0232 {
0233 /* 做一些事情 */
0234 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
0235 v = dev_pm_opp_get_voltage(opp);
0236 dev_pm_opp_put(opp);
0237 if (v)
0238 regulator_set_voltage(.., v);
0239 /* 做其它事 */
0240 }
0241
0242 dev_pm_opp_get_freq
0243 检索OPP指针描述的频率。
0244 例子：比方说，SoC框架使用了几个辅助函数，通过这些函数，我们可以将OPP
0245 指针传入，而不是传入额外的参数，用来处理一系列数据参数::
0246
0247 soc_cpufreq_target(..)
0248 {
0249 /* 做一些事情.. */
0250 max_freq = ULONG_MAX;
0251 max_opp = dev_pm_opp_find_freq_floor(dev,&max_freq);
0252 requested_opp = dev_pm_opp_find_freq_ceil(dev,&freq);
0253 if (!IS_ERR(max_opp) && !IS_ERR(requested_opp))
0254 r = soc_test_validity(max_opp, requested_opp);
0255 dev_pm_opp_put(max_opp);
0256 dev_pm_opp_put(requested_opp);
0257 /* 做其它事 */
0258 }
0259 soc_test_validity(..)
0260 {
0261 if(dev_pm_opp_get_voltage(max_opp) < dev_pm_opp_get_voltage(requested_opp))
0262 return -EINVAL;
0263 if(dev_pm_opp_get_freq(max_opp) < dev_pm_opp_get_freq(requested_opp))
0264 return -EINVAL;
0265 /* 做一些事情.. */
0266 }
0267
0268 dev_pm_opp_get_opp_count
0269 检索某个设备可用的OPP数量。
0270 例子：假设SoC中的一个协处理器需要知道某个表中的可用频率，主处理器可以
0271 按如下方式发出通知::
0272
0273 soc_notify_coproc_available_frequencies()
0274 {
0275 /* 做一些事情 */
0276 num_available = dev_pm_opp_get_opp_count(dev);
0277 speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
0278 /* 按升序填充表 */
0279 freq = 0;
0280 while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
0281 speeds[i] = freq;
0282 freq++;
0283 i++;
0284 dev_pm_opp_put(opp);
0285 }
0286
0287 soc_notify_coproc(AVAILABLE_FREQs, speeds, num_available);
0288 /* 做其它事 */
0289 }
0290
0291 6. 数据结构
0292 ===========
0293 通常，一个SoC包含多个可变电压域。每个域由一个设备指针描述。和OPP之间的关系可以
0294 按以下方式描述::
0295
0296 SoC
0297 |- device 1
0298 | |- opp 1 (availability, freq, voltage)
0299 | |- opp 2 ..
0300 ... ...
0301 | `- opp n ..
0302 |- device 2
0303 ...
0304 `- device m
0305
0306 OPP库维护着一个内部链表，SoC框架使用上文描述的各个函数来填充和访问。然而，描述
0307 真实OPP和域的结构体是OPP库自身的内部组成，以允许合适的抽象在不同系统中得到复用。
0308
0309 struct dev_pm_opp
0310 OPP库的内部数据结构，用于表示一个OPP。除了频率、电压、可用性信息外，
0311 它还包含OPP库运行所需的内部统计信息。指向这个结构体的指针被提供给
0312 用户（比如SoC框架）使用，在与OPP层的交互中作为OPP的标识符。
0313
0314 警告：
0315 结构体dev_pm_opp的指针不应该由用户解析或修改。一个实例的默认值由
0316 dev_pm_opp_add填充，但OPP的可用性由dev_pm_opp_enable/disable函数
0317 修改。
0318
0319 struct device
0320 这用于向OPP层标识一个域。设备的性质和它的实现是由OPP库的用户决定的，
0321 如SoC框架。
0322
0323 总体来说，以一个简化的视角看，对数据结构的操作可以描述为下面各图::
0324
0325 初始化 / 修改:
0326 +-----+ /- dev_pm_opp_enable
0327 dev_pm_opp_add --> | opp | <-------
0328 | +-----+ \- dev_pm_opp_disable
0329 \-------> domain_info(device)
0330
0331 搜索函数:
0332 /-- dev_pm_opp_find_freq_ceil ---\ +-----+
0333 domain_info<---- dev_pm_opp_find_freq_exact -----> | opp |
0334 \-- dev_pm_opp_find_freq_floor ---/ +-----+
0335
0336 检索函数:
0337 +-----+ /- dev_pm_opp_get_voltage
0338 | opp | <---
0339 +-----+ \- dev_pm_opp_get_freq
0340
0341 domain_info <- dev_pm_opp_get_opp_count
