xref: /freebsd/sys/compat/linuxkpi/common/include/linux/io-mapping.h (revision cddbc3b40812213ff00041f79174cac0be360a2a)
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 _LINUX_IO_MAPPING_H_
33 #define	_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/slab.h>
41 
42 struct io_mapping {
43 	unsigned long base;
44 	unsigned long size;
45 	void *mem;
46 	vm_memattr_t attr;
47 };
48 
49 static inline struct io_mapping *
50 io_mapping_init_wc(struct io_mapping *mapping, resource_size_t base,
51     unsigned long size)
52 {
53 
54 	mapping->base = base;
55 	mapping->size = size;
56 #ifdef VM_MEMATTR_WRITE_COMBINING
57 	mapping->mem = ioremap_wc(base, size);
58 	mapping->attr = VM_MEMATTR_WRITE_COMBINING;
59 #else
60 	mapping->mem = ioremap_nocache(base, size);
61 	mapping->attr = VM_MEMATTR_UNCACHEABLE;
62 #endif
63 	return (mapping);
64 }
65 
66 static inline struct io_mapping *
67 io_mapping_create_wc(resource_size_t base, unsigned long size)
68 {
69 	struct io_mapping *mapping;
70 
71 	mapping = kmalloc(sizeof(*mapping), GFP_KERNEL);
72 	if (mapping == NULL)
73 		return (NULL);
74 	return (io_mapping_init_wc(mapping, base, size));
75 }
76 
77 static inline void
78 io_mapping_fini(struct io_mapping *mapping)
79 {
80 
81 	iounmap(mapping->mem);
82 }
83 
84 static inline void
85 io_mapping_free(struct io_mapping *mapping)
86 {
87 
88 	io_mapping_fini(mapping->mem);
89 	kfree(mapping);
90 }
91 
92 static inline void *
93 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
94 {
95 
96 	return ((char *)mapping->mem + offset);
97 }
98 
99 static inline void
100 io_mapping_unmap_atomic(void *vaddr)
101 {
102 }
103 
104 static inline void *
105 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset,
106     unsigned long size)
107 {
108 
109 	return ((char *)mapping->mem + offset);
110 }
111 
112 static inline void
113 io_mapping_unmap(void *vaddr)
114 {
115 }
116 
117 #endif /* _LINUX_IO_MAPPING_H_ */
118