drivers/platform/x86/intel/vsec.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _VSEC_H
   3 #define _VSEC_H
   4
   5 #include <linux/auxiliary_bus.h>
   6 #include <linux/bits.h>
   7
   8 #define VSEC_CAP_TELEMETRY      BIT(0)
   9 #define VSEC_CAP_WATCHER        BIT(1)
  10 #define VSEC_CAP_CRASHLOG       BIT(2)
  11 #define VSEC_CAP_SDSI           BIT(3)
  12 #define VSEC_CAP_TPMI           BIT(4)
  13
  14 /* Intel DVSEC offsets */
  15 #define INTEL_DVSEC_ENTRIES             0xA
  16 #define INTEL_DVSEC_SIZE                0xB
  17 #define INTEL_DVSEC_TABLE               0xC
  18 #define INTEL_DVSEC_TABLE_BAR(x)        ((x) & GENMASK(2, 0))
  19 #define INTEL_DVSEC_TABLE_OFFSET(x)     ((x) & GENMASK(31, 3))
  20 #define TABLE_OFFSET_SHIFT              3
  21
  22 struct pci_dev;
  23 struct resource;
  24
  25 enum intel_vsec_id {
  26         VSEC_ID_TELEMETRY       = 2,
  27         VSEC_ID_WATCHER         = 3,
  28         VSEC_ID_CRASHLOG        = 4,
  29         VSEC_ID_SDSI            = 65,
  30         VSEC_ID_TPMI            = 66,
  31 };
  32
  33 /**
  34  * struct intel_vsec_header - Common fields of Intel VSEC and DVSEC registers.
  35  * @rev:         Revision ID of the VSEC/DVSEC register space
  36  * @length:      Length of the VSEC/DVSEC register space
  37  * @id:          ID of the feature
  38  * @num_entries: Number of instances of the feature
  39  * @entry_size:  Size of the discovery table for each feature
  40  * @tbir:        BAR containing the discovery tables
  41  * @offset:      BAR offset of start of the first discovery table
  42  */
  43 struct intel_vsec_header {
  44         u8      rev;
  45         u16     length;
  46         u16     id;
  47         u8      num_entries;
  48         u8      entry_size;
  49         u8      tbir;
  50         u32     offset;
  51 };
  52
  53 enum intel_vsec_quirks {
  54         /* Watcher feature not supported */
  55         VSEC_QUIRK_NO_WATCHER   = BIT(0),
  56
  57         /* Crashlog feature not supported */
  58         VSEC_QUIRK_NO_CRASHLOG  = BIT(1),
  59
  60         /* Use shift instead of mask to read discovery table offset */
  61         VSEC_QUIRK_TABLE_SHIFT  = BIT(2),
  62
  63         /* DVSEC not present (provided in driver data) */
  64         VSEC_QUIRK_NO_DVSEC     = BIT(3),
  65
  66         /* Platforms requiring quirk in the auxiliary driver */
  67         VSEC_QUIRK_EARLY_HW     = BIT(4),
  68 };
  69
  70 /* Platform specific data */
  71 struct intel_vsec_platform_info {
  72         struct device *parent;
  73         struct intel_vsec_header **headers;
  74         unsigned long caps;
  75         unsigned long quirks;
  76         u64 base_addr;
  77 };
  78
  79 struct intel_vsec_device {
  80         struct auxiliary_device auxdev;
  81         struct pci_dev *pcidev;
  82         struct resource *resource;
  83         struct ida *ida;
  84         int num_resources;
  85         int id; /* xa */
  86         void *priv_data;
  87         size_t priv_data_size;
  88         unsigned long quirks;
  89         u64 base_addr;
  90 };
  91
  92 int intel_vsec_add_aux(struct pci_dev *pdev, struct device *parent,
  93                        struct intel_vsec_device *intel_vsec_dev,
  94                        const char *name);
  95
  96 static inline struct intel_vsec_device *dev_to_ivdev(struct device *dev)
  97 {
  98         return container_of(dev, struct intel_vsec_device, auxdev.dev);
  99 }
 100
 101 static inline struct intel_vsec_device *auxdev_to_ivdev(struct auxiliary_device *auxdev)
 102 {
 103         return container_of(auxdev, struct intel_vsec_device, auxdev);
 104 }
 105
 106 void intel_vsec_register(struct pci_dev *pdev,
 107                          struct intel_vsec_platform_info *info);
 108 #endif