ARM: 6271/1: Introduce *_relaxed() I/O accessors
[linux-2.6.git] / arch / arm / include / asm / io.h
1 /*
2  *  arch/arm/include/asm/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  *  05-Oct-2004 BJD     Moved memory string functions to use void __iomem
20  */
21 #ifndef __ASM_ARM_IO_H
22 #define __ASM_ARM_IO_H
23
24 #ifdef __KERNEL__
25
26 #include <linux/types.h>
27 #include <asm/byteorder.h>
28 #include <asm/memory.h>
29
30 /*
31  * ISA I/O bus memory addresses are 1:1 with the physical address.
32  */
33 #define isa_virt_to_bus virt_to_phys
34 #define isa_page_to_bus page_to_phys
35 #define isa_bus_to_virt phys_to_virt
36
37 /*
38  * Generic IO read/write.  These perform native-endian accesses.  Note
39  * that some architectures will want to re-define __raw_{read,write}w.
40  */
41 extern void __raw_writesb(void __iomem *addr, const void *data, int bytelen);
42 extern void __raw_writesw(void __iomem *addr, const void *data, int wordlen);
43 extern void __raw_writesl(void __iomem *addr, const void *data, int longlen);
44
45 extern void __raw_readsb(const void __iomem *addr, void *data, int bytelen);
46 extern void __raw_readsw(const void __iomem *addr, void *data, int wordlen);
47 extern void __raw_readsl(const void __iomem *addr, void *data, int longlen);
48
49 #define __raw_writeb(v,a)       (__chk_io_ptr(a), *(volatile unsigned char __force  *)(a) = (v))
50 #define __raw_writew(v,a)       (__chk_io_ptr(a), *(volatile unsigned short __force *)(a) = (v))
51 #define __raw_writel(v,a)       (__chk_io_ptr(a), *(volatile unsigned int __force   *)(a) = (v))
52
53 #define __raw_readb(a)          (__chk_io_ptr(a), *(volatile unsigned char __force  *)(a))
54 #define __raw_readw(a)          (__chk_io_ptr(a), *(volatile unsigned short __force *)(a))
55 #define __raw_readl(a)          (__chk_io_ptr(a), *(volatile unsigned int __force   *)(a))
56
57 /*
58  * Architecture ioremap implementation.
59  */
60 #define MT_DEVICE               0
61 #define MT_DEVICE_NONSHARED     1
62 #define MT_DEVICE_CACHED        2
63 #define MT_DEVICE_WC            3
64 /*
65  * types 4 onwards can be found in asm/mach/map.h and are undefined
66  * for ioremap
67  */
68
69 /*
70  * __arm_ioremap takes CPU physical address.
71  * __arm_ioremap_pfn takes a Page Frame Number and an offset into that page
72  * The _caller variety takes a __builtin_return_address(0) value for
73  * /proc/vmalloc to use - and should only be used in non-inline functions.
74  */
75 extern void __iomem *__arm_ioremap_pfn_caller(unsigned long, unsigned long,
76         size_t, unsigned int, void *);
77 extern void __iomem *__arm_ioremap_caller(unsigned long, size_t, unsigned int,
78         void *);
79
80 extern void __iomem *__arm_ioremap_pfn(unsigned long, unsigned long, size_t, unsigned int);
81 extern void __iomem *__arm_ioremap(unsigned long, size_t, unsigned int);
82 extern void __iounmap(volatile void __iomem *addr);
83
84 /*
85  * Bad read/write accesses...
86  */
87 extern void __readwrite_bug(const char *fn);
88
89 /*
90  * A typesafe __io() helper
91  */
92 static inline void __iomem *__typesafe_io(unsigned long addr)
93 {
94         return (void __iomem *)addr;
95 }
96
97 /*
98  * Now, pick up the machine-defined IO definitions
99  */
100 #include <mach/io.h>
101
102 /*
103  *  IO port access primitives
104  *  -------------------------
105  *
106  * The ARM doesn't have special IO access instructions; all IO is memory
107  * mapped.  Note that these are defined to perform little endian accesses
108  * only.  Their primary purpose is to access PCI and ISA peripherals.
109  *
110  * Note that for a big endian machine, this implies that the following
111  * big endian mode connectivity is in place, as described by numerous
112  * ARM documents:
113  *
114  *    PCI:  D0-D7   D8-D15 D16-D23 D24-D31
115  *    ARM: D24-D31 D16-D23  D8-D15  D0-D7
116  *
117  * The machine specific io.h include defines __io to translate an "IO"
118  * address to a memory address.
119  *
120  * Note that we prevent GCC re-ordering or caching values in expressions
121  * by introducing sequence points into the in*() definitions.  Note that
122  * __raw_* do not guarantee this behaviour.
123  *
124  * The {in,out}[bwl] macros are for emulating x86-style PCI/ISA IO space.
125  */
126 #ifdef __io
127 #define outb(v,p)               __raw_writeb(v,__io(p))
128 #define outw(v,p)               __raw_writew((__force __u16) \
129                                         cpu_to_le16(v),__io(p))
130 #define outl(v,p)               __raw_writel((__force __u32) \
131                                         cpu_to_le32(v),__io(p))
132
133 #define inb(p)  ({ __u8 __v = __raw_readb(__io(p)); __v; })
134 #define inw(p)  ({ __u16 __v = le16_to_cpu((__force __le16) \
135                         __raw_readw(__io(p))); __v; })
136 #define inl(p)  ({ __u32 __v = le32_to_cpu((__force __le32) \
137                         __raw_readl(__io(p))); __v; })
138
139 #define outsb(p,d,l)            __raw_writesb(__io(p),d,l)
140 #define outsw(p,d,l)            __raw_writesw(__io(p),d,l)
141 #define outsl(p,d,l)            __raw_writesl(__io(p),d,l)
142
143 #define insb(p,d,l)             __raw_readsb(__io(p),d,l)
144 #define insw(p,d,l)             __raw_readsw(__io(p),d,l)
145 #define insl(p,d,l)             __raw_readsl(__io(p),d,l)
146 #endif
147
148 #define outb_p(val,port)        outb((val),(port))
149 #define outw_p(val,port)        outw((val),(port))
150 #define outl_p(val,port)        outl((val),(port))
151 #define inb_p(port)             inb((port))
152 #define inw_p(port)             inw((port))
153 #define inl_p(port)             inl((port))
154
155 #define outsb_p(port,from,len)  outsb(port,from,len)
156 #define outsw_p(port,from,len)  outsw(port,from,len)
157 #define outsl_p(port,from,len)  outsl(port,from,len)
158 #define insb_p(port,to,len)     insb(port,to,len)
159 #define insw_p(port,to,len)     insw(port,to,len)
160 #define insl_p(port,to,len)     insl(port,to,len)
161
162 /*
163  * String version of IO memory access ops:
164  */
165 extern void _memcpy_fromio(void *, const volatile void __iomem *, size_t);
166 extern void _memcpy_toio(volatile void __iomem *, const void *, size_t);
167 extern void _memset_io(volatile void __iomem *, int, size_t);
168
169 #define mmiowb()
170
171 /*
172  *  Memory access primitives
173  *  ------------------------
174  *
175  * These perform PCI memory accesses via an ioremap region.  They don't
176  * take an address as such, but a cookie.
177  *
178  * Again, this are defined to perform little endian accesses.  See the
179  * IO port primitives for more information.
180  */
181 #ifdef __mem_pci
182 #define readb_relaxed(c) ({ u8  __v = __raw_readb(__mem_pci(c)); __v; })
183 #define readw_relaxed(c) ({ u16 __v = le16_to_cpu((__force __le16) \
184                                         __raw_readw(__mem_pci(c))); __v; })
185 #define readl_relaxed(c) ({ u32 __v = le32_to_cpu((__force __le32) \
186                                         __raw_readl(__mem_pci(c))); __v; })
187
188 #define writeb_relaxed(v,c)     ((void)__raw_writeb(v,__mem_pci(c)))
189 #define writew_relaxed(v,c)     ((void)__raw_writew((__force u16) \
190                                         cpu_to_le16(v),__mem_pci(c)))
191 #define writel_relaxed(v,c)     ((void)__raw_writel((__force u32) \
192                                         cpu_to_le32(v),__mem_pci(c)))
193
194 #define readb(c)                readb_relaxed(c)
195 #define readw(c)                readw_relaxed(c)
196 #define readl(c)                readl_relaxed(c)
197
198 #define writeb(v,c)             writeb_relaxed(v,c)
199 #define writew(v,c)             writew_relaxed(v,c)
200 #define writel(v,c)             writel_relaxed(v,c)
201
202 #define readsb(p,d,l)           __raw_readsb(__mem_pci(p),d,l)
203 #define readsw(p,d,l)           __raw_readsw(__mem_pci(p),d,l)
204 #define readsl(p,d,l)           __raw_readsl(__mem_pci(p),d,l)
205
206 #define writesb(p,d,l)          __raw_writesb(__mem_pci(p),d,l)
207 #define writesw(p,d,l)          __raw_writesw(__mem_pci(p),d,l)
208 #define writesl(p,d,l)          __raw_writesl(__mem_pci(p),d,l)
209
210 #define memset_io(c,v,l)        _memset_io(__mem_pci(c),(v),(l))
211 #define memcpy_fromio(a,c,l)    _memcpy_fromio((a),__mem_pci(c),(l))
212 #define memcpy_toio(c,a,l)      _memcpy_toio(__mem_pci(c),(a),(l))
213
214 #elif !defined(readb)
215
216 #define readb(c)                        (__readwrite_bug("readb"),0)
217 #define readw(c)                        (__readwrite_bug("readw"),0)
218 #define readl(c)                        (__readwrite_bug("readl"),0)
219 #define writeb(v,c)                     __readwrite_bug("writeb")
220 #define writew(v,c)                     __readwrite_bug("writew")
221 #define writel(v,c)                     __readwrite_bug("writel")
222
223 #define check_signature(io,sig,len)     (0)
224
225 #endif  /* __mem_pci */
226
227 /*
228  * ioremap and friends.
229  *
230  * ioremap takes a PCI memory address, as specified in
231  * Documentation/IO-mapping.txt.
232  *
233  */
234 #ifndef __arch_ioremap
235 #define ioremap(cookie,size)            __arm_ioremap(cookie, size, MT_DEVICE)
236 #define ioremap_nocache(cookie,size)    __arm_ioremap(cookie, size, MT_DEVICE)
237 #define ioremap_cached(cookie,size)     __arm_ioremap(cookie, size, MT_DEVICE_CACHED)
238 #define ioremap_wc(cookie,size)         __arm_ioremap(cookie, size, MT_DEVICE_WC)
239 #define iounmap(cookie)                 __iounmap(cookie)
240 #else
241 #define ioremap(cookie,size)            __arch_ioremap((cookie), (size), MT_DEVICE)
242 #define ioremap_nocache(cookie,size)    __arch_ioremap((cookie), (size), MT_DEVICE)
243 #define ioremap_cached(cookie,size)     __arch_ioremap((cookie), (size), MT_DEVICE_CACHED)
244 #define ioremap_wc(cookie,size)         __arch_ioremap((cookie), (size), MT_DEVICE_WC)
245 #define iounmap(cookie)                 __arch_iounmap(cookie)
246 #endif
247
248 /*
249  * io{read,write}{8,16,32} macros
250  */
251 #ifndef ioread8
252 #define ioread8(p)      ({ unsigned int __v = __raw_readb(p); __v; })
253 #define ioread16(p)     ({ unsigned int __v = le16_to_cpu((__force __le16)__raw_readw(p)); __v; })
254 #define ioread32(p)     ({ unsigned int __v = le32_to_cpu((__force __le32)__raw_readl(p)); __v; })
255
256 #define iowrite8(v,p)   __raw_writeb(v, p)
257 #define iowrite16(v,p)  __raw_writew((__force __u16)cpu_to_le16(v), p)
258 #define iowrite32(v,p)  __raw_writel((__force __u32)cpu_to_le32(v), p)
259
260 #define ioread8_rep(p,d,c)      __raw_readsb(p,d,c)
261 #define ioread16_rep(p,d,c)     __raw_readsw(p,d,c)
262 #define ioread32_rep(p,d,c)     __raw_readsl(p,d,c)
263
264 #define iowrite8_rep(p,s,c)     __raw_writesb(p,s,c)
265 #define iowrite16_rep(p,s,c)    __raw_writesw(p,s,c)
266 #define iowrite32_rep(p,s,c)    __raw_writesl(p,s,c)
267
268 extern void __iomem *ioport_map(unsigned long port, unsigned int nr);
269 extern void ioport_unmap(void __iomem *addr);
270 #endif
271
272 struct pci_dev;
273
274 extern void __iomem *pci_iomap(struct pci_dev *dev, int bar, unsigned long maxlen);
275 extern void pci_iounmap(struct pci_dev *dev, void __iomem *addr);
276
277 /*
278  * can the hardware map this into one segment or not, given no other
279  * constraints.
280  */
281 #define BIOVEC_MERGEABLE(vec1, vec2)    \
282         ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
283
284 #ifdef CONFIG_MMU
285 #define ARCH_HAS_VALID_PHYS_ADDR_RANGE
286 extern int valid_phys_addr_range(unsigned long addr, size_t size);
287 extern int valid_mmap_phys_addr_range(unsigned long pfn, size_t size);
288 #endif
289
290 /*
291  * Convert a physical pointer to a virtual kernel pointer for /dev/mem
292  * access
293  */
294 #define xlate_dev_mem_ptr(p)    __va(p)
295
296 /*
297  * Convert a virtual cached pointer to an uncached pointer
298  */
299 #define xlate_dev_kmem_ptr(p)   p
300
301 /*
302  * Register ISA memory and port locations for glibc iopl/inb/outb
303  * emulation.
304  */
305 extern void register_isa_ports(unsigned int mmio, unsigned int io,
306                                unsigned int io_shift);
307
308 #endif  /* __KERNEL__ */
309 #endif  /* __ASM_ARM_IO_H */