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