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