drivers/platform/x86/intel/tpmi.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * intel-tpmi : Driver to enumerate TPMI features and create devices
   4  *
   5  * Copyright (c) 2023, Intel Corporation.
   6  * All Rights Reserved.
   7  *
   8  * The TPMI (Topology Aware Register and PM Capsule Interface) provides a
   9  * flexible, extendable and PCIe enumerable MMIO interface for PM features.
  10  *
  11  * For example Intel RAPL (Running Average Power Limit) provides a MMIO
  12  * interface using TPMI. This has advantage over traditional MSR
  13  * (Model Specific Register) interface, where a thread needs to be scheduled
  14  * on the target CPU to read or write. Also the RAPL features vary between
  15  * CPU models, and hence lot of model specific code. Here TPMI provides an
  16  * architectural interface by providing hierarchical tables and fields,
  17  * which will not need any model specific implementation.
  18  *
  19  * The TPMI interface uses a PCI VSEC structure to expose the location of
  20  * MMIO region.
  21  *
  22  * This VSEC structure is present in the PCI configuration space of the
  23  * Intel Out-of-Band (OOB) device, which  is handled by the Intel VSEC
  24  * driver. The Intel VSEC driver parses VSEC structures present in the PCI
  25  * configuration space of the given device and creates an auxiliary device
  26  * object for each of them. In particular, it creates an auxiliary device
  27  * object representing TPMI that can be bound by an auxiliary driver.
  28  *
  29  * This TPMI driver will bind to the TPMI auxiliary device object created
  30  * by the Intel VSEC driver.
  31  *
  32  * The TPMI specification defines a PFS (PM Feature Structure) table.
  33  * This table is present in the TPMI MMIO region. The starting address
  34  * of PFS is derived from the tBIR (Bar Indicator Register) and "Address"
  35  * field from the VSEC header.
  36  *
  37  * Each TPMI PM feature has one entry in the PFS with a unique TPMI
  38  * ID and its access details. The TPMI driver creates device nodes
  39  * for the supported PM features.
  40  *
  41  * The names of the devices created by the TPMI driver start with the
  42  * "intel_vsec.tpmi-" prefix which is followed by a specific name of the
  43  * given PM feature (for example, "intel_vsec.tpmi-rapl.0").
  44  *
  45  * The device nodes are create by using interface "intel_vsec_add_aux()"
  46  * provided by the Intel VSEC driver.
  47  */
  48
  49 #include <linux/auxiliary_bus.h>
  50 #include <linux/bitfield.h>
  51 #include <linux/debugfs.h>
  52 #include <linux/delay.h>
  53 #include <linux/intel_tpmi.h>
  54 #include <linux/io.h>
  55 #include <linux/iopoll.h>
  56 #include <linux/module.h>
  57 #include <linux/pci.h>
  58 #include <linux/security.h>
  59 #include <linux/sizes.h>
  60 #include <linux/string_helpers.h>
  61
  62 #include "vsec.h"
  63
  64 /**
  65  * struct intel_tpmi_pfs_entry - TPMI PM Feature Structure (PFS) entry
  66  * @tpmi_id:    TPMI feature identifier (what the feature is and its data format).
  67  * @num_entries: Number of feature interface instances present in the PFS.
  68  *               This represents the maximum number of Power domains in the SoC.
  69  * @entry_size: Interface instance entry size in 32-bit words.
  70  * @cap_offset: Offset from the PM_Features base address to the base of the PM VSEC
  71  *              register bank in KB.
  72  * @attribute:  Feature attribute: 0=BIOS. 1=OS. 2-3=Reserved.
  73  * @reserved:   Bits for use in the future.
  74  *
  75  * Represents one TPMI feature entry data in the PFS retrieved as is
  76  * from the hardware.
  77  */
  78 struct intel_tpmi_pfs_entry {
  79         u64 tpmi_id:8;
  80         u64 num_entries:8;
  81         u64 entry_size:16;
  82         u64 cap_offset:16;
  83         u64 attribute:2;
  84         u64 reserved:14;
  85 } __packed;
  86
  87 /**
  88  * struct intel_tpmi_pm_feature - TPMI PM Feature information for a TPMI ID
  89  * @pfs_header: PFS header retireved from the hardware.
  90  * @vsec_offset: Starting MMIO address for this feature in bytes. Essentially
  91  *               this offset = "Address" from VSEC header + PFS Capability
  92  *               offset for this feature entry.
  93  * @vsec_dev:   Pointer to intel_vsec_device structure for this TPMI device
  94  *
  95  * Represents TPMI instance information for one TPMI ID.
  96  */
  97 struct intel_tpmi_pm_feature {
  98         struct intel_tpmi_pfs_entry pfs_header;
  99         u64 vsec_offset;
 100         struct intel_vsec_device *vsec_dev;
 101 };
 102
 103 /**
 104  * struct intel_tpmi_info - TPMI information for all IDs in an instance
 105  * @tpmi_features:      Pointer to a list of TPMI feature instances
 106  * @vsec_dev:           Pointer to intel_vsec_device structure for this TPMI device
 107  * @feature_count:      Number of TPMI of TPMI instances pointed by tpmi_features
 108  * @pfs_start:          Start of PFS offset for the TPMI instances in this device
 109  * @plat_info:          Stores platform info which can be used by the client drivers
 110  * @tpmi_control_mem:   Memory mapped IO for getting control information
 111  * @dbgfs_dir:          debugfs entry pointer
 112  *
 113  * Stores the information for all TPMI devices enumerated from a single PCI device.
 114  */
 115 struct intel_tpmi_info {
 116         struct intel_tpmi_pm_feature *tpmi_features;
 117         struct intel_vsec_device *vsec_dev;
 118         int feature_count;
 119         u64 pfs_start;
 120         struct intel_tpmi_plat_info plat_info;
 121         void __iomem *tpmi_control_mem;
 122         struct dentry *dbgfs_dir;
 123 };
 124
 125 /**
 126  * struct tpmi_info_header - CPU package ID to PCI device mapping information
 127  * @fn:         PCI function number
 128  * @dev:        PCI device number
 129  * @bus:        PCI bus number
 130  * @pkg:        CPU Package id
 131  * @segment:    PCI segment id
 132  * @partition:  Package Partition id
 133  * @cdie_mask:  Bitmap of compute dies in the current partition
 134  * @reserved:   Reserved for future use
 135  * @lock:       When set to 1 the register is locked and becomes read-only
 136  *              until next reset. Not for use by the OS driver.
 137  *
 138  * The structure to read hardware provided mapping information.
 139  */
 140 struct tpmi_info_header {
 141         u64 fn:3;
 142         u64 dev:5;
 143         u64 bus:8;
 144         u64 pkg:8;
 145         u64 segment:8;
 146         u64 partition:2;
 147         u64 cdie_mask:16;
 148         u64 reserved:13;
 149         u64 lock:1;
 150 } __packed;
 151
 152 /**
 153  * struct tpmi_feature_state - Structure to read hardware state of a feature
 154  * @enabled:    Enable state of a feature, 1: enabled, 0: disabled
 155  * @reserved_1: Reserved for future use
 156  * @write_blocked: Writes are blocked means all write operations are ignored
 157  * @read_blocked: Reads are blocked means will read 0xFFs
 158  * @pcs_select: Interface used by out of band software, not used in OS
 159  * @reserved_2: Reserved for future use
 160  * @id:         TPMI ID of the feature
 161  * @reserved_3: Reserved for future use
 162  * @locked:     When set to 1, OS can't change this register.
 163  *
 164  * The structure is used to read hardware state of a TPMI feature. This
 165  * information is used for debug and restricting operations for this feature.
 166  */
 167 struct tpmi_feature_state {
 168         u32 enabled:1;
 169         u32 reserved_1:3;
 170         u32 write_blocked:1;
 171         u32 read_blocked:1;
 172         u32 pcs_select:1;
 173         u32 reserved_2:1;
 174         u32 id:8;
 175         u32 reserved_3:15;
 176         u32 locked:1;
 177 } __packed;
 178
 179 /*
 180  * The size from hardware is in u32 units. This size is from a trusted hardware,
 181  * but better to verify for pre silicon platforms. Set size to 0, when invalid.
 182  */
 183 #define TPMI_GET_SINGLE_ENTRY_SIZE(pfs)                                                 \
 184 ({                                                                                      \
 185         pfs->pfs_header.entry_size > SZ_1K ? 0 : pfs->pfs_header.entry_size << 2;       \
 186 })
 187
 188 /* Used during auxbus device creation */
 189 static DEFINE_IDA(intel_vsec_tpmi_ida);
 190
 191 struct intel_tpmi_plat_info *tpmi_get_platform_data(struct auxiliary_device *auxdev)
 192 {
 193         struct intel_vsec_device *vsec_dev = auxdev_to_ivdev(auxdev);
 194
 195         return vsec_dev->priv_data;
 196 }
 197 EXPORT_SYMBOL_NS_GPL(tpmi_get_platform_data, INTEL_TPMI);
 198
 199 int tpmi_get_resource_count(struct auxiliary_device *auxdev)
 200 {
 201         struct intel_vsec_device *vsec_dev = auxdev_to_ivdev(auxdev);
 202
 203         if (vsec_dev)
 204                 return vsec_dev->num_resources;
 205
 206         return 0;
 207 }
 208 EXPORT_SYMBOL_NS_GPL(tpmi_get_resource_count, INTEL_TPMI);
 209
 210 struct resource *tpmi_get_resource_at_index(struct auxiliary_device *auxdev, int index)
 211 {
 212         struct intel_vsec_device *vsec_dev = auxdev_to_ivdev(auxdev);
 213
 214         if (vsec_dev && index < vsec_dev->num_resources)
 215                 return &vsec_dev->resource[index];
 216
 217         return NULL;
 218 }
 219 EXPORT_SYMBOL_NS_GPL(tpmi_get_resource_at_index, INTEL_TPMI);
 220
 221 /* TPMI Control Interface */
 222
 223 #define TPMI_CONTROL_STATUS_OFFSET      0x00
 224 #define TPMI_COMMAND_OFFSET             0x08
 225 #define TMPI_CONTROL_DATA_VAL_OFFSET    0x0c
 226
 227 /*
 228  * Spec is calling for max 1 seconds to get ownership at the worst
 229  * case. Read at 10 ms timeouts and repeat up to 1 second.
 230  */
 231 #define TPMI_CONTROL_TIMEOUT_US         (10 * USEC_PER_MSEC)
 232 #define TPMI_CONTROL_TIMEOUT_MAX_US     (1 * USEC_PER_SEC)
 233
 234 #define TPMI_RB_TIMEOUT_US              (10 * USEC_PER_MSEC)
 235 #define TPMI_RB_TIMEOUT_MAX_US          USEC_PER_SEC
 236
 237 /* TPMI Control status register defines */
 238
 239 #define TPMI_CONTROL_STATUS_RB          BIT_ULL(0)
 240
 241 #define TPMI_CONTROL_STATUS_OWNER       GENMASK_ULL(5, 4)
 242 #define TPMI_OWNER_NONE                 0
 243 #define TPMI_OWNER_IN_BAND              1
 244
 245 #define TPMI_CONTROL_STATUS_CPL         BIT_ULL(6)
 246 #define TPMI_CONTROL_STATUS_RESULT      GENMASK_ULL(15, 8)
 247 #define TPMI_CONTROL_STATUS_LEN         GENMASK_ULL(31, 16)
 248
 249 #define TPMI_CMD_PKT_LEN                2
 250 #define TPMI_CMD_STATUS_SUCCESS         0x40
 251
 252 /* TPMI command data registers */
 253 #define TMPI_CONTROL_DATA_CMD           GENMASK_ULL(7, 0)
 254 #define TPMI_CONTROL_DATA_VAL_FEATURE   GENMASK_ULL(48, 40)
 255
 256 /* Command to send via control interface */
 257 #define TPMI_CONTROL_GET_STATE_CMD      0x10
 258
 259 #define TPMI_CONTROL_CMD_MASK           GENMASK_ULL(48, 40)
 260
 261 #define TPMI_CMD_LEN_MASK               GENMASK_ULL(18, 16)
 262
 263 /* Mutex to complete get feature status without interruption */
 264 static DEFINE_MUTEX(tpmi_dev_lock);
 265
 266 static int tpmi_wait_for_owner(struct intel_tpmi_info *tpmi_info, u8 owner)
 267 {
 268         u64 control;
 269
 270         return readq_poll_timeout(tpmi_info->tpmi_control_mem + TPMI_CONTROL_STATUS_OFFSET,
 271                                   control, owner == FIELD_GET(TPMI_CONTROL_STATUS_OWNER, control),
 272                                   TPMI_CONTROL_TIMEOUT_US, TPMI_CONTROL_TIMEOUT_MAX_US);
 273 }
 274
 275 static int tpmi_read_feature_status(struct intel_tpmi_info *tpmi_info, int feature_id,
 276                                     struct tpmi_feature_state *feature_state)
 277 {
 278         u64 control, data;
 279         int ret;
 280
 281         if (!tpmi_info->tpmi_control_mem)
 282                 return -EFAULT;
 283
 284         mutex_lock(&tpmi_dev_lock);
 285
 286         /* Wait for owner bit set to 0 (none) */
 287         ret = tpmi_wait_for_owner(tpmi_info, TPMI_OWNER_NONE);
 288         if (ret)
 289                 goto err_unlock;
 290
 291         /* set command id to 0x10 for TPMI_GET_STATE */
 292         data = FIELD_PREP(TMPI_CONTROL_DATA_CMD, TPMI_CONTROL_GET_STATE_CMD);
 293
 294         /* 32 bits for DATA offset and +8 for feature_id field */
 295         data |= FIELD_PREP(TPMI_CONTROL_DATA_VAL_FEATURE, feature_id);
 296
 297         /* Write at command offset for qword access */
 298         writeq(data, tpmi_info->tpmi_control_mem + TPMI_COMMAND_OFFSET);
 299
 300         /* Wait for owner bit set to in-band */
 301         ret = tpmi_wait_for_owner(tpmi_info, TPMI_OWNER_IN_BAND);
 302         if (ret)
 303                 goto err_unlock;
 304
 305         /* Set Run Busy and packet length of 2 dwords */
 306         control = TPMI_CONTROL_STATUS_RB;
 307         control |= FIELD_PREP(TPMI_CONTROL_STATUS_LEN, TPMI_CMD_PKT_LEN);
 308
 309         /* Write at status offset for qword access */
 310         writeq(control, tpmi_info->tpmi_control_mem + TPMI_CONTROL_STATUS_OFFSET);
 311
 312         /* Wait for Run Busy clear */
 313         ret = readq_poll_timeout(tpmi_info->tpmi_control_mem + TPMI_CONTROL_STATUS_OFFSET,
 314                                  control, !(control & TPMI_CONTROL_STATUS_RB),
 315                                  TPMI_RB_TIMEOUT_US, TPMI_RB_TIMEOUT_MAX_US);
 316         if (ret)
 317                 goto done_proc;
 318
 319         control = FIELD_GET(TPMI_CONTROL_STATUS_RESULT, control);
 320         if (control != TPMI_CMD_STATUS_SUCCESS) {
 321                 ret = -EBUSY;
 322                 goto done_proc;
 323         }
 324
 325         /* Response is ready */
 326         memcpy_fromio(feature_state, tpmi_info->tpmi_control_mem + TMPI_CONTROL_DATA_VAL_OFFSET,
 327                       sizeof(*feature_state));
 328
 329         ret = 0;
 330
 331 done_proc:
 332         /* Set CPL "completion" bit */
 333         writeq(TPMI_CONTROL_STATUS_CPL, tpmi_info->tpmi_control_mem + TPMI_CONTROL_STATUS_OFFSET);
 334
 335 err_unlock:
 336         mutex_unlock(&tpmi_dev_lock);
 337
 338         return ret;
 339 }
 340
 341 int tpmi_get_feature_status(struct auxiliary_device *auxdev,
 342                             int feature_id, bool *read_blocked, bool *write_blocked)
 343 {
 344         struct intel_vsec_device *intel_vsec_dev = dev_to_ivdev(auxdev->dev.parent);
 345         struct intel_tpmi_info *tpmi_info = auxiliary_get_drvdata(&intel_vsec_dev->auxdev);
 346         struct tpmi_feature_state feature_state;
 347         int ret;
 348
 349         ret = tpmi_read_feature_status(tpmi_info, feature_id, &feature_state);
 350         if (ret)
 351                 return ret;
 352
 353         *read_blocked = feature_state.read_blocked;
 354         *write_blocked = feature_state.write_blocked;
 355
 356         return 0;
 357 }
 358 EXPORT_SYMBOL_NS_GPL(tpmi_get_feature_status, INTEL_TPMI);
 359
 360 struct dentry *tpmi_get_debugfs_dir(struct auxiliary_device *auxdev)
 361 {
 362         struct intel_vsec_device *intel_vsec_dev = dev_to_ivdev(auxdev->dev.parent);
 363         struct intel_tpmi_info *tpmi_info = auxiliary_get_drvdata(&intel_vsec_dev->auxdev);
 364
 365         return tpmi_info->dbgfs_dir;
 366 }
 367 EXPORT_SYMBOL_NS_GPL(tpmi_get_debugfs_dir, INTEL_TPMI);
 368
 369 static int tpmi_pfs_dbg_show(struct seq_file *s, void *unused)
 370 {
 371         struct intel_tpmi_info *tpmi_info = s->private;
 372         int locked, disabled, read_blocked, write_blocked;
 373         struct tpmi_feature_state feature_state;
 374         struct intel_tpmi_pm_feature *pfs;
 375         int ret, i;
 376
 377
 378         seq_printf(s, "tpmi PFS start offset 0x:%llx\n", tpmi_info->pfs_start);
 379         seq_puts(s, "tpmi_id\t\tentries\t\tsize\t\tcap_offset\tattribute\tvsec_offset\tlocked\tdisabled\tread_blocked\twrite_blocked\n");
 380         for (i = 0; i < tpmi_info->feature_count; ++i) {
 381                 pfs = &tpmi_info->tpmi_features[i];
 382                 ret = tpmi_read_feature_status(tpmi_info, pfs->pfs_header.tpmi_id, &feature_state);
 383                 if (ret) {
 384                         locked = 'U';
 385                         disabled = 'U';
 386                         read_blocked = 'U';
 387                         write_blocked = 'U';
 388                 } else {
 389                         disabled = feature_state.enabled ? 'N' : 'Y';
 390                         locked = feature_state.locked ? 'Y' : 'N';
 391                         read_blocked = feature_state.read_blocked ? 'Y' : 'N';
 392                         write_blocked = feature_state.write_blocked ? 'Y' : 'N';
 393                 }
 394                 seq_printf(s, "0x%02x\t\t0x%02x\t\t0x%04x\t\t0x%04x\t\t0x%02x\t\t0x%016llx\t%c\t%c\t\t%c\t\t%c\n",
 395                            pfs->pfs_header.tpmi_id, pfs->pfs_header.num_entries,
 396                            pfs->pfs_header.entry_size, pfs->pfs_header.cap_offset,
 397                            pfs->pfs_header.attribute, pfs->vsec_offset, locked, disabled,
 398                            read_blocked, write_blocked);
 399         }
 400
 401         return 0;
 402 }
 403 DEFINE_SHOW_ATTRIBUTE(tpmi_pfs_dbg);
 404
 405 #define MEM_DUMP_COLUMN_COUNT   8
 406
 407 static int tpmi_mem_dump_show(struct seq_file *s, void *unused)
 408 {
 409         size_t row_size = MEM_DUMP_COLUMN_COUNT * sizeof(u32);
 410         struct intel_tpmi_pm_feature *pfs = s->private;
 411         int count, ret = 0;
 412         void __iomem *mem;
 413         u32 size;
 414         u64 off;
 415         u8 *buffer;
 416
 417         size = TPMI_GET_SINGLE_ENTRY_SIZE(pfs);
 418         if (!size)
 419                 return -EIO;
 420
 421         buffer = kmalloc(size, GFP_KERNEL);
 422         if (!buffer)
 423                 return -ENOMEM;
 424
 425         off = pfs->vsec_offset;
 426
 427         mutex_lock(&tpmi_dev_lock);
 428
 429         for (count = 0; count < pfs->pfs_header.num_entries; ++count) {
 430                 seq_printf(s, "TPMI Instance:%d offset:0x%llx\n", count, off);
 431
 432                 mem = ioremap(off, size);
 433                 if (!mem) {
 434                         ret = -ENOMEM;
 435                         break;
 436                 }
 437
 438                 memcpy_fromio(buffer, mem, size);
 439
 440                 seq_hex_dump(s, " ", DUMP_PREFIX_OFFSET, row_size, sizeof(u32), buffer, size,
 441                              false);
 442
 443                 iounmap(mem);
 444
 445                 off += size;
 446         }
 447
 448         mutex_unlock(&tpmi_dev_lock);
 449
 450         kfree(buffer);
 451
 452         return ret;
 453 }
 454 DEFINE_SHOW_ATTRIBUTE(tpmi_mem_dump);
 455
 456 static ssize_t mem_write(struct file *file, const char __user *userbuf, size_t len, loff_t *ppos)
 457 {
 458         struct seq_file *m = file->private_data;
 459         struct intel_tpmi_pm_feature *pfs = m->private;
 460         u32 addr, value, punit, size;
 461         u32 num_elems, *array;
 462         void __iomem *mem;
 463         int ret;
 464
 465         size = TPMI_GET_SINGLE_ENTRY_SIZE(pfs);
 466         if (!size)
 467                 return -EIO;
 468
 469         ret = parse_int_array_user(userbuf, len, (int **)&array);
 470         if (ret < 0)
 471                 return ret;
 472
 473         num_elems = *array;
 474         if (num_elems != 3) {
 475                 ret = -EINVAL;
 476                 goto exit_write;
 477         }
 478
 479         punit = array[1];
 480         addr = array[2];
 481         value = array[3];
 482
 483         if (punit >= pfs->pfs_header.num_entries) {
 484                 ret = -EINVAL;
 485                 goto exit_write;
 486         }
 487
 488         if (addr >= size) {
 489                 ret = -EINVAL;
 490                 goto exit_write;
 491         }
 492
 493         mutex_lock(&tpmi_dev_lock);
 494
 495         mem = ioremap(pfs->vsec_offset + punit * size, size);
 496         if (!mem) {
 497                 ret = -ENOMEM;
 498                 goto unlock_mem_write;
 499         }
 500
 501         writel(value, mem + addr);
 502
 503         iounmap(mem);
 504
 505         ret = len;
 506
 507 unlock_mem_write:
 508         mutex_unlock(&tpmi_dev_lock);
 509
 510 exit_write:
 511         kfree(array);
 512
 513         return ret;
 514 }
 515
 516 static int mem_write_show(struct seq_file *s, void *unused)
 517 {
 518         return 0;
 519 }
 520
 521 static int mem_write_open(struct inode *inode, struct file *file)
 522 {
 523         return single_open(file, mem_write_show, inode->i_private);
 524 }
 525
 526 static const struct file_operations mem_write_ops = {
 527         .open           = mem_write_open,
 528         .read           = seq_read,
 529         .write          = mem_write,
 530         .llseek         = seq_lseek,
 531         .release        = single_release,
 532 };
 533
 534 #define tpmi_to_dev(info)       (&info->vsec_dev->pcidev->dev)
 535
 536 static void tpmi_dbgfs_register(struct intel_tpmi_info *tpmi_info)
 537 {
 538         char name[64];
 539         int i;
 540
 541         snprintf(name, sizeof(name), "tpmi-%s", dev_name(tpmi_to_dev(tpmi_info)));
 542         tpmi_info->dbgfs_dir = debugfs_create_dir(name, NULL);
 543
 544         debugfs_create_file("pfs_dump", 0444, tpmi_info->dbgfs_dir, tpmi_info, &tpmi_pfs_dbg_fops);
 545
 546         for (i = 0; i < tpmi_info->feature_count; ++i) {
 547                 struct intel_tpmi_pm_feature *pfs;
 548                 struct dentry *dir;
 549
 550                 pfs = &tpmi_info->tpmi_features[i];
 551                 snprintf(name, sizeof(name), "tpmi-id-%02x", pfs->pfs_header.tpmi_id);
 552                 dir = debugfs_create_dir(name, tpmi_info->dbgfs_dir);
 553
 554                 debugfs_create_file("mem_dump", 0444, dir, pfs, &tpmi_mem_dump_fops);
 555                 debugfs_create_file("mem_write", 0644, dir, pfs, &mem_write_ops);
 556         }
 557 }
 558
 559 static void tpmi_set_control_base(struct auxiliary_device *auxdev,
 560                                   struct intel_tpmi_info *tpmi_info,
 561                                   struct intel_tpmi_pm_feature *pfs)
 562 {
 563         void __iomem *mem;
 564         u32 size;
 565
 566         size = TPMI_GET_SINGLE_ENTRY_SIZE(pfs);
 567         if (!size)
 568                 return;
 569
 570         mem = devm_ioremap(&auxdev->dev, pfs->vsec_offset, size);
 571         if (!mem)
 572                 return;
 573
 574         /* mem is pointing to TPMI CONTROL base */
 575         tpmi_info->tpmi_control_mem = mem;
 576 }
 577
 578 static const char *intel_tpmi_name(enum intel_tpmi_id id)
 579 {
 580         switch (id) {
 581         case TPMI_ID_RAPL:
 582                 return "rapl";
 583         case TPMI_ID_PEM:
 584                 return "pem";
 585         case TPMI_ID_UNCORE:
 586                 return "uncore";
 587         case TPMI_ID_SST:
 588                 return "sst";
 589         case TPMI_ID_PLR:
 590                 return "plr";
 591         default:
 592                 return NULL;
 593         }
 594 }
 595
 596 /* String Length for tpmi-"feature_name(upto 8 bytes)" */
 597 #define TPMI_FEATURE_NAME_LEN   14
 598
 599 static int tpmi_create_device(struct intel_tpmi_info *tpmi_info,
 600                               struct intel_tpmi_pm_feature *pfs,
 601                               u64 pfs_start)
 602 {
 603         struct intel_vsec_device *vsec_dev = tpmi_info->vsec_dev;
 604         char feature_id_name[TPMI_FEATURE_NAME_LEN];
 605         struct intel_vsec_device *feature_vsec_dev;
 606         struct tpmi_feature_state feature_state;
 607         struct resource *res, *tmp;
 608         const char *name;
 609         int i, ret;
 610
 611         ret = tpmi_read_feature_status(tpmi_info, pfs->pfs_header.tpmi_id, &feature_state);
 612         if (ret)
 613                 return ret;
 614
 615         /*
 616          * If not enabled, continue to look at other features in the PFS, so return -EOPNOTSUPP.
 617          * This will not cause failure of loading of this driver.
 618          */
 619         if (!feature_state.enabled)
 620                 return -EOPNOTSUPP;
 621
 622         name = intel_tpmi_name(pfs->pfs_header.tpmi_id);
 623         if (!name)
 624                 return -EOPNOTSUPP;
 625
 626         res = kcalloc(pfs->pfs_header.num_entries, sizeof(*res), GFP_KERNEL);
 627         if (!res)
 628                 return -ENOMEM;
 629
 630         feature_vsec_dev = kzalloc(sizeof(*feature_vsec_dev), GFP_KERNEL);
 631         if (!feature_vsec_dev) {
 632                 kfree(res);
 633                 return -ENOMEM;
 634         }
 635
 636         snprintf(feature_id_name, sizeof(feature_id_name), "tpmi-%s", name);
 637
 638         for (i = 0, tmp = res; i < pfs->pfs_header.num_entries; i++, tmp++) {
 639                 u64 entry_size_bytes = pfs->pfs_header.entry_size * sizeof(u32);
 640
 641                 tmp->start = pfs->vsec_offset + entry_size_bytes * i;
 642                 tmp->end = tmp->start + entry_size_bytes - 1;
 643                 tmp->flags = IORESOURCE_MEM;
 644         }
 645
 646         feature_vsec_dev->pcidev = vsec_dev->pcidev;
 647         feature_vsec_dev->resource = res;
 648         feature_vsec_dev->num_resources = pfs->pfs_header.num_entries;
 649         feature_vsec_dev->priv_data = &tpmi_info->plat_info;
 650         feature_vsec_dev->priv_data_size = sizeof(tpmi_info->plat_info);
 651         feature_vsec_dev->ida = &intel_vsec_tpmi_ida;
 652
 653         /*
 654          * intel_vsec_add_aux() is resource managed, no explicit
 655          * delete is required on error or on module unload.
 656          * feature_vsec_dev and res memory are also freed as part of
 657          * device deletion.
 658          */
 659         return intel_vsec_add_aux(vsec_dev->pcidev, &vsec_dev->auxdev.dev,
 660                                   feature_vsec_dev, feature_id_name);
 661 }
 662
 663 static int tpmi_create_devices(struct intel_tpmi_info *tpmi_info)
 664 {
 665         struct intel_vsec_device *vsec_dev = tpmi_info->vsec_dev;
 666         int ret, i;
 667
 668         for (i = 0; i < vsec_dev->num_resources; i++) {
 669                 ret = tpmi_create_device(tpmi_info, &tpmi_info->tpmi_features[i],
 670                                          tpmi_info->pfs_start);
 671                 /*
 672                  * Fail, if the supported features fails to create device,
 673                  * otherwise, continue. Even if one device failed to create,
 674                  * fail the loading of driver. Since intel_vsec_add_aux()
 675                  * is resource managed, no clean up is required for the
 676                  * successfully created devices.
 677                  */
 678                 if (ret && ret != -EOPNOTSUPP)
 679                         return ret;
 680         }
 681
 682         return 0;
 683 }
 684
 685 #define TPMI_INFO_BUS_INFO_OFFSET       0x08
 686 #define TPMI_INFO_MAJOR_VERSION         0x00
 687 #define TPMI_INFO_MINOR_VERSION         0x02
 688
 689 static int tpmi_process_info(struct intel_tpmi_info *tpmi_info,
 690                              struct intel_tpmi_pm_feature *pfs)
 691 {
 692         struct tpmi_info_header header;
 693         void __iomem *info_mem;
 694         u64 feature_header;
 695         int ret = 0;
 696
 697         info_mem = ioremap(pfs->vsec_offset, pfs->pfs_header.entry_size * sizeof(u32));
 698         if (!info_mem)
 699                 return -ENOMEM;
 700
 701         feature_header = readq(info_mem);
 702         if (TPMI_MAJOR_VERSION(feature_header) != TPMI_INFO_MAJOR_VERSION) {
 703                 ret = -ENODEV;
 704                 goto error_info_header;
 705         }
 706
 707         memcpy_fromio(&header, info_mem + TPMI_INFO_BUS_INFO_OFFSET, sizeof(header));
 708
 709         tpmi_info->plat_info.package_id = header.pkg;
 710         tpmi_info->plat_info.bus_number = header.bus;
 711         tpmi_info->plat_info.device_number = header.dev;
 712         tpmi_info->plat_info.function_number = header.fn;
 713
 714         if (TPMI_MINOR_VERSION(feature_header) >= TPMI_INFO_MINOR_VERSION) {
 715                 tpmi_info->plat_info.cdie_mask = header.cdie_mask;
 716                 tpmi_info->plat_info.partition = header.partition;
 717                 tpmi_info->plat_info.segment = header.segment;
 718         }
 719
 720 error_info_header:
 721         iounmap(info_mem);
 722
 723         return ret;
 724 }
 725
 726 static int tpmi_fetch_pfs_header(struct intel_tpmi_pm_feature *pfs, u64 start, int size)
 727 {
 728         void __iomem *pfs_mem;
 729
 730         pfs_mem = ioremap(start, size);
 731         if (!pfs_mem)
 732                 return -ENOMEM;
 733
 734         memcpy_fromio(&pfs->pfs_header, pfs_mem, sizeof(pfs->pfs_header));
 735
 736         iounmap(pfs_mem);
 737
 738         return 0;
 739 }
 740
 741 #define TPMI_CAP_OFFSET_UNIT    1024
 742
 743 static int intel_vsec_tpmi_init(struct auxiliary_device *auxdev)
 744 {
 745         struct intel_vsec_device *vsec_dev = auxdev_to_ivdev(auxdev);
 746         struct pci_dev *pci_dev = vsec_dev->pcidev;
 747         struct intel_tpmi_info *tpmi_info;
 748         u64 pfs_start = 0;
 749         int ret, i;
 750
 751         tpmi_info = devm_kzalloc(&auxdev->dev, sizeof(*tpmi_info), GFP_KERNEL);
 752         if (!tpmi_info)
 753                 return -ENOMEM;
 754
 755         tpmi_info->vsec_dev = vsec_dev;
 756         tpmi_info->feature_count = vsec_dev->num_resources;
 757         tpmi_info->plat_info.bus_number = pci_dev->bus->number;
 758
 759         tpmi_info->tpmi_features = devm_kcalloc(&auxdev->dev, vsec_dev->num_resources,
 760                                                 sizeof(*tpmi_info->tpmi_features),
 761                                                 GFP_KERNEL);
 762         if (!tpmi_info->tpmi_features)
 763                 return -ENOMEM;
 764
 765         for (i = 0; i < vsec_dev->num_resources; i++) {
 766                 struct intel_tpmi_pm_feature *pfs;
 767                 struct resource *res;
 768                 u64 res_start;
 769                 int size, ret;
 770
 771                 pfs = &tpmi_info->tpmi_features[i];
 772                 pfs->vsec_dev = vsec_dev;
 773
 774                 res = &vsec_dev->resource[i];
 775                 if (!res)
 776                         continue;
 777
 778                 res_start = res->start;
 779                 size = resource_size(res);
 780                 if (size < 0)
 781                         continue;
 782
 783                 ret = tpmi_fetch_pfs_header(pfs, res_start, size);
 784                 if (ret)
 785                         continue;
 786
 787                 if (!pfs_start)
 788                         pfs_start = res_start;
 789
 790                 pfs->vsec_offset = pfs_start + pfs->pfs_header.cap_offset * TPMI_CAP_OFFSET_UNIT;
 791
 792                 /*
 793                  * Process TPMI_INFO to get PCI device to CPU package ID.
 794                  * Device nodes for TPMI features are not created in this
 795                  * for loop. So, the mapping information will be available
 796                  * when actual device nodes created outside this
 797                  * loop via tpmi_create_devices().
 798                  */
 799                 if (pfs->pfs_header.tpmi_id == TPMI_INFO_ID) {
 800                         ret = tpmi_process_info(tpmi_info, pfs);
 801                         if (ret)
 802                                 return ret;
 803                 }
 804
 805                 if (pfs->pfs_header.tpmi_id == TPMI_CONTROL_ID)
 806                         tpmi_set_control_base(auxdev, tpmi_info, pfs);
 807         }
 808
 809         tpmi_info->pfs_start = pfs_start;
 810
 811         auxiliary_set_drvdata(auxdev, tpmi_info);
 812
 813         ret = tpmi_create_devices(tpmi_info);
 814         if (ret)
 815                 return ret;
 816
 817         /*
 818          * Allow debugfs when security policy allows. Everything this debugfs
 819          * interface provides, can also be done via /dev/mem access. If
 820          * /dev/mem interface is locked, don't allow debugfs to present any
 821          * information. Also check for CAP_SYS_RAWIO as /dev/mem interface.
 822          */
 823         if (!security_locked_down(LOCKDOWN_DEV_MEM) && capable(CAP_SYS_RAWIO))
 824                 tpmi_dbgfs_register(tpmi_info);
 825
 826         return 0;
 827 }
 828
 829 static int tpmi_probe(struct auxiliary_device *auxdev,
 830                       const struct auxiliary_device_id *id)
 831 {
 832         return intel_vsec_tpmi_init(auxdev);
 833 }
 834
 835 static void tpmi_remove(struct auxiliary_device *auxdev)
 836 {
 837         struct intel_tpmi_info *tpmi_info = auxiliary_get_drvdata(auxdev);
 838
 839         debugfs_remove_recursive(tpmi_info->dbgfs_dir);
 840 }
 841
 842 static const struct auxiliary_device_id tpmi_id_table[] = {
 843         { .name = "intel_vsec.tpmi" },
 844         {}
 845 };
 846 MODULE_DEVICE_TABLE(auxiliary, tpmi_id_table);
 847
 848 static struct auxiliary_driver tpmi_aux_driver = {
 849         .id_table       = tpmi_id_table,
 850         .probe          = tpmi_probe,
 851         .remove         = tpmi_remove,
 852 };
 853
 854 module_auxiliary_driver(tpmi_aux_driver);
 855
 856 MODULE_IMPORT_NS(INTEL_VSEC);
 857 MODULE_DESCRIPTION("Intel TPMI enumeration module");
 858 MODULE_LICENSE("GPL");