blob: 25085ddd955fda5516b4b8a73958246ba4044e41 [file] [log] [blame]
Keith Packard9663f2e2008-10-30 19:38:18 -07001/*
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090022#include <linux/slab.h>
Keith Packard9663f2e2008-10-30 19:38:18 -070023#include <asm/io.h>
24#include <asm/page.h>
25#include <asm/iomap.h>
26
27/*
28 * The io_mapping mechanism provides an abstraction for mapping
29 * individual pages from an io device to the CPU in an efficient fashion.
30 *
31 * See Documentation/io_mapping.txt
32 */
33
Keith Packarde5beae12008-11-03 18:21:45 +010034#ifdef CONFIG_HAVE_ATOMIC_IOMAP
Keith Packard9663f2e2008-10-30 19:38:18 -070035
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080036struct io_mapping {
37 resource_size_t base;
38 unsigned long size;
39 pgprot_t prot;
40};
41
Keith Packarde5beae12008-11-03 18:21:45 +010042/*
43 * For small address space machines, mapping large objects
44 * into the kernel virtual space isn't practical. Where
45 * available, use fixmap support to dynamically map pages
46 * of the object at run time.
47 */
Keith Packard9663f2e2008-10-30 19:38:18 -070048
Keith Packard9663f2e2008-10-30 19:38:18 -070049static inline struct io_mapping *
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080050io_mapping_create_wc(resource_size_t base, unsigned long size)
Keith Packard9663f2e2008-10-30 19:38:18 -070051{
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080052 struct io_mapping *iomap;
Venkatesh Pallipadi9e36fda2009-07-10 09:57:35 -070053 pgprot_t prot;
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080054
55 iomap = kmalloc(sizeof(*iomap), GFP_KERNEL);
56 if (!iomap)
Venkatesh Pallipadi9e36fda2009-07-10 09:57:35 -070057 goto out_err;
58
59 if (iomap_create_wc(base, size, &prot))
60 goto out_free;
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080061
62 iomap->base = base;
63 iomap->size = size;
Venkatesh Pallipadi9e36fda2009-07-10 09:57:35 -070064 iomap->prot = prot;
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080065 return iomap;
Venkatesh Pallipadi9e36fda2009-07-10 09:57:35 -070066
67out_free:
68 kfree(iomap);
69out_err:
70 return NULL;
Keith Packard9663f2e2008-10-30 19:38:18 -070071}
72
73static inline void
74io_mapping_free(struct io_mapping *mapping)
75{
Venkatesh Pallipadi9e36fda2009-07-10 09:57:35 -070076 iomap_free(mapping->base, mapping->size);
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080077 kfree(mapping);
Keith Packard9663f2e2008-10-30 19:38:18 -070078}
79
80/* Atomic map/unmap */
81static inline void *
82io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
83{
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -080084 resource_size_t phys_addr;
85 unsigned long pfn;
86
87 BUG_ON(offset >= mapping->size);
88 phys_addr = mapping->base + offset;
89 pfn = (unsigned long) (phys_addr >> PAGE_SHIFT);
90 return iomap_atomic_prot_pfn(pfn, KM_USER0, mapping->prot);
Keith Packard9663f2e2008-10-30 19:38:18 -070091}
92
93static inline void
94io_mapping_unmap_atomic(void *vaddr)
95{
96 iounmap_atomic(vaddr, KM_USER0);
97}
98
99static inline void *
100io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset)
101{
Pallipadi, Venkatesh5ce04e32009-03-01 08:53:27 -0800102 resource_size_t phys_addr;
103
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -0800104 BUG_ON(offset >= mapping->size);
Pallipadi, Venkatesh5ce04e32009-03-01 08:53:27 -0800105 phys_addr = mapping->base + offset;
106
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -0800107 return ioremap_wc(phys_addr, PAGE_SIZE);
Keith Packard9663f2e2008-10-30 19:38:18 -0700108}
109
110static inline void
111io_mapping_unmap(void *vaddr)
112{
113 iounmap(vaddr);
114}
Keith Packarde5beae12008-11-03 18:21:45 +0100115
116#else
117
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -0800118/* this struct isn't actually defined anywhere */
119struct io_mapping;
120
Keith Packarde5beae12008-11-03 18:21:45 +0100121/* Create the io_mapping object*/
122static inline struct io_mapping *
Venkatesh Pallipadi4ab0d472009-02-24 17:35:12 -0800123io_mapping_create_wc(resource_size_t base, unsigned long size)
Keith Packarde5beae12008-11-03 18:21:45 +0100124{
125 return (struct io_mapping *) ioremap_wc(base, size);
126}
127
128static inline void
129io_mapping_free(struct io_mapping *mapping)
130{
131 iounmap(mapping);
132}
133
134/* Atomic map/unmap */
135static inline void *
136io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
137{
138 return ((char *) mapping) + offset;
139}
140
141static inline void
142io_mapping_unmap_atomic(void *vaddr)
143{
144}
145
146/* Non-atomic map/unmap */
147static inline void *
148io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset)
149{
150 return ((char *) mapping) + offset;
151}
152
153static inline void
154io_mapping_unmap(void *vaddr)
155{
156}
157
158#endif /* HAVE_ATOMIC_IOMAP */
Keith Packard9663f2e2008-10-30 19:38:18 -0700159
160#endif /* _LINUX_IO_MAPPING_H */