include/linux/dmar.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (c) 2006, Intel Corporation.
   4  *
   5  * Copyright (C) Ashok Raj <[email protected]>
   6  * Copyright (C) Shaohua Li <[email protected]>
   7  */
   8
   9 #ifndef __DMAR_H__
  10 #define __DMAR_H__
  11
  12 #include <linux/acpi.h>
  13 #include <linux/types.h>
  14 #include <linux/msi.h>
  15 #include <linux/irqreturn.h>
  16 #include <linux/rwsem.h>
  17 #include <linux/rculist.h>
  18
  19 struct acpi_dmar_header;
  20
  21 #ifdef  CONFIG_X86
  22 # define        DMAR_UNITS_SUPPORTED    MAX_IO_APICS
  23 #else
  24 # define        DMAR_UNITS_SUPPORTED    64
  25 #endif
  26
  27 /* DMAR Flags */
  28 #define DMAR_INTR_REMAP         0x1
  29 #define DMAR_X2APIC_OPT_OUT     0x2
  30 #define DMAR_PLATFORM_OPT_IN    0x4
  31
  32 struct intel_iommu;
  33
  34 struct dmar_dev_scope {
  35         struct device __rcu *dev;
  36         u8 bus;
  37         u8 devfn;
  38 };
  39
  40 #ifdef CONFIG_DMAR_TABLE
  41 extern struct acpi_table_header *dmar_tbl;
  42 struct dmar_drhd_unit {
  43         struct list_head list;          /* list of drhd units   */
  44         struct  acpi_dmar_header *hdr;  /* ACPI header          */
  45         u64     reg_base_addr;          /* register base address*/
  46         struct  dmar_dev_scope *devices;/* target device array  */
  47         int     devices_cnt;            /* target device count  */
  48         u16     segment;                /* PCI domain           */
  49         u8      ignored:1;              /* ignore drhd          */
  50         u8      include_all:1;
  51         u8      gfx_dedicated:1;        /* graphic dedicated    */
  52         struct intel_iommu *iommu;
  53 };
  54
  55 struct dmar_pci_path {
  56         u8 bus;
  57         u8 device;
  58         u8 function;
  59 };
  60
  61 struct dmar_pci_notify_info {
  62         struct pci_dev                  *dev;
  63         unsigned long                   event;
  64         int                             bus;
  65         u16                             seg;
  66         u16                             level;
  67         struct dmar_pci_path            path[];
  68 }  __attribute__((packed));
  69
  70 extern struct rw_semaphore dmar_global_lock;
  71 extern struct list_head dmar_drhd_units;
  72
  73 #define for_each_drhd_unit(drhd)                                        \
  74         list_for_each_entry_rcu(drhd, &dmar_drhd_units, list,           \
  75                                 dmar_rcu_check())
  76
  77 #define for_each_active_drhd_unit(drhd)                                 \
  78         list_for_each_entry_rcu(drhd, &dmar_drhd_units, list,           \
  79                                 dmar_rcu_check())                       \
  80                 if (drhd->ignored) {} else
  81
  82 #define for_each_active_iommu(i, drhd)                                  \
  83         list_for_each_entry_rcu(drhd, &dmar_drhd_units, list,           \
  84                                 dmar_rcu_check())                       \
  85                 if (i=drhd->iommu, drhd->ignored) {} else
  86
  87 #define for_each_iommu(i, drhd)                                         \
  88         list_for_each_entry_rcu(drhd, &dmar_drhd_units, list,           \
  89                                 dmar_rcu_check())                       \
  90                 if (i=drhd->iommu, 0) {} else
  91
  92 static inline bool dmar_rcu_check(void)
  93 {
  94         return rwsem_is_locked(&dmar_global_lock) ||
  95                system_state == SYSTEM_BOOTING;
  96 }
  97
  98 #define dmar_rcu_dereference(p) rcu_dereference_check((p), dmar_rcu_check())
  99
 100 #define for_each_dev_scope(devs, cnt, i, tmp)                           \
 101         for ((i) = 0; ((tmp) = (i) < (cnt) ?                            \
 102             dmar_rcu_dereference((devs)[(i)].dev) : NULL, (i) < (cnt)); \
 103             (i)++)
 104
 105 #define for_each_active_dev_scope(devs, cnt, i, tmp)                    \
 106         for_each_dev_scope((devs), (cnt), (i), (tmp))                   \
 107                 if (!(tmp)) { continue; } else
 108
 109 extern int dmar_table_init(void);
 110 extern int dmar_dev_scope_init(void);
 111 extern void dmar_register_bus_notifier(void);
 112 extern int dmar_parse_dev_scope(void *start, void *end, int *cnt,
 113                                 struct dmar_dev_scope **devices, u16 segment);
 114 extern void *dmar_alloc_dev_scope(void *start, void *end, int *cnt);
 115 extern void dmar_free_dev_scope(struct dmar_dev_scope **devices, int *cnt);
 116 extern int dmar_insert_dev_scope(struct dmar_pci_notify_info *info,
 117                                  void *start, void*end, u16 segment,
 118                                  struct dmar_dev_scope *devices,
 119                                  int devices_cnt);
 120 extern int dmar_remove_dev_scope(struct dmar_pci_notify_info *info,
 121                                  u16 segment, struct dmar_dev_scope *devices,
 122                                  int count);
 123 /* Intel IOMMU detection */
 124 extern int detect_intel_iommu(void);
 125 extern int enable_drhd_fault_handling(void);
 126 extern int dmar_device_add(acpi_handle handle);
 127 extern int dmar_device_remove(acpi_handle handle);
 128
 129 static inline int dmar_res_noop(struct acpi_dmar_header *hdr, void *arg)
 130 {
 131         return 0;
 132 }
 133
 134 #ifdef CONFIG_DMAR_DEBUG
 135 void dmar_fault_dump_ptes(struct intel_iommu *iommu, u16 source_id,
 136                           unsigned long long addr, u32 pasid);
 137 #else
 138 static inline void dmar_fault_dump_ptes(struct intel_iommu *iommu, u16 source_id,
 139                                         unsigned long long addr, u32 pasid) {}
 140 #endif
 141
 142 #ifdef CONFIG_INTEL_IOMMU
 143 extern int iommu_detected, no_iommu;
 144 extern int intel_iommu_init(void);
 145 extern void intel_iommu_shutdown(void);
 146 extern int dmar_parse_one_rmrr(struct acpi_dmar_header *header, void *arg);
 147 extern int dmar_parse_one_atsr(struct acpi_dmar_header *header, void *arg);
 148 extern int dmar_check_one_atsr(struct acpi_dmar_header *hdr, void *arg);
 149 extern int dmar_parse_one_satc(struct acpi_dmar_header *hdr, void *arg);
 150 extern int dmar_release_one_atsr(struct acpi_dmar_header *hdr, void *arg);
 151 extern int dmar_iommu_hotplug(struct dmar_drhd_unit *dmaru, bool insert);
 152 extern int dmar_iommu_notify_scope_dev(struct dmar_pci_notify_info *info);
 153 #else /* !CONFIG_INTEL_IOMMU: */
 154 static inline int intel_iommu_init(void) { return -ENODEV; }
 155 static inline void intel_iommu_shutdown(void) { }
 156
 157 #define dmar_parse_one_rmrr             dmar_res_noop
 158 #define dmar_parse_one_atsr             dmar_res_noop
 159 #define dmar_check_one_atsr             dmar_res_noop
 160 #define dmar_release_one_atsr           dmar_res_noop
 161 #define dmar_parse_one_satc             dmar_res_noop
 162
 163 static inline int dmar_iommu_notify_scope_dev(struct dmar_pci_notify_info *info)
 164 {
 165         return 0;
 166 }
 167
 168 static inline int dmar_iommu_hotplug(struct dmar_drhd_unit *dmaru, bool insert)
 169 {
 170         return 0;
 171 }
 172 #endif /* CONFIG_INTEL_IOMMU */
 173
 174 #ifdef CONFIG_IRQ_REMAP
 175 extern int dmar_ir_hotplug(struct dmar_drhd_unit *dmaru, bool insert);
 176 #else  /* CONFIG_IRQ_REMAP */
 177 static inline int dmar_ir_hotplug(struct dmar_drhd_unit *dmaru, bool insert)
 178 { return 0; }
 179 #endif /* CONFIG_IRQ_REMAP */
 180
 181 extern bool dmar_platform_optin(void);
 182
 183 #else /* CONFIG_DMAR_TABLE */
 184
 185 static inline int dmar_device_add(void *handle)
 186 {
 187         return 0;
 188 }
 189
 190 static inline int dmar_device_remove(void *handle)
 191 {
 192         return 0;
 193 }
 194
 195 static inline bool dmar_platform_optin(void)
 196 {
 197         return false;
 198 }
 199
 200 #endif /* CONFIG_DMAR_TABLE */
 201
 202 struct irte {
 203         union {
 204                 /* Shared between remapped and posted mode*/
 205                 struct {
 206                         __u64   present         : 1,  /*  0      */
 207                                 fpd             : 1,  /*  1      */
 208                                 __res0          : 6,  /*  2 -  6 */
 209                                 avail           : 4,  /*  8 - 11 */
 210                                 __res1          : 3,  /* 12 - 14 */
 211                                 pst             : 1,  /* 15      */
 212                                 vector          : 8,  /* 16 - 23 */
 213                                 __res2          : 40; /* 24 - 63 */
 214                 };
 215
 216                 /* Remapped mode */
 217                 struct {
 218                         __u64   r_present       : 1,  /*  0      */
 219                                 r_fpd           : 1,  /*  1      */
 220                                 dst_mode        : 1,  /*  2      */
 221                                 redir_hint      : 1,  /*  3      */
 222                                 trigger_mode    : 1,  /*  4      */
 223                                 dlvry_mode      : 3,  /*  5 -  7 */
 224                                 r_avail         : 4,  /*  8 - 11 */
 225                                 r_res0          : 4,  /* 12 - 15 */
 226                                 r_vector        : 8,  /* 16 - 23 */
 227                                 r_res1          : 8,  /* 24 - 31 */
 228                                 dest_id         : 32; /* 32 - 63 */
 229                 };
 230
 231                 /* Posted mode */
 232                 struct {
 233                         __u64   p_present       : 1,  /*  0      */
 234                                 p_fpd           : 1,  /*  1      */
 235                                 p_res0          : 6,  /*  2 -  7 */
 236                                 p_avail         : 4,  /*  8 - 11 */
 237                                 p_res1          : 2,  /* 12 - 13 */
 238                                 p_urgent        : 1,  /* 14      */
 239                                 p_pst           : 1,  /* 15      */
 240                                 p_vector        : 8,  /* 16 - 23 */
 241                                 p_res2          : 14, /* 24 - 37 */
 242                                 pda_l           : 26; /* 38 - 63 */
 243                 };
 244                 __u64 low;
 245         };
 246
 247         union {
 248                 /* Shared between remapped and posted mode*/
 249                 struct {
 250                         __u64   sid             : 16,  /* 64 - 79  */
 251                                 sq              : 2,   /* 80 - 81  */
 252                                 svt             : 2,   /* 82 - 83  */
 253                                 __res3          : 44;  /* 84 - 127 */
 254                 };
 255
 256                 /* Posted mode*/
 257                 struct {
 258                         __u64   p_sid           : 16,  /* 64 - 79  */
 259                                 p_sq            : 2,   /* 80 - 81  */
 260                                 p_svt           : 2,   /* 82 - 83  */
 261                                 p_res3          : 12,  /* 84 - 95  */
 262                                 pda_h           : 32;  /* 96 - 127 */
 263                 };
 264                 __u64 high;
 265         };
 266 };
 267
 268 static inline void dmar_copy_shared_irte(struct irte *dst, struct irte *src)
 269 {
 270         dst->present    = src->present;
 271         dst->fpd        = src->fpd;
 272         dst->avail      = src->avail;
 273         dst->pst        = src->pst;
 274         dst->vector     = src->vector;
 275         dst->sid        = src->sid;
 276         dst->sq         = src->sq;
 277         dst->svt        = src->svt;
 278 }
 279
 280 #define PDA_LOW_BIT    26
 281 #define PDA_HIGH_BIT   32
 282
 283 /* Can't use the common MSI interrupt functions
 284  * since DMAR is not a pci device
 285  */
 286 struct irq_data;
 287 extern void dmar_msi_unmask(struct irq_data *data);
 288 extern void dmar_msi_mask(struct irq_data *data);
 289 extern void dmar_msi_read(int irq, struct msi_msg *msg);
 290 extern void dmar_msi_write(int irq, struct msi_msg *msg);
 291 extern int dmar_set_interrupt(struct intel_iommu *iommu);
 292 extern irqreturn_t dmar_fault(int irq, void *dev_id);
 293 extern int dmar_alloc_hwirq(int id, int node, void *arg);
 294 extern void dmar_free_hwirq(int irq);
 295
 296 #endif /* __DMAR_H__ */