sys/compat/linuxkpi/common/include/linux/io.h

   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-2015 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 #ifndef _LINUX_IO_H_
  32 #define _LINUX_IO_H_
  33
  34 #include <machine/vm.h>
  35 #include <sys/endian.h>
  36 #include <sys/types.h>
  37
  38 #include <linux/compiler.h>
  39 #include <linux/types.h>
  40
  41 static inline uint32_t
  42 __raw_readl(const volatile void *addr)
  43 {
  44         return *(const volatile uint32_t *)addr;
  45 }
  46
  47 static inline void
  48 __raw_writel(uint32_t b, volatile void *addr)
  49 {
  50         *(volatile uint32_t *)addr = b;
  51 }
  52
  53 static inline uint64_t
  54 __raw_readq(const volatile void *addr)
  55 {
  56         return *(const volatile uint64_t *)addr;
  57 }
  58
  59 static inline void
  60 __raw_writeq(uint64_t b, volatile void *addr)
  61 {
  62         *(volatile uint64_t *)addr = b;
  63 }
  64
  65 /*
  66  * XXX This is all x86 specific.  It should be bus space access.
  67  */
  68 #define mmiowb()        barrier()
  69
  70 #undef writel
  71 static inline void
  72 writel(uint32_t b, void *addr)
  73 {
  74         *(volatile uint32_t *)addr = b;
  75 }
  76
  77 #undef writeq
  78 static inline void
  79 writeq(uint64_t b, void *addr)
  80 {
  81         *(volatile uint64_t *)addr = b;
  82 }
  83
  84 #undef writeb
  85 static inline void
  86 writeb(uint8_t b, void *addr)
  87 {
  88         *(volatile uint8_t *)addr = b;
  89 }
  90
  91 #undef writew
  92 static inline void
  93 writew(uint16_t b, void *addr)
  94 {
  95         *(volatile uint16_t *)addr = b;
  96 }
  97
  98 #undef ioread8
  99 static inline uint8_t
 100 ioread8(const volatile void *addr)
 101 {
 102         return *(const volatile uint8_t *)addr;
 103 }
 104
 105 #undef ioread16
 106 static inline uint16_t
 107 ioread16(const volatile void *addr)
 108 {
 109         return *(const volatile uint16_t *)addr;
 110 }
 111
 112 #undef ioread32
 113 static inline uint32_t
 114 ioread32(const volatile void *addr)
 115 {
 116         return *(const volatile uint32_t *)addr;
 117 }
 118
 119 #undef ioread32be
 120 static inline uint32_t
 121 ioread32be(const volatile void *addr)
 122 {
 123         return be32toh(*(const volatile uint32_t *)addr);
 124 }
 125
 126 #undef iowrite8
 127 static inline void
 128 iowrite8(uint8_t v, volatile void *addr)
 129 {
 130         *(volatile uint8_t *)addr = v;
 131 }
 132
 133 #undef iowrite16
 134 static inline void
 135 iowrite16(uint16_t v, volatile void *addr)
 136 {
 137         *(volatile uint16_t *)addr = v;
 138 }
 139
 140 #undef iowrite32
 141 static inline void
 142 iowrite32(uint32_t v, volatile void *addr)
 143 {
 144         *(volatile uint32_t *)addr = v;
 145 }
 146
 147 #undef iowrite32be
 148 static inline void
 149 iowrite32be(uint32_t v, volatile void *addr)
 150 {
 151         *(volatile uint32_t *)addr = htobe32(v);
 152 }
 153
 154 #undef readb
 155 static inline uint8_t
 156 readb(const volatile void *addr)
 157 {
 158         return *(const volatile uint8_t *)addr;
 159 }
 160
 161 #undef readw
 162 static inline uint16_t
 163 readw(const volatile void *addr)
 164 {
 165         return *(const volatile uint16_t *)addr;
 166 }
 167
 168 #undef readl
 169 static inline uint32_t
 170 readl(const volatile void *addr)
 171 {
 172         return *(const volatile uint32_t *)addr;
 173 }
 174
 175 #if defined(__i386__) || defined(__amd64__)
 176 static inline void
 177 _outb(u_char data, u_int port)
 178 {
 179         __asm __volatile("outb %0, %w1" : : "a" (data), "Nd" (port));
 180 }
 181 #endif
 182
 183 #if defined(__i386__) || defined(__amd64__)
 184 void *_ioremap_attr(vm_paddr_t phys_addr, unsigned long size, int attr);
 185 #else
 186 #define _ioremap_attr(...) NULL
 187 #endif
 188
 189 #define ioremap_nocache(addr, size)                                     \
 190     _ioremap_attr((addr), (size), VM_MEMATTR_UNCACHEABLE)
 191 #define ioremap_wc(addr, size)                                          \
 192     _ioremap_attr((addr), (size), VM_MEMATTR_WRITE_COMBINING)
 193 #define ioremap_wb(addr, size)                                          \
 194     _ioremap_attr((addr), (size), VM_MEMATTR_WRITE_BACK)
 195 #define ioremap_wt(addr, size)                                          \
 196     _ioremap_attr((addr), (size), VM_MEMATTR_WRITE_THROUGH)
 197 #define ioremap(addr, size)                                             \
 198     _ioremap_attr((addr), (size), VM_MEMATTR_UNCACHEABLE)
 199 void iounmap(void *addr);
 200
 201 #define memset_io(a, b, c)      memset((a), (b), (c))
 202 #define memcpy_fromio(a, b, c)  memcpy((a), (b), (c))
 203 #define memcpy_toio(a, b, c)    memcpy((a), (b), (c))
 204
 205 static inline void
 206 __iowrite32_copy(void *to, void *from, size_t count)
 207 {
 208         uint32_t *src;
 209         uint32_t *dst;
 210         int i;
 211
 212         for (i = 0, src = from, dst = to; i < count; i++, src++, dst++)
 213                 __raw_writel(*src, dst);
 214 }
 215
 216 static inline void
 217 __iowrite64_copy(void *to, void *from, size_t count)
 218 {
 219 #ifdef __LP64__
 220         uint64_t *src;
 221         uint64_t *dst;
 222         int i;
 223
 224         for (i = 0, src = from, dst = to; i < count; i++, src++, dst++)
 225                 __raw_writeq(*src, dst);
 226 #else
 227         __iowrite32_copy(to, from, count * 2);
 228 #endif
 229 }
 230
 231 enum {
 232         MEMREMAP_WB = 1 << 0,
 233         MEMREMAP_WT = 1 << 1,
 234         MEMREMAP_WC = 1 << 2,
 235 };
 236
 237 static inline void *
 238 memremap(resource_size_t offset, size_t size, unsigned long flags)
 239 {
 240         void *addr = NULL;
 241
 242         if ((flags & MEMREMAP_WB) &&
 243             (addr = ioremap_wb(offset, size)) != NULL)
 244                 goto done;
 245         if ((flags & MEMREMAP_WT) &&
 246             (addr = ioremap_wt(offset, size)) != NULL)
 247                 goto done;
 248         if ((flags & MEMREMAP_WC) &&
 249             (addr = ioremap_wc(offset, size)) != NULL)
 250                 goto done;
 251 done:
 252         return (addr);
 253 }
 254
 255 static inline void
 256 memunmap(void *addr)
 257 {
 258         /* XXX May need to check if this is RAM */
 259         iounmap(addr);
 260 }
 261
 262 #endif  /* _LINUX_IO_H_ */