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