GNU Linux-libre 4.19.211-gnu1
[releases.git] / include / asm-generic / iomap.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __GENERIC_IO_H
3 #define __GENERIC_IO_H
4
5 #include <linux/linkage.h>
6 #include <asm/byteorder.h>
7
8 /*
9  * These are the "generic" interfaces for doing new-style
10  * memory-mapped or PIO accesses. Architectures may do
11  * their own arch-optimized versions, these just act as
12  * wrappers around the old-style IO register access functions:
13  * read[bwl]/write[bwl]/in[bwl]/out[bwl]
14  *
15  * Don't include this directly, include it from <asm/io.h>.
16  */
17
18 /*
19  * Read/write from/to an (offsettable) iomem cookie. It might be a PIO
20  * access or a MMIO access, these functions don't care. The info is
21  * encoded in the hardware mapping set up by the mapping functions
22  * (or the cookie itself, depending on implementation and hw).
23  *
24  * The generic routines just encode the PIO/MMIO as part of the
25  * cookie, and coldly assume that the MMIO IO mappings are not
26  * in the low address range. Architectures for which this is not
27  * true can't use this generic implementation.
28  */
29 extern unsigned int ioread8(void __iomem *);
30 extern unsigned int ioread16(void __iomem *);
31 extern unsigned int ioread16be(void __iomem *);
32 extern unsigned int ioread32(void __iomem *);
33 extern unsigned int ioread32be(void __iomem *);
34 #ifdef CONFIG_64BIT
35 extern u64 ioread64(void __iomem *);
36 extern u64 ioread64be(void __iomem *);
37 #endif
38
39 extern void iowrite8(u8, void __iomem *);
40 extern void iowrite16(u16, void __iomem *);
41 extern void iowrite16be(u16, void __iomem *);
42 extern void iowrite32(u32, void __iomem *);
43 extern void iowrite32be(u32, void __iomem *);
44 #ifdef CONFIG_64BIT
45 extern void iowrite64(u64, void __iomem *);
46 extern void iowrite64be(u64, void __iomem *);
47 #endif
48
49 /*
50  * "string" versions of the above. Note that they
51  * use native byte ordering for the accesses (on
52  * the assumption that IO and memory agree on a
53  * byte order, and CPU byteorder is irrelevant).
54  *
55  * They do _not_ update the port address. If you
56  * want MMIO that copies stuff laid out in MMIO
57  * memory across multiple ports, use "memcpy_toio()"
58  * and friends.
59  */
60 extern void ioread8_rep(void __iomem *port, void *buf, unsigned long count);
61 extern void ioread16_rep(void __iomem *port, void *buf, unsigned long count);
62 extern void ioread32_rep(void __iomem *port, void *buf, unsigned long count);
63
64 extern void iowrite8_rep(void __iomem *port, const void *buf, unsigned long count);
65 extern void iowrite16_rep(void __iomem *port, const void *buf, unsigned long count);
66 extern void iowrite32_rep(void __iomem *port, const void *buf, unsigned long count);
67
68 #ifdef CONFIG_HAS_IOPORT_MAP
69 /* Create a virtual mapping cookie for an IO port range */
70 extern void __iomem *ioport_map(unsigned long port, unsigned int nr);
71 extern void ioport_unmap(void __iomem *);
72 #endif
73
74 #ifndef ARCH_HAS_IOREMAP_WC
75 #define ioremap_wc ioremap_nocache
76 #endif
77
78 #ifndef ARCH_HAS_IOREMAP_WT
79 #define ioremap_wt ioremap_nocache
80 #endif
81
82 #ifdef CONFIG_PCI
83 /* Destroy a virtual mapping cookie for a PCI BAR (memory or IO) */
84 struct pci_dev;
85 extern void pci_iounmap(struct pci_dev *dev, void __iomem *);
86 #elif defined(CONFIG_GENERIC_IOMAP)
87 struct pci_dev;
88 static inline void pci_iounmap(struct pci_dev *dev, void __iomem *addr)
89 { }
90 #endif
91
92 #include <asm-generic/pci_iomap.h>
93
94 #endif