]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
platform/x86/intel/pmc/ssram: Switch to static array with per-index probe state
authorDavid E. Box <david.e.box@linux.intel.com>
Fri, 12 Jun 2026 21:01:53 +0000 (14:01 -0700)
committerIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Sun, 14 Jun 2026 23:13:12 +0000 (02:13 +0300)
Replace devm-allocated pmc_ssram_telems pointer with a fixed-size static
array and introduce per-index probe state tracking.

This prepares the driver for later per-device probe handling where tying
the PMC tracking storage to one probed PCI device is no longer suitable.

The previous single global device_probed flag cannot describe the state of
individual PMC indices when multiple devices can be probed independently.
Replace it with per-index state (UNPROBED, PROBING, PRESENT, ABSENT) and a
staging cache that publishes discovered values only after probe completes.
This avoids races between probe/unbind and concurrent readers.

Use marked state accesses with release/acquire ordering to prevent compiler
and CPU reordering issues across concurrent probe/unbind cycles.

This patch was substantially rewritten in later revisions. Originally
developed from earlier work by Xi Pardee.

Signed-off-by: David E. Box <david.e.box@linux.intel.com>
Assisted-by: Claude:claude-sonnet-4-5
Link: https://patch.msgid.link/a2cccf532bec04fcc370819890d936212bc1b14c.1781294741.git.david.e.box@linux.intel.com
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
drivers/platform/x86/intel/pmc/ssram_telemetry.c

index 211d842df4497797b43698da704ba52c2f6064ea..3349f65ae7bdfba5c1603068c3dad7495536e74c 100644 (file)
@@ -5,6 +5,7 @@
  * Copyright (c) 2023, Intel Corporation.
  */
 
+#include <linux/bitmap.h>
 #include <linux/bits.h>
 #include <linux/cleanup.h>
 #include <linux/device.h>
@@ -24,6 +25,7 @@
 #define SSRAM_IOE_OFFSET       0x68
 #define SSRAM_DEVID_OFFSET     0x70
 #define SSRAM_BASE_ADDR_MASK   GENMASK_ULL(63, 3)
+#define SSRAM_PCI_PMC_MASK     (BIT(PMC_IDX_MAIN) | BIT(PMC_IDX_IOE) | BIT(PMC_IDX_PCH))
 
 DEFINE_FREE(pmc_ssram_telemetry_iounmap, void __iomem *, if (_T) iounmap(_T))
 
@@ -39,15 +41,37 @@ static const struct ssram_type pci_main = {
        .method = RES_METHOD_PCI,
 };
 
-static struct pmc_ssram_telemetry *pmc_ssram_telems;
-static bool device_probed;
+enum pmc_ssram_state {
+       PMC_SSRAM_UNPROBED = 0,
+       PMC_SSRAM_PROBING,
+       PMC_SSRAM_PRESENT,
+       PMC_SSRAM_ABSENT,
+};
+
+static enum pmc_ssram_state pmc_ssram_state[MAX_NUM_PMC];
+static struct pmc_ssram_telemetry pmc_ssram_telems[MAX_NUM_PMC];
+
+struct pmc_ssram_probe_cache {
+       /* Per-index values staged by probe before publishing globally. */
+       struct pmc_ssram_telemetry telems[MAX_NUM_PMC];
+       /* PMCs this probe instance is responsible for publishing. */
+       unsigned long owned_mask;
+       /* Subset of owned_mask that was discovered successfully. */
+       unsigned long valid_mask;
+};
+
+struct pmc_ssram_drvdata {
+       /* PMCs published by this bound device; used to unpublish on remove. */
+       unsigned long owned_mask;
+};
 
 static inline u64 get_base(void __iomem *addr, u32 offset)
 {
        return lo_hi_readq(addr + offset) & SSRAM_BASE_ADDR_MASK;
 }
 
-static void pmc_ssram_get_devid_pwrmbase(void __iomem *ssram, unsigned int pmc_idx)
+static void pmc_ssram_get_devid_pwrmbase(struct pmc_ssram_probe_cache *probe_cache,
+                                        void __iomem *ssram, unsigned int pmc_idx)
 {
        u64 pwrm_base;
        u16 devid;
@@ -55,8 +79,45 @@ static void pmc_ssram_get_devid_pwrmbase(void __iomem *ssram, unsigned int pmc_i
        pwrm_base = get_base(ssram, SSRAM_PWRM_OFFSET);
        devid = readw(ssram + SSRAM_DEVID_OFFSET);
 
-       pmc_ssram_telems[pmc_idx].devid = devid;
-       pmc_ssram_telems[pmc_idx].base_addr = pwrm_base;
+       probe_cache->telems[pmc_idx].base_addr = pwrm_base;
+       probe_cache->telems[pmc_idx].devid = devid;
+}
+
+static void pmc_ssram_publish_absent(unsigned int pmc_idx)
+{
+       /*
+        * Publish only the state without modifying base_addr and devid. This
+        * lets a reader that already observed PRESENT finish copying the
+        * previous values even if unbind concurrently publishes ABSENT. Readers
+        * that observe ABSENT return -ENODEV without accessing data.
+        */
+       smp_store_release(&pmc_ssram_state[pmc_idx], PMC_SSRAM_ABSENT);
+}
+
+static void pmc_ssram_publish_present(struct pmc_ssram_probe_cache *probe_cache,
+                                     unsigned int pmc_idx)
+{
+       /*
+        * The devid and base_addr fields are read from hardware MMIO registers
+        * whose values are stable for a given PMC index. A reader that observed
+        * PRESENT from an earlier probe can safely copy them while a concurrent
+        * rebind republishes those fields because both probes read the same
+        * hardware values.
+        */
+       pmc_ssram_telems[pmc_idx] = probe_cache->telems[pmc_idx];
+       /*
+        * Publish base_addr and devid before publishing PRESENT. Pairs with the
+        * acquire load in the reader that consumes them after observing PRESENT.
+        */
+       smp_store_release(&pmc_ssram_state[pmc_idx], PMC_SSRAM_PRESENT);
+}
+
+static void pmc_ssram_mark_probing(unsigned long mask)
+{
+       unsigned long bit;
+
+       for_each_set_bit(bit, &mask, MAX_NUM_PMC)
+               WRITE_ONCE(pmc_ssram_state[bit], PMC_SSRAM_PROBING);
 }
 
 static int
@@ -96,11 +157,14 @@ pmc_ssram_telemetry_add_pmt(struct pci_dev *pcidev, u64 ssram_base, void __iomem
 }
 
 static int
-pmc_ssram_telemetry_get_pmc_pci(struct pci_dev *pcidev, unsigned int pmc_idx, u32 offset)
+pmc_ssram_telemetry_get_pmc_pci(struct pci_dev *pcidev,
+                               struct pmc_ssram_probe_cache *probe_cache,
+                               unsigned int pmc_idx, u32 offset)
 {
        void __iomem __free(pmc_ssram_telemetry_iounmap) *tmp_ssram = NULL;
        void __iomem __free(pmc_ssram_telemetry_iounmap) *ssram = NULL;
        u64 ssram_base;
+       int ret;
 
        ssram_base = pci_resource_start(pcidev, 0);
        tmp_ssram = ioremap(ssram_base, SSRAM_HDR_SIZE);
@@ -125,22 +189,38 @@ pmc_ssram_telemetry_get_pmc_pci(struct pci_dev *pcidev, unsigned int pmc_idx, u3
                ssram = no_free_ptr(tmp_ssram);
        }
 
-       pmc_ssram_get_devid_pwrmbase(ssram, pmc_idx);
+       pmc_ssram_get_devid_pwrmbase(probe_cache, ssram, pmc_idx);
 
        /* Find and register and PMC telemetry entries */
-       return pmc_ssram_telemetry_add_pmt(pcidev, ssram_base, ssram);
+       ret = pmc_ssram_telemetry_add_pmt(pcidev, ssram_base, ssram);
+       if (ret)
+               return ret;
+
+       probe_cache->valid_mask |= BIT(pmc_idx);
+
+       return 0;
 }
 
-static int pmc_ssram_telemetry_pci_init(struct pci_dev *pcidev)
+static int pmc_ssram_telemetry_pci_init(struct pci_dev *pcidev,
+                                       struct pmc_ssram_probe_cache *probe_cache)
 {
        int ret;
 
-       ret = pmc_ssram_telemetry_get_pmc_pci(pcidev, PMC_IDX_MAIN, 0);
+       ret = pmc_ssram_telemetry_get_pmc_pci(pcidev, probe_cache, PMC_IDX_MAIN, 0);
        if (ret)
                return ret;
 
-       pmc_ssram_telemetry_get_pmc_pci(pcidev, PMC_IDX_IOE, SSRAM_IOE_OFFSET);
-       pmc_ssram_telemetry_get_pmc_pci(pcidev, PMC_IDX_PCH, SSRAM_PCH_OFFSET);
+       /*
+        * If MAIN PMC enumeration is successful but either IOE or PCH fail,
+        * don't fail probe as the MAIN PMC is still useful as it provides the
+        * global reset and slp_s0 counter access. Failed or missing secondary
+        * PMCs are left out of valid_mask and published as absent.
+        */
+       pmc_ssram_telemetry_get_pmc_pci(pcidev, probe_cache, PMC_IDX_IOE,
+                                       SSRAM_IOE_OFFSET);
+
+       pmc_ssram_telemetry_get_pmc_pci(pcidev, probe_cache, PMC_IDX_PCH,
+                                       SSRAM_PCH_OFFSET);
 
        return 0;
 }
@@ -150,62 +230,106 @@ static int pmc_ssram_telemetry_pci_init(struct pci_dev *pcidev)
  * @pmc_idx:               Index of the PMC
  * @pmc_ssram_telemetry:   pmc_ssram_telemetry structure to store the PMC information
  *
+ * State flow per PMC index:
+ * - PMC_SSRAM_UNPROBED: Probe has not started for this index.
+ * - PMC_SSRAM_PROBING:  Probe is currently discovering data for this index.
+ * - PMC_SSRAM_PRESENT:  base_addr/devid were published and can be read.
+ * - PMC_SSRAM_ABSENT:   No data is available for this index.
+ *
+ * Readers use an acquire load of the state. If state is PRESENT, reads of
+ * base_addr/devid are ordered after the state observation and pair with the
+ * writer's release-store when publishing PRESENT.
+ *
  * Return:
  * * 0           - Success
  * * -EAGAIN     - Probe function has not finished yet. Try again.
  * * -EINVAL     - Invalid pmc_idx
- * * -ENODEV     - PMC device is not available
+ * * -ENODEV     - PMC device is not available (hardware absent or driver failed to initialize)
  */
 int pmc_ssram_telemetry_get_pmc_info(unsigned int pmc_idx,
                                     struct pmc_ssram_telemetry *pmc_ssram_telemetry)
 {
+       enum pmc_ssram_state state;
+
+       if (pmc_idx >= MAX_NUM_PMC)
+               return -EINVAL;
+
        /*
         * PMCs are discovered in probe function. If this function is called before
-        * probe function complete, the result would be invalid. Use device_probed
-        * variable to avoid this case. Return -EAGAIN to inform the consumer to call
-        * again later.
+        * probe function complete, the result would be invalid. Use per-PMC state
+        * to inform the consumer to call again later.
         */
-       if (!device_probed)
+       state = smp_load_acquire(&pmc_ssram_state[pmc_idx]);
+       if (state == PMC_SSRAM_UNPROBED || state == PMC_SSRAM_PROBING)
                return -EAGAIN;
 
-       /*
-        * Memory barrier is used to ensure the correct read order between
-        * device_probed variable and PMC info.
-        */
-       smp_rmb();
-       if (pmc_idx >= MAX_NUM_PMC)
-               return -EINVAL;
-
-       if (!pmc_ssram_telems || !pmc_ssram_telems[pmc_idx].devid)
+       if (state == PMC_SSRAM_ABSENT)
                return -ENODEV;
 
+       /*
+        * Acquire semantics order reads of devid and base_addr after observing
+        * PRESENT and pair with the writer's release-store.
+        */
        pmc_ssram_telemetry->devid = pmc_ssram_telems[pmc_idx].devid;
        pmc_ssram_telemetry->base_addr = pmc_ssram_telems[pmc_idx].base_addr;
        return 0;
 }
 EXPORT_SYMBOL_GPL(pmc_ssram_telemetry_get_pmc_info);
 
+static void pmc_ssram_publish_absent_mask(unsigned long mask)
+{
+       unsigned long bit;
+
+       for_each_set_bit(bit, &mask, MAX_NUM_PMC)
+               pmc_ssram_publish_absent(bit);
+}
+
+static void pmc_ssram_publish_telems(struct pmc_ssram_probe_cache *probe_cache, int ret)
+{
+       unsigned long bit;
+
+       /* If probe failed, all owned indexes become absent for readers. */
+       if (ret) {
+               pmc_ssram_publish_absent_mask(probe_cache->owned_mask);
+               return;
+       }
+
+       /* Publish each owned index independently based on discovery result. */
+       for_each_set_bit(bit, &probe_cache->owned_mask, MAX_NUM_PMC) {
+               if (probe_cache->valid_mask & BIT(bit))
+                       pmc_ssram_publish_present(probe_cache, bit);
+               else
+                       pmc_ssram_publish_absent(bit);
+       }
+}
+
 static int pmc_ssram_telemetry_probe(struct pci_dev *pcidev, const struct pci_device_id *id)
 {
+       struct pmc_ssram_probe_cache probe_cache = {};
+       struct pmc_ssram_drvdata *drvdata;
        const struct ssram_type *ssram_type;
        enum resource_method method;
        int ret;
 
-       pmc_ssram_telems = devm_kzalloc(&pcidev->dev, sizeof(*pmc_ssram_telems) * MAX_NUM_PMC,
-                                       GFP_KERNEL);
-       if (!pmc_ssram_telems) {
-               ret = -ENOMEM;
-               goto probe_finish;
-       }
-
        ssram_type = (const struct ssram_type *)id->driver_data;
        if (!ssram_type) {
                dev_dbg(&pcidev->dev, "missing driver data\n");
-               ret = -EINVAL;
-               goto probe_finish;
+               return -EINVAL;
        }
 
        method = ssram_type->method;
+       if (method == RES_METHOD_PCI)
+               probe_cache.owned_mask = SSRAM_PCI_PMC_MASK;
+       else
+               return -EINVAL;
+
+       pmc_ssram_mark_probing(probe_cache.owned_mask);
+
+       drvdata = devm_kzalloc(&pcidev->dev, sizeof(*drvdata), GFP_KERNEL);
+       if (!drvdata) {
+               ret = -ENOMEM;
+               goto probe_finish;
+       }
 
        ret = pcim_enable_device(pcidev);
        if (ret) {
@@ -214,20 +338,29 @@ static int pmc_ssram_telemetry_probe(struct pci_dev *pcidev, const struct pci_de
        }
 
        if (method == RES_METHOD_PCI)
-               ret = pmc_ssram_telemetry_pci_init(pcidev);
+               ret = pmc_ssram_telemetry_pci_init(pcidev, &probe_cache);
        else
                ret = -EINVAL;
 
+       if (!ret) {
+               drvdata->owned_mask = probe_cache.owned_mask;
+               pci_set_drvdata(pcidev, drvdata);
+       }
+
 probe_finish:
-       /*
-        * Memory barrier is used to ensure the correct write order between PMC info
-        * and device_probed variable.
-        */
-       smp_wmb();
-       device_probed = true;
+       pmc_ssram_publish_telems(&probe_cache, ret);
+
        return ret;
 }
 
+static void pmc_ssram_telemetry_remove(struct pci_dev *pcidev)
+{
+       struct pmc_ssram_drvdata *drvdata = pci_get_drvdata(pcidev);
+
+       if (drvdata)
+               pmc_ssram_publish_absent_mask(drvdata->owned_mask);
+}
+
 static const struct pci_device_id pmc_ssram_telemetry_pci_ids[] = {
        { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PMC_DEVID_MTL_SOCM),
                .driver_data = (kernel_ulong_t)&pci_main },
@@ -251,6 +384,7 @@ static struct pci_driver pmc_ssram_telemetry_driver = {
        .name = "intel_pmc_ssram_telemetry",
        .id_table = pmc_ssram_telemetry_pci_ids,
        .probe = pmc_ssram_telemetry_probe,
+       .remove = pmc_ssram_telemetry_remove,
 };
 module_pci_driver(pmc_ssram_telemetry_driver);