xref: /freebsd/sys/compat/linuxkpi/common/include/linux/io-mapping.h (revision 271171e0d97b88ba2a7c3bf750c9672b484c1c13)
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/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 struct io_mapping *io_mapping_create_wc(resource_size_t base, unsigned long size);
50 
51 static inline struct io_mapping *
52 io_mapping_init_wc(struct io_mapping *mapping, resource_size_t base,
53     unsigned long size)
54 {
55 
56 	mapping->base = base;
57 	mapping->size = size;
58 #ifdef VM_MEMATTR_WRITE_COMBINING
59 	mapping->mem = ioremap_wc(base, size);
60 	mapping->attr = VM_MEMATTR_WRITE_COMBINING;
61 #else
62 	mapping->mem = ioremap_nocache(base, size);
63 	mapping->attr = VM_MEMATTR_UNCACHEABLE;
64 #endif
65 	return (mapping);
66 }
67 
68 static inline void
69 io_mapping_fini(struct io_mapping *mapping)
70 {
71 
72 	iounmap(mapping->mem);
73 }
74 
75 static inline void
76 io_mapping_free(struct io_mapping *mapping)
77 {
78 
79 	io_mapping_fini(mapping->mem);
80 	kfree(mapping);
81 }
82 
83 static inline void *
84 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
85 {
86 
87 	return ((char *)mapping->mem + offset);
88 }
89 
90 static inline void
91 io_mapping_unmap_atomic(void *vaddr)
92 {
93 }
94 
95 static inline void *
96 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset,
97     unsigned long size)
98 {
99 
100 	return ((char *)mapping->mem + offset);
101 }
102 
103 static inline void
104 io_mapping_unmap(void *vaddr)
105 {
106 }
107 
108 #endif /* _LINUXKPI_LINUX_IO_MAPPING_H_ */
109