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