0f395501ab8ebc42fe64ca1efb52b6de65aed21f
[safe/jmp/linux-2.6] / include / asm-x86 / amd_iommu_types.h
1 /*
2  * Copyright (C) 2007-2008 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 __AMD_IOMMU_TYPES_H__
21 #define __AMD_IOMMU_TYPES_H__
22
23 #include <linux/types.h>
24 #include <linux/list.h>
25 #include <linux/spinlock.h>
26
27 /*
28  * some size calculation constants
29  */
30 #define DEV_TABLE_ENTRY_SIZE            256
31 #define ALIAS_TABLE_ENTRY_SIZE          2
32 #define RLOOKUP_TABLE_ENTRY_SIZE        (sizeof(void *))
33
34 /* helper macros */
35 #define LOW_U32(x) ((x) & ((1ULL << 32)-1))
36 #define HIGH_U32(x) (LOW_U32((x) >> 32))
37
38 /* Length of the MMIO region for the AMD IOMMU */
39 #define MMIO_REGION_LENGTH       0x4000
40
41 /* Capability offsets used by the driver */
42 #define MMIO_CAP_HDR_OFFSET     0x00
43 #define MMIO_RANGE_OFFSET       0x0c
44
45 /* Masks, shifts and macros to parse the device range capability */
46 #define MMIO_RANGE_LD_MASK      0xff000000
47 #define MMIO_RANGE_FD_MASK      0x00ff0000
48 #define MMIO_RANGE_BUS_MASK     0x0000ff00
49 #define MMIO_RANGE_LD_SHIFT     24
50 #define MMIO_RANGE_FD_SHIFT     16
51 #define MMIO_RANGE_BUS_SHIFT    8
52 #define MMIO_GET_LD(x)  (((x) & MMIO_RANGE_LD_MASK) >> MMIO_RANGE_LD_SHIFT)
53 #define MMIO_GET_FD(x)  (((x) & MMIO_RANGE_FD_MASK) >> MMIO_RANGE_FD_SHIFT)
54 #define MMIO_GET_BUS(x) (((x) & MMIO_RANGE_BUS_MASK) >> MMIO_RANGE_BUS_SHIFT)
55
56 /* Flag masks for the AMD IOMMU exclusion range */
57 #define MMIO_EXCL_ENABLE_MASK 0x01ULL
58 #define MMIO_EXCL_ALLOW_MASK  0x02ULL
59
60 /* Used offsets into the MMIO space */
61 #define MMIO_DEV_TABLE_OFFSET   0x0000
62 #define MMIO_CMD_BUF_OFFSET     0x0008
63 #define MMIO_EVT_BUF_OFFSET     0x0010
64 #define MMIO_CONTROL_OFFSET     0x0018
65 #define MMIO_EXCL_BASE_OFFSET   0x0020
66 #define MMIO_EXCL_LIMIT_OFFSET  0x0028
67 #define MMIO_CMD_HEAD_OFFSET    0x2000
68 #define MMIO_CMD_TAIL_OFFSET    0x2008
69 #define MMIO_EVT_HEAD_OFFSET    0x2010
70 #define MMIO_EVT_TAIL_OFFSET    0x2018
71 #define MMIO_STATUS_OFFSET      0x2020
72
73 /* feature control bits */
74 #define CONTROL_IOMMU_EN        0x00ULL
75 #define CONTROL_HT_TUN_EN       0x01ULL
76 #define CONTROL_EVT_LOG_EN      0x02ULL
77 #define CONTROL_EVT_INT_EN      0x03ULL
78 #define CONTROL_COMWAIT_EN      0x04ULL
79 #define CONTROL_PASSPW_EN       0x08ULL
80 #define CONTROL_RESPASSPW_EN    0x09ULL
81 #define CONTROL_COHERENT_EN     0x0aULL
82 #define CONTROL_ISOC_EN         0x0bULL
83 #define CONTROL_CMDBUF_EN       0x0cULL
84 #define CONTROL_PPFLOG_EN       0x0dULL
85 #define CONTROL_PPFINT_EN       0x0eULL
86
87 /* command specific defines */
88 #define CMD_COMPL_WAIT          0x01
89 #define CMD_INV_DEV_ENTRY       0x02
90 #define CMD_INV_IOMMU_PAGES     0x03
91
92 #define CMD_COMPL_WAIT_STORE_MASK       0x01
93 #define CMD_INV_IOMMU_PAGES_SIZE_MASK   0x01
94 #define CMD_INV_IOMMU_PAGES_PDE_MASK    0x02
95
96 /* macros and definitions for device table entries */
97 #define DEV_ENTRY_VALID         0x00
98 #define DEV_ENTRY_TRANSLATION   0x01
99 #define DEV_ENTRY_IR            0x3d
100 #define DEV_ENTRY_IW            0x3e
101 #define DEV_ENTRY_EX            0x67
102 #define DEV_ENTRY_SYSMGT1       0x68
103 #define DEV_ENTRY_SYSMGT2       0x69
104 #define DEV_ENTRY_INIT_PASS     0xb8
105 #define DEV_ENTRY_EINT_PASS     0xb9
106 #define DEV_ENTRY_NMI_PASS      0xba
107 #define DEV_ENTRY_LINT0_PASS    0xbe
108 #define DEV_ENTRY_LINT1_PASS    0xbf
109
110 /* constants to configure the command buffer */
111 #define CMD_BUFFER_SIZE    8192
112 #define CMD_BUFFER_ENTRIES 512
113 #define MMIO_CMD_SIZE_SHIFT 56
114 #define MMIO_CMD_SIZE_512 (0x9ULL << MMIO_CMD_SIZE_SHIFT)
115
116 #define PAGE_MODE_1_LEVEL 0x01
117 #define PAGE_MODE_2_LEVEL 0x02
118 #define PAGE_MODE_3_LEVEL 0x03
119
120 #define IOMMU_PDE_NL_0   0x000ULL
121 #define IOMMU_PDE_NL_1   0x200ULL
122 #define IOMMU_PDE_NL_2   0x400ULL
123 #define IOMMU_PDE_NL_3   0x600ULL
124
125 #define IOMMU_PTE_L2_INDEX(address) (((address) >> 30) & 0x1ffULL)
126 #define IOMMU_PTE_L1_INDEX(address) (((address) >> 21) & 0x1ffULL)
127 #define IOMMU_PTE_L0_INDEX(address) (((address) >> 12) & 0x1ffULL)
128
129 #define IOMMU_MAP_SIZE_L1 (1ULL << 21)
130 #define IOMMU_MAP_SIZE_L2 (1ULL << 30)
131 #define IOMMU_MAP_SIZE_L3 (1ULL << 39)
132
133 #define IOMMU_PTE_P  (1ULL << 0)
134 #define IOMMU_PTE_U  (1ULL << 59)
135 #define IOMMU_PTE_FC (1ULL << 60)
136 #define IOMMU_PTE_IR (1ULL << 61)
137 #define IOMMU_PTE_IW (1ULL << 62)
138
139 #define IOMMU_L1_PDE(address) \
140         ((address) | IOMMU_PDE_NL_1 | IOMMU_PTE_P | IOMMU_PTE_IR | IOMMU_PTE_IW)
141 #define IOMMU_L2_PDE(address) \
142         ((address) | IOMMU_PDE_NL_2 | IOMMU_PTE_P | IOMMU_PTE_IR | IOMMU_PTE_IW)
143
144 #define IOMMU_PAGE_MASK (((1ULL << 52) - 1) & ~0xfffULL)
145 #define IOMMU_PTE_PRESENT(pte) ((pte) & IOMMU_PTE_P)
146 #define IOMMU_PTE_PAGE(pte) (phys_to_virt((pte) & IOMMU_PAGE_MASK))
147 #define IOMMU_PTE_MODE(pte) (((pte) >> 9) & 0x07)
148
149 #define IOMMU_PROT_MASK 0x03
150 #define IOMMU_PROT_IR 0x01
151 #define IOMMU_PROT_IW 0x02
152
153 /* IOMMU capabilities */
154 #define IOMMU_CAP_IOTLB   24
155 #define IOMMU_CAP_NPCACHE 26
156
157 #define MAX_DOMAIN_ID 65536
158
159 struct protection_domain {
160         spinlock_t lock;
161         u16 id;
162         int mode;
163         u64 *pt_root;
164         void *priv;
165 };
166
167 struct dma_ops_domain {
168         struct list_head list;
169         struct protection_domain domain;
170         unsigned long aperture_size;
171         unsigned long next_bit;
172         unsigned long *bitmap;
173         u64 **pte_pages;
174 };
175
176 struct amd_iommu {
177         struct list_head list;
178         spinlock_t lock;
179
180         u16 devid;
181         u16 cap_ptr;
182
183         u64 mmio_phys;
184         u8 *mmio_base;
185         u32 cap;
186         u16 first_device;
187         u16 last_device;
188         u64 exclusion_start;
189         u64 exclusion_length;
190
191         u8 *cmd_buf;
192         u32 cmd_buf_size;
193
194         int need_sync;
195
196         struct dma_ops_domain *default_dom;
197 };
198
199 extern struct list_head amd_iommu_list;
200
201 struct dev_table_entry {
202         u32 data[8];
203 };
204
205 struct unity_map_entry {
206         struct list_head list;
207         u16 devid_start;
208         u16 devid_end;
209         u64 address_start;
210         u64 address_end;
211         int prot;
212 };
213
214 extern struct list_head amd_iommu_unity_map;
215
216 /* data structures for device handling */
217 extern struct dev_table_entry *amd_iommu_dev_table;
218 extern u16 *amd_iommu_alias_table;
219 extern struct amd_iommu **amd_iommu_rlookup_table;
220
221 extern unsigned amd_iommu_aperture_order;
222
223 extern u16 amd_iommu_last_bdf;
224
225 /* data structures for protection domain handling */
226 extern struct protection_domain **amd_iommu_pd_table;
227 extern unsigned long *amd_iommu_pd_alloc_bitmap;
228
229 extern int amd_iommu_isolate;
230
231 static inline void print_devid(u16 devid, int nl)
232 {
233         int bus = devid >> 8;
234         int dev = devid >> 3 & 0x1f;
235         int fn  = devid & 0x07;
236
237         printk("%02x:%02x.%x", bus, dev, fn);
238         if (nl)
239                 printk("\n");
240 }
241
242 #endif