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