1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * AMD Platform Management Framework Driver
4 *
5 * Copyright (c) 2022, Advanced Micro Devices, Inc.
6 * All Rights Reserved.
7 *
8 * Author: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
9 */
10
11 #include <linux/debugfs.h>
12 #include <linux/iopoll.h>
13 #include <linux/module.h>
14 #include <linux/pci.h>
15 #include <linux/platform_device.h>
16 #include <linux/power_supply.h>
17 #include <asm/amd_node.h>
18 #include "pmf.h"
19
20 /* PMF-SMU communication registers */
21 #define AMD_PMF_REGISTER_MESSAGE 0xA18
22 #define AMD_PMF_REGISTER_RESPONSE 0xA78
23 #define AMD_PMF_REGISTER_ARGUMENT 0xA58
24
25 /* Base address of SMU for mapping physical address to virtual address */
26 #define AMD_PMF_MAPPING_SIZE 0x01000
27 #define AMD_PMF_BASE_ADDR_OFFSET 0x10000
28 #define AMD_PMF_BASE_ADDR_LO 0x13B102E8
29 #define AMD_PMF_BASE_ADDR_HI 0x13B102EC
30 #define AMD_PMF_BASE_ADDR_LO_MASK GENMASK(15, 0)
31 #define AMD_PMF_BASE_ADDR_HI_MASK GENMASK(31, 20)
32
33 /* SMU Response Codes */
34 #define AMD_PMF_RESULT_OK 0x01
35 #define AMD_PMF_RESULT_CMD_REJECT_BUSY 0xFC
36 #define AMD_PMF_RESULT_CMD_REJECT_PREREQ 0xFD
37 #define AMD_PMF_RESULT_CMD_UNKNOWN 0xFE
38 #define AMD_PMF_RESULT_FAILED 0xFF
39
40 #define PMF_MSG_DELAY_MIN_US 50
41 #define RESPONSE_REGISTER_LOOP_MAX 20000
42
43 #define DELAY_MIN_US 2000
44 #define DELAY_MAX_US 3000
45
46 /* override Metrics Table sample size time (in ms) */
47 static int metrics_table_loop_ms = 1000;
48 module_param(metrics_table_loop_ms, int, 0644);
49 MODULE_PARM_DESC(metrics_table_loop_ms, "Metrics Table sample size time (default = 1000ms)");
50
51 /* Force load on supported older platforms */
52 static bool force_load;
53 module_param(force_load, bool, 0444);
54 MODULE_PARM_DESC(force_load, "Force load this driver on supported older platforms (experimental)");
55
amd_pmf_pwr_src_notify_call(struct notifier_block * nb,unsigned long event,void * data)56 static int amd_pmf_pwr_src_notify_call(struct notifier_block *nb, unsigned long event, void *data)
57 {
58 struct amd_pmf_dev *pmf = container_of(nb, struct amd_pmf_dev, pwr_src_notifier);
59
60 if (event != PSY_EVENT_PROP_CHANGED)
61 return NOTIFY_OK;
62
63 if (is_apmf_func_supported(pmf, APMF_FUNC_AUTO_MODE) ||
64 is_apmf_func_supported(pmf, APMF_FUNC_DYN_SLIDER_DC) ||
65 is_apmf_func_supported(pmf, APMF_FUNC_DYN_SLIDER_AC)) {
66 if ((pmf->amt_enabled || pmf->cnqf_enabled) && is_pprof_balanced(pmf))
67 return NOTIFY_DONE;
68 }
69
70 if (is_apmf_func_supported(pmf, APMF_FUNC_STATIC_SLIDER_GRANULAR))
71 amd_pmf_set_sps_power_limits(pmf);
72
73 if (is_apmf_func_supported(pmf, APMF_FUNC_OS_POWER_SLIDER_UPDATE))
74 amd_pmf_power_slider_update_event(pmf);
75
76 return NOTIFY_OK;
77 }
78
current_power_limits_show(struct seq_file * seq,void * unused)79 static int current_power_limits_show(struct seq_file *seq, void *unused)
80 {
81 struct amd_pmf_dev *dev = seq->private;
82 struct amd_pmf_static_slider_granular table;
83 int mode, src = 0;
84
85 mode = amd_pmf_get_pprof_modes(dev);
86 if (mode < 0)
87 return mode;
88
89 src = amd_pmf_get_power_source();
90 amd_pmf_update_slider(dev, SLIDER_OP_GET, mode, &table);
91 seq_printf(seq, "spl:%u fppt:%u sppt:%u sppt_apu_only:%u stt_min:%u stt[APU]:%u stt[HS2]: %u\n",
92 table.prop[src][mode].spl,
93 table.prop[src][mode].fppt,
94 table.prop[src][mode].sppt,
95 table.prop[src][mode].sppt_apu_only,
96 table.prop[src][mode].stt_min,
97 table.prop[src][mode].stt_skin_temp[STT_TEMP_APU],
98 table.prop[src][mode].stt_skin_temp[STT_TEMP_HS2]);
99 return 0;
100 }
101 DEFINE_SHOW_ATTRIBUTE(current_power_limits);
102
amd_pmf_dbgfs_unregister(struct amd_pmf_dev * dev)103 static void amd_pmf_dbgfs_unregister(struct amd_pmf_dev *dev)
104 {
105 debugfs_remove_recursive(dev->dbgfs_dir);
106 }
107
amd_pmf_dbgfs_register(struct amd_pmf_dev * dev)108 static void amd_pmf_dbgfs_register(struct amd_pmf_dev *dev)
109 {
110 dev->dbgfs_dir = debugfs_create_dir("amd_pmf", NULL);
111 if (dev->pmf_if_version == PMF_IF_V1)
112 debugfs_create_file("current_power_limits", 0644, dev->dbgfs_dir, dev,
113 ¤t_power_limits_fops);
114 }
115
amd_pmf_get_power_source(void)116 int amd_pmf_get_power_source(void)
117 {
118 if (power_supply_is_system_supplied() > 0)
119 return POWER_SOURCE_AC;
120 else
121 return POWER_SOURCE_DC;
122 }
123
amd_pmf_get_metrics(struct work_struct * work)124 static void amd_pmf_get_metrics(struct work_struct *work)
125 {
126 struct amd_pmf_dev *dev = container_of(work, struct amd_pmf_dev, work_buffer.work);
127 ktime_t time_elapsed_ms;
128 int socket_power;
129
130 guard(mutex)(&dev->update_mutex);
131
132 /* Transfer table contents */
133 memset(dev->buf, 0, sizeof(dev->m_table));
134 amd_pmf_send_cmd(dev, SET_TRANSFER_TABLE, 0, 7, NULL);
135 memcpy(&dev->m_table, dev->buf, sizeof(dev->m_table));
136
137 time_elapsed_ms = ktime_to_ms(ktime_get()) - dev->start_time;
138 /* Calculate the avg SoC power consumption */
139 socket_power = dev->m_table.apu_power + dev->m_table.dgpu_power;
140
141 if (dev->amt_enabled) {
142 /* Apply the Auto Mode transition */
143 amd_pmf_trans_automode(dev, socket_power, time_elapsed_ms);
144 }
145
146 if (dev->cnqf_enabled) {
147 /* Apply the CnQF transition */
148 amd_pmf_trans_cnqf(dev, socket_power, time_elapsed_ms);
149 }
150
151 dev->start_time = ktime_to_ms(ktime_get());
152 schedule_delayed_work(&dev->work_buffer, msecs_to_jiffies(metrics_table_loop_ms));
153 }
154
amd_pmf_reg_read(struct amd_pmf_dev * dev,int reg_offset)155 static inline u32 amd_pmf_reg_read(struct amd_pmf_dev *dev, int reg_offset)
156 {
157 return ioread32(dev->regbase + reg_offset);
158 }
159
amd_pmf_reg_write(struct amd_pmf_dev * dev,int reg_offset,u32 val)160 static inline void amd_pmf_reg_write(struct amd_pmf_dev *dev, int reg_offset, u32 val)
161 {
162 iowrite32(val, dev->regbase + reg_offset);
163 }
164
amd_pmf_dump_registers(struct amd_pmf_dev * dev)165 static void __maybe_unused amd_pmf_dump_registers(struct amd_pmf_dev *dev)
166 {
167 u32 value;
168
169 value = amd_pmf_reg_read(dev, AMD_PMF_REGISTER_RESPONSE);
170 dev_dbg(dev->dev, "AMD_PMF_REGISTER_RESPONSE:%x\n", value);
171
172 value = amd_pmf_reg_read(dev, AMD_PMF_REGISTER_ARGUMENT);
173 dev_dbg(dev->dev, "AMD_PMF_REGISTER_ARGUMENT:%d\n", value);
174
175 value = amd_pmf_reg_read(dev, AMD_PMF_REGISTER_MESSAGE);
176 dev_dbg(dev->dev, "AMD_PMF_REGISTER_MESSAGE:%x\n", value);
177 }
178
amd_pmf_send_cmd(struct amd_pmf_dev * dev,u8 message,bool get,u32 arg,u32 * data)179 int amd_pmf_send_cmd(struct amd_pmf_dev *dev, u8 message, bool get, u32 arg, u32 *data)
180 {
181 int rc;
182 u32 val;
183
184 guard(mutex)(&dev->lock);
185
186 /* Wait until we get a valid response */
187 rc = readx_poll_timeout(ioread32, dev->regbase + AMD_PMF_REGISTER_RESPONSE,
188 val, val != 0, PMF_MSG_DELAY_MIN_US,
189 PMF_MSG_DELAY_MIN_US * RESPONSE_REGISTER_LOOP_MAX);
190 if (rc) {
191 dev_err(dev->dev, "failed to talk to SMU\n");
192 return rc;
193 }
194
195 /* Write zero to response register */
196 amd_pmf_reg_write(dev, AMD_PMF_REGISTER_RESPONSE, 0);
197
198 /* Write argument into argument register */
199 amd_pmf_reg_write(dev, AMD_PMF_REGISTER_ARGUMENT, arg);
200
201 /* Write message ID to message ID register */
202 amd_pmf_reg_write(dev, AMD_PMF_REGISTER_MESSAGE, message);
203
204 /* Wait until we get a valid response */
205 rc = readx_poll_timeout(ioread32, dev->regbase + AMD_PMF_REGISTER_RESPONSE,
206 val, val != 0, PMF_MSG_DELAY_MIN_US,
207 PMF_MSG_DELAY_MIN_US * RESPONSE_REGISTER_LOOP_MAX);
208 if (rc) {
209 dev_err(dev->dev, "SMU response timed out\n");
210 return rc;
211 }
212
213 switch (val) {
214 case AMD_PMF_RESULT_OK:
215 if (get) {
216 /* PMFW may take longer time to return back the data */
217 usleep_range(DELAY_MIN_US, 10 * DELAY_MAX_US);
218 *data = amd_pmf_reg_read(dev, AMD_PMF_REGISTER_ARGUMENT);
219 }
220 break;
221 case AMD_PMF_RESULT_CMD_REJECT_BUSY:
222 dev_err(dev->dev, "SMU not ready. err: 0x%x\n", val);
223 rc = -EBUSY;
224 break;
225 case AMD_PMF_RESULT_CMD_UNKNOWN:
226 dev_err(dev->dev, "SMU cmd unknown. err: 0x%x\n", val);
227 rc = -EINVAL;
228 break;
229 case AMD_PMF_RESULT_CMD_REJECT_PREREQ:
230 case AMD_PMF_RESULT_FAILED:
231 default:
232 dev_err(dev->dev, "SMU cmd failed. err: 0x%x\n", val);
233 rc = -EIO;
234 break;
235 }
236
237 amd_pmf_dump_registers(dev);
238 return rc;
239 }
240
241 static const struct pci_device_id pmf_pci_ids[] = {
242 { PCI_DEVICE(PCI_VENDOR_ID_AMD, AMD_CPU_ID_RMB) },
243 { PCI_DEVICE(PCI_VENDOR_ID_AMD, AMD_CPU_ID_PS) },
244 { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_1AH_M20H_ROOT) },
245 { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_1AH_M60H_ROOT) },
246 { }
247 };
248
amd_pmf_set_dram_addr(struct amd_pmf_dev * dev,bool alloc_buffer)249 int amd_pmf_set_dram_addr(struct amd_pmf_dev *dev, bool alloc_buffer)
250 {
251 u64 phys_addr;
252 u32 hi, low;
253
254 /* Get Metrics Table Address */
255 if (alloc_buffer) {
256 switch (dev->cpu_id) {
257 case AMD_CPU_ID_PS:
258 case AMD_CPU_ID_RMB:
259 dev->mtable_size = sizeof(dev->m_table);
260 break;
261 case PCI_DEVICE_ID_AMD_1AH_M20H_ROOT:
262 case PCI_DEVICE_ID_AMD_1AH_M60H_ROOT:
263 dev->mtable_size = sizeof(dev->m_table_v2);
264 break;
265 default:
266 dev_err(dev->dev, "Invalid CPU id: 0x%x", dev->cpu_id);
267 }
268
269 dev->buf = kzalloc(dev->mtable_size, GFP_KERNEL);
270 if (!dev->buf)
271 return -ENOMEM;
272 }
273
274 phys_addr = virt_to_phys(dev->buf);
275 hi = phys_addr >> 32;
276 low = phys_addr & GENMASK(31, 0);
277
278 amd_pmf_send_cmd(dev, SET_DRAM_ADDR_HIGH, 0, hi, NULL);
279 amd_pmf_send_cmd(dev, SET_DRAM_ADDR_LOW, 0, low, NULL);
280
281 return 0;
282 }
283
amd_pmf_init_metrics_table(struct amd_pmf_dev * dev)284 int amd_pmf_init_metrics_table(struct amd_pmf_dev *dev)
285 {
286 int ret;
287
288 INIT_DELAYED_WORK(&dev->work_buffer, amd_pmf_get_metrics);
289
290 ret = amd_pmf_set_dram_addr(dev, true);
291 if (ret)
292 return ret;
293
294 /*
295 * Start collecting the metrics data after a small delay
296 * or else, we might end up getting stale values from PMFW.
297 */
298 schedule_delayed_work(&dev->work_buffer, msecs_to_jiffies(metrics_table_loop_ms * 3));
299
300 return 0;
301 }
302
amd_pmf_suspend_handler(struct device * dev)303 static int amd_pmf_suspend_handler(struct device *dev)
304 {
305 struct amd_pmf_dev *pdev = dev_get_drvdata(dev);
306
307 if (pdev->smart_pc_enabled)
308 cancel_delayed_work_sync(&pdev->pb_work);
309
310 if (is_apmf_func_supported(pdev, APMF_FUNC_SBIOS_HEARTBEAT_V2))
311 amd_pmf_notify_sbios_heartbeat_event_v2(pdev, ON_SUSPEND);
312
313 return 0;
314 }
315
amd_pmf_resume_handler(struct device * dev)316 static int amd_pmf_resume_handler(struct device *dev)
317 {
318 struct amd_pmf_dev *pdev = dev_get_drvdata(dev);
319 int ret;
320
321 if (pdev->buf) {
322 ret = amd_pmf_set_dram_addr(pdev, false);
323 if (ret)
324 return ret;
325 }
326
327 if (is_apmf_func_supported(pdev, APMF_FUNC_SBIOS_HEARTBEAT_V2))
328 amd_pmf_notify_sbios_heartbeat_event_v2(pdev, ON_RESUME);
329
330 if (pdev->smart_pc_enabled)
331 schedule_delayed_work(&pdev->pb_work, msecs_to_jiffies(2000));
332
333 return 0;
334 }
335
336 static DEFINE_SIMPLE_DEV_PM_OPS(amd_pmf_pm, amd_pmf_suspend_handler, amd_pmf_resume_handler);
337
amd_pmf_init_features(struct amd_pmf_dev * dev)338 static void amd_pmf_init_features(struct amd_pmf_dev *dev)
339 {
340 int ret;
341
342 /* Enable Static Slider */
343 if (is_apmf_func_supported(dev, APMF_FUNC_STATIC_SLIDER_GRANULAR) ||
344 is_apmf_func_supported(dev, APMF_FUNC_OS_POWER_SLIDER_UPDATE)) {
345 amd_pmf_init_sps(dev);
346 dev->pwr_src_notifier.notifier_call = amd_pmf_pwr_src_notify_call;
347 power_supply_reg_notifier(&dev->pwr_src_notifier);
348 dev_dbg(dev->dev, "SPS enabled and Platform Profiles registered\n");
349 }
350
351 amd_pmf_init_smart_pc(dev);
352 if (dev->smart_pc_enabled) {
353 dev_dbg(dev->dev, "Smart PC Solution Enabled\n");
354 /* If Smart PC is enabled, no need to check for other features */
355 return;
356 }
357
358 if (is_apmf_func_supported(dev, APMF_FUNC_AUTO_MODE)) {
359 amd_pmf_init_auto_mode(dev);
360 dev_dbg(dev->dev, "Auto Mode Init done\n");
361 } else if (is_apmf_func_supported(dev, APMF_FUNC_DYN_SLIDER_AC) ||
362 is_apmf_func_supported(dev, APMF_FUNC_DYN_SLIDER_DC)) {
363 ret = amd_pmf_init_cnqf(dev);
364 if (ret)
365 dev_warn(dev->dev, "CnQF Init failed\n");
366 }
367 }
368
amd_pmf_deinit_features(struct amd_pmf_dev * dev)369 static void amd_pmf_deinit_features(struct amd_pmf_dev *dev)
370 {
371 if (is_apmf_func_supported(dev, APMF_FUNC_STATIC_SLIDER_GRANULAR) ||
372 is_apmf_func_supported(dev, APMF_FUNC_OS_POWER_SLIDER_UPDATE)) {
373 power_supply_unreg_notifier(&dev->pwr_src_notifier);
374 }
375
376 if (dev->smart_pc_enabled) {
377 amd_pmf_deinit_smart_pc(dev);
378 } else if (is_apmf_func_supported(dev, APMF_FUNC_AUTO_MODE)) {
379 amd_pmf_deinit_auto_mode(dev);
380 } else if (is_apmf_func_supported(dev, APMF_FUNC_DYN_SLIDER_AC) ||
381 is_apmf_func_supported(dev, APMF_FUNC_DYN_SLIDER_DC)) {
382 amd_pmf_deinit_cnqf(dev);
383 }
384 }
385
386 static const struct acpi_device_id amd_pmf_acpi_ids[] = {
387 {"AMDI0100", 0x100},
388 {"AMDI0102", 0},
389 {"AMDI0103", 0},
390 {"AMDI0105", 0},
391 {"AMDI0107", 0},
392 { }
393 };
394 MODULE_DEVICE_TABLE(acpi, amd_pmf_acpi_ids);
395
amd_pmf_probe(struct platform_device * pdev)396 static int amd_pmf_probe(struct platform_device *pdev)
397 {
398 const struct acpi_device_id *id;
399 struct amd_pmf_dev *dev;
400 struct pci_dev *rdev;
401 u32 base_addr_lo;
402 u32 base_addr_hi;
403 u64 base_addr;
404 u32 val;
405 int err;
406
407 id = acpi_match_device(amd_pmf_acpi_ids, &pdev->dev);
408 if (!id)
409 return -ENODEV;
410
411 if (id->driver_data == 0x100 && !force_load)
412 return -ENODEV;
413
414 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
415 if (!dev)
416 return -ENOMEM;
417
418 dev->dev = &pdev->dev;
419
420 rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
421 if (!rdev || !pci_match_id(pmf_pci_ids, rdev)) {
422 pci_dev_put(rdev);
423 return -ENODEV;
424 }
425
426 dev->cpu_id = rdev->device;
427
428 err = amd_smn_read(0, AMD_PMF_BASE_ADDR_LO, &val);
429 if (err) {
430 pci_dev_put(rdev);
431 return dev_err_probe(dev->dev, pcibios_err_to_errno(err),
432 "error in reading from 0x%x\n", AMD_PMF_BASE_ADDR_LO);
433 }
434
435 base_addr_lo = val & AMD_PMF_BASE_ADDR_HI_MASK;
436
437 err = amd_smn_read(0, AMD_PMF_BASE_ADDR_HI, &val);
438 if (err) {
439 pci_dev_put(rdev);
440 return dev_err_probe(dev->dev, pcibios_err_to_errno(err),
441 "error in reading from 0x%x\n", AMD_PMF_BASE_ADDR_HI);
442 }
443
444 base_addr_hi = val & AMD_PMF_BASE_ADDR_LO_MASK;
445 pci_dev_put(rdev);
446 base_addr = ((u64)base_addr_hi << 32 | base_addr_lo);
447
448 dev->regbase = devm_ioremap(dev->dev, base_addr + AMD_PMF_BASE_ADDR_OFFSET,
449 AMD_PMF_MAPPING_SIZE);
450 if (!dev->regbase)
451 return -ENOMEM;
452
453 mutex_init(&dev->lock);
454 mutex_init(&dev->update_mutex);
455 mutex_init(&dev->cb_mutex);
456
457 apmf_acpi_init(dev);
458 platform_set_drvdata(pdev, dev);
459 amd_pmf_dbgfs_register(dev);
460 amd_pmf_init_features(dev);
461 apmf_install_handler(dev);
462 if (is_apmf_func_supported(dev, APMF_FUNC_SBIOS_HEARTBEAT_V2))
463 amd_pmf_notify_sbios_heartbeat_event_v2(dev, ON_LOAD);
464
465 dev_info(dev->dev, "registered PMF device successfully\n");
466
467 return 0;
468 }
469
amd_pmf_remove(struct platform_device * pdev)470 static void amd_pmf_remove(struct platform_device *pdev)
471 {
472 struct amd_pmf_dev *dev = platform_get_drvdata(pdev);
473
474 amd_pmf_deinit_features(dev);
475 if (is_apmf_func_supported(dev, APMF_FUNC_SBIOS_HEARTBEAT_V2))
476 amd_pmf_notify_sbios_heartbeat_event_v2(dev, ON_UNLOAD);
477 apmf_acpi_deinit(dev);
478 amd_pmf_dbgfs_unregister(dev);
479 mutex_destroy(&dev->lock);
480 mutex_destroy(&dev->update_mutex);
481 mutex_destroy(&dev->cb_mutex);
482 kfree(dev->buf);
483 }
484
485 static const struct attribute_group *amd_pmf_driver_groups[] = {
486 &cnqf_feature_attribute_group,
487 NULL,
488 };
489
490 static struct platform_driver amd_pmf_driver = {
491 .driver = {
492 .name = "amd-pmf",
493 .acpi_match_table = amd_pmf_acpi_ids,
494 .dev_groups = amd_pmf_driver_groups,
495 .pm = pm_sleep_ptr(&amd_pmf_pm),
496 },
497 .probe = amd_pmf_probe,
498 .remove = amd_pmf_remove,
499 };
500 module_platform_driver(amd_pmf_driver);
501
502 MODULE_LICENSE("GPL");
503 MODULE_DESCRIPTION("AMD Platform Management Framework Driver");
504 MODULE_SOFTDEP("pre: amdtee");
505