xref: /OK3568_Linux_fs/kernel/arch/arc/include/asm/io.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com)
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #ifndef _ASM_ARC_IO_H
7*4882a593Smuzhiyun #define _ASM_ARC_IO_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/types.h>
10*4882a593Smuzhiyun #include <asm/byteorder.h>
11*4882a593Smuzhiyun #include <asm/page.h>
12*4882a593Smuzhiyun #include <asm/unaligned.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #ifdef CONFIG_ISA_ARCV2
15*4882a593Smuzhiyun #include <asm/barrier.h>
16*4882a593Smuzhiyun #define __iormb()		rmb()
17*4882a593Smuzhiyun #define __iowmb()		wmb()
18*4882a593Smuzhiyun #else
19*4882a593Smuzhiyun #define __iormb()		do { } while (0)
20*4882a593Smuzhiyun #define __iowmb()		do { } while (0)
21*4882a593Smuzhiyun #endif
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun extern void __iomem *ioremap(phys_addr_t paddr, unsigned long size);
24*4882a593Smuzhiyun extern void __iomem *ioremap_prot(phys_addr_t paddr, unsigned long size,
25*4882a593Smuzhiyun 				  unsigned long flags);
ioport_map(unsigned long port,unsigned int nr)26*4882a593Smuzhiyun static inline void __iomem *ioport_map(unsigned long port, unsigned int nr)
27*4882a593Smuzhiyun {
28*4882a593Smuzhiyun 	return (void __iomem *)port;
29*4882a593Smuzhiyun }
30*4882a593Smuzhiyun 
ioport_unmap(void __iomem * addr)31*4882a593Smuzhiyun static inline void ioport_unmap(void __iomem *addr)
32*4882a593Smuzhiyun {
33*4882a593Smuzhiyun }
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun extern void iounmap(const volatile void __iomem *addr);
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /*
38*4882a593Smuzhiyun  * io{read,write}{16,32}be() macros
39*4882a593Smuzhiyun  */
40*4882a593Smuzhiyun #define ioread16be(p)		({ u16 __v = be16_to_cpu((__force __be16)__raw_readw(p)); __iormb(); __v; })
41*4882a593Smuzhiyun #define ioread32be(p)		({ u32 __v = be32_to_cpu((__force __be32)__raw_readl(p)); __iormb(); __v; })
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun #define iowrite16be(v,p)	({ __iowmb(); __raw_writew((__force u16)cpu_to_be16(v), p); })
44*4882a593Smuzhiyun #define iowrite32be(v,p)	({ __iowmb(); __raw_writel((__force u32)cpu_to_be32(v), p); })
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun /* Change struct page to physical address */
47*4882a593Smuzhiyun #define page_to_phys(page)		(page_to_pfn(page) << PAGE_SHIFT)
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun #define __raw_readb __raw_readb
__raw_readb(const volatile void __iomem * addr)50*4882a593Smuzhiyun static inline u8 __raw_readb(const volatile void __iomem *addr)
51*4882a593Smuzhiyun {
52*4882a593Smuzhiyun 	u8 b;
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	__asm__ __volatile__(
55*4882a593Smuzhiyun 	"	ldb%U1 %0, %1	\n"
56*4882a593Smuzhiyun 	: "=r" (b)
57*4882a593Smuzhiyun 	: "m" (*(volatile u8 __force *)addr)
58*4882a593Smuzhiyun 	: "memory");
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	return b;
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun #define __raw_readw __raw_readw
__raw_readw(const volatile void __iomem * addr)64*4882a593Smuzhiyun static inline u16 __raw_readw(const volatile void __iomem *addr)
65*4882a593Smuzhiyun {
66*4882a593Smuzhiyun 	u16 s;
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	__asm__ __volatile__(
69*4882a593Smuzhiyun 	"	ldw%U1 %0, %1	\n"
70*4882a593Smuzhiyun 	: "=r" (s)
71*4882a593Smuzhiyun 	: "m" (*(volatile u16 __force *)addr)
72*4882a593Smuzhiyun 	: "memory");
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	return s;
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun #define __raw_readl __raw_readl
__raw_readl(const volatile void __iomem * addr)78*4882a593Smuzhiyun static inline u32 __raw_readl(const volatile void __iomem *addr)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun 	u32 w;
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 	__asm__ __volatile__(
83*4882a593Smuzhiyun 	"	ld%U1 %0, %1	\n"
84*4882a593Smuzhiyun 	: "=r" (w)
85*4882a593Smuzhiyun 	: "m" (*(volatile u32 __force *)addr)
86*4882a593Smuzhiyun 	: "memory");
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 	return w;
89*4882a593Smuzhiyun }
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun /*
92*4882a593Smuzhiyun  * {read,write}s{b,w,l}() repeatedly access the same IO address in
93*4882a593Smuzhiyun  * native endianness in 8-, 16-, 32-bit chunks {into,from} memory,
94*4882a593Smuzhiyun  * @count times
95*4882a593Smuzhiyun  */
96*4882a593Smuzhiyun #define __raw_readsx(t,f) \
97*4882a593Smuzhiyun static inline void __raw_reads##f(const volatile void __iomem *addr,	\
98*4882a593Smuzhiyun 				  void *ptr, unsigned int count)	\
99*4882a593Smuzhiyun {									\
100*4882a593Smuzhiyun 	bool is_aligned = ((unsigned long)ptr % ((t) / 8)) == 0;	\
101*4882a593Smuzhiyun 	u##t *buf = ptr;						\
102*4882a593Smuzhiyun 									\
103*4882a593Smuzhiyun 	if (!count)							\
104*4882a593Smuzhiyun 		return;							\
105*4882a593Smuzhiyun 									\
106*4882a593Smuzhiyun 	/* Some ARC CPU's don't support unaligned accesses */		\
107*4882a593Smuzhiyun 	if (is_aligned) {						\
108*4882a593Smuzhiyun 		do {							\
109*4882a593Smuzhiyun 			u##t x = __raw_read##f(addr);			\
110*4882a593Smuzhiyun 			*buf++ = x;					\
111*4882a593Smuzhiyun 		} while (--count);					\
112*4882a593Smuzhiyun 	} else {							\
113*4882a593Smuzhiyun 		do {							\
114*4882a593Smuzhiyun 			u##t x = __raw_read##f(addr);			\
115*4882a593Smuzhiyun 			put_unaligned(x, buf++);			\
116*4882a593Smuzhiyun 		} while (--count);					\
117*4882a593Smuzhiyun 	}								\
118*4882a593Smuzhiyun }
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun #define __raw_readsb __raw_readsb
121*4882a593Smuzhiyun __raw_readsx(8, b)
122*4882a593Smuzhiyun #define __raw_readsw __raw_readsw
123*4882a593Smuzhiyun __raw_readsx(16, w)
124*4882a593Smuzhiyun #define __raw_readsl __raw_readsl
125*4882a593Smuzhiyun __raw_readsx(32, l)
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun #define __raw_writeb __raw_writeb
__raw_writeb(u8 b,volatile void __iomem * addr)128*4882a593Smuzhiyun static inline void __raw_writeb(u8 b, volatile void __iomem *addr)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun 	__asm__ __volatile__(
131*4882a593Smuzhiyun 	"	stb%U1 %0, %1	\n"
132*4882a593Smuzhiyun 	:
133*4882a593Smuzhiyun 	: "r" (b), "m" (*(volatile u8 __force *)addr)
134*4882a593Smuzhiyun 	: "memory");
135*4882a593Smuzhiyun }
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun #define __raw_writew __raw_writew
__raw_writew(u16 s,volatile void __iomem * addr)138*4882a593Smuzhiyun static inline void __raw_writew(u16 s, volatile void __iomem *addr)
139*4882a593Smuzhiyun {
140*4882a593Smuzhiyun 	__asm__ __volatile__(
141*4882a593Smuzhiyun 	"	stw%U1 %0, %1	\n"
142*4882a593Smuzhiyun 	:
143*4882a593Smuzhiyun 	: "r" (s), "m" (*(volatile u16 __force *)addr)
144*4882a593Smuzhiyun 	: "memory");
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun #define __raw_writel __raw_writel
__raw_writel(u32 w,volatile void __iomem * addr)149*4882a593Smuzhiyun static inline void __raw_writel(u32 w, volatile void __iomem *addr)
150*4882a593Smuzhiyun {
151*4882a593Smuzhiyun 	__asm__ __volatile__(
152*4882a593Smuzhiyun 	"	st%U1 %0, %1	\n"
153*4882a593Smuzhiyun 	:
154*4882a593Smuzhiyun 	: "r" (w), "m" (*(volatile u32 __force *)addr)
155*4882a593Smuzhiyun 	: "memory");
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun }
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun #define __raw_writesx(t,f)						\
160*4882a593Smuzhiyun static inline void __raw_writes##f(volatile void __iomem *addr, 	\
161*4882a593Smuzhiyun 				   const void *ptr, unsigned int count)	\
162*4882a593Smuzhiyun {									\
163*4882a593Smuzhiyun 	bool is_aligned = ((unsigned long)ptr % ((t) / 8)) == 0;	\
164*4882a593Smuzhiyun 	const u##t *buf = ptr;						\
165*4882a593Smuzhiyun 									\
166*4882a593Smuzhiyun 	if (!count)							\
167*4882a593Smuzhiyun 		return;							\
168*4882a593Smuzhiyun 									\
169*4882a593Smuzhiyun 	/* Some ARC CPU's don't support unaligned accesses */		\
170*4882a593Smuzhiyun 	if (is_aligned) {						\
171*4882a593Smuzhiyun 		do {							\
172*4882a593Smuzhiyun 			__raw_write##f(*buf++, addr);			\
173*4882a593Smuzhiyun 		} while (--count);					\
174*4882a593Smuzhiyun 	} else {							\
175*4882a593Smuzhiyun 		do {							\
176*4882a593Smuzhiyun 			__raw_write##f(get_unaligned(buf++), addr);	\
177*4882a593Smuzhiyun 		} while (--count);					\
178*4882a593Smuzhiyun 	}								\
179*4882a593Smuzhiyun }
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun #define __raw_writesb __raw_writesb
182*4882a593Smuzhiyun __raw_writesx(8, b)
183*4882a593Smuzhiyun #define __raw_writesw __raw_writesw
184*4882a593Smuzhiyun __raw_writesx(16, w)
185*4882a593Smuzhiyun #define __raw_writesl __raw_writesl
186*4882a593Smuzhiyun __raw_writesx(32, l)
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun /*
189*4882a593Smuzhiyun  * MMIO can also get buffered/optimized in micro-arch, so barriers needed
190*4882a593Smuzhiyun  * Based on ARM model for the typical use case
191*4882a593Smuzhiyun  *
192*4882a593Smuzhiyun  *	<ST [DMA buffer]>
193*4882a593Smuzhiyun  *	<writel MMIO "go" reg>
194*4882a593Smuzhiyun  *  or:
195*4882a593Smuzhiyun  *	<readl MMIO "status" reg>
196*4882a593Smuzhiyun  *	<LD [DMA buffer]>
197*4882a593Smuzhiyun  *
198*4882a593Smuzhiyun  * http://lkml.kernel.org/r/20150622133656.GG1583@arm.com
199*4882a593Smuzhiyun  */
200*4882a593Smuzhiyun #define readb(c)		({ u8  __v = readb_relaxed(c); __iormb(); __v; })
201*4882a593Smuzhiyun #define readw(c)		({ u16 __v = readw_relaxed(c); __iormb(); __v; })
202*4882a593Smuzhiyun #define readl(c)		({ u32 __v = readl_relaxed(c); __iormb(); __v; })
203*4882a593Smuzhiyun #define readsb(p,d,l)		({ __raw_readsb(p,d,l); __iormb(); })
204*4882a593Smuzhiyun #define readsw(p,d,l)		({ __raw_readsw(p,d,l); __iormb(); })
205*4882a593Smuzhiyun #define readsl(p,d,l)		({ __raw_readsl(p,d,l); __iormb(); })
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun #define writeb(v,c)		({ __iowmb(); writeb_relaxed(v,c); })
208*4882a593Smuzhiyun #define writew(v,c)		({ __iowmb(); writew_relaxed(v,c); })
209*4882a593Smuzhiyun #define writel(v,c)		({ __iowmb(); writel_relaxed(v,c); })
210*4882a593Smuzhiyun #define writesb(p,d,l)		({ __iowmb(); __raw_writesb(p,d,l); })
211*4882a593Smuzhiyun #define writesw(p,d,l)		({ __iowmb(); __raw_writesw(p,d,l); })
212*4882a593Smuzhiyun #define writesl(p,d,l)		({ __iowmb(); __raw_writesl(p,d,l); })
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun /*
215*4882a593Smuzhiyun  * Relaxed API for drivers which can handle barrier ordering themselves
216*4882a593Smuzhiyun  *
217*4882a593Smuzhiyun  * Also these are defined to perform little endian accesses.
218*4882a593Smuzhiyun  * To provide the typical device register semantics of fixed endian,
219*4882a593Smuzhiyun  * swap the byte order for Big Endian
220*4882a593Smuzhiyun  *
221*4882a593Smuzhiyun  * http://lkml.kernel.org/r/201603100845.30602.arnd@arndb.de
222*4882a593Smuzhiyun  */
223*4882a593Smuzhiyun #define readb_relaxed(c)	__raw_readb(c)
224*4882a593Smuzhiyun #define readw_relaxed(c) ({ u16 __r = le16_to_cpu((__force __le16) \
225*4882a593Smuzhiyun 					__raw_readw(c)); __r; })
226*4882a593Smuzhiyun #define readl_relaxed(c) ({ u32 __r = le32_to_cpu((__force __le32) \
227*4882a593Smuzhiyun 					__raw_readl(c)); __r; })
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun #define writeb_relaxed(v,c)	__raw_writeb(v,c)
230*4882a593Smuzhiyun #define writew_relaxed(v,c)	__raw_writew((__force u16) cpu_to_le16(v),c)
231*4882a593Smuzhiyun #define writel_relaxed(v,c)	__raw_writel((__force u32) cpu_to_le32(v),c)
232*4882a593Smuzhiyun 
233*4882a593Smuzhiyun #include <asm-generic/io.h>
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun #endif /* _ASM_ARC_IO_H */
236