iommu: Consolidate IOVA allocator code
[firefly-linux-kernel-4.4.55.git] / include / linux / iova.h
1 /*
2  * Copyright (c) 2006, Intel Corporation.
3  *
4  * This file is released under the GPLv2.
5  *
6  * Copyright (C) 2006-2008 Intel Corporation
7  * Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
8  *
9  */
10
11 #ifndef _IOVA_H_
12 #define _IOVA_H_
13
14 #include <linux/types.h>
15 #include <linux/kernel.h>
16 #include <linux/rbtree.h>
17 #include <linux/dma-mapping.h>
18
19 /* IO virtual address start page frame number */
20 #define IOVA_START_PFN          (1)
21
22 /* iova structure */
23 struct iova {
24         struct rb_node  node;
25         unsigned long   pfn_hi; /* IOMMU dish out addr hi */
26         unsigned long   pfn_lo; /* IOMMU dish out addr lo */
27 };
28
29 /* holds all the iova translations for a domain */
30 struct iova_domain {
31         spinlock_t      iova_rbtree_lock; /* Lock to protect update of rbtree */
32         struct rb_root  rbroot;         /* iova domain rbtree root */
33         struct rb_node  *cached32_node; /* Save last alloced node */
34         unsigned long   dma_32bit_pfn;
35 };
36
37 static inline unsigned long iova_size(struct iova *iova)
38 {
39         return iova->pfn_hi - iova->pfn_lo + 1;
40 }
41
42 int iommu_iova_cache_init(void);
43 void iommu_iova_cache_destroy(void);
44
45 struct iova *alloc_iova_mem(void);
46 void free_iova_mem(struct iova *iova);
47 void free_iova(struct iova_domain *iovad, unsigned long pfn);
48 void __free_iova(struct iova_domain *iovad, struct iova *iova);
49 struct iova *alloc_iova(struct iova_domain *iovad, unsigned long size,
50         unsigned long limit_pfn,
51         bool size_aligned);
52 struct iova *reserve_iova(struct iova_domain *iovad, unsigned long pfn_lo,
53         unsigned long pfn_hi);
54 void copy_reserved_iova(struct iova_domain *from, struct iova_domain *to);
55 void init_iova_domain(struct iova_domain *iovad, unsigned long pfn_32bit);
56 struct iova *find_iova(struct iova_domain *iovad, unsigned long pfn);
57 void put_iova_domain(struct iova_domain *iovad);
58 struct iova *split_and_remove_iova(struct iova_domain *iovad,
59         struct iova *iova, unsigned long pfn_lo, unsigned long pfn_hi);
60
61 #endif