1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __ASM_SH_IO_H 3 #define __ASM_SH_IO_H 4 5 /* 6 * Convention: 7 * read{b,w,l,q}/write{b,w,l,q} are for PCI, 8 * while in{b,w,l}/out{b,w,l} are for ISA 9 * 10 * In addition we have 'pausing' versions: in{b,w,l}_p/out{b,w,l}_p 11 * and 'string' versions: ins{b,w,l}/outs{b,w,l} 12 * 13 * While read{b,w,l,q} and write{b,w,l,q} contain memory barriers 14 * automatically, there are also __raw versions, which do not. 15 */ 16 #include <linux/errno.h> 17 #include <asm/cache.h> 18 #include <asm/addrspace.h> 19 #include <asm/machvec.h> 20 #include <asm/pgtable.h> 21 #include <asm-generic/iomap.h> 22 23 #ifdef __KERNEL__ 24 #define __IO_PREFIX generic 25 #include <asm/io_generic.h> 26 #include <asm/io_trapped.h> 27 #include <asm-generic/pci_iomap.h> 28 #include <mach/mangle-port.h> 29 30 #define __raw_writeb(v,a) (__chk_io_ptr(a), *(volatile u8 __force *)(a) = (v)) 31 #define __raw_writew(v,a) (__chk_io_ptr(a), *(volatile u16 __force *)(a) = (v)) 32 #define __raw_writel(v,a) (__chk_io_ptr(a), *(volatile u32 __force *)(a) = (v)) 33 #define __raw_writeq(v,a) (__chk_io_ptr(a), *(volatile u64 __force *)(a) = (v)) 34 35 #define __raw_readb(a) (__chk_io_ptr(a), *(volatile u8 __force *)(a)) 36 #define __raw_readw(a) (__chk_io_ptr(a), *(volatile u16 __force *)(a)) 37 #define __raw_readl(a) (__chk_io_ptr(a), *(volatile u32 __force *)(a)) 38 #define __raw_readq(a) (__chk_io_ptr(a), *(volatile u64 __force *)(a)) 39 40 #define readb_relaxed(c) ({ u8 __v = ioswabb(__raw_readb(c)); __v; }) 41 #define readw_relaxed(c) ({ u16 __v = ioswabw(__raw_readw(c)); __v; }) 42 #define readl_relaxed(c) ({ u32 __v = ioswabl(__raw_readl(c)); __v; }) 43 #define readq_relaxed(c) ({ u64 __v = ioswabq(__raw_readq(c)); __v; }) 44 45 #define writeb_relaxed(v,c) ((void)__raw_writeb((__force u8)ioswabb(v),c)) 46 #define writew_relaxed(v,c) ((void)__raw_writew((__force u16)ioswabw(v),c)) 47 #define writel_relaxed(v,c) ((void)__raw_writel((__force u32)ioswabl(v),c)) 48 #define writeq_relaxed(v,c) ((void)__raw_writeq((__force u64)ioswabq(v),c)) 49 50 #define readb(a) ({ u8 r_ = readb_relaxed(a); rmb(); r_; }) 51 #define readw(a) ({ u16 r_ = readw_relaxed(a); rmb(); r_; }) 52 #define readl(a) ({ u32 r_ = readl_relaxed(a); rmb(); r_; }) 53 #define readq(a) ({ u64 r_ = readq_relaxed(a); rmb(); r_; }) 54 55 #define writeb(v,a) ({ wmb(); writeb_relaxed((v),(a)); }) 56 #define writew(v,a) ({ wmb(); writew_relaxed((v),(a)); }) 57 #define writel(v,a) ({ wmb(); writel_relaxed((v),(a)); }) 58 #define writeq(v,a) ({ wmb(); writeq_relaxed((v),(a)); }) 59 60 #define readsb(p,d,l) __raw_readsb(p,d,l) 61 #define readsw(p,d,l) __raw_readsw(p,d,l) 62 #define readsl(p,d,l) __raw_readsl(p,d,l) 63 64 #define writesb(p,d,l) __raw_writesb(p,d,l) 65 #define writesw(p,d,l) __raw_writesw(p,d,l) 66 #define writesl(p,d,l) __raw_writesl(p,d,l) 67 68 #define __BUILD_UNCACHED_IO(bwlq, type) \ 69 static inline type read##bwlq##_uncached(unsigned long addr) \ 70 { \ 71 type ret; \ 72 jump_to_uncached(); \ 73 ret = __raw_read##bwlq(addr); \ 74 back_to_cached(); \ 75 return ret; \ 76 } \ 77 \ 78 static inline void write##bwlq##_uncached(type v, unsigned long addr) \ 79 { \ 80 jump_to_uncached(); \ 81 __raw_write##bwlq(v, addr); \ 82 back_to_cached(); \ 83 } 84 85 __BUILD_UNCACHED_IO(b, u8) 86 __BUILD_UNCACHED_IO(w, u16) 87 __BUILD_UNCACHED_IO(l, u32) 88 __BUILD_UNCACHED_IO(q, u64) 89 90 #define __BUILD_MEMORY_STRING(pfx, bwlq, type) \ 91 \ 92 static inline void \ 93 pfx##writes##bwlq(volatile void __iomem *mem, const void *addr, \ 94 unsigned int count) \ 95 { \ 96 const volatile type *__addr = addr; \ 97 \ 98 while (count--) { \ 99 __raw_write##bwlq(*__addr, mem); \ 100 __addr++; \ 101 } \ 102 } \ 103 \ 104 static inline void pfx##reads##bwlq(volatile void __iomem *mem, \ 105 void *addr, unsigned int count) \ 106 { \ 107 volatile type *__addr = addr; \ 108 \ 109 while (count--) { \ 110 *__addr = __raw_read##bwlq(mem); \ 111 __addr++; \ 112 } \ 113 } 114 115 __BUILD_MEMORY_STRING(__raw_, b, u8) 116 __BUILD_MEMORY_STRING(__raw_, w, u16) 117 118 #ifdef CONFIG_SUPERH32 119 void __raw_writesl(void __iomem *addr, const void *data, int longlen); 120 void __raw_readsl(const void __iomem *addr, void *data, int longlen); 121 #else 122 __BUILD_MEMORY_STRING(__raw_, l, u32) 123 #endif 124 125 __BUILD_MEMORY_STRING(__raw_, q, u64) 126 127 #ifdef CONFIG_HAS_IOPORT_MAP 128 129 /* 130 * Slowdown I/O port space accesses for antique hardware. 131 */ 132 #undef CONF_SLOWDOWN_IO 133 134 /* 135 * On SuperH I/O ports are memory mapped, so we access them using normal 136 * load/store instructions. sh_io_port_base is the virtual address to 137 * which all ports are being mapped. 138 */ 139 extern unsigned long sh_io_port_base; 140 141 static inline void __set_io_port_base(unsigned long pbase) 142 { 143 *(unsigned long *)&sh_io_port_base = pbase; 144 barrier(); 145 } 146 147 #ifdef CONFIG_GENERIC_IOMAP 148 #define __ioport_map ioport_map 149 #else 150 extern void __iomem *__ioport_map(unsigned long addr, unsigned int size); 151 #endif 152 153 #ifdef CONF_SLOWDOWN_IO 154 #define SLOW_DOWN_IO __raw_readw(sh_io_port_base) 155 #else 156 #define SLOW_DOWN_IO 157 #endif 158 159 #define __BUILD_IOPORT_SINGLE(pfx, bwlq, type, p, slow) \ 160 \ 161 static inline void pfx##out##bwlq##p(type val, unsigned long port) \ 162 { \ 163 volatile type *__addr; \ 164 \ 165 __addr = __ioport_map(port, sizeof(type)); \ 166 *__addr = val; \ 167 slow; \ 168 } \ 169 \ 170 static inline type pfx##in##bwlq##p(unsigned long port) \ 171 { \ 172 volatile type *__addr; \ 173 type __val; \ 174 \ 175 __addr = __ioport_map(port, sizeof(type)); \ 176 __val = *__addr; \ 177 slow; \ 178 \ 179 return __val; \ 180 } 181 182 #define __BUILD_IOPORT_PFX(bus, bwlq, type) \ 183 __BUILD_IOPORT_SINGLE(bus, bwlq, type, ,) \ 184 __BUILD_IOPORT_SINGLE(bus, bwlq, type, _p, SLOW_DOWN_IO) 185 186 #define BUILDIO_IOPORT(bwlq, type) \ 187 __BUILD_IOPORT_PFX(, bwlq, type) 188 189 BUILDIO_IOPORT(b, u8) 190 BUILDIO_IOPORT(w, u16) 191 BUILDIO_IOPORT(l, u32) 192 BUILDIO_IOPORT(q, u64) 193 194 #define __BUILD_IOPORT_STRING(bwlq, type) \ 195 \ 196 static inline void outs##bwlq(unsigned long port, const void *addr, \ 197 unsigned int count) \ 198 { \ 199 const volatile type *__addr = addr; \ 200 \ 201 while (count--) { \ 202 out##bwlq(*__addr, port); \ 203 __addr++; \ 204 } \ 205 } \ 206 \ 207 static inline void ins##bwlq(unsigned long port, void *addr, \ 208 unsigned int count) \ 209 { \ 210 volatile type *__addr = addr; \ 211 \ 212 while (count--) { \ 213 *__addr = in##bwlq(port); \ 214 __addr++; \ 215 } \ 216 } 217 218 __BUILD_IOPORT_STRING(b, u8) 219 __BUILD_IOPORT_STRING(w, u16) 220 __BUILD_IOPORT_STRING(l, u32) 221 __BUILD_IOPORT_STRING(q, u64) 222 223 #else /* !CONFIG_HAS_IOPORT_MAP */ 224 225 #include <asm/io_noioport.h> 226 227 #endif 228 229 230 #define IO_SPACE_LIMIT 0xffffffff 231 232 /* synco on SH-4A, otherwise a nop */ 233 #define mmiowb() wmb() 234 235 /* We really want to try and get these to memcpy etc */ 236 void memcpy_fromio(void *, const volatile void __iomem *, unsigned long); 237 void memcpy_toio(volatile void __iomem *, const void *, unsigned long); 238 void memset_io(volatile void __iomem *, int, unsigned long); 239 240 /* Quad-word real-mode I/O, don't ask.. */ 241 unsigned long long peek_real_address_q(unsigned long long addr); 242 unsigned long long poke_real_address_q(unsigned long long addr, 243 unsigned long long val); 244 245 #if !defined(CONFIG_MMU) 246 #define virt_to_phys(address) ((unsigned long)(address)) 247 #define phys_to_virt(address) ((void *)(address)) 248 #else 249 #define virt_to_phys(address) (__pa(address)) 250 #define phys_to_virt(address) (__va(address)) 251 #endif 252 253 /* 254 * On 32-bit SH, we traditionally have the whole physical address space 255 * mapped at all times (as MIPS does), so "ioremap()" and "iounmap()" do 256 * not need to do anything but place the address in the proper segment. 257 * This is true for P1 and P2 addresses, as well as some P3 ones. 258 * However, most of the P3 addresses and newer cores using extended 259 * addressing need to map through page tables, so the ioremap() 260 * implementation becomes a bit more complicated. 261 * 262 * See arch/sh/mm/ioremap.c for additional notes on this. 263 * 264 * We cheat a bit and always return uncachable areas until we've fixed 265 * the drivers to handle caching properly. 266 * 267 * On the SH-5 the concept of segmentation in the 1:1 PXSEG sense simply 268 * doesn't exist, so everything must go through page tables. 269 */ 270 #ifdef CONFIG_MMU 271 void __iomem *__ioremap_caller(phys_addr_t offset, unsigned long size, 272 pgprot_t prot, void *caller); 273 void __iounmap(void __iomem *addr); 274 275 static inline void __iomem * 276 __ioremap(phys_addr_t offset, unsigned long size, pgprot_t prot) 277 { 278 return __ioremap_caller(offset, size, prot, __builtin_return_address(0)); 279 } 280 281 static inline void __iomem * 282 __ioremap_29bit(phys_addr_t offset, unsigned long size, pgprot_t prot) 283 { 284 #ifdef CONFIG_29BIT 285 phys_addr_t last_addr = offset + size - 1; 286 287 /* 288 * For P1 and P2 space this is trivial, as everything is already 289 * mapped. Uncached access for P1 addresses are done through P2. 290 * In the P3 case or for addresses outside of the 29-bit space, 291 * mapping must be done by the PMB or by using page tables. 292 */ 293 if (likely(PXSEG(offset) < P3SEG && PXSEG(last_addr) < P3SEG)) { 294 u64 flags = pgprot_val(prot); 295 296 /* 297 * Anything using the legacy PTEA space attributes needs 298 * to be kicked down to page table mappings. 299 */ 300 if (unlikely(flags & _PAGE_PCC_MASK)) 301 return NULL; 302 if (unlikely(flags & _PAGE_CACHABLE)) 303 return (void __iomem *)P1SEGADDR(offset); 304 305 return (void __iomem *)P2SEGADDR(offset); 306 } 307 308 /* P4 above the store queues are always mapped. */ 309 if (unlikely(offset >= P3_ADDR_MAX)) 310 return (void __iomem *)P4SEGADDR(offset); 311 #endif 312 313 return NULL; 314 } 315 316 static inline void __iomem * 317 __ioremap_mode(phys_addr_t offset, unsigned long size, pgprot_t prot) 318 { 319 void __iomem *ret; 320 321 ret = __ioremap_trapped(offset, size); 322 if (ret) 323 return ret; 324 325 ret = __ioremap_29bit(offset, size, prot); 326 if (ret) 327 return ret; 328 329 return __ioremap(offset, size, prot); 330 } 331 #else 332 #define __ioremap(offset, size, prot) ((void __iomem *)(offset)) 333 #define __ioremap_mode(offset, size, prot) ((void __iomem *)(offset)) 334 #define __iounmap(addr) do { } while (0) 335 #endif /* CONFIG_MMU */ 336 337 static inline void __iomem *ioremap(phys_addr_t offset, unsigned long size) 338 { 339 return __ioremap_mode(offset, size, PAGE_KERNEL_NOCACHE); 340 } 341 342 static inline void __iomem * 343 ioremap_cache(phys_addr_t offset, unsigned long size) 344 { 345 return __ioremap_mode(offset, size, PAGE_KERNEL); 346 } 347 #define ioremap_cache ioremap_cache 348 349 #ifdef CONFIG_HAVE_IOREMAP_PROT 350 static inline void __iomem * 351 ioremap_prot(phys_addr_t offset, unsigned long size, unsigned long flags) 352 { 353 return __ioremap_mode(offset, size, __pgprot(flags)); 354 } 355 #endif 356 357 #ifdef CONFIG_IOREMAP_FIXED 358 extern void __iomem *ioremap_fixed(phys_addr_t, unsigned long, pgprot_t); 359 extern int iounmap_fixed(void __iomem *); 360 extern void ioremap_fixed_init(void); 361 #else 362 static inline void __iomem * 363 ioremap_fixed(phys_addr_t phys_addr, unsigned long size, pgprot_t prot) 364 { 365 BUG(); 366 return NULL; 367 } 368 369 static inline void ioremap_fixed_init(void) { } 370 static inline int iounmap_fixed(void __iomem *addr) { return -EINVAL; } 371 #endif 372 373 #define ioremap_nocache ioremap 374 #define ioremap_uc ioremap 375 #define iounmap __iounmap 376 377 /* 378 * Convert a physical pointer to a virtual kernel pointer for /dev/mem 379 * access 380 */ 381 #define xlate_dev_mem_ptr(p) __va(p) 382 383 /* 384 * Convert a virtual cached pointer to an uncached pointer 385 */ 386 #define xlate_dev_kmem_ptr(p) p 387 388 #define ARCH_HAS_VALID_PHYS_ADDR_RANGE 389 int valid_phys_addr_range(phys_addr_t addr, size_t size); 390 int valid_mmap_phys_addr_range(unsigned long pfn, size_t size); 391 392 #endif /* __KERNEL__ */ 393 394 #endif /* __ASM_SH_IO_H */ 395