4755bbc7ae5b71796c364ff2c93e3a167d9730e2
[sfrench/cifs-2.6.git] / arch / x86 / kernel / amd_iommu.c
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 #include <linux/pci.h>
21 #include <linux/gfp.h>
22 #include <linux/bitops.h>
23 #include <linux/scatterlist.h>
24 #include <linux/iommu-helper.h>
25 #include <asm/proto.h>
26 #include <asm/iommu.h>
27 #include <asm/amd_iommu_types.h>
28 #include <asm/amd_iommu.h>
29
30 #define CMD_SET_TYPE(cmd, t) ((cmd)->data[1] |= ((t) << 28))
31
32 #define EXIT_LOOP_COUNT 10000000
33
34 static DEFINE_RWLOCK(amd_iommu_devtable_lock);
35
36 /* A list of preallocated protection domains */
37 static LIST_HEAD(iommu_pd_list);
38 static DEFINE_SPINLOCK(iommu_pd_list_lock);
39
40 /*
41  * general struct to manage commands send to an IOMMU
42  */
43 struct iommu_cmd {
44         u32 data[4];
45 };
46
47 static int dma_ops_unity_map(struct dma_ops_domain *dma_dom,
48                              struct unity_map_entry *e);
49
50 /* returns !0 if the IOMMU is caching non-present entries in its TLB */
51 static int iommu_has_npcache(struct amd_iommu *iommu)
52 {
53         return iommu->cap & (1UL << IOMMU_CAP_NPCACHE);
54 }
55
56 /****************************************************************************
57  *
58  * Interrupt handling functions
59  *
60  ****************************************************************************/
61
62 static void iommu_print_event(void *__evt)
63 {
64         u32 *event = __evt;
65         int type  = (event[1] >> EVENT_TYPE_SHIFT)  & EVENT_TYPE_MASK;
66         int devid = (event[0] >> EVENT_DEVID_SHIFT) & EVENT_DEVID_MASK;
67         int domid = (event[1] >> EVENT_DOMID_SHIFT) & EVENT_DOMID_MASK;
68         int flags = (event[1] >> EVENT_FLAGS_SHIFT) & EVENT_FLAGS_MASK;
69         u64 address = (u64)(((u64)event[3]) << 32) | event[2];
70
71         printk(KERN_ERR "AMD IOMMU: Event logged [");
72
73         switch (type) {
74         case EVENT_TYPE_ILL_DEV:
75                 printk("ILLEGAL_DEV_TABLE_ENTRY device=%02x:%02x.%x "
76                        "address=0x%016llx flags=0x%04x]\n",
77                        PCI_BUS(devid), PCI_SLOT(devid), PCI_FUNC(devid),
78                        address, flags);
79                 break;
80         case EVENT_TYPE_IO_FAULT:
81                 printk("IO_PAGE_FAULT device=%02x:%02x.%x "
82                        "domain=0x%04x address=0x%016llx flags=0x%04x]\n",
83                        PCI_BUS(devid), PCI_SLOT(devid), PCI_FUNC(devid),
84                        domid, address, flags);
85                 break;
86         case EVENT_TYPE_DEV_TAB_ERR:
87                 printk("DEV_TAB_HARDWARE_ERROR device=%02x:%02x.%x "
88                        "address=0x%016llx flags=0x%04x]\n",
89                        PCI_BUS(devid), PCI_SLOT(devid), PCI_FUNC(devid),
90                        address, flags);
91                 break;
92         case EVENT_TYPE_PAGE_TAB_ERR:
93                 printk("PAGE_TAB_HARDWARE_ERROR device=%02x:%02x.%x "
94                        "domain=0x%04x address=0x%016llx flags=0x%04x]\n",
95                        PCI_BUS(devid), PCI_SLOT(devid), PCI_FUNC(devid),
96                        domid, address, flags);
97                 break;
98         case EVENT_TYPE_ILL_CMD:
99                 printk("ILLEGAL_COMMAND_ERROR address=0x%016llx]\n", address);
100                 break;
101         case EVENT_TYPE_CMD_HARD_ERR:
102                 printk("COMMAND_HARDWARE_ERROR address=0x%016llx "
103                        "flags=0x%04x]\n", address, flags);
104                 break;
105         case EVENT_TYPE_IOTLB_INV_TO:
106                 printk("IOTLB_INV_TIMEOUT device=%02x:%02x.%x "
107                        "address=0x%016llx]\n",
108                        PCI_BUS(devid), PCI_SLOT(devid), PCI_FUNC(devid),
109                        address);
110                 break;
111         case EVENT_TYPE_INV_DEV_REQ:
112                 printk("INVALID_DEVICE_REQUEST device=%02x:%02x.%x "
113                        "address=0x%016llx flags=0x%04x]\n",
114                        PCI_BUS(devid), PCI_SLOT(devid), PCI_FUNC(devid),
115                        address, flags);
116                 break;
117         default:
118                 printk(KERN_ERR "UNKNOWN type=0x%02x]\n", type);
119         }
120 }
121
122 static void iommu_poll_events(struct amd_iommu *iommu)
123 {
124         u32 head, tail;
125         unsigned long flags;
126
127         spin_lock_irqsave(&iommu->lock, flags);
128
129         head = readl(iommu->mmio_base + MMIO_EVT_HEAD_OFFSET);
130         tail = readl(iommu->mmio_base + MMIO_EVT_TAIL_OFFSET);
131
132         while (head != tail) {
133                 iommu_print_event(iommu->evt_buf + head);
134                 head = (head + EVENT_ENTRY_SIZE) % iommu->evt_buf_size;
135         }
136
137         writel(head, iommu->mmio_base + MMIO_EVT_HEAD_OFFSET);
138
139         spin_unlock_irqrestore(&iommu->lock, flags);
140 }
141
142 irqreturn_t amd_iommu_int_handler(int irq, void *data)
143 {
144         struct amd_iommu *iommu;
145
146         list_for_each_entry(iommu, &amd_iommu_list, list)
147                 iommu_poll_events(iommu);
148
149         return IRQ_HANDLED;
150 }
151
152 /****************************************************************************
153  *
154  * IOMMU command queuing functions
155  *
156  ****************************************************************************/
157
158 /*
159  * Writes the command to the IOMMUs command buffer and informs the
160  * hardware about the new command. Must be called with iommu->lock held.
161  */
162 static int __iommu_queue_command(struct amd_iommu *iommu, struct iommu_cmd *cmd)
163 {
164         u32 tail, head;
165         u8 *target;
166
167         tail = readl(iommu->mmio_base + MMIO_CMD_TAIL_OFFSET);
168         target = iommu->cmd_buf + tail;
169         memcpy_toio(target, cmd, sizeof(*cmd));
170         tail = (tail + sizeof(*cmd)) % iommu->cmd_buf_size;
171         head = readl(iommu->mmio_base + MMIO_CMD_HEAD_OFFSET);
172         if (tail == head)
173                 return -ENOMEM;
174         writel(tail, iommu->mmio_base + MMIO_CMD_TAIL_OFFSET);
175
176         return 0;
177 }
178
179 /*
180  * General queuing function for commands. Takes iommu->lock and calls
181  * __iommu_queue_command().
182  */
183 static int iommu_queue_command(struct amd_iommu *iommu, struct iommu_cmd *cmd)
184 {
185         unsigned long flags;
186         int ret;
187
188         spin_lock_irqsave(&iommu->lock, flags);
189         ret = __iommu_queue_command(iommu, cmd);
190         spin_unlock_irqrestore(&iommu->lock, flags);
191
192         return ret;
193 }
194
195 /*
196  * This function is called whenever we need to ensure that the IOMMU has
197  * completed execution of all commands we sent. It sends a
198  * COMPLETION_WAIT command and waits for it to finish. The IOMMU informs
199  * us about that by writing a value to a physical address we pass with
200  * the command.
201  */
202 static int iommu_completion_wait(struct amd_iommu *iommu)
203 {
204         int ret, ready = 0;
205         unsigned status = 0;
206         struct iommu_cmd cmd;
207         unsigned long i = 0;
208
209         memset(&cmd, 0, sizeof(cmd));
210         cmd.data[0] = CMD_COMPL_WAIT_INT_MASK;
211         CMD_SET_TYPE(&cmd, CMD_COMPL_WAIT);
212
213         iommu->need_sync = 0;
214
215         ret = iommu_queue_command(iommu, &cmd);
216
217         if (ret)
218                 return ret;
219
220         while (!ready && (i < EXIT_LOOP_COUNT)) {
221                 ++i;
222                 /* wait for the bit to become one */
223                 status = readl(iommu->mmio_base + MMIO_STATUS_OFFSET);
224                 ready = status & MMIO_STATUS_COM_WAIT_INT_MASK;
225         }
226
227         /* set bit back to zero */
228         status &= ~MMIO_STATUS_COM_WAIT_INT_MASK;
229         writel(status, iommu->mmio_base + MMIO_STATUS_OFFSET);
230
231         if (unlikely((i == EXIT_LOOP_COUNT) && printk_ratelimit()))
232                 printk(KERN_WARNING "AMD IOMMU: Completion wait loop failed\n");
233
234         return 0;
235 }
236
237 /*
238  * Command send function for invalidating a device table entry
239  */
240 static int iommu_queue_inv_dev_entry(struct amd_iommu *iommu, u16 devid)
241 {
242         struct iommu_cmd cmd;
243
244         BUG_ON(iommu == NULL);
245
246         memset(&cmd, 0, sizeof(cmd));
247         CMD_SET_TYPE(&cmd, CMD_INV_DEV_ENTRY);
248         cmd.data[0] = devid;
249
250         iommu->need_sync = 1;
251
252         return iommu_queue_command(iommu, &cmd);
253 }
254
255 /*
256  * Generic command send function for invalidaing TLB entries
257  */
258 static int iommu_queue_inv_iommu_pages(struct amd_iommu *iommu,
259                 u64 address, u16 domid, int pde, int s)
260 {
261         struct iommu_cmd cmd;
262
263         memset(&cmd, 0, sizeof(cmd));
264         address &= PAGE_MASK;
265         CMD_SET_TYPE(&cmd, CMD_INV_IOMMU_PAGES);
266         cmd.data[1] |= domid;
267         cmd.data[2] = lower_32_bits(address);
268         cmd.data[3] = upper_32_bits(address);
269         if (s) /* size bit - we flush more than one 4kb page */
270                 cmd.data[2] |= CMD_INV_IOMMU_PAGES_SIZE_MASK;
271         if (pde) /* PDE bit - we wan't flush everything not only the PTEs */
272                 cmd.data[2] |= CMD_INV_IOMMU_PAGES_PDE_MASK;
273
274         iommu->need_sync = 1;
275
276         return iommu_queue_command(iommu, &cmd);
277 }
278
279 /*
280  * TLB invalidation function which is called from the mapping functions.
281  * It invalidates a single PTE if the range to flush is within a single
282  * page. Otherwise it flushes the whole TLB of the IOMMU.
283  */
284 static int iommu_flush_pages(struct amd_iommu *iommu, u16 domid,
285                 u64 address, size_t size)
286 {
287         int s = 0;
288         unsigned pages = iommu_num_pages(address, size);
289
290         address &= PAGE_MASK;
291
292         if (pages > 1) {
293                 /*
294                  * If we have to flush more than one page, flush all
295                  * TLB entries for this domain
296                  */
297                 address = CMD_INV_IOMMU_ALL_PAGES_ADDRESS;
298                 s = 1;
299         }
300
301         iommu_queue_inv_iommu_pages(iommu, address, domid, 0, s);
302
303         return 0;
304 }
305
306 /* Flush the whole IO/TLB for a given protection domain */
307 static void iommu_flush_tlb(struct amd_iommu *iommu, u16 domid)
308 {
309         u64 address = CMD_INV_IOMMU_ALL_PAGES_ADDRESS;
310
311         iommu_queue_inv_iommu_pages(iommu, address, domid, 0, 1);
312 }
313
314 /****************************************************************************
315  *
316  * The functions below are used the create the page table mappings for
317  * unity mapped regions.
318  *
319  ****************************************************************************/
320
321 /*
322  * Generic mapping functions. It maps a physical address into a DMA
323  * address space. It allocates the page table pages if necessary.
324  * In the future it can be extended to a generic mapping function
325  * supporting all features of AMD IOMMU page tables like level skipping
326  * and full 64 bit address spaces.
327  */
328 static int iommu_map(struct protection_domain *dom,
329                      unsigned long bus_addr,
330                      unsigned long phys_addr,
331                      int prot)
332 {
333         u64 __pte, *pte, *page;
334
335         bus_addr  = PAGE_ALIGN(bus_addr);
336         phys_addr = PAGE_ALIGN(bus_addr);
337
338         /* only support 512GB address spaces for now */
339         if (bus_addr > IOMMU_MAP_SIZE_L3 || !(prot & IOMMU_PROT_MASK))
340                 return -EINVAL;
341
342         pte = &dom->pt_root[IOMMU_PTE_L2_INDEX(bus_addr)];
343
344         if (!IOMMU_PTE_PRESENT(*pte)) {
345                 page = (u64 *)get_zeroed_page(GFP_KERNEL);
346                 if (!page)
347                         return -ENOMEM;
348                 *pte = IOMMU_L2_PDE(virt_to_phys(page));
349         }
350
351         pte = IOMMU_PTE_PAGE(*pte);
352         pte = &pte[IOMMU_PTE_L1_INDEX(bus_addr)];
353
354         if (!IOMMU_PTE_PRESENT(*pte)) {
355                 page = (u64 *)get_zeroed_page(GFP_KERNEL);
356                 if (!page)
357                         return -ENOMEM;
358                 *pte = IOMMU_L1_PDE(virt_to_phys(page));
359         }
360
361         pte = IOMMU_PTE_PAGE(*pte);
362         pte = &pte[IOMMU_PTE_L0_INDEX(bus_addr)];
363
364         if (IOMMU_PTE_PRESENT(*pte))
365                 return -EBUSY;
366
367         __pte = phys_addr | IOMMU_PTE_P;
368         if (prot & IOMMU_PROT_IR)
369                 __pte |= IOMMU_PTE_IR;
370         if (prot & IOMMU_PROT_IW)
371                 __pte |= IOMMU_PTE_IW;
372
373         *pte = __pte;
374
375         return 0;
376 }
377
378 /*
379  * This function checks if a specific unity mapping entry is needed for
380  * this specific IOMMU.
381  */
382 static int iommu_for_unity_map(struct amd_iommu *iommu,
383                                struct unity_map_entry *entry)
384 {
385         u16 bdf, i;
386
387         for (i = entry->devid_start; i <= entry->devid_end; ++i) {
388                 bdf = amd_iommu_alias_table[i];
389                 if (amd_iommu_rlookup_table[bdf] == iommu)
390                         return 1;
391         }
392
393         return 0;
394 }
395
396 /*
397  * Init the unity mappings for a specific IOMMU in the system
398  *
399  * Basically iterates over all unity mapping entries and applies them to
400  * the default domain DMA of that IOMMU if necessary.
401  */
402 static int iommu_init_unity_mappings(struct amd_iommu *iommu)
403 {
404         struct unity_map_entry *entry;
405         int ret;
406
407         list_for_each_entry(entry, &amd_iommu_unity_map, list) {
408                 if (!iommu_for_unity_map(iommu, entry))
409                         continue;
410                 ret = dma_ops_unity_map(iommu->default_dom, entry);
411                 if (ret)
412                         return ret;
413         }
414
415         return 0;
416 }
417
418 /*
419  * This function actually applies the mapping to the page table of the
420  * dma_ops domain.
421  */
422 static int dma_ops_unity_map(struct dma_ops_domain *dma_dom,
423                              struct unity_map_entry *e)
424 {
425         u64 addr;
426         int ret;
427
428         for (addr = e->address_start; addr < e->address_end;
429              addr += PAGE_SIZE) {
430                 ret = iommu_map(&dma_dom->domain, addr, addr, e->prot);
431                 if (ret)
432                         return ret;
433                 /*
434                  * if unity mapping is in aperture range mark the page
435                  * as allocated in the aperture
436                  */
437                 if (addr < dma_dom->aperture_size)
438                         __set_bit(addr >> PAGE_SHIFT, dma_dom->bitmap);
439         }
440
441         return 0;
442 }
443
444 /*
445  * Inits the unity mappings required for a specific device
446  */
447 static int init_unity_mappings_for_device(struct dma_ops_domain *dma_dom,
448                                           u16 devid)
449 {
450         struct unity_map_entry *e;
451         int ret;
452
453         list_for_each_entry(e, &amd_iommu_unity_map, list) {
454                 if (!(devid >= e->devid_start && devid <= e->devid_end))
455                         continue;
456                 ret = dma_ops_unity_map(dma_dom, e);
457                 if (ret)
458                         return ret;
459         }
460
461         return 0;
462 }
463
464 /****************************************************************************
465  *
466  * The next functions belong to the address allocator for the dma_ops
467  * interface functions. They work like the allocators in the other IOMMU
468  * drivers. Its basically a bitmap which marks the allocated pages in
469  * the aperture. Maybe it could be enhanced in the future to a more
470  * efficient allocator.
471  *
472  ****************************************************************************/
473
474 /*
475  * The address allocator core function.
476  *
477  * called with domain->lock held
478  */
479 static unsigned long dma_ops_alloc_addresses(struct device *dev,
480                                              struct dma_ops_domain *dom,
481                                              unsigned int pages,
482                                              unsigned long align_mask,
483                                              u64 dma_mask)
484 {
485         unsigned long limit;
486         unsigned long address;
487         unsigned long boundary_size;
488
489         boundary_size = ALIGN(dma_get_seg_boundary(dev) + 1,
490                         PAGE_SIZE) >> PAGE_SHIFT;
491         limit = iommu_device_max_index(dom->aperture_size >> PAGE_SHIFT, 0,
492                                        dma_mask >> PAGE_SHIFT);
493
494         if (dom->next_bit >= limit) {
495                 dom->next_bit = 0;
496                 dom->need_flush = true;
497         }
498
499         address = iommu_area_alloc(dom->bitmap, limit, dom->next_bit, pages,
500                                    0 , boundary_size, align_mask);
501         if (address == -1) {
502                 address = iommu_area_alloc(dom->bitmap, limit, 0, pages,
503                                 0, boundary_size, align_mask);
504                 dom->need_flush = true;
505         }
506
507         if (likely(address != -1)) {
508                 dom->next_bit = address + pages;
509                 address <<= PAGE_SHIFT;
510         } else
511                 address = bad_dma_address;
512
513         WARN_ON((address + (PAGE_SIZE*pages)) > dom->aperture_size);
514
515         return address;
516 }
517
518 /*
519  * The address free function.
520  *
521  * called with domain->lock held
522  */
523 static void dma_ops_free_addresses(struct dma_ops_domain *dom,
524                                    unsigned long address,
525                                    unsigned int pages)
526 {
527         address >>= PAGE_SHIFT;
528         iommu_area_free(dom->bitmap, address, pages);
529
530         if (address + pages >= dom->next_bit)
531                 dom->need_flush = true;
532 }
533
534 /****************************************************************************
535  *
536  * The next functions belong to the domain allocation. A domain is
537  * allocated for every IOMMU as the default domain. If device isolation
538  * is enabled, every device get its own domain. The most important thing
539  * about domains is the page table mapping the DMA address space they
540  * contain.
541  *
542  ****************************************************************************/
543
544 static u16 domain_id_alloc(void)
545 {
546         unsigned long flags;
547         int id;
548
549         write_lock_irqsave(&amd_iommu_devtable_lock, flags);
550         id = find_first_zero_bit(amd_iommu_pd_alloc_bitmap, MAX_DOMAIN_ID);
551         BUG_ON(id == 0);
552         if (id > 0 && id < MAX_DOMAIN_ID)
553                 __set_bit(id, amd_iommu_pd_alloc_bitmap);
554         else
555                 id = 0;
556         write_unlock_irqrestore(&amd_iommu_devtable_lock, flags);
557
558         return id;
559 }
560
561 /*
562  * Used to reserve address ranges in the aperture (e.g. for exclusion
563  * ranges.
564  */
565 static void dma_ops_reserve_addresses(struct dma_ops_domain *dom,
566                                       unsigned long start_page,
567                                       unsigned int pages)
568 {
569         unsigned int last_page = dom->aperture_size >> PAGE_SHIFT;
570
571         if (start_page + pages > last_page)
572                 pages = last_page - start_page;
573
574         iommu_area_reserve(dom->bitmap, start_page, pages);
575 }
576
577 static void dma_ops_free_pagetable(struct dma_ops_domain *dma_dom)
578 {
579         int i, j;
580         u64 *p1, *p2, *p3;
581
582         p1 = dma_dom->domain.pt_root;
583
584         if (!p1)
585                 return;
586
587         for (i = 0; i < 512; ++i) {
588                 if (!IOMMU_PTE_PRESENT(p1[i]))
589                         continue;
590
591                 p2 = IOMMU_PTE_PAGE(p1[i]);
592                 for (j = 0; j < 512; ++i) {
593                         if (!IOMMU_PTE_PRESENT(p2[j]))
594                                 continue;
595                         p3 = IOMMU_PTE_PAGE(p2[j]);
596                         free_page((unsigned long)p3);
597                 }
598
599                 free_page((unsigned long)p2);
600         }
601
602         free_page((unsigned long)p1);
603 }
604
605 /*
606  * Free a domain, only used if something went wrong in the
607  * allocation path and we need to free an already allocated page table
608  */
609 static void dma_ops_domain_free(struct dma_ops_domain *dom)
610 {
611         if (!dom)
612                 return;
613
614         dma_ops_free_pagetable(dom);
615
616         kfree(dom->pte_pages);
617
618         kfree(dom->bitmap);
619
620         kfree(dom);
621 }
622
623 /*
624  * Allocates a new protection domain usable for the dma_ops functions.
625  * It also intializes the page table and the address allocator data
626  * structures required for the dma_ops interface
627  */
628 static struct dma_ops_domain *dma_ops_domain_alloc(struct amd_iommu *iommu,
629                                                    unsigned order)
630 {
631         struct dma_ops_domain *dma_dom;
632         unsigned i, num_pte_pages;
633         u64 *l2_pde;
634         u64 address;
635
636         /*
637          * Currently the DMA aperture must be between 32 MB and 1GB in size
638          */
639         if ((order < 25) || (order > 30))
640                 return NULL;
641
642         dma_dom = kzalloc(sizeof(struct dma_ops_domain), GFP_KERNEL);
643         if (!dma_dom)
644                 return NULL;
645
646         spin_lock_init(&dma_dom->domain.lock);
647
648         dma_dom->domain.id = domain_id_alloc();
649         if (dma_dom->domain.id == 0)
650                 goto free_dma_dom;
651         dma_dom->domain.mode = PAGE_MODE_3_LEVEL;
652         dma_dom->domain.pt_root = (void *)get_zeroed_page(GFP_KERNEL);
653         dma_dom->domain.priv = dma_dom;
654         if (!dma_dom->domain.pt_root)
655                 goto free_dma_dom;
656         dma_dom->aperture_size = (1ULL << order);
657         dma_dom->bitmap = kzalloc(dma_dom->aperture_size / (PAGE_SIZE * 8),
658                                   GFP_KERNEL);
659         if (!dma_dom->bitmap)
660                 goto free_dma_dom;
661         /*
662          * mark the first page as allocated so we never return 0 as
663          * a valid dma-address. So we can use 0 as error value
664          */
665         dma_dom->bitmap[0] = 1;
666         dma_dom->next_bit = 0;
667
668         dma_dom->need_flush = false;
669         dma_dom->target_dev = 0xffff;
670
671         /* Intialize the exclusion range if necessary */
672         if (iommu->exclusion_start &&
673             iommu->exclusion_start < dma_dom->aperture_size) {
674                 unsigned long startpage = iommu->exclusion_start >> PAGE_SHIFT;
675                 int pages = iommu_num_pages(iommu->exclusion_start,
676                                             iommu->exclusion_length);
677                 dma_ops_reserve_addresses(dma_dom, startpage, pages);
678         }
679
680         /*
681          * At the last step, build the page tables so we don't need to
682          * allocate page table pages in the dma_ops mapping/unmapping
683          * path.
684          */
685         num_pte_pages = dma_dom->aperture_size / (PAGE_SIZE * 512);
686         dma_dom->pte_pages = kzalloc(num_pte_pages * sizeof(void *),
687                         GFP_KERNEL);
688         if (!dma_dom->pte_pages)
689                 goto free_dma_dom;
690
691         l2_pde = (u64 *)get_zeroed_page(GFP_KERNEL);
692         if (l2_pde == NULL)
693                 goto free_dma_dom;
694
695         dma_dom->domain.pt_root[0] = IOMMU_L2_PDE(virt_to_phys(l2_pde));
696
697         for (i = 0; i < num_pte_pages; ++i) {
698                 dma_dom->pte_pages[i] = (u64 *)get_zeroed_page(GFP_KERNEL);
699                 if (!dma_dom->pte_pages[i])
700                         goto free_dma_dom;
701                 address = virt_to_phys(dma_dom->pte_pages[i]);
702                 l2_pde[i] = IOMMU_L1_PDE(address);
703         }
704
705         return dma_dom;
706
707 free_dma_dom:
708         dma_ops_domain_free(dma_dom);
709
710         return NULL;
711 }
712
713 /*
714  * Find out the protection domain structure for a given PCI device. This
715  * will give us the pointer to the page table root for example.
716  */
717 static struct protection_domain *domain_for_device(u16 devid)
718 {
719         struct protection_domain *dom;
720         unsigned long flags;
721
722         read_lock_irqsave(&amd_iommu_devtable_lock, flags);
723         dom = amd_iommu_pd_table[devid];
724         read_unlock_irqrestore(&amd_iommu_devtable_lock, flags);
725
726         return dom;
727 }
728
729 /*
730  * If a device is not yet associated with a domain, this function does
731  * assigns it visible for the hardware
732  */
733 static void set_device_domain(struct amd_iommu *iommu,
734                               struct protection_domain *domain,
735                               u16 devid)
736 {
737         unsigned long flags;
738
739         u64 pte_root = virt_to_phys(domain->pt_root);
740
741         pte_root |= (domain->mode & DEV_ENTRY_MODE_MASK)
742                     << DEV_ENTRY_MODE_SHIFT;
743         pte_root |= IOMMU_PTE_IR | IOMMU_PTE_IW | IOMMU_PTE_P | IOMMU_PTE_TV;
744
745         write_lock_irqsave(&amd_iommu_devtable_lock, flags);
746         amd_iommu_dev_table[devid].data[0] = lower_32_bits(pte_root);
747         amd_iommu_dev_table[devid].data[1] = upper_32_bits(pte_root);
748         amd_iommu_dev_table[devid].data[2] = domain->id;
749
750         amd_iommu_pd_table[devid] = domain;
751         write_unlock_irqrestore(&amd_iommu_devtable_lock, flags);
752
753         iommu_queue_inv_dev_entry(iommu, devid);
754
755         iommu->need_sync = 1;
756 }
757
758 /*****************************************************************************
759  *
760  * The next functions belong to the dma_ops mapping/unmapping code.
761  *
762  *****************************************************************************/
763
764 /*
765  * This function checks if the driver got a valid device from the caller to
766  * avoid dereferencing invalid pointers.
767  */
768 static bool check_device(struct device *dev)
769 {
770         if (!dev || !dev->dma_mask)
771                 return false;
772
773         return true;
774 }
775
776 /*
777  * In this function the list of preallocated protection domains is traversed to
778  * find the domain for a specific device
779  */
780 static struct dma_ops_domain *find_protection_domain(u16 devid)
781 {
782         struct dma_ops_domain *entry, *ret = NULL;
783         unsigned long flags;
784
785         if (list_empty(&iommu_pd_list))
786                 return NULL;
787
788         spin_lock_irqsave(&iommu_pd_list_lock, flags);
789
790         list_for_each_entry(entry, &iommu_pd_list, list) {
791                 if (entry->target_dev == devid) {
792                         ret = entry;
793                         list_del(&ret->list);
794                         break;
795                 }
796         }
797
798         spin_unlock_irqrestore(&iommu_pd_list_lock, flags);
799
800         return ret;
801 }
802
803 /*
804  * In the dma_ops path we only have the struct device. This function
805  * finds the corresponding IOMMU, the protection domain and the
806  * requestor id for a given device.
807  * If the device is not yet associated with a domain this is also done
808  * in this function.
809  */
810 static int get_device_resources(struct device *dev,
811                                 struct amd_iommu **iommu,
812                                 struct protection_domain **domain,
813                                 u16 *bdf)
814 {
815         struct dma_ops_domain *dma_dom;
816         struct pci_dev *pcidev;
817         u16 _bdf;
818
819         *iommu = NULL;
820         *domain = NULL;
821         *bdf = 0xffff;
822
823         if (dev->bus != &pci_bus_type)
824                 return 0;
825
826         pcidev = to_pci_dev(dev);
827         _bdf = calc_devid(pcidev->bus->number, pcidev->devfn);
828
829         /* device not translated by any IOMMU in the system? */
830         if (_bdf > amd_iommu_last_bdf)
831                 return 0;
832
833         *bdf = amd_iommu_alias_table[_bdf];
834
835         *iommu = amd_iommu_rlookup_table[*bdf];
836         if (*iommu == NULL)
837                 return 0;
838         *domain = domain_for_device(*bdf);
839         if (*domain == NULL) {
840                 dma_dom = find_protection_domain(*bdf);
841                 if (!dma_dom)
842                         dma_dom = (*iommu)->default_dom;
843                 *domain = &dma_dom->domain;
844                 set_device_domain(*iommu, *domain, *bdf);
845                 printk(KERN_INFO "AMD IOMMU: Using protection domain %d for "
846                                 "device ", (*domain)->id);
847                 print_devid(_bdf, 1);
848         }
849
850         return 1;
851 }
852
853 /*
854  * This is the generic map function. It maps one 4kb page at paddr to
855  * the given address in the DMA address space for the domain.
856  */
857 static dma_addr_t dma_ops_domain_map(struct amd_iommu *iommu,
858                                      struct dma_ops_domain *dom,
859                                      unsigned long address,
860                                      phys_addr_t paddr,
861                                      int direction)
862 {
863         u64 *pte, __pte;
864
865         WARN_ON(address > dom->aperture_size);
866
867         paddr &= PAGE_MASK;
868
869         pte  = dom->pte_pages[IOMMU_PTE_L1_INDEX(address)];
870         pte += IOMMU_PTE_L0_INDEX(address);
871
872         __pte = paddr | IOMMU_PTE_P | IOMMU_PTE_FC;
873
874         if (direction == DMA_TO_DEVICE)
875                 __pte |= IOMMU_PTE_IR;
876         else if (direction == DMA_FROM_DEVICE)
877                 __pte |= IOMMU_PTE_IW;
878         else if (direction == DMA_BIDIRECTIONAL)
879                 __pte |= IOMMU_PTE_IR | IOMMU_PTE_IW;
880
881         WARN_ON(*pte);
882
883         *pte = __pte;
884
885         return (dma_addr_t)address;
886 }
887
888 /*
889  * The generic unmapping function for on page in the DMA address space.
890  */
891 static void dma_ops_domain_unmap(struct amd_iommu *iommu,
892                                  struct dma_ops_domain *dom,
893                                  unsigned long address)
894 {
895         u64 *pte;
896
897         if (address >= dom->aperture_size)
898                 return;
899
900         WARN_ON(address & 0xfffULL || address > dom->aperture_size);
901
902         pte  = dom->pte_pages[IOMMU_PTE_L1_INDEX(address)];
903         pte += IOMMU_PTE_L0_INDEX(address);
904
905         WARN_ON(!*pte);
906
907         *pte = 0ULL;
908 }
909
910 /*
911  * This function contains common code for mapping of a physically
912  * contiguous memory region into DMA address space. It is uses by all
913  * mapping functions provided by this IOMMU driver.
914  * Must be called with the domain lock held.
915  */
916 static dma_addr_t __map_single(struct device *dev,
917                                struct amd_iommu *iommu,
918                                struct dma_ops_domain *dma_dom,
919                                phys_addr_t paddr,
920                                size_t size,
921                                int dir,
922                                bool align,
923                                u64 dma_mask)
924 {
925         dma_addr_t offset = paddr & ~PAGE_MASK;
926         dma_addr_t address, start;
927         unsigned int pages;
928         unsigned long align_mask = 0;
929         int i;
930
931         pages = iommu_num_pages(paddr, size);
932         paddr &= PAGE_MASK;
933
934         if (align)
935                 align_mask = (1UL << get_order(size)) - 1;
936
937         address = dma_ops_alloc_addresses(dev, dma_dom, pages, align_mask,
938                                           dma_mask);
939         if (unlikely(address == bad_dma_address))
940                 goto out;
941
942         start = address;
943         for (i = 0; i < pages; ++i) {
944                 dma_ops_domain_map(iommu, dma_dom, start, paddr, dir);
945                 paddr += PAGE_SIZE;
946                 start += PAGE_SIZE;
947         }
948         address += offset;
949
950         if (unlikely(dma_dom->need_flush && !amd_iommu_unmap_flush)) {
951                 iommu_flush_tlb(iommu, dma_dom->domain.id);
952                 dma_dom->need_flush = false;
953         } else if (unlikely(iommu_has_npcache(iommu)))
954                 iommu_flush_pages(iommu, dma_dom->domain.id, address, size);
955
956 out:
957         return address;
958 }
959
960 /*
961  * Does the reverse of the __map_single function. Must be called with
962  * the domain lock held too
963  */
964 static void __unmap_single(struct amd_iommu *iommu,
965                            struct dma_ops_domain *dma_dom,
966                            dma_addr_t dma_addr,
967                            size_t size,
968                            int dir)
969 {
970         dma_addr_t i, start;
971         unsigned int pages;
972
973         if ((dma_addr == 0) || (dma_addr + size > dma_dom->aperture_size))
974                 return;
975
976         pages = iommu_num_pages(dma_addr, size);
977         dma_addr &= PAGE_MASK;
978         start = dma_addr;
979
980         for (i = 0; i < pages; ++i) {
981                 dma_ops_domain_unmap(iommu, dma_dom, start);
982                 start += PAGE_SIZE;
983         }
984
985         dma_ops_free_addresses(dma_dom, dma_addr, pages);
986
987         if (amd_iommu_unmap_flush || dma_dom->need_flush) {
988                 iommu_flush_pages(iommu, dma_dom->domain.id, dma_addr, size);
989                 dma_dom->need_flush = false;
990         }
991 }
992
993 /*
994  * The exported map_single function for dma_ops.
995  */
996 static dma_addr_t map_single(struct device *dev, phys_addr_t paddr,
997                              size_t size, int dir)
998 {
999         unsigned long flags;
1000         struct amd_iommu *iommu;
1001         struct protection_domain *domain;
1002         u16 devid;
1003         dma_addr_t addr;
1004         u64 dma_mask;
1005
1006         if (!check_device(dev))
1007                 return bad_dma_address;
1008
1009         dma_mask = *dev->dma_mask;
1010
1011         get_device_resources(dev, &iommu, &domain, &devid);
1012
1013         if (iommu == NULL || domain == NULL)
1014                 /* device not handled by any AMD IOMMU */
1015                 return (dma_addr_t)paddr;
1016
1017         spin_lock_irqsave(&domain->lock, flags);
1018         addr = __map_single(dev, iommu, domain->priv, paddr, size, dir, false,
1019                             dma_mask);
1020         if (addr == bad_dma_address)
1021                 goto out;
1022
1023         if (unlikely(iommu->need_sync))
1024                 iommu_completion_wait(iommu);
1025
1026 out:
1027         spin_unlock_irqrestore(&domain->lock, flags);
1028
1029         return addr;
1030 }
1031
1032 /*
1033  * The exported unmap_single function for dma_ops.
1034  */
1035 static void unmap_single(struct device *dev, dma_addr_t dma_addr,
1036                          size_t size, int dir)
1037 {
1038         unsigned long flags;
1039         struct amd_iommu *iommu;
1040         struct protection_domain *domain;
1041         u16 devid;
1042
1043         if (!check_device(dev) ||
1044             !get_device_resources(dev, &iommu, &domain, &devid))
1045                 /* device not handled by any AMD IOMMU */
1046                 return;
1047
1048         spin_lock_irqsave(&domain->lock, flags);
1049
1050         __unmap_single(iommu, domain->priv, dma_addr, size, dir);
1051
1052         if (unlikely(iommu->need_sync))
1053                 iommu_completion_wait(iommu);
1054
1055         spin_unlock_irqrestore(&domain->lock, flags);
1056 }
1057
1058 /*
1059  * This is a special map_sg function which is used if we should map a
1060  * device which is not handled by an AMD IOMMU in the system.
1061  */
1062 static int map_sg_no_iommu(struct device *dev, struct scatterlist *sglist,
1063                            int nelems, int dir)
1064 {
1065         struct scatterlist *s;
1066         int i;
1067
1068         for_each_sg(sglist, s, nelems, i) {
1069                 s->dma_address = (dma_addr_t)sg_phys(s);
1070                 s->dma_length  = s->length;
1071         }
1072
1073         return nelems;
1074 }
1075
1076 /*
1077  * The exported map_sg function for dma_ops (handles scatter-gather
1078  * lists).
1079  */
1080 static int map_sg(struct device *dev, struct scatterlist *sglist,
1081                   int nelems, int dir)
1082 {
1083         unsigned long flags;
1084         struct amd_iommu *iommu;
1085         struct protection_domain *domain;
1086         u16 devid;
1087         int i;
1088         struct scatterlist *s;
1089         phys_addr_t paddr;
1090         int mapped_elems = 0;
1091         u64 dma_mask;
1092
1093         if (!check_device(dev))
1094                 return 0;
1095
1096         dma_mask = *dev->dma_mask;
1097
1098         get_device_resources(dev, &iommu, &domain, &devid);
1099
1100         if (!iommu || !domain)
1101                 return map_sg_no_iommu(dev, sglist, nelems, dir);
1102
1103         spin_lock_irqsave(&domain->lock, flags);
1104
1105         for_each_sg(sglist, s, nelems, i) {
1106                 paddr = sg_phys(s);
1107
1108                 s->dma_address = __map_single(dev, iommu, domain->priv,
1109                                               paddr, s->length, dir, false,
1110                                               dma_mask);
1111
1112                 if (s->dma_address) {
1113                         s->dma_length = s->length;
1114                         mapped_elems++;
1115                 } else
1116                         goto unmap;
1117         }
1118
1119         if (unlikely(iommu->need_sync))
1120                 iommu_completion_wait(iommu);
1121
1122 out:
1123         spin_unlock_irqrestore(&domain->lock, flags);
1124
1125         return mapped_elems;
1126 unmap:
1127         for_each_sg(sglist, s, mapped_elems, i) {
1128                 if (s->dma_address)
1129                         __unmap_single(iommu, domain->priv, s->dma_address,
1130                                        s->dma_length, dir);
1131                 s->dma_address = s->dma_length = 0;
1132         }
1133
1134         mapped_elems = 0;
1135
1136         goto out;
1137 }
1138
1139 /*
1140  * The exported map_sg function for dma_ops (handles scatter-gather
1141  * lists).
1142  */
1143 static void unmap_sg(struct device *dev, struct scatterlist *sglist,
1144                      int nelems, int dir)
1145 {
1146         unsigned long flags;
1147         struct amd_iommu *iommu;
1148         struct protection_domain *domain;
1149         struct scatterlist *s;
1150         u16 devid;
1151         int i;
1152
1153         if (!check_device(dev) ||
1154             !get_device_resources(dev, &iommu, &domain, &devid))
1155                 return;
1156
1157         spin_lock_irqsave(&domain->lock, flags);
1158
1159         for_each_sg(sglist, s, nelems, i) {
1160                 __unmap_single(iommu, domain->priv, s->dma_address,
1161                                s->dma_length, dir);
1162                 s->dma_address = s->dma_length = 0;
1163         }
1164
1165         if (unlikely(iommu->need_sync))
1166                 iommu_completion_wait(iommu);
1167
1168         spin_unlock_irqrestore(&domain->lock, flags);
1169 }
1170
1171 /*
1172  * The exported alloc_coherent function for dma_ops.
1173  */
1174 static void *alloc_coherent(struct device *dev, size_t size,
1175                             dma_addr_t *dma_addr, gfp_t flag)
1176 {
1177         unsigned long flags;
1178         void *virt_addr;
1179         struct amd_iommu *iommu;
1180         struct protection_domain *domain;
1181         u16 devid;
1182         phys_addr_t paddr;
1183         u64 dma_mask = dev->coherent_dma_mask;
1184
1185         if (!check_device(dev))
1186                 return NULL;
1187
1188         if (!get_device_resources(dev, &iommu, &domain, &devid))
1189                 flag &= ~(__GFP_DMA | __GFP_HIGHMEM | __GFP_DMA32);
1190
1191         flag |= __GFP_ZERO;
1192         virt_addr = (void *)__get_free_pages(flag, get_order(size));
1193         if (!virt_addr)
1194                 return 0;
1195
1196         paddr = virt_to_phys(virt_addr);
1197
1198         if (!iommu || !domain) {
1199                 *dma_addr = (dma_addr_t)paddr;
1200                 return virt_addr;
1201         }
1202
1203         if (!dma_mask)
1204                 dma_mask = *dev->dma_mask;
1205
1206         spin_lock_irqsave(&domain->lock, flags);
1207
1208         *dma_addr = __map_single(dev, iommu, domain->priv, paddr,
1209                                  size, DMA_BIDIRECTIONAL, true, dma_mask);
1210
1211         if (*dma_addr == bad_dma_address) {
1212                 free_pages((unsigned long)virt_addr, get_order(size));
1213                 virt_addr = NULL;
1214                 goto out;
1215         }
1216
1217         if (unlikely(iommu->need_sync))
1218                 iommu_completion_wait(iommu);
1219
1220 out:
1221         spin_unlock_irqrestore(&domain->lock, flags);
1222
1223         return virt_addr;
1224 }
1225
1226 /*
1227  * The exported free_coherent function for dma_ops.
1228  */
1229 static void free_coherent(struct device *dev, size_t size,
1230                           void *virt_addr, dma_addr_t dma_addr)
1231 {
1232         unsigned long flags;
1233         struct amd_iommu *iommu;
1234         struct protection_domain *domain;
1235         u16 devid;
1236
1237         if (!check_device(dev))
1238                 return;
1239
1240         get_device_resources(dev, &iommu, &domain, &devid);
1241
1242         if (!iommu || !domain)
1243                 goto free_mem;
1244
1245         spin_lock_irqsave(&domain->lock, flags);
1246
1247         __unmap_single(iommu, domain->priv, dma_addr, size, DMA_BIDIRECTIONAL);
1248
1249         if (unlikely(iommu->need_sync))
1250                 iommu_completion_wait(iommu);
1251
1252         spin_unlock_irqrestore(&domain->lock, flags);
1253
1254 free_mem:
1255         free_pages((unsigned long)virt_addr, get_order(size));
1256 }
1257
1258 /*
1259  * This function is called by the DMA layer to find out if we can handle a
1260  * particular device. It is part of the dma_ops.
1261  */
1262 static int amd_iommu_dma_supported(struct device *dev, u64 mask)
1263 {
1264         u16 bdf;
1265         struct pci_dev *pcidev;
1266
1267         /* No device or no PCI device */
1268         if (!dev || dev->bus != &pci_bus_type)
1269                 return 0;
1270
1271         pcidev = to_pci_dev(dev);
1272
1273         bdf = calc_devid(pcidev->bus->number, pcidev->devfn);
1274
1275         /* Out of our scope? */
1276         if (bdf > amd_iommu_last_bdf)
1277                 return 0;
1278
1279         return 1;
1280 }
1281
1282 /*
1283  * The function for pre-allocating protection domains.
1284  *
1285  * If the driver core informs the DMA layer if a driver grabs a device
1286  * we don't need to preallocate the protection domains anymore.
1287  * For now we have to.
1288  */
1289 void prealloc_protection_domains(void)
1290 {
1291         struct pci_dev *dev = NULL;
1292         struct dma_ops_domain *dma_dom;
1293         struct amd_iommu *iommu;
1294         int order = amd_iommu_aperture_order;
1295         u16 devid;
1296
1297         while ((dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
1298                 devid = (dev->bus->number << 8) | dev->devfn;
1299                 if (devid > amd_iommu_last_bdf)
1300                         continue;
1301                 devid = amd_iommu_alias_table[devid];
1302                 if (domain_for_device(devid))
1303                         continue;
1304                 iommu = amd_iommu_rlookup_table[devid];
1305                 if (!iommu)
1306                         continue;
1307                 dma_dom = dma_ops_domain_alloc(iommu, order);
1308                 if (!dma_dom)
1309                         continue;
1310                 init_unity_mappings_for_device(dma_dom, devid);
1311                 dma_dom->target_dev = devid;
1312
1313                 list_add_tail(&dma_dom->list, &iommu_pd_list);
1314         }
1315 }
1316
1317 static struct dma_mapping_ops amd_iommu_dma_ops = {
1318         .alloc_coherent = alloc_coherent,
1319         .free_coherent = free_coherent,
1320         .map_single = map_single,
1321         .unmap_single = unmap_single,
1322         .map_sg = map_sg,
1323         .unmap_sg = unmap_sg,
1324         .dma_supported = amd_iommu_dma_supported,
1325 };
1326
1327 /*
1328  * The function which clues the AMD IOMMU driver into dma_ops.
1329  */
1330 int __init amd_iommu_init_dma_ops(void)
1331 {
1332         struct amd_iommu *iommu;
1333         int order = amd_iommu_aperture_order;
1334         int ret;
1335
1336         /*
1337          * first allocate a default protection domain for every IOMMU we
1338          * found in the system. Devices not assigned to any other
1339          * protection domain will be assigned to the default one.
1340          */
1341         list_for_each_entry(iommu, &amd_iommu_list, list) {
1342                 iommu->default_dom = dma_ops_domain_alloc(iommu, order);
1343                 if (iommu->default_dom == NULL)
1344                         return -ENOMEM;
1345                 ret = iommu_init_unity_mappings(iommu);
1346                 if (ret)
1347                         goto free_domains;
1348         }
1349
1350         /*
1351          * If device isolation is enabled, pre-allocate the protection
1352          * domains for each device.
1353          */
1354         if (amd_iommu_isolate)
1355                 prealloc_protection_domains();
1356
1357         iommu_detected = 1;
1358         force_iommu = 1;
1359         bad_dma_address = 0;
1360 #ifdef CONFIG_GART_IOMMU
1361         gart_iommu_aperture_disabled = 1;
1362         gart_iommu_aperture = 0;
1363 #endif
1364
1365         /* Make the driver finally visible to the drivers */
1366         dma_ops = &amd_iommu_dma_ops;
1367
1368         return 0;
1369
1370 free_domains:
1371
1372         list_for_each_entry(iommu, &amd_iommu_list, list) {
1373                 if (iommu->default_dom)
1374                         dma_ops_domain_free(iommu->default_dom);
1375         }
1376
1377         return ret;
1378 }