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 *  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 */
41extern void __raw_writesb(void __iomem *addr, const void *data, int bytelen);
42extern void __raw_writesw(void __iomem *addr, const void *data, int wordlen);
43extern void __raw_writesl(void __iomem *addr, const void *data, int longlen);
44
45extern void __raw_readsb(const void __iomem *addr, void *data, int bytelen);
46extern void __raw_readsw(const void __iomem *addr, void *data, int wordlen);
47extern 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_IXP2000	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 */
73extern void __iomem * __arm_ioremap_pfn(unsigned long, unsigned long, size_t, unsigned int);
74extern void __iomem * __arm_ioremap(unsigned long, size_t, unsigned int);
75extern void __iounmap(volatile void __iomem *addr);
76
77/*
78 * Bad read/write accesses...
79 */
80extern void __readwrite_bug(const char *fn);
81
82/*
83 * Now, pick up the machine-defined IO definitions
84 */
85#include <asm/arch/io.h>
86
87/*
88 *  IO port access primitives
89 *  -------------------------
90 *
91 * The ARM doesn't have special IO access instructions; all IO is memory
92 * mapped.  Note that these are defined to perform little endian accesses
93 * only.  Their primary purpose is to access PCI and ISA peripherals.
94 *
95 * Note that for a big endian machine, this implies that the following
96 * big endian mode connectivity is in place, as described by numerous
97 * ARM documents:
98 *
99 *    PCI:  D0-D7   D8-D15 D16-D23 D24-D31
100 *    ARM: D24-D31 D16-D23  D8-D15  D0-D7
101 *
102 * The machine specific io.h include defines __io to translate an "IO"
103 * address to a memory address.
104 *
105 * Note that we prevent GCC re-ordering or caching values in expressions
106 * by introducing sequence points into the in*() definitions.  Note that
107 * __raw_* do not guarantee this behaviour.
108 *
109 * The {in,out}[bwl] macros are for emulating x86-style PCI/ISA IO space.
110 */
111#ifdef __io
112#define outb(v,p)		__raw_writeb(v,__io(p))
113#define outw(v,p)		__raw_writew((__force __u16) \
114					cpu_to_le16(v),__io(p))
115#define outl(v,p)		__raw_writel((__force __u32) \
116					cpu_to_le32(v),__io(p))
117
118#define inb(p)	({ __u8 __v = __raw_readb(__io(p)); __v; })
119#define inw(p)	({ __u16 __v = le16_to_cpu((__force __le16) \
120			__raw_readw(__io(p))); __v; })
121#define inl(p)	({ __u32 __v = le32_to_cpu((__force __le32) \
122			__raw_readl(__io(p))); __v; })
123
124#define outsb(p,d,l)		__raw_writesb(__io(p),d,l)
125#define outsw(p,d,l)		__raw_writesw(__io(p),d,l)
126#define outsl(p,d,l)		__raw_writesl(__io(p),d,l)
127
128#define insb(p,d,l)		__raw_readsb(__io(p),d,l)
129#define insw(p,d,l)		__raw_readsw(__io(p),d,l)
130#define insl(p,d,l)		__raw_readsl(__io(p),d,l)
131#endif
132
133#define outb_p(val,port)	outb((val),(port))
134#define outw_p(val,port)	outw((val),(port))
135#define outl_p(val,port)	outl((val),(port))
136#define inb_p(port)		inb((port))
137#define inw_p(port)		inw((port))
138#define inl_p(port)		inl((port))
139
140#define outsb_p(port,from,len)	outsb(port,from,len)
141#define outsw_p(port,from,len)	outsw(port,from,len)
142#define outsl_p(port,from,len)	outsl(port,from,len)
143#define insb_p(port,to,len)	insb(port,to,len)
144#define insw_p(port,to,len)	insw(port,to,len)
145#define insl_p(port,to,len)	insl(port,to,len)
146
147/*
148 * String version of IO memory access ops:
149 */
150extern void _memcpy_fromio(void *, const volatile void __iomem *, size_t);
151extern void _memcpy_toio(volatile void __iomem *, const void *, size_t);
152extern void _memset_io(volatile void __iomem *, int, size_t);
153
154#define mmiowb()
155
156/*
157 *  Memory access primitives
158 *  ------------------------
159 *
160 * These perform PCI memory accesses via an ioremap region.  They don't
161 * take an address as such, but a cookie.
162 *
163 * Again, this are defined to perform little endian accesses.  See the
164 * IO port primitives for more information.
165 */
166#ifdef __mem_pci
167#define readb(c) ({ __u8  __v = __raw_readb(__mem_pci(c)); __v; })
168#define readw(c) ({ __u16 __v = le16_to_cpu((__force __le16) \
169					__raw_readw(__mem_pci(c))); __v; })
170#define readl(c) ({ __u32 __v = le32_to_cpu((__force __le32) \
171					__raw_readl(__mem_pci(c))); __v; })
172#define readb_relaxed(addr) readb(addr)
173#define readw_relaxed(addr) readw(addr)
174#define readl_relaxed(addr) readl(addr)
175
176#define readsb(p,d,l)		__raw_readsb(__mem_pci(p),d,l)
177#define readsw(p,d,l)		__raw_readsw(__mem_pci(p),d,l)
178#define readsl(p,d,l)		__raw_readsl(__mem_pci(p),d,l)
179
180#define writeb(v,c)		__raw_writeb(v,__mem_pci(c))
181#define writew(v,c)		__raw_writew((__force __u16) \
182					cpu_to_le16(v),__mem_pci(c))
183#define writel(v,c)		__raw_writel((__force __u32) \
184					cpu_to_le32(v),__mem_pci(c))
185
186#define writesb(p,d,l)		__raw_writesb(__mem_pci(p),d,l)
187#define writesw(p,d,l)		__raw_writesw(__mem_pci(p),d,l)
188#define writesl(p,d,l)		__raw_writesl(__mem_pci(p),d,l)
189
190#define memset_io(c,v,l)	_memset_io(__mem_pci(c),(v),(l))
191#define memcpy_fromio(a,c,l)	_memcpy_fromio((a),__mem_pci(c),(l))
192#define memcpy_toio(c,a,l)	_memcpy_toio(__mem_pci(c),(a),(l))
193
194#elif !defined(readb)
195
196#define readb(c)			(__readwrite_bug("readb"),0)
197#define readw(c)			(__readwrite_bug("readw"),0)
198#define readl(c)			(__readwrite_bug("readl"),0)
199#define writeb(v,c)			__readwrite_bug("writeb")
200#define writew(v,c)			__readwrite_bug("writew")
201#define writel(v,c)			__readwrite_bug("writel")
202
203#define check_signature(io,sig,len)	(0)
204
205#endif	/* __mem_pci */
206
207/*
208 * ioremap and friends.
209 *
210 * ioremap takes a PCI memory address, as specified in
211 * Documentation/IO-mapping.txt.
212 *
213 */
214#ifndef __arch_ioremap
215#define ioremap(cookie,size)		__arm_ioremap(cookie, size, MT_DEVICE)
216#define ioremap_nocache(cookie,size)	__arm_ioremap(cookie, size, MT_DEVICE)
217#define ioremap_cached(cookie,size)	__arm_ioremap(cookie, size, MT_DEVICE_CACHED)
218#define iounmap(cookie)			__iounmap(cookie)
219#else
220#define ioremap(cookie,size)		__arch_ioremap((cookie), (size), MT_DEVICE)
221#define ioremap_nocache(cookie,size)	__arch_ioremap((cookie), (size), MT_DEVICE)
222#define ioremap_cached(cookie,size)	__arch_ioremap((cookie), (size), MT_DEVICE_CACHED)
223#define iounmap(cookie)			__arch_iounmap(cookie)
224#endif
225
226/*
227 * io{read,write}{8,16,32} macros
228 */
229#ifndef ioread8
230#define ioread8(p)	({ unsigned int __v = __raw_readb(p); __v; })
231#define ioread16(p)	({ unsigned int __v = le16_to_cpu(__raw_readw(p)); __v; })
232#define ioread32(p)	({ unsigned int __v = le32_to_cpu(__raw_readl(p)); __v; })
233
234#define iowrite8(v,p)	__raw_writeb(v, p)
235#define iowrite16(v,p)	__raw_writew(cpu_to_le16(v), p)
236#define iowrite32(v,p)	__raw_writel(cpu_to_le32(v), p)
237
238#define ioread8_rep(p,d,c)	__raw_readsb(p,d,c)
239#define ioread16_rep(p,d,c)	__raw_readsw(p,d,c)
240#define ioread32_rep(p,d,c)	__raw_readsl(p,d,c)
241
242#define iowrite8_rep(p,s,c)	__raw_writesb(p,s,c)
243#define iowrite16_rep(p,s,c)	__raw_writesw(p,s,c)
244#define iowrite32_rep(p,s,c)	__raw_writesl(p,s,c)
245
246extern void __iomem *ioport_map(unsigned long port, unsigned int nr);
247extern void ioport_unmap(void __iomem *addr);
248#endif
249
250struct pci_dev;
251
252extern void __iomem *pci_iomap(struct pci_dev *dev, int bar, unsigned long maxlen);
253extern void pci_iounmap(struct pci_dev *dev, void __iomem *addr);
254
255/*
256 * can the hardware map this into one segment or not, given no other
257 * constraints.
258 */
259#define BIOVEC_MERGEABLE(vec1, vec2)	\
260	((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
261
262#ifdef CONFIG_MMU
263#define ARCH_HAS_VALID_PHYS_ADDR_RANGE
264extern int valid_phys_addr_range(unsigned long addr, size_t size);
265extern int valid_mmap_phys_addr_range(unsigned long pfn, size_t size);
266#endif
267
268/*
269 * Convert a physical pointer to a virtual kernel pointer for /dev/mem
270 * access
271 */
272#define xlate_dev_mem_ptr(p)	__va(p)
273
274/*
275 * Convert a virtual cached pointer to an uncached pointer
276 */
277#define xlate_dev_kmem_ptr(p)	p
278
279/*
280 * Register ISA memory and port locations for glibc iopl/inb/outb
281 * emulation.
282 */
283extern void register_isa_ports(unsigned int mmio, unsigned int io,
284			       unsigned int io_shift);
285
286#endif	/* __KERNEL__ */
287#endif	/* __ASM_ARM_IO_H */
288