include/asm-arm/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 /*
  33  * Generic virtual read/write.  Note that we don't support half-word
  34  * read/writes.  We define __arch_*[bl] here, and leave __arch_*w
  35  * to the architecture specific code.
  36  */
  37 #define __arch_getb(a)                  (*(volatile unsigned char *)(a))
  38 #define __arch_getw(a)                  (*(volatile unsigned short *)(a))
  39 #define __arch_getl(a)                  (*(volatile unsigned int *)(a))
  40
  41 #define __arch_putb(v,a)                (*(volatile unsigned char *)(a) = (v))
  42 #define __arch_putw(v,a)                (*(volatile unsigned short *)(a) = (v))
  43 #define __arch_putl(v,a)                (*(volatile unsigned int *)(a) = (v))
  44
  45 extern void __raw_writesb(unsigned int addr, const void *data, int bytelen);
  46 extern void __raw_writesw(unsigned int addr, const void *data, int wordlen);
  47 extern void __raw_writesl(unsigned int addr, const void *data, int longlen);
  48
  49 extern void __raw_readsb(unsigned int addr, void *data, int bytelen);
  50 extern void __raw_readsw(unsigned int addr, void *data, int wordlen);
  51 extern void __raw_readsl(unsigned int addr, void *data, int longlen);
  52
  53 #define __raw_writeb(v,a)               __arch_putb(v,a)
  54 #define __raw_writew(v,a)               __arch_putw(v,a)
  55 #define __raw_writel(v,a)               __arch_putl(v,a)
  56
  57 #define __raw_readb(a)                  __arch_getb(a)
  58 #define __raw_readw(a)                  __arch_getw(a)
  59 #define __raw_readl(a)                  __arch_getl(a)
  60
  61 /*
  62  * The compiler seems to be incapable of optimising constants
  63  * properly.  Spell it out to the compiler in some cases.
  64  * These are only valid for small values of "off" (< 1<<12)
  65  */
  66 #define __raw_base_writeb(val,base,off) __arch_base_putb(val,base,off)
  67 #define __raw_base_writew(val,base,off) __arch_base_putw(val,base,off)
  68 #define __raw_base_writel(val,base,off) __arch_base_putl(val,base,off)
  69
  70 #define __raw_base_readb(base,off)      __arch_base_getb(base,off)
  71 #define __raw_base_readw(base,off)      __arch_base_getw(base,off)
  72 #define __raw_base_readl(base,off)      __arch_base_getl(base,off)
  73
  74 /*
  75  * Now, pick up the machine-defined IO definitions
  76  */
  77 #if 0   /* XXX###XXX */
  78 #include <asm/arch/io.h>
  79 #endif  /* XXX###XXX */
  80
  81 /*
  82  *  IO port access primitives
  83  *  -------------------------
  84  *
  85  * The ARM doesn't have special IO access instructions; all IO is memory
  86  * mapped.  Note that these are defined to perform little endian accesses
  87  * only.  Their primary purpose is to access PCI and ISA peripherals.
  88  *
  89  * Note that for a big endian machine, this implies that the following
  90  * big endian mode connectivity is in place, as described by numerious
  91  * ARM documents:
  92  *
  93  *    PCI:  D0-D7   D8-D15 D16-D23 D24-D31
  94  *    ARM: D24-D31 D16-D23  D8-D15  D0-D7
  95  *
  96  * The machine specific io.h include defines __io to translate an "IO"
  97  * address to a memory address.
  98  *
  99  * Note that we prevent GCC re-ordering or caching values in expressions
 100  * by introducing sequence points into the in*() definitions.  Note that
 101  * __raw_* do not guarantee this behaviour.
 102  *
 103  * The {in,out}[bwl] macros are for emulating x86-style PCI/ISA IO space.
 104  */
 105 #ifdef __io
 106 #define outb(v,p)                       __raw_writeb(v,__io(p))
 107 #define outw(v,p)                       __raw_writew(cpu_to_le16(v),__io(p))
 108 #define outl(v,p)                       __raw_writel(cpu_to_le32(v),__io(p))
 109
 110 #define inb(p)  ({ unsigned int __v = __raw_readb(__io(p)); __v; })
 111 #define inw(p)  ({ unsigned int __v = le16_to_cpu(__raw_readw(__io(p))); __v; })
 112 #define inl(p)  ({ unsigned int __v = le32_to_cpu(__raw_readl(__io(p))); __v; })
 113
 114 #define outsb(p,d,l)                    __raw_writesb(__io(p),d,l)
 115 #define outsw(p,d,l)                    __raw_writesw(__io(p),d,l)
 116 #define outsl(p,d,l)                    __raw_writesl(__io(p),d,l)
 117
 118 #define insb(p,d,l)                     __raw_readsb(__io(p),d,l)
 119 #define insw(p,d,l)                     __raw_readsw(__io(p),d,l)
 120 #define insl(p,d,l)                     __raw_readsl(__io(p),d,l)
 121 #endif
 122
 123 #define outb_p(val,port)                outb((val),(port))
 124 #define outw_p(val,port)                outw((val),(port))
 125 #define outl_p(val,port)                outl((val),(port))
 126 #define inb_p(port)                     inb((port))
 127 #define inw_p(port)                     inw((port))
 128 #define inl_p(port)                     inl((port))
 129
 130 #define outsb_p(port,from,len)          outsb(port,from,len)
 131 #define outsw_p(port,from,len)          outsw(port,from,len)
 132 #define outsl_p(port,from,len)          outsl(port,from,len)
 133 #define insb_p(port,to,len)             insb(port,to,len)
 134 #define insw_p(port,to,len)             insw(port,to,len)
 135 #define insl_p(port,to,len)             insl(port,to,len)
 136
 137 /*
 138  * ioremap and friends.
 139  *
 140  * ioremap takes a PCI memory address, as specified in
 141  * linux/Documentation/IO-mapping.txt.  If you want a
 142  * physical address, use __ioremap instead.
 143  */
 144 extern void * __ioremap(unsigned long offset, size_t size, unsigned long flags);
 145 extern void __iounmap(void *addr);
 146
 147 /*
 148  * Generic ioremap support.
 149  *
 150  * Define:
 151  *  iomem_valid_addr(off,size)
 152  *  iomem_to_phys(off)
 153  */
 154 #ifdef iomem_valid_addr
 155 #define __arch_ioremap(off,sz,nocache)                          \
 156  ({                                                             \
 157         unsigned long _off = (off), _size = (sz);               \
 158         void *_ret = (void *)0;                                 \
 159         if (iomem_valid_addr(_off, _size))                      \
 160                 _ret = __ioremap(iomem_to_phys(_off),_size,0);  \
 161         _ret;                                                   \
 162  })
 163
 164 #define __arch_iounmap __iounmap
 165 #endif
 166
 167 #define ioremap(off,sz)                 __arch_ioremap((off),(sz),0)
 168 #define ioremap_nocache(off,sz)         __arch_ioremap((off),(sz),1)
 169 #define iounmap(_addr)                  __arch_iounmap(_addr)
 170
 171 /*
 172  * DMA-consistent mapping functions.  These allocate/free a region of
 173  * uncached, unwrite-buffered mapped memory space for use with DMA
 174  * devices.  This is the "generic" version.  The PCI specific version
 175  * is in pci.h
 176  */
 177 extern void *consistent_alloc(int gfp, size_t size, dma_addr_t *handle);
 178 extern void consistent_free(void *vaddr, size_t size, dma_addr_t handle);
 179 extern void consistent_sync(void *vaddr, size_t size, int rw);
 180
 181 /*
 182  * String version of IO memory access ops:
 183  */
 184 extern void _memcpy_fromio(void *, unsigned long, size_t);
 185 extern void _memcpy_toio(unsigned long, const void *, size_t);
 186 extern void _memset_io(unsigned long, int, size_t);
 187
 188 extern void __readwrite_bug(const char *fn);
 189
 190 /*
 191  * If this architecture has PCI memory IO, then define the read/write
 192  * macros.  These should only be used with the cookie passed from
 193  * ioremap.
 194  */
 195 #ifdef __mem_pci
 196
 197 #define readb(c) ({ unsigned int __v = __raw_readb(__mem_pci(c)); __v; })
 198 #define readw(c) ({ unsigned int __v = le16_to_cpu(__raw_readw(__mem_pci(c))); __v; })
 199 #define readl(c) ({ unsigned int __v = le32_to_cpu(__raw_readl(__mem_pci(c))); __v; })
 200
 201 #define writeb(v,c)             __raw_writeb(v,__mem_pci(c))
 202 #define writew(v,c)             __raw_writew(cpu_to_le16(v),__mem_pci(c))
 203 #define writel(v,c)             __raw_writel(cpu_to_le32(v),__mem_pci(c))
 204
 205 #define memset_io(c,v,l)                _memset_io(__mem_pci(c),(v),(l))
 206 #define memcpy_fromio(a,c,l)            _memcpy_fromio((a),__mem_pci(c),(l))
 207 #define memcpy_toio(c,a,l)              _memcpy_toio(__mem_pci(c),(a),(l))
 208
 209 #define eth_io_copy_and_sum(s,c,l,b) \
 210                                 eth_copy_and_sum((s),__mem_pci(c),(l),(b))
 211
 212 static inline int
 213 check_signature(unsigned long io_addr, const unsigned char *signature,
 214                 int length)
 215 {
 216         int retval = 0;
 217         do {
 218                 if (readb(io_addr) != *signature)
 219                         goto out;
 220                 io_addr++;
 221                 signature++;
 222                 length--;
 223         } while (length);
 224         retval = 1;
 225 out:
 226         return retval;
 227 }
 228
 229 #elif !defined(readb)
 230
 231 #define readb(addr)                     (__readwrite_bug("readb"),0)
 232 #define readw(addr)                     (__readwrite_bug("readw"),0)
 233 #define readl(addr)                     (__readwrite_bug("readl"),0)
 234 #define writeb(v,addr)                  __readwrite_bug("writeb")
 235 #define writew(v,addr)                  __readwrite_bug("writew")
 236 #define writel(v,addr)                  __readwrite_bug("writel")
 237
 238 #define eth_io_copy_and_sum(a,b,c,d)    __readwrite_bug("eth_io_copy_and_sum")
 239
 240 #define check_signature(io,sig,len)     (0)
 241
 242 #endif  /* __mem_pci */
 243
 244 /*
 245  * If this architecture has ISA IO, then define the isa_read/isa_write
 246  * macros.
 247  */
 248 #ifdef __mem_isa
 249
 250 #define isa_readb(addr)                 __raw_readb(__mem_isa(addr))
 251 #define isa_readw(addr)                 __raw_readw(__mem_isa(addr))
 252 #define isa_readl(addr)                 __raw_readl(__mem_isa(addr))
 253 #define isa_writeb(val,addr)            __raw_writeb(val,__mem_isa(addr))
 254 #define isa_writew(val,addr)            __raw_writew(val,__mem_isa(addr))
 255 #define isa_writel(val,addr)            __raw_writel(val,__mem_isa(addr))
 256 #define isa_memset_io(a,b,c)            _memset_io(__mem_isa(a),(b),(c))
 257 #define isa_memcpy_fromio(a,b,c)        _memcpy_fromio((a),__mem_isa(b),(c))
 258 #define isa_memcpy_toio(a,b,c)          _memcpy_toio(__mem_isa((a)),(b),(c))
 259
 260 #define isa_eth_io_copy_and_sum(a,b,c,d) \
 261                                 eth_copy_and_sum((a),__mem_isa(b),(c),(d))
 262
 263 static inline int
 264 isa_check_signature(unsigned long io_addr, const unsigned char *signature,
 265                     int length)
 266 {
 267         int retval = 0;
 268         do {
 269                 if (isa_readb(io_addr) != *signature)
 270                         goto out;
 271                 io_addr++;
 272                 signature++;
 273                 length--;
 274         } while (length);
 275         retval = 1;
 276 out:
 277         return retval;
 278 }
 279
 280 #else   /* __mem_isa */
 281
 282 #define isa_readb(addr)                 (__readwrite_bug("isa_readb"),0)
 283 #define isa_readw(addr)                 (__readwrite_bug("isa_readw"),0)
 284 #define isa_readl(addr)                 (__readwrite_bug("isa_readl"),0)
 285 #define isa_writeb(val,addr)            __readwrite_bug("isa_writeb")
 286 #define isa_writew(val,addr)            __readwrite_bug("isa_writew")
 287 #define isa_writel(val,addr)            __readwrite_bug("isa_writel")
 288 #define isa_memset_io(a,b,c)            __readwrite_bug("isa_memset_io")
 289 #define isa_memcpy_fromio(a,b,c)        __readwrite_bug("isa_memcpy_fromio")
 290 #define isa_memcpy_toio(a,b,c)          __readwrite_bug("isa_memcpy_toio")
 291
 292 #define isa_eth_io_copy_and_sum(a,b,c,d) \
 293                                 __readwrite_bug("isa_eth_io_copy_and_sum")
 294
 295 #define isa_check_signature(io,sig,len) (0)
 296
 297 #endif  /* __mem_isa */
 298 #endif  /* __KERNEL__ */
 299 #endif  /* __ASM_ARM_IO_H */