xref: /linux/arch/sh/include/asm/io.h (revision 2e18e047981ae04be9bd0d9760057f7c1a7b3785)
1 #ifndef __ASM_SH_IO_H
2 #define __ASM_SH_IO_H
3 /*
4  * Convention:
5  *    read{b,w,l,q}/write{b,w,l,q} are for PCI,
6  *    while in{b,w,l}/out{b,w,l} are for ISA
7  *
8  * In addition we have 'pausing' versions: in{b,w,l}_p/out{b,w,l}_p
9  * and 'string' versions: ins{b,w,l}/outs{b,w,l}
10  *
11  * While read{b,w,l,q} and write{b,w,l,q} contain memory barriers
12  * automatically, there are also __raw versions, which do not.
13  *
14  * Historically, we have also had ctrl_in{b,w,l,q}/ctrl_out{b,w,l,q} for
15  * SuperH specific I/O (raw I/O to on-chip CPU peripherals). In practice
16  * these have the same semantics as the __raw variants, and as such, all
17  * new code should be using the __raw versions.
18  *
19  * All ISA I/O routines are wrapped through the machine vector. If a
20  * board does not provide overrides, a generic set that are copied in
21  * from the default machine vector are used instead. These are largely
22  * for old compat code for I/O offseting to SuperIOs, all of which are
23  * better handled through the machvec ioport mapping routines these days.
24  */
25 #include <linux/errno.h>
26 #include <asm/cache.h>
27 #include <asm/system.h>
28 #include <asm/addrspace.h>
29 #include <asm/machvec.h>
30 #include <asm/pgtable.h>
31 #include <asm-generic/iomap.h>
32 
33 #ifdef __KERNEL__
34 /*
35  * Depending on which platform we are running on, we need different
36  * I/O functions.
37  */
38 #define __IO_PREFIX	generic
39 #include <asm/io_generic.h>
40 #include <asm/io_trapped.h>
41 
42 #define inb(p)			sh_mv.mv_inb((p))
43 #define inw(p)			sh_mv.mv_inw((p))
44 #define inl(p)			sh_mv.mv_inl((p))
45 #define outb(x,p)		sh_mv.mv_outb((x),(p))
46 #define outw(x,p)		sh_mv.mv_outw((x),(p))
47 #define outl(x,p)		sh_mv.mv_outl((x),(p))
48 
49 #define inb_p(p)		sh_mv.mv_inb_p((p))
50 #define inw_p(p)		sh_mv.mv_inw_p((p))
51 #define inl_p(p)		sh_mv.mv_inl_p((p))
52 #define outb_p(x,p)		sh_mv.mv_outb_p((x),(p))
53 #define outw_p(x,p)		sh_mv.mv_outw_p((x),(p))
54 #define outl_p(x,p)		sh_mv.mv_outl_p((x),(p))
55 
56 #define insb(p,b,c)		sh_mv.mv_insb((p), (b), (c))
57 #define insw(p,b,c)		sh_mv.mv_insw((p), (b), (c))
58 #define insl(p,b,c)		sh_mv.mv_insl((p), (b), (c))
59 #define outsb(p,b,c)		sh_mv.mv_outsb((p), (b), (c))
60 #define outsw(p,b,c)		sh_mv.mv_outsw((p), (b), (c))
61 #define outsl(p,b,c)		sh_mv.mv_outsl((p), (b), (c))
62 
63 #define __raw_writeb(v,a)	(__chk_io_ptr(a), *(volatile u8  __force *)(a) = (v))
64 #define __raw_writew(v,a)	(__chk_io_ptr(a), *(volatile u16 __force *)(a) = (v))
65 #define __raw_writel(v,a)	(__chk_io_ptr(a), *(volatile u32 __force *)(a) = (v))
66 #define __raw_writeq(v,a)	(__chk_io_ptr(a), *(volatile u64 __force *)(a) = (v))
67 
68 #define __raw_readb(a)		(__chk_io_ptr(a), *(volatile u8  __force *)(a))
69 #define __raw_readw(a)		(__chk_io_ptr(a), *(volatile u16 __force *)(a))
70 #define __raw_readl(a)		(__chk_io_ptr(a), *(volatile u32 __force *)(a))
71 #define __raw_readq(a)		(__chk_io_ptr(a), *(volatile u64 __force *)(a))
72 
73 #define readb(a)		({ u8  r_ = __raw_readb(a); mb(); r_; })
74 #define readw(a)		({ u16 r_ = __raw_readw(a); mb(); r_; })
75 #define readl(a)		({ u32 r_ = __raw_readl(a); mb(); r_; })
76 #define readq(a)		({ u64 r_ = __raw_readq(a); mb(); r_; })
77 
78 #define writeb(v,a)		({ __raw_writeb((v),(a)); mb(); })
79 #define writew(v,a)		({ __raw_writew((v),(a)); mb(); })
80 #define writel(v,a)		({ __raw_writel((v),(a)); mb(); })
81 #define writeq(v,a)		({ __raw_writeq((v),(a)); mb(); })
82 
83 /*
84  * Legacy SuperH on-chip I/O functions
85  *
86  * These are all deprecated, all new (and especially cross-platform) code
87  * should be using the __raw_xxx() routines directly.
88  */
89 static inline u8 __deprecated ctrl_inb(unsigned long addr)
90 {
91 	return __raw_readb(addr);
92 }
93 
94 static inline u16 __deprecated ctrl_inw(unsigned long addr)
95 {
96 	return __raw_readw(addr);
97 }
98 
99 static inline u32 __deprecated ctrl_inl(unsigned long addr)
100 {
101 	return __raw_readl(addr);
102 }
103 
104 static inline u64 __deprecated ctrl_inq(unsigned long addr)
105 {
106 	return __raw_readq(addr);
107 }
108 
109 static inline void __deprecated ctrl_outb(u8 v, unsigned long addr)
110 {
111 	__raw_writeb(v, addr);
112 }
113 
114 static inline void __deprecated ctrl_outw(u16 v, unsigned long addr)
115 {
116 	__raw_writew(v, addr);
117 }
118 
119 static inline void __deprecated ctrl_outl(u32 v, unsigned long addr)
120 {
121 	__raw_writel(v, addr);
122 }
123 
124 static inline void __deprecated ctrl_outq(u64 v, unsigned long addr)
125 {
126 	__raw_writeq(v, addr);
127 }
128 
129 extern unsigned long generic_io_base;
130 
131 static inline void ctrl_delay(void)
132 {
133 	__raw_readw(generic_io_base);
134 }
135 
136 #define __BUILD_MEMORY_STRING(bwlq, type)				\
137 									\
138 static inline void __raw_writes##bwlq(volatile void __iomem *mem,	\
139 				const void *addr, unsigned int count)	\
140 {									\
141 	const volatile type *__addr = addr;				\
142 									\
143 	while (count--) {						\
144 		__raw_write##bwlq(*__addr, mem);			\
145 		__addr++;						\
146 	}								\
147 }									\
148 									\
149 static inline void __raw_reads##bwlq(volatile void __iomem *mem,	\
150 			       void *addr, unsigned int count)		\
151 {									\
152 	volatile type *__addr = addr;					\
153 									\
154 	while (count--) {						\
155 		*__addr = __raw_read##bwlq(mem);			\
156 		__addr++;						\
157 	}								\
158 }
159 
160 __BUILD_MEMORY_STRING(b, u8)
161 __BUILD_MEMORY_STRING(w, u16)
162 
163 #ifdef CONFIG_SUPERH32
164 void __raw_writesl(void __iomem *addr, const void *data, int longlen);
165 void __raw_readsl(const void __iomem *addr, void *data, int longlen);
166 #else
167 __BUILD_MEMORY_STRING(l, u32)
168 #endif
169 
170 __BUILD_MEMORY_STRING(q, u64)
171 
172 #define writesb			__raw_writesb
173 #define writesw			__raw_writesw
174 #define writesl			__raw_writesl
175 
176 #define readsb			__raw_readsb
177 #define readsw			__raw_readsw
178 #define readsl			__raw_readsl
179 
180 #define readb_relaxed(a)	readb(a)
181 #define readw_relaxed(a)	readw(a)
182 #define readl_relaxed(a)	readl(a)
183 #define readq_relaxed(a)	readq(a)
184 
185 #ifndef CONFIG_GENERIC_IOMAP
186 /* Simple MMIO */
187 #define ioread8(a)		__raw_readb(a)
188 #define ioread16(a)		__raw_readw(a)
189 #define ioread16be(a)		be16_to_cpu(__raw_readw((a)))
190 #define ioread32(a)		__raw_readl(a)
191 #define ioread32be(a)		be32_to_cpu(__raw_readl((a)))
192 
193 #define iowrite8(v,a)		__raw_writeb((v),(a))
194 #define iowrite16(v,a)		__raw_writew((v),(a))
195 #define iowrite16be(v,a)	__raw_writew(cpu_to_be16((v)),(a))
196 #define iowrite32(v,a)		__raw_writel((v),(a))
197 #define iowrite32be(v,a)	__raw_writel(cpu_to_be32((v)),(a))
198 
199 #define ioread8_rep(a, d, c)	__raw_readsb((a), (d), (c))
200 #define ioread16_rep(a, d, c)	__raw_readsw((a), (d), (c))
201 #define ioread32_rep(a, d, c)	__raw_readsl((a), (d), (c))
202 
203 #define iowrite8_rep(a, s, c)	__raw_writesb((a), (s), (c))
204 #define iowrite16_rep(a, s, c)	__raw_writesw((a), (s), (c))
205 #define iowrite32_rep(a, s, c)	__raw_writesl((a), (s), (c))
206 #endif
207 
208 #define mmio_insb(p,d,c)	__raw_readsb(p,d,c)
209 #define mmio_insw(p,d,c)	__raw_readsw(p,d,c)
210 #define mmio_insl(p,d,c)	__raw_readsl(p,d,c)
211 
212 #define mmio_outsb(p,s,c)	__raw_writesb(p,s,c)
213 #define mmio_outsw(p,s,c)	__raw_writesw(p,s,c)
214 #define mmio_outsl(p,s,c)	__raw_writesl(p,s,c)
215 
216 /* synco on SH-4A, otherwise a nop */
217 #define mmiowb()		wmb()
218 
219 #define IO_SPACE_LIMIT 0xffffffff
220 
221 /*
222  * This function provides a method for the generic case where a
223  * board-specific ioport_map simply needs to return the port + some
224  * arbitrary port base.
225  *
226  * We use this at board setup time to implicitly set the port base, and
227  * as a result, we can use the generic ioport_map.
228  */
229 static inline void __set_io_port_base(unsigned long pbase)
230 {
231 	generic_io_base = pbase;
232 }
233 
234 #define __ioport_map(p, n) sh_mv.mv_ioport_map((p), (n))
235 
236 /* We really want to try and get these to memcpy etc */
237 void memcpy_fromio(void *, const volatile void __iomem *, unsigned long);
238 void memcpy_toio(volatile void __iomem *, const void *, unsigned long);
239 void memset_io(volatile void __iomem *, int, unsigned long);
240 
241 /* Quad-word real-mode I/O, don't ask.. */
242 unsigned long long peek_real_address_q(unsigned long long addr);
243 unsigned long long poke_real_address_q(unsigned long long addr,
244 				       unsigned long long val);
245 
246 #if !defined(CONFIG_MMU)
247 #define virt_to_phys(address)	((unsigned long)(address))
248 #define phys_to_virt(address)	((void *)(address))
249 #else
250 #define virt_to_phys(address)	(__pa(address))
251 #define phys_to_virt(address)	(__va(address))
252 #endif
253 
254 /*
255  * On 32-bit SH, we traditionally have the whole physical address space
256  * mapped at all times (as MIPS does), so "ioremap()" and "iounmap()" do
257  * not need to do anything but place the address in the proper segment.
258  * This is true for P1 and P2 addresses, as well as some P3 ones.
259  * However, most of the P3 addresses and newer cores using extended
260  * addressing need to map through page tables, so the ioremap()
261  * implementation becomes a bit more complicated.
262  *
263  * See arch/sh/mm/ioremap.c for additional notes on this.
264  *
265  * We cheat a bit and always return uncachable areas until we've fixed
266  * the drivers to handle caching properly.
267  *
268  * On the SH-5 the concept of segmentation in the 1:1 PXSEG sense simply
269  * doesn't exist, so everything must go through page tables.
270  */
271 #ifdef CONFIG_MMU
272 void __iomem *__ioremap_caller(unsigned long offset, unsigned long size,
273 			       pgprot_t prot, void *caller);
274 void __iounmap(void __iomem *addr);
275 
276 static inline void __iomem *
277 __ioremap(unsigned long offset, unsigned long size, pgprot_t prot)
278 {
279 	return __ioremap_caller(offset, size, prot, __builtin_return_address(0));
280 }
281 
282 static inline void __iomem *
283 __ioremap_29bit(unsigned long offset, unsigned long size, pgprot_t prot)
284 {
285 #ifdef CONFIG_29BIT
286 	unsigned long last_addr = offset + size - 1;
287 
288 	/*
289 	 * For P1 and P2 space this is trivial, as everything is already
290 	 * mapped. Uncached access for P1 addresses are done through P2.
291 	 * In the P3 case or for addresses outside of the 29-bit space,
292 	 * mapping must be done by the PMB or by using page tables.
293 	 */
294 	if (likely(PXSEG(offset) < P3SEG && PXSEG(last_addr) < P3SEG)) {
295 		if (unlikely(pgprot_val(prot) & _PAGE_CACHABLE))
296 			return (void __iomem *)P1SEGADDR(offset);
297 
298 		return (void __iomem *)P2SEGADDR(offset);
299 	}
300 
301 	/* P4 above the store queues are always mapped. */
302 	if (unlikely(offset >= P3_ADDR_MAX))
303 		return (void __iomem *)P4SEGADDR(offset);
304 #endif
305 
306 	return NULL;
307 }
308 
309 static inline void __iomem *
310 __ioremap_mode(unsigned long offset, unsigned long size, pgprot_t prot)
311 {
312 	void __iomem *ret;
313 
314 	ret = __ioremap_trapped(offset, size);
315 	if (ret)
316 		return ret;
317 
318 	ret = __ioremap_29bit(offset, size, prot);
319 	if (ret)
320 		return ret;
321 
322 	return __ioremap(offset, size, prot);
323 }
324 #else
325 #define __ioremap(offset, size, prot)		((void __iomem *)(offset))
326 #define __ioremap_mode(offset, size, prot)	((void __iomem *)(offset))
327 #define __iounmap(addr)				do { } while (0)
328 #endif /* CONFIG_MMU */
329 
330 static inline void __iomem *
331 ioremap(unsigned long offset, unsigned long size)
332 {
333 	return __ioremap_mode(offset, size, PAGE_KERNEL_NOCACHE);
334 }
335 
336 static inline void __iomem *
337 ioremap_cache(unsigned long offset, unsigned long size)
338 {
339 	return __ioremap_mode(offset, size, PAGE_KERNEL);
340 }
341 
342 #ifdef CONFIG_HAVE_IOREMAP_PROT
343 static inline void __iomem *
344 ioremap_prot(resource_size_t offset, unsigned long size, unsigned long flags)
345 {
346 	return __ioremap_mode(offset, size, __pgprot(flags));
347 }
348 #endif
349 
350 #ifdef CONFIG_IOREMAP_FIXED
351 extern void __iomem *ioremap_fixed(resource_size_t, unsigned long,
352 				   unsigned long, pgprot_t);
353 extern int iounmap_fixed(void __iomem *);
354 extern void ioremap_fixed_init(void);
355 #else
356 static inline void __iomem *
357 ioremap_fixed(resource_size_t phys_addr, unsigned long offset,
358 	      unsigned long size, pgprot_t prot)
359 {
360 	BUG();
361 	return NULL;
362 }
363 
364 static inline void ioremap_fixed_init(void) { }
365 static inline int iounmap_fixed(void __iomem *addr) { return -EINVAL; }
366 #endif
367 
368 #define ioremap_nocache	ioremap
369 #define iounmap		__iounmap
370 
371 #define maybebadio(port) \
372 	printk(KERN_ERR "bad PC-like io %s:%u for port 0x%lx at 0x%08x\n", \
373 	       __func__, __LINE__, (port), (u32)__builtin_return_address(0))
374 
375 /*
376  * Convert a physical pointer to a virtual kernel pointer for /dev/mem
377  * access
378  */
379 #define xlate_dev_mem_ptr(p)	__va(p)
380 
381 /*
382  * Convert a virtual cached pointer to an uncached pointer
383  */
384 #define xlate_dev_kmem_ptr(p)	p
385 
386 #define ARCH_HAS_VALID_PHYS_ADDR_RANGE
387 int valid_phys_addr_range(unsigned long addr, size_t size);
388 int valid_mmap_phys_addr_range(unsigned long pfn, size_t size);
389 
390 #endif /* __KERNEL__ */
391 
392 #endif /* __ASM_SH_IO_H */
393