resources: add io-mapping functions to dynamically map large device apertures
[linux-2.6.git] / include / linux / io-mapping.h
1 /*
2  * Copyright © 2008 Keith Packard <keithp@keithp.com>
3  *
4  * This file is free software; you can redistribute it and/or modify
5  * it under the terms of version 2 of the GNU General Public License
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software Foundation,
15  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
16  */
17
18 #ifndef _LINUX_IO_MAPPING_H
19 #define _LINUX_IO_MAPPING_H
20
21 #include <linux/types.h>
22 #include <asm/io.h>
23 #include <asm/page.h>
24 #include <asm/iomap.h>
25
26 /*
27  * The io_mapping mechanism provides an abstraction for mapping
28  * individual pages from an io device to the CPU in an efficient fashion.
29  *
30  * See Documentation/io_mapping.txt
31  */
32
33 /* this struct isn't actually defined anywhere */
34 struct io_mapping;
35
36 #ifdef CONFIG_X86_64
37
38 /* Create the io_mapping object*/
39 static inline struct io_mapping *
40 io_mapping_create_wc(unsigned long base, unsigned long size)
41 {
42         return (struct io_mapping *) ioremap_wc(base, size);
43 }
44
45 static inline void
46 io_mapping_free(struct io_mapping *mapping)
47 {
48         iounmap(mapping);
49 }
50
51 /* Atomic map/unmap */
52 static inline void *
53 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
54 {
55         return ((char *) mapping) + offset;
56 }
57
58 static inline void
59 io_mapping_unmap_atomic(void *vaddr)
60 {
61 }
62
63 /* Non-atomic map/unmap */
64 static inline void *
65 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset)
66 {
67         return ((char *) mapping) + offset;
68 }
69
70 static inline void
71 io_mapping_unmap(void *vaddr)
72 {
73 }
74
75 #endif /* CONFIG_X86_64 */
76
77 #ifdef CONFIG_X86_32
78 static inline struct io_mapping *
79 io_mapping_create_wc(unsigned long base, unsigned long size)
80 {
81         return (struct io_mapping *) base;
82 }
83
84 static inline void
85 io_mapping_free(struct io_mapping *mapping)
86 {
87 }
88
89 /* Atomic map/unmap */
90 static inline void *
91 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
92 {
93         offset += (unsigned long) mapping;
94         return iomap_atomic_prot_pfn(offset >> PAGE_SHIFT, KM_USER0,
95                                      __pgprot(__PAGE_KERNEL_WC));
96 }
97
98 static inline void
99 io_mapping_unmap_atomic(void *vaddr)
100 {
101         iounmap_atomic(vaddr, KM_USER0);
102 }
103
104 static inline void *
105 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset)
106 {
107         offset += (unsigned long) mapping;
108         return ioremap_wc(offset, PAGE_SIZE);
109 }
110
111 static inline void
112 io_mapping_unmap(void *vaddr)
113 {
114         iounmap(vaddr);
115 }
116 #endif /* CONFIG_X86_32 */
117
118 #endif /* _LINUX_IO_MAPPING_H */