blob: 3d2b114f9d57477ee808170282573571ccd1585e [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>
Magnus Damme7cc9a72008-02-07 20:18:21 +090041#include <asm/io_trapped.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Paul Mundtb66c1a32006-01-16 22:14:15 -080043#define maybebadio(port) \
44 printk(KERN_ERR "bad PC-like io %s:%u for port 0x%lx at 0x%08x\n", \
45 __FUNCTION__, __LINE__, (port), (u32)__builtin_return_address(0))
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/*
48 * Since boards are able to define their own set of I/O routines through
49 * their respective machine vector, we always wrap through the mv.
50 *
51 * Also, in the event that a board hasn't provided its own definition for
52 * a given routine, it will be wrapped to generic code at run-time.
53 */
54
Paul Mundtb66c1a32006-01-16 22:14:15 -080055#define __inb(p) sh_mv.mv_inb((p))
56#define __inw(p) sh_mv.mv_inw((p))
57#define __inl(p) sh_mv.mv_inl((p))
58#define __outb(x,p) sh_mv.mv_outb((x),(p))
59#define __outw(x,p) sh_mv.mv_outw((x),(p))
60#define __outl(x,p) sh_mv.mv_outl((x),(p))
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Paul Mundtb66c1a32006-01-16 22:14:15 -080062#define __inb_p(p) sh_mv.mv_inb_p((p))
63#define __inw_p(p) sh_mv.mv_inw_p((p))
64#define __inl_p(p) sh_mv.mv_inl_p((p))
65#define __outb_p(x,p) sh_mv.mv_outb_p((x),(p))
66#define __outw_p(x,p) sh_mv.mv_outw_p((x),(p))
67#define __outl_p(x,p) sh_mv.mv_outl_p((x),(p))
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Paul Mundtb66c1a32006-01-16 22:14:15 -080069#define __insb(p,b,c) sh_mv.mv_insb((p), (b), (c))
70#define __insw(p,b,c) sh_mv.mv_insw((p), (b), (c))
71#define __insl(p,b,c) sh_mv.mv_insl((p), (b), (c))
72#define __outsb(p,b,c) sh_mv.mv_outsb((p), (b), (c))
73#define __outsw(p,b,c) sh_mv.mv_outsw((p), (b), (c))
74#define __outsl(p,b,c) sh_mv.mv_outsl((p), (b), (c))
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Paul Mundtb66c1a32006-01-16 22:14:15 -080076#define __readb(a) sh_mv.mv_readb((a))
77#define __readw(a) sh_mv.mv_readw((a))
78#define __readl(a) sh_mv.mv_readl((a))
79#define __writeb(v,a) sh_mv.mv_writeb((v),(a))
80#define __writew(v,a) sh_mv.mv_writew((v),(a))
81#define __writel(v,a) sh_mv.mv_writel((v),(a))
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Paul Mundtb66c1a32006-01-16 22:14:15 -080083#define inb __inb
84#define inw __inw
85#define inl __inl
86#define outb __outb
87#define outw __outw
88#define outl __outl
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Paul Mundtb66c1a32006-01-16 22:14:15 -080090#define inb_p __inb_p
91#define inw_p __inw_p
92#define inl_p __inl_p
93#define outb_p __outb_p
94#define outw_p __outw_p
95#define outl_p __outl_p
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Paul Mundtb66c1a32006-01-16 22:14:15 -080097#define insb __insb
98#define insw __insw
99#define insl __insl
100#define outsb __outsb
101#define outsw __outsw
102#define outsl __outsl
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Paul Mundtb66c1a32006-01-16 22:14:15 -0800104#define __raw_readb(a) __readb((void __iomem *)(a))
105#define __raw_readw(a) __readw((void __iomem *)(a))
106#define __raw_readl(a) __readl((void __iomem *)(a))
107#define __raw_writeb(v, a) __writeb(v, (void __iomem *)(a))
108#define __raw_writew(v, a) __writew(v, (void __iomem *)(a))
109#define __raw_writel(v, a) __writel(v, (void __iomem *)(a))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Paul Mundt05ae9152006-09-27 18:25:24 +0900111void __raw_writesl(unsigned long addr, const void *data, int longlen);
112void __raw_readsl(unsigned long addr, void *data, int longlen);
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/*
115 * The platform header files may define some of these macros to use
116 * the inlined versions where appropriate. These macros may also be
117 * redefined by userlevel programs.
118 */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800119#ifdef __readb
Evgeniy Polyakov66c52272007-05-31 13:46:21 +0900120# define readb(a) ({ unsigned int r_ = __raw_readb(a); mb(); r_; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#endif
122#ifdef __raw_readw
Evgeniy Polyakov66c52272007-05-31 13:46:21 +0900123# define readw(a) ({ unsigned int r_ = __raw_readw(a); mb(); r_; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#endif
125#ifdef __raw_readl
Evgeniy Polyakov66c52272007-05-31 13:46:21 +0900126# define readl(a) ({ unsigned int r_ = __raw_readl(a); mb(); r_; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127#endif
128
129#ifdef __raw_writeb
Paul Mundtb66c1a32006-01-16 22:14:15 -0800130# define writeb(v,a) ({ __raw_writeb((v),(a)); mb(); })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131#endif
132#ifdef __raw_writew
Paul Mundtb66c1a32006-01-16 22:14:15 -0800133# define writew(v,a) ({ __raw_writew((v),(a)); mb(); })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134#endif
135#ifdef __raw_writel
Paul Mundtb66c1a32006-01-16 22:14:15 -0800136# define writel(v,a) ({ __raw_writel((v),(a)); mb(); })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137#endif
138
Magnus Dammda6b0032007-09-10 12:08:42 +0900139#define __BUILD_MEMORY_STRING(bwlq, type) \
140 \
141static inline void writes##bwlq(volatile void __iomem *mem, \
142 const void *addr, unsigned int count) \
143{ \
144 const volatile type *__addr = addr; \
145 \
146 while (count--) { \
147 __raw_write##bwlq(*__addr, mem); \
148 __addr++; \
149 } \
150} \
151 \
152static inline void reads##bwlq(volatile void __iomem *mem, void *addr, \
153 unsigned int count) \
154{ \
155 volatile type *__addr = addr; \
156 \
157 while (count--) { \
158 *__addr = __raw_read##bwlq(mem); \
159 __addr++; \
160 } \
161}
162
163__BUILD_MEMORY_STRING(b, u8)
164__BUILD_MEMORY_STRING(w, u16)
Paul Mundt05ae9152006-09-27 18:25:24 +0900165#define writesl __raw_writesl
166#define readsl __raw_readsl
167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168#define readb_relaxed(a) readb(a)
169#define readw_relaxed(a) readw(a)
170#define readl_relaxed(a) readl(a)
171
Paul Mundtb66c1a32006-01-16 22:14:15 -0800172/* Simple MMIO */
173#define ioread8(a) readb(a)
174#define ioread16(a) readw(a)
175#define ioread16be(a) be16_to_cpu(__raw_readw((a)))
176#define ioread32(a) readl(a)
177#define ioread32be(a) be32_to_cpu(__raw_readl((a)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Paul Mundtb66c1a32006-01-16 22:14:15 -0800179#define iowrite8(v,a) writeb((v),(a))
180#define iowrite16(v,a) writew((v),(a))
181#define iowrite16be(v,a) __raw_writew(cpu_to_be16((v)),(a))
182#define iowrite32(v,a) writel((v),(a))
183#define iowrite32be(v,a) __raw_writel(cpu_to_be32((v)),(a))
184
185#define ioread8_rep(a,d,c) insb((a),(d),(c))
186#define ioread16_rep(a,d,c) insw((a),(d),(c))
187#define ioread32_rep(a,d,c) insl((a),(d),(c))
188
189#define iowrite8_rep(a,s,c) outsb((a),(s),(c))
190#define iowrite16_rep(a,s,c) outsw((a),(s),(c))
191#define iowrite32_rep(a,s,c) outsl((a),(s),(c))
192
193#define mmiowb() wmb() /* synco on SH-4A, otherwise a nop */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Paul Mundt0f2c15c2007-11-21 18:06:34 +0900195#define IO_SPACE_LIMIT 0xffffffff
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197/*
198 * This function provides a method for the generic case where a board-specific
Paul Mundtb66c1a32006-01-16 22:14:15 -0800199 * ioport_map simply needs to return the port + some arbitrary port base.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 *
201 * We use this at board setup time to implicitly set the port base, and
Paul Mundtb66c1a32006-01-16 22:14:15 -0800202 * as a result, we can use the generic ioport_map.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 */
204static inline void __set_io_port_base(unsigned long pbase)
205{
206 extern unsigned long generic_io_base;
207
208 generic_io_base = pbase;
209}
210
Magnus Damme7cc9a72008-02-07 20:18:21 +0900211#define __ioport_map(p, n) sh_mv.mv_ioport_map((p), (n))
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213/* We really want to try and get these to memcpy etc */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800214extern void memcpy_fromio(void *, volatile void __iomem *, unsigned long);
215extern void memcpy_toio(volatile void __iomem *, const void *, unsigned long);
216extern void memset_io(volatile void __iomem *, int, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218/* SuperH on-chip I/O functions */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800219static inline unsigned char ctrl_inb(unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
221 return *(volatile unsigned char*)addr;
222}
223
Paul Mundtb66c1a32006-01-16 22:14:15 -0800224static inline unsigned short ctrl_inw(unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
226 return *(volatile unsigned short*)addr;
227}
228
Paul Mundtb66c1a32006-01-16 22:14:15 -0800229static inline unsigned int ctrl_inl(unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
231 return *(volatile unsigned long*)addr;
232}
233
Paul Mundt0f2c15c2007-11-21 18:06:34 +0900234static inline unsigned long long ctrl_inq(unsigned long addr)
235{
236 return *(volatile unsigned long long*)addr;
237}
238
Paul Mundtb66c1a32006-01-16 22:14:15 -0800239static inline void ctrl_outb(unsigned char b, unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
241 *(volatile unsigned char*)addr = b;
242}
243
Paul Mundtb66c1a32006-01-16 22:14:15 -0800244static inline void ctrl_outw(unsigned short b, unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 *(volatile unsigned short*)addr = b;
247}
248
Paul Mundtb66c1a32006-01-16 22:14:15 -0800249static inline void ctrl_outl(unsigned int b, unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 *(volatile unsigned long*)addr = b;
252}
253
Paul Mundt0f2c15c2007-11-21 18:06:34 +0900254static inline void ctrl_outq(unsigned long long b, unsigned long addr)
255{
256 *(volatile unsigned long long*)addr = b;
257}
258
Paul Mundt959f85f2006-09-27 16:43:28 +0900259static inline void ctrl_delay(void)
260{
Paul Mundtda06b8d2007-11-09 12:58:12 +0900261#ifdef P2SEG
Paul Mundt959f85f2006-09-27 16:43:28 +0900262 ctrl_inw(P2SEG);
Paul Mundtda06b8d2007-11-09 12:58:12 +0900263#endif
Paul Mundt959f85f2006-09-27 16:43:28 +0900264}
265
Paul Mundtac490a42007-11-20 18:26:28 +0900266/* Quad-word real-mode I/O, don't ask.. */
267unsigned long long peek_real_address_q(unsigned long long addr);
268unsigned long long poke_real_address_q(unsigned long long addr,
269 unsigned long long val);
270
Paul Mundt0f2c15c2007-11-21 18:06:34 +0900271/* arch/sh/mm/ioremap_64.c */
272unsigned long onchip_remap(unsigned long addr, unsigned long size,
273 const char *name);
274extern void onchip_unmap(unsigned long vaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Paul Mundtda06b8d2007-11-09 12:58:12 +0900276#if !defined(CONFIG_MMU)
277#define virt_to_phys(address) ((unsigned long)(address))
278#define phys_to_virt(address) ((void *)(address))
Stuart Menefyd02b08f2007-11-30 17:52:53 +0900279#else
Paul Mundtda06b8d2007-11-09 12:58:12 +0900280#define virt_to_phys(address) (__pa(address))
281#define phys_to_virt(address) (__va(address))
Yoshinori Satoa2d1a5f2006-09-27 17:25:07 +0900282#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/*
Paul Mundtda06b8d2007-11-09 12:58:12 +0900285 * On 32-bit SH, we traditionally have the whole physical address space
286 * mapped at all times (as MIPS does), so "ioremap()" and "iounmap()" do
287 * not need to do anything but place the address in the proper segment.
288 * This is true for P1 and P2 addresses, as well as some P3 ones.
289 * However, most of the P3 addresses and newer cores using extended
290 * addressing need to map through page tables, so the ioremap()
291 * implementation becomes a bit more complicated.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 *
Paul Mundtda06b8d2007-11-09 12:58:12 +0900293 * See arch/sh/mm/ioremap.c for additional notes on this.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 *
295 * We cheat a bit and always return uncachable areas until we've fixed
Paul Mundtb66c1a32006-01-16 22:14:15 -0800296 * the drivers to handle caching properly.
Paul Mundtda06b8d2007-11-09 12:58:12 +0900297 *
298 * On the SH-5 the concept of segmentation in the 1:1 PXSEG sense simply
299 * doesn't exist, so everything must go through page tables.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 */
Paul Mundtb66c1a32006-01-16 22:14:15 -0800301#ifdef CONFIG_MMU
302void __iomem *__ioremap(unsigned long offset, unsigned long size,
303 unsigned long flags);
304void __iounmap(void __iomem *addr);
305#else
306#define __ioremap(offset, size, flags) ((void __iomem *)(offset))
307#define __iounmap(addr) do { } while (0)
308#endif /* CONFIG_MMU */
309
310static inline void __iomem *
311__ioremap_mode(unsigned long offset, unsigned long size, unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
Paul Mundtda06b8d2007-11-09 12:58:12 +0900313#ifdef CONFIG_SUPERH32
Paul Mundtb66c1a32006-01-16 22:14:15 -0800314 unsigned long last_addr = offset + size - 1;
Magnus Damme7cc9a72008-02-07 20:18:21 +0900315#endif
316 void __iomem *ret;
Paul Mundtb66c1a32006-01-16 22:14:15 -0800317
Magnus Damme7cc9a72008-02-07 20:18:21 +0900318 ret = __ioremap_trapped(offset, size);
319 if (ret)
320 return ret;
321
322#ifdef CONFIG_SUPERH32
Paul Mundtb66c1a32006-01-16 22:14:15 -0800323 /*
324 * For P1 and P2 space this is trivial, as everything is already
325 * mapped. Uncached access for P1 addresses are done through P2.
326 * In the P3 case or for addresses outside of the 29-bit space,
327 * mapping must be done by the PMB or by using page tables.
328 */
329 if (likely(PXSEG(offset) < P3SEG && PXSEG(last_addr) < P3SEG)) {
330 if (unlikely(flags & _PAGE_CACHABLE))
331 return (void __iomem *)P1SEGADDR(offset);
332
333 return (void __iomem *)P2SEGADDR(offset);
334 }
Paul Mundtda06b8d2007-11-09 12:58:12 +0900335#endif
Paul Mundtb66c1a32006-01-16 22:14:15 -0800336
337 return __ioremap(offset, size, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338}
339
Paul Mundtb66c1a32006-01-16 22:14:15 -0800340#define ioremap(offset, size) \
341 __ioremap_mode((offset), (size), 0)
342#define ioremap_nocache(offset, size) \
343 __ioremap_mode((offset), (size), 0)
344#define ioremap_cache(offset, size) \
345 __ioremap_mode((offset), (size), _PAGE_CACHABLE)
346#define p3_ioremap(offset, size, flags) \
347 __ioremap((offset), (size), (flags))
348#define iounmap(addr) \
349 __iounmap((addr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 * Convert a physical pointer to a virtual kernel pointer for /dev/mem
353 * access
354 */
355#define xlate_dev_mem_ptr(p) __va(p)
356
357/*
358 * Convert a virtual cached pointer to an uncached pointer
359 */
360#define xlate_dev_kmem_ptr(p) p
361
362#endif /* __KERNEL__ */
363
364#endif /* __ASM_SH_IO_H */