arch/arm/include/asm/io.h

   1 /*
   2  *  linux/include/asm-arm/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  */
  20 #ifndef __ASM_ARM_IO_H
  21 #define __ASM_ARM_IO_H
  22
  23 #ifdef __KERNEL__
  24
  25 #include <linux/types.h>
  26 #include <asm/byteorder.h>
  27 #include <asm/memory.h>
  28 #if 0   /* XXX###XXX */
  29 #include <asm/arch/hardware.h>
  30 #endif  /* XXX###XXX */
  31
  32 static inline void sync(void)
  33 {
  34 }
  35
  36 /*
  37  * Given a physical address and a length, return a virtual address
  38  * that can be used to access the memory range with the caching
  39  * properties specified by "flags".
  40  */
  41 #define MAP_NOCACHE     (0)
  42 #define MAP_WRCOMBINE   (0)
  43 #define MAP_WRBACK      (0)
  44 #define MAP_WRTHROUGH   (0)
  45
  46 static inline void *
  47 map_physmem(phys_addr_t paddr, unsigned long len, unsigned long flags)
  48 {
  49         return (void *)paddr;
  50 }
  51
  52 /*
  53  * Take down a mapping set up by map_physmem().
  54  */
  55 static inline void unmap_physmem(void *vaddr, unsigned long flags)
  56 {
  57
  58 }
  59
  60 static inline phys_addr_t virt_to_phys(void * vaddr)
  61 {
  62         return (phys_addr_t)(vaddr);
  63 }
  64
  65 /*
  66  * Generic virtual read/write.  Note that we don't support half-word
  67  * read/writes.  We define __arch_*[bl] here, and leave __arch_*w
  68  * to the architecture specific code.
  69  */
  70 #define __arch_getb(a)                  (*(volatile unsigned char *)(a))
  71 #define __arch_getw(a)                  (*(volatile unsigned short *)(a))
  72 #define __arch_getl(a)                  (*(volatile unsigned int *)(a))
  73
  74 #define __arch_putb(v,a)                (*(volatile unsigned char *)(a) = (v))
  75 #define __arch_putw(v,a)                (*(volatile unsigned short *)(a) = (v))
  76 #define __arch_putl(v,a)                (*(volatile unsigned int *)(a) = (v))
  77
  78 extern inline void __raw_writesb(unsigned long addr, const void *data,
  79                                  int bytelen)
  80 {
  81         uint8_t *buf = (uint8_t *)data;
  82         while(bytelen--)
  83                 __arch_putb(*buf++, addr);
  84 }
  85
  86 extern inline void __raw_writesw(unsigned long addr, const void *data,
  87                                  int wordlen)
  88 {
  89         uint16_t *buf = (uint16_t *)data;
  90         while(wordlen--)
  91                 __arch_putw(*buf++, addr);
  92 }
  93
  94 extern inline void __raw_writesl(unsigned long addr, const void *data,
  95                                  int longlen)
  96 {
  97         uint32_t *buf = (uint32_t *)data;
  98         while(longlen--)
  99                 __arch_putl(*buf++, addr);
 100 }
 101
 102 extern inline void __raw_readsb(unsigned long addr, void *data, int bytelen)
 103 {
 104         uint8_t *buf = (uint8_t *)data;
 105         while(bytelen--)
 106                 *buf++ = __arch_getb(addr);
 107 }
 108
 109 extern inline void __raw_readsw(unsigned long addr, void *data, int wordlen)
 110 {
 111         uint16_t *buf = (uint16_t *)data;
 112         while(wordlen--)
 113                 *buf++ = __arch_getw(addr);
 114 }
 115
 116 extern inline void __raw_readsl(unsigned long addr, void *data, int longlen)
 117 {
 118         uint32_t *buf = (uint32_t *)data;
 119         while(longlen--)
 120                 *buf++ = __arch_getl(addr);
 121 }
 122
 123 #define __raw_writeb(v,a)       __arch_putb(v,a)
 124 #define __raw_writew(v,a)       __arch_putw(v,a)
 125 #define __raw_writel(v,a)       __arch_putl(v,a)
 126
 127 #define __raw_readb(a)          __arch_getb(a)
 128 #define __raw_readw(a)          __arch_getw(a)
 129 #define __raw_readl(a)          __arch_getl(a)
 130
 131 /*
 132  * TODO: The kernel offers some more advanced versions of barriers, it might
 133  * have some advantages to use them instead of the simple one here.
 134  */
 135 #define dmb()           __asm__ __volatile__ ("" : : : "memory")
 136 #define __iormb()       dmb()
 137 #define __iowmb()       dmb()
 138
 139 #define writeb(v,c)     ({ u8  __v = v; __iowmb(); __arch_putb(__v,c); __v; })
 140 #define writew(v,c)     ({ u16 __v = v; __iowmb(); __arch_putw(__v,c); __v; })
 141 #define writel(v,c)     ({ u32 __v = v; __iowmb(); __arch_putl(__v,c); __v; })
 142
 143 #define readb(c)        ({ u8  __v = __arch_getb(c); __iormb(); __v; })
 144 #define readw(c)        ({ u16 __v = __arch_getw(c); __iormb(); __v; })
 145 #define readl(c)        ({ u32 __v = __arch_getl(c); __iormb(); __v; })
 146
 147 /*
 148  * The compiler seems to be incapable of optimising constants
 149  * properly.  Spell it out to the compiler in some cases.
 150  * These are only valid for small values of "off" (< 1<<12)
 151  */
 152 #define __raw_base_writeb(val,base,off) __arch_base_putb(val,base,off)
 153 #define __raw_base_writew(val,base,off) __arch_base_putw(val,base,off)
 154 #define __raw_base_writel(val,base,off) __arch_base_putl(val,base,off)
 155
 156 #define __raw_base_readb(base,off)      __arch_base_getb(base,off)
 157 #define __raw_base_readw(base,off)      __arch_base_getw(base,off)
 158 #define __raw_base_readl(base,off)      __arch_base_getl(base,off)
 159
 160 /*
 161  * Clear and set bits in one shot. These macros can be used to clear and
 162  * set multiple bits in a register using a single call. These macros can
 163  * also be used to set a multiple-bit bit pattern using a mask, by
 164  * specifying the mask in the 'clear' parameter and the new bit pattern
 165  * in the 'set' parameter.
 166  */
 167
 168 #define out_arch(type,endian,a,v)       __raw_write##type(cpu_to_##endian(v),a)
 169 #define in_arch(type,endian,a)          endian##_to_cpu(__raw_read##type(a))
 170
 171 #define out_le32(a,v)   out_arch(l,le32,a,v)
 172 #define out_le16(a,v)   out_arch(w,le16,a,v)
 173
 174 #define in_le32(a)      in_arch(l,le32,a)
 175 #define in_le16(a)      in_arch(w,le16,a)
 176
 177 #define out_be32(a,v)   out_arch(l,be32,a,v)
 178 #define out_be16(a,v)   out_arch(w,be16,a,v)
 179
 180 #define in_be32(a)      in_arch(l,be32,a)
 181 #define in_be16(a)      in_arch(w,be16,a)
 182
 183 #define out_8(a,v)      __raw_writeb(v,a)
 184 #define in_8(a)         __raw_readb(a)
 185
 186 #define clrbits(type, addr, clear) \
 187         out_##type((addr), in_##type(addr) & ~(clear))
 188
 189 #define setbits(type, addr, set) \
 190         out_##type((addr), in_##type(addr) | (set))
 191
 192 #define clrsetbits(type, addr, clear, set) \
 193         out_##type((addr), (in_##type(addr) & ~(clear)) | (set))
 194
 195 #define clrbits_be32(addr, clear) clrbits(be32, addr, clear)
 196 #define setbits_be32(addr, set) setbits(be32, addr, set)
 197 #define clrsetbits_be32(addr, clear, set) clrsetbits(be32, addr, clear, set)
 198
 199 #define clrbits_le32(addr, clear) clrbits(le32, addr, clear)
 200 #define setbits_le32(addr, set) setbits(le32, addr, set)
 201 #define clrsetbits_le32(addr, clear, set) clrsetbits(le32, addr, clear, set)
 202
 203 #define clrbits_be16(addr, clear) clrbits(be16, addr, clear)
 204 #define setbits_be16(addr, set) setbits(be16, addr, set)
 205 #define clrsetbits_be16(addr, clear, set) clrsetbits(be16, addr, clear, set)
 206
 207 #define clrbits_le16(addr, clear) clrbits(le16, addr, clear)
 208 #define setbits_le16(addr, set) setbits(le16, addr, set)
 209 #define clrsetbits_le16(addr, clear, set) clrsetbits(le16, addr, clear, set)
 210
 211 #define clrbits_8(addr, clear) clrbits(8, addr, clear)
 212 #define setbits_8(addr, set) setbits(8, addr, set)
 213 #define clrsetbits_8(addr, clear, set) clrsetbits(8, addr, clear, set)
 214
 215 /*
 216  * Now, pick up the machine-defined IO definitions
 217  */
 218 #if 0   /* XXX###XXX */
 219 #include <asm/arch/io.h>
 220 #endif  /* XXX###XXX */
 221
 222 /*
 223  *  IO port access primitives
 224  *  -------------------------
 225  *
 226  * The ARM doesn't have special IO access instructions; all IO is memory
 227  * mapped.  Note that these are defined to perform little endian accesses
 228  * only.  Their primary purpose is to access PCI and ISA peripherals.
 229  *
 230  * Note that for a big endian machine, this implies that the following
 231  * big endian mode connectivity is in place, as described by numerous
 232  * ARM documents:
 233  *
 234  *    PCI:  D0-D7   D8-D15 D16-D23 D24-D31
 235  *    ARM: D24-D31 D16-D23  D8-D15  D0-D7
 236  *
 237  * The machine specific io.h include defines __io to translate an "IO"
 238  * address to a memory address.
 239  *
 240  * Note that we prevent GCC re-ordering or caching values in expressions
 241  * by introducing sequence points into the in*() definitions.  Note that
 242  * __raw_* do not guarantee this behaviour.
 243  *
 244  * The {in,out}[bwl] macros are for emulating x86-style PCI/ISA IO space.
 245  */
 246 #ifdef __io
 247 #define outb(v,p)                       __raw_writeb(v,__io(p))
 248 #define outw(v,p)                       __raw_writew(cpu_to_le16(v),__io(p))
 249 #define outl(v,p)                       __raw_writel(cpu_to_le32(v),__io(p))
 250
 251 #define inb(p)  ({ unsigned int __v = __raw_readb(__io(p)); __v; })
 252 #define inw(p)  ({ unsigned int __v = le16_to_cpu(__raw_readw(__io(p))); __v; })
 253 #define inl(p)  ({ unsigned int __v = le32_to_cpu(__raw_readl(__io(p))); __v; })
 254
 255 #define outsb(p,d,l)                    __raw_writesb(__io(p),d,l)
 256 #define outsw(p,d,l)                    __raw_writesw(__io(p),d,l)
 257 #define outsl(p,d,l)                    __raw_writesl(__io(p),d,l)
 258
 259 #define insb(p,d,l)                     __raw_readsb(__io(p),d,l)
 260 #define insw(p,d,l)                     __raw_readsw(__io(p),d,l)
 261 #define insl(p,d,l)                     __raw_readsl(__io(p),d,l)
 262 #endif
 263
 264 #define outb_p(val,port)                outb((val),(port))
 265 #define outw_p(val,port)                outw((val),(port))
 266 #define outl_p(val,port)                outl((val),(port))
 267 #define inb_p(port)                     inb((port))
 268 #define inw_p(port)                     inw((port))
 269 #define inl_p(port)                     inl((port))
 270
 271 #define outsb_p(port,from,len)          outsb(port,from,len)
 272 #define outsw_p(port,from,len)          outsw(port,from,len)
 273 #define outsl_p(port,from,len)          outsl(port,from,len)
 274 #define insb_p(port,to,len)             insb(port,to,len)
 275 #define insw_p(port,to,len)             insw(port,to,len)
 276 #define insl_p(port,to,len)             insl(port,to,len)
 277
 278 /*
 279  * ioremap and friends.
 280  *
 281  * ioremap takes a PCI memory address, as specified in
 282  * linux/Documentation/IO-mapping.txt.  If you want a
 283  * physical address, use __ioremap instead.
 284  */
 285 extern void * __ioremap(unsigned long offset, size_t size, unsigned long flags);
 286 extern void __iounmap(void *addr);
 287
 288 /*
 289  * Generic ioremap support.
 290  *
 291  * Define:
 292  *  iomem_valid_addr(off,size)
 293  *  iomem_to_phys(off)
 294  */
 295 #ifdef iomem_valid_addr
 296 #define __arch_ioremap(off,sz,nocache)                                  \
 297  ({                                                                     \
 298         unsigned long _off = (off), _size = (sz);                       \
 299         void *_ret = (void *)0;                                         \
 300         if (iomem_valid_addr(_off, _size))                              \
 301                 _ret = __ioremap(iomem_to_phys(_off),_size,nocache);    \
 302         _ret;                                                           \
 303  })
 304
 305 #define __arch_iounmap __iounmap
 306 #endif
 307
 308 #define ioremap(off,sz)                 __arch_ioremap((off),(sz),0)
 309 #define ioremap_nocache(off,sz)         __arch_ioremap((off),(sz),1)
 310 #define iounmap(_addr)                  __arch_iounmap(_addr)
 311
 312 /*
 313  * DMA-consistent mapping functions.  These allocate/free a region of
 314  * uncached, unwrite-buffered mapped memory space for use with DMA
 315  * devices.  This is the "generic" version.  The PCI specific version
 316  * is in pci.h
 317  */
 318 extern void *consistent_alloc(int gfp, size_t size, dma_addr_t *handle);
 319 extern void consistent_free(void *vaddr, size_t size, dma_addr_t handle);
 320 extern void consistent_sync(void *vaddr, size_t size, int rw);
 321
 322 /*
 323  * String version of IO memory access ops:
 324  */
 325 extern void _memcpy_fromio(void *, unsigned long, size_t);
 326 extern void _memcpy_toio(unsigned long, const void *, size_t);
 327 extern void _memset_io(unsigned long, int, size_t);
 328
 329 extern void __readwrite_bug(const char *fn);
 330
 331 /*
 332  * If this architecture has PCI memory IO, then define the read/write
 333  * macros.  These should only be used with the cookie passed from
 334  * ioremap.
 335  */
 336 #ifdef __mem_pci
 337
 338 #define readb(c) ({ unsigned int __v = __raw_readb(__mem_pci(c)); __v; })
 339 #define readw(c) ({ unsigned int __v = le16_to_cpu(__raw_readw(__mem_pci(c))); __v; })
 340 #define readl(c) ({ unsigned int __v = le32_to_cpu(__raw_readl(__mem_pci(c))); __v; })
 341
 342 #define writeb(v,c)             __raw_writeb(v,__mem_pci(c))
 343 #define writew(v,c)             __raw_writew(cpu_to_le16(v),__mem_pci(c))
 344 #define writel(v,c)             __raw_writel(cpu_to_le32(v),__mem_pci(c))
 345
 346 #define memset_io(c,v,l)                _memset_io(__mem_pci(c),(v),(l))
 347 #define memcpy_fromio(a,c,l)            _memcpy_fromio((a),__mem_pci(c),(l))
 348 #define memcpy_toio(c,a,l)              _memcpy_toio(__mem_pci(c),(a),(l))
 349
 350 #define eth_io_copy_and_sum(s,c,l,b) \
 351                                 eth_copy_and_sum((s),__mem_pci(c),(l),(b))
 352
 353 static inline int
 354 check_signature(unsigned long io_addr, const unsigned char *signature,
 355                 int length)
 356 {
 357         int retval = 0;
 358         do {
 359                 if (readb(io_addr) != *signature)
 360                         goto out;
 361                 io_addr++;
 362                 signature++;
 363                 length--;
 364         } while (length);
 365         retval = 1;
 366 out:
 367         return retval;
 368 }
 369
 370 #elif !defined(readb)
 371
 372 #define readb(addr)                     (__readwrite_bug("readb"),0)
 373 #define readw(addr)                     (__readwrite_bug("readw"),0)
 374 #define readl(addr)                     (__readwrite_bug("readl"),0)
 375 #define writeb(v,addr)                  __readwrite_bug("writeb")
 376 #define writew(v,addr)                  __readwrite_bug("writew")
 377 #define writel(v,addr)                  __readwrite_bug("writel")
 378
 379 #define eth_io_copy_and_sum(a,b,c,d)    __readwrite_bug("eth_io_copy_and_sum")
 380
 381 #define check_signature(io,sig,len)     (0)
 382
 383 #endif  /* __mem_pci */
 384
 385 /*
 386  * If this architecture has ISA IO, then define the isa_read/isa_write
 387  * macros.
 388  */
 389 #ifdef __mem_isa
 390
 391 #define isa_readb(addr)                 __raw_readb(__mem_isa(addr))
 392 #define isa_readw(addr)                 __raw_readw(__mem_isa(addr))
 393 #define isa_readl(addr)                 __raw_readl(__mem_isa(addr))
 394 #define isa_writeb(val,addr)            __raw_writeb(val,__mem_isa(addr))
 395 #define isa_writew(val,addr)            __raw_writew(val,__mem_isa(addr))
 396 #define isa_writel(val,addr)            __raw_writel(val,__mem_isa(addr))
 397 #define isa_memset_io(a,b,c)            _memset_io(__mem_isa(a),(b),(c))
 398 #define isa_memcpy_fromio(a,b,c)        _memcpy_fromio((a),__mem_isa(b),(c))
 399 #define isa_memcpy_toio(a,b,c)          _memcpy_toio(__mem_isa((a)),(b),(c))
 400
 401 #define isa_eth_io_copy_and_sum(a,b,c,d) \
 402                                 eth_copy_and_sum((a),__mem_isa(b),(c),(d))
 403
 404 static inline int
 405 isa_check_signature(unsigned long io_addr, const unsigned char *signature,
 406                     int length)
 407 {
 408         int retval = 0;
 409         do {
 410                 if (isa_readb(io_addr) != *signature)
 411                         goto out;
 412                 io_addr++;
 413                 signature++;
 414                 length--;
 415         } while (length);
 416         retval = 1;
 417 out:
 418         return retval;
 419 }
 420
 421 #else   /* __mem_isa */
 422
 423 #define isa_readb(addr)                 (__readwrite_bug("isa_readb"),0)
 424 #define isa_readw(addr)                 (__readwrite_bug("isa_readw"),0)
 425 #define isa_readl(addr)                 (__readwrite_bug("isa_readl"),0)
 426 #define isa_writeb(val,addr)            __readwrite_bug("isa_writeb")
 427 #define isa_writew(val,addr)            __readwrite_bug("isa_writew")
 428 #define isa_writel(val,addr)            __readwrite_bug("isa_writel")
 429 #define isa_memset_io(a,b,c)            __readwrite_bug("isa_memset_io")
 430 #define isa_memcpy_fromio(a,b,c)        __readwrite_bug("isa_memcpy_fromio")
 431 #define isa_memcpy_toio(a,b,c)          __readwrite_bug("isa_memcpy_toio")
 432
 433 #define isa_eth_io_copy_and_sum(a,b,c,d) \
 434                                 __readwrite_bug("isa_eth_io_copy_and_sum")
 435
 436 #define isa_check_signature(io,sig,len) (0)
 437
 438 #endif  /* __mem_isa */
 439 #endif  /* __KERNEL__ */
 440
 441 #include <iotrace.h>
 442
 443 #endif  /* __ASM_ARM_IO_H */