1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright 2006 PathScale, Inc. All Rights Reserved.
4 */
5
6 #ifndef _LINUX_IO_H
7 #define _LINUX_IO_H
8
9 #include <linux/types.h>
10 #include <linux/init.h>
11 #include <linux/bug.h>
12 #include <linux/err.h>
13 #include <asm/io.h>
14 #include <asm/page.h>
15
16 struct device;
17 struct resource;
18
19 __visible void __iowrite32_copy(void __iomem *to, const void *from, size_t count);
20 void __ioread32_copy(void *to, const void __iomem *from, size_t count);
21 void __iowrite64_copy(void __iomem *to, const void *from, size_t count);
22
23 #ifdef CONFIG_MMU
24 void ioremap_phys_range_hook(phys_addr_t phys_addr, size_t size, pgprot_t prot);
25 void iounmap_phys_range_hook(phys_addr_t phys_addr, size_t size);
26 int ioremap_page_range(unsigned long addr, unsigned long end,
27 phys_addr_t phys_addr, pgprot_t prot);
28 #else
ioremap_page_range(unsigned long addr,unsigned long end,phys_addr_t phys_addr,pgprot_t prot)29 static inline int ioremap_page_range(unsigned long addr, unsigned long end,
30 phys_addr_t phys_addr, pgprot_t prot)
31 {
32 return 0;
33 }
34 #endif
35
36 /*
37 * Managed iomap interface
38 */
39 #ifdef CONFIG_HAS_IOPORT_MAP
40 void __iomem * devm_ioport_map(struct device *dev, unsigned long port,
41 unsigned int nr);
42 void devm_ioport_unmap(struct device *dev, void __iomem *addr);
43 #else
devm_ioport_map(struct device * dev,unsigned long port,unsigned int nr)44 static inline void __iomem *devm_ioport_map(struct device *dev,
45 unsigned long port,
46 unsigned int nr)
47 {
48 return NULL;
49 }
50
devm_ioport_unmap(struct device * dev,void __iomem * addr)51 static inline void devm_ioport_unmap(struct device *dev, void __iomem *addr)
52 {
53 }
54 #endif
55
56 #define IOMEM_ERR_PTR(err) (__force void __iomem *)ERR_PTR(err)
57
58 void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
59 resource_size_t size);
60 void __iomem *devm_ioremap_uc(struct device *dev, resource_size_t offset,
61 resource_size_t size);
62 void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
63 resource_size_t size);
64 void devm_iounmap(struct device *dev, void __iomem *addr);
65 int check_signature(const volatile void __iomem *io_addr,
66 const unsigned char *signature, int length);
67 void devm_ioremap_release(struct device *dev, void *res);
68
69 void *devm_memremap(struct device *dev, resource_size_t offset,
70 size_t size, unsigned long flags);
71 void devm_memunmap(struct device *dev, void *addr);
72
73 /* architectures can override this */
74 pgprot_t __init early_memremap_pgprot_adjust(resource_size_t phys_addr,
75 unsigned long size, pgprot_t prot);
76
77
78 #ifdef CONFIG_PCI
79 /*
80 * The PCI specifications (Rev 3.0, 3.2.5 "Transaction Ordering and
81 * Posting") mandate non-posted configuration transactions. This default
82 * implementation attempts to use the ioremap_np() API to provide this
83 * on arches that support it, and falls back to ioremap() on those that
84 * don't. Overriding this function is deprecated; arches that properly
85 * support non-posted accesses should implement ioremap_np() instead, which
86 * this default implementation can then use to return mappings compliant with
87 * the PCI specification.
88 */
89 #ifndef pci_remap_cfgspace
90 #define pci_remap_cfgspace pci_remap_cfgspace
pci_remap_cfgspace(phys_addr_t offset,size_t size)91 static inline void __iomem *pci_remap_cfgspace(phys_addr_t offset,
92 size_t size)
93 {
94 return ioremap_np(offset, size) ?: ioremap(offset, size);
95 }
96 #endif
97 #endif
98
99 /*
100 * Some systems do not have legacy ISA devices.
101 * /dev/port is not a valid interface on these systems.
102 * So for those archs, <asm/io.h> should define the following symbol.
103 */
104 #ifndef arch_has_dev_port
105 #define arch_has_dev_port() (1)
106 #endif
107
108 /*
109 * Some systems (x86 without PAT) have a somewhat reliable way to mark a
110 * physical address range such that uncached mappings will actually
111 * end up write-combining. This facility should be used in conjunction
112 * with pgprot_writecombine, ioremap-wc, or set_memory_wc, since it has
113 * no effect if the per-page mechanisms are functional.
114 * (On x86 without PAT, these functions manipulate MTRRs.)
115 *
116 * arch_phys_del_wc(0) or arch_phys_del_wc(any error code) is guaranteed
117 * to have no effect.
118 */
119 #ifndef arch_phys_wc_add
arch_phys_wc_add(unsigned long base,unsigned long size)120 static inline int __must_check arch_phys_wc_add(unsigned long base,
121 unsigned long size)
122 {
123 return 0; /* It worked (i.e. did nothing). */
124 }
125
arch_phys_wc_del(int handle)126 static inline void arch_phys_wc_del(int handle)
127 {
128 }
129
130 #define arch_phys_wc_add arch_phys_wc_add
131 #ifndef arch_phys_wc_index
arch_phys_wc_index(int handle)132 static inline int arch_phys_wc_index(int handle)
133 {
134 return -1;
135 }
136 #define arch_phys_wc_index arch_phys_wc_index
137 #endif
138 #endif
139
140 int devm_arch_phys_wc_add(struct device *dev, unsigned long base, unsigned long size);
141
142 enum {
143 /* See memremap() kernel-doc for usage description... */
144 MEMREMAP_WB = 1 << 0,
145 MEMREMAP_WT = 1 << 1,
146 MEMREMAP_WC = 1 << 2,
147 MEMREMAP_ENC = 1 << 3,
148 MEMREMAP_DEC = 1 << 4,
149 };
150
151 void *memremap(resource_size_t offset, size_t size, unsigned long flags);
152 void memunmap(void *addr);
153
154 /*
155 * On x86 PAT systems we have memory tracking that keeps track of
156 * the allowed mappings on memory ranges. This tracking works for
157 * all the in-kernel mapping APIs (ioremap*), but where the user
158 * wishes to map a range from a physical device into user memory
159 * the tracking won't be updated. This API is to be used by
160 * drivers which remap physical device pages into userspace,
161 * and wants to make sure they are mapped WC and not UC.
162 */
163 #ifndef arch_io_reserve_memtype_wc
arch_io_reserve_memtype_wc(resource_size_t base,resource_size_t size)164 static inline int arch_io_reserve_memtype_wc(resource_size_t base,
165 resource_size_t size)
166 {
167 return 0;
168 }
169
arch_io_free_memtype_wc(resource_size_t base,resource_size_t size)170 static inline void arch_io_free_memtype_wc(resource_size_t base,
171 resource_size_t size)
172 {
173 }
174 #endif
175
176 int devm_arch_io_reserve_memtype_wc(struct device *dev, resource_size_t start,
177 resource_size_t size);
178
179 #endif /* _LINUX_IO_H */
180