SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 #ifdef CONFIG_HAVE_ATOMIC_IOMAP
  34
  35 struct io_mapping {
  36         resource_size_t base;
  37         unsigned long size;
  38         pgprot_t prot;
  39 };
  40
  41 /*
  42  * For small address space machines, mapping large objects
  43  * into the kernel virtual space isn't practical. Where
  44  * available, use fixmap support to dynamically map pages
  45  * of the object at run time.
  46  */
  47
  48 static inline struct io_mapping *
  49 io_mapping_create_wc(resource_size_t base, unsigned long size)
  50 {
  51         struct io_mapping *iomap;
  52         pgprot_t prot;
  53
  54         if (!reserve_io_memtype_wc(base, size, &prot))
  55                 return NULL;
  56
  57         iomap = kmalloc(sizeof(*iomap), GFP_KERNEL);
  58         if (!iomap)
  59                 return NULL;
  60
  61         iomap->base = base;
  62         iomap->size = size;
  63         iomap->prot = prot;
  64         return iomap;
  65 }
  66
  67 static inline void
  68 io_mapping_free(struct io_mapping *mapping)
  69 {
  70         free_io_memtype(mapping->base, mapping->size);
  71         kfree(mapping);
  72 }
  73
  74 /* Atomic map/unmap */
  75 static inline void *
  76 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
  77 {
  78         resource_size_t phys_addr;
  79         unsigned long pfn;
  80
  81         BUG_ON(offset >= mapping->size);
  82         phys_addr = mapping->base + offset;
  83         pfn = (unsigned long) (phys_addr >> PAGE_SHIFT);
  84         return iomap_atomic_prot_pfn(pfn, KM_USER0, mapping->prot);
  85 }
  86
  87 static inline void
  88 io_mapping_unmap_atomic(void *vaddr)
  89 {
  90         iounmap_atomic(vaddr, KM_USER0);
  91 }
  92
  93 static inline void *
  94 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset)
  95 {
  96         resource_size_t phys_addr;
  97
  98         BUG_ON(offset >= mapping->size);
  99         phys_addr = mapping->base + offset;
 100
 101         return ioremap_wc(phys_addr, PAGE_SIZE);
 102 }
 103
 104 static inline void
 105 io_mapping_unmap(void *vaddr)
 106 {
 107         iounmap(vaddr);
 108 }
 109
 110 #else
 111
 112 /* this struct isn't actually defined anywhere */
 113 struct io_mapping;
 114
 115 /* Create the io_mapping object*/
 116 static inline struct io_mapping *
 117 io_mapping_create_wc(resource_size_t base, unsigned long size)
 118 {
 119         return (struct io_mapping *) ioremap_wc(base, size);
 120 }
 121
 122 static inline void
 123 io_mapping_free(struct io_mapping *mapping)
 124 {
 125         iounmap(mapping);
 126 }
 127
 128 /* Atomic map/unmap */
 129 static inline void *
 130 io_mapping_map_atomic_wc(struct io_mapping *mapping, unsigned long offset)
 131 {
 132         return ((char *) mapping) + offset;
 133 }
 134
 135 static inline void
 136 io_mapping_unmap_atomic(void *vaddr)
 137 {
 138 }
 139
 140 /* Non-atomic map/unmap */
 141 static inline void *
 142 io_mapping_map_wc(struct io_mapping *mapping, unsigned long offset)
 143 {
 144         return ((char *) mapping) + offset;
 145 }
 146
 147 static inline void
 148 io_mapping_unmap(void *vaddr)
 149 {
 150 }
 151
 152 #endif /* HAVE_ATOMIC_IOMAP */
 153
 154 #endif /* _LINUX_IO_MAPPING_H */