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/byteorder.h>
27 #include <asm/memory.h>
28 #include <asm/arch/hardware.h>
29 
30 /*
31  * Generic virtual read/write.  Note that we don't support half-word
32  * read/writes.  We define __arch_*[bl] here, and leave __arch_*w
33  * to the architecture specific code.
34  */
35 #define __arch_getb(a)			(*(volatile unsigned char *)(a))
36 #define __arch_getl(a)			(*(volatile unsigned int  *)(a))
37 
38 #define __arch_putb(v,a)		(*(volatile unsigned char *)(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 #include <asm/arch/io.h>
74 
75 /*
76  *  IO port access primitives
77  *  -------------------------
78  *
79  * The ARM doesn't have special IO access instructions; all IO is memory
80  * mapped.  Note that these are defined to perform little endian accesses
81  * only.  Their primary purpose is to access PCI and ISA peripherals.
82  *
83  * Note that for a big endian machine, this implies that the following
84  * big endian mode connectivity is in place, as described by numerious
85  * ARM documents:
86  *
87  *    PCI:  D0-D7   D8-D15 D16-D23 D24-D31
88  *    ARM: D24-D31 D16-D23  D8-D15  D0-D7
89  *
90  * The machine specific io.h include defines __io to translate an "IO"
91  * address to a memory address.
92  *
93  * Note that we prevent GCC re-ordering or caching values in expressions
94  * by introducing sequence points into the in*() definitions.  Note that
95  * __raw_* do not guarantee this behaviour.
96  *
97  * The {in,out}[bwl] macros are for emulating x86-style PCI/ISA IO space.
98  */
99 #ifdef __io
100 #define outb(v,p)			__raw_writeb(v,__io(p))
101 #define outw(v,p)			__raw_writew(cpu_to_le16(v),__io(p))
102 #define outl(v,p)			__raw_writel(cpu_to_le32(v),__io(p))
103 
104 #define inb(p)	({ unsigned int __v = __raw_readb(__io(p)); __v; })
105 #define inw(p)	({ unsigned int __v = le16_to_cpu(__raw_readw(__io(p))); __v; })
106 #define inl(p)	({ unsigned int __v = le32_to_cpu(__raw_readl(__io(p))); __v; })
107 
108 #define outsb(p,d,l)			__raw_writesb(__io(p),d,l)
109 #define outsw(p,d,l)			__raw_writesw(__io(p),d,l)
110 #define outsl(p,d,l)			__raw_writesl(__io(p),d,l)
111 
112 #define insb(p,d,l)			__raw_readsb(__io(p),d,l)
113 #define insw(p,d,l)			__raw_readsw(__io(p),d,l)
114 #define insl(p,d,l)			__raw_readsl(__io(p),d,l)
115 #endif
116 
117 #define outb_p(val,port)		outb((val),(port))
118 #define outw_p(val,port)		outw((val),(port))
119 #define outl_p(val,port)		outl((val),(port))
120 #define inb_p(port)			inb((port))
121 #define inw_p(port)			inw((port))
122 #define inl_p(port)			inl((port))
123 
124 #define outsb_p(port,from,len)		outsb(port,from,len)
125 #define outsw_p(port,from,len)		outsw(port,from,len)
126 #define outsl_p(port,from,len)		outsl(port,from,len)
127 #define insb_p(port,to,len)		insb(port,to,len)
128 #define insw_p(port,to,len)		insw(port,to,len)
129 #define insl_p(port,to,len)		insl(port,to,len)
130 
131 /*
132  * ioremap and friends.
133  *
134  * ioremap takes a PCI memory address, as specified in
135  * linux/Documentation/IO-mapping.txt.  If you want a
136  * physical address, use __ioremap instead.
137  */
138 extern void * __ioremap(unsigned long offset, size_t size, unsigned long flags);
139 extern void __iounmap(void *addr);
140 
141 /*
142  * Generic ioremap support.
143  *
144  * Define:
145  *  iomem_valid_addr(off,size)
146  *  iomem_to_phys(off)
147  */
148 #ifdef iomem_valid_addr
149 #define __arch_ioremap(off,sz,nocache)				\
150  ({								\
151 	unsigned long _off = (off), _size = (sz);		\
152 	void *_ret = (void *)0;					\
153 	if (iomem_valid_addr(_off, _size))			\
154 		_ret = __ioremap(iomem_to_phys(_off),_size,0);	\
155 	_ret;							\
156  })
157 
158 #define __arch_iounmap __iounmap
159 #endif
160 
161 #define ioremap(off,sz)			__arch_ioremap((off),(sz),0)
162 #define ioremap_nocache(off,sz)		__arch_ioremap((off),(sz),1)
163 #define iounmap(_addr)			__arch_iounmap(_addr)
164 
165 /*
166  * DMA-consistent mapping functions.  These allocate/free a region of
167  * uncached, unwrite-buffered mapped memory space for use with DMA
168  * devices.  This is the "generic" version.  The PCI specific version
169  * is in pci.h
170  */
171 extern void *consistent_alloc(int gfp, size_t size, dma_addr_t *handle);
172 extern void consistent_free(void *vaddr, size_t size, dma_addr_t handle);
173 extern void consistent_sync(void *vaddr, size_t size, int rw);
174 
175 /*
176  * String version of IO memory access ops:
177  */
178 extern void _memcpy_fromio(void *, unsigned long, size_t);
179 extern void _memcpy_toio(unsigned long, const void *, size_t);
180 extern void _memset_io(unsigned long, int, size_t);
181 
182 extern void __readwrite_bug(const char *fn);
183 
184 /*
185  * If this architecture has PCI memory IO, then define the read/write
186  * macros.  These should only be used with the cookie passed from
187  * ioremap.
188  */
189 #ifdef __mem_pci
190 
191 #define readb(c) ({ unsigned int __v = __raw_readb(__mem_pci(c)); __v; })
192 #define readw(c) ({ unsigned int __v = le16_to_cpu(__raw_readw(__mem_pci(c))); __v; })
193 #define readl(c) ({ unsigned int __v = le32_to_cpu(__raw_readl(__mem_pci(c))); __v; })
194 
195 #define writeb(v,c)		__raw_writeb(v,__mem_pci(c))
196 #define writew(v,c)		__raw_writew(cpu_to_le16(v),__mem_pci(c))
197 #define writel(v,c)		__raw_writel(cpu_to_le32(v),__mem_pci(c))
198 
199 #define memset_io(c,v,l)		_memset_io(__mem_pci(c),(v),(l))
200 #define memcpy_fromio(a,c,l)		_memcpy_fromio((a),__mem_pci(c),(l))
201 #define memcpy_toio(c,a,l)		_memcpy_toio(__mem_pci(c),(a),(l))
202 
203 #define eth_io_copy_and_sum(s,c,l,b) \
204 				eth_copy_and_sum((s),__mem_pci(c),(l),(b))
205 
206 static inline int
check_signature(unsigned long io_addr,const unsigned char * signature,int length)207 check_signature(unsigned long io_addr, const unsigned char *signature,
208 		int length)
209 {
210 	int retval = 0;
211 	do {
212 		if (readb(io_addr) != *signature)
213 			goto out;
214 		io_addr++;
215 		signature++;
216 		length--;
217 	} while (length);
218 	retval = 1;
219 out:
220 	return retval;
221 }
222 
223 #elif !defined(readb)
224 
225 #define readb(addr)			(__readwrite_bug("readb"),0)
226 #define readw(addr)			(__readwrite_bug("readw"),0)
227 #define readl(addr)			(__readwrite_bug("readl"),0)
228 #define writeb(v,addr)			__readwrite_bug("writeb")
229 #define writew(v,addr)			__readwrite_bug("writew")
230 #define writel(v,addr)			__readwrite_bug("writel")
231 
232 #define eth_io_copy_and_sum(a,b,c,d)	__readwrite_bug("eth_io_copy_and_sum")
233 
234 #define check_signature(io,sig,len)	(0)
235 
236 #endif	/* __mem_pci */
237 
238 /*
239  * If this architecture has ISA IO, then define the isa_read/isa_write
240  * macros.
241  */
242 #ifdef __mem_isa
243 
244 #define isa_readb(addr)			__raw_readb(__mem_isa(addr))
245 #define isa_readw(addr)			__raw_readw(__mem_isa(addr))
246 #define isa_readl(addr)			__raw_readl(__mem_isa(addr))
247 #define isa_writeb(val,addr)		__raw_writeb(val,__mem_isa(addr))
248 #define isa_writew(val,addr)		__raw_writew(val,__mem_isa(addr))
249 #define isa_writel(val,addr)		__raw_writel(val,__mem_isa(addr))
250 #define isa_memset_io(a,b,c)		_memset_io(__mem_isa(a),(b),(c))
251 #define isa_memcpy_fromio(a,b,c)	_memcpy_fromio((a),__mem_isa(b),(c))
252 #define isa_memcpy_toio(a,b,c)		_memcpy_toio(__mem_isa((a)),(b),(c))
253 
254 #define isa_eth_io_copy_and_sum(a,b,c,d) \
255 				eth_copy_and_sum((a),__mem_isa(b),(c),(d))
256 
257 static inline int
isa_check_signature(unsigned long io_addr,const unsigned char * signature,int length)258 isa_check_signature(unsigned long io_addr, const unsigned char *signature,
259 		    int length)
260 {
261 	int retval = 0;
262 	do {
263 		if (isa_readb(io_addr) != *signature)
264 			goto out;
265 		io_addr++;
266 		signature++;
267 		length--;
268 	} while (length);
269 	retval = 1;
270 out:
271 	return retval;
272 }
273 
274 #else	/* __mem_isa */
275 
276 #define isa_readb(addr)			(__readwrite_bug("isa_readb"),0)
277 #define isa_readw(addr)			(__readwrite_bug("isa_readw"),0)
278 #define isa_readl(addr)			(__readwrite_bug("isa_readl"),0)
279 #define isa_writeb(val,addr)		__readwrite_bug("isa_writeb")
280 #define isa_writew(val,addr)		__readwrite_bug("isa_writew")
281 #define isa_writel(val,addr)		__readwrite_bug("isa_writel")
282 #define isa_memset_io(a,b,c)		__readwrite_bug("isa_memset_io")
283 #define isa_memcpy_fromio(a,b,c)	__readwrite_bug("isa_memcpy_fromio")
284 #define isa_memcpy_toio(a,b,c)		__readwrite_bug("isa_memcpy_toio")
285 
286 #define isa_eth_io_copy_and_sum(a,b,c,d) \
287 				__readwrite_bug("isa_eth_io_copy_and_sum")
288 
289 #define isa_check_signature(io,sig,len)	(0)
290 
291 #endif	/* __mem_isa */
292 #endif	/* __KERNEL__ */
293 #endif	/* __ASM_ARM_IO_H */
294