drivers/iommu/amd_iommu_types.h

   1 /*
   2  * Copyright (C) 2007-2010 Advanced Micro Devices, Inc.
   3  * Author: Joerg Roedel <joerg.roedel@amd.com>
   4  *         Leo Duran <leo.duran@amd.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published
   8  * by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18  */
  19
  20 #ifndef _ASM_X86_AMD_IOMMU_TYPES_H
  21 #define _ASM_X86_AMD_IOMMU_TYPES_H
  22
  23 #include <linux/types.h>
  24 #include <linux/mutex.h>
  25 #include <linux/list.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/pci.h>
  28
  29 /*
  30  * Maximum number of IOMMUs supported
  31  */
  32 #define MAX_IOMMUS      32
  33
  34 /*
  35  * some size calculation constants
  36  */
  37 #define DEV_TABLE_ENTRY_SIZE            32
  38 #define ALIAS_TABLE_ENTRY_SIZE          2
  39 #define RLOOKUP_TABLE_ENTRY_SIZE        (sizeof(void *))
  40
  41 /* Length of the MMIO region for the AMD IOMMU */
  42 #define MMIO_REGION_LENGTH       0x4000
  43
  44 /* Capability offsets used by the driver */
  45 #define MMIO_CAP_HDR_OFFSET     0x00
  46 #define MMIO_RANGE_OFFSET       0x0c
  47 #define MMIO_MISC_OFFSET        0x10
  48
  49 /* Masks, shifts and macros to parse the device range capability */
  50 #define MMIO_RANGE_LD_MASK      0xff000000
  51 #define MMIO_RANGE_FD_MASK      0x00ff0000
  52 #define MMIO_RANGE_BUS_MASK     0x0000ff00
  53 #define MMIO_RANGE_LD_SHIFT     24
  54 #define MMIO_RANGE_FD_SHIFT     16
  55 #define MMIO_RANGE_BUS_SHIFT    8
  56 #define MMIO_GET_LD(x)  (((x) & MMIO_RANGE_LD_MASK) >> MMIO_RANGE_LD_SHIFT)
  57 #define MMIO_GET_FD(x)  (((x) & MMIO_RANGE_FD_MASK) >> MMIO_RANGE_FD_SHIFT)
  58 #define MMIO_GET_BUS(x) (((x) & MMIO_RANGE_BUS_MASK) >> MMIO_RANGE_BUS_SHIFT)
  59 #define MMIO_MSI_NUM(x) ((x) & 0x1f)
  60
  61 /* Flag masks for the AMD IOMMU exclusion range */
  62 #define MMIO_EXCL_ENABLE_MASK 0x01ULL
  63 #define MMIO_EXCL_ALLOW_MASK  0x02ULL
  64
  65 /* Used offsets into the MMIO space */
  66 #define MMIO_DEV_TABLE_OFFSET   0x0000
  67 #define MMIO_CMD_BUF_OFFSET     0x0008
  68 #define MMIO_EVT_BUF_OFFSET     0x0010
  69 #define MMIO_CONTROL_OFFSET     0x0018
  70 #define MMIO_EXCL_BASE_OFFSET   0x0020
  71 #define MMIO_EXCL_LIMIT_OFFSET  0x0028
  72 #define MMIO_EXT_FEATURES       0x0030
  73 #define MMIO_PPR_LOG_OFFSET     0x0038
  74 #define MMIO_CMD_HEAD_OFFSET    0x2000
  75 #define MMIO_CMD_TAIL_OFFSET    0x2008
  76 #define MMIO_EVT_HEAD_OFFSET    0x2010
  77 #define MMIO_EVT_TAIL_OFFSET    0x2018
  78 #define MMIO_STATUS_OFFSET      0x2020
  79 #define MMIO_PPR_HEAD_OFFSET    0x2030
  80 #define MMIO_PPR_TAIL_OFFSET    0x2038
  81
  82
  83 /* Extended Feature Bits */
  84 #define FEATURE_PREFETCH        (1ULL<<0)
  85 #define FEATURE_PPR             (1ULL<<1)
  86 #define FEATURE_X2APIC          (1ULL<<2)
  87 #define FEATURE_NX              (1ULL<<3)
  88 #define FEATURE_GT              (1ULL<<4)
  89 #define FEATURE_IA              (1ULL<<6)
  90 #define FEATURE_GA              (1ULL<<7)
  91 #define FEATURE_HE              (1ULL<<8)
  92 #define FEATURE_PC              (1ULL<<9)
  93
  94 #define FEATURE_PASID_SHIFT     32
  95 #define FEATURE_PASID_MASK      (0x1fULL << FEATURE_PASID_SHIFT)
  96
  97 #define FEATURE_GLXVAL_SHIFT    14
  98 #define FEATURE_GLXVAL_MASK     (0x03ULL << FEATURE_GLXVAL_SHIFT)
  99
 100 #define PASID_MASK              0x000fffff
 101
 102 /* MMIO status bits */
 103 #define MMIO_STATUS_COM_WAIT_INT_MASK   (1 << 2)
 104 #define MMIO_STATUS_PPR_INT_MASK        (1 << 6)
 105
 106 /* event logging constants */
 107 #define EVENT_ENTRY_SIZE        0x10
 108 #define EVENT_TYPE_SHIFT        28
 109 #define EVENT_TYPE_MASK         0xf
 110 #define EVENT_TYPE_ILL_DEV      0x1
 111 #define EVENT_TYPE_IO_FAULT     0x2
 112 #define EVENT_TYPE_DEV_TAB_ERR  0x3
 113 #define EVENT_TYPE_PAGE_TAB_ERR 0x4
 114 #define EVENT_TYPE_ILL_CMD      0x5
 115 #define EVENT_TYPE_CMD_HARD_ERR 0x6
 116 #define EVENT_TYPE_IOTLB_INV_TO 0x7
 117 #define EVENT_TYPE_INV_DEV_REQ  0x8
 118 #define EVENT_DEVID_MASK        0xffff
 119 #define EVENT_DEVID_SHIFT       0
 120 #define EVENT_DOMID_MASK        0xffff
 121 #define EVENT_DOMID_SHIFT       0
 122 #define EVENT_FLAGS_MASK        0xfff
 123 #define EVENT_FLAGS_SHIFT       0x10
 124
 125 /* feature control bits */
 126 #define CONTROL_IOMMU_EN        0x00ULL
 127 #define CONTROL_HT_TUN_EN       0x01ULL
 128 #define CONTROL_EVT_LOG_EN      0x02ULL
 129 #define CONTROL_EVT_INT_EN      0x03ULL
 130 #define CONTROL_COMWAIT_EN      0x04ULL
 131 #define CONTROL_INV_TIMEOUT     0x05ULL
 132 #define CONTROL_PASSPW_EN       0x08ULL
 133 #define CONTROL_RESPASSPW_EN    0x09ULL
 134 #define CONTROL_COHERENT_EN     0x0aULL
 135 #define CONTROL_ISOC_EN         0x0bULL
 136 #define CONTROL_CMDBUF_EN       0x0cULL
 137 #define CONTROL_PPFLOG_EN       0x0dULL
 138 #define CONTROL_PPFINT_EN       0x0eULL
 139 #define CONTROL_PPR_EN          0x0fULL
 140 #define CONTROL_GT_EN           0x10ULL
 141
 142 #define CTRL_INV_TO_MASK        (7 << CONTROL_INV_TIMEOUT)
 143 #define CTRL_INV_TO_NONE        0
 144 #define CTRL_INV_TO_1MS         1
 145 #define CTRL_INV_TO_10MS        2
 146 #define CTRL_INV_TO_100MS       3
 147 #define CTRL_INV_TO_1S          4
 148 #define CTRL_INV_TO_10S         5
 149 #define CTRL_INV_TO_100S        6
 150
 151 /* command specific defines */
 152 #define CMD_COMPL_WAIT          0x01
 153 #define CMD_INV_DEV_ENTRY       0x02
 154 #define CMD_INV_IOMMU_PAGES     0x03
 155 #define CMD_INV_IOTLB_PAGES     0x04
 156 #define CMD_INV_IRT             0x05
 157 #define CMD_COMPLETE_PPR        0x07
 158 #define CMD_INV_ALL             0x08
 159
 160 #define CMD_COMPL_WAIT_STORE_MASK       0x01
 161 #define CMD_COMPL_WAIT_INT_MASK         0x02
 162 #define CMD_INV_IOMMU_PAGES_SIZE_MASK   0x01
 163 #define CMD_INV_IOMMU_PAGES_PDE_MASK    0x02
 164 #define CMD_INV_IOMMU_PAGES_GN_MASK     0x04
 165
 166 #define PPR_STATUS_MASK                 0xf
 167 #define PPR_STATUS_SHIFT                12
 168
 169 #define CMD_INV_IOMMU_ALL_PAGES_ADDRESS 0x7fffffffffffffffULL
 170
 171 /* macros and definitions for device table entries */
 172 #define DEV_ENTRY_VALID         0x00
 173 #define DEV_ENTRY_TRANSLATION   0x01
 174 #define DEV_ENTRY_IR            0x3d
 175 #define DEV_ENTRY_IW            0x3e
 176 #define DEV_ENTRY_NO_PAGE_FAULT 0x62
 177 #define DEV_ENTRY_EX            0x67
 178 #define DEV_ENTRY_SYSMGT1       0x68
 179 #define DEV_ENTRY_SYSMGT2       0x69
 180 #define DEV_ENTRY_IRQ_TBL_EN    0x80
 181 #define DEV_ENTRY_INIT_PASS     0xb8
 182 #define DEV_ENTRY_EINT_PASS     0xb9
 183 #define DEV_ENTRY_NMI_PASS      0xba
 184 #define DEV_ENTRY_LINT0_PASS    0xbe
 185 #define DEV_ENTRY_LINT1_PASS    0xbf
 186 #define DEV_ENTRY_MODE_MASK     0x07
 187 #define DEV_ENTRY_MODE_SHIFT    0x09
 188
 189 #define MAX_DEV_TABLE_ENTRIES   0xffff
 190
 191 /* constants to configure the command buffer */
 192 #define CMD_BUFFER_SIZE    8192
 193 #define CMD_BUFFER_UNINITIALIZED 1
 194 #define CMD_BUFFER_ENTRIES 512
 195 #define MMIO_CMD_SIZE_SHIFT 56
 196 #define MMIO_CMD_SIZE_512 (0x9ULL << MMIO_CMD_SIZE_SHIFT)
 197
 198 /* constants for event buffer handling */
 199 #define EVT_BUFFER_SIZE         8192 /* 512 entries */
 200 #define EVT_LEN_MASK            (0x9ULL << 56)
 201
 202 /* Constants for PPR Log handling */
 203 #define PPR_LOG_ENTRIES         512
 204 #define PPR_LOG_SIZE_SHIFT      56
 205 #define PPR_LOG_SIZE_512        (0x9ULL << PPR_LOG_SIZE_SHIFT)
 206 #define PPR_ENTRY_SIZE          16
 207 #define PPR_LOG_SIZE            (PPR_ENTRY_SIZE * PPR_LOG_ENTRIES)
 208
 209 #define PPR_REQ_TYPE(x)         (((x) >> 60) & 0xfULL)
 210 #define PPR_FLAGS(x)            (((x) >> 48) & 0xfffULL)
 211 #define PPR_DEVID(x)            ((x) & 0xffffULL)
 212 #define PPR_TAG(x)              (((x) >> 32) & 0x3ffULL)
 213 #define PPR_PASID1(x)           (((x) >> 16) & 0xffffULL)
 214 #define PPR_PASID2(x)           (((x) >> 42) & 0xfULL)
 215 #define PPR_PASID(x)            ((PPR_PASID2(x) << 16) | PPR_PASID1(x))
 216
 217 #define PPR_REQ_FAULT           0x01
 218
 219 #define PAGE_MODE_NONE    0x00
 220 #define PAGE_MODE_1_LEVEL 0x01
 221 #define PAGE_MODE_2_LEVEL 0x02
 222 #define PAGE_MODE_3_LEVEL 0x03
 223 #define PAGE_MODE_4_LEVEL 0x04
 224 #define PAGE_MODE_5_LEVEL 0x05
 225 #define PAGE_MODE_6_LEVEL 0x06
 226
 227 #define PM_LEVEL_SHIFT(x)       (12 + ((x) * 9))
 228 #define PM_LEVEL_SIZE(x)        (((x) < 6) ? \
 229                                   ((1ULL << PM_LEVEL_SHIFT((x))) - 1): \
 230                                    (0xffffffffffffffffULL))
 231 #define PM_LEVEL_INDEX(x, a)    (((a) >> PM_LEVEL_SHIFT((x))) & 0x1ffULL)
 232 #define PM_LEVEL_ENC(x)         (((x) << 9) & 0xe00ULL)
 233 #define PM_LEVEL_PDE(x, a)      ((a) | PM_LEVEL_ENC((x)) | \
 234                                  IOMMU_PTE_P | IOMMU_PTE_IR | IOMMU_PTE_IW)
 235 #define PM_PTE_LEVEL(pte)       (((pte) >> 9) & 0x7ULL)
 236
 237 #define PM_MAP_4k               0
 238 #define PM_ADDR_MASK            0x000ffffffffff000ULL
 239 #define PM_MAP_MASK(lvl)        (PM_ADDR_MASK & \
 240                                 (~((1ULL << (12 + ((lvl) * 9))) - 1)))
 241 #define PM_ALIGNED(lvl, addr)   ((PM_MAP_MASK(lvl) & (addr)) == (addr))
 242
 243 /*
 244  * Returns the page table level to use for a given page size
 245  * Pagesize is expected to be a power-of-two
 246  */
 247 #define PAGE_SIZE_LEVEL(pagesize) \
 248                 ((__ffs(pagesize) - 12) / 9)
 249 /*
 250  * Returns the number of ptes to use for a given page size
 251  * Pagesize is expected to be a power-of-two
 252  */
 253 #define PAGE_SIZE_PTE_COUNT(pagesize) \
 254                 (1ULL << ((__ffs(pagesize) - 12) % 9))
 255
 256 /*
 257  * Aligns a given io-virtual address to a given page size
 258  * Pagesize is expected to be a power-of-two
 259  */
 260 #define PAGE_SIZE_ALIGN(address, pagesize) \
 261                 ((address) & ~((pagesize) - 1))
 262 /*
 263  * Creates an IOMMU PTE for an address and a given pagesize
 264  * The PTE has no permission bits set
 265  * Pagesize is expected to be a power-of-two larger than 4096
 266  */
 267 #define PAGE_SIZE_PTE(address, pagesize)                \
 268                 (((address) | ((pagesize) - 1)) &       \
 269                  (~(pagesize >> 1)) & PM_ADDR_MASK)
 270
 271 /*
 272  * Takes a PTE value with mode=0x07 and returns the page size it maps
 273  */
 274 #define PTE_PAGE_SIZE(pte) \
 275         (1ULL << (1 + ffz(((pte) | 0xfffULL))))
 276
 277 #define IOMMU_PTE_P  (1ULL << 0)
 278 #define IOMMU_PTE_TV (1ULL << 1)
 279 #define IOMMU_PTE_U  (1ULL << 59)
 280 #define IOMMU_PTE_FC (1ULL << 60)
 281 #define IOMMU_PTE_IR (1ULL << 61)
 282 #define IOMMU_PTE_IW (1ULL << 62)
 283
 284 #define DTE_FLAG_IOTLB  (0x01UL << 32)
 285 #define DTE_FLAG_GV     (0x01ULL << 55)
 286 #define DTE_GLX_SHIFT   (56)
 287 #define DTE_GLX_MASK    (3)
 288
 289 #define DTE_GCR3_VAL_A(x)       (((x) >> 12) & 0x00007ULL)
 290 #define DTE_GCR3_VAL_B(x)       (((x) >> 15) & 0x0ffffULL)
 291 #define DTE_GCR3_VAL_C(x)       (((x) >> 31) & 0xfffffULL)
 292
 293 #define DTE_GCR3_INDEX_A        0
 294 #define DTE_GCR3_INDEX_B        1
 295 #define DTE_GCR3_INDEX_C        1
 296
 297 #define DTE_GCR3_SHIFT_A        58
 298 #define DTE_GCR3_SHIFT_B        16
 299 #define DTE_GCR3_SHIFT_C        43
 300
 301 #define GCR3_VALID              0x01ULL
 302
 303 #define IOMMU_PAGE_MASK (((1ULL << 52) - 1) & ~0xfffULL)
 304 #define IOMMU_PTE_PRESENT(pte) ((pte) & IOMMU_PTE_P)
 305 #define IOMMU_PTE_PAGE(pte) (phys_to_virt((pte) & IOMMU_PAGE_MASK))
 306 #define IOMMU_PTE_MODE(pte) (((pte) >> 9) & 0x07)
 307
 308 #define IOMMU_PROT_MASK 0x03
 309 #define IOMMU_PROT_IR 0x01
 310 #define IOMMU_PROT_IW 0x02
 311
 312 /* IOMMU capabilities */
 313 #define IOMMU_CAP_IOTLB   24
 314 #define IOMMU_CAP_NPCACHE 26
 315 #define IOMMU_CAP_EFR     27
 316
 317 #define MAX_DOMAIN_ID 65536
 318
 319 /* Protection domain flags */
 320 #define PD_DMA_OPS_MASK         (1UL << 0) /* domain used for dma_ops */
 321 #define PD_DEFAULT_MASK         (1UL << 1) /* domain is a default dma_ops
 322                                               domain for an IOMMU */
 323 #define PD_PASSTHROUGH_MASK     (1UL << 2) /* domain has no page
 324                                               translation */
 325 #define PD_IOMMUV2_MASK         (1UL << 3) /* domain has gcr3 table */
 326
 327 extern bool amd_iommu_dump;
 328 #define DUMP_printk(format, arg...)                                     \
 329         do {                                                            \
 330                 if (amd_iommu_dump)                                             \
 331                         printk(KERN_INFO "AMD-Vi: " format, ## arg);    \
 332         } while(0);
 333
 334 /* global flag if IOMMUs cache non-present entries */
 335 extern bool amd_iommu_np_cache;
 336 /* Only true if all IOMMUs support device IOTLBs */
 337 extern bool amd_iommu_iotlb_sup;
 338
 339 #define MAX_IRQS_PER_TABLE      256
 340 #define IRQ_TABLE_ALIGNMENT     128
 341
 342 struct irq_remap_table {
 343         spinlock_t lock;
 344         unsigned min_index;
 345         u32 *table;
 346 };
 347
 348 extern struct irq_remap_table **irq_lookup_table;
 349
 350 /* Interrupt remapping feature used? */
 351 extern bool amd_iommu_irq_remap;
 352
 353 /* kmem_cache to get tables with 128 byte alignement */
 354 extern struct kmem_cache *amd_iommu_irq_cache;
 355
 356 /*
 357  * Make iterating over all IOMMUs easier
 358  */
 359 #define for_each_iommu(iommu) \
 360         list_for_each_entry((iommu), &amd_iommu_list, list)
 361 #define for_each_iommu_safe(iommu, next) \
 362         list_for_each_entry_safe((iommu), (next), &amd_iommu_list, list)
 363
 364 #define APERTURE_RANGE_SHIFT    27      /* 128 MB */
 365 #define APERTURE_RANGE_SIZE     (1ULL << APERTURE_RANGE_SHIFT)
 366 #define APERTURE_RANGE_PAGES    (APERTURE_RANGE_SIZE >> PAGE_SHIFT)
 367 #define APERTURE_MAX_RANGES     32      /* allows 4GB of DMA address space */
 368 #define APERTURE_RANGE_INDEX(a) ((a) >> APERTURE_RANGE_SHIFT)
 369 #define APERTURE_PAGE_INDEX(a)  (((a) >> 21) & 0x3fULL)
 370
 371
 372 /*
 373  * This struct is used to pass information about
 374  * incoming PPR faults around.
 375  */
 376 struct amd_iommu_fault {
 377         u64 address;    /* IO virtual address of the fault*/
 378         u32 pasid;      /* Address space identifier */
 379         u16 device_id;  /* Originating PCI device id */
 380         u16 tag;        /* PPR tag */
 381         u16 flags;      /* Fault flags */
 382
 383 };
 384
 385 #define PPR_FAULT_EXEC  (1 << 1)
 386 #define PPR_FAULT_READ  (1 << 2)
 387 #define PPR_FAULT_WRITE (1 << 5)
 388 #define PPR_FAULT_USER  (1 << 6)
 389 #define PPR_FAULT_RSVD  (1 << 7)
 390 #define PPR_FAULT_GN    (1 << 8)
 391
 392 struct iommu_domain;
 393
 394 /*
 395  * This structure contains generic data for  IOMMU protection domains
 396  * independent of their use.
 397  */
 398 struct protection_domain {
 399         struct list_head list;  /* for list of all protection domains */
 400         struct list_head dev_list; /* List of all devices in this domain */
 401         spinlock_t lock;        /* mostly used to lock the page table*/
 402         struct mutex api_lock;  /* protect page tables in the iommu-api path */
 403         u16 id;                 /* the domain id written to the device table */
 404         int mode;               /* paging mode (0-6 levels) */
 405         u64 *pt_root;           /* page table root pointer */
 406         int glx;                /* Number of levels for GCR3 table */
 407         u64 *gcr3_tbl;          /* Guest CR3 table */
 408         unsigned long flags;    /* flags to find out type of domain */
 409         bool updated;           /* complete domain flush required */
 410         unsigned dev_cnt;       /* devices assigned to this domain */
 411         unsigned dev_iommu[MAX_IOMMUS]; /* per-IOMMU reference count */
 412         void *priv;             /* private data */
 413         struct iommu_domain *iommu_domain; /* Pointer to generic
 414                                               domain structure */
 415
 416 };
 417
 418 /*
 419  * This struct contains device specific data for the IOMMU
 420  */
 421 struct iommu_dev_data {
 422         struct list_head list;            /* For domain->dev_list */
 423         struct list_head dev_data_list;   /* For global dev_data_list */
 424         struct iommu_dev_data *alias_data;/* The alias dev_data */
 425         struct protection_domain *domain; /* Domain the device is bound to */
 426         atomic_t bind;                    /* Domain attach reference count */
 427         struct iommu_group *group;        /* IOMMU group for virtual aliases */
 428         u16 devid;                        /* PCI Device ID */
 429         bool iommu_v2;                    /* Device can make use of IOMMUv2 */
 430         bool passthrough;                 /* Default for device is pt_domain */
 431         struct {
 432                 bool enabled;
 433                 int qdep;
 434         } ats;                            /* ATS state */
 435         bool pri_tlp;                     /* PASID TLB required for
 436                                              PPR completions */
 437         u32 errata;                       /* Bitmap for errata to apply */
 438 };
 439
 440 /*
 441  * For dynamic growth the aperture size is split into ranges of 128MB of
 442  * DMA address space each. This struct represents one such range.
 443  */
 444 struct aperture_range {
 445
 446         /* address allocation bitmap */
 447         unsigned long *bitmap;
 448
 449         /*
 450          * Array of PTE pages for the aperture. In this array we save all the
 451          * leaf pages of the domain page table used for the aperture. This way
 452          * we don't need to walk the page table to find a specific PTE. We can
 453          * just calculate its address in constant time.
 454          */
 455         u64 *pte_pages[64];
 456
 457         unsigned long offset;
 458 };
 459
 460 /*
 461  * Data container for a dma_ops specific protection domain
 462  */
 463 struct dma_ops_domain {
 464         struct list_head list;
 465
 466         /* generic protection domain information */
 467         struct protection_domain domain;
 468
 469         /* size of the aperture for the mappings */
 470         unsigned long aperture_size;
 471
 472         /* address we start to search for free addresses */
 473         unsigned long next_address;
 474
 475         /* address space relevant data */
 476         struct aperture_range *aperture[APERTURE_MAX_RANGES];
 477
 478         /* This will be set to true when TLB needs to be flushed */
 479         bool need_flush;
 480
 481         /*
 482          * if this is a preallocated domain, keep the device for which it was
 483          * preallocated in this variable
 484          */
 485         u16 target_dev;
 486 };
 487
 488 /*
 489  * Structure where we save information about one hardware AMD IOMMU in the
 490  * system.
 491  */
 492 struct amd_iommu {
 493         struct list_head list;
 494
 495         /* Index within the IOMMU array */
 496         int index;
 497
 498         /* locks the accesses to the hardware */
 499         spinlock_t lock;
 500
 501         /* Pointer to PCI device of this IOMMU */
 502         struct pci_dev *dev;
 503
 504         /* Cache pdev to root device for resume quirks */
 505         struct pci_dev *root_pdev;
 506
 507         /* physical address of MMIO space */
 508         u64 mmio_phys;
 509         /* virtual address of MMIO space */
 510         u8 __iomem *mmio_base;
 511
 512         /* capabilities of that IOMMU read from ACPI */
 513         u32 cap;
 514
 515         /* flags read from acpi table */
 516         u8 acpi_flags;
 517
 518         /* Extended features */
 519         u64 features;
 520
 521         /* IOMMUv2 */
 522         bool is_iommu_v2;
 523
 524         /* PCI device id of the IOMMU device */
 525         u16 devid;
 526
 527         /*
 528          * Capability pointer. There could be more than one IOMMU per PCI
 529          * device function if there are more than one AMD IOMMU capability
 530          * pointers.
 531          */
 532         u16 cap_ptr;
 533
 534         /* pci domain of this IOMMU */
 535         u16 pci_seg;
 536
 537         /* first device this IOMMU handles. read from PCI */
 538         u16 first_device;
 539         /* last device this IOMMU handles. read from PCI */
 540         u16 last_device;
 541
 542         /* start of exclusion range of that IOMMU */
 543         u64 exclusion_start;
 544         /* length of exclusion range of that IOMMU */
 545         u64 exclusion_length;
 546
 547         /* command buffer virtual address */
 548         u8 *cmd_buf;
 549         /* size of command buffer */
 550         u32 cmd_buf_size;
 551
 552         /* size of event buffer */
 553         u32 evt_buf_size;
 554         /* event buffer virtual address */
 555         u8 *evt_buf;
 556
 557         /* Base of the PPR log, if present */
 558         u8 *ppr_log;
 559
 560         /* true if interrupts for this IOMMU are already enabled */
 561         bool int_enabled;
 562
 563         /* if one, we need to send a completion wait command */
 564         bool need_sync;
 565
 566         /* default dma_ops domain for that IOMMU */
 567         struct dma_ops_domain *default_dom;
 568
 569         /*
 570          * We can't rely on the BIOS to restore all values on reinit, so we
 571          * need to stash them
 572          */
 573
 574         /* The iommu BAR */
 575         u32 stored_addr_lo;
 576         u32 stored_addr_hi;
 577
 578         /*
 579          * Each iommu has 6 l1s, each of which is documented as having 0x12
 580          * registers
 581          */
 582         u32 stored_l1[6][0x12];
 583
 584         /* The l2 indirect registers */
 585         u32 stored_l2[0x83];
 586 };
 587
 588 struct devid_map {
 589         struct list_head list;
 590         u8 id;
 591         u16 devid;
 592 };
 593
 594 /* Map HPET and IOAPIC ids to the devid used by the IOMMU */
 595 extern struct list_head ioapic_map;
 596 extern struct list_head hpet_map;
 597
 598 /*
 599  * List with all IOMMUs in the system. This list is not locked because it is
 600  * only written and read at driver initialization or suspend time
 601  */
 602 extern struct list_head amd_iommu_list;
 603
 604 /*
 605  * Array with pointers to each IOMMU struct
 606  * The indices are referenced in the protection domains
 607  */
 608 extern struct amd_iommu *amd_iommus[MAX_IOMMUS];
 609
 610 /* Number of IOMMUs present in the system */
 611 extern int amd_iommus_present;
 612
 613 /*
 614  * Declarations for the global list of all protection domains
 615  */
 616 extern spinlock_t amd_iommu_pd_lock;
 617 extern struct list_head amd_iommu_pd_list;
 618
 619 /*
 620  * Structure defining one entry in the device table
 621  */
 622 struct dev_table_entry {
 623         u64 data[4];
 624 };
 625
 626 /*
 627  * One entry for unity mappings parsed out of the ACPI table.
 628  */
 629 struct unity_map_entry {
 630         struct list_head list;
 631
 632         /* starting device id this entry is used for (including) */
 633         u16 devid_start;
 634         /* end device id this entry is used for (including) */
 635         u16 devid_end;
 636
 637         /* start address to unity map (including) */
 638         u64 address_start;
 639         /* end address to unity map (including) */
 640         u64 address_end;
 641
 642         /* required protection */
 643         int prot;
 644 };
 645
 646 /*
 647  * List of all unity mappings. It is not locked because as runtime it is only
 648  * read. It is created at ACPI table parsing time.
 649  */
 650 extern struct list_head amd_iommu_unity_map;
 651
 652 /*
 653  * Data structures for device handling
 654  */
 655
 656 /*
 657  * Device table used by hardware. Read and write accesses by software are
 658  * locked with the amd_iommu_pd_table lock.
 659  */
 660 extern struct dev_table_entry *amd_iommu_dev_table;
 661
 662 /*
 663  * Alias table to find requestor ids to device ids. Not locked because only
 664  * read on runtime.
 665  */
 666 extern u16 *amd_iommu_alias_table;
 667
 668 /*
 669  * Reverse lookup table to find the IOMMU which translates a specific device.
 670  */
 671 extern struct amd_iommu **amd_iommu_rlookup_table;
 672
 673 /* size of the dma_ops aperture as power of 2 */
 674 extern unsigned amd_iommu_aperture_order;
 675
 676 /* largest PCI device id we expect translation requests for */
 677 extern u16 amd_iommu_last_bdf;
 678
 679 /* allocation bitmap for domain ids */
 680 extern unsigned long *amd_iommu_pd_alloc_bitmap;
 681
 682 /*
 683  * If true, the addresses will be flushed on unmap time, not when
 684  * they are reused
 685  */
 686 extern u32 amd_iommu_unmap_flush;
 687
 688 /* Smallest number of PASIDs supported by any IOMMU in the system */
 689 extern u32 amd_iommu_max_pasids;
 690
 691 extern bool amd_iommu_v2_present;
 692
 693 extern bool amd_iommu_force_isolation;
 694
 695 /* Max levels of glxval supported */
 696 extern int amd_iommu_max_glx_val;
 697
 698 /*
 699  * This function flushes all internal caches of
 700  * the IOMMU used by this driver.
 701  */
 702 extern void iommu_flush_all_caches(struct amd_iommu *iommu);
 703
 704 static inline int get_ioapic_devid(int id)
 705 {
 706         struct devid_map *entry;
 707
 708         list_for_each_entry(entry, &ioapic_map, list) {
 709                 if (entry->id == id)
 710                         return entry->devid;
 711         }
 712
 713         return -EINVAL;
 714 }
 715
 716 static inline int get_hpet_devid(int id)
 717 {
 718         struct devid_map *entry;
 719
 720         list_for_each_entry(entry, &hpet_map, list) {
 721                 if (entry->id == id)
 722                         return entry->devid;
 723         }
 724
 725         return -EINVAL;
 726 }
 727
 728 #ifdef CONFIG_AMD_IOMMU_STATS
 729
 730 struct __iommu_counter {
 731         char *name;
 732         struct dentry *dent;
 733         u64 value;
 734 };
 735
 736 #define DECLARE_STATS_COUNTER(nm) \
 737         static struct __iommu_counter nm = {    \
 738                 .name = #nm,                    \
 739         }
 740
 741 #define INC_STATS_COUNTER(name)         name.value += 1
 742 #define ADD_STATS_COUNTER(name, x)      name.value += (x)
 743 #define SUB_STATS_COUNTER(name, x)      name.value -= (x)
 744
 745 #else /* CONFIG_AMD_IOMMU_STATS */
 746
 747 #define DECLARE_STATS_COUNTER(name)
 748 #define INC_STATS_COUNTER(name)
 749 #define ADD_STATS_COUNTER(name, x)
 750 #define SUB_STATS_COUNTER(name, x)
 751
 752 #endif /* CONFIG_AMD_IOMMU_STATS */
 753
 754 #endif /* _ASM_X86_AMD_IOMMU_TYPES_H */