arch/arm/include/asm/io.h

   1 /*
   2  *  arch/arm/include/asm/io.h
   3  *
   4  *  Copyright (C) 1996-2000 Russell King
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * Modifications:
  11  *  16-Sep-1996 RMK     Inlined the inx/outx functions & optimised for both
  12  *                      constant addresses and variable addresses.
  13  *  04-Dec-1997 RMK     Moved a lot of this stuff to the new architecture
  14  *                      specific IO header files.
  15  *  27-Mar-1999 PJB     Second parameter of memcpy_toio is const..
  16  *  04-Apr-1999 PJB     Added check_signature.
  17  *  12-Dec-1999 RMK     More cleanups
  18  *  18-Jun-2000 RMK     Removed virt_to_* and friends definitions
  19  *  05-Oct-2004 BJD     Moved memory string functions to use void __iomem
  20  */
  21 #ifndef __ASM_ARM_IO_H
  22 #define __ASM_ARM_IO_H
  23
  24 #ifdef __KERNEL__
  25
  26 #include <linux/types.h>
  27 #include <asm/byteorder.h>
  28 #include <asm/memory.h>
  29 #include <asm/system.h>
  30
  31 /*
  32  * ISA I/O bus memory addresses are 1:1 with the physical address.
  33  */
  34 #define isa_virt_to_bus virt_to_phys
  35 #define isa_page_to_bus page_to_phys
  36 #define isa_bus_to_virt phys_to_virt
  37
  38 /*
  39  * Generic IO read/write.  These perform native-endian accesses.  Note
  40  * that some architectures will want to re-define __raw_{read,write}w.
  41  */
  42 extern void __raw_writesb(void __iomem *addr, const void *data, int bytelen);
  43 extern void __raw_writesw(void __iomem *addr, const void *data, int wordlen);
  44 extern void __raw_writesl(void __iomem *addr, const void *data, int longlen);
  45
  46 extern void __raw_readsb(const void __iomem *addr, void *data, int bytelen);
  47 extern void __raw_readsw(const void __iomem *addr, void *data, int wordlen);
  48 extern void __raw_readsl(const void __iomem *addr, void *data, int longlen);
  49
  50 #define __raw_writeb(v,a)       (__chk_io_ptr(a), *(volatile unsigned char __force  *)(a) = (v))
  51 #define __raw_writew(v,a)       (__chk_io_ptr(a), *(volatile unsigned short __force *)(a) = (v))
  52 #define __raw_writel(v,a)       (__chk_io_ptr(a), *(volatile unsigned int __force   *)(a) = (v))
  53
  54 #define __raw_readb(a)          (__chk_io_ptr(a), *(volatile unsigned char __force  *)(a))
  55 #define __raw_readw(a)          (__chk_io_ptr(a), *(volatile unsigned short __force *)(a))
  56 #define __raw_readl(a)          (__chk_io_ptr(a), *(volatile unsigned int __force   *)(a))
  57
  58 /*
  59  * Architecture ioremap implementation.
  60  */
  61 #define MT_DEVICE               0
  62 #define MT_DEVICE_NONSHARED     1
  63 #define MT_DEVICE_CACHED        2
  64 #define MT_DEVICE_WC            3
  65 /*
  66  * types 4 onwards can be found in asm/mach/map.h and are undefined
  67  * for ioremap
  68  */
  69
  70 /*
  71  * __arm_ioremap takes CPU physical address.
  72  * __arm_ioremap_pfn takes a Page Frame Number and an offset into that page
  73  * The _caller variety takes a __builtin_return_address(0) value for
  74  * /proc/vmalloc to use - and should only be used in non-inline functions.
  75  */
  76 extern void __iomem *__arm_ioremap_pfn_caller(unsigned long, unsigned long,
  77         size_t, unsigned int, void *);
  78 extern void __iomem *__arm_ioremap_caller(unsigned long, size_t, unsigned int,
  79         void *);
  80
  81 extern void __iomem *__arm_ioremap_pfn(unsigned long, unsigned long, size_t, unsigned int);
  82 extern void __iomem *__arm_ioremap(unsigned long, size_t, unsigned int);
  83 extern void __iomem *__arm_ioremap_exec(unsigned long, size_t, bool cached);
  84 extern void __iounmap(volatile void __iomem *addr);
  85
  86 extern void __iomem *ioremap_prot(resource_size_t, unsigned long size,
  87         unsigned long prot_val);
  88
  89 /*
  90  * Bad read/write accesses...
  91  */
  92 extern void __readwrite_bug(const char *fn);
  93
  94 /*
  95  * A typesafe __io() helper
  96  */
  97 static inline void __iomem *__typesafe_io(unsigned long addr)
  98 {
  99         return (void __iomem *)addr;
 100 }
 101
 102 /* IO barriers */
 103 #ifdef CONFIG_ARM_DMA_MEM_BUFFERABLE
 104 #define __iormb()               rmb()
 105 #define __iowmb()               wmb()
 106 #else
 107 #define __iormb()               do { } while (0)
 108 #define __iowmb()               do { } while (0)
 109 #endif
 110
 111 /*
 112  * Now, pick up the machine-defined IO definitions
 113  */
 114 #include <mach/io.h>
 115
 116 /*
 117  * This is the limit of PC card/PCI/ISA IO space, which is by default
 118  * 64K if we have PC card, PCI or ISA support.  Otherwise, default to
 119  * zero to prevent ISA/PCI drivers claiming IO space (and potentially
 120  * oopsing.)
 121  *
 122  * Only set this larger if you really need inb() et.al. to operate over
 123  * a larger address space.  Note that SOC_COMMON ioremaps each sockets
 124  * IO space area, and so inb() et.al. must be defined to operate as per
 125  * readb() et.al. on such platforms.
 126  */
 127 #ifndef IO_SPACE_LIMIT
 128 #if defined(CONFIG_PCMCIA_SOC_COMMON) || defined(CONFIG_PCMCIA_SOC_COMMON_MODULE)
 129 #define IO_SPACE_LIMIT ((resource_size_t)0xffffffff)
 130 #elif defined(CONFIG_PCI) || defined(CONFIG_ISA) || defined(CONFIG_PCCARD)
 131 #define IO_SPACE_LIMIT ((resource_size_t)0xffff)
 132 #else
 133 #define IO_SPACE_LIMIT ((resource_size_t)0)
 134 #endif
 135 #endif
 136
 137 /*
 138  *  IO port access primitives
 139  *  -------------------------
 140  *
 141  * The ARM doesn't have special IO access instructions; all IO is memory
 142  * mapped.  Note that these are defined to perform little endian accesses
 143  * only.  Their primary purpose is to access PCI and ISA peripherals.
 144  *
 145  * Note that for a big endian machine, this implies that the following
 146  * big endian mode connectivity is in place, as described by numerous
 147  * ARM documents:
 148  *
 149  *    PCI:  D0-D7   D8-D15 D16-D23 D24-D31
 150  *    ARM: D24-D31 D16-D23  D8-D15  D0-D7
 151  *
 152  * The machine specific io.h include defines __io to translate an "IO"
 153  * address to a memory address.
 154  *
 155  * Note that we prevent GCC re-ordering or caching values in expressions
 156  * by introducing sequence points into the in*() definitions.  Note that
 157  * __raw_* do not guarantee this behaviour.
 158  *
 159  * The {in,out}[bwl] macros are for emulating x86-style PCI/ISA IO space.
 160  */
 161 #ifdef __io
 162 #define outb(v,p)       ({ __iowmb(); __raw_writeb(v,__io(p)); })
 163 #define outw(v,p)       ({ __iowmb(); __raw_writew((__force __u16) \
 164                                         cpu_to_le16(v),__io(p)); })
 165 #define outl(v,p)       ({ __iowmb(); __raw_writel((__force __u32) \
 166                                         cpu_to_le32(v),__io(p)); })
 167
 168 #define inb(p)  ({ __u8 __v = __raw_readb(__io(p)); __iormb(); __v; })
 169 #define inw(p)  ({ __u16 __v = le16_to_cpu((__force __le16) \
 170                         __raw_readw(__io(p))); __iormb(); __v; })
 171 #define inl(p)  ({ __u32 __v = le32_to_cpu((__force __le32) \
 172                         __raw_readl(__io(p))); __iormb(); __v; })
 173
 174 #define outsb(p,d,l)            __raw_writesb(__io(p),d,l)
 175 #define outsw(p,d,l)            __raw_writesw(__io(p),d,l)
 176 #define outsl(p,d,l)            __raw_writesl(__io(p),d,l)
 177
 178 #define insb(p,d,l)             __raw_readsb(__io(p),d,l)
 179 #define insw(p,d,l)             __raw_readsw(__io(p),d,l)
 180 #define insl(p,d,l)             __raw_readsl(__io(p),d,l)
 181 #endif
 182
 183 #define outb_p(val,port)        outb((val),(port))
 184 #define outw_p(val,port)        outw((val),(port))
 185 #define outl_p(val,port)        outl((val),(port))
 186 #define inb_p(port)             inb((port))
 187 #define inw_p(port)             inw((port))
 188 #define inl_p(port)             inl((port))
 189
 190 #define outsb_p(port,from,len)  outsb(port,from,len)
 191 #define outsw_p(port,from,len)  outsw(port,from,len)
 192 #define outsl_p(port,from,len)  outsl(port,from,len)
 193 #define insb_p(port,to,len)     insb(port,to,len)
 194 #define insw_p(port,to,len)     insw(port,to,len)
 195 #define insl_p(port,to,len)     insl(port,to,len)
 196
 197 /*
 198  * String version of IO memory access ops:
 199  */
 200 extern void _memcpy_fromio(void *, const volatile void __iomem *, size_t);
 201 extern void _memcpy_toio(volatile void __iomem *, const void *, size_t);
 202 extern void _memset_io(volatile void __iomem *, int, size_t);
 203
 204 #define mmiowb()
 205
 206 /*
 207  *  Memory access primitives
 208  *  ------------------------
 209  *
 210  * These perform PCI memory accesses via an ioremap region.  They don't
 211  * take an address as such, but a cookie.
 212  *
 213  * Again, this are defined to perform little endian accesses.  See the
 214  * IO port primitives for more information.
 215  */
 216 #ifdef __mem_pci
 217 #define readb_relaxed(c) ({ u8  __r = __raw_readb(__mem_pci(c)); __r; })
 218 #define readw_relaxed(c) ({ u16 __r = le16_to_cpu((__force __le16) \
 219                                         __raw_readw(__mem_pci(c))); __r; })
 220 #define readl_relaxed(c) ({ u32 __r = le32_to_cpu((__force __le32) \
 221                                         __raw_readl(__mem_pci(c))); __r; })
 222
 223 #define writeb_relaxed(v,c)     ((void)__raw_writeb(v,__mem_pci(c)))
 224 #define writew_relaxed(v,c)     ((void)__raw_writew((__force u16) \
 225                                         cpu_to_le16(v),__mem_pci(c)))
 226 #define writel_relaxed(v,c)     ((void)__raw_writel((__force u32) \
 227                                         cpu_to_le32(v),__mem_pci(c)))
 228
 229 #define readb(c)                ({ u8  __v = readb_relaxed(c); __iormb(); __v; })
 230 #define readw(c)                ({ u16 __v = readw_relaxed(c); __iormb(); __v; })
 231 #define readl(c)                ({ u32 __v = readl_relaxed(c); __iormb(); __v; })
 232
 233 #define writeb(v,c)             ({ __iowmb(); writeb_relaxed(v,c); })
 234 #define writew(v,c)             ({ __iowmb(); writew_relaxed(v,c); })
 235 #define writel(v,c)             ({ __iowmb(); writel_relaxed(v,c); })
 236
 237 #define readsb(p,d,l)           __raw_readsb(__mem_pci(p),d,l)
 238 #define readsw(p,d,l)           __raw_readsw(__mem_pci(p),d,l)
 239 #define readsl(p,d,l)           __raw_readsl(__mem_pci(p),d,l)
 240
 241 #define writesb(p,d,l)          __raw_writesb(__mem_pci(p),d,l)
 242 #define writesw(p,d,l)          __raw_writesw(__mem_pci(p),d,l)
 243 #define writesl(p,d,l)          __raw_writesl(__mem_pci(p),d,l)
 244
 245 #define memset_io(c,v,l)        _memset_io(__mem_pci(c),(v),(l))
 246 #define memcpy_fromio(a,c,l)    _memcpy_fromio((a),__mem_pci(c),(l))
 247 #define memcpy_toio(c,a,l)      _memcpy_toio(__mem_pci(c),(a),(l))
 248
 249 #elif !defined(readb)
 250
 251 #define readb(c)                        (__readwrite_bug("readb"),0)
 252 #define readw(c)                        (__readwrite_bug("readw"),0)
 253 #define readl(c)                        (__readwrite_bug("readl"),0)
 254 #define writeb(v,c)                     __readwrite_bug("writeb")
 255 #define writew(v,c)                     __readwrite_bug("writew")
 256 #define writel(v,c)                     __readwrite_bug("writel")
 257
 258 #define check_signature(io,sig,len)     (0)
 259
 260 #endif  /* __mem_pci */
 261
 262 /*
 263  * ioremap and friends.
 264  *
 265  * ioremap takes a PCI memory address, as specified in
 266  * Documentation/io-mapping.txt.
 267  *
 268  */
 269 #ifndef __arch_ioremap
 270 #define __arch_ioremap                  __arm_ioremap
 271 #define __arch_iounmap                  __iounmap
 272 #endif
 273
 274 #define ioremap(cookie,size)            __arch_ioremap((cookie), (size), MT_DEVICE)
 275 #define ioremap_nocache(cookie,size)    __arch_ioremap((cookie), (size), MT_DEVICE)
 276 #define ioremap_cached(cookie,size)     __arch_ioremap((cookie), (size), MT_DEVICE_CACHED)
 277 #define ioremap_wc(cookie,size)         __arch_ioremap((cookie), (size), MT_DEVICE_WC)
 278 #define iounmap                         __arch_iounmap
 279
 280 /*
 281  * io{read,write}{8,16,32} macros
 282  */
 283 #ifndef ioread8
 284 #define ioread8(p)      ({ unsigned int __v = __raw_readb(p); __iormb(); __v; })
 285 #define ioread16(p)     ({ unsigned int __v = le16_to_cpu((__force __le16)__raw_readw(p)); __iormb(); __v; })
 286 #define ioread32(p)     ({ unsigned int __v = le32_to_cpu((__force __le32)__raw_readl(p)); __iormb(); __v; })
 287
 288 #define ioread16be(p)   ({ unsigned int __v = be16_to_cpu((__force __be16)__raw_readw(p)); __iormb(); __v; })
 289 #define ioread32be(p)   ({ unsigned int __v = be32_to_cpu((__force __be32)__raw_readl(p)); __iormb(); __v; })
 290
 291 #define iowrite8(v,p)   ({ __iowmb(); (void)__raw_writeb(v, p); })
 292 #define iowrite16(v,p)  ({ __iowmb(); (void)__raw_writew((__force __u16)cpu_to_le16(v), p); })
 293 #define iowrite32(v,p)  ({ __iowmb(); (void)__raw_writel((__force __u32)cpu_to_le32(v), p); })
 294
 295 #define iowrite16be(v,p) ({ __iowmb(); (void)__raw_writew((__force __u16)cpu_to_be16(v), p); })
 296 #define iowrite32be(v,p) ({ __iowmb(); (void)__raw_writel((__force __u32)cpu_to_be32(v), p); })
 297
 298 #define ioread8_rep(p,d,c)      __raw_readsb(p,d,c)
 299 #define ioread16_rep(p,d,c)     __raw_readsw(p,d,c)
 300 #define ioread32_rep(p,d,c)     __raw_readsl(p,d,c)
 301
 302 #define iowrite8_rep(p,s,c)     __raw_writesb(p,s,c)
 303 #define iowrite16_rep(p,s,c)    __raw_writesw(p,s,c)
 304 #define iowrite32_rep(p,s,c)    __raw_writesl(p,s,c)
 305
 306 extern void __iomem *ioport_map(unsigned long port, unsigned int nr);
 307 extern void ioport_unmap(void __iomem *addr);
 308 #endif
 309
 310 struct pci_dev;
 311
 312 extern void __iomem *pci_iomap(struct pci_dev *dev, int bar, unsigned long maxlen);
 313 extern void pci_iounmap(struct pci_dev *dev, void __iomem *addr);
 314
 315 /*
 316  * can the hardware map this into one segment or not, given no other
 317  * constraints.
 318  */
 319 #define BIOVEC_MERGEABLE(vec1, vec2)    \
 320         ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
 321
 322 #ifdef CONFIG_MMU
 323 #define ARCH_HAS_VALID_PHYS_ADDR_RANGE
 324 extern int valid_phys_addr_range(unsigned long addr, size_t size);
 325 extern int valid_mmap_phys_addr_range(unsigned long pfn, size_t size);
 326 extern int devmem_is_allowed(unsigned long pfn);
 327 #endif
 328
 329 /*
 330  * Convert a physical pointer to a virtual kernel pointer for /dev/mem
 331  * access
 332  */
 333 #define xlate_dev_mem_ptr(p)    __va(p)
 334
 335 /*
 336  * Convert a virtual cached pointer to an uncached pointer
 337  */
 338 #define xlate_dev_kmem_ptr(p)   p
 339
 340 /*
 341  * Register ISA memory and port locations for glibc iopl/inb/outb
 342  * emulation.
 343  */
 344 extern void register_isa_ports(unsigned int mmio, unsigned int io,
 345                                unsigned int io_shift);
 346
 347 #endif  /* __KERNEL__ */
 348 #endif  /* __ASM_ARM_IO_H */