linux/drivers/platform/x86/intel_pmc_core.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * Intel Core SoC Power Management Controller Driver
   4 *
   5 * Copyright (c) 2016, Intel Corporation.
   6 * All Rights Reserved.
   7 *
   8 * Authors: Rajneesh Bhardwaj <rajneesh.bhardwaj@intel.com>
   9 *          Vishwanath Somayaji <vishwanath.somayaji@intel.com>
  10 */
  11
  12#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  13
  14#include <linux/acpi.h>
  15#include <linux/bitfield.h>
  16#include <linux/debugfs.h>
  17#include <linux/delay.h>
  18#include <linux/dmi.h>
  19#include <linux/io.h>
  20#include <linux/module.h>
  21#include <linux/pci.h>
  22#include <linux/platform_device.h>
  23#include <linux/slab.h>
  24#include <linux/suspend.h>
  25#include <linux/uaccess.h>
  26#include <linux/uuid.h>
  27
  28#include <acpi/acpi_bus.h>
  29#include <asm/cpu_device_id.h>
  30#include <asm/intel-family.h>
  31#include <asm/msr.h>
  32#include <asm/tsc.h>
  33
  34#include "intel_pmc_core.h"
  35
  36#define ACPI_S0IX_DSM_UUID              "57a6512e-3979-4e9d-9708-ff13b2508972"
  37#define ACPI_GET_LOW_MODE_REGISTERS     1
  38
  39/* PKGC MSRs are common across Intel Core SoCs */
  40static const struct pmc_bit_map msr_map[] = {
  41        {"Package C2",                  MSR_PKG_C2_RESIDENCY},
  42        {"Package C3",                  MSR_PKG_C3_RESIDENCY},
  43        {"Package C6",                  MSR_PKG_C6_RESIDENCY},
  44        {"Package C7",                  MSR_PKG_C7_RESIDENCY},
  45        {"Package C8",                  MSR_PKG_C8_RESIDENCY},
  46        {"Package C9",                  MSR_PKG_C9_RESIDENCY},
  47        {"Package C10",                 MSR_PKG_C10_RESIDENCY},
  48        {}
  49};
  50
  51static const struct pmc_bit_map spt_pll_map[] = {
  52        {"MIPI PLL",                    SPT_PMC_BIT_MPHY_CMN_LANE0},
  53        {"GEN2 USB2PCIE2 PLL",          SPT_PMC_BIT_MPHY_CMN_LANE1},
  54        {"DMIPCIE3 PLL",                SPT_PMC_BIT_MPHY_CMN_LANE2},
  55        {"SATA PLL",                    SPT_PMC_BIT_MPHY_CMN_LANE3},
  56        {}
  57};
  58
  59static const struct pmc_bit_map spt_mphy_map[] = {
  60        {"MPHY CORE LANE 0",           SPT_PMC_BIT_MPHY_LANE0},
  61        {"MPHY CORE LANE 1",           SPT_PMC_BIT_MPHY_LANE1},
  62        {"MPHY CORE LANE 2",           SPT_PMC_BIT_MPHY_LANE2},
  63        {"MPHY CORE LANE 3",           SPT_PMC_BIT_MPHY_LANE3},
  64        {"MPHY CORE LANE 4",           SPT_PMC_BIT_MPHY_LANE4},
  65        {"MPHY CORE LANE 5",           SPT_PMC_BIT_MPHY_LANE5},
  66        {"MPHY CORE LANE 6",           SPT_PMC_BIT_MPHY_LANE6},
  67        {"MPHY CORE LANE 7",           SPT_PMC_BIT_MPHY_LANE7},
  68        {"MPHY CORE LANE 8",           SPT_PMC_BIT_MPHY_LANE8},
  69        {"MPHY CORE LANE 9",           SPT_PMC_BIT_MPHY_LANE9},
  70        {"MPHY CORE LANE 10",          SPT_PMC_BIT_MPHY_LANE10},
  71        {"MPHY CORE LANE 11",          SPT_PMC_BIT_MPHY_LANE11},
  72        {"MPHY CORE LANE 12",          SPT_PMC_BIT_MPHY_LANE12},
  73        {"MPHY CORE LANE 13",          SPT_PMC_BIT_MPHY_LANE13},
  74        {"MPHY CORE LANE 14",          SPT_PMC_BIT_MPHY_LANE14},
  75        {"MPHY CORE LANE 15",          SPT_PMC_BIT_MPHY_LANE15},
  76        {}
  77};
  78
  79static const struct pmc_bit_map spt_pfear_map[] = {
  80        {"PMC",                         SPT_PMC_BIT_PMC},
  81        {"OPI-DMI",                     SPT_PMC_BIT_OPI},
  82        {"SPI / eSPI",                  SPT_PMC_BIT_SPI},
  83        {"XHCI",                        SPT_PMC_BIT_XHCI},
  84        {"SPA",                         SPT_PMC_BIT_SPA},
  85        {"SPB",                         SPT_PMC_BIT_SPB},
  86        {"SPC",                         SPT_PMC_BIT_SPC},
  87        {"GBE",                         SPT_PMC_BIT_GBE},
  88        {"SATA",                        SPT_PMC_BIT_SATA},
  89        {"HDA-PGD0",                    SPT_PMC_BIT_HDA_PGD0},
  90        {"HDA-PGD1",                    SPT_PMC_BIT_HDA_PGD1},
  91        {"HDA-PGD2",                    SPT_PMC_BIT_HDA_PGD2},
  92        {"HDA-PGD3",                    SPT_PMC_BIT_HDA_PGD3},
  93        {"RSVD",                        SPT_PMC_BIT_RSVD_0B},
  94        {"LPSS",                        SPT_PMC_BIT_LPSS},
  95        {"LPC",                         SPT_PMC_BIT_LPC},
  96        {"SMB",                         SPT_PMC_BIT_SMB},
  97        {"ISH",                         SPT_PMC_BIT_ISH},
  98        {"P2SB",                        SPT_PMC_BIT_P2SB},
  99        {"DFX",                         SPT_PMC_BIT_DFX},
 100        {"SCC",                         SPT_PMC_BIT_SCC},
 101        {"RSVD",                        SPT_PMC_BIT_RSVD_0C},
 102        {"FUSE",                        SPT_PMC_BIT_FUSE},
 103        {"CAMERA",                      SPT_PMC_BIT_CAMREA},
 104        {"RSVD",                        SPT_PMC_BIT_RSVD_0D},
 105        {"USB3-OTG",                    SPT_PMC_BIT_USB3_OTG},
 106        {"EXI",                         SPT_PMC_BIT_EXI},
 107        {"CSE",                         SPT_PMC_BIT_CSE},
 108        {"CSME_KVM",                    SPT_PMC_BIT_CSME_KVM},
 109        {"CSME_PMT",                    SPT_PMC_BIT_CSME_PMT},
 110        {"CSME_CLINK",                  SPT_PMC_BIT_CSME_CLINK},
 111        {"CSME_PTIO",                   SPT_PMC_BIT_CSME_PTIO},
 112        {"CSME_USBR",                   SPT_PMC_BIT_CSME_USBR},
 113        {"CSME_SUSRAM",                 SPT_PMC_BIT_CSME_SUSRAM},
 114        {"CSME_SMT",                    SPT_PMC_BIT_CSME_SMT},
 115        {"RSVD",                        SPT_PMC_BIT_RSVD_1A},
 116        {"CSME_SMS2",                   SPT_PMC_BIT_CSME_SMS2},
 117        {"CSME_SMS1",                   SPT_PMC_BIT_CSME_SMS1},
 118        {"CSME_RTC",                    SPT_PMC_BIT_CSME_RTC},
 119        {"CSME_PSF",                    SPT_PMC_BIT_CSME_PSF},
 120        {}
 121};
 122
 123static const struct pmc_bit_map *ext_spt_pfear_map[] = {
 124        /*
 125         * Check intel_pmc_core_ids[] users of spt_reg_map for
 126         * a list of core SoCs using this.
 127         */
 128        spt_pfear_map,
 129        NULL
 130};
 131
 132static const struct pmc_bit_map spt_ltr_show_map[] = {
 133        {"SOUTHPORT_A",         SPT_PMC_LTR_SPA},
 134        {"SOUTHPORT_B",         SPT_PMC_LTR_SPB},
 135        {"SATA",                SPT_PMC_LTR_SATA},
 136        {"GIGABIT_ETHERNET",    SPT_PMC_LTR_GBE},
 137        {"XHCI",                SPT_PMC_LTR_XHCI},
 138        {"Reserved",            SPT_PMC_LTR_RESERVED},
 139        {"ME",                  SPT_PMC_LTR_ME},
 140        /* EVA is Enterprise Value Add, doesn't really exist on PCH */
 141        {"EVA",                 SPT_PMC_LTR_EVA},
 142        {"SOUTHPORT_C",         SPT_PMC_LTR_SPC},
 143        {"HD_AUDIO",            SPT_PMC_LTR_AZ},
 144        {"LPSS",                SPT_PMC_LTR_LPSS},
 145        {"SOUTHPORT_D",         SPT_PMC_LTR_SPD},
 146        {"SOUTHPORT_E",         SPT_PMC_LTR_SPE},
 147        {"CAMERA",              SPT_PMC_LTR_CAM},
 148        {"ESPI",                SPT_PMC_LTR_ESPI},
 149        {"SCC",                 SPT_PMC_LTR_SCC},
 150        {"ISH",                 SPT_PMC_LTR_ISH},
 151        /* Below two cannot be used for LTR_IGNORE */
 152        {"CURRENT_PLATFORM",    SPT_PMC_LTR_CUR_PLT},
 153        {"AGGREGATED_SYSTEM",   SPT_PMC_LTR_CUR_ASLT},
 154        {}
 155};
 156
 157static const struct pmc_reg_map spt_reg_map = {
 158        .pfear_sts = ext_spt_pfear_map,
 159        .mphy_sts = spt_mphy_map,
 160        .pll_sts = spt_pll_map,
 161        .ltr_show_sts = spt_ltr_show_map,
 162        .msr_sts = msr_map,
 163        .slp_s0_offset = SPT_PMC_SLP_S0_RES_COUNTER_OFFSET,
 164        .slp_s0_res_counter_step = SPT_PMC_SLP_S0_RES_COUNTER_STEP,
 165        .ltr_ignore_offset = SPT_PMC_LTR_IGNORE_OFFSET,
 166        .regmap_length = SPT_PMC_MMIO_REG_LEN,
 167        .ppfear0_offset = SPT_PMC_XRAM_PPFEAR0A,
 168        .ppfear_buckets = SPT_PPFEAR_NUM_ENTRIES,
 169        .pm_cfg_offset = SPT_PMC_PM_CFG_OFFSET,
 170        .pm_read_disable_bit = SPT_PMC_READ_DISABLE_BIT,
 171        .ltr_ignore_max = SPT_NUM_IP_IGN_ALLOWED,
 172        .pm_vric1_offset = SPT_PMC_VRIC1_OFFSET,
 173};
 174
 175/* Cannon Lake: PGD PFET Enable Ack Status Register(s) bitmap */
 176static const struct pmc_bit_map cnp_pfear_map[] = {
 177        {"PMC",                 BIT(0)},
 178        {"OPI-DMI",             BIT(1)},
 179        {"SPI/eSPI",            BIT(2)},
 180        {"XHCI",                BIT(3)},
 181        {"SPA",                 BIT(4)},
 182        {"SPB",                 BIT(5)},
 183        {"SPC",                 BIT(6)},
 184        {"GBE",                 BIT(7)},
 185
 186        {"SATA",                BIT(0)},
 187        {"HDA_PGD0",            BIT(1)},
 188        {"HDA_PGD1",            BIT(2)},
 189        {"HDA_PGD2",            BIT(3)},
 190        {"HDA_PGD3",            BIT(4)},
 191        {"SPD",                 BIT(5)},
 192        {"LPSS",                BIT(6)},
 193        {"LPC",                 BIT(7)},
 194
 195        {"SMB",                 BIT(0)},
 196        {"ISH",                 BIT(1)},
 197        {"P2SB",                BIT(2)},
 198        {"NPK_VNN",             BIT(3)},
 199        {"SDX",                 BIT(4)},
 200        {"SPE",                 BIT(5)},
 201        {"Fuse",                BIT(6)},
 202        {"SBR8",                BIT(7)},
 203
 204        {"CSME_FSC",            BIT(0)},
 205        {"USB3_OTG",            BIT(1)},
 206        {"EXI",                 BIT(2)},
 207        {"CSE",                 BIT(3)},
 208        {"CSME_KVM",            BIT(4)},
 209        {"CSME_PMT",            BIT(5)},
 210        {"CSME_CLINK",          BIT(6)},
 211        {"CSME_PTIO",           BIT(7)},
 212
 213        {"CSME_USBR",           BIT(0)},
 214        {"CSME_SUSRAM",         BIT(1)},
 215        {"CSME_SMT1",           BIT(2)},
 216        {"CSME_SMT4",           BIT(3)},
 217        {"CSME_SMS2",           BIT(4)},
 218        {"CSME_SMS1",           BIT(5)},
 219        {"CSME_RTC",            BIT(6)},
 220        {"CSME_PSF",            BIT(7)},
 221
 222        {"SBR0",                BIT(0)},
 223        {"SBR1",                BIT(1)},
 224        {"SBR2",                BIT(2)},
 225        {"SBR3",                BIT(3)},
 226        {"SBR4",                BIT(4)},
 227        {"SBR5",                BIT(5)},
 228        {"CSME_PECI",           BIT(6)},
 229        {"PSF1",                BIT(7)},
 230
 231        {"PSF2",                BIT(0)},
 232        {"PSF3",                BIT(1)},
 233        {"PSF4",                BIT(2)},
 234        {"CNVI",                BIT(3)},
 235        {"UFS0",                BIT(4)},
 236        {"EMMC",                BIT(5)},
 237        {"SPF",                 BIT(6)},
 238        {"SBR6",                BIT(7)},
 239
 240        {"SBR7",                BIT(0)},
 241        {"NPK_AON",             BIT(1)},
 242        {"HDA_PGD4",            BIT(2)},
 243        {"HDA_PGD5",            BIT(3)},
 244        {"HDA_PGD6",            BIT(4)},
 245        {"PSF6",                BIT(5)},
 246        {"PSF7",                BIT(6)},
 247        {"PSF8",                BIT(7)},
 248        {}
 249};
 250
 251static const struct pmc_bit_map *ext_cnp_pfear_map[] = {
 252        /*
 253         * Check intel_pmc_core_ids[] users of cnp_reg_map for
 254         * a list of core SoCs using this.
 255         */
 256        cnp_pfear_map,
 257        NULL
 258};
 259
 260static const struct pmc_bit_map icl_pfear_map[] = {
 261        {"RES_65",              BIT(0)},
 262        {"RES_66",              BIT(1)},
 263        {"RES_67",              BIT(2)},
 264        {"TAM",                 BIT(3)},
 265        {"GBETSN",              BIT(4)},
 266        {"TBTLSX",              BIT(5)},
 267        {"RES_71",              BIT(6)},
 268        {"RES_72",              BIT(7)},
 269        {}
 270};
 271
 272static const struct pmc_bit_map *ext_icl_pfear_map[] = {
 273        /*
 274         * Check intel_pmc_core_ids[] users of icl_reg_map for
 275         * a list of core SoCs using this.
 276         */
 277        cnp_pfear_map,
 278        icl_pfear_map,
 279        NULL
 280};
 281
 282static const struct pmc_bit_map tgl_pfear_map[] = {
 283        {"PSF9",                BIT(0)},
 284        {"RES_66",              BIT(1)},
 285        {"RES_67",              BIT(2)},
 286        {"RES_68",              BIT(3)},
 287        {"RES_69",              BIT(4)},
 288        {"RES_70",              BIT(5)},
 289        {"TBTLSX",              BIT(6)},
 290        {}
 291};
 292
 293static const struct pmc_bit_map *ext_tgl_pfear_map[] = {
 294        /*
 295         * Check intel_pmc_core_ids[] users of tgl_reg_map for
 296         * a list of core SoCs using this.
 297         */
 298        cnp_pfear_map,
 299        tgl_pfear_map,
 300        NULL
 301};
 302
 303static const struct pmc_bit_map cnp_slps0_dbg0_map[] = {
 304        {"AUDIO_D3",            BIT(0)},
 305        {"OTG_D3",              BIT(1)},
 306        {"XHCI_D3",             BIT(2)},
 307        {"LPIO_D3",             BIT(3)},
 308        {"SDX_D3",              BIT(4)},
 309        {"SATA_D3",             BIT(5)},
 310        {"UFS0_D3",             BIT(6)},
 311        {"UFS1_D3",             BIT(7)},
 312        {"EMMC_D3",             BIT(8)},
 313        {}
 314};
 315
 316static const struct pmc_bit_map cnp_slps0_dbg1_map[] = {
 317        {"SDIO_PLL_OFF",        BIT(0)},
 318        {"USB2_PLL_OFF",        BIT(1)},
 319        {"AUDIO_PLL_OFF",       BIT(2)},
 320        {"OC_PLL_OFF",          BIT(3)},
 321        {"MAIN_PLL_OFF",        BIT(4)},
 322        {"XOSC_OFF",            BIT(5)},
 323        {"LPC_CLKS_GATED",      BIT(6)},
 324        {"PCIE_CLKREQS_IDLE",   BIT(7)},
 325        {"AUDIO_ROSC_OFF",      BIT(8)},
 326        {"HPET_XOSC_CLK_REQ",   BIT(9)},
 327        {"PMC_ROSC_SLOW_CLK",   BIT(10)},
 328        {"AON2_ROSC_GATED",     BIT(11)},
 329        {"CLKACKS_DEASSERTED",  BIT(12)},
 330        {}
 331};
 332
 333static const struct pmc_bit_map cnp_slps0_dbg2_map[] = {
 334        {"MPHY_CORE_GATED",     BIT(0)},
 335        {"CSME_GATED",          BIT(1)},
 336        {"USB2_SUS_GATED",      BIT(2)},
 337        {"DYN_FLEX_IO_IDLE",    BIT(3)},
 338        {"GBE_NO_LINK",         BIT(4)},
 339        {"THERM_SEN_DISABLED",  BIT(5)},
 340        {"PCIE_LOW_POWER",      BIT(6)},
 341        {"ISH_VNNAON_REQ_ACT",  BIT(7)},
 342        {"ISH_VNN_REQ_ACT",     BIT(8)},
 343        {"CNV_VNNAON_REQ_ACT",  BIT(9)},
 344        {"CNV_VNN_REQ_ACT",     BIT(10)},
 345        {"NPK_VNNON_REQ_ACT",   BIT(11)},
 346        {"PMSYNC_STATE_IDLE",   BIT(12)},
 347        {"ALST_GT_THRES",       BIT(13)},
 348        {"PMC_ARC_PG_READY",    BIT(14)},
 349        {}
 350};
 351
 352static const struct pmc_bit_map *cnp_slps0_dbg_maps[] = {
 353        cnp_slps0_dbg0_map,
 354        cnp_slps0_dbg1_map,
 355        cnp_slps0_dbg2_map,
 356        NULL
 357};
 358
 359static const struct pmc_bit_map cnp_ltr_show_map[] = {
 360        {"SOUTHPORT_A",         CNP_PMC_LTR_SPA},
 361        {"SOUTHPORT_B",         CNP_PMC_LTR_SPB},
 362        {"SATA",                CNP_PMC_LTR_SATA},
 363        {"GIGABIT_ETHERNET",    CNP_PMC_LTR_GBE},
 364        {"XHCI",                CNP_PMC_LTR_XHCI},
 365        {"Reserved",            CNP_PMC_LTR_RESERVED},
 366        {"ME",                  CNP_PMC_LTR_ME},
 367        /* EVA is Enterprise Value Add, doesn't really exist on PCH */
 368        {"EVA",                 CNP_PMC_LTR_EVA},
 369        {"SOUTHPORT_C",         CNP_PMC_LTR_SPC},
 370        {"HD_AUDIO",            CNP_PMC_LTR_AZ},
 371        {"CNV",                 CNP_PMC_LTR_CNV},
 372        {"LPSS",                CNP_PMC_LTR_LPSS},
 373        {"SOUTHPORT_D",         CNP_PMC_LTR_SPD},
 374        {"SOUTHPORT_E",         CNP_PMC_LTR_SPE},
 375        {"CAMERA",              CNP_PMC_LTR_CAM},
 376        {"ESPI",                CNP_PMC_LTR_ESPI},
 377        {"SCC",                 CNP_PMC_LTR_SCC},
 378        {"ISH",                 CNP_PMC_LTR_ISH},
 379        {"UFSX2",               CNP_PMC_LTR_UFSX2},
 380        {"EMMC",                CNP_PMC_LTR_EMMC},
 381        /*
 382         * Check intel_pmc_core_ids[] users of cnp_reg_map for
 383         * a list of core SoCs using this.
 384         */
 385        {"WIGIG",               ICL_PMC_LTR_WIGIG},
 386        {"THC0",                TGL_PMC_LTR_THC0},
 387        {"THC1",                TGL_PMC_LTR_THC1},
 388        /* Below two cannot be used for LTR_IGNORE */
 389        {"CURRENT_PLATFORM",    CNP_PMC_LTR_CUR_PLT},
 390        {"AGGREGATED_SYSTEM",   CNP_PMC_LTR_CUR_ASLT},
 391        {}
 392};
 393
 394static const struct pmc_reg_map cnp_reg_map = {
 395        .pfear_sts = ext_cnp_pfear_map,
 396        .slp_s0_offset = CNP_PMC_SLP_S0_RES_COUNTER_OFFSET,
 397        .slp_s0_res_counter_step = SPT_PMC_SLP_S0_RES_COUNTER_STEP,
 398        .slps0_dbg_maps = cnp_slps0_dbg_maps,
 399        .ltr_show_sts = cnp_ltr_show_map,
 400        .msr_sts = msr_map,
 401        .slps0_dbg_offset = CNP_PMC_SLPS0_DBG_OFFSET,
 402        .ltr_ignore_offset = CNP_PMC_LTR_IGNORE_OFFSET,
 403        .regmap_length = CNP_PMC_MMIO_REG_LEN,
 404        .ppfear0_offset = CNP_PMC_HOST_PPFEAR0A,
 405        .ppfear_buckets = CNP_PPFEAR_NUM_ENTRIES,
 406        .pm_cfg_offset = CNP_PMC_PM_CFG_OFFSET,
 407        .pm_read_disable_bit = CNP_PMC_READ_DISABLE_BIT,
 408        .ltr_ignore_max = CNP_NUM_IP_IGN_ALLOWED,
 409        .etr3_offset = ETR3_OFFSET,
 410};
 411
 412static const struct pmc_reg_map icl_reg_map = {
 413        .pfear_sts = ext_icl_pfear_map,
 414        .slp_s0_offset = CNP_PMC_SLP_S0_RES_COUNTER_OFFSET,
 415        .slp_s0_res_counter_step = ICL_PMC_SLP_S0_RES_COUNTER_STEP,
 416        .slps0_dbg_maps = cnp_slps0_dbg_maps,
 417        .ltr_show_sts = cnp_ltr_show_map,
 418        .msr_sts = msr_map,
 419        .slps0_dbg_offset = CNP_PMC_SLPS0_DBG_OFFSET,
 420        .ltr_ignore_offset = CNP_PMC_LTR_IGNORE_OFFSET,
 421        .regmap_length = CNP_PMC_MMIO_REG_LEN,
 422        .ppfear0_offset = CNP_PMC_HOST_PPFEAR0A,
 423        .ppfear_buckets = ICL_PPFEAR_NUM_ENTRIES,
 424        .pm_cfg_offset = CNP_PMC_PM_CFG_OFFSET,
 425        .pm_read_disable_bit = CNP_PMC_READ_DISABLE_BIT,
 426        .ltr_ignore_max = ICL_NUM_IP_IGN_ALLOWED,
 427        .etr3_offset = ETR3_OFFSET,
 428};
 429
 430static const struct pmc_bit_map tgl_clocksource_status_map[] = {
 431        {"USB2PLL_OFF_STS",                     BIT(18)},
 432        {"PCIe/USB3.1_Gen2PLL_OFF_STS",         BIT(19)},
 433        {"PCIe_Gen3PLL_OFF_STS",                BIT(20)},
 434        {"OPIOPLL_OFF_STS",                     BIT(21)},
 435        {"OCPLL_OFF_STS",                       BIT(22)},
 436        {"MainPLL_OFF_STS",                     BIT(23)},
 437        {"MIPIPLL_OFF_STS",                     BIT(24)},
 438        {"Fast_XTAL_Osc_OFF_STS",               BIT(25)},
 439        {"AC_Ring_Osc_OFF_STS",                 BIT(26)},
 440        {"MC_Ring_Osc_OFF_STS",                 BIT(27)},
 441        {"SATAPLL_OFF_STS",                     BIT(29)},
 442        {"XTAL_USB2PLL_OFF_STS",                BIT(31)},
 443        {}
 444};
 445
 446static const struct pmc_bit_map tgl_power_gating_status_map[] = {
 447        {"CSME_PG_STS",                         BIT(0)},
 448        {"SATA_PG_STS",                         BIT(1)},
 449        {"xHCI_PG_STS",                         BIT(2)},
 450        {"UFSX2_PG_STS",                        BIT(3)},
 451        {"OTG_PG_STS",                          BIT(5)},
 452        {"SPA_PG_STS",                          BIT(6)},
 453        {"SPB_PG_STS",                          BIT(7)},
 454        {"SPC_PG_STS",                          BIT(8)},
 455        {"SPD_PG_STS",                          BIT(9)},
 456        {"SPE_PG_STS",                          BIT(10)},
 457        {"SPF_PG_STS",                          BIT(11)},
 458        {"LSX_PG_STS",                          BIT(13)},
 459        {"P2SB_PG_STS",                         BIT(14)},
 460        {"PSF_PG_STS",                          BIT(15)},
 461        {"SBR_PG_STS",                          BIT(16)},
 462        {"OPIDMI_PG_STS",                       BIT(17)},
 463        {"THC0_PG_STS",                         BIT(18)},
 464        {"THC1_PG_STS",                         BIT(19)},
 465        {"GBETSN_PG_STS",                       BIT(20)},
 466        {"GBE_PG_STS",                          BIT(21)},
 467        {"LPSS_PG_STS",                         BIT(22)},
 468        {"MMP_UFSX2_PG_STS",                    BIT(23)},
 469        {"MMP_UFSX2B_PG_STS",                   BIT(24)},
 470        {"FIA_PG_STS",                          BIT(25)},
 471        {}
 472};
 473
 474static const struct pmc_bit_map tgl_d3_status_map[] = {
 475        {"ADSP_D3_STS",                         BIT(0)},
 476        {"SATA_D3_STS",                         BIT(1)},
 477        {"xHCI0_D3_STS",                        BIT(2)},
 478        {"xDCI1_D3_STS",                        BIT(5)},
 479        {"SDX_D3_STS",                          BIT(6)},
 480        {"EMMC_D3_STS",                         BIT(7)},
 481        {"IS_D3_STS",                           BIT(8)},
 482        {"THC0_D3_STS",                         BIT(9)},
 483        {"THC1_D3_STS",                         BIT(10)},
 484        {"GBE_D3_STS",                          BIT(11)},
 485        {"GBE_TSN_D3_STS",                      BIT(12)},
 486        {}
 487};
 488
 489static const struct pmc_bit_map tgl_vnn_req_status_map[] = {
 490        {"GPIO_COM0_VNN_REQ_STS",               BIT(1)},
 491        {"GPIO_COM1_VNN_REQ_STS",               BIT(2)},
 492        {"GPIO_COM2_VNN_REQ_STS",               BIT(3)},
 493        {"GPIO_COM3_VNN_REQ_STS",               BIT(4)},
 494        {"GPIO_COM4_VNN_REQ_STS",               BIT(5)},
 495        {"GPIO_COM5_VNN_REQ_STS",               BIT(6)},
 496        {"Audio_VNN_REQ_STS",                   BIT(7)},
 497        {"ISH_VNN_REQ_STS",                     BIT(8)},
 498        {"CNVI_VNN_REQ_STS",                    BIT(9)},
 499        {"eSPI_VNN_REQ_STS",                    BIT(10)},
 500        {"Display_VNN_REQ_STS",                 BIT(11)},
 501        {"DTS_VNN_REQ_STS",                     BIT(12)},
 502        {"SMBUS_VNN_REQ_STS",                   BIT(14)},
 503        {"CSME_VNN_REQ_STS",                    BIT(15)},
 504        {"SMLINK0_VNN_REQ_STS",                 BIT(16)},
 505        {"SMLINK1_VNN_REQ_STS",                 BIT(17)},
 506        {"CLINK_VNN_REQ_STS",                   BIT(20)},
 507        {"DCI_VNN_REQ_STS",                     BIT(21)},
 508        {"ITH_VNN_REQ_STS",                     BIT(22)},
 509        {"CSME_VNN_REQ_STS",                    BIT(24)},
 510        {"GBE_VNN_REQ_STS",                     BIT(25)},
 511        {}
 512};
 513
 514static const struct pmc_bit_map tgl_vnn_misc_status_map[] = {
 515        {"CPU_C10_REQ_STS_0",                   BIT(0)},
 516        {"PCIe_LPM_En_REQ_STS_3",               BIT(3)},
 517        {"ITH_REQ_STS_5",                       BIT(5)},
 518        {"CNVI_REQ_STS_6",                      BIT(6)},
 519        {"ISH_REQ_STS_7",                       BIT(7)},
 520        {"USB2_SUS_PG_Sys_REQ_STS_10",          BIT(10)},
 521        {"PCIe_Clk_REQ_STS_12",                 BIT(12)},
 522        {"MPHY_Core_DL_REQ_STS_16",             BIT(16)},
 523        {"Break-even_En_REQ_STS_17",            BIT(17)},
 524        {"Auto-demo_En_REQ_STS_18",             BIT(18)},
 525        {"MPHY_SUS_REQ_STS_22",                 BIT(22)},
 526        {"xDCI_attached_REQ_STS_24",            BIT(24)},
 527        {}
 528};
 529
 530static const struct pmc_bit_map tgl_signal_status_map[] = {
 531        {"LSX_Wake0_En_STS",                    BIT(0)},
 532        {"LSX_Wake0_Pol_STS",                   BIT(1)},
 533        {"LSX_Wake1_En_STS",                    BIT(2)},
 534        {"LSX_Wake1_Pol_STS",                   BIT(3)},
 535        {"LSX_Wake2_En_STS",                    BIT(4)},
 536        {"LSX_Wake2_Pol_STS",                   BIT(5)},
 537        {"LSX_Wake3_En_STS",                    BIT(6)},
 538        {"LSX_Wake3_Pol_STS",                   BIT(7)},
 539        {"LSX_Wake4_En_STS",                    BIT(8)},
 540        {"LSX_Wake4_Pol_STS",                   BIT(9)},
 541        {"LSX_Wake5_En_STS",                    BIT(10)},
 542        {"LSX_Wake5_Pol_STS",                   BIT(11)},
 543        {"LSX_Wake6_En_STS",                    BIT(12)},
 544        {"LSX_Wake6_Pol_STS",                   BIT(13)},
 545        {"LSX_Wake7_En_STS",                    BIT(14)},
 546        {"LSX_Wake7_Pol_STS",                   BIT(15)},
 547        {"Intel_Se_IO_Wake0_En_STS",            BIT(16)},
 548        {"Intel_Se_IO_Wake0_Pol_STS",           BIT(17)},
 549        {"Intel_Se_IO_Wake1_En_STS",            BIT(18)},
 550        {"Intel_Se_IO_Wake1_Pol_STS",           BIT(19)},
 551        {"Int_Timer_SS_Wake0_En_STS",           BIT(20)},
 552        {"Int_Timer_SS_Wake0_Pol_STS",          BIT(21)},
 553        {"Int_Timer_SS_Wake1_En_STS",           BIT(22)},
 554        {"Int_Timer_SS_Wake1_Pol_STS",          BIT(23)},
 555        {"Int_Timer_SS_Wake2_En_STS",           BIT(24)},
 556        {"Int_Timer_SS_Wake2_Pol_STS",          BIT(25)},
 557        {"Int_Timer_SS_Wake3_En_STS",           BIT(26)},
 558        {"Int_Timer_SS_Wake3_Pol_STS",          BIT(27)},
 559        {"Int_Timer_SS_Wake4_En_STS",           BIT(28)},
 560        {"Int_Timer_SS_Wake4_Pol_STS",          BIT(29)},
 561        {"Int_Timer_SS_Wake5_En_STS",           BIT(30)},
 562        {"Int_Timer_SS_Wake5_Pol_STS",          BIT(31)},
 563        {}
 564};
 565
 566static const struct pmc_bit_map *tgl_lpm_maps[] = {
 567        tgl_clocksource_status_map,
 568        tgl_power_gating_status_map,
 569        tgl_d3_status_map,
 570        tgl_vnn_req_status_map,
 571        tgl_vnn_misc_status_map,
 572        tgl_signal_status_map,
 573        NULL
 574};
 575
 576static const struct pmc_reg_map tgl_reg_map = {
 577        .pfear_sts = ext_tgl_pfear_map,
 578        .slp_s0_offset = CNP_PMC_SLP_S0_RES_COUNTER_OFFSET,
 579        .slp_s0_res_counter_step = TGL_PMC_SLP_S0_RES_COUNTER_STEP,
 580        .ltr_show_sts = cnp_ltr_show_map,
 581        .msr_sts = msr_map,
 582        .ltr_ignore_offset = CNP_PMC_LTR_IGNORE_OFFSET,
 583        .regmap_length = CNP_PMC_MMIO_REG_LEN,
 584        .ppfear0_offset = CNP_PMC_HOST_PPFEAR0A,
 585        .ppfear_buckets = ICL_PPFEAR_NUM_ENTRIES,
 586        .pm_cfg_offset = CNP_PMC_PM_CFG_OFFSET,
 587        .pm_read_disable_bit = CNP_PMC_READ_DISABLE_BIT,
 588        .ltr_ignore_max = TGL_NUM_IP_IGN_ALLOWED,
 589        .lpm_num_maps = TGL_LPM_NUM_MAPS,
 590        .lpm_res_counter_step_x2 = TGL_PMC_LPM_RES_COUNTER_STEP_X2,
 591        .lpm_sts_latch_en_offset = TGL_LPM_STS_LATCH_EN_OFFSET,
 592        .lpm_en_offset = TGL_LPM_EN_OFFSET,
 593        .lpm_priority_offset = TGL_LPM_PRI_OFFSET,
 594        .lpm_residency_offset = TGL_LPM_RESIDENCY_OFFSET,
 595        .lpm_sts = tgl_lpm_maps,
 596        .lpm_status_offset = TGL_LPM_STATUS_OFFSET,
 597        .lpm_live_status_offset = TGL_LPM_LIVE_STATUS_OFFSET,
 598        .etr3_offset = ETR3_OFFSET,
 599};
 600
 601static void pmc_core_get_tgl_lpm_reqs(struct platform_device *pdev)
 602{
 603        struct pmc_dev *pmcdev = platform_get_drvdata(pdev);
 604        const int num_maps = pmcdev->map->lpm_num_maps;
 605        u32 lpm_size = LPM_MAX_NUM_MODES * num_maps * 4;
 606        union acpi_object *out_obj;
 607        struct acpi_device *adev;
 608        guid_t s0ix_dsm_guid;
 609        u32 *lpm_req_regs, *addr;
 610
 611        adev = ACPI_COMPANION(&pdev->dev);
 612        if (!adev)
 613                return;
 614
 615        guid_parse(ACPI_S0IX_DSM_UUID, &s0ix_dsm_guid);
 616
 617        out_obj = acpi_evaluate_dsm(adev->handle, &s0ix_dsm_guid, 0,
 618                                    ACPI_GET_LOW_MODE_REGISTERS, NULL);
 619        if (out_obj && out_obj->type == ACPI_TYPE_BUFFER) {
 620                u32 size = out_obj->buffer.length;
 621
 622                if (size != lpm_size) {
 623                        acpi_handle_debug(adev->handle,
 624                                "_DSM returned unexpected buffer size, have %u, expect %u\n",
 625                                size, lpm_size);
 626                        goto free_acpi_obj;
 627                }
 628        } else {
 629                acpi_handle_debug(adev->handle,
 630                                  "_DSM function 0 evaluation failed\n");
 631                goto free_acpi_obj;
 632        }
 633
 634        addr = (u32 *)out_obj->buffer.pointer;
 635
 636        lpm_req_regs = devm_kzalloc(&pdev->dev, lpm_size * sizeof(u32),
 637                                     GFP_KERNEL);
 638        if (!lpm_req_regs)
 639                goto free_acpi_obj;
 640
 641        memcpy(lpm_req_regs, addr, lpm_size);
 642        pmcdev->lpm_req_regs = lpm_req_regs;
 643
 644free_acpi_obj:
 645        ACPI_FREE(out_obj);
 646}
 647
 648static inline u32 pmc_core_reg_read(struct pmc_dev *pmcdev, int reg_offset)
 649{
 650        return readl(pmcdev->regbase + reg_offset);
 651}
 652
 653static inline void pmc_core_reg_write(struct pmc_dev *pmcdev, int reg_offset,
 654                                      u32 val)
 655{
 656        writel(val, pmcdev->regbase + reg_offset);
 657}
 658
 659static inline u64 pmc_core_adjust_slp_s0_step(struct pmc_dev *pmcdev, u32 value)
 660{
 661        return (u64)value * pmcdev->map->slp_s0_res_counter_step;
 662}
 663
 664static int set_etr3(struct pmc_dev *pmcdev)
 665{
 666        const struct pmc_reg_map *map = pmcdev->map;
 667        u32 reg;
 668        int err;
 669
 670        if (!map->etr3_offset)
 671                return -EOPNOTSUPP;
 672
 673        mutex_lock(&pmcdev->lock);
 674
 675        /* check if CF9 is locked */
 676        reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
 677        if (reg & ETR3_CF9LOCK) {
 678                err = -EACCES;
 679                goto out_unlock;
 680        }
 681
 682        /* write CF9 global reset bit */
 683        reg |= ETR3_CF9GR;
 684        pmc_core_reg_write(pmcdev, map->etr3_offset, reg);
 685
 686        reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
 687        if (!(reg & ETR3_CF9GR)) {
 688                err = -EIO;
 689                goto out_unlock;
 690        }
 691
 692        err = 0;
 693
 694out_unlock:
 695        mutex_unlock(&pmcdev->lock);
 696        return err;
 697}
 698static umode_t etr3_is_visible(struct kobject *kobj,
 699                                struct attribute *attr,
 700                                int idx)
 701{
 702        struct device *dev = container_of(kobj, struct device, kobj);
 703        struct pmc_dev *pmcdev = dev_get_drvdata(dev);
 704        const struct pmc_reg_map *map = pmcdev->map;
 705        u32 reg;
 706
 707        mutex_lock(&pmcdev->lock);
 708        reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
 709        mutex_unlock(&pmcdev->lock);
 710
 711        return reg & ETR3_CF9LOCK ? attr->mode & (SYSFS_PREALLOC | 0444) : attr->mode;
 712}
 713
 714static ssize_t etr3_show(struct device *dev,
 715                                 struct device_attribute *attr, char *buf)
 716{
 717        struct pmc_dev *pmcdev = dev_get_drvdata(dev);
 718        const struct pmc_reg_map *map = pmcdev->map;
 719        u32 reg;
 720
 721        if (!map->etr3_offset)
 722                return -EOPNOTSUPP;
 723
 724        mutex_lock(&pmcdev->lock);
 725
 726        reg = pmc_core_reg_read(pmcdev, map->etr3_offset);
 727        reg &= ETR3_CF9GR | ETR3_CF9LOCK;
 728
 729        mutex_unlock(&pmcdev->lock);
 730
 731        return sysfs_emit(buf, "0x%08x", reg);
 732}
 733
 734static ssize_t etr3_store(struct device *dev,
 735                                  struct device_attribute *attr,
 736                                  const char *buf, size_t len)
 737{
 738        struct pmc_dev *pmcdev = dev_get_drvdata(dev);
 739        int err;
 740        u32 reg;
 741
 742        err = kstrtouint(buf, 16, &reg);
 743        if (err)
 744                return err;
 745
 746        /* allow only CF9 writes */
 747        if (reg != ETR3_CF9GR)
 748                return -EINVAL;
 749
 750        err = set_etr3(pmcdev);
 751        if (err)
 752                return err;
 753
 754        return len;
 755}
 756static DEVICE_ATTR_RW(etr3);
 757
 758static struct attribute *pmc_attrs[] = {
 759        &dev_attr_etr3.attr,
 760        NULL
 761};
 762
 763static const struct attribute_group pmc_attr_group = {
 764        .attrs = pmc_attrs,
 765        .is_visible = etr3_is_visible,
 766};
 767
 768static const struct attribute_group *pmc_dev_groups[] = {
 769        &pmc_attr_group,
 770        NULL
 771};
 772
 773static int pmc_core_dev_state_get(void *data, u64 *val)
 774{
 775        struct pmc_dev *pmcdev = data;
 776        const struct pmc_reg_map *map = pmcdev->map;
 777        u32 value;
 778
 779        value = pmc_core_reg_read(pmcdev, map->slp_s0_offset);
 780        *val = pmc_core_adjust_slp_s0_step(pmcdev, value);
 781
 782        return 0;
 783}
 784
 785DEFINE_DEBUGFS_ATTRIBUTE(pmc_core_dev_state, pmc_core_dev_state_get, NULL, "%llu\n");
 786
 787static int pmc_core_check_read_lock_bit(struct pmc_dev *pmcdev)
 788{
 789        u32 value;
 790
 791        value = pmc_core_reg_read(pmcdev, pmcdev->map->pm_cfg_offset);
 792        return value & BIT(pmcdev->map->pm_read_disable_bit);
 793}
 794
 795static void pmc_core_slps0_display(struct pmc_dev *pmcdev, struct device *dev,
 796                                   struct seq_file *s)
 797{
 798        const struct pmc_bit_map **maps = pmcdev->map->slps0_dbg_maps;
 799        const struct pmc_bit_map *map;
 800        int offset = pmcdev->map->slps0_dbg_offset;
 801        u32 data;
 802
 803        while (*maps) {
 804                map = *maps;
 805                data = pmc_core_reg_read(pmcdev, offset);
 806                offset += 4;
 807                while (map->name) {
 808                        if (dev)
 809                                dev_info(dev, "SLP_S0_DBG: %-32s\tState: %s\n",
 810                                        map->name,
 811                                        data & map->bit_mask ? "Yes" : "No");
 812                        if (s)
 813                                seq_printf(s, "SLP_S0_DBG: %-32s\tState: %s\n",
 814                                           map->name,
 815                                           data & map->bit_mask ? "Yes" : "No");
 816                        ++map;
 817                }
 818                ++maps;
 819        }
 820}
 821
 822static int pmc_core_lpm_get_arr_size(const struct pmc_bit_map **maps)
 823{
 824        int idx;
 825
 826        for (idx = 0; maps[idx]; idx++)
 827                ;/* Nothing */
 828
 829        return idx;
 830}
 831
 832static void pmc_core_lpm_display(struct pmc_dev *pmcdev, struct device *dev,
 833                                 struct seq_file *s, u32 offset,
 834                                 const char *str,
 835                                 const struct pmc_bit_map **maps)
 836{
 837        int index, idx, len = 32, bit_mask, arr_size;
 838        u32 *lpm_regs;
 839
 840        arr_size = pmc_core_lpm_get_arr_size(maps);
 841        lpm_regs = kmalloc_array(arr_size, sizeof(*lpm_regs), GFP_KERNEL);
 842        if (!lpm_regs)
 843                return;
 844
 845        for (index = 0; index < arr_size; index++) {
 846                lpm_regs[index] = pmc_core_reg_read(pmcdev, offset);
 847                offset += 4;
 848        }
 849
 850        for (idx = 0; idx < arr_size; idx++) {
 851                if (dev)
 852                        dev_info(dev, "\nLPM_%s_%d:\t0x%x\n", str, idx,
 853                                lpm_regs[idx]);
 854                if (s)
 855                        seq_printf(s, "\nLPM_%s_%d:\t0x%x\n", str, idx,
 856                                   lpm_regs[idx]);
 857                for (index = 0; maps[idx][index].name && index < len; index++) {
 858                        bit_mask = maps[idx][index].bit_mask;
 859                        if (dev)
 860                                dev_info(dev, "%-30s %-30d\n",
 861                                        maps[idx][index].name,
 862                                        lpm_regs[idx] & bit_mask ? 1 : 0);
 863                        if (s)
 864                                seq_printf(s, "%-30s %-30d\n",
 865                                           maps[idx][index].name,
 866                                           lpm_regs[idx] & bit_mask ? 1 : 0);
 867                }
 868        }
 869
 870        kfree(lpm_regs);
 871}
 872
 873static bool slps0_dbg_latch;
 874
 875static inline u8 pmc_core_reg_read_byte(struct pmc_dev *pmcdev, int offset)
 876{
 877        return readb(pmcdev->regbase + offset);
 878}
 879
 880static void pmc_core_display_map(struct seq_file *s, int index, int idx, int ip,
 881                                 u8 pf_reg, const struct pmc_bit_map **pf_map)
 882{
 883        seq_printf(s, "PCH IP: %-2d - %-32s\tState: %s\n",
 884                   ip, pf_map[idx][index].name,
 885                   pf_map[idx][index].bit_mask & pf_reg ? "Off" : "On");
 886}
 887
 888static int pmc_core_ppfear_show(struct seq_file *s, void *unused)
 889{
 890        struct pmc_dev *pmcdev = s->private;
 891        const struct pmc_bit_map **maps = pmcdev->map->pfear_sts;
 892        u8 pf_regs[PPFEAR_MAX_NUM_ENTRIES];
 893        int index, iter, idx, ip = 0;
 894
 895        iter = pmcdev->map->ppfear0_offset;
 896
 897        for (index = 0; index < pmcdev->map->ppfear_buckets &&
 898             index < PPFEAR_MAX_NUM_ENTRIES; index++, iter++)
 899                pf_regs[index] = pmc_core_reg_read_byte(pmcdev, iter);
 900
 901        for (idx = 0; maps[idx]; idx++) {
 902                for (index = 0; maps[idx][index].name &&
 903                     index < pmcdev->map->ppfear_buckets * 8; ip++, index++)
 904                        pmc_core_display_map(s, index, idx, ip,
 905                                             pf_regs[index / 8], maps);
 906        }
 907
 908        return 0;
 909}
 910DEFINE_SHOW_ATTRIBUTE(pmc_core_ppfear);
 911
 912/* This function should return link status, 0 means ready */
 913static int pmc_core_mtpmc_link_status(struct pmc_dev *pmcdev)
 914{
 915        u32 value;
 916
 917        value = pmc_core_reg_read(pmcdev, SPT_PMC_PM_STS_OFFSET);
 918        return value & BIT(SPT_PMC_MSG_FULL_STS_BIT);
 919}
 920
 921static int pmc_core_send_msg(struct pmc_dev *pmcdev, u32 *addr_xram)
 922{
 923        u32 dest;
 924        int timeout;
 925
 926        for (timeout = NUM_RETRIES; timeout > 0; timeout--) {
 927                if (pmc_core_mtpmc_link_status(pmcdev) == 0)
 928                        break;
 929                msleep(5);
 930        }
 931
 932        if (timeout <= 0 && pmc_core_mtpmc_link_status(pmcdev))
 933                return -EBUSY;
 934
 935        dest = (*addr_xram & MTPMC_MASK) | (1U << 1);
 936        pmc_core_reg_write(pmcdev, SPT_PMC_MTPMC_OFFSET, dest);
 937        return 0;
 938}
 939
 940static int pmc_core_mphy_pg_show(struct seq_file *s, void *unused)
 941{
 942        struct pmc_dev *pmcdev = s->private;
 943        const struct pmc_bit_map *map = pmcdev->map->mphy_sts;
 944        u32 mphy_core_reg_low, mphy_core_reg_high;
 945        u32 val_low, val_high;
 946        int index, err = 0;
 947
 948        if (pmcdev->pmc_xram_read_bit) {
 949                seq_puts(s, "Access denied: please disable PMC_READ_DISABLE setting in BIOS.");
 950                return 0;
 951        }
 952
 953        mphy_core_reg_low  = (SPT_PMC_MPHY_CORE_STS_0 << 16);
 954        mphy_core_reg_high = (SPT_PMC_MPHY_CORE_STS_1 << 16);
 955
 956        mutex_lock(&pmcdev->lock);
 957
 958        if (pmc_core_send_msg(pmcdev, &mphy_core_reg_low) != 0) {
 959                err = -EBUSY;
 960                goto out_unlock;
 961        }
 962
 963        msleep(10);
 964        val_low = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
 965
 966        if (pmc_core_send_msg(pmcdev, &mphy_core_reg_high) != 0) {
 967                err = -EBUSY;
 968                goto out_unlock;
 969        }
 970
 971        msleep(10);
 972        val_high = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
 973
 974        for (index = 0; index < 8 && map[index].name; index++) {
 975                seq_printf(s, "%-32s\tState: %s\n",
 976                           map[index].name,
 977                           map[index].bit_mask & val_low ? "Not power gated" :
 978                           "Power gated");
 979        }
 980
 981        for (index = 8; map[index].name; index++) {
 982                seq_printf(s, "%-32s\tState: %s\n",
 983                           map[index].name,
 984                           map[index].bit_mask & val_high ? "Not power gated" :
 985                           "Power gated");
 986        }
 987
 988out_unlock:
 989        mutex_unlock(&pmcdev->lock);
 990        return err;
 991}
 992DEFINE_SHOW_ATTRIBUTE(pmc_core_mphy_pg);
 993
 994static int pmc_core_pll_show(struct seq_file *s, void *unused)
 995{
 996        struct pmc_dev *pmcdev = s->private;
 997        const struct pmc_bit_map *map = pmcdev->map->pll_sts;
 998        u32 mphy_common_reg, val;
 999        int index, err = 0;
1000
1001        if (pmcdev->pmc_xram_read_bit) {
1002                seq_puts(s, "Access denied: please disable PMC_READ_DISABLE setting in BIOS.");
1003                return 0;
1004        }
1005
1006        mphy_common_reg  = (SPT_PMC_MPHY_COM_STS_0 << 16);
1007        mutex_lock(&pmcdev->lock);
1008
1009        if (pmc_core_send_msg(pmcdev, &mphy_common_reg) != 0) {
1010                err = -EBUSY;
1011                goto out_unlock;
1012        }
1013
1014        /* Observed PMC HW response latency for MTPMC-MFPMC is ~10 ms */
1015        msleep(10);
1016        val = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
1017
1018        for (index = 0; map[index].name ; index++) {
1019                seq_printf(s, "%-32s\tState: %s\n",
1020                           map[index].name,
1021                           map[index].bit_mask & val ? "Active" : "Idle");
1022        }
1023
1024out_unlock:
1025        mutex_unlock(&pmcdev->lock);
1026        return err;
1027}
1028DEFINE_SHOW_ATTRIBUTE(pmc_core_pll);
1029
1030static int pmc_core_send_ltr_ignore(struct pmc_dev *pmcdev, u32 value)
1031{
1032        const struct pmc_reg_map *map = pmcdev->map;
1033        u32 reg;
1034        int err = 0;
1035
1036        mutex_lock(&pmcdev->lock);
1037
1038        if (value > map->ltr_ignore_max) {
1039                err = -EINVAL;
1040                goto out_unlock;
1041        }
1042
1043        reg = pmc_core_reg_read(pmcdev, map->ltr_ignore_offset);
1044        reg |= BIT(value);
1045        pmc_core_reg_write(pmcdev, map->ltr_ignore_offset, reg);
1046
1047out_unlock:
1048        mutex_unlock(&pmcdev->lock);
1049
1050        return err;
1051}
1052
1053static ssize_t pmc_core_ltr_ignore_write(struct file *file,
1054                                         const char __user *userbuf,
1055                                         size_t count, loff_t *ppos)
1056{
1057        struct seq_file *s = file->private_data;
1058        struct pmc_dev *pmcdev = s->private;
1059        u32 buf_size, value;
1060        int err;
1061
1062        buf_size = min_t(u32, count, 64);
1063
1064        err = kstrtou32_from_user(userbuf, buf_size, 10, &value);
1065        if (err)
1066                return err;
1067
1068        err = pmc_core_send_ltr_ignore(pmcdev, value);
1069
1070        return err == 0 ? count : err;
1071}
1072
1073static int pmc_core_ltr_ignore_show(struct seq_file *s, void *unused)
1074{
1075        return 0;
1076}
1077
1078static int pmc_core_ltr_ignore_open(struct inode *inode, struct file *file)
1079{
1080        return single_open(file, pmc_core_ltr_ignore_show, inode->i_private);
1081}
1082
1083static const struct file_operations pmc_core_ltr_ignore_ops = {
1084        .open           = pmc_core_ltr_ignore_open,
1085        .read           = seq_read,
1086        .write          = pmc_core_ltr_ignore_write,
1087        .llseek         = seq_lseek,
1088        .release        = single_release,
1089};
1090
1091static void pmc_core_slps0_dbg_latch(struct pmc_dev *pmcdev, bool reset)
1092{
1093        const struct pmc_reg_map *map = pmcdev->map;
1094        u32 fd;
1095
1096        mutex_lock(&pmcdev->lock);
1097
1098        if (!reset && !slps0_dbg_latch)
1099                goto out_unlock;
1100
1101        fd = pmc_core_reg_read(pmcdev, map->slps0_dbg_offset);
1102        if (reset)
1103                fd &= ~CNP_PMC_LATCH_SLPS0_EVENTS;
1104        else
1105                fd |= CNP_PMC_LATCH_SLPS0_EVENTS;
1106        pmc_core_reg_write(pmcdev, map->slps0_dbg_offset, fd);
1107
1108        slps0_dbg_latch = false;
1109
1110out_unlock:
1111        mutex_unlock(&pmcdev->lock);
1112}
1113
1114static int pmc_core_slps0_dbg_show(struct seq_file *s, void *unused)
1115{
1116        struct pmc_dev *pmcdev = s->private;
1117
1118        pmc_core_slps0_dbg_latch(pmcdev, false);
1119        pmc_core_slps0_display(pmcdev, NULL, s);
1120        pmc_core_slps0_dbg_latch(pmcdev, true);
1121
1122        return 0;
1123}
1124DEFINE_SHOW_ATTRIBUTE(pmc_core_slps0_dbg);
1125
1126static u32 convert_ltr_scale(u32 val)
1127{
1128        /*
1129         * As per PCIE specification supporting document
1130         * ECN_LatencyTolnReporting_14Aug08.pdf the Latency
1131         * Tolerance Reporting data payload is encoded in a
1132         * 3 bit scale and 10 bit value fields. Values are
1133         * multiplied by the indicated scale to yield an absolute time
1134         * value, expressible in a range from 1 nanosecond to
1135         * 2^25*(2^10-1) = 34,326,183,936 nanoseconds.
1136         *
1137         * scale encoding is as follows:
1138         *
1139         * ----------------------------------------------
1140         * |scale factor        |       Multiplier (ns) |
1141         * ----------------------------------------------
1142         * |    0               |       1               |
1143         * |    1               |       32              |
1144         * |    2               |       1024            |
1145         * |    3               |       32768           |
1146         * |    4               |       1048576         |
1147         * |    5               |       33554432        |
1148         * |    6               |       Invalid         |
1149         * |    7               |       Invalid         |
1150         * ----------------------------------------------
1151         */
1152        if (val > 5) {
1153                pr_warn("Invalid LTR scale factor.\n");
1154                return 0;
1155        }
1156
1157        return 1U << (5 * val);
1158}
1159
1160static int pmc_core_ltr_show(struct seq_file *s, void *unused)
1161{
1162        struct pmc_dev *pmcdev = s->private;
1163        const struct pmc_bit_map *map = pmcdev->map->ltr_show_sts;
1164        u64 decoded_snoop_ltr, decoded_non_snoop_ltr;
1165        u32 ltr_raw_data, scale, val;
1166        u16 snoop_ltr, nonsnoop_ltr;
1167        int index;
1168
1169        for (index = 0; map[index].name ; index++) {
1170                decoded_snoop_ltr = decoded_non_snoop_ltr = 0;
1171                ltr_raw_data = pmc_core_reg_read(pmcdev,
1172                                                 map[index].bit_mask);
1173                snoop_ltr = ltr_raw_data & ~MTPMC_MASK;
1174                nonsnoop_ltr = (ltr_raw_data >> 0x10) & ~MTPMC_MASK;
1175
1176                if (FIELD_GET(LTR_REQ_NONSNOOP, ltr_raw_data)) {
1177                        scale = FIELD_GET(LTR_DECODED_SCALE, nonsnoop_ltr);
1178                        val = FIELD_GET(LTR_DECODED_VAL, nonsnoop_ltr);
1179                        decoded_non_snoop_ltr = val * convert_ltr_scale(scale);
1180                }
1181
1182                if (FIELD_GET(LTR_REQ_SNOOP, ltr_raw_data)) {
1183                        scale = FIELD_GET(LTR_DECODED_SCALE, snoop_ltr);
1184                        val = FIELD_GET(LTR_DECODED_VAL, snoop_ltr);
1185                        decoded_snoop_ltr = val * convert_ltr_scale(scale);
1186                }
1187
1188                seq_printf(s, "%-32s\tLTR: RAW: 0x%-16x\tNon-Snoop(ns): %-16llu\tSnoop(ns): %-16llu\n",
1189                           map[index].name, ltr_raw_data,
1190                           decoded_non_snoop_ltr,
1191                           decoded_snoop_ltr);
1192        }
1193        return 0;
1194}
1195DEFINE_SHOW_ATTRIBUTE(pmc_core_ltr);
1196
1197static inline u64 adjust_lpm_residency(struct pmc_dev *pmcdev, u32 offset,
1198                                       const int lpm_adj_x2)
1199{
1200        u64 lpm_res = pmc_core_reg_read(pmcdev, offset);
1201
1202        return GET_X2_COUNTER((u64)lpm_adj_x2 * lpm_res);
1203}
1204
1205static int pmc_core_substate_res_show(struct seq_file *s, void *unused)
1206{
1207        struct pmc_dev *pmcdev = s->private;
1208        const int lpm_adj_x2 = pmcdev->map->lpm_res_counter_step_x2;
1209        u32 offset = pmcdev->map->lpm_residency_offset;
1210        int i, mode;
1211
1212        seq_printf(s, "%-10s %-15s\n", "Substate", "Residency");
1213
1214        pmc_for_each_mode(i, mode, pmcdev) {
1215                seq_printf(s, "%-10s %-15llu\n", pmc_lpm_modes[mode],
1216                           adjust_lpm_residency(pmcdev, offset + (4 * mode), lpm_adj_x2));
1217        }
1218
1219        return 0;
1220}
1221DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_res);
1222
1223static int pmc_core_substate_sts_regs_show(struct seq_file *s, void *unused)
1224{
1225        struct pmc_dev *pmcdev = s->private;
1226        const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1227        u32 offset = pmcdev->map->lpm_status_offset;
1228
1229        pmc_core_lpm_display(pmcdev, NULL, s, offset, "STATUS", maps);
1230
1231        return 0;
1232}
1233DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_sts_regs);
1234
1235static int pmc_core_substate_l_sts_regs_show(struct seq_file *s, void *unused)
1236{
1237        struct pmc_dev *pmcdev = s->private;
1238        const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1239        u32 offset = pmcdev->map->lpm_live_status_offset;
1240
1241        pmc_core_lpm_display(pmcdev, NULL, s, offset, "LIVE_STATUS", maps);
1242
1243        return 0;
1244}
1245DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_l_sts_regs);
1246
1247static void pmc_core_substate_req_header_show(struct seq_file *s)
1248{
1249        struct pmc_dev *pmcdev = s->private;
1250        int i, mode;
1251
1252        seq_printf(s, "%30s |", "Element");
1253        pmc_for_each_mode(i, mode, pmcdev)
1254                seq_printf(s, " %9s |", pmc_lpm_modes[mode]);
1255
1256        seq_printf(s, " %9s |\n", "Status");
1257}
1258
1259static int pmc_core_substate_req_regs_show(struct seq_file *s, void *unused)
1260{
1261        struct pmc_dev *pmcdev = s->private;
1262        const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1263        const struct pmc_bit_map *map;
1264        const int num_maps = pmcdev->map->lpm_num_maps;
1265        u32 sts_offset = pmcdev->map->lpm_status_offset;
1266        u32 *lpm_req_regs = pmcdev->lpm_req_regs;
1267        int mp;
1268
1269        /* Display the header */
1270        pmc_core_substate_req_header_show(s);
1271
1272        /* Loop over maps */
1273        for (mp = 0; mp < num_maps; mp++) {
1274                u32 req_mask = 0;
1275                u32 lpm_status;
1276                int mode, idx, i, len = 32;
1277
1278                /*
1279                 * Capture the requirements and create a mask so that we only
1280                 * show an element if it's required for at least one of the
1281                 * enabled low power modes
1282                 */
1283                pmc_for_each_mode(idx, mode, pmcdev)
1284                        req_mask |= lpm_req_regs[mp + (mode * num_maps)];
1285
1286                /* Get the last latched status for this map */
1287                lpm_status = pmc_core_reg_read(pmcdev, sts_offset + (mp * 4));
1288
1289                /*  Loop over elements in this map */
1290                map = maps[mp];
1291                for (i = 0; map[i].name && i < len; i++) {
1292                        u32 bit_mask = map[i].bit_mask;
1293
1294                        if (!(bit_mask & req_mask))
1295                                /*
1296                                 * Not required for any enabled states
1297                                 * so don't display
1298                                 */
1299                                continue;
1300
1301                        /* Display the element name in the first column */
1302                        seq_printf(s, "%30s |", map[i].name);
1303
1304                        /* Loop over the enabled states and display if required */
1305                        pmc_for_each_mode(idx, mode, pmcdev) {
1306                                if (lpm_req_regs[mp + (mode * num_maps)] & bit_mask)
1307                                        seq_printf(s, " %9s |",
1308                                                   "Required");
1309                                else
1310                                        seq_printf(s, " %9s |", " ");
1311                        }
1312
1313                        /* In Status column, show the last captured state of this agent */
1314                        if (lpm_status & bit_mask)
1315                                seq_printf(s, " %9s |", "Yes");
1316                        else
1317                                seq_printf(s, " %9s |", " ");
1318
1319                        seq_puts(s, "\n");
1320                }
1321        }
1322
1323        return 0;
1324}
1325DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_req_regs);
1326
1327static int pmc_core_lpm_latch_mode_show(struct seq_file *s, void *unused)
1328{
1329        struct pmc_dev *pmcdev = s->private;
1330        bool c10;
1331        u32 reg;
1332        int idx, mode;
1333
1334        reg = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_sts_latch_en_offset);
1335        if (reg & LPM_STS_LATCH_MODE) {
1336                seq_puts(s, "c10");
1337                c10 = false;
1338        } else {
1339                seq_puts(s, "[c10]");
1340                c10 = true;
1341        }
1342
1343        pmc_for_each_mode(idx, mode, pmcdev) {
1344                if ((BIT(mode) & reg) && !c10)
1345                        seq_printf(s, " [%s]", pmc_lpm_modes[mode]);
1346                else
1347                        seq_printf(s, " %s", pmc_lpm_modes[mode]);
1348        }
1349
1350        seq_puts(s, " clear\n");
1351
1352        return 0;
1353}
1354
1355static ssize_t pmc_core_lpm_latch_mode_write(struct file *file,
1356                                             const char __user *userbuf,
1357                                             size_t count, loff_t *ppos)
1358{
1359        struct seq_file *s = file->private_data;
1360        struct pmc_dev *pmcdev = s->private;
1361        bool clear = false, c10 = false;
1362        unsigned char buf[8];
1363        int idx, m, mode;
1364        u32 reg;
1365
1366        if (count > sizeof(buf) - 1)
1367                return -EINVAL;
1368        if (copy_from_user(buf, userbuf, count))
1369                return -EFAULT;
1370        buf[count] = '\0';
1371
1372        /*
1373         * Allowed strings are:
1374         *      Any enabled substate, e.g. 'S0i2.0'
1375         *      'c10'
1376         *      'clear'
1377         */
1378        mode = sysfs_match_string(pmc_lpm_modes, buf);
1379
1380        /* Check string matches enabled mode */
1381        pmc_for_each_mode(idx, m, pmcdev)
1382                if (mode == m)
1383                        break;
1384
1385        if (mode != m || mode < 0) {
1386                if (sysfs_streq(buf, "clear"))
1387                        clear = true;
1388                else if (sysfs_streq(buf, "c10"))
1389                        c10 = true;
1390                else
1391                        return -EINVAL;
1392        }
1393
1394        if (clear) {
1395                mutex_lock(&pmcdev->lock);
1396
1397                reg = pmc_core_reg_read(pmcdev, pmcdev->map->etr3_offset);
1398                reg |= ETR3_CLEAR_LPM_EVENTS;
1399                pmc_core_reg_write(pmcdev, pmcdev->map->etr3_offset, reg);
1400
1401                mutex_unlock(&pmcdev->lock);
1402
1403                return count;
1404        }
1405
1406        if (c10) {
1407                mutex_lock(&pmcdev->lock);
1408
1409                reg = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_sts_latch_en_offset);
1410                reg &= ~LPM_STS_LATCH_MODE;
1411                pmc_core_reg_write(pmcdev, pmcdev->map->lpm_sts_latch_en_offset, reg);
1412
1413                mutex_unlock(&pmcdev->lock);
1414
1415                return count;
1416        }
1417
1418        /*
1419         * For LPM mode latching we set the latch enable bit and selected mode
1420         * and clear everything else.
1421         */
1422        reg = LPM_STS_LATCH_MODE | BIT(mode);
1423        mutex_lock(&pmcdev->lock);
1424        pmc_core_reg_write(pmcdev, pmcdev->map->lpm_sts_latch_en_offset, reg);
1425        mutex_unlock(&pmcdev->lock);
1426
1427        return count;
1428}
1429DEFINE_PMC_CORE_ATTR_WRITE(pmc_core_lpm_latch_mode);
1430
1431static int pmc_core_pkgc_show(struct seq_file *s, void *unused)
1432{
1433        struct pmc_dev *pmcdev = s->private;
1434        const struct pmc_bit_map *map = pmcdev->map->msr_sts;
1435        u64 pcstate_count;
1436        int index;
1437
1438        for (index = 0; map[index].name ; index++) {
1439                if (rdmsrl_safe(map[index].bit_mask, &pcstate_count))
1440                        continue;
1441
1442                pcstate_count *= 1000;
1443                do_div(pcstate_count, tsc_khz);
1444                seq_printf(s, "%-8s : %llu\n", map[index].name,
1445                           pcstate_count);
1446        }
1447
1448        return 0;
1449}
1450DEFINE_SHOW_ATTRIBUTE(pmc_core_pkgc);
1451
1452static void pmc_core_get_low_power_modes(struct pmc_dev *pmcdev)
1453{
1454        u8 lpm_priority[LPM_MAX_NUM_MODES];
1455        u32 lpm_en;
1456        int mode, i, p;
1457
1458        /* Use LPM Maps to indicate support for substates */
1459        if (!pmcdev->map->lpm_num_maps)
1460                return;
1461
1462        lpm_en = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_en_offset);
1463        pmcdev->num_lpm_modes = hweight32(lpm_en);
1464
1465        /* Each byte contains information for 2 modes (7:4 and 3:0) */
1466        for (mode = 0; mode < LPM_MAX_NUM_MODES; mode += 2) {
1467                u8 priority = pmc_core_reg_read_byte(pmcdev,
1468                                pmcdev->map->lpm_priority_offset + (mode / 2));
1469                int pri0 = GENMASK(3, 0) & priority;
1470                int pri1 = (GENMASK(7, 4) & priority) >> 4;
1471
1472                lpm_priority[pri0] = mode;
1473                lpm_priority[pri1] = mode + 1;
1474        }
1475
1476        /*
1477         * Loop though all modes from lowest to highest priority,
1478         * and capture all enabled modes in order
1479         */
1480        i = 0;
1481        for (p = LPM_MAX_NUM_MODES - 1; p >= 0; p--) {
1482                int mode = lpm_priority[p];
1483
1484                if (!(BIT(mode) & lpm_en))
1485                        continue;
1486
1487                pmcdev->lpm_en_modes[i++] = mode;
1488        }
1489}
1490
1491static void pmc_core_dbgfs_unregister(struct pmc_dev *pmcdev)
1492{
1493        debugfs_remove_recursive(pmcdev->dbgfs_dir);
1494}
1495
1496static void pmc_core_dbgfs_register(struct pmc_dev *pmcdev)
1497{
1498        struct dentry *dir;
1499
1500        dir = debugfs_create_dir("pmc_core", NULL);
1501        pmcdev->dbgfs_dir = dir;
1502
1503        debugfs_create_file("slp_s0_residency_usec", 0444, dir, pmcdev,
1504                            &pmc_core_dev_state);
1505
1506        if (pmcdev->map->pfear_sts)
1507                debugfs_create_file("pch_ip_power_gating_status", 0444, dir,
1508                                    pmcdev, &pmc_core_ppfear_fops);
1509
1510        debugfs_create_file("ltr_ignore", 0644, dir, pmcdev,
1511                            &pmc_core_ltr_ignore_ops);
1512
1513        debugfs_create_file("ltr_show", 0444, dir, pmcdev, &pmc_core_ltr_fops);
1514
1515        debugfs_create_file("package_cstate_show", 0444, dir, pmcdev,
1516                            &pmc_core_pkgc_fops);
1517
1518        if (pmcdev->map->pll_sts)
1519                debugfs_create_file("pll_status", 0444, dir, pmcdev,
1520                                    &pmc_core_pll_fops);
1521
1522        if (pmcdev->map->mphy_sts)
1523                debugfs_create_file("mphy_core_lanes_power_gating_status",
1524                                    0444, dir, pmcdev,
1525                                    &pmc_core_mphy_pg_fops);
1526
1527        if (pmcdev->map->slps0_dbg_maps) {
1528                debugfs_create_file("slp_s0_debug_status", 0444,
1529                                    dir, pmcdev,
1530                                    &pmc_core_slps0_dbg_fops);
1531
1532                debugfs_create_bool("slp_s0_dbg_latch", 0644,
1533                                    dir, &slps0_dbg_latch);
1534        }
1535
1536        if (pmcdev->map->lpm_en_offset) {
1537                debugfs_create_file("substate_residencies", 0444,
1538                                    pmcdev->dbgfs_dir, pmcdev,
1539                                    &pmc_core_substate_res_fops);
1540        }
1541
1542        if (pmcdev->map->lpm_status_offset) {
1543                debugfs_create_file("substate_status_registers", 0444,
1544                                    pmcdev->dbgfs_dir, pmcdev,
1545                                    &pmc_core_substate_sts_regs_fops);
1546                debugfs_create_file("substate_live_status_registers", 0444,
1547                                    pmcdev->dbgfs_dir, pmcdev,
1548                                    &pmc_core_substate_l_sts_regs_fops);
1549                debugfs_create_file("lpm_latch_mode", 0644,
1550                                    pmcdev->dbgfs_dir, pmcdev,
1551                                    &pmc_core_lpm_latch_mode_fops);
1552        }
1553
1554        if (pmcdev->lpm_req_regs) {
1555                debugfs_create_file("substate_requirements", 0444,
1556                                    pmcdev->dbgfs_dir, pmcdev,
1557                                    &pmc_core_substate_req_regs_fops);
1558        }
1559}
1560
1561static const struct x86_cpu_id intel_pmc_core_ids[] = {
1562        X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE_L,           &spt_reg_map),
1563        X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE,             &spt_reg_map),
1564        X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE_L,          &spt_reg_map),
1565        X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE,            &spt_reg_map),
1566        X86_MATCH_INTEL_FAM6_MODEL(CANNONLAKE_L,        &cnp_reg_map),
1567        X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_L,           &icl_reg_map),
1568        X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_NNPI,        &icl_reg_map),
1569        X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE,           &cnp_reg_map),
1570        X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE_L,         &cnp_reg_map),
1571        X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE_L,         &tgl_reg_map),
1572        X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE,           &tgl_reg_map),
1573        X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT,        &tgl_reg_map),
1574        X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT_L,      &icl_reg_map),
1575        X86_MATCH_INTEL_FAM6_MODEL(ROCKETLAKE,          &tgl_reg_map),
1576        X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE_L,         &tgl_reg_map),
1577        {}
1578};
1579
1580MODULE_DEVICE_TABLE(x86cpu, intel_pmc_core_ids);
1581
1582static const struct pci_device_id pmc_pci_ids[] = {
1583        { PCI_VDEVICE(INTEL, SPT_PMC_PCI_DEVICE_ID) },
1584        { }
1585};
1586
1587/*
1588 * This quirk can be used on those platforms where
1589 * the platform BIOS enforces 24Mhz crystal to shutdown
1590 * before PMC can assert SLP_S0#.
1591 */
1592static bool xtal_ignore;
1593static int quirk_xtal_ignore(const struct dmi_system_id *id)
1594{
1595        xtal_ignore = true;
1596        return 0;
1597}
1598
1599static void pmc_core_xtal_ignore(struct pmc_dev *pmcdev)
1600{
1601        u32 value;
1602
1603        value = pmc_core_reg_read(pmcdev, pmcdev->map->pm_vric1_offset);
1604        /* 24MHz Crystal Shutdown Qualification Disable */
1605        value |= SPT_PMC_VRIC1_XTALSDQDIS;
1606        /* Low Voltage Mode Enable */
1607        value &= ~SPT_PMC_VRIC1_SLPS0LVEN;
1608        pmc_core_reg_write(pmcdev, pmcdev->map->pm_vric1_offset, value);
1609}
1610
1611static const struct dmi_system_id pmc_core_dmi_table[]  = {
1612        {
1613        .callback = quirk_xtal_ignore,
1614        .ident = "HP Elite x2 1013 G3",
1615        .matches = {
1616                DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1617                DMI_MATCH(DMI_PRODUCT_NAME, "HP Elite x2 1013 G3"),
1618                },
1619        },
1620        {}
1621};
1622
1623static void pmc_core_do_dmi_quirks(struct pmc_dev *pmcdev)
1624{
1625        dmi_check_system(pmc_core_dmi_table);
1626
1627        if (xtal_ignore)
1628                pmc_core_xtal_ignore(pmcdev);
1629}
1630
1631static int pmc_core_probe(struct platform_device *pdev)
1632{
1633        static bool device_initialized;
1634        struct pmc_dev *pmcdev;
1635        const struct x86_cpu_id *cpu_id;
1636        u64 slp_s0_addr;
1637
1638        if (device_initialized)
1639                return -ENODEV;
1640
1641        pmcdev = devm_kzalloc(&pdev->dev, sizeof(*pmcdev), GFP_KERNEL);
1642        if (!pmcdev)
1643                return -ENOMEM;
1644
1645        platform_set_drvdata(pdev, pmcdev);
1646
1647        cpu_id = x86_match_cpu(intel_pmc_core_ids);
1648        if (!cpu_id)
1649                return -ENODEV;
1650
1651        pmcdev->map = (struct pmc_reg_map *)cpu_id->driver_data;
1652
1653        /*
1654         * Coffee Lake has CPU ID of Kaby Lake and Cannon Lake PCH. So here
1655         * Sunrisepoint PCH regmap can't be used. Use Cannon Lake PCH regmap
1656         * in this case.
1657         */
1658        if (pmcdev->map == &spt_reg_map && !pci_dev_present(pmc_pci_ids))
1659                pmcdev->map = &cnp_reg_map;
1660
1661        if (lpit_read_residency_count_address(&slp_s0_addr)) {
1662                pmcdev->base_addr = PMC_BASE_ADDR_DEFAULT;
1663
1664                if (page_is_ram(PHYS_PFN(pmcdev->base_addr)))
1665                        return -ENODEV;
1666        } else {
1667                pmcdev->base_addr = slp_s0_addr - pmcdev->map->slp_s0_offset;
1668        }
1669
1670        pmcdev->regbase = ioremap(pmcdev->base_addr,
1671                                  pmcdev->map->regmap_length);
1672        if (!pmcdev->regbase)
1673                return -ENOMEM;
1674
1675        mutex_init(&pmcdev->lock);
1676
1677        pmcdev->pmc_xram_read_bit = pmc_core_check_read_lock_bit(pmcdev);
1678        pmc_core_get_low_power_modes(pmcdev);
1679        pmc_core_do_dmi_quirks(pmcdev);
1680
1681        if (pmcdev->map == &tgl_reg_map)
1682                pmc_core_get_tgl_lpm_reqs(pdev);
1683
1684        /*
1685         * On TGL, due to a hardware limitation, the GBE LTR blocks PC10 when
1686         * a cable is attached. Tell the PMC to ignore it.
1687         */
1688        if (pmcdev->map == &tgl_reg_map) {
1689                dev_dbg(&pdev->dev, "ignoring GBE LTR\n");
1690                pmc_core_send_ltr_ignore(pmcdev, 3);
1691        }
1692
1693        pmc_core_dbgfs_register(pmcdev);
1694
1695        device_initialized = true;
1696        dev_info(&pdev->dev, " initialized\n");
1697
1698        return 0;
1699}
1700
1701static int pmc_core_remove(struct platform_device *pdev)
1702{
1703        struct pmc_dev *pmcdev = platform_get_drvdata(pdev);
1704
1705        pmc_core_dbgfs_unregister(pmcdev);
1706        platform_set_drvdata(pdev, NULL);
1707        mutex_destroy(&pmcdev->lock);
1708        iounmap(pmcdev->regbase);
1709        return 0;
1710}
1711
1712static bool warn_on_s0ix_failures;
1713module_param(warn_on_s0ix_failures, bool, 0644);
1714MODULE_PARM_DESC(warn_on_s0ix_failures, "Check and warn for S0ix failures");
1715
1716static __maybe_unused int pmc_core_suspend(struct device *dev)
1717{
1718        struct pmc_dev *pmcdev = dev_get_drvdata(dev);
1719
1720        pmcdev->check_counters = false;
1721
1722        /* No warnings on S0ix failures */
1723        if (!warn_on_s0ix_failures)
1724                return 0;
1725
1726        /* Check if the syspend will actually use S0ix */
1727        if (pm_suspend_via_firmware())
1728                return 0;
1729
1730        /* Save PC10 residency for checking later */
1731        if (rdmsrl_safe(MSR_PKG_C10_RESIDENCY, &pmcdev->pc10_counter))
1732                return -EIO;
1733
1734        /* Save S0ix residency for checking later */
1735        if (pmc_core_dev_state_get(pmcdev, &pmcdev->s0ix_counter))
1736                return -EIO;
1737
1738        pmcdev->check_counters = true;
1739        return 0;
1740}
1741
1742static inline bool pmc_core_is_pc10_failed(struct pmc_dev *pmcdev)
1743{
1744        u64 pc10_counter;
1745
1746        if (rdmsrl_safe(MSR_PKG_C10_RESIDENCY, &pc10_counter))
1747                return false;
1748
1749        if (pc10_counter == pmcdev->pc10_counter)
1750                return true;
1751
1752        return false;
1753}
1754
1755static inline bool pmc_core_is_s0ix_failed(struct pmc_dev *pmcdev)
1756{
1757        u64 s0ix_counter;
1758
1759        if (pmc_core_dev_state_get(pmcdev, &s0ix_counter))
1760                return false;
1761
1762        if (s0ix_counter == pmcdev->s0ix_counter)
1763                return true;
1764
1765        return false;
1766}
1767
1768static __maybe_unused int pmc_core_resume(struct device *dev)
1769{
1770        struct pmc_dev *pmcdev = dev_get_drvdata(dev);
1771        const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1772        int offset = pmcdev->map->lpm_status_offset;
1773
1774        if (!pmcdev->check_counters)
1775                return 0;
1776
1777        if (!pmc_core_is_s0ix_failed(pmcdev))
1778                return 0;
1779
1780        if (pmc_core_is_pc10_failed(pmcdev)) {
1781                /* S0ix failed because of PC10 entry failure */
1782                dev_info(dev, "CPU did not enter PC10!!! (PC10 cnt=0x%llx)\n",
1783                         pmcdev->pc10_counter);
1784                return 0;
1785        }
1786
1787        /* The real interesting case - S0ix failed - lets ask PMC why. */
1788        dev_warn(dev, "CPU did not enter SLP_S0!!! (S0ix cnt=%llu)\n",
1789                 pmcdev->s0ix_counter);
1790        if (pmcdev->map->slps0_dbg_maps)
1791                pmc_core_slps0_display(pmcdev, dev, NULL);
1792        if (pmcdev->map->lpm_sts)
1793                pmc_core_lpm_display(pmcdev, dev, NULL, offset, "STATUS", maps);
1794
1795        return 0;
1796}
1797
1798static const struct dev_pm_ops pmc_core_pm_ops = {
1799        SET_LATE_SYSTEM_SLEEP_PM_OPS(pmc_core_suspend, pmc_core_resume)
1800};
1801
1802static const struct acpi_device_id pmc_core_acpi_ids[] = {
1803        {"INT33A1", 0}, /* _HID for Intel Power Engine, _CID PNP0D80*/
1804        { }
1805};
1806MODULE_DEVICE_TABLE(acpi, pmc_core_acpi_ids);
1807
1808static struct platform_driver pmc_core_driver = {
1809        .driver = {
1810                .name = "intel_pmc_core",
1811                .acpi_match_table = ACPI_PTR(pmc_core_acpi_ids),
1812                .pm = &pmc_core_pm_ops,
1813                .dev_groups = pmc_dev_groups,
1814        },
1815        .probe = pmc_core_probe,
1816        .remove = pmc_core_remove,
1817};
1818
1819module_platform_driver(pmc_core_driver);
1820
1821MODULE_LICENSE("GPL v2");
1822MODULE_DESCRIPTION("Intel PMC Core Driver");
1823