1 // SPDX-License-Identifier: GPL-2.0
3 * Intel Core SoC Power Management Controller Driver
5 * Copyright (c) 2016, Intel Corporation.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <linux/bitfield.h>
15 #include <linux/debugfs.h>
16 #include <linux/delay.h>
17 #include <linux/dmi.h>
19 #include <linux/module.h>
20 #include <linux/pci.h>
21 #include <linux/slab.h>
22 #include <linux/suspend.h>
24 #include <asm/cpu_device_id.h>
25 #include <asm/intel-family.h>
31 /* Maximum number of modes supported by platfoms that has low power mode capability */
32 const char *pmc_lpm_modes[] = {
44 /* PKGC MSRs are common across Intel Core SoCs */
45 const struct pmc_bit_map msr_map[] = {
46 {"Package C2", MSR_PKG_C2_RESIDENCY},
47 {"Package C3", MSR_PKG_C3_RESIDENCY},
48 {"Package C6", MSR_PKG_C6_RESIDENCY},
49 {"Package C7", MSR_PKG_C7_RESIDENCY},
50 {"Package C8", MSR_PKG_C8_RESIDENCY},
51 {"Package C9", MSR_PKG_C9_RESIDENCY},
52 {"Package C10", MSR_PKG_C10_RESIDENCY},
56 static inline u32 pmc_core_reg_read(struct pmc_dev *pmcdev, int reg_offset)
58 return readl(pmcdev->regbase + reg_offset);
61 static inline void pmc_core_reg_write(struct pmc_dev *pmcdev, int reg_offset,
64 writel(val, pmcdev->regbase + reg_offset);
67 static inline u64 pmc_core_adjust_slp_s0_step(struct pmc_dev *pmcdev, u32 value)
69 return (u64)value * pmcdev->map->slp_s0_res_counter_step;
72 static int set_etr3(struct pmc_dev *pmcdev)
74 const struct pmc_reg_map *map = pmcdev->map;
78 if (!map->etr3_offset)
81 mutex_lock(&pmcdev->lock);
83 /* check if CF9 is locked */
84 reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
85 if (reg & ETR3_CF9LOCK) {
90 /* write CF9 global reset bit */
92 pmc_core_reg_write(pmcdev, map->etr3_offset, reg);
94 reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
95 if (!(reg & ETR3_CF9GR)) {
103 mutex_unlock(&pmcdev->lock);
106 static umode_t etr3_is_visible(struct kobject *kobj,
107 struct attribute *attr,
110 struct device *dev = kobj_to_dev(kobj);
111 struct pmc_dev *pmcdev = dev_get_drvdata(dev);
112 const struct pmc_reg_map *map = pmcdev->map;
115 mutex_lock(&pmcdev->lock);
116 reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
117 mutex_unlock(&pmcdev->lock);
119 return reg & ETR3_CF9LOCK ? attr->mode & (SYSFS_PREALLOC | 0444) : attr->mode;
122 static ssize_t etr3_show(struct device *dev,
123 struct device_attribute *attr, char *buf)
125 struct pmc_dev *pmcdev = dev_get_drvdata(dev);
126 const struct pmc_reg_map *map = pmcdev->map;
129 if (!map->etr3_offset)
132 mutex_lock(&pmcdev->lock);
134 reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
135 reg &= ETR3_CF9GR | ETR3_CF9LOCK;
137 mutex_unlock(&pmcdev->lock);
139 return sysfs_emit(buf, "0x%08x", reg);
142 static ssize_t etr3_store(struct device *dev,
143 struct device_attribute *attr,
144 const char *buf, size_t len)
146 struct pmc_dev *pmcdev = dev_get_drvdata(dev);
150 err = kstrtouint(buf, 16, ®);
154 /* allow only CF9 writes */
155 if (reg != ETR3_CF9GR)
158 err = set_etr3(pmcdev);
164 static DEVICE_ATTR_RW(etr3);
166 static struct attribute *pmc_attrs[] = {
171 static const struct attribute_group pmc_attr_group = {
173 .is_visible = etr3_is_visible,
176 static const struct attribute_group *pmc_dev_groups[] = {
181 static int pmc_core_dev_state_get(void *data, u64 *val)
183 struct pmc_dev *pmcdev = data;
184 const struct pmc_reg_map *map = pmcdev->map;
187 value = pmc_core_reg_read(pmcdev, map->slp_s0_offset);
188 *val = pmc_core_adjust_slp_s0_step(pmcdev, value);
193 DEFINE_DEBUGFS_ATTRIBUTE(pmc_core_dev_state, pmc_core_dev_state_get, NULL, "%llu\n");
195 static int pmc_core_check_read_lock_bit(struct pmc_dev *pmcdev)
199 value = pmc_core_reg_read(pmcdev, pmcdev->map->pm_cfg_offset);
200 return value & BIT(pmcdev->map->pm_read_disable_bit);
203 static void pmc_core_slps0_display(struct pmc_dev *pmcdev, struct device *dev,
206 const struct pmc_bit_map **maps = pmcdev->map->slps0_dbg_maps;
207 const struct pmc_bit_map *map;
208 int offset = pmcdev->map->slps0_dbg_offset;
213 data = pmc_core_reg_read(pmcdev, offset);
217 dev_info(dev, "SLP_S0_DBG: %-32s\tState: %s\n",
219 data & map->bit_mask ? "Yes" : "No");
221 seq_printf(s, "SLP_S0_DBG: %-32s\tState: %s\n",
223 data & map->bit_mask ? "Yes" : "No");
230 static int pmc_core_lpm_get_arr_size(const struct pmc_bit_map **maps)
234 for (idx = 0; maps[idx]; idx++)
240 static void pmc_core_lpm_display(struct pmc_dev *pmcdev, struct device *dev,
241 struct seq_file *s, u32 offset,
243 const struct pmc_bit_map **maps)
245 int index, idx, len = 32, bit_mask, arr_size;
248 arr_size = pmc_core_lpm_get_arr_size(maps);
249 lpm_regs = kmalloc_array(arr_size, sizeof(*lpm_regs), GFP_KERNEL);
253 for (index = 0; index < arr_size; index++) {
254 lpm_regs[index] = pmc_core_reg_read(pmcdev, offset);
258 for (idx = 0; idx < arr_size; idx++) {
260 dev_info(dev, "\nLPM_%s_%d:\t0x%x\n", str, idx,
263 seq_printf(s, "\nLPM_%s_%d:\t0x%x\n", str, idx,
265 for (index = 0; maps[idx][index].name && index < len; index++) {
266 bit_mask = maps[idx][index].bit_mask;
268 dev_info(dev, "%-30s %-30d\n",
269 maps[idx][index].name,
270 lpm_regs[idx] & bit_mask ? 1 : 0);
272 seq_printf(s, "%-30s %-30d\n",
273 maps[idx][index].name,
274 lpm_regs[idx] & bit_mask ? 1 : 0);
281 static bool slps0_dbg_latch;
283 static inline u8 pmc_core_reg_read_byte(struct pmc_dev *pmcdev, int offset)
285 return readb(pmcdev->regbase + offset);
288 static void pmc_core_display_map(struct seq_file *s, int index, int idx, int ip,
289 u8 pf_reg, const struct pmc_bit_map **pf_map)
291 seq_printf(s, "PCH IP: %-2d - %-32s\tState: %s\n",
292 ip, pf_map[idx][index].name,
293 pf_map[idx][index].bit_mask & pf_reg ? "Off" : "On");
296 static int pmc_core_ppfear_show(struct seq_file *s, void *unused)
298 struct pmc_dev *pmcdev = s->private;
299 const struct pmc_bit_map **maps = pmcdev->map->pfear_sts;
300 u8 pf_regs[PPFEAR_MAX_NUM_ENTRIES];
301 int index, iter, idx, ip = 0;
303 iter = pmcdev->map->ppfear0_offset;
305 for (index = 0; index < pmcdev->map->ppfear_buckets &&
306 index < PPFEAR_MAX_NUM_ENTRIES; index++, iter++)
307 pf_regs[index] = pmc_core_reg_read_byte(pmcdev, iter);
309 for (idx = 0; maps[idx]; idx++) {
310 for (index = 0; maps[idx][index].name &&
311 index < pmcdev->map->ppfear_buckets * 8; ip++, index++)
312 pmc_core_display_map(s, index, idx, ip,
313 pf_regs[index / 8], maps);
318 DEFINE_SHOW_ATTRIBUTE(pmc_core_ppfear);
320 /* This function should return link status, 0 means ready */
321 static int pmc_core_mtpmc_link_status(struct pmc_dev *pmcdev)
325 value = pmc_core_reg_read(pmcdev, SPT_PMC_PM_STS_OFFSET);
326 return value & BIT(SPT_PMC_MSG_FULL_STS_BIT);
329 static int pmc_core_send_msg(struct pmc_dev *pmcdev, u32 *addr_xram)
334 for (timeout = NUM_RETRIES; timeout > 0; timeout--) {
335 if (pmc_core_mtpmc_link_status(pmcdev) == 0)
340 if (timeout <= 0 && pmc_core_mtpmc_link_status(pmcdev))
343 dest = (*addr_xram & MTPMC_MASK) | (1U << 1);
344 pmc_core_reg_write(pmcdev, SPT_PMC_MTPMC_OFFSET, dest);
348 static int pmc_core_mphy_pg_show(struct seq_file *s, void *unused)
350 struct pmc_dev *pmcdev = s->private;
351 const struct pmc_bit_map *map = pmcdev->map->mphy_sts;
352 u32 mphy_core_reg_low, mphy_core_reg_high;
353 u32 val_low, val_high;
356 if (pmcdev->pmc_xram_read_bit) {
357 seq_puts(s, "Access denied: please disable PMC_READ_DISABLE setting in BIOS.");
361 mphy_core_reg_low = (SPT_PMC_MPHY_CORE_STS_0 << 16);
362 mphy_core_reg_high = (SPT_PMC_MPHY_CORE_STS_1 << 16);
364 mutex_lock(&pmcdev->lock);
366 if (pmc_core_send_msg(pmcdev, &mphy_core_reg_low) != 0) {
372 val_low = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
374 if (pmc_core_send_msg(pmcdev, &mphy_core_reg_high) != 0) {
380 val_high = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
382 for (index = 0; index < 8 && map[index].name; index++) {
383 seq_printf(s, "%-32s\tState: %s\n",
385 map[index].bit_mask & val_low ? "Not power gated" :
389 for (index = 8; map[index].name; index++) {
390 seq_printf(s, "%-32s\tState: %s\n",
392 map[index].bit_mask & val_high ? "Not power gated" :
397 mutex_unlock(&pmcdev->lock);
400 DEFINE_SHOW_ATTRIBUTE(pmc_core_mphy_pg);
402 static int pmc_core_pll_show(struct seq_file *s, void *unused)
404 struct pmc_dev *pmcdev = s->private;
405 const struct pmc_bit_map *map = pmcdev->map->pll_sts;
406 u32 mphy_common_reg, val;
409 if (pmcdev->pmc_xram_read_bit) {
410 seq_puts(s, "Access denied: please disable PMC_READ_DISABLE setting in BIOS.");
414 mphy_common_reg = (SPT_PMC_MPHY_COM_STS_0 << 16);
415 mutex_lock(&pmcdev->lock);
417 if (pmc_core_send_msg(pmcdev, &mphy_common_reg) != 0) {
422 /* Observed PMC HW response latency for MTPMC-MFPMC is ~10 ms */
424 val = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
426 for (index = 0; map[index].name ; index++) {
427 seq_printf(s, "%-32s\tState: %s\n",
429 map[index].bit_mask & val ? "Active" : "Idle");
433 mutex_unlock(&pmcdev->lock);
436 DEFINE_SHOW_ATTRIBUTE(pmc_core_pll);
438 int pmc_core_send_ltr_ignore(struct pmc_dev *pmcdev, u32 value)
440 const struct pmc_reg_map *map = pmcdev->map;
444 mutex_lock(&pmcdev->lock);
446 if (value > map->ltr_ignore_max) {
451 reg = pmc_core_reg_read(pmcdev, map->ltr_ignore_offset);
453 pmc_core_reg_write(pmcdev, map->ltr_ignore_offset, reg);
456 mutex_unlock(&pmcdev->lock);
461 static ssize_t pmc_core_ltr_ignore_write(struct file *file,
462 const char __user *userbuf,
463 size_t count, loff_t *ppos)
465 struct seq_file *s = file->private_data;
466 struct pmc_dev *pmcdev = s->private;
470 buf_size = min_t(u32, count, 64);
472 err = kstrtou32_from_user(userbuf, buf_size, 10, &value);
476 err = pmc_core_send_ltr_ignore(pmcdev, value);
478 return err == 0 ? count : err;
481 static int pmc_core_ltr_ignore_show(struct seq_file *s, void *unused)
486 static int pmc_core_ltr_ignore_open(struct inode *inode, struct file *file)
488 return single_open(file, pmc_core_ltr_ignore_show, inode->i_private);
491 static const struct file_operations pmc_core_ltr_ignore_ops = {
492 .open = pmc_core_ltr_ignore_open,
494 .write = pmc_core_ltr_ignore_write,
496 .release = single_release,
499 static void pmc_core_slps0_dbg_latch(struct pmc_dev *pmcdev, bool reset)
501 const struct pmc_reg_map *map = pmcdev->map;
504 mutex_lock(&pmcdev->lock);
506 if (!reset && !slps0_dbg_latch)
509 fd = pmc_core_reg_read(pmcdev, map->slps0_dbg_offset);
511 fd &= ~CNP_PMC_LATCH_SLPS0_EVENTS;
513 fd |= CNP_PMC_LATCH_SLPS0_EVENTS;
514 pmc_core_reg_write(pmcdev, map->slps0_dbg_offset, fd);
516 slps0_dbg_latch = false;
519 mutex_unlock(&pmcdev->lock);
522 static int pmc_core_slps0_dbg_show(struct seq_file *s, void *unused)
524 struct pmc_dev *pmcdev = s->private;
526 pmc_core_slps0_dbg_latch(pmcdev, false);
527 pmc_core_slps0_display(pmcdev, NULL, s);
528 pmc_core_slps0_dbg_latch(pmcdev, true);
532 DEFINE_SHOW_ATTRIBUTE(pmc_core_slps0_dbg);
534 static u32 convert_ltr_scale(u32 val)
537 * As per PCIE specification supporting document
538 * ECN_LatencyTolnReporting_14Aug08.pdf the Latency
539 * Tolerance Reporting data payload is encoded in a
540 * 3 bit scale and 10 bit value fields. Values are
541 * multiplied by the indicated scale to yield an absolute time
542 * value, expressible in a range from 1 nanosecond to
543 * 2^25*(2^10-1) = 34,326,183,936 nanoseconds.
545 * scale encoding is as follows:
547 * ----------------------------------------------
548 * |scale factor | Multiplier (ns) |
549 * ----------------------------------------------
558 * ----------------------------------------------
561 pr_warn("Invalid LTR scale factor.\n");
565 return 1U << (5 * val);
568 static int pmc_core_ltr_show(struct seq_file *s, void *unused)
570 struct pmc_dev *pmcdev = s->private;
571 const struct pmc_bit_map *map = pmcdev->map->ltr_show_sts;
572 u64 decoded_snoop_ltr, decoded_non_snoop_ltr;
573 u32 ltr_raw_data, scale, val;
574 u16 snoop_ltr, nonsnoop_ltr;
577 for (index = 0; map[index].name ; index++) {
578 decoded_snoop_ltr = decoded_non_snoop_ltr = 0;
579 ltr_raw_data = pmc_core_reg_read(pmcdev,
580 map[index].bit_mask);
581 snoop_ltr = ltr_raw_data & ~MTPMC_MASK;
582 nonsnoop_ltr = (ltr_raw_data >> 0x10) & ~MTPMC_MASK;
584 if (FIELD_GET(LTR_REQ_NONSNOOP, ltr_raw_data)) {
585 scale = FIELD_GET(LTR_DECODED_SCALE, nonsnoop_ltr);
586 val = FIELD_GET(LTR_DECODED_VAL, nonsnoop_ltr);
587 decoded_non_snoop_ltr = val * convert_ltr_scale(scale);
590 if (FIELD_GET(LTR_REQ_SNOOP, ltr_raw_data)) {
591 scale = FIELD_GET(LTR_DECODED_SCALE, snoop_ltr);
592 val = FIELD_GET(LTR_DECODED_VAL, snoop_ltr);
593 decoded_snoop_ltr = val * convert_ltr_scale(scale);
596 seq_printf(s, "%-32s\tLTR: RAW: 0x%-16x\tNon-Snoop(ns): %-16llu\tSnoop(ns): %-16llu\n",
597 map[index].name, ltr_raw_data,
598 decoded_non_snoop_ltr,
603 DEFINE_SHOW_ATTRIBUTE(pmc_core_ltr);
605 static inline u64 adjust_lpm_residency(struct pmc_dev *pmcdev, u32 offset,
606 const int lpm_adj_x2)
608 u64 lpm_res = pmc_core_reg_read(pmcdev, offset);
610 return GET_X2_COUNTER((u64)lpm_adj_x2 * lpm_res);
613 static int pmc_core_substate_res_show(struct seq_file *s, void *unused)
615 struct pmc_dev *pmcdev = s->private;
616 const int lpm_adj_x2 = pmcdev->map->lpm_res_counter_step_x2;
617 u32 offset = pmcdev->map->lpm_residency_offset;
620 seq_printf(s, "%-10s %-15s\n", "Substate", "Residency");
622 pmc_for_each_mode(i, mode, pmcdev) {
623 seq_printf(s, "%-10s %-15llu\n", pmc_lpm_modes[mode],
624 adjust_lpm_residency(pmcdev, offset + (4 * mode), lpm_adj_x2));
629 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_res);
631 static int pmc_core_substate_sts_regs_show(struct seq_file *s, void *unused)
633 struct pmc_dev *pmcdev = s->private;
634 const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
635 u32 offset = pmcdev->map->lpm_status_offset;
637 pmc_core_lpm_display(pmcdev, NULL, s, offset, "STATUS", maps);
641 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_sts_regs);
643 static int pmc_core_substate_l_sts_regs_show(struct seq_file *s, void *unused)
645 struct pmc_dev *pmcdev = s->private;
646 const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
647 u32 offset = pmcdev->map->lpm_live_status_offset;
649 pmc_core_lpm_display(pmcdev, NULL, s, offset, "LIVE_STATUS", maps);
653 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_l_sts_regs);
655 static void pmc_core_substate_req_header_show(struct seq_file *s)
657 struct pmc_dev *pmcdev = s->private;
660 seq_printf(s, "%30s |", "Element");
661 pmc_for_each_mode(i, mode, pmcdev)
662 seq_printf(s, " %9s |", pmc_lpm_modes[mode]);
664 seq_printf(s, " %9s |\n", "Status");
667 static int pmc_core_substate_req_regs_show(struct seq_file *s, void *unused)
669 struct pmc_dev *pmcdev = s->private;
670 const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
671 const struct pmc_bit_map *map;
672 const int num_maps = pmcdev->map->lpm_num_maps;
673 u32 sts_offset = pmcdev->map->lpm_status_offset;
674 u32 *lpm_req_regs = pmcdev->lpm_req_regs;
677 /* Display the header */
678 pmc_core_substate_req_header_show(s);
681 for (mp = 0; mp < num_maps; mp++) {
684 int mode, idx, i, len = 32;
687 * Capture the requirements and create a mask so that we only
688 * show an element if it's required for at least one of the
689 * enabled low power modes
691 pmc_for_each_mode(idx, mode, pmcdev)
692 req_mask |= lpm_req_regs[mp + (mode * num_maps)];
694 /* Get the last latched status for this map */
695 lpm_status = pmc_core_reg_read(pmcdev, sts_offset + (mp * 4));
697 /* Loop over elements in this map */
699 for (i = 0; map[i].name && i < len; i++) {
700 u32 bit_mask = map[i].bit_mask;
702 if (!(bit_mask & req_mask))
704 * Not required for any enabled states
709 /* Display the element name in the first column */
710 seq_printf(s, "%30s |", map[i].name);
712 /* Loop over the enabled states and display if required */
713 pmc_for_each_mode(idx, mode, pmcdev) {
714 if (lpm_req_regs[mp + (mode * num_maps)] & bit_mask)
715 seq_printf(s, " %9s |",
718 seq_printf(s, " %9s |", " ");
721 /* In Status column, show the last captured state of this agent */
722 if (lpm_status & bit_mask)
723 seq_printf(s, " %9s |", "Yes");
725 seq_printf(s, " %9s |", " ");
733 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_req_regs);
735 static int pmc_core_lpm_latch_mode_show(struct seq_file *s, void *unused)
737 struct pmc_dev *pmcdev = s->private;
742 reg = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_sts_latch_en_offset);
743 if (reg & LPM_STS_LATCH_MODE) {
747 seq_puts(s, "[c10]");
751 pmc_for_each_mode(idx, mode, pmcdev) {
752 if ((BIT(mode) & reg) && !c10)
753 seq_printf(s, " [%s]", pmc_lpm_modes[mode]);
755 seq_printf(s, " %s", pmc_lpm_modes[mode]);
758 seq_puts(s, " clear\n");
763 static ssize_t pmc_core_lpm_latch_mode_write(struct file *file,
764 const char __user *userbuf,
765 size_t count, loff_t *ppos)
767 struct seq_file *s = file->private_data;
768 struct pmc_dev *pmcdev = s->private;
769 bool clear = false, c10 = false;
770 unsigned char buf[8];
774 if (count > sizeof(buf) - 1)
776 if (copy_from_user(buf, userbuf, count))
781 * Allowed strings are:
782 * Any enabled substate, e.g. 'S0i2.0'
786 mode = sysfs_match_string(pmc_lpm_modes, buf);
788 /* Check string matches enabled mode */
789 pmc_for_each_mode(idx, m, pmcdev)
793 if (mode != m || mode < 0) {
794 if (sysfs_streq(buf, "clear"))
796 else if (sysfs_streq(buf, "c10"))
803 mutex_lock(&pmcdev->lock);
805 reg = pmc_core_reg_read(pmcdev, pmcdev->map->etr3_offset);
806 reg |= ETR3_CLEAR_LPM_EVENTS;
807 pmc_core_reg_write(pmcdev, pmcdev->map->etr3_offset, reg);
809 mutex_unlock(&pmcdev->lock);
815 mutex_lock(&pmcdev->lock);
817 reg = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_sts_latch_en_offset);
818 reg &= ~LPM_STS_LATCH_MODE;
819 pmc_core_reg_write(pmcdev, pmcdev->map->lpm_sts_latch_en_offset, reg);
821 mutex_unlock(&pmcdev->lock);
827 * For LPM mode latching we set the latch enable bit and selected mode
828 * and clear everything else.
830 reg = LPM_STS_LATCH_MODE | BIT(mode);
831 mutex_lock(&pmcdev->lock);
832 pmc_core_reg_write(pmcdev, pmcdev->map->lpm_sts_latch_en_offset, reg);
833 mutex_unlock(&pmcdev->lock);
837 DEFINE_PMC_CORE_ATTR_WRITE(pmc_core_lpm_latch_mode);
839 static int pmc_core_pkgc_show(struct seq_file *s, void *unused)
841 struct pmc_dev *pmcdev = s->private;
842 const struct pmc_bit_map *map = pmcdev->map->msr_sts;
846 for (index = 0; map[index].name ; index++) {
847 if (rdmsrl_safe(map[index].bit_mask, &pcstate_count))
850 pcstate_count *= 1000;
851 do_div(pcstate_count, tsc_khz);
852 seq_printf(s, "%-8s : %llu\n", map[index].name,
858 DEFINE_SHOW_ATTRIBUTE(pmc_core_pkgc);
860 static bool pmc_core_pri_verify(u32 lpm_pri, u8 *mode_order)
867 * Each byte contains the priority level for 2 modes (7:4 and 3:0).
868 * In a 32 bit register this allows for describing 8 modes. Store the
869 * levels and look for values out of range.
871 for (i = 0; i < 8; i++) {
872 int level = lpm_pri & GENMASK(3, 0);
874 if (level >= LPM_MAX_NUM_MODES)
877 mode_order[i] = level;
881 /* Check that we have unique values */
882 for (i = 0; i < LPM_MAX_NUM_MODES - 1; i++)
883 for (j = i + 1; j < LPM_MAX_NUM_MODES; j++)
884 if (mode_order[i] == mode_order[j])
890 static void pmc_core_get_low_power_modes(struct platform_device *pdev)
892 struct pmc_dev *pmcdev = platform_get_drvdata(pdev);
893 u8 pri_order[LPM_MAX_NUM_MODES] = LPM_DEFAULT_PRI;
894 u8 mode_order[LPM_MAX_NUM_MODES];
899 /* Use LPM Maps to indicate support for substates */
900 if (!pmcdev->map->lpm_num_maps)
903 lpm_en = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_en_offset);
904 /* For MTL, BIT 31 is not an lpm mode but a enable bit.
905 * Lower byte is enough to cover the number of lpm modes for all
906 * platforms and hence mask the upper 3 bytes.
908 pmcdev->num_lpm_modes = hweight32(lpm_en & 0xFF);
910 /* Read 32 bit LPM_PRI register */
911 lpm_pri = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_priority_offset);
915 * If lpm_pri value passes verification, then override the default
916 * modes here. Otherwise stick with the default.
918 if (pmc_core_pri_verify(lpm_pri, mode_order))
919 /* Get list of modes in priority order */
920 for (mode = 0; mode < LPM_MAX_NUM_MODES; mode++)
921 pri_order[mode_order[mode]] = mode;
923 dev_warn(&pdev->dev, "Assuming a default substate order for this platform\n");
926 * Loop through all modes from lowest to highest priority,
927 * and capture all enabled modes in order
930 for (p = LPM_MAX_NUM_MODES - 1; p >= 0; p--) {
931 int mode = pri_order[p];
933 if (!(BIT(mode) & lpm_en))
936 pmcdev->lpm_en_modes[i++] = mode;
940 static void pmc_core_dbgfs_unregister(struct pmc_dev *pmcdev)
942 debugfs_remove_recursive(pmcdev->dbgfs_dir);
945 static void pmc_core_dbgfs_register(struct pmc_dev *pmcdev)
949 dir = debugfs_create_dir("pmc_core", NULL);
950 pmcdev->dbgfs_dir = dir;
952 debugfs_create_file("slp_s0_residency_usec", 0444, dir, pmcdev,
953 &pmc_core_dev_state);
955 if (pmcdev->map->pfear_sts)
956 debugfs_create_file("pch_ip_power_gating_status", 0444, dir,
957 pmcdev, &pmc_core_ppfear_fops);
959 debugfs_create_file("ltr_ignore", 0644, dir, pmcdev,
960 &pmc_core_ltr_ignore_ops);
962 debugfs_create_file("ltr_show", 0444, dir, pmcdev, &pmc_core_ltr_fops);
964 debugfs_create_file("package_cstate_show", 0444, dir, pmcdev,
965 &pmc_core_pkgc_fops);
967 if (pmcdev->map->pll_sts)
968 debugfs_create_file("pll_status", 0444, dir, pmcdev,
971 if (pmcdev->map->mphy_sts)
972 debugfs_create_file("mphy_core_lanes_power_gating_status",
974 &pmc_core_mphy_pg_fops);
976 if (pmcdev->map->slps0_dbg_maps) {
977 debugfs_create_file("slp_s0_debug_status", 0444,
979 &pmc_core_slps0_dbg_fops);
981 debugfs_create_bool("slp_s0_dbg_latch", 0644,
982 dir, &slps0_dbg_latch);
985 if (pmcdev->map->lpm_en_offset) {
986 debugfs_create_file("substate_residencies", 0444,
987 pmcdev->dbgfs_dir, pmcdev,
988 &pmc_core_substate_res_fops);
991 if (pmcdev->map->lpm_status_offset) {
992 debugfs_create_file("substate_status_registers", 0444,
993 pmcdev->dbgfs_dir, pmcdev,
994 &pmc_core_substate_sts_regs_fops);
995 debugfs_create_file("substate_live_status_registers", 0444,
996 pmcdev->dbgfs_dir, pmcdev,
997 &pmc_core_substate_l_sts_regs_fops);
998 debugfs_create_file("lpm_latch_mode", 0644,
999 pmcdev->dbgfs_dir, pmcdev,
1000 &pmc_core_lpm_latch_mode_fops);
1003 if (pmcdev->lpm_req_regs) {
1004 debugfs_create_file("substate_requirements", 0444,
1005 pmcdev->dbgfs_dir, pmcdev,
1006 &pmc_core_substate_req_regs_fops);
1010 static const struct x86_cpu_id intel_pmc_core_ids[] = {
1011 X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE_L, spt_core_init),
1012 X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE, spt_core_init),
1013 X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE_L, spt_core_init),
1014 X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE, spt_core_init),
1015 X86_MATCH_INTEL_FAM6_MODEL(CANNONLAKE_L, cnp_core_init),
1016 X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_L, icl_core_init),
1017 X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_NNPI, icl_core_init),
1018 X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE, cnp_core_init),
1019 X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE_L, cnp_core_init),
1020 X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE_L, tgl_core_init),
1021 X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE, tgl_core_init),
1022 X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT, tgl_core_init),
1023 X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT_L, icl_core_init),
1024 X86_MATCH_INTEL_FAM6_MODEL(ROCKETLAKE, tgl_core_init),
1025 X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE_L, tgl_core_init),
1026 X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE_N, tgl_core_init),
1027 X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE, adl_core_init),
1028 X86_MATCH_INTEL_FAM6_MODEL(RAPTORLAKE_P, tgl_core_init),
1029 X86_MATCH_INTEL_FAM6_MODEL(RAPTORLAKE, adl_core_init),
1030 X86_MATCH_INTEL_FAM6_MODEL(RAPTORLAKE_S, adl_core_init),
1031 X86_MATCH_INTEL_FAM6_MODEL(METEORLAKE, mtl_core_init),
1032 X86_MATCH_INTEL_FAM6_MODEL(METEORLAKE_L, mtl_core_init),
1036 MODULE_DEVICE_TABLE(x86cpu, intel_pmc_core_ids);
1038 static const struct pci_device_id pmc_pci_ids[] = {
1039 { PCI_VDEVICE(INTEL, SPT_PMC_PCI_DEVICE_ID) },
1044 * This quirk can be used on those platforms where
1045 * the platform BIOS enforces 24Mhz crystal to shutdown
1046 * before PMC can assert SLP_S0#.
1048 static bool xtal_ignore;
1049 static int quirk_xtal_ignore(const struct dmi_system_id *id)
1055 static void pmc_core_xtal_ignore(struct pmc_dev *pmcdev)
1059 value = pmc_core_reg_read(pmcdev, pmcdev->map->pm_vric1_offset);
1060 /* 24MHz Crystal Shutdown Qualification Disable */
1061 value |= SPT_PMC_VRIC1_XTALSDQDIS;
1062 /* Low Voltage Mode Enable */
1063 value &= ~SPT_PMC_VRIC1_SLPS0LVEN;
1064 pmc_core_reg_write(pmcdev, pmcdev->map->pm_vric1_offset, value);
1067 static const struct dmi_system_id pmc_core_dmi_table[] = {
1069 .callback = quirk_xtal_ignore,
1070 .ident = "HP Elite x2 1013 G3",
1072 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1073 DMI_MATCH(DMI_PRODUCT_NAME, "HP Elite x2 1013 G3"),
1079 static void pmc_core_do_dmi_quirks(struct pmc_dev *pmcdev)
1081 dmi_check_system(pmc_core_dmi_table);
1084 pmc_core_xtal_ignore(pmcdev);
1087 static int pmc_core_probe(struct platform_device *pdev)
1089 static bool device_initialized;
1090 struct pmc_dev *pmcdev;
1091 const struct x86_cpu_id *cpu_id;
1092 void (*core_init)(struct pmc_dev *pmcdev);
1095 if (device_initialized)
1098 pmcdev = devm_kzalloc(&pdev->dev, sizeof(*pmcdev), GFP_KERNEL);
1102 platform_set_drvdata(pdev, pmcdev);
1103 pmcdev->pdev = pdev;
1105 cpu_id = x86_match_cpu(intel_pmc_core_ids);
1109 core_init = (void (*)(struct pmc_dev *))cpu_id->driver_data;
1112 * Coffee Lake has CPU ID of Kaby Lake and Cannon Lake PCH. So here
1113 * Sunrisepoint PCH regmap can't be used. Use Cannon Lake PCH regmap
1116 if (core_init == spt_core_init && !pci_dev_present(pmc_pci_ids))
1117 core_init = cnp_core_init;
1119 mutex_init(&pmcdev->lock);
1123 if (lpit_read_residency_count_address(&slp_s0_addr)) {
1124 pmcdev->base_addr = PMC_BASE_ADDR_DEFAULT;
1126 if (page_is_ram(PHYS_PFN(pmcdev->base_addr)))
1129 pmcdev->base_addr = slp_s0_addr - pmcdev->map->slp_s0_offset;
1132 pmcdev->regbase = ioremap(pmcdev->base_addr,
1133 pmcdev->map->regmap_length);
1134 if (!pmcdev->regbase)
1137 if (pmcdev->core_configure)
1138 pmcdev->core_configure(pmcdev);
1140 pmcdev->pmc_xram_read_bit = pmc_core_check_read_lock_bit(pmcdev);
1141 pmc_core_get_low_power_modes(pdev);
1142 pmc_core_do_dmi_quirks(pmcdev);
1144 pmc_core_dbgfs_register(pmcdev);
1146 device_initialized = true;
1147 dev_info(&pdev->dev, " initialized\n");
1152 static int pmc_core_remove(struct platform_device *pdev)
1154 struct pmc_dev *pmcdev = platform_get_drvdata(pdev);
1156 pmc_core_dbgfs_unregister(pmcdev);
1157 platform_set_drvdata(pdev, NULL);
1158 mutex_destroy(&pmcdev->lock);
1159 iounmap(pmcdev->regbase);
1163 static bool warn_on_s0ix_failures;
1164 module_param(warn_on_s0ix_failures, bool, 0644);
1165 MODULE_PARM_DESC(warn_on_s0ix_failures, "Check and warn for S0ix failures");
1167 static __maybe_unused int pmc_core_suspend(struct device *dev)
1169 struct pmc_dev *pmcdev = dev_get_drvdata(dev);
1171 pmcdev->check_counters = false;
1173 /* No warnings on S0ix failures */
1174 if (!warn_on_s0ix_failures)
1177 /* Check if the syspend will actually use S0ix */
1178 if (pm_suspend_via_firmware())
1181 /* Save PC10 residency for checking later */
1182 if (rdmsrl_safe(MSR_PKG_C10_RESIDENCY, &pmcdev->pc10_counter))
1185 /* Save S0ix residency for checking later */
1186 if (pmc_core_dev_state_get(pmcdev, &pmcdev->s0ix_counter))
1189 pmcdev->check_counters = true;
1193 static inline bool pmc_core_is_pc10_failed(struct pmc_dev *pmcdev)
1197 if (rdmsrl_safe(MSR_PKG_C10_RESIDENCY, &pc10_counter))
1200 if (pc10_counter == pmcdev->pc10_counter)
1206 static inline bool pmc_core_is_s0ix_failed(struct pmc_dev *pmcdev)
1210 if (pmc_core_dev_state_get(pmcdev, &s0ix_counter))
1213 if (s0ix_counter == pmcdev->s0ix_counter)
1219 static __maybe_unused int pmc_core_resume(struct device *dev)
1221 struct pmc_dev *pmcdev = dev_get_drvdata(dev);
1222 const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1223 int offset = pmcdev->map->lpm_status_offset;
1225 if (!pmcdev->check_counters)
1228 if (!pmc_core_is_s0ix_failed(pmcdev))
1231 if (pmc_core_is_pc10_failed(pmcdev)) {
1232 /* S0ix failed because of PC10 entry failure */
1233 dev_info(dev, "CPU did not enter PC10!!! (PC10 cnt=0x%llx)\n",
1234 pmcdev->pc10_counter);
1238 /* The real interesting case - S0ix failed - lets ask PMC why. */
1239 dev_warn(dev, "CPU did not enter SLP_S0!!! (S0ix cnt=%llu)\n",
1240 pmcdev->s0ix_counter);
1241 if (pmcdev->map->slps0_dbg_maps)
1242 pmc_core_slps0_display(pmcdev, dev, NULL);
1243 if (pmcdev->map->lpm_sts)
1244 pmc_core_lpm_display(pmcdev, dev, NULL, offset, "STATUS", maps);
1249 static const struct dev_pm_ops pmc_core_pm_ops = {
1250 SET_LATE_SYSTEM_SLEEP_PM_OPS(pmc_core_suspend, pmc_core_resume)
1253 static const struct acpi_device_id pmc_core_acpi_ids[] = {
1254 {"INT33A1", 0}, /* _HID for Intel Power Engine, _CID PNP0D80*/
1257 MODULE_DEVICE_TABLE(acpi, pmc_core_acpi_ids);
1259 static struct platform_driver pmc_core_driver = {
1261 .name = "intel_pmc_core",
1262 .acpi_match_table = ACPI_PTR(pmc_core_acpi_ids),
1263 .pm = &pmc_core_pm_ops,
1264 .dev_groups = pmc_dev_groups,
1266 .probe = pmc_core_probe,
1267 .remove = pmc_core_remove,
1270 module_platform_driver(pmc_core_driver);
1272 MODULE_LICENSE("GPL v2");
1273 MODULE_DESCRIPTION("Intel PMC Core Driver");