xref: /freebsd/sys/compat/linuxkpi/common/include/linux/io-mapping.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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 
30 #ifndef _LINUXKPI_LINUX_IO_MAPPING_H_
31 #define	_LINUXKPI_LINUX_IO_MAPPING_H_
32 
33 #include <sys/types.h>
34 #include <machine/vm.h>
35 
36 #include <linux/types.h>
37 #include <linux/io.h>
38 #include <linux/mm.h>
39 #include <linux/slab.h>
40 
41 struct io_mapping {
42 	unsigned long base;
43 	unsigned long size;
44 	void *mem;
45 	vm_memattr_t attr;
46 };
47 
48 struct io_mapping *io_mapping_create_wc(resource_size_t base, unsigned long size);
49 
50 static inline struct io_mapping *
io_mapping_init_wc(struct io_mapping * mapping,resource_size_t base,unsigned long size)51 io_mapping_init_wc(struct io_mapping *mapping, resource_size_t base,
52     unsigned long size)
53 {
54 
55 	mapping->base = base;
56 	mapping->size = size;
57 #ifdef VM_MEMATTR_WRITE_COMBINING
58 	mapping->mem = ioremap_wc(base, size);
59 	mapping->attr = VM_MEMATTR_WRITE_COMBINING;
60 #else
61 	mapping->mem = ioremap_nocache(base, size);
62 	mapping->attr = VM_MEMATTR_UNCACHEABLE;
63 #endif
64 	return (mapping);
65 }
66 
67 static inline void
io_mapping_fini(struct io_mapping * mapping)68 io_mapping_fini(struct io_mapping *mapping)
69 {
70 
71 	iounmap(mapping->mem);
72 }
73 
74 static inline void
io_mapping_free(struct io_mapping * mapping)75 io_mapping_free(struct io_mapping *mapping)
76 {
77 
78 	io_mapping_fini(mapping->mem);
79 	kfree(mapping);
80 }
81 
82 static inline void *
io_mapping_map_atomic_wc(struct io_mapping * mapping,unsigned long offset)83 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
84 {
85 
86 	return ((char *)mapping->mem + offset);
87 }
88 
89 static inline void
io_mapping_unmap_atomic(void * vaddr)90 io_mapping_unmap_atomic(void *vaddr)
91 {
92 }
93 
94 static inline void *
io_mapping_map_local_wc(struct io_mapping * mapping,unsigned long offset)95 io_mapping_map_local_wc(struct io_mapping *mapping, unsigned long offset)
96 {
97 
98 	return (io_mapping_map_atomic_wc(mapping, offset));
99 }
100 
101 static inline void
io_mapping_unmap_local(void * vaddr __unused)102 io_mapping_unmap_local(void *vaddr __unused)
103 {
104 }
105 
106 static inline void *
io_mapping_map_wc(struct io_mapping * mapping,unsigned long offset,unsigned long size)107 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset,
108     unsigned long size)
109 {
110 
111 	return ((char *)mapping->mem + offset);
112 }
113 
114 int lkpi_io_mapping_map_user(struct io_mapping *iomap,
115     struct vm_area_struct *vma, unsigned long addr, unsigned long pfn,
116     unsigned long size);
117 
118 static inline int
io_mapping_map_user(struct io_mapping * iomap,struct vm_area_struct * vma,unsigned long addr,unsigned long pfn,unsigned long size)119 io_mapping_map_user(struct io_mapping *iomap, struct vm_area_struct *vma,
120     unsigned long addr, unsigned long pfn, unsigned long size)
121 {
122 	return (lkpi_io_mapping_map_user(iomap, vma, addr, pfn, size));
123 }
124 
125 static inline void
io_mapping_unmap(void * vaddr)126 io_mapping_unmap(void *vaddr)
127 {
128 }
129 
130 #endif /* _LINUXKPI_LINUX_IO_MAPPING_H_ */
131