include/asm-sh/io.h

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