drivers/platform/x86/intel_pmc_core.c

   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 <[email protected]>
   9  *          Vishwanath Somayaji <[email protected]>
  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
  27 #include <asm/cpu_device_id.h>
  28 #include <asm/intel-family.h>
  29 #include <asm/msr.h>
  30 #include <asm/tsc.h>
  31
  32 #include "intel_pmc_core.h"
  33
  34 static struct pmc_dev pmc;
  35
  36 /* PKGC MSRs are common across Intel Core SoCs */
  37 static const struct pmc_bit_map msr_map[] = {
  38         {"Package C2",                  MSR_PKG_C2_RESIDENCY},
  39         {"Package C3",                  MSR_PKG_C3_RESIDENCY},
  40         {"Package C6",                  MSR_PKG_C6_RESIDENCY},
  41         {"Package C7",                  MSR_PKG_C7_RESIDENCY},
  42         {"Package C8",                  MSR_PKG_C8_RESIDENCY},
  43         {"Package C9",                  MSR_PKG_C9_RESIDENCY},
  44         {"Package C10",                 MSR_PKG_C10_RESIDENCY},
  45         {}
  46 };
  47
  48 static const struct pmc_bit_map spt_pll_map[] = {
  49         {"MIPI PLL",                    SPT_PMC_BIT_MPHY_CMN_LANE0},
  50         {"GEN2 USB2PCIE2 PLL",          SPT_PMC_BIT_MPHY_CMN_LANE1},
  51         {"DMIPCIE3 PLL",                SPT_PMC_BIT_MPHY_CMN_LANE2},
  52         {"SATA PLL",                    SPT_PMC_BIT_MPHY_CMN_LANE3},
  53         {}
  54 };
  55
  56 static const struct pmc_bit_map spt_mphy_map[] = {
  57         {"MPHY CORE LANE 0",           SPT_PMC_BIT_MPHY_LANE0},
  58         {"MPHY CORE LANE 1",           SPT_PMC_BIT_MPHY_LANE1},
  59         {"MPHY CORE LANE 2",           SPT_PMC_BIT_MPHY_LANE2},
  60         {"MPHY CORE LANE 3",           SPT_PMC_BIT_MPHY_LANE3},
  61         {"MPHY CORE LANE 4",           SPT_PMC_BIT_MPHY_LANE4},
  62         {"MPHY CORE LANE 5",           SPT_PMC_BIT_MPHY_LANE5},
  63         {"MPHY CORE LANE 6",           SPT_PMC_BIT_MPHY_LANE6},
  64         {"MPHY CORE LANE 7",           SPT_PMC_BIT_MPHY_LANE7},
  65         {"MPHY CORE LANE 8",           SPT_PMC_BIT_MPHY_LANE8},
  66         {"MPHY CORE LANE 9",           SPT_PMC_BIT_MPHY_LANE9},
  67         {"MPHY CORE LANE 10",          SPT_PMC_BIT_MPHY_LANE10},
  68         {"MPHY CORE LANE 11",          SPT_PMC_BIT_MPHY_LANE11},
  69         {"MPHY CORE LANE 12",          SPT_PMC_BIT_MPHY_LANE12},
  70         {"MPHY CORE LANE 13",          SPT_PMC_BIT_MPHY_LANE13},
  71         {"MPHY CORE LANE 14",          SPT_PMC_BIT_MPHY_LANE14},
  72         {"MPHY CORE LANE 15",          SPT_PMC_BIT_MPHY_LANE15},
  73         {}
  74 };
  75
  76 static const struct pmc_bit_map spt_pfear_map[] = {
  77         {"PMC",                         SPT_PMC_BIT_PMC},
  78         {"OPI-DMI",                     SPT_PMC_BIT_OPI},
  79         {"SPI / eSPI",                  SPT_PMC_BIT_SPI},
  80         {"XHCI",                        SPT_PMC_BIT_XHCI},
  81         {"SPA",                         SPT_PMC_BIT_SPA},
  82         {"SPB",                         SPT_PMC_BIT_SPB},
  83         {"SPC",                         SPT_PMC_BIT_SPC},
  84         {"GBE",                         SPT_PMC_BIT_GBE},
  85         {"SATA",                        SPT_PMC_BIT_SATA},
  86         {"HDA-PGD0",                    SPT_PMC_BIT_HDA_PGD0},
  87         {"HDA-PGD1",                    SPT_PMC_BIT_HDA_PGD1},
  88         {"HDA-PGD2",                    SPT_PMC_BIT_HDA_PGD2},
  89         {"HDA-PGD3",                    SPT_PMC_BIT_HDA_PGD3},
  90         {"RSVD",                        SPT_PMC_BIT_RSVD_0B},
  91         {"LPSS",                        SPT_PMC_BIT_LPSS},
  92         {"LPC",                         SPT_PMC_BIT_LPC},
  93         {"SMB",                         SPT_PMC_BIT_SMB},
  94         {"ISH",                         SPT_PMC_BIT_ISH},
  95         {"P2SB",                        SPT_PMC_BIT_P2SB},
  96         {"DFX",                         SPT_PMC_BIT_DFX},
  97         {"SCC",                         SPT_PMC_BIT_SCC},
  98         {"RSVD",                        SPT_PMC_BIT_RSVD_0C},
  99         {"FUSE",                        SPT_PMC_BIT_FUSE},
 100         {"CAMERA",                      SPT_PMC_BIT_CAMREA},
 101         {"RSVD",                        SPT_PMC_BIT_RSVD_0D},
 102         {"USB3-OTG",                    SPT_PMC_BIT_USB3_OTG},
 103         {"EXI",                         SPT_PMC_BIT_EXI},
 104         {"CSE",                         SPT_PMC_BIT_CSE},
 105         {"CSME_KVM",                    SPT_PMC_BIT_CSME_KVM},
 106         {"CSME_PMT",                    SPT_PMC_BIT_CSME_PMT},
 107         {"CSME_CLINK",                  SPT_PMC_BIT_CSME_CLINK},
 108         {"CSME_PTIO",                   SPT_PMC_BIT_CSME_PTIO},
 109         {"CSME_USBR",                   SPT_PMC_BIT_CSME_USBR},
 110         {"CSME_SUSRAM",                 SPT_PMC_BIT_CSME_SUSRAM},
 111         {"CSME_SMT",                    SPT_PMC_BIT_CSME_SMT},
 112         {"RSVD",                        SPT_PMC_BIT_RSVD_1A},
 113         {"CSME_SMS2",                   SPT_PMC_BIT_CSME_SMS2},
 114         {"CSME_SMS1",                   SPT_PMC_BIT_CSME_SMS1},
 115         {"CSME_RTC",                    SPT_PMC_BIT_CSME_RTC},
 116         {"CSME_PSF",                    SPT_PMC_BIT_CSME_PSF},
 117         {}
 118 };
 119
 120 static const struct pmc_bit_map *ext_spt_pfear_map[] = {
 121         spt_pfear_map,
 122         NULL
 123 };
 124
 125 static const struct pmc_bit_map spt_ltr_show_map[] = {
 126         {"SOUTHPORT_A",         SPT_PMC_LTR_SPA},
 127         {"SOUTHPORT_B",         SPT_PMC_LTR_SPB},
 128         {"SATA",                SPT_PMC_LTR_SATA},
 129         {"GIGABIT_ETHERNET",    SPT_PMC_LTR_GBE},
 130         {"XHCI",                SPT_PMC_LTR_XHCI},
 131         {"Reserved",            SPT_PMC_LTR_RESERVED},
 132         {"ME",                  SPT_PMC_LTR_ME},
 133         /* EVA is Enterprise Value Add, doesn't really exist on PCH */
 134         {"EVA",                 SPT_PMC_LTR_EVA},
 135         {"SOUTHPORT_C",         SPT_PMC_LTR_SPC},
 136         {"HD_AUDIO",            SPT_PMC_LTR_AZ},
 137         {"LPSS",                SPT_PMC_LTR_LPSS},
 138         {"SOUTHPORT_D",         SPT_PMC_LTR_SPD},
 139         {"SOUTHPORT_E",         SPT_PMC_LTR_SPE},
 140         {"CAMERA",              SPT_PMC_LTR_CAM},
 141         {"ESPI",                SPT_PMC_LTR_ESPI},
 142         {"SCC",                 SPT_PMC_LTR_SCC},
 143         {"ISH",                 SPT_PMC_LTR_ISH},
 144         /* Below two cannot be used for LTR_IGNORE */
 145         {"CURRENT_PLATFORM",    SPT_PMC_LTR_CUR_PLT},
 146         {"AGGREGATED_SYSTEM",   SPT_PMC_LTR_CUR_ASLT},
 147         {}
 148 };
 149
 150 static const struct pmc_reg_map spt_reg_map = {
 151         .pfear_sts = ext_spt_pfear_map,
 152         .mphy_sts = spt_mphy_map,
 153         .pll_sts = spt_pll_map,
 154         .ltr_show_sts = spt_ltr_show_map,
 155         .msr_sts = msr_map,
 156         .slp_s0_offset = SPT_PMC_SLP_S0_RES_COUNTER_OFFSET,
 157         .ltr_ignore_offset = SPT_PMC_LTR_IGNORE_OFFSET,
 158         .regmap_length = SPT_PMC_MMIO_REG_LEN,
 159         .ppfear0_offset = SPT_PMC_XRAM_PPFEAR0A,
 160         .ppfear_buckets = SPT_PPFEAR_NUM_ENTRIES,
 161         .pm_cfg_offset = SPT_PMC_PM_CFG_OFFSET,
 162         .pm_read_disable_bit = SPT_PMC_READ_DISABLE_BIT,
 163         .ltr_ignore_max = SPT_NUM_IP_IGN_ALLOWED,
 164         .pm_vric1_offset = SPT_PMC_VRIC1_OFFSET,
 165 };
 166
 167 /* Cannon Lake: PGD PFET Enable Ack Status Register(s) bitmap */
 168 static const struct pmc_bit_map cnp_pfear_map[] = {
 169         /* Reserved for Cannon Lake but valid for Comet Lake */
 170         {"PMC",                 BIT(0)},
 171         {"OPI-DMI",             BIT(1)},
 172         {"SPI/eSPI",            BIT(2)},
 173         {"XHCI",                BIT(3)},
 174         {"SPA",                 BIT(4)},
 175         {"SPB",                 BIT(5)},
 176         {"SPC",                 BIT(6)},
 177         {"GBE",                 BIT(7)},
 178
 179         {"SATA",                BIT(0)},
 180         {"HDA_PGD0",            BIT(1)},
 181         {"HDA_PGD1",            BIT(2)},
 182         {"HDA_PGD2",            BIT(3)},
 183         {"HDA_PGD3",            BIT(4)},
 184         {"SPD",                 BIT(5)},
 185         {"LPSS",                BIT(6)},
 186         {"LPC",                 BIT(7)},
 187
 188         {"SMB",                 BIT(0)},
 189         {"ISH",                 BIT(1)},
 190         {"P2SB",                BIT(2)},
 191         {"NPK_VNN",             BIT(3)},
 192         {"SDX",                 BIT(4)},
 193         {"SPE",                 BIT(5)},
 194         {"Fuse",                BIT(6)},
 195         /*
 196          * Reserved for Cannon Lake but valid for Ice Lake, Comet Lake,
 197          * Tiger Lake, Elkhart Lake and Jasper Lake.
 198          */
 199         {"SBR8",                BIT(7)},
 200
 201         {"CSME_FSC",            BIT(0)},
 202         {"USB3_OTG",            BIT(1)},
 203         {"EXI",                 BIT(2)},
 204         {"CSE",                 BIT(3)},
 205         {"CSME_KVM",            BIT(4)},
 206         {"CSME_PMT",            BIT(5)},
 207         {"CSME_CLINK",          BIT(6)},
 208         {"CSME_PTIO",           BIT(7)},
 209
 210         {"CSME_USBR",           BIT(0)},
 211         {"CSME_SUSRAM",         BIT(1)},
 212         {"CSME_SMT1",           BIT(2)},
 213         {"CSME_SMT4",           BIT(3)},
 214         {"CSME_SMS2",           BIT(4)},
 215         {"CSME_SMS1",           BIT(5)},
 216         {"CSME_RTC",            BIT(6)},
 217         {"CSME_PSF",            BIT(7)},
 218
 219         {"SBR0",                BIT(0)},
 220         {"SBR1",                BIT(1)},
 221         {"SBR2",                BIT(2)},
 222         {"SBR3",                BIT(3)},
 223         {"SBR4",                BIT(4)},
 224         {"SBR5",                BIT(5)},
 225         {"CSME_PECI",           BIT(6)},
 226         {"PSF1",                BIT(7)},
 227
 228         {"PSF2",                BIT(0)},
 229         {"PSF3",                BIT(1)},
 230         {"PSF4",                BIT(2)},
 231         {"CNVI",                BIT(3)},
 232         {"UFS0",                BIT(4)},
 233         {"EMMC",                BIT(5)},
 234         {"SPF",                 BIT(6)},
 235         {"SBR6",                BIT(7)},
 236
 237         {"SBR7",                BIT(0)},
 238         {"NPK_AON",             BIT(1)},
 239         {"HDA_PGD4",            BIT(2)},
 240         {"HDA_PGD5",            BIT(3)},
 241         {"HDA_PGD6",            BIT(4)},
 242         /*
 243          * Reserved for Cannon Lake but valid for Ice Lake, Comet Lake,
 244          * Tiger Lake, ELkhart Lake and Jasper Lake.
 245          */
 246         {"PSF6",                BIT(5)},
 247         {"PSF7",                BIT(6)},
 248         {"PSF8",                BIT(7)},
 249         {}
 250 };
 251
 252 static const struct pmc_bit_map *ext_cnp_pfear_map[] = {
 253         cnp_pfear_map,
 254         NULL
 255 };
 256
 257 static const struct pmc_bit_map icl_pfear_map[] = {
 258         /* Ice Lake generation onwards only */
 259         {"RES_65",              BIT(0)},
 260         {"RES_66",              BIT(1)},
 261         {"RES_67",              BIT(2)},
 262         {"TAM",                 BIT(3)},
 263         {"GBETSN",              BIT(4)},
 264         {"TBTLSX",              BIT(5)},
 265         {"RES_71",              BIT(6)},
 266         {"RES_72",              BIT(7)},
 267         {}
 268 };
 269
 270 static const struct pmc_bit_map *ext_icl_pfear_map[] = {
 271         cnp_pfear_map,
 272         icl_pfear_map,
 273         NULL
 274 };
 275
 276 static const struct pmc_bit_map tgl_pfear_map[] = {
 277         /* Tiger Lake, Elkhart Lake and Jasper Lake generation onwards only */
 278         {"PSF9",                BIT(0)},
 279         {"RES_66",              BIT(1)},
 280         {"RES_67",              BIT(2)},
 281         {"RES_68",              BIT(3)},
 282         {"RES_69",              BIT(4)},
 283         {"RES_70",              BIT(5)},
 284         {"TBTLSX",              BIT(6)},
 285         {}
 286 };
 287
 288 static const struct pmc_bit_map *ext_tgl_pfear_map[] = {
 289         cnp_pfear_map,
 290         tgl_pfear_map,
 291         NULL
 292 };
 293
 294 static const struct pmc_bit_map cnp_slps0_dbg0_map[] = {
 295         {"AUDIO_D3",            BIT(0)},
 296         {"OTG_D3",              BIT(1)},
 297         {"XHCI_D3",             BIT(2)},
 298         {"LPIO_D3",             BIT(3)},
 299         {"SDX_D3",              BIT(4)},
 300         {"SATA_D3",             BIT(5)},
 301         {"UFS0_D3",             BIT(6)},
 302         {"UFS1_D3",             BIT(7)},
 303         {"EMMC_D3",             BIT(8)},
 304         {}
 305 };
 306
 307 static const struct pmc_bit_map cnp_slps0_dbg1_map[] = {
 308         {"SDIO_PLL_OFF",        BIT(0)},
 309         {"USB2_PLL_OFF",        BIT(1)},
 310         {"AUDIO_PLL_OFF",       BIT(2)},
 311         {"OC_PLL_OFF",          BIT(3)},
 312         {"MAIN_PLL_OFF",        BIT(4)},
 313         {"XOSC_OFF",            BIT(5)},
 314         {"LPC_CLKS_GATED",      BIT(6)},
 315         {"PCIE_CLKREQS_IDLE",   BIT(7)},
 316         {"AUDIO_ROSC_OFF",      BIT(8)},
 317         {"HPET_XOSC_CLK_REQ",   BIT(9)},
 318         {"PMC_ROSC_SLOW_CLK",   BIT(10)},
 319         {"AON2_ROSC_GATED",     BIT(11)},
 320         {"CLKACKS_DEASSERTED",  BIT(12)},
 321         {}
 322 };
 323
 324 static const struct pmc_bit_map cnp_slps0_dbg2_map[] = {
 325         {"MPHY_CORE_GATED",     BIT(0)},
 326         {"CSME_GATED",          BIT(1)},
 327         {"USB2_SUS_GATED",      BIT(2)},
 328         {"DYN_FLEX_IO_IDLE",    BIT(3)},
 329         {"GBE_NO_LINK",         BIT(4)},
 330         {"THERM_SEN_DISABLED",  BIT(5)},
 331         {"PCIE_LOW_POWER",      BIT(6)},
 332         {"ISH_VNNAON_REQ_ACT",  BIT(7)},
 333         {"ISH_VNN_REQ_ACT",     BIT(8)},
 334         {"CNV_VNNAON_REQ_ACT",  BIT(9)},
 335         {"CNV_VNN_REQ_ACT",     BIT(10)},
 336         {"NPK_VNNON_REQ_ACT",   BIT(11)},
 337         {"PMSYNC_STATE_IDLE",   BIT(12)},
 338         {"ALST_GT_THRES",       BIT(13)},
 339         {"PMC_ARC_PG_READY",    BIT(14)},
 340         {}
 341 };
 342
 343 static const struct pmc_bit_map *cnp_slps0_dbg_maps[] = {
 344         cnp_slps0_dbg0_map,
 345         cnp_slps0_dbg1_map,
 346         cnp_slps0_dbg2_map,
 347         NULL
 348 };
 349
 350 static const struct pmc_bit_map cnp_ltr_show_map[] = {
 351         {"SOUTHPORT_A",         CNP_PMC_LTR_SPA},
 352         {"SOUTHPORT_B",         CNP_PMC_LTR_SPB},
 353         {"SATA",                CNP_PMC_LTR_SATA},
 354         {"GIGABIT_ETHERNET",    CNP_PMC_LTR_GBE},
 355         {"XHCI",                CNP_PMC_LTR_XHCI},
 356         {"Reserved",            CNP_PMC_LTR_RESERVED},
 357         {"ME",                  CNP_PMC_LTR_ME},
 358         /* EVA is Enterprise Value Add, doesn't really exist on PCH */
 359         {"EVA",                 CNP_PMC_LTR_EVA},
 360         {"SOUTHPORT_C",         CNP_PMC_LTR_SPC},
 361         {"HD_AUDIO",            CNP_PMC_LTR_AZ},
 362         {"CNV",                 CNP_PMC_LTR_CNV},
 363         {"LPSS",                CNP_PMC_LTR_LPSS},
 364         {"SOUTHPORT_D",         CNP_PMC_LTR_SPD},
 365         {"SOUTHPORT_E",         CNP_PMC_LTR_SPE},
 366         {"CAMERA",              CNP_PMC_LTR_CAM},
 367         {"ESPI",                CNP_PMC_LTR_ESPI},
 368         {"SCC",                 CNP_PMC_LTR_SCC},
 369         {"ISH",                 CNP_PMC_LTR_ISH},
 370         {"UFSX2",               CNP_PMC_LTR_UFSX2},
 371         {"EMMC",                CNP_PMC_LTR_EMMC},
 372         /* Reserved for Cannon Lake but valid for Ice Lake */
 373         {"WIGIG",               ICL_PMC_LTR_WIGIG},
 374         /* Below two cannot be used for LTR_IGNORE */
 375         {"CURRENT_PLATFORM",    CNP_PMC_LTR_CUR_PLT},
 376         {"AGGREGATED_SYSTEM",   CNP_PMC_LTR_CUR_ASLT},
 377         {}
 378 };
 379
 380 static const struct pmc_reg_map cnp_reg_map = {
 381         .pfear_sts = ext_cnp_pfear_map,
 382         .slp_s0_offset = CNP_PMC_SLP_S0_RES_COUNTER_OFFSET,
 383         .slps0_dbg_maps = cnp_slps0_dbg_maps,
 384         .ltr_show_sts = cnp_ltr_show_map,
 385         .msr_sts = msr_map,
 386         .slps0_dbg_offset = CNP_PMC_SLPS0_DBG_OFFSET,
 387         .ltr_ignore_offset = CNP_PMC_LTR_IGNORE_OFFSET,
 388         .regmap_length = CNP_PMC_MMIO_REG_LEN,
 389         .ppfear0_offset = CNP_PMC_HOST_PPFEAR0A,
 390         .ppfear_buckets = CNP_PPFEAR_NUM_ENTRIES,
 391         .pm_cfg_offset = CNP_PMC_PM_CFG_OFFSET,
 392         .pm_read_disable_bit = CNP_PMC_READ_DISABLE_BIT,
 393         .ltr_ignore_max = CNP_NUM_IP_IGN_ALLOWED,
 394 };
 395
 396 static const struct pmc_reg_map icl_reg_map = {
 397         .pfear_sts = ext_icl_pfear_map,
 398         .slp_s0_offset = CNP_PMC_SLP_S0_RES_COUNTER_OFFSET,
 399         .slps0_dbg_maps = cnp_slps0_dbg_maps,
 400         .ltr_show_sts = cnp_ltr_show_map,
 401         .msr_sts = msr_map,
 402         .slps0_dbg_offset = CNP_PMC_SLPS0_DBG_OFFSET,
 403         .ltr_ignore_offset = CNP_PMC_LTR_IGNORE_OFFSET,
 404         .regmap_length = CNP_PMC_MMIO_REG_LEN,
 405         .ppfear0_offset = CNP_PMC_HOST_PPFEAR0A,
 406         .ppfear_buckets = ICL_PPFEAR_NUM_ENTRIES,
 407         .pm_cfg_offset = CNP_PMC_PM_CFG_OFFSET,
 408         .pm_read_disable_bit = CNP_PMC_READ_DISABLE_BIT,
 409         .ltr_ignore_max = ICL_NUM_IP_IGN_ALLOWED,
 410 };
 411
 412 static const struct pmc_bit_map tgl_lpm0_map[] = {
 413         {"USB2PLL_OFF_STS",                     BIT(18)},
 414         {"PCIe/USB3.1_Gen2PLL_OFF_STS",         BIT(19)},
 415         {"PCIe_Gen3PLL_OFF_STS",                BIT(20)},
 416         {"OPIOPLL_OFF_STS",                     BIT(21)},
 417         {"OCPLL_OFF_STS",                       BIT(22)},
 418         {"AudioPLL_OFF_STS",                    BIT(23)},
 419         {"MIPIPLL_OFF_STS",                     BIT(24)},
 420         {"Fast_XTAL_Osc_OFF_STS",               BIT(25)},
 421         {"AC_Ring_Osc_OFF_STS",                 BIT(26)},
 422         {"MC_Ring_Osc_OFF_STS",                 BIT(27)},
 423         {"SATAPLL_OFF_STS",                     BIT(29)},
 424         {"XTAL_USB2PLL_OFF_STS",                BIT(31)},
 425         {}
 426 };
 427
 428 static const struct pmc_bit_map tgl_lpm1_map[] = {
 429         {"SPI_PG_STS",                          BIT(2)},
 430         {"xHCI_PG_STS",                         BIT(3)},
 431         {"PCIe_Ctrller_A_PG_STS",               BIT(4)},
 432         {"PCIe_Ctrller_B_PG_STS",               BIT(5)},
 433         {"PCIe_Ctrller_C_PG_STS",               BIT(6)},
 434         {"GBE_PG_STS",                          BIT(7)},
 435         {"SATA_PG_STS",                         BIT(8)},
 436         {"HDA0_PG_STS",                         BIT(9)},
 437         {"HDA1_PG_STS",                         BIT(10)},
 438         {"HDA2_PG_STS",                         BIT(11)},
 439         {"HDA3_PG_STS",                         BIT(12)},
 440         {"PCIe_Ctrller_D_PG_STS",               BIT(13)},
 441         {"ISIO_PG_STS",                         BIT(14)},
 442         {"SMB_PG_STS",                          BIT(16)},
 443         {"ISH_PG_STS",                          BIT(17)},
 444         {"ITH_PG_STS",                          BIT(19)},
 445         {"SDX_PG_STS",                          BIT(20)},
 446         {"xDCI_PG_STS",                         BIT(25)},
 447         {"DCI_PG_STS",                          BIT(26)},
 448         {"CSME0_PG_STS",                        BIT(27)},
 449         {"CSME_KVM_PG_STS",                     BIT(28)},
 450         {"CSME1_PG_STS",                        BIT(29)},
 451         {"CSME_CLINK_PG_STS",                   BIT(30)},
 452         {"CSME2_PG_STS",                        BIT(31)},
 453         {}
 454 };
 455
 456 static const struct pmc_bit_map tgl_lpm2_map[] = {
 457         {"ADSP_D3_STS",                         BIT(0)},
 458         {"SATA_D3_STS",                         BIT(1)},
 459         {"xHCI0_D3_STS",                        BIT(2)},
 460         {"xDCI1_D3_STS",                        BIT(5)},
 461         {"SDX_D3_STS",                          BIT(6)},
 462         {"EMMC_D3_STS",                         BIT(7)},
 463         {"IS_D3_STS",                           BIT(8)},
 464         {"THC0_D3_STS",                         BIT(9)},
 465         {"THC1_D3_STS",                         BIT(10)},
 466         {"GBE_D3_STS",                          BIT(11)},
 467         {"GBE_TSN_D3_STS",                      BIT(12)},
 468         {}
 469 };
 470
 471 static const struct pmc_bit_map tgl_lpm3_map[] = {
 472         {"GPIO_COM0_VNN_REQ_STS",               BIT(1)},
 473         {"GPIO_COM1_VNN_REQ_STS",               BIT(2)},
 474         {"GPIO_COM2_VNN_REQ_STS",               BIT(3)},
 475         {"GPIO_COM3_VNN_REQ_STS",               BIT(4)},
 476         {"GPIO_COM4_VNN_REQ_STS",               BIT(5)},
 477         {"GPIO_COM5_VNN_REQ_STS",               BIT(6)},
 478         {"Audio_VNN_REQ_STS",                   BIT(7)},
 479         {"ISH_VNN_REQ_STS",                     BIT(8)},
 480         {"CNVI_VNN_REQ_STS",                    BIT(9)},
 481         {"eSPI_VNN_REQ_STS",                    BIT(10)},
 482         {"Display_VNN_REQ_STS",                 BIT(11)},
 483         {"DTS_VNN_REQ_STS",                     BIT(12)},
 484         {"SMBUS_VNN_REQ_STS",                   BIT(14)},
 485         {"CSME_VNN_REQ_STS",                    BIT(15)},
 486         {"SMLINK0_VNN_REQ_STS",                 BIT(16)},
 487         {"SMLINK1_VNN_REQ_STS",                 BIT(17)},
 488         {"CLINK_VNN_REQ_STS",                   BIT(20)},
 489         {"DCI_VNN_REQ_STS",                     BIT(21)},
 490         {"ITH_VNN_REQ_STS",                     BIT(22)},
 491         {"CSME_VNN_REQ_STS",                    BIT(24)},
 492         {"GBE_VNN_REQ_STS",                     BIT(25)},
 493         {}
 494 };
 495
 496 static const struct pmc_bit_map tgl_lpm4_map[] = {
 497         {"CPU_C10_REQ_STS_0",                   BIT(0)},
 498         {"PCIe_LPM_En_REQ_STS_3",               BIT(3)},
 499         {"ITH_REQ_STS_5",                       BIT(5)},
 500         {"CNVI_REQ_STS_6",                      BIT(6)},
 501         {"ISH_REQ_STS_7",                       BIT(7)},
 502         {"USB2_SUS_PG_Sys_REQ_STS_10",          BIT(10)},
 503         {"PCIe_Clk_REQ_STS_12",                 BIT(12)},
 504         {"MPHY_Core_DL_REQ_STS_16",             BIT(16)},
 505         {"Break-even_En_REQ_STS_17",            BIT(17)},
 506         {"Auto-demo_En_REQ_STS_18",             BIT(18)},
 507         {"MPHY_SUS_REQ_STS_22",                 BIT(22)},
 508         {"xDCI_attached_REQ_STS_24",            BIT(24)},
 509         {}
 510 };
 511
 512 static const struct pmc_bit_map tgl_lpm5_map[] = {
 513         {"LSX_Wake0_En_STS",                    BIT(0)},
 514         {"LSX_Wake0_Pol_STS",                   BIT(1)},
 515         {"LSX_Wake1_En_STS",                    BIT(2)},
 516         {"LSX_Wake1_Pol_STS",                   BIT(3)},
 517         {"LSX_Wake2_En_STS",                    BIT(4)},
 518         {"LSX_Wake2_Pol_STS",                   BIT(5)},
 519         {"LSX_Wake3_En_STS",                    BIT(6)},
 520         {"LSX_Wake3_Pol_STS",                   BIT(7)},
 521         {"LSX_Wake4_En_STS",                    BIT(8)},
 522         {"LSX_Wake4_Pol_STS",                   BIT(9)},
 523         {"LSX_Wake5_En_STS",                    BIT(10)},
 524         {"LSX_Wake5_Pol_STS",                   BIT(11)},
 525         {"LSX_Wake6_En_STS",                    BIT(12)},
 526         {"LSX_Wake6_Pol_STS",                   BIT(13)},
 527         {"LSX_Wake7_En_STS",                    BIT(14)},
 528         {"LSX_Wake7_Pol_STS",                   BIT(15)},
 529         {"Intel_Se_IO_Wake0_En_STS",            BIT(16)},
 530         {"Intel_Se_IO_Wake0_Pol_STS",           BIT(17)},
 531         {"Intel_Se_IO_Wake1_En_STS",            BIT(18)},
 532         {"Intel_Se_IO_Wake1_Pol_STS",           BIT(19)},
 533         {"Int_Timer_SS_Wake0_En_STS",           BIT(20)},
 534         {"Int_Timer_SS_Wake0_Pol_STS",          BIT(21)},
 535         {"Int_Timer_SS_Wake1_En_STS",           BIT(22)},
 536         {"Int_Timer_SS_Wake1_Pol_STS",          BIT(23)},
 537         {"Int_Timer_SS_Wake2_En_STS",           BIT(24)},
 538         {"Int_Timer_SS_Wake2_Pol_STS",          BIT(25)},
 539         {"Int_Timer_SS_Wake3_En_STS",           BIT(26)},
 540         {"Int_Timer_SS_Wake3_Pol_STS",          BIT(27)},
 541         {"Int_Timer_SS_Wake4_En_STS",           BIT(28)},
 542         {"Int_Timer_SS_Wake4_Pol_STS",          BIT(29)},
 543         {"Int_Timer_SS_Wake5_En_STS",           BIT(30)},
 544         {"Int_Timer_SS_Wake5_Pol_STS",          BIT(31)},
 545         {}
 546 };
 547
 548 static const struct pmc_bit_map *tgl_lpm_maps[] = {
 549         tgl_lpm0_map,
 550         tgl_lpm1_map,
 551         tgl_lpm2_map,
 552         tgl_lpm3_map,
 553         tgl_lpm4_map,
 554         tgl_lpm5_map,
 555         NULL
 556 };
 557
 558 static const struct pmc_reg_map tgl_reg_map = {
 559         .pfear_sts = ext_tgl_pfear_map,
 560         .slp_s0_offset = CNP_PMC_SLP_S0_RES_COUNTER_OFFSET,
 561         .ltr_show_sts = cnp_ltr_show_map,
 562         .msr_sts = msr_map,
 563         .ltr_ignore_offset = CNP_PMC_LTR_IGNORE_OFFSET,
 564         .regmap_length = CNP_PMC_MMIO_REG_LEN,
 565         .ppfear0_offset = CNP_PMC_HOST_PPFEAR0A,
 566         .ppfear_buckets = ICL_PPFEAR_NUM_ENTRIES,
 567         .pm_cfg_offset = CNP_PMC_PM_CFG_OFFSET,
 568         .pm_read_disable_bit = CNP_PMC_READ_DISABLE_BIT,
 569         .ltr_ignore_max = TGL_NUM_IP_IGN_ALLOWED,
 570         .lpm_modes = tgl_lpm_modes,
 571         .lpm_en_offset = TGL_LPM_EN_OFFSET,
 572         .lpm_residency_offset = TGL_LPM_RESIDENCY_OFFSET,
 573         .lpm_sts = tgl_lpm_maps,
 574         .lpm_status_offset = TGL_LPM_STATUS_OFFSET,
 575         .lpm_live_status_offset = TGL_LPM_LIVE_STATUS_OFFSET,
 576 };
 577
 578 static inline u32 pmc_core_reg_read(struct pmc_dev *pmcdev, int reg_offset)
 579 {
 580         return readl(pmcdev->regbase + reg_offset);
 581 }
 582
 583 static inline void pmc_core_reg_write(struct pmc_dev *pmcdev, int reg_offset,
 584                                       u32 val)
 585 {
 586         writel(val, pmcdev->regbase + reg_offset);
 587 }
 588
 589 static inline u64 pmc_core_adjust_slp_s0_step(u32 value)
 590 {
 591         return (u64)value * SPT_PMC_SLP_S0_RES_COUNTER_STEP;
 592 }
 593
 594 static int pmc_core_dev_state_get(void *data, u64 *val)
 595 {
 596         struct pmc_dev *pmcdev = data;
 597         const struct pmc_reg_map *map = pmcdev->map;
 598         u32 value;
 599
 600         value = pmc_core_reg_read(pmcdev, map->slp_s0_offset);
 601         *val = pmc_core_adjust_slp_s0_step(value);
 602
 603         return 0;
 604 }
 605
 606 DEFINE_DEBUGFS_ATTRIBUTE(pmc_core_dev_state, pmc_core_dev_state_get, NULL, "%llu\n");
 607
 608 static int pmc_core_check_read_lock_bit(void)
 609 {
 610         struct pmc_dev *pmcdev = &pmc;
 611         u32 value;
 612
 613         value = pmc_core_reg_read(pmcdev, pmcdev->map->pm_cfg_offset);
 614         return value & BIT(pmcdev->map->pm_read_disable_bit);
 615 }
 616
 617 static void pmc_core_slps0_display(struct pmc_dev *pmcdev, struct device *dev,
 618                                    struct seq_file *s)
 619 {
 620         const struct pmc_bit_map **maps = pmcdev->map->slps0_dbg_maps;
 621         const struct pmc_bit_map *map;
 622         int offset = pmcdev->map->slps0_dbg_offset;
 623         u32 data;
 624
 625         while (*maps) {
 626                 map = *maps;
 627                 data = pmc_core_reg_read(pmcdev, offset);
 628                 offset += 4;
 629                 while (map->name) {
 630                         if (dev)
 631                                 dev_dbg(dev, "SLP_S0_DBG: %-32s\tState: %s\n",
 632                                         map->name,
 633                                         data & map->bit_mask ? "Yes" : "No");
 634                         if (s)
 635                                 seq_printf(s, "SLP_S0_DBG: %-32s\tState: %s\n",
 636                                            map->name,
 637                                            data & map->bit_mask ? "Yes" : "No");
 638                         ++map;
 639                 }
 640                 ++maps;
 641         }
 642 }
 643
 644 static int pmc_core_lpm_get_arr_size(const struct pmc_bit_map **maps)
 645 {
 646         int idx;
 647
 648         for (idx = 0; maps[idx]; idx++)
 649                 ;/* Nothing */
 650
 651         return idx;
 652 }
 653
 654 static void pmc_core_lpm_display(struct pmc_dev *pmcdev, struct device *dev,
 655                                  struct seq_file *s, u32 offset,
 656                                  const char *str,
 657                                  const struct pmc_bit_map **maps)
 658 {
 659         int index, idx, len = 32, bit_mask, arr_size;
 660         u32 *lpm_regs;
 661
 662         arr_size = pmc_core_lpm_get_arr_size(maps);
 663         lpm_regs = kmalloc_array(arr_size, sizeof(*lpm_regs), GFP_KERNEL);
 664         if (!lpm_regs)
 665                 return;
 666
 667         for (index = 0; index < arr_size; index++) {
 668                 lpm_regs[index] = pmc_core_reg_read(pmcdev, offset);
 669                 offset += 4;
 670         }
 671
 672         for (idx = 0; idx < arr_size; idx++) {
 673                 if (dev)
 674                         dev_dbg(dev, "\nLPM_%s_%d:\t0x%x\n", str, idx,
 675                                 lpm_regs[idx]);
 676                 if (s)
 677                         seq_printf(s, "\nLPM_%s_%d:\t0x%x\n", str, idx,
 678                                    lpm_regs[idx]);
 679                 for (index = 0; maps[idx][index].name && index < len; index++) {
 680                         bit_mask = maps[idx][index].bit_mask;
 681                         if (dev)
 682                                 dev_dbg(dev, "%-30s %-30d\n",
 683                                         maps[idx][index].name,
 684                                         lpm_regs[idx] & bit_mask ? 1 : 0);
 685                         if (s)
 686                                 seq_printf(s, "%-30s %-30d\n",
 687                                            maps[idx][index].name,
 688                                            lpm_regs[idx] & bit_mask ? 1 : 0);
 689                 }
 690         }
 691
 692         kfree(lpm_regs);
 693 }
 694
 695 #if IS_ENABLED(CONFIG_DEBUG_FS)
 696 static bool slps0_dbg_latch;
 697
 698 static inline u8 pmc_core_reg_read_byte(struct pmc_dev *pmcdev, int offset)
 699 {
 700         return readb(pmcdev->regbase + offset);
 701 }
 702
 703 static void pmc_core_display_map(struct seq_file *s, int index, int idx, int ip,
 704                                  u8 pf_reg, const struct pmc_bit_map **pf_map)
 705 {
 706         seq_printf(s, "PCH IP: %-2d - %-32s\tState: %s\n",
 707                    ip, pf_map[idx][index].name,
 708                    pf_map[idx][index].bit_mask & pf_reg ? "Off" : "On");
 709 }
 710
 711 static int pmc_core_ppfear_show(struct seq_file *s, void *unused)
 712 {
 713         struct pmc_dev *pmcdev = s->private;
 714         const struct pmc_bit_map **maps = pmcdev->map->pfear_sts;
 715         u8 pf_regs[PPFEAR_MAX_NUM_ENTRIES];
 716         int index, iter, idx, ip = 0;
 717
 718         iter = pmcdev->map->ppfear0_offset;
 719
 720         for (index = 0; index < pmcdev->map->ppfear_buckets &&
 721              index < PPFEAR_MAX_NUM_ENTRIES; index++, iter++)
 722                 pf_regs[index] = pmc_core_reg_read_byte(pmcdev, iter);
 723
 724         for (idx = 0; maps[idx]; idx++) {
 725                 for (index = 0; maps[idx][index].name &&
 726                      index < pmcdev->map->ppfear_buckets * 8; ip++, index++)
 727                         pmc_core_display_map(s, index, idx, ip,
 728                                              pf_regs[index / 8], maps);
 729         }
 730
 731         return 0;
 732 }
 733 DEFINE_SHOW_ATTRIBUTE(pmc_core_ppfear);
 734
 735 /* This function should return link status, 0 means ready */
 736 static int pmc_core_mtpmc_link_status(void)
 737 {
 738         struct pmc_dev *pmcdev = &pmc;
 739         u32 value;
 740
 741         value = pmc_core_reg_read(pmcdev, SPT_PMC_PM_STS_OFFSET);
 742         return value & BIT(SPT_PMC_MSG_FULL_STS_BIT);
 743 }
 744
 745 static int pmc_core_send_msg(u32 *addr_xram)
 746 {
 747         struct pmc_dev *pmcdev = &pmc;
 748         u32 dest;
 749         int timeout;
 750
 751         for (timeout = NUM_RETRIES; timeout > 0; timeout--) {
 752                 if (pmc_core_mtpmc_link_status() == 0)
 753                         break;
 754                 msleep(5);
 755         }
 756
 757         if (timeout <= 0 && pmc_core_mtpmc_link_status())
 758                 return -EBUSY;
 759
 760         dest = (*addr_xram & MTPMC_MASK) | (1U << 1);
 761         pmc_core_reg_write(pmcdev, SPT_PMC_MTPMC_OFFSET, dest);
 762         return 0;
 763 }
 764
 765 static int pmc_core_mphy_pg_show(struct seq_file *s, void *unused)
 766 {
 767         struct pmc_dev *pmcdev = s->private;
 768         const struct pmc_bit_map *map = pmcdev->map->mphy_sts;
 769         u32 mphy_core_reg_low, mphy_core_reg_high;
 770         u32 val_low, val_high;
 771         int index, err = 0;
 772
 773         if (pmcdev->pmc_xram_read_bit) {
 774                 seq_puts(s, "Access denied: please disable PMC_READ_DISABLE setting in BIOS.");
 775                 return 0;
 776         }
 777
 778         mphy_core_reg_low  = (SPT_PMC_MPHY_CORE_STS_0 << 16);
 779         mphy_core_reg_high = (SPT_PMC_MPHY_CORE_STS_1 << 16);
 780
 781         mutex_lock(&pmcdev->lock);
 782
 783         if (pmc_core_send_msg(&mphy_core_reg_low) != 0) {
 784                 err = -EBUSY;
 785                 goto out_unlock;
 786         }
 787
 788         msleep(10);
 789         val_low = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
 790
 791         if (pmc_core_send_msg(&mphy_core_reg_high) != 0) {
 792                 err = -EBUSY;
 793                 goto out_unlock;
 794         }
 795
 796         msleep(10);
 797         val_high = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
 798
 799         for (index = 0; map[index].name && index < 8; index++) {
 800                 seq_printf(s, "%-32s\tState: %s\n",
 801                            map[index].name,
 802                            map[index].bit_mask & val_low ? "Not power gated" :
 803                            "Power gated");
 804         }
 805
 806         for (index = 8; map[index].name; index++) {
 807                 seq_printf(s, "%-32s\tState: %s\n",
 808                            map[index].name,
 809                            map[index].bit_mask & val_high ? "Not power gated" :
 810                            "Power gated");
 811         }
 812
 813 out_unlock:
 814         mutex_unlock(&pmcdev->lock);
 815         return err;
 816 }
 817 DEFINE_SHOW_ATTRIBUTE(pmc_core_mphy_pg);
 818
 819 static int pmc_core_pll_show(struct seq_file *s, void *unused)
 820 {
 821         struct pmc_dev *pmcdev = s->private;
 822         const struct pmc_bit_map *map = pmcdev->map->pll_sts;
 823         u32 mphy_common_reg, val;
 824         int index, err = 0;
 825
 826         if (pmcdev->pmc_xram_read_bit) {
 827                 seq_puts(s, "Access denied: please disable PMC_READ_DISABLE setting in BIOS.");
 828                 return 0;
 829         }
 830
 831         mphy_common_reg  = (SPT_PMC_MPHY_COM_STS_0 << 16);
 832         mutex_lock(&pmcdev->lock);
 833
 834         if (pmc_core_send_msg(&mphy_common_reg) != 0) {
 835                 err = -EBUSY;
 836                 goto out_unlock;
 837         }
 838
 839         /* Observed PMC HW response latency for MTPMC-MFPMC is ~10 ms */
 840         msleep(10);
 841         val = pmc_core_reg_read(pmcdev, SPT_PMC_MFPMC_OFFSET);
 842
 843         for (index = 0; map[index].name ; index++) {
 844                 seq_printf(s, "%-32s\tState: %s\n",
 845                            map[index].name,
 846                            map[index].bit_mask & val ? "Active" : "Idle");
 847         }
 848
 849 out_unlock:
 850         mutex_unlock(&pmcdev->lock);
 851         return err;
 852 }
 853 DEFINE_SHOW_ATTRIBUTE(pmc_core_pll);
 854
 855 static ssize_t pmc_core_ltr_ignore_write(struct file *file,
 856                                          const char __user *userbuf,
 857                                          size_t count, loff_t *ppos)
 858 {
 859         struct pmc_dev *pmcdev = &pmc;
 860         const struct pmc_reg_map *map = pmcdev->map;
 861         u32 val, buf_size, fd;
 862         int err;
 863
 864         buf_size = count < 64 ? count : 64;
 865
 866         err = kstrtou32_from_user(userbuf, buf_size, 10, &val);
 867         if (err)
 868                 return err;
 869
 870         mutex_lock(&pmcdev->lock);
 871
 872         if (val > map->ltr_ignore_max) {
 873                 err = -EINVAL;
 874                 goto out_unlock;
 875         }
 876
 877         fd = pmc_core_reg_read(pmcdev, map->ltr_ignore_offset);
 878         fd |= (1U << val);
 879         pmc_core_reg_write(pmcdev, map->ltr_ignore_offset, fd);
 880
 881 out_unlock:
 882         mutex_unlock(&pmcdev->lock);
 883         return err == 0 ? count : err;
 884 }
 885
 886 static int pmc_core_ltr_ignore_show(struct seq_file *s, void *unused)
 887 {
 888         return 0;
 889 }
 890
 891 static int pmc_core_ltr_ignore_open(struct inode *inode, struct file *file)
 892 {
 893         return single_open(file, pmc_core_ltr_ignore_show, inode->i_private);
 894 }
 895
 896 static const struct file_operations pmc_core_ltr_ignore_ops = {
 897         .open           = pmc_core_ltr_ignore_open,
 898         .read           = seq_read,
 899         .write          = pmc_core_ltr_ignore_write,
 900         .llseek         = seq_lseek,
 901         .release        = single_release,
 902 };
 903
 904 static void pmc_core_slps0_dbg_latch(struct pmc_dev *pmcdev, bool reset)
 905 {
 906         const struct pmc_reg_map *map = pmcdev->map;
 907         u32 fd;
 908
 909         mutex_lock(&pmcdev->lock);
 910
 911         if (!reset && !slps0_dbg_latch)
 912                 goto out_unlock;
 913
 914         fd = pmc_core_reg_read(pmcdev, map->slps0_dbg_offset);
 915         if (reset)
 916                 fd &= ~CNP_PMC_LATCH_SLPS0_EVENTS;
 917         else
 918                 fd |= CNP_PMC_LATCH_SLPS0_EVENTS;
 919         pmc_core_reg_write(pmcdev, map->slps0_dbg_offset, fd);
 920
 921         slps0_dbg_latch = 0;
 922
 923 out_unlock:
 924         mutex_unlock(&pmcdev->lock);
 925 }
 926
 927 static int pmc_core_slps0_dbg_show(struct seq_file *s, void *unused)
 928 {
 929         struct pmc_dev *pmcdev = s->private;
 930
 931         pmc_core_slps0_dbg_latch(pmcdev, false);
 932         pmc_core_slps0_display(pmcdev, NULL, s);
 933         pmc_core_slps0_dbg_latch(pmcdev, true);
 934
 935         return 0;
 936 }
 937 DEFINE_SHOW_ATTRIBUTE(pmc_core_slps0_dbg);
 938
 939 static u32 convert_ltr_scale(u32 val)
 940 {
 941         /*
 942          * As per PCIE specification supporting document
 943          * ECN_LatencyTolnReporting_14Aug08.pdf the Latency
 944          * Tolerance Reporting data payload is encoded in a
 945          * 3 bit scale and 10 bit value fields. Values are
 946          * multiplied by the indicated scale to yield an absolute time
 947          * value, expressible in a range from 1 nanosecond to
 948          * 2^25*(2^10-1) = 34,326,183,936 nanoseconds.
 949          *
 950          * scale encoding is as follows:
 951          *
 952          * ----------------------------------------------
 953          * |scale factor        |       Multiplier (ns) |
 954          * ----------------------------------------------
 955          * |    0               |       1               |
 956          * |    1               |       32              |
 957          * |    2               |       1024            |
 958          * |    3               |       32768           |
 959          * |    4               |       1048576         |
 960          * |    5               |       33554432        |
 961          * |    6               |       Invalid         |
 962          * |    7               |       Invalid         |
 963          * ----------------------------------------------
 964          */
 965         if (val > 5) {
 966                 pr_warn("Invalid LTR scale factor.\n");
 967                 return 0;
 968         }
 969
 970         return 1U << (5 * val);
 971 }
 972
 973 static int pmc_core_ltr_show(struct seq_file *s, void *unused)
 974 {
 975         struct pmc_dev *pmcdev = s->private;
 976         const struct pmc_bit_map *map = pmcdev->map->ltr_show_sts;
 977         u64 decoded_snoop_ltr, decoded_non_snoop_ltr;
 978         u32 ltr_raw_data, scale, val;
 979         u16 snoop_ltr, nonsnoop_ltr;
 980         int index;
 981
 982         for (index = 0; map[index].name ; index++) {
 983                 decoded_snoop_ltr = decoded_non_snoop_ltr = 0;
 984                 ltr_raw_data = pmc_core_reg_read(pmcdev,
 985                                                  map[index].bit_mask);
 986                 snoop_ltr = ltr_raw_data & ~MTPMC_MASK;
 987                 nonsnoop_ltr = (ltr_raw_data >> 0x10) & ~MTPMC_MASK;
 988
 989                 if (FIELD_GET(LTR_REQ_NONSNOOP, ltr_raw_data)) {
 990                         scale = FIELD_GET(LTR_DECODED_SCALE, nonsnoop_ltr);
 991                         val = FIELD_GET(LTR_DECODED_VAL, nonsnoop_ltr);
 992                         decoded_non_snoop_ltr = val * convert_ltr_scale(scale);
 993                 }
 994
 995                 if (FIELD_GET(LTR_REQ_SNOOP, ltr_raw_data)) {
 996                         scale = FIELD_GET(LTR_DECODED_SCALE, snoop_ltr);
 997                         val = FIELD_GET(LTR_DECODED_VAL, snoop_ltr);
 998                         decoded_snoop_ltr = val * convert_ltr_scale(scale);
 999                 }
1000
1001                 seq_printf(s, "%-32s\tLTR: RAW: 0x%-16x\tNon-Snoop(ns): %-16llu\tSnoop(ns): %-16llu\n",
1002                            map[index].name, ltr_raw_data,
1003                            decoded_non_snoop_ltr,
1004                            decoded_snoop_ltr);
1005         }
1006         return 0;
1007 }
1008 DEFINE_SHOW_ATTRIBUTE(pmc_core_ltr);
1009
1010 static int pmc_core_substate_res_show(struct seq_file *s, void *unused)
1011 {
1012         struct pmc_dev *pmcdev = s->private;
1013         const char **lpm_modes = pmcdev->map->lpm_modes;
1014         u32 offset = pmcdev->map->lpm_residency_offset;
1015         u32 lpm_en;
1016         int index;
1017
1018         lpm_en = pmc_core_reg_read(pmcdev, pmcdev->map->lpm_en_offset);
1019         seq_printf(s, "status substate residency\n");
1020         for (index = 0; lpm_modes[index]; index++) {
1021                 seq_printf(s, "%7s %7s %-15u\n",
1022                            BIT(index) & lpm_en ? "Enabled" : " ",
1023                            lpm_modes[index], pmc_core_reg_read(pmcdev, offset));
1024                 offset += 4;
1025         }
1026
1027         return 0;
1028 }
1029 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_res);
1030
1031 static int pmc_core_substate_sts_regs_show(struct seq_file *s, void *unused)
1032 {
1033         struct pmc_dev *pmcdev = s->private;
1034         const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1035         u32 offset = pmcdev->map->lpm_status_offset;
1036
1037         pmc_core_lpm_display(pmcdev, NULL, s, offset, "STATUS", maps);
1038
1039         return 0;
1040 }
1041 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_sts_regs);
1042
1043 static int pmc_core_substate_l_sts_regs_show(struct seq_file *s, void *unused)
1044 {
1045         struct pmc_dev *pmcdev = s->private;
1046         const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1047         u32 offset = pmcdev->map->lpm_live_status_offset;
1048
1049         pmc_core_lpm_display(pmcdev, NULL, s, offset, "LIVE_STATUS", maps);
1050
1051         return 0;
1052 }
1053 DEFINE_SHOW_ATTRIBUTE(pmc_core_substate_l_sts_regs);
1054
1055 static int pmc_core_pkgc_show(struct seq_file *s, void *unused)
1056 {
1057         struct pmc_dev *pmcdev = s->private;
1058         const struct pmc_bit_map *map = pmcdev->map->msr_sts;
1059         u64 pcstate_count;
1060         int index;
1061
1062         for (index = 0; map[index].name ; index++) {
1063                 if (rdmsrl_safe(map[index].bit_mask, &pcstate_count))
1064                         continue;
1065
1066                 pcstate_count *= 1000;
1067                 do_div(pcstate_count, tsc_khz);
1068                 seq_printf(s, "%-8s : %llu\n", map[index].name,
1069                            pcstate_count);
1070         }
1071
1072         return 0;
1073 }
1074 DEFINE_SHOW_ATTRIBUTE(pmc_core_pkgc);
1075
1076 static void pmc_core_dbgfs_unregister(struct pmc_dev *pmcdev)
1077 {
1078         debugfs_remove_recursive(pmcdev->dbgfs_dir);
1079 }
1080
1081 static void pmc_core_dbgfs_register(struct pmc_dev *pmcdev)
1082 {
1083         struct dentry *dir;
1084
1085         dir = debugfs_create_dir("pmc_core", NULL);
1086         pmcdev->dbgfs_dir = dir;
1087
1088         debugfs_create_file("slp_s0_residency_usec", 0444, dir, pmcdev,
1089                             &pmc_core_dev_state);
1090
1091         if (pmcdev->map->pfear_sts)
1092                 debugfs_create_file("pch_ip_power_gating_status", 0444, dir,
1093                                     pmcdev, &pmc_core_ppfear_fops);
1094
1095         debugfs_create_file("ltr_ignore", 0644, dir, pmcdev,
1096                             &pmc_core_ltr_ignore_ops);
1097
1098         debugfs_create_file("ltr_show", 0444, dir, pmcdev, &pmc_core_ltr_fops);
1099
1100         debugfs_create_file("package_cstate_show", 0444, dir, pmcdev,
1101                             &pmc_core_pkgc_fops);
1102
1103         if (pmcdev->map->pll_sts)
1104                 debugfs_create_file("pll_status", 0444, dir, pmcdev,
1105                                     &pmc_core_pll_fops);
1106
1107         if (pmcdev->map->mphy_sts)
1108                 debugfs_create_file("mphy_core_lanes_power_gating_status",
1109                                     0444, dir, pmcdev,
1110                                     &pmc_core_mphy_pg_fops);
1111
1112         if (pmcdev->map->slps0_dbg_maps) {
1113                 debugfs_create_file("slp_s0_debug_status", 0444,
1114                                     dir, pmcdev,
1115                                     &pmc_core_slps0_dbg_fops);
1116
1117                 debugfs_create_bool("slp_s0_dbg_latch", 0644,
1118                                     dir, &slps0_dbg_latch);
1119         }
1120
1121         if (pmcdev->map->lpm_en_offset) {
1122                 debugfs_create_file("substate_residencies", 0444,
1123                                     pmcdev->dbgfs_dir, pmcdev,
1124                                     &pmc_core_substate_res_fops);
1125         }
1126
1127         if (pmcdev->map->lpm_status_offset) {
1128                 debugfs_create_file("substate_status_registers", 0444,
1129                                     pmcdev->dbgfs_dir, pmcdev,
1130                                     &pmc_core_substate_sts_regs_fops);
1131                 debugfs_create_file("substate_live_status_registers", 0444,
1132                                     pmcdev->dbgfs_dir, pmcdev,
1133                                     &pmc_core_substate_l_sts_regs_fops);
1134         }
1135 }
1136 #else
1137 static inline void pmc_core_dbgfs_register(struct pmc_dev *pmcdev)
1138 {
1139 }
1140
1141 static inline void pmc_core_dbgfs_unregister(struct pmc_dev *pmcdev)
1142 {
1143 }
1144 #endif /* CONFIG_DEBUG_FS */
1145
1146 static const struct x86_cpu_id intel_pmc_core_ids[] = {
1147         X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE_L,           &spt_reg_map),
1148         X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE,             &spt_reg_map),
1149         X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE_L,          &spt_reg_map),
1150         X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE,            &spt_reg_map),
1151         X86_MATCH_INTEL_FAM6_MODEL(CANNONLAKE_L,        &cnp_reg_map),
1152         X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_L,           &icl_reg_map),
1153         X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_NNPI,        &icl_reg_map),
1154         X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE,           &cnp_reg_map),
1155         X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE_L,         &cnp_reg_map),
1156         X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE_L,         &tgl_reg_map),
1157         X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE,           &tgl_reg_map),
1158         X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT,        &tgl_reg_map),
1159         X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT_L,      &tgl_reg_map),
1160         {}
1161 };
1162
1163 MODULE_DEVICE_TABLE(x86cpu, intel_pmc_core_ids);
1164
1165 static const struct pci_device_id pmc_pci_ids[] = {
1166         { PCI_VDEVICE(INTEL, SPT_PMC_PCI_DEVICE_ID) },
1167         { }
1168 };
1169
1170 /*
1171  * This quirk can be used on those platforms where
1172  * the platform BIOS enforces 24Mhz crystal to shutdown
1173  * before PMC can assert SLP_S0#.
1174  */
1175 static int quirk_xtal_ignore(const struct dmi_system_id *id)
1176 {
1177         struct pmc_dev *pmcdev = &pmc;
1178         u32 value;
1179
1180         value = pmc_core_reg_read(pmcdev, pmcdev->map->pm_vric1_offset);
1181         /* 24MHz Crystal Shutdown Qualification Disable */
1182         value |= SPT_PMC_VRIC1_XTALSDQDIS;
1183         /* Low Voltage Mode Enable */
1184         value &= ~SPT_PMC_VRIC1_SLPS0LVEN;
1185         pmc_core_reg_write(pmcdev, pmcdev->map->pm_vric1_offset, value);
1186         return 0;
1187 }
1188
1189 static const struct dmi_system_id pmc_core_dmi_table[]  = {
1190         {
1191         .callback = quirk_xtal_ignore,
1192         .ident = "HP Elite x2 1013 G3",
1193         .matches = {
1194                 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1195                 DMI_MATCH(DMI_PRODUCT_NAME, "HP Elite x2 1013 G3"),
1196                 },
1197         },
1198         {}
1199 };
1200
1201 static int pmc_core_probe(struct platform_device *pdev)
1202 {
1203         static bool device_initialized;
1204         struct pmc_dev *pmcdev = &pmc;
1205         const struct x86_cpu_id *cpu_id;
1206         u64 slp_s0_addr;
1207
1208         if (device_initialized)
1209                 return -ENODEV;
1210
1211         cpu_id = x86_match_cpu(intel_pmc_core_ids);
1212         if (!cpu_id)
1213                 return -ENODEV;
1214
1215         pmcdev->map = (struct pmc_reg_map *)cpu_id->driver_data;
1216
1217         /*
1218          * Coffee Lake has CPU ID of Kaby Lake and Cannon Lake PCH. So here
1219          * Sunrisepoint PCH regmap can't be used. Use Cannon Lake PCH regmap
1220          * in this case.
1221          */
1222         if (pmcdev->map == &spt_reg_map && !pci_dev_present(pmc_pci_ids))
1223                 pmcdev->map = &cnp_reg_map;
1224
1225         if (lpit_read_residency_count_address(&slp_s0_addr)) {
1226                 pmcdev->base_addr = PMC_BASE_ADDR_DEFAULT;
1227
1228                 if (page_is_ram(PHYS_PFN(pmcdev->base_addr)))
1229                         return -ENODEV;
1230         } else {
1231                 pmcdev->base_addr = slp_s0_addr - pmcdev->map->slp_s0_offset;
1232         }
1233
1234         pmcdev->regbase = ioremap(pmcdev->base_addr,
1235                                   pmcdev->map->regmap_length);
1236         if (!pmcdev->regbase)
1237                 return -ENOMEM;
1238
1239         mutex_init(&pmcdev->lock);
1240         platform_set_drvdata(pdev, pmcdev);
1241         pmcdev->pmc_xram_read_bit = pmc_core_check_read_lock_bit();
1242         dmi_check_system(pmc_core_dmi_table);
1243
1244         pmc_core_dbgfs_register(pmcdev);
1245
1246         device_initialized = true;
1247         dev_info(&pdev->dev, " initialized\n");
1248
1249         return 0;
1250 }
1251
1252 static int pmc_core_remove(struct platform_device *pdev)
1253 {
1254         struct pmc_dev *pmcdev = platform_get_drvdata(pdev);
1255
1256         pmc_core_dbgfs_unregister(pmcdev);
1257         platform_set_drvdata(pdev, NULL);
1258         mutex_destroy(&pmcdev->lock);
1259         iounmap(pmcdev->regbase);
1260         return 0;
1261 }
1262
1263 #ifdef CONFIG_PM_SLEEP
1264
1265 static bool warn_on_s0ix_failures;
1266 module_param(warn_on_s0ix_failures, bool, 0644);
1267 MODULE_PARM_DESC(warn_on_s0ix_failures, "Check and warn for S0ix failures");
1268
1269 static int pmc_core_suspend(struct device *dev)
1270 {
1271         struct pmc_dev *pmcdev = dev_get_drvdata(dev);
1272
1273         pmcdev->check_counters = false;
1274
1275         /* No warnings on S0ix failures */
1276         if (!warn_on_s0ix_failures)
1277                 return 0;
1278
1279         /* Check if the syspend will actually use S0ix */
1280         if (pm_suspend_via_firmware())
1281                 return 0;
1282
1283         /* Save PC10 residency for checking later */
1284         if (rdmsrl_safe(MSR_PKG_C10_RESIDENCY, &pmcdev->pc10_counter))
1285                 return -EIO;
1286
1287         /* Save S0ix residency for checking later */
1288         if (pmc_core_dev_state_get(pmcdev, &pmcdev->s0ix_counter))
1289                 return -EIO;
1290
1291         pmcdev->check_counters = true;
1292         return 0;
1293 }
1294
1295 static inline bool pmc_core_is_pc10_failed(struct pmc_dev *pmcdev)
1296 {
1297         u64 pc10_counter;
1298
1299         if (rdmsrl_safe(MSR_PKG_C10_RESIDENCY, &pc10_counter))
1300                 return false;
1301
1302         if (pc10_counter == pmcdev->pc10_counter)
1303                 return true;
1304
1305         return false;
1306 }
1307
1308 static inline bool pmc_core_is_s0ix_failed(struct pmc_dev *pmcdev)
1309 {
1310         u64 s0ix_counter;
1311
1312         if (pmc_core_dev_state_get(pmcdev, &s0ix_counter))
1313                 return false;
1314
1315         if (s0ix_counter == pmcdev->s0ix_counter)
1316                 return true;
1317
1318         return false;
1319 }
1320
1321 static int pmc_core_resume(struct device *dev)
1322 {
1323         struct pmc_dev *pmcdev = dev_get_drvdata(dev);
1324         const struct pmc_bit_map **maps = pmcdev->map->lpm_sts;
1325         int offset = pmcdev->map->lpm_status_offset;
1326
1327         if (!pmcdev->check_counters)
1328                 return 0;
1329
1330         if (!pmc_core_is_s0ix_failed(pmcdev))
1331                 return 0;
1332
1333         if (pmc_core_is_pc10_failed(pmcdev)) {
1334                 /* S0ix failed because of PC10 entry failure */
1335                 dev_info(dev, "CPU did not enter PC10!!! (PC10 cnt=0x%llx)\n",
1336                          pmcdev->pc10_counter);
1337                 return 0;
1338         }
1339
1340         /* The real interesting case - S0ix failed - lets ask PMC why. */
1341         dev_warn(dev, "CPU did not enter SLP_S0!!! (S0ix cnt=%llu)\n",
1342                  pmcdev->s0ix_counter);
1343         if (pmcdev->map->slps0_dbg_maps)
1344                 pmc_core_slps0_display(pmcdev, dev, NULL);
1345         if (pmcdev->map->lpm_sts)
1346                 pmc_core_lpm_display(pmcdev, dev, NULL, offset, "STATUS", maps);
1347
1348         return 0;
1349 }
1350
1351 #endif
1352
1353 static const struct dev_pm_ops pmc_core_pm_ops = {
1354         SET_LATE_SYSTEM_SLEEP_PM_OPS(pmc_core_suspend, pmc_core_resume)
1355 };
1356
1357 static const struct acpi_device_id pmc_core_acpi_ids[] = {
1358         {"INT33A1", 0}, /* _HID for Intel Power Engine, _CID PNP0D80*/
1359         { }
1360 };
1361 MODULE_DEVICE_TABLE(acpi, pmc_core_acpi_ids);
1362
1363 static struct platform_driver pmc_core_driver = {
1364         .driver = {
1365                 .name = "intel_pmc_core",
1366                 .acpi_match_table = ACPI_PTR(pmc_core_acpi_ids),
1367                 .pm = &pmc_core_pm_ops,
1368         },
1369         .probe = pmc_core_probe,
1370         .remove = pmc_core_remove,
1371 };
1372
1373 module_platform_driver(pmc_core_driver);
1374
1375 MODULE_LICENSE("GPL v2");
1376 MODULE_DESCRIPTION("Intel PMC Core Driver");