xref: /freebsd/sys/compat/linuxkpi/common/include/linux/io-mapping.h (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _LINUXKPI_LINUX_IO_MAPPING_H_
33 #define	_LINUXKPI_LINUX_IO_MAPPING_H_
34 
35 #include <sys/types.h>
36 #include <machine/vm.h>
37 
38 #include <linux/types.h>
39 #include <linux/io.h>
40 #include <linux/mm.h>
41 #include <linux/slab.h>
42 
43 struct io_mapping {
44 	unsigned long base;
45 	unsigned long size;
46 	void *mem;
47 	vm_memattr_t attr;
48 };
49 
50 struct io_mapping *io_mapping_create_wc(resource_size_t base, unsigned long size);
51 
52 static inline struct io_mapping *
53 io_mapping_init_wc(struct io_mapping *mapping, resource_size_t base,
54     unsigned long size)
55 {
56 
57 	mapping->base = base;
58 	mapping->size = size;
59 #ifdef VM_MEMATTR_WRITE_COMBINING
60 	mapping->mem = ioremap_wc(base, size);
61 	mapping->attr = VM_MEMATTR_WRITE_COMBINING;
62 #else
63 	mapping->mem = ioremap_nocache(base, size);
64 	mapping->attr = VM_MEMATTR_UNCACHEABLE;
65 #endif
66 	return (mapping);
67 }
68 
69 static inline void
70 io_mapping_fini(struct io_mapping *mapping)
71 {
72 
73 	iounmap(mapping->mem);
74 }
75 
76 static inline void
77 io_mapping_free(struct io_mapping *mapping)
78 {
79 
80 	io_mapping_fini(mapping->mem);
81 	kfree(mapping);
82 }
83 
84 static inline void *
85 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
86 {
87 
88 	return ((char *)mapping->mem + offset);
89 }
90 
91 static inline void
92 io_mapping_unmap_atomic(void *vaddr)
93 {
94 }
95 
96 static inline void *
97 io_mapping_map_local_wc(struct io_mapping *mapping, unsigned long offset)
98 {
99 
100 	return (io_mapping_map_atomic_wc(mapping, offset));
101 }
102 
103 static inline void
104 io_mapping_unmap_local(void *vaddr __unused)
105 {
106 }
107 
108 static inline void *
109 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset,
110     unsigned long size)
111 {
112 
113 	return ((char *)mapping->mem + offset);
114 }
115 
116 int lkpi_io_mapping_map_user(struct io_mapping *iomap,
117     struct vm_area_struct *vma, unsigned long addr, unsigned long pfn,
118     unsigned long size);
119 
120 static inline int
121 io_mapping_map_user(struct io_mapping *iomap, struct vm_area_struct *vma,
122     unsigned long addr, unsigned long pfn, unsigned long size)
123 {
124 	return (lkpi_io_mapping_map_user(iomap, vma, addr, pfn, size));
125 }
126 
127 static inline void
128 io_mapping_unmap(void *vaddr)
129 {
130 }
131 
132 #endif /* _LINUXKPI_LINUX_IO_MAPPING_H_ */
133