blob: 894e64b2d5f0a0f066c50f2fca4a9dc554f172dd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __ASM_SH_IO_H
2#define __ASM_SH_IO_H
3
4/*
5 * Convention:
6 * read{b,w,l}/write{b,w,l} are for PCI,
7 * while in{b,w,l}/out{b,w,l} are for ISA
8 * These may (will) be platform specific function.
9 * In addition we have 'pausing' versions: in{b,w,l}_p/out{b,w,l}_p
10 * and 'string' versions: ins{b,w,l}/outs{b,w,l}
11 * For read{b,w,l} and write{b,w,l} there are also __raw versions, which
12 * do not have a memory barrier after them.
13 *
Paul Mundtb66c1a32006-01-16 22:14:15 -080014 * In addition, we have
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * ctrl_in{b,w,l}/ctrl_out{b,w,l} for SuperH specific I/O.
16 * which are processor specific.
17 */
18
19/*
20 * We follow the Alpha convention here:
21 * __inb expands to an inline function call (which calls via the mv)
22 * _inb is a real function call (note ___raw fns are _ version of __raw)
23 * inb by default expands to _inb, but the machine specific code may
24 * define it to __inb if it chooses.
25 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <asm/cache.h>
27#include <asm/system.h>
28#include <asm/addrspace.h>
29#include <asm/machvec.h>
Paul Mundtb66c1a32006-01-16 22:14:15 -080030#include <asm/pgtable.h>
31#include <asm-generic/iomap.h>
32
33#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35/*
36 * Depending on which platform we are running on, we need different
37 * I/O functions.
38 */
Paul Mundtb66c1a32006-01-16 22:14:15 -080039#define __IO_PREFIX generic
40#include <asm/io_generic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Paul Mundtb66c1a32006-01-16 22:14:15 -080042#define maybebadio(port) \
43 printk(KERN_ERR "bad PC-like io %s:%u for port 0x%lx at 0x%08x\n", \
44 __FUNCTION__, __LINE__, (port), (u32)__builtin_return_address(0))
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/*
47 * Since boards are able to define their own set of I/O routines through
48 * their respective machine vector, we always wrap through the mv.
49 *
50 * Also, in the event that a board hasn't provided its own definition for
51 * a given routine, it will be wrapped to generic code at run-time.
52 */
53
Paul Mundtb66c1a32006-01-16 22:14:15 -080054#define __inb(p) sh_mv.mv_inb((p))
55#define __inw(p) sh_mv.mv_inw((p))
56#define __inl(p) sh_mv.mv_inl((p))
57#define __outb(x,p) sh_mv.mv_outb((x),(p))
58#define __outw(x,p) sh_mv.mv_outw((x),(p))
59#define __outl(x,p) sh_mv.mv_outl((x),(p))
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Paul Mundtb66c1a32006-01-16 22:14:15 -080061#define __inb_p(p) sh_mv.mv_inb_p((p))
62#define __inw_p(p) sh_mv.mv_inw_p((p))
63#define __inl_p(p) sh_mv.mv_inl_p((p))
64#define __outb_p(x,p) sh_mv.mv_outb_p((x),(p))
65#define __outw_p(x,p) sh_mv.mv_outw_p((x),(p))
66#define __outl_p(x,p) sh_mv.mv_outl_p((x),(p))
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Paul Mundtb66c1a32006-01-16 22:14:15 -080068#define __insb(p,b,c) sh_mv.mv_insb((p), (b), (c))
69#define __insw(p,b,c) sh_mv.mv_insw((p), (b), (c))
70#define __insl(p,b,c) sh_mv.mv_insl((p), (b), (c))
71#define __outsb(p,b,c) sh_mv.mv_outsb((p), (b), (c))
72#define __outsw(p,b,c) sh_mv.mv_outsw((p), (b), (c))
73#define __outsl(p,b,c) sh_mv.mv_outsl((p), (b), (c))
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Paul Mundtb66c1a32006-01-16 22:14:15 -080075#define __readb(a) sh_mv.mv_readb((a))
76#define __readw(a) sh_mv.mv_readw((a))
77#define __readl(a) sh_mv.mv_readl((a))
78#define __writeb(v,a) sh_mv.mv_writeb((v),(a))
79#define __writew(v,a) sh_mv.mv_writew((v),(a))
80#define __writel(v,a) sh_mv.mv_writel((v),(a))
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Paul Mundtb66c1a32006-01-16 22:14:15 -080082#define inb __inb
83#define inw __inw
84#define inl __inl
85#define outb __outb
86#define outw __outw
87#define outl __outl
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Paul Mundtb66c1a32006-01-16 22:14:15 -080089#define inb_p __inb_p
90#define inw_p __inw_p
91#define inl_p __inl_p
92#define outb_p __outb_p
93#define outw_p __outw_p
94#define outl_p __outl_p
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Paul Mundtb66c1a32006-01-16 22:14:15 -080096#define insb __insb
97#define insw __insw
98#define insl __insl
99#define outsb __outsb
100#define outsw __outsw
101#define outsl __outsl
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Paul Mundtb66c1a32006-01-16 22:14:15 -0800103#define __raw_readb(a) __readb((void __iomem *)(a))
104#define __raw_readw(a) __readw((void __iomem *)(a))
105#define __raw_readl(a) __readl((void __iomem *)(a))
106#define __raw_writeb(v, a) __writeb(v, (void __iomem *)(a))
107#define __raw_writew(v, a) __writew(v, (void __iomem *)(a))
108#define __raw_writel(v, a) __writel(v, (void __iomem *)(a))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110/*
111 * The platform header files may define some of these macros to use
112 * the inlined versions where appropriate. These macros may also be
113 * redefined by userlevel programs.
114 */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800115#ifdef __readb
116# define readb(a) ({ unsigned long r_ = __raw_readb(a); mb(); r_; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117#endif
118#ifdef __raw_readw
Paul Mundtb66c1a32006-01-16 22:14:15 -0800119# define readw(a) ({ unsigned long r_ = __raw_readw(a); mb(); r_; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120#endif
121#ifdef __raw_readl
Paul Mundtb66c1a32006-01-16 22:14:15 -0800122# define readl(a) ({ unsigned long r_ = __raw_readl(a); mb(); r_; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123#endif
124
125#ifdef __raw_writeb
Paul Mundtb66c1a32006-01-16 22:14:15 -0800126# define writeb(v,a) ({ __raw_writeb((v),(a)); mb(); })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127#endif
128#ifdef __raw_writew
Paul Mundtb66c1a32006-01-16 22:14:15 -0800129# define writew(v,a) ({ __raw_writew((v),(a)); mb(); })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#endif
131#ifdef __raw_writel
Paul Mundtb66c1a32006-01-16 22:14:15 -0800132# define writel(v,a) ({ __raw_writel((v),(a)); mb(); })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#endif
134
135#define readb_relaxed(a) readb(a)
136#define readw_relaxed(a) readw(a)
137#define readl_relaxed(a) readl(a)
138
Paul Mundtb66c1a32006-01-16 22:14:15 -0800139/* Simple MMIO */
140#define ioread8(a) readb(a)
141#define ioread16(a) readw(a)
142#define ioread16be(a) be16_to_cpu(__raw_readw((a)))
143#define ioread32(a) readl(a)
144#define ioread32be(a) be32_to_cpu(__raw_readl((a)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Paul Mundtb66c1a32006-01-16 22:14:15 -0800146#define iowrite8(v,a) writeb((v),(a))
147#define iowrite16(v,a) writew((v),(a))
148#define iowrite16be(v,a) __raw_writew(cpu_to_be16((v)),(a))
149#define iowrite32(v,a) writel((v),(a))
150#define iowrite32be(v,a) __raw_writel(cpu_to_be32((v)),(a))
151
152#define ioread8_rep(a,d,c) insb((a),(d),(c))
153#define ioread16_rep(a,d,c) insw((a),(d),(c))
154#define ioread32_rep(a,d,c) insl((a),(d),(c))
155
156#define iowrite8_rep(a,s,c) outsb((a),(s),(c))
157#define iowrite16_rep(a,s,c) outsw((a),(s),(c))
158#define iowrite32_rep(a,s,c) outsl((a),(s),(c))
159
160#define mmiowb() wmb() /* synco on SH-4A, otherwise a nop */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162/*
163 * This function provides a method for the generic case where a board-specific
Paul Mundtb66c1a32006-01-16 22:14:15 -0800164 * ioport_map simply needs to return the port + some arbitrary port base.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 *
166 * We use this at board setup time to implicitly set the port base, and
Paul Mundtb66c1a32006-01-16 22:14:15 -0800167 * as a result, we can use the generic ioport_map.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 */
169static inline void __set_io_port_base(unsigned long pbase)
170{
171 extern unsigned long generic_io_base;
172
173 generic_io_base = pbase;
174}
175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176/* We really want to try and get these to memcpy etc */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800177extern void memcpy_fromio(void *, volatile void __iomem *, unsigned long);
178extern void memcpy_toio(volatile void __iomem *, const void *, unsigned long);
179extern void memset_io(volatile void __iomem *, int, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181/* SuperH on-chip I/O functions */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800182static inline unsigned char ctrl_inb(unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
184 return *(volatile unsigned char*)addr;
185}
186
Paul Mundtb66c1a32006-01-16 22:14:15 -0800187static inline unsigned short ctrl_inw(unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
189 return *(volatile unsigned short*)addr;
190}
191
Paul Mundtb66c1a32006-01-16 22:14:15 -0800192static inline unsigned int ctrl_inl(unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 return *(volatile unsigned long*)addr;
195}
196
Paul Mundtb66c1a32006-01-16 22:14:15 -0800197static inline void ctrl_outb(unsigned char b, unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
199 *(volatile unsigned char*)addr = b;
200}
201
Paul Mundtb66c1a32006-01-16 22:14:15 -0800202static inline void ctrl_outw(unsigned short b, unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
204 *(volatile unsigned short*)addr = b;
205}
206
Paul Mundtb66c1a32006-01-16 22:14:15 -0800207static inline void ctrl_outl(unsigned int b, unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 *(volatile unsigned long*)addr = b;
210}
211
212#define IO_SPACE_LIMIT 0xffffffff
213
214/*
215 * Change virtual addresses to physical addresses and vv.
216 * These are trivial on the 1:1 Linux/SuperH mapping
217 */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800218static inline unsigned long virt_to_phys(volatile void *address)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219{
220 return PHYSADDR(address);
221}
222
Paul Mundtb66c1a32006-01-16 22:14:15 -0800223static inline void *phys_to_virt(unsigned long address)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224{
225 return (void *)P1SEGADDR(address);
226}
227
228#define virt_to_bus virt_to_phys
229#define bus_to_virt phys_to_virt
230#define page_to_bus page_to_phys
231
232/*
233 * readX/writeX() are used to access memory mapped devices. On some
234 * architectures the memory mapped IO stuff needs to be accessed
235 * differently. On the x86 architecture, we just read/write the
236 * memory location directly.
237 *
Paul Mundtb66c1a32006-01-16 22:14:15 -0800238 * On SH, we traditionally have the whole physical address space mapped
239 * at all times (as MIPS does), so "ioremap()" and "iounmap()" do not
240 * need to do anything but place the address in the proper segment. This
241 * is true for P1 and P2 addresses, as well as some P3 ones. However,
242 * most of the P3 addresses and newer cores using extended addressing
243 * need to map through page tables, so the ioremap() implementation
244 * becomes a bit more complicated. See arch/sh/mm/ioremap.c for
245 * additional notes on this.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 *
247 * We cheat a bit and always return uncachable areas until we've fixed
Paul Mundtb66c1a32006-01-16 22:14:15 -0800248 * the drivers to handle caching properly.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800250#ifdef CONFIG_MMU
251void __iomem *__ioremap(unsigned long offset, unsigned long size,
252 unsigned long flags);
253void __iounmap(void __iomem *addr);
254#else
255#define __ioremap(offset, size, flags) ((void __iomem *)(offset))
256#define __iounmap(addr) do { } while (0)
257#endif /* CONFIG_MMU */
258
259static inline void __iomem *
260__ioremap_mode(unsigned long offset, unsigned long size, unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
Paul Mundtb66c1a32006-01-16 22:14:15 -0800262 unsigned long last_addr = offset + size - 1;
263
264 /*
265 * For P1 and P2 space this is trivial, as everything is already
266 * mapped. Uncached access for P1 addresses are done through P2.
267 * In the P3 case or for addresses outside of the 29-bit space,
268 * mapping must be done by the PMB or by using page tables.
269 */
270 if (likely(PXSEG(offset) < P3SEG && PXSEG(last_addr) < P3SEG)) {
271 if (unlikely(flags & _PAGE_CACHABLE))
272 return (void __iomem *)P1SEGADDR(offset);
273
274 return (void __iomem *)P2SEGADDR(offset);
275 }
276
277 return __ioremap(offset, size, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279
Paul Mundtb66c1a32006-01-16 22:14:15 -0800280#define ioremap(offset, size) \
281 __ioremap_mode((offset), (size), 0)
282#define ioremap_nocache(offset, size) \
283 __ioremap_mode((offset), (size), 0)
284#define ioremap_cache(offset, size) \
285 __ioremap_mode((offset), (size), _PAGE_CACHABLE)
286#define p3_ioremap(offset, size, flags) \
287 __ioremap((offset), (size), (flags))
288#define iounmap(addr) \
289 __iounmap((addr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Paul Mundtb66c1a32006-01-16 22:14:15 -0800291static inline int check_signature(char __iomem *io_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 const unsigned char *signature, int length)
293{
294 int retval = 0;
295 do {
296 if (readb(io_addr) != *signature)
297 goto out;
298 io_addr++;
299 signature++;
300 length--;
301 } while (length);
302 retval = 1;
303out:
304 return retval;
305}
306
307/*
308 * The caches on some architectures aren't dma-coherent and have need to
309 * handle this in software. There are three types of operations that
310 * can be applied to dma buffers.
311 *
312 * - dma_cache_wback_inv(start, size) makes caches and RAM coherent by
313 * writing the content of the caches back to memory, if necessary.
314 * The function also invalidates the affected part of the caches as
315 * necessary before DMA transfers from outside to memory.
316 * - dma_cache_inv(start, size) invalidates the affected parts of the
317 * caches. Dirty lines of the caches may be written back or simply
318 * be discarded. This operation is necessary before dma operations
319 * to the memory.
320 * - dma_cache_wback(start, size) writes back any dirty lines but does
321 * not invalidate the cache. This can be used before DMA reads from
322 * memory,
323 */
324
325#define dma_cache_wback_inv(_start,_size) \
326 __flush_purge_region(_start,_size)
327#define dma_cache_inv(_start,_size) \
328 __flush_invalidate_region(_start,_size)
329#define dma_cache_wback(_start,_size) \
330 __flush_wback_region(_start,_size)
331
332/*
333 * Convert a physical pointer to a virtual kernel pointer for /dev/mem
334 * access
335 */
336#define xlate_dev_mem_ptr(p) __va(p)
337
338/*
339 * Convert a virtual cached pointer to an uncached pointer
340 */
341#define xlate_dev_kmem_ptr(p) p
342
343#endif /* __KERNEL__ */
344
345#endif /* __ASM_SH_IO_H */