1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* Generic I/O port emulation.
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
7 #ifndef __ASM_GENERIC_IO_H
8 #define __ASM_GENERIC_IO_H
10 #include <asm/page.h> /* I/O is all done through memory accesses */
11 #include <linux/string.h> /* for memset() and memcpy() */
12 #include <linux/types.h>
14 #ifdef CONFIG_GENERIC_IOMAP
15 #include <asm-generic/iomap.h>
18 #include <asm/mmiowb.h>
19 #include <asm-generic/pci_iomap.h>
22 #define __io_br() barrier()
25 /* prevent prefetching of coherent DMA data ahead of a dma-complete */
28 #define __io_ar(v) rmb()
30 #define __io_ar(v) barrier()
34 /* flush writes to coherent DMA data before possibly triggering a DMA read */
37 #define __io_bw() wmb()
39 #define __io_bw() barrier()
43 /* serialize device access against a spin_unlock, usually handled there. */
45 #define __io_aw() mmiowb_set_pending()
49 #define __io_pbw() __io_bw()
53 #define __io_paw() __io_aw()
57 #define __io_pbr() __io_br()
61 #define __io_par(v) __io_ar(v)
66 * __raw_{read,write}{b,w,l,q}() access memory in native endianness.
68 * On some architectures memory mapped IO needs to be accessed differently.
69 * On the simple architectures, we just read/write the memory location
74 #define __raw_readb __raw_readb
75 static inline u8
__raw_readb(const volatile void __iomem
*addr
)
77 return *(const volatile u8 __force
*)addr
;
82 #define __raw_readw __raw_readw
83 static inline u16
__raw_readw(const volatile void __iomem
*addr
)
85 return *(const volatile u16 __force
*)addr
;
90 #define __raw_readl __raw_readl
91 static inline u32
__raw_readl(const volatile void __iomem
*addr
)
93 return *(const volatile u32 __force
*)addr
;
99 #define __raw_readq __raw_readq
100 static inline u64
__raw_readq(const volatile void __iomem
*addr
)
102 return *(const volatile u64 __force
*)addr
;
105 #endif /* CONFIG_64BIT */
108 #define __raw_writeb __raw_writeb
109 static inline void __raw_writeb(u8 value
, volatile void __iomem
*addr
)
111 *(volatile u8 __force
*)addr
= value
;
116 #define __raw_writew __raw_writew
117 static inline void __raw_writew(u16 value
, volatile void __iomem
*addr
)
119 *(volatile u16 __force
*)addr
= value
;
124 #define __raw_writel __raw_writel
125 static inline void __raw_writel(u32 value
, volatile void __iomem
*addr
)
127 *(volatile u32 __force
*)addr
= value
;
133 #define __raw_writeq __raw_writeq
134 static inline void __raw_writeq(u64 value
, volatile void __iomem
*addr
)
136 *(volatile u64 __force
*)addr
= value
;
139 #endif /* CONFIG_64BIT */
142 * {read,write}{b,w,l,q}() access little endian memory and return result in
148 static inline u8
readb(const volatile void __iomem
*addr
)
153 val
= __raw_readb(addr
);
161 static inline u16
readw(const volatile void __iomem
*addr
)
166 val
= __le16_to_cpu((__le16 __force
)__raw_readw(addr
));
174 static inline u32
readl(const volatile void __iomem
*addr
)
179 val
= __le32_to_cpu((__le32 __force
)__raw_readl(addr
));
188 static inline u64
readq(const volatile void __iomem
*addr
)
193 val
= __le64_to_cpu(__raw_readq(addr
));
198 #endif /* CONFIG_64BIT */
201 #define writeb writeb
202 static inline void writeb(u8 value
, volatile void __iomem
*addr
)
205 __raw_writeb(value
, addr
);
211 #define writew writew
212 static inline void writew(u16 value
, volatile void __iomem
*addr
)
215 __raw_writew((u16 __force
)cpu_to_le16(value
), addr
);
221 #define writel writel
222 static inline void writel(u32 value
, volatile void __iomem
*addr
)
225 __raw_writel((u32 __force
)__cpu_to_le32(value
), addr
);
232 #define writeq writeq
233 static inline void writeq(u64 value
, volatile void __iomem
*addr
)
236 __raw_writeq(__cpu_to_le64(value
), addr
);
240 #endif /* CONFIG_64BIT */
243 * {read,write}{b,w,l,q}_relaxed() are like the regular version, but
244 * are not guaranteed to provide ordering against spinlocks or memory
247 #ifndef readb_relaxed
248 #define readb_relaxed readb_relaxed
249 static inline u8
readb_relaxed(const volatile void __iomem
*addr
)
251 return __raw_readb(addr
);
255 #ifndef readw_relaxed
256 #define readw_relaxed readw_relaxed
257 static inline u16
readw_relaxed(const volatile void __iomem
*addr
)
259 return __le16_to_cpu(__raw_readw(addr
));
263 #ifndef readl_relaxed
264 #define readl_relaxed readl_relaxed
265 static inline u32
readl_relaxed(const volatile void __iomem
*addr
)
267 return __le32_to_cpu(__raw_readl(addr
));
271 #if defined(readq) && !defined(readq_relaxed)
272 #define readq_relaxed readq_relaxed
273 static inline u64
readq_relaxed(const volatile void __iomem
*addr
)
275 return __le64_to_cpu(__raw_readq(addr
));
279 #ifndef writeb_relaxed
280 #define writeb_relaxed writeb_relaxed
281 static inline void writeb_relaxed(u8 value
, volatile void __iomem
*addr
)
283 __raw_writeb(value
, addr
);
287 #ifndef writew_relaxed
288 #define writew_relaxed writew_relaxed
289 static inline void writew_relaxed(u16 value
, volatile void __iomem
*addr
)
291 __raw_writew(cpu_to_le16(value
), addr
);
295 #ifndef writel_relaxed
296 #define writel_relaxed writel_relaxed
297 static inline void writel_relaxed(u32 value
, volatile void __iomem
*addr
)
299 __raw_writel(__cpu_to_le32(value
), addr
);
303 #if defined(writeq) && !defined(writeq_relaxed)
304 #define writeq_relaxed writeq_relaxed
305 static inline void writeq_relaxed(u64 value
, volatile void __iomem
*addr
)
307 __raw_writeq(__cpu_to_le64(value
), addr
);
312 * {read,write}s{b,w,l,q}() repeatedly access the same memory address in
313 * native endianness in 8-, 16-, 32- or 64-bit chunks (@count times).
316 #define readsb readsb
317 static inline void readsb(const volatile void __iomem
*addr
, void *buffer
,
324 u8 x
= __raw_readb(addr
);
332 #define readsw readsw
333 static inline void readsw(const volatile void __iomem
*addr
, void *buffer
,
340 u16 x
= __raw_readw(addr
);
348 #define readsl readsl
349 static inline void readsl(const volatile void __iomem
*addr
, void *buffer
,
356 u32 x
= __raw_readl(addr
);
365 #define readsq readsq
366 static inline void readsq(const volatile void __iomem
*addr
, void *buffer
,
373 u64 x
= __raw_readq(addr
);
379 #endif /* CONFIG_64BIT */
382 #define writesb writesb
383 static inline void writesb(volatile void __iomem
*addr
, const void *buffer
,
387 const u8
*buf
= buffer
;
390 __raw_writeb(*buf
++, addr
);
397 #define writesw writesw
398 static inline void writesw(volatile void __iomem
*addr
, const void *buffer
,
402 const u16
*buf
= buffer
;
405 __raw_writew(*buf
++, addr
);
412 #define writesl writesl
413 static inline void writesl(volatile void __iomem
*addr
, const void *buffer
,
417 const u32
*buf
= buffer
;
420 __raw_writel(*buf
++, addr
);
428 #define writesq writesq
429 static inline void writesq(volatile void __iomem
*addr
, const void *buffer
,
433 const u64
*buf
= buffer
;
436 __raw_writeq(*buf
++, addr
);
441 #endif /* CONFIG_64BIT */
444 #define PCI_IOBASE ((void __iomem *)0)
447 #ifndef IO_SPACE_LIMIT
448 #define IO_SPACE_LIMIT 0xffff
452 * {in,out}{b,w,l}() access little endian I/O. {in,out}{b,w,l}_p() can be
453 * implemented on hardware that needs an additional delay for I/O accesses to
457 #if !defined(inb) && !defined(_inb)
459 static inline u8
_inb(unsigned long addr
)
464 val
= __raw_readb(PCI_IOBASE
+ addr
);
470 #if !defined(inw) && !defined(_inw)
472 static inline u16
_inw(unsigned long addr
)
477 val
= __le16_to_cpu((__le16 __force
)__raw_readw(PCI_IOBASE
+ addr
));
483 #if !defined(inl) && !defined(_inl)
485 static inline u32
_inl(unsigned long addr
)
490 val
= __le32_to_cpu((__le32 __force
)__raw_readl(PCI_IOBASE
+ addr
));
496 #if !defined(outb) && !defined(_outb)
498 static inline void _outb(u8 value
, unsigned long addr
)
501 __raw_writeb(value
, PCI_IOBASE
+ addr
);
506 #if !defined(outw) && !defined(_outw)
508 static inline void _outw(u16 value
, unsigned long addr
)
511 __raw_writew((u16 __force
)cpu_to_le16(value
), PCI_IOBASE
+ addr
);
516 #if !defined(outl) && !defined(_outl)
518 static inline void _outl(u32 value
, unsigned long addr
)
521 __raw_writel((u32 __force
)cpu_to_le32(value
), PCI_IOBASE
+ addr
);
526 #include <linux/logic_pio.h>
554 static inline u8
inb_p(unsigned long addr
)
562 static inline u16
inw_p(unsigned long addr
)
570 static inline u32
inl_p(unsigned long addr
)
577 #define outb_p outb_p
578 static inline void outb_p(u8 value
, unsigned long addr
)
585 #define outw_p outw_p
586 static inline void outw_p(u16 value
, unsigned long addr
)
593 #define outl_p outl_p
594 static inline void outl_p(u32 value
, unsigned long addr
)
601 * {in,out}s{b,w,l}{,_p}() are variants of the above that repeatedly access a
602 * single I/O port multiple times.
607 static inline void insb(unsigned long addr
, void *buffer
, unsigned int count
)
609 readsb(PCI_IOBASE
+ addr
, buffer
, count
);
615 static inline void insw(unsigned long addr
, void *buffer
, unsigned int count
)
617 readsw(PCI_IOBASE
+ addr
, buffer
, count
);
623 static inline void insl(unsigned long addr
, void *buffer
, unsigned int count
)
625 readsl(PCI_IOBASE
+ addr
, buffer
, count
);
631 static inline void outsb(unsigned long addr
, const void *buffer
,
634 writesb(PCI_IOBASE
+ addr
, buffer
, count
);
640 static inline void outsw(unsigned long addr
, const void *buffer
,
643 writesw(PCI_IOBASE
+ addr
, buffer
, count
);
649 static inline void outsl(unsigned long addr
, const void *buffer
,
652 writesl(PCI_IOBASE
+ addr
, buffer
, count
);
657 #define insb_p insb_p
658 static inline void insb_p(unsigned long addr
, void *buffer
, unsigned int count
)
660 insb(addr
, buffer
, count
);
665 #define insw_p insw_p
666 static inline void insw_p(unsigned long addr
, void *buffer
, unsigned int count
)
668 insw(addr
, buffer
, count
);
673 #define insl_p insl_p
674 static inline void insl_p(unsigned long addr
, void *buffer
, unsigned int count
)
676 insl(addr
, buffer
, count
);
681 #define outsb_p outsb_p
682 static inline void outsb_p(unsigned long addr
, const void *buffer
,
685 outsb(addr
, buffer
, count
);
690 #define outsw_p outsw_p
691 static inline void outsw_p(unsigned long addr
, const void *buffer
,
694 outsw(addr
, buffer
, count
);
699 #define outsl_p outsl_p
700 static inline void outsl_p(unsigned long addr
, const void *buffer
,
703 outsl(addr
, buffer
, count
);
707 #ifndef CONFIG_GENERIC_IOMAP
709 #define ioread8 ioread8
710 static inline u8
ioread8(const volatile void __iomem
*addr
)
717 #define ioread16 ioread16
718 static inline u16
ioread16(const volatile void __iomem
*addr
)
725 #define ioread32 ioread32
726 static inline u32
ioread32(const volatile void __iomem
*addr
)
734 #define ioread64 ioread64
735 static inline u64
ioread64(const volatile void __iomem
*addr
)
740 #endif /* CONFIG_64BIT */
743 #define iowrite8 iowrite8
744 static inline void iowrite8(u8 value
, volatile void __iomem
*addr
)
751 #define iowrite16 iowrite16
752 static inline void iowrite16(u16 value
, volatile void __iomem
*addr
)
759 #define iowrite32 iowrite32
760 static inline void iowrite32(u32 value
, volatile void __iomem
*addr
)
768 #define iowrite64 iowrite64
769 static inline void iowrite64(u64 value
, volatile void __iomem
*addr
)
774 #endif /* CONFIG_64BIT */
777 #define ioread16be ioread16be
778 static inline u16
ioread16be(const volatile void __iomem
*addr
)
780 return swab16(readw(addr
));
785 #define ioread32be ioread32be
786 static inline u32
ioread32be(const volatile void __iomem
*addr
)
788 return swab32(readl(addr
));
794 #define ioread64be ioread64be
795 static inline u64
ioread64be(const volatile void __iomem
*addr
)
797 return swab64(readq(addr
));
800 #endif /* CONFIG_64BIT */
803 #define iowrite16be iowrite16be
804 static inline void iowrite16be(u16 value
, void volatile __iomem
*addr
)
806 writew(swab16(value
), addr
);
811 #define iowrite32be iowrite32be
812 static inline void iowrite32be(u32 value
, volatile void __iomem
*addr
)
814 writel(swab32(value
), addr
);
820 #define iowrite64be iowrite64be
821 static inline void iowrite64be(u64 value
, volatile void __iomem
*addr
)
823 writeq(swab64(value
), addr
);
826 #endif /* CONFIG_64BIT */
829 #define ioread8_rep ioread8_rep
830 static inline void ioread8_rep(const volatile void __iomem
*addr
, void *buffer
,
833 readsb(addr
, buffer
, count
);
838 #define ioread16_rep ioread16_rep
839 static inline void ioread16_rep(const volatile void __iomem
*addr
,
840 void *buffer
, unsigned int count
)
842 readsw(addr
, buffer
, count
);
847 #define ioread32_rep ioread32_rep
848 static inline void ioread32_rep(const volatile void __iomem
*addr
,
849 void *buffer
, unsigned int count
)
851 readsl(addr
, buffer
, count
);
857 #define ioread64_rep ioread64_rep
858 static inline void ioread64_rep(const volatile void __iomem
*addr
,
859 void *buffer
, unsigned int count
)
861 readsq(addr
, buffer
, count
);
864 #endif /* CONFIG_64BIT */
867 #define iowrite8_rep iowrite8_rep
868 static inline void iowrite8_rep(volatile void __iomem
*addr
,
872 writesb(addr
, buffer
, count
);
876 #ifndef iowrite16_rep
877 #define iowrite16_rep iowrite16_rep
878 static inline void iowrite16_rep(volatile void __iomem
*addr
,
882 writesw(addr
, buffer
, count
);
886 #ifndef iowrite32_rep
887 #define iowrite32_rep iowrite32_rep
888 static inline void iowrite32_rep(volatile void __iomem
*addr
,
892 writesl(addr
, buffer
, count
);
897 #ifndef iowrite64_rep
898 #define iowrite64_rep iowrite64_rep
899 static inline void iowrite64_rep(volatile void __iomem
*addr
,
903 writesq(addr
, buffer
, count
);
906 #endif /* CONFIG_64BIT */
907 #endif /* CONFIG_GENERIC_IOMAP */
911 #include <linux/vmalloc.h>
912 #define __io_virt(x) ((void __force *)(x))
915 * Change virtual addresses to physical addresses and vv.
916 * These are pretty trivial
919 #define virt_to_phys virt_to_phys
920 static inline unsigned long virt_to_phys(volatile void *address
)
922 return __pa((unsigned long)address
);
927 #define phys_to_virt phys_to_virt
928 static inline void *phys_to_virt(unsigned long address
)
930 return __va(address
);
935 * DOC: ioremap() and ioremap_*() variants
937 * Architectures with an MMU are expected to provide ioremap() and iounmap()
938 * themselves or rely on GENERIC_IOREMAP. For NOMMU architectures we provide
939 * a default nop-op implementation that expect that the physical address used
940 * for MMIO are already marked as uncached, and can be used as kernel virtual
943 * ioremap_wc() and ioremap_wt() can provide more relaxed caching attributes
944 * for specific drivers if the architecture choses to implement them. If they
945 * are not implemented we fall back to plain ioremap.
949 #define ioremap ioremap
950 static inline void __iomem
*ioremap(phys_addr_t offset
, size_t size
)
952 return (void __iomem
*)(unsigned long)offset
;
957 #define iounmap iounmap
958 static inline void iounmap(void __iomem
*addr
)
962 #elif defined(CONFIG_GENERIC_IOREMAP)
963 #include <linux/pgtable.h>
965 void __iomem
*ioremap_prot(phys_addr_t addr
, size_t size
, unsigned long prot
);
966 void iounmap(volatile void __iomem
*addr
);
968 static inline void __iomem
*ioremap(phys_addr_t addr
, size_t size
)
970 /* _PAGE_IOREMAP needs to be supplied by the architecture */
971 return ioremap_prot(addr
, size
, _PAGE_IOREMAP
);
973 #endif /* !CONFIG_MMU || CONFIG_GENERIC_IOREMAP */
976 #define ioremap_wc ioremap
980 #define ioremap_wt ioremap
984 * ioremap_uc is special in that we do require an explicit architecture
985 * implementation. In general you do not want to use this function in a
986 * driver and use plain ioremap, which is uncached by default. Similarly
987 * architectures should not implement it unless they have a very good
991 #define ioremap_uc ioremap_uc
992 static inline void __iomem
*ioremap_uc(phys_addr_t offset
, size_t size
)
998 #ifdef CONFIG_HAS_IOPORT_MAP
999 #ifndef CONFIG_GENERIC_IOMAP
1001 #define ioport_map ioport_map
1002 static inline void __iomem
*ioport_map(unsigned long port
, unsigned int nr
)
1004 port
&= IO_SPACE_LIMIT
;
1005 return (port
> MMIO_UPPER_LIMIT
) ? NULL
: PCI_IOBASE
+ port
;
1007 #define __pci_ioport_unmap __pci_ioport_unmap
1008 static inline void __pci_ioport_unmap(void __iomem
*p
)
1010 uintptr_t start
= (uintptr_t) PCI_IOBASE
;
1011 uintptr_t addr
= (uintptr_t) p
;
1013 if (addr
>= start
&& addr
< start
+ IO_SPACE_LIMIT
)
1019 #ifndef ioport_unmap
1020 #define ioport_unmap ioport_unmap
1021 static inline void ioport_unmap(void __iomem
*p
)
1025 #else /* CONFIG_GENERIC_IOMAP */
1026 extern void __iomem
*ioport_map(unsigned long port
, unsigned int nr
);
1027 extern void ioport_unmap(void __iomem
*p
);
1028 #endif /* CONFIG_GENERIC_IOMAP */
1029 #endif /* CONFIG_HAS_IOPORT_MAP */
1031 #ifndef CONFIG_GENERIC_IOMAP
1033 extern void __iomem
*pci_iomap(struct pci_dev
*dev
, int bar
, unsigned long max
);
1035 #ifndef __pci_ioport_unmap
1036 static inline void __pci_ioport_unmap(void __iomem
*p
) {}
1040 #define pci_iounmap pci_iounmap
1041 static inline void pci_iounmap(struct pci_dev
*dev
, void __iomem
*p
)
1043 __pci_ioport_unmap(p
);
1046 #endif /* CONFIG_GENERIC_IOMAP */
1049 * Convert a virtual cached pointer to an uncached pointer
1051 #ifndef xlate_dev_kmem_ptr
1052 #define xlate_dev_kmem_ptr xlate_dev_kmem_ptr
1053 static inline void *xlate_dev_kmem_ptr(void *addr
)
1059 #ifndef xlate_dev_mem_ptr
1060 #define xlate_dev_mem_ptr xlate_dev_mem_ptr
1061 static inline void *xlate_dev_mem_ptr(phys_addr_t addr
)
1067 #ifndef unxlate_dev_mem_ptr
1068 #define unxlate_dev_mem_ptr unxlate_dev_mem_ptr
1069 static inline void unxlate_dev_mem_ptr(phys_addr_t phys
, void *addr
)
1074 #ifdef CONFIG_VIRT_TO_BUS
1076 static inline unsigned long virt_to_bus(void *address
)
1078 return (unsigned long)address
;
1081 static inline void *bus_to_virt(unsigned long address
)
1083 return (void *)address
;
1089 #define memset_io memset_io
1091 * memset_io Set a range of I/O memory to a constant value
1092 * @addr: The beginning of the I/O-memory range to set
1093 * @val: The value to set the memory to
1094 * @count: The number of bytes to set
1096 * Set a range of I/O memory to a given value.
1098 static inline void memset_io(volatile void __iomem
*addr
, int value
,
1101 memset(__io_virt(addr
), value
, size
);
1105 #ifndef memcpy_fromio
1106 #define memcpy_fromio memcpy_fromio
1108 * memcpy_fromio Copy a block of data from I/O memory
1109 * @dst: The (RAM) destination for the copy
1110 * @src: The (I/O memory) source for the data
1111 * @count: The number of bytes to copy
1113 * Copy a block of data from I/O memory.
1115 static inline void memcpy_fromio(void *buffer
,
1116 const volatile void __iomem
*addr
,
1119 memcpy(buffer
, __io_virt(addr
), size
);
1124 #define memcpy_toio memcpy_toio
1126 * memcpy_toio Copy a block of data into I/O memory
1127 * @dst: The (I/O memory) destination for the copy
1128 * @src: The (RAM) source for the data
1129 * @count: The number of bytes to copy
1131 * Copy a block of data to I/O memory.
1133 static inline void memcpy_toio(volatile void __iomem
*addr
, const void *buffer
,
1136 memcpy(__io_virt(addr
), buffer
, size
);
1140 #ifndef CONFIG_GENERIC_DEVMEM_IS_ALLOWED
1141 extern int devmem_is_allowed(unsigned long pfn
);
1144 #endif /* __KERNEL__ */
1146 #endif /* __ASM_GENERIC_IO_H */