0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 .. include:: ../disclaimer-zh_TW.rst
0004
0005 :Original: :doc:`../../../cpu-freq/cpu-drivers`
0006 :Translator: Yanteng Si <siyanteng@loongson.cn>
0007 Hu Haowen <src.res@email.cn>
0008
0009 .. _tw_cpu-drivers.rst:
0010
0011
0012 =======================================
0013 如何實現一個新的CPUFreq處理器驅動程序？
0014 =======================================
0015
0016 作者:
0017
0018
0019 - Dominik Brodowski <linux@brodo.de>
0020 - Rafael J. Wysocki <rafael.j.wysocki@intel.com>
0021 - Viresh Kumar <viresh.kumar@linaro.org>
0022
0023 .. Contents
0024
0025 1. 怎麼做？
0026 1.1 初始化
0027 1.2 Per-CPU 初始化
0028 1.3 驗證
0029 1.4 target/target_index 或 setpolicy?
0030 1.5 target/target_index
0031 1.6 setpolicy
0032 1.7 get_intermediate 與 target_intermediate
0033 2. 頻率表助手
0034
0035
0036
0037 1. 怎麼做？
0038 ===========
0039
0040 如此，你剛剛得到了一個全新的CPU/晶片組及其數據手冊，並希望爲這個CPU/晶片組添加cpufreq
0041 支持？很好，這裡有一些至關重要的提示：
0042
0043
0044 1.1 初始化
0045 ----------
0046
0047 首先，在__initcall_level_7 (module_init())或更靠後的函數中檢查這個內核是否
0048 運行在正確的CPU和正確的晶片組上。如果是，則使用cpufreq_register_driver()向
0049 CPUfreq核心層註冊一個cpufreq_driver結構體。
0050
0051 結構體cpufreq_driver應該包含什麼成員?
0052
0053 .name - 驅動的名字。
0054
0055 .init - 一個指向per-policy初始化函數的指針。
0056
0057 .verify - 一個指向"verification"函數的指針。
0058
0059 .setpolicy 或 .fast_switch 或 .target 或 .target_index - 差異見
0060 下文。
0061
0062 並且可選擇
0063
0064 .flags - cpufreq核的提示。
0065
0066 .driver_data - cpufreq驅動程序的特定數據。
0067
0068 .get_intermediate 和 target_intermediate - 用於在改變CPU頻率時切換到穩定
0069 的頻率。
0070
0071 .get - 返回CPU的當前頻率。
0072
0073 .bios_limit - 返回HW/BIOS對CPU的最大頻率限制值。
0074
0075 .exit - 一個指向per-policy清理函數的指針，該函數在cpu熱插拔過程的CPU_POST_DEAD
0076 階段被調用。
0077
0078 .suspend - 一個指向per-policy暫停函數的指針，該函數在關中斷且在該策略的調節器停止
0079 後被調用。
0080
0081 .resume - 一個指向per-policy恢復函數的指針，該函數在關中斷且在調節器再一次開始前被
0082 調用。
0083
0084 .ready - 一個指向per-policy準備函數的指針，該函數在策略完全初始化之後被調用。
0085
0086 .attr - 一個指向NULL結尾的"struct freq_attr"列表的指針，該函數允許導出值到
0087 sysfs。
0088
0089 .boost_enabled - 如果設置，則啓用提升(boost)頻率。
0090
0091 .set_boost - 一個指向per-policy函數的指針，該函數用來開啓/關閉提升(boost)頻率功能。
0092
0093
0094 1.2 Per-CPU 初始化
0095 ------------------
0096
0097 每當一個新的CPU被註冊到設備模型中，或者在cpufreq驅動註冊自己之後，如果此CPU的cpufreq策
0098 略不存在，則會調用per-policy的初始化函數cpufreq_driver.init。請注意，.init()和.exit()程序
0099 只對策略調用一次，而不是對策略管理的每個CPU調用一次。它需要一個 ``struct cpufreq_policy
0100 *policy`` 作爲參數。現在該怎麼做呢？
0101
0102 如果有必要，請在你的CPU上激活CPUfreq功能支持。
0103
0104 然後，驅動程序必須填寫以下數值:
0105
0106 +-----------------------------------+--------------------------------------+
0107 |policy->cpuinfo.min_freq 和 | |
0108 |policy->cpuinfo.max_freq | 該CPU支持的最低和最高頻率（kHz） |
0109 | | |
0110 | | |
0111 +-----------------------------------+--------------------------------------+
0112 |policy->cpuinfo.transition_latency | |
0113 | | CPU在兩個頻率之間切換所需的時間，以 |
0114 | | 納秒爲單位（如適用，否則指定 |
0115 | | CPUFREQ_ETERNAL） |
0116 +-----------------------------------+--------------------------------------+
0117 |policy->cur | 該CPU當前的工作頻率(如適用) |
0118 | | |
0119 +-----------------------------------+--------------------------------------+
0120 |policy->min, | |
0121 |policy->max, | |
0122 |policy->policy and, if necessary, | |
0123 |policy->governor | 必須包含該cpu的 「默認策略」。稍後 |
0124 | | 會用這些值調用 |
0125 | | cpufreq_driver.verify and either |
0126 | | cpufreq_driver.setpolicy or |
0127 | | cpufreq_driver.target/target_index |
0128 | | |
0129 +-----------------------------------+--------------------------------------+
0130 |policy->cpus | 用與這個CPU一起做DVFS的(在線+離線) |
0131 | | CPU(即與它共享時鐘/電壓軌)的掩碼更新 |
0132 | | 這個 |
0133 | | |
0134 +-----------------------------------+--------------------------------------+
0135
0136 對於設置其中的一些值(cpuinfo.min[max]_freq, policy->min[max])，頻率表助手可能會有幫
0137 助。關於它們的更多信息，請參見第2節。
0138
0139
0140 1.3 驗證
0141 --------
0142
0143 當用戶決定設置一個新的策略(由 「policy,governor,min,max組成」)時，必須對這個策略進行驗證，
0144 以便糾正不兼容的值。爲了驗證這些值，cpufreq_verify_within_limits(``struct cpufreq_policy
0145 *policy``, ``unsigned int min_freq``, ``unsigned int max_freq``)函數可能會有幫助。
0146 關於頻率表助手的詳細內容請參見第2節。
0147
0148 您需要確保至少有一個有效頻率（或工作範圍）在 policy->min 和 policy->max 範圍內。如果有必
0149 要，先增加policy->max，只有在沒有辦法的情況下，才減少policy->min。
0150
0151
0152 1.4 target 或 target_index 或 setpolicy 或 fast_switch?
0153 -------------------------------------------------------
0154
0155 大多數cpufreq驅動甚至大多數cpu頻率升降算法只允許將CPU頻率設置爲預定義的固定值。對於這些，你
0156 可以使用->target()，->target_index()或->fast_switch()回調。
0157
0158 有些cpufreq功能的處理器可以自己在某些限制之間切換頻率。這些應使用->setpolicy()回調。
0159
0160
0161 1.5. target/target_index
0162 ------------------------
0163
0164 target_index調用有兩個參數：``struct cpufreq_policy * policy``和``unsigned int``
0165 索引(於列出的頻率表)。
0166
0167 當調用這裡時，CPUfreq驅動必須設置新的頻率。實際頻率必須由freq_table[index].frequency決定。
0168
0169 它應該總是在錯誤的情況下恢復到之前的頻率(即policy->restore_freq)，即使我們之前切換到中間頻率。
0170
0171 已棄用
0172 ----------
0173 目標調用有三個參數。``struct cpufreq_policy * policy``, unsigned int target_frequency,
0174 unsigned int relation.
0175
0176 CPUfreq驅動在調用這裡時必須設置新的頻率。實際的頻率必須使用以下規則來確定。
0177
0178 - 緊跟 "目標頻率"。
0179 - policy->min <= new_freq <= policy->max (這必須是有效的!!!)
0180 - 如果 relation==CPUFREQ_REL_L，嘗試選擇一個高於或等於 target_freq 的 new_freq。("L代表
0181 最低，但不能低於")
0182 - 如果 relation==CPUFREQ_REL_H，嘗試選擇一個低於或等於 target_freq 的 new_freq。("H代表
0183 最高，但不能高於")
0184
0185 這裡，頻率表助手可能會幫助你--詳見第2節。
0186
0187 1.6. fast_switch
0188 ----------------
0189
0190 這個函數用於從調度器的上下文進行頻率切換。並非所有的驅動都要實現它，因爲不允許在這個回調中睡眠。這
0191 個回調必須經過高度優化，以儘可能快地進行切換。
0192
0193 這個函數有兩個參數： ``struct cpufreq_policy *policy`` 和 ``unsigned int target_frequency``。
0194
0195
0196 1.7 setpolicy
0197 -------------
0198
0199 setpolicy調用只需要一個``struct cpufreq_policy * policy``作爲參數。需要將處理器內或晶片組內動態頻
0200 率切換的下限設置爲policy->min，上限設置爲policy->max，如果支持的話，當policy->policy爲
0201 CPUFREQ_POLICY_PERFORMANCE時選擇面向性能的設置，當CPUFREQ_POLICY_POWERSAVE時選擇面向省電的設置。
0202 也可以查看drivers/cpufreq/longrun.c中的參考實現。
0203
0204 1.8 get_intermediate 和 target_intermediate
0205 --------------------------------------------
0206
0207 僅適用於 target_index() 和 CPUFREQ_ASYNC_NOTIFICATION 未設置的驅動。
0208
0209 get_intermediate應該返回一個平台想要切換到的穩定的中間頻率，target_intermediate()應該將CPU設置爲
0210 該頻率，然後再跳轉到'index'對應的頻率。核心會負責發送通知，驅動不必在target_intermediate()或
0211 target_index()中處理。
0212
0213 在驅動程序不想因爲某個目標頻率切換到中間頻率的情況下，它們可以從get_intermediate()中返回'0'。在這種情況
0214 下，核心將直接調用->target_index()。
0215
0216 注意：->target_index()應該在失敗的情況下恢復到policy->restore_freq，因爲core會爲此發送通知。
0217
0218
0219 2. 頻率表助手
0220 =============
0221
0222 由於大多數cpufreq處理器只允許被設置爲幾個特定的頻率，因此，一個帶有一些函數的 「頻率表」可能會輔助處理器驅動
0223 程序的一些工作。這樣的 "頻率表" 由一個cpufreq_frequency_table條目構成的數組組成，"driver_data" 中包
0224 含了驅動程序的具體數值，"frequency" 中包含了相應的頻率，並設置了標誌。在表的最後，需要添加一個
0225 cpufreq_frequency_table條目，頻率設置爲CPUFREQ_TABLE_END。而如果想跳過表中的一個條目，則將頻率設置爲
0226 CPUFREQ_ENTRY_INVALID。這些條目不需要按照任何特定的順序排序，但如果它們是cpufreq 核心會對它們進行快速的DVFS，
0227 因爲搜索最佳匹配會更快。
0228
0229 如果策略在其policy->freq_table欄位中包含一個有效的指針，cpufreq表就會被核心自動驗證。
0230
0231 cpufreq_frequency_table_verify()保證至少有一個有效的頻率在policy->min和policy->max範圍內，並且所有其他
0232 標準都被滿足。這對->verify調用很有幫助。
0233
0234 cpufreq_frequency_table_target()是對應於->target階段的頻率表助手。只要把數值傳遞給這個函數，這個函數就會返
0235 回包含CPU要設置的頻率的頻率表條目。
0236
0237 以下宏可以作爲cpufreq_frequency_table的疊代器。
0238
0239 cpufreq_for_each_entry(pos, table) - 遍歷頻率表的所有條目。
0240
0241 cpufreq_for_each_valid_entry(pos, table) - 該函數遍歷所有條目，不包括CPUFREQ_ENTRY_INVALID頻率。
0242 使用參數 "pos"-一個``cpufreq_frequency_table * `` 作爲循環變量，使用參數 "table"-作爲你想疊代
0243 的``cpufreq_frequency_table * `` 。
0244
0245 例如::
0246
0247 struct cpufreq_frequency_table *pos, *driver_freq_table;
0248
0249 cpufreq_for_each_entry(pos, driver_freq_table) {
0250 /* Do something with pos */
0251 pos->frequency = ...
0252 }
0253
0254 如果你需要在driver_freq_table中處理pos的位置，不要減去指針，因爲它的代價相當高。相反，使用宏
0255 cpufreq_for_each_entry_idx() 和 cpufreq_for_each_valid_entry_idx() 。
0256
