arch/x86/include/asm/amd_iommu_types.h

   1 /*
   2  * Copyright (C) 2007-2009 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/list.h>
  25 #include <linux/spinlock.h>
  26
  27 /*
  28  * Maximum number of IOMMUs supported
  29  */
  30 #define MAX_IOMMUS      32
  31
  32 /*
  33  * some size calculation constants
  34  */
  35 #define DEV_TABLE_ENTRY_SIZE            32
  36 #define ALIAS_TABLE_ENTRY_SIZE          2
  37 #define RLOOKUP_TABLE_ENTRY_SIZE        (sizeof(void *))
  38
  39 /* Length of the MMIO region for the AMD IOMMU */
  40 #define MMIO_REGION_LENGTH       0x4000
  41
  42 /* Capability offsets used by the driver */
  43 #define MMIO_CAP_HDR_OFFSET     0x00
  44 #define MMIO_RANGE_OFFSET       0x0c
  45 #define MMIO_MISC_OFFSET        0x10
  46
  47 /* Masks, shifts and macros to parse the device range capability */
  48 #define MMIO_RANGE_LD_MASK      0xff000000
  49 #define MMIO_RANGE_FD_MASK      0x00ff0000
  50 #define MMIO_RANGE_BUS_MASK     0x0000ff00
  51 #define MMIO_RANGE_LD_SHIFT     24
  52 #define MMIO_RANGE_FD_SHIFT     16
  53 #define MMIO_RANGE_BUS_SHIFT    8
  54 #define MMIO_GET_LD(x)  (((x) & MMIO_RANGE_LD_MASK) >> MMIO_RANGE_LD_SHIFT)
  55 #define MMIO_GET_FD(x)  (((x) & MMIO_RANGE_FD_MASK) >> MMIO_RANGE_FD_SHIFT)
  56 #define MMIO_GET_BUS(x) (((x) & MMIO_RANGE_BUS_MASK) >> MMIO_RANGE_BUS_SHIFT)
  57 #define MMIO_MSI_NUM(x) ((x) & 0x1f)
  58
  59 /* Flag masks for the AMD IOMMU exclusion range */
  60 #define MMIO_EXCL_ENABLE_MASK 0x01ULL
  61 #define MMIO_EXCL_ALLOW_MASK  0x02ULL
  62
  63 /* Used offsets into the MMIO space */
  64 #define MMIO_DEV_TABLE_OFFSET   0x0000
  65 #define MMIO_CMD_BUF_OFFSET     0x0008
  66 #define MMIO_EVT_BUF_OFFSET     0x0010
  67 #define MMIO_CONTROL_OFFSET     0x0018
  68 #define MMIO_EXCL_BASE_OFFSET   0x0020
  69 #define MMIO_EXCL_LIMIT_OFFSET  0x0028
  70 #define MMIO_CMD_HEAD_OFFSET    0x2000
  71 #define MMIO_CMD_TAIL_OFFSET    0x2008
  72 #define MMIO_EVT_HEAD_OFFSET    0x2010
  73 #define MMIO_EVT_TAIL_OFFSET    0x2018
  74 #define MMIO_STATUS_OFFSET      0x2020
  75
  76 /* MMIO status bits */
  77 #define MMIO_STATUS_COM_WAIT_INT_MASK   0x04
  78
  79 /* event logging constants */
  80 #define EVENT_ENTRY_SIZE        0x10
  81 #define EVENT_TYPE_SHIFT        28
  82 #define EVENT_TYPE_MASK         0xf
  83 #define EVENT_TYPE_ILL_DEV      0x1
  84 #define EVENT_TYPE_IO_FAULT     0x2
  85 #define EVENT_TYPE_DEV_TAB_ERR  0x3
  86 #define EVENT_TYPE_PAGE_TAB_ERR 0x4
  87 #define EVENT_TYPE_ILL_CMD      0x5
  88 #define EVENT_TYPE_CMD_HARD_ERR 0x6
  89 #define EVENT_TYPE_IOTLB_INV_TO 0x7
  90 #define EVENT_TYPE_INV_DEV_REQ  0x8
  91 #define EVENT_DEVID_MASK        0xffff
  92 #define EVENT_DEVID_SHIFT       0
  93 #define EVENT_DOMID_MASK        0xffff
  94 #define EVENT_DOMID_SHIFT       0
  95 #define EVENT_FLAGS_MASK        0xfff
  96 #define EVENT_FLAGS_SHIFT       0x10
  97
  98 /* feature control bits */
  99 #define CONTROL_IOMMU_EN        0x00ULL
 100 #define CONTROL_HT_TUN_EN       0x01ULL
 101 #define CONTROL_EVT_LOG_EN      0x02ULL
 102 #define CONTROL_EVT_INT_EN      0x03ULL
 103 #define CONTROL_COMWAIT_EN      0x04ULL
 104 #define CONTROL_PASSPW_EN       0x08ULL
 105 #define CONTROL_RESPASSPW_EN    0x09ULL
 106 #define CONTROL_COHERENT_EN     0x0aULL
 107 #define CONTROL_ISOC_EN         0x0bULL
 108 #define CONTROL_CMDBUF_EN       0x0cULL
 109 #define CONTROL_PPFLOG_EN       0x0dULL
 110 #define CONTROL_PPFINT_EN       0x0eULL
 111
 112 /* command specific defines */
 113 #define CMD_COMPL_WAIT          0x01
 114 #define CMD_INV_DEV_ENTRY       0x02
 115 #define CMD_INV_IOMMU_PAGES     0x03
 116
 117 #define CMD_COMPL_WAIT_STORE_MASK       0x01
 118 #define CMD_COMPL_WAIT_INT_MASK         0x02
 119 #define CMD_INV_IOMMU_PAGES_SIZE_MASK   0x01
 120 #define CMD_INV_IOMMU_PAGES_PDE_MASK    0x02
 121
 122 #define CMD_INV_IOMMU_ALL_PAGES_ADDRESS 0x7fffffffffffffffULL
 123
 124 /* macros and definitions for device table entries */
 125 #define DEV_ENTRY_VALID         0x00
 126 #define DEV_ENTRY_TRANSLATION   0x01
 127 #define DEV_ENTRY_IR            0x3d
 128 #define DEV_ENTRY_IW            0x3e
 129 #define DEV_ENTRY_NO_PAGE_FAULT 0x62
 130 #define DEV_ENTRY_EX            0x67
 131 #define DEV_ENTRY_SYSMGT1       0x68
 132 #define DEV_ENTRY_SYSMGT2       0x69
 133 #define DEV_ENTRY_INIT_PASS     0xb8
 134 #define DEV_ENTRY_EINT_PASS     0xb9
 135 #define DEV_ENTRY_NMI_PASS      0xba
 136 #define DEV_ENTRY_LINT0_PASS    0xbe
 137 #define DEV_ENTRY_LINT1_PASS    0xbf
 138 #define DEV_ENTRY_MODE_MASK     0x07
 139 #define DEV_ENTRY_MODE_SHIFT    0x09
 140
 141 /* constants to configure the command buffer */
 142 #define CMD_BUFFER_SIZE    8192
 143 #define CMD_BUFFER_ENTRIES 512
 144 #define MMIO_CMD_SIZE_SHIFT 56
 145 #define MMIO_CMD_SIZE_512 (0x9ULL << MMIO_CMD_SIZE_SHIFT)
 146
 147 /* constants for event buffer handling */
 148 #define EVT_BUFFER_SIZE         8192 /* 512 entries */
 149 #define EVT_LEN_MASK            (0x9ULL << 56)
 150
 151 #define PAGE_MODE_NONE    0x00
 152 #define PAGE_MODE_1_LEVEL 0x01
 153 #define PAGE_MODE_2_LEVEL 0x02
 154 #define PAGE_MODE_3_LEVEL 0x03
 155 #define PAGE_MODE_4_LEVEL 0x04
 156 #define PAGE_MODE_5_LEVEL 0x05
 157 #define PAGE_MODE_6_LEVEL 0x06
 158
 159 #define PM_LEVEL_SHIFT(x)       (12 + ((x) * 9))
 160 #define PM_LEVEL_SIZE(x)        (((x) < 6) ? \
 161                                   ((1ULL << PM_LEVEL_SHIFT((x))) - 1): \
 162                                    (0xffffffffffffffffULL))
 163 #define PM_LEVEL_INDEX(x, a)    (((a) >> PM_LEVEL_SHIFT((x))) & 0x1ffULL)
 164 #define PM_LEVEL_ENC(x)         (((x) << 9) & 0xe00ULL)
 165 #define PM_LEVEL_PDE(x, a)      ((a) | PM_LEVEL_ENC((x)) | \
 166                                  IOMMU_PTE_P | IOMMU_PTE_IR | IOMMU_PTE_IW)
 167 #define PM_PTE_LEVEL(pte)       (((pte) >> 9) & 0x7ULL)
 168
 169 #define PM_MAP_4k               0
 170 #define PM_ADDR_MASK            0x000ffffffffff000ULL
 171 #define PM_MAP_MASK(lvl)        (PM_ADDR_MASK & \
 172                                 (~((1ULL << (12 + ((lvl) * 9))) - 1)))
 173 #define PM_ALIGNED(lvl, addr)   ((PM_MAP_MASK(lvl) & (addr)) == (addr))
 174
 175 /*
 176  * Returns the page table level to use for a given page size
 177  * Pagesize is expected to be a power-of-two
 178  */
 179 #define PAGE_SIZE_LEVEL(pagesize) \
 180                 ((__ffs(pagesize) - 12) / 9)
 181 /*
 182  * Returns the number of ptes to use for a given page size
 183  * Pagesize is expected to be a power-of-two
 184  */
 185 #define PAGE_SIZE_PTE_COUNT(pagesize) \
 186                 (1ULL << ((__ffs(pagesize) - 12) % 9))
 187
 188 /*
 189  * Aligns a given io-virtual address to a given page size
 190  * Pagesize is expected to be a power-of-two
 191  */
 192 #define PAGE_SIZE_ALIGN(address, pagesize) \
 193                 ((address) & ~((pagesize) - 1))
 194 /*
 195  * Creates an IOMMU PTE for an address an a given pagesize
 196  * The PTE has no permission bits set
 197  * Pagesize is expected to be a power-of-two larger than 4096
 198  */
 199 #define PAGE_SIZE_PTE(address, pagesize)                \
 200                 (((address) | ((pagesize) - 1)) &       \
 201                  (~(pagesize >> 1)) & PM_ADDR_MASK)
 202
 203 #define IOMMU_PTE_P  (1ULL << 0)
 204 #define IOMMU_PTE_TV (1ULL << 1)
 205 #define IOMMU_PTE_U  (1ULL << 59)
 206 #define IOMMU_PTE_FC (1ULL << 60)
 207 #define IOMMU_PTE_IR (1ULL << 61)
 208 #define IOMMU_PTE_IW (1ULL << 62)
 209
 210 #define IOMMU_PAGE_MASK (((1ULL << 52) - 1) & ~0xfffULL)
 211 #define IOMMU_PTE_PRESENT(pte) ((pte) & IOMMU_PTE_P)
 212 #define IOMMU_PTE_PAGE(pte) (phys_to_virt((pte) & IOMMU_PAGE_MASK))
 213 #define IOMMU_PTE_MODE(pte) (((pte) >> 9) & 0x07)
 214
 215 #define IOMMU_PROT_MASK 0x03
 216 #define IOMMU_PROT_IR 0x01
 217 #define IOMMU_PROT_IW 0x02
 218
 219 /* IOMMU capabilities */
 220 #define IOMMU_CAP_IOTLB   24
 221 #define IOMMU_CAP_NPCACHE 26
 222
 223 #define MAX_DOMAIN_ID 65536
 224
 225 /* FIXME: move this macro to <linux/pci.h> */
 226 #define PCI_BUS(x) (((x) >> 8) & 0xff)
 227
 228 /* Protection domain flags */
 229 #define PD_DMA_OPS_MASK         (1UL << 0) /* domain used for dma_ops */
 230 #define PD_DEFAULT_MASK         (1UL << 1) /* domain is a default dma_ops
 231                                               domain for an IOMMU */
 232 #define PD_PASSTHROUGH_MASK     (1UL << 2) /* domain has no page
 233                                               translation */
 234
 235 extern bool amd_iommu_dump;
 236 #define DUMP_printk(format, arg...)                                     \
 237         do {                                                            \
 238                 if (amd_iommu_dump)                                             \
 239                         printk(KERN_INFO "AMD-Vi: " format, ## arg);    \
 240         } while(0);
 241
 242 /* global flag if IOMMUs cache non-present entries */
 243 extern bool amd_iommu_np_cache;
 244
 245 /*
 246  * Make iterating over all IOMMUs easier
 247  */
 248 #define for_each_iommu(iommu) \
 249         list_for_each_entry((iommu), &amd_iommu_list, list)
 250 #define for_each_iommu_safe(iommu, next) \
 251         list_for_each_entry_safe((iommu), (next), &amd_iommu_list, list)
 252
 253 #define APERTURE_RANGE_SHIFT    27      /* 128 MB */
 254 #define APERTURE_RANGE_SIZE     (1ULL << APERTURE_RANGE_SHIFT)
 255 #define APERTURE_RANGE_PAGES    (APERTURE_RANGE_SIZE >> PAGE_SHIFT)
 256 #define APERTURE_MAX_RANGES     32      /* allows 4GB of DMA address space */
 257 #define APERTURE_RANGE_INDEX(a) ((a) >> APERTURE_RANGE_SHIFT)
 258 #define APERTURE_PAGE_INDEX(a)  (((a) >> 21) & 0x3fULL)
 259
 260 /*
 261  * This structure contains generic data for  IOMMU protection domains
 262  * independent of their use.
 263  */
 264 struct protection_domain {
 265         struct list_head list;  /* for list of all protection domains */
 266         struct list_head dev_list; /* List of all devices in this domain */
 267         spinlock_t lock;        /* mostly used to lock the page table*/
 268         u16 id;                 /* the domain id written to the device table */
 269         int mode;               /* paging mode (0-6 levels) */
 270         u64 *pt_root;           /* page table root pointer */
 271         unsigned long flags;    /* flags to find out type of domain */
 272         bool updated;           /* complete domain flush required */
 273         unsigned dev_cnt;       /* devices assigned to this domain */
 274         unsigned dev_iommu[MAX_IOMMUS]; /* per-IOMMU reference count */
 275         void *priv;             /* private data */
 276
 277 };
 278
 279 /*
 280  * This struct contains device specific data for the IOMMU
 281  */
 282 struct iommu_dev_data {
 283         struct list_head list;            /* For domain->dev_list */
 284         struct device *dev;               /* Device this data belong to */
 285         struct device *alias;             /* The Alias Device */
 286         struct protection_domain *domain; /* Domain the device is bound to */
 287         atomic_t bind;                    /* Domain attach reverent count */
 288 };
 289
 290 /*
 291  * For dynamic growth the aperture size is split into ranges of 128MB of
 292  * DMA address space each. This struct represents one such range.
 293  */
 294 struct aperture_range {
 295
 296         /* address allocation bitmap */
 297         unsigned long *bitmap;
 298
 299         /*
 300          * Array of PTE pages for the aperture. In this array we save all the
 301          * leaf pages of the domain page table used for the aperture. This way
 302          * we don't need to walk the page table to find a specific PTE. We can
 303          * just calculate its address in constant time.
 304          */
 305         u64 *pte_pages[64];
 306
 307         unsigned long offset;
 308 };
 309
 310 /*
 311  * Data container for a dma_ops specific protection domain
 312  */
 313 struct dma_ops_domain {
 314         struct list_head list;
 315
 316         /* generic protection domain information */
 317         struct protection_domain domain;
 318
 319         /* size of the aperture for the mappings */
 320         unsigned long aperture_size;
 321
 322         /* address we start to search for free addresses */
 323         unsigned long next_address;
 324
 325         /* address space relevant data */
 326         struct aperture_range *aperture[APERTURE_MAX_RANGES];
 327
 328         /* This will be set to true when TLB needs to be flushed */
 329         bool need_flush;
 330
 331         /*
 332          * if this is a preallocated domain, keep the device for which it was
 333          * preallocated in this variable
 334          */
 335         u16 target_dev;
 336 };
 337
 338 /*
 339  * Structure where we save information about one hardware AMD IOMMU in the
 340  * system.
 341  */
 342 struct amd_iommu {
 343         struct list_head list;
 344
 345         /* Index within the IOMMU array */
 346         int index;
 347
 348         /* locks the accesses to the hardware */
 349         spinlock_t lock;
 350
 351         /* Pointer to PCI device of this IOMMU */
 352         struct pci_dev *dev;
 353
 354         /* physical address of MMIO space */
 355         u64 mmio_phys;
 356         /* virtual address of MMIO space */
 357         u8 *mmio_base;
 358
 359         /* capabilities of that IOMMU read from ACPI */
 360         u32 cap;
 361
 362         /*
 363          * Capability pointer. There could be more than one IOMMU per PCI
 364          * device function if there are more than one AMD IOMMU capability
 365          * pointers.
 366          */
 367         u16 cap_ptr;
 368
 369         /* pci domain of this IOMMU */
 370         u16 pci_seg;
 371
 372         /* first device this IOMMU handles. read from PCI */
 373         u16 first_device;
 374         /* last device this IOMMU handles. read from PCI */
 375         u16 last_device;
 376
 377         /* start of exclusion range of that IOMMU */
 378         u64 exclusion_start;
 379         /* length of exclusion range of that IOMMU */
 380         u64 exclusion_length;
 381
 382         /* command buffer virtual address */
 383         u8 *cmd_buf;
 384         /* size of command buffer */
 385         u32 cmd_buf_size;
 386
 387         /* size of event buffer */
 388         u32 evt_buf_size;
 389         /* event buffer virtual address */
 390         u8 *evt_buf;
 391         /* MSI number for event interrupt */
 392         u16 evt_msi_num;
 393
 394         /* true if interrupts for this IOMMU are already enabled */
 395         bool int_enabled;
 396
 397         /* if one, we need to send a completion wait command */
 398         bool need_sync;
 399
 400         /* becomes true if a command buffer reset is running */
 401         bool reset_in_progress;
 402
 403         /* default dma_ops domain for that IOMMU */
 404         struct dma_ops_domain *default_dom;
 405 };
 406
 407 /*
 408  * List with all IOMMUs in the system. This list is not locked because it is
 409  * only written and read at driver initialization or suspend time
 410  */
 411 extern struct list_head amd_iommu_list;
 412
 413 /*
 414  * Array with pointers to each IOMMU struct
 415  * The indices are referenced in the protection domains
 416  */
 417 extern struct amd_iommu *amd_iommus[MAX_IOMMUS];
 418
 419 /* Number of IOMMUs present in the system */
 420 extern int amd_iommus_present;
 421
 422 /*
 423  * Declarations for the global list of all protection domains
 424  */
 425 extern spinlock_t amd_iommu_pd_lock;
 426 extern struct list_head amd_iommu_pd_list;
 427
 428 /*
 429  * Structure defining one entry in the device table
 430  */
 431 struct dev_table_entry {
 432         u32 data[8];
 433 };
 434
 435 /*
 436  * One entry for unity mappings parsed out of the ACPI table.
 437  */
 438 struct unity_map_entry {
 439         struct list_head list;
 440
 441         /* starting device id this entry is used for (including) */
 442         u16 devid_start;
 443         /* end device id this entry is used for (including) */
 444         u16 devid_end;
 445
 446         /* start address to unity map (including) */
 447         u64 address_start;
 448         /* end address to unity map (including) */
 449         u64 address_end;
 450
 451         /* required protection */
 452         int prot;
 453 };
 454
 455 /*
 456  * List of all unity mappings. It is not locked because as runtime it is only
 457  * read. It is created at ACPI table parsing time.
 458  */
 459 extern struct list_head amd_iommu_unity_map;
 460
 461 /*
 462  * Data structures for device handling
 463  */
 464
 465 /*
 466  * Device table used by hardware. Read and write accesses by software are
 467  * locked with the amd_iommu_pd_table lock.
 468  */
 469 extern struct dev_table_entry *amd_iommu_dev_table;
 470
 471 /*
 472  * Alias table to find requestor ids to device ids. Not locked because only
 473  * read on runtime.
 474  */
 475 extern u16 *amd_iommu_alias_table;
 476
 477 /*
 478  * Reverse lookup table to find the IOMMU which translates a specific device.
 479  */
 480 extern struct amd_iommu **amd_iommu_rlookup_table;
 481
 482 /* size of the dma_ops aperture as power of 2 */
 483 extern unsigned amd_iommu_aperture_order;
 484
 485 /* largest PCI device id we expect translation requests for */
 486 extern u16 amd_iommu_last_bdf;
 487
 488 /* allocation bitmap for domain ids */
 489 extern unsigned long *amd_iommu_pd_alloc_bitmap;
 490
 491 /*
 492  * If true, the addresses will be flushed on unmap time, not when
 493  * they are reused
 494  */
 495 extern bool amd_iommu_unmap_flush;
 496
 497 /* takes bus and device/function and returns the device id
 498  * FIXME: should that be in generic PCI code? */
 499 static inline u16 calc_devid(u8 bus, u8 devfn)
 500 {
 501         return (((u16)bus) << 8) | devfn;
 502 }
 503
 504 #ifdef CONFIG_AMD_IOMMU_STATS
 505
 506 struct __iommu_counter {
 507         char *name;
 508         struct dentry *dent;
 509         u64 value;
 510 };
 511
 512 #define DECLARE_STATS_COUNTER(nm) \
 513         static struct __iommu_counter nm = {    \
 514                 .name = #nm,                    \
 515         }
 516
 517 #define INC_STATS_COUNTER(name)         name.value += 1
 518 #define ADD_STATS_COUNTER(name, x)      name.value += (x)
 519 #define SUB_STATS_COUNTER(name, x)      name.value -= (x)
 520
 521 #else /* CONFIG_AMD_IOMMU_STATS */
 522
 523 #define DECLARE_STATS_COUNTER(name)
 524 #define INC_STATS_COUNTER(name)
 525 #define ADD_STATS_COUNTER(name, x)
 526 #define SUB_STATS_COUNTER(name, x)
 527
 528 #endif /* CONFIG_AMD_IOMMU_STATS */
 529
 530 #endif /* _ASM_X86_AMD_IOMMU_TYPES_H */