1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * ioport.h Definitions of routines for detecting, reserving and
4 * allocating system resources.
5 *
6 * Authors: Linus Torvalds
7 */
8
9 #ifndef _LINUX_IOPORT_H
10 #define _LINUX_IOPORT_H
11
12 #ifndef __ASSEMBLY__
13 #include <linux/compiler.h>
14 #include <linux/types.h>
15 #include <linux/bits.h>
16 /*
17 * Resources are tree-like, allowing
18 * nesting etc..
19 */
20 struct resource {
21 resource_size_t start;
22 resource_size_t end;
23 const char *name;
24 unsigned long flags;
25 unsigned long desc;
26 struct resource *parent, *sibling, *child;
27 };
28
29 /*
30 * IO resources have these defined flags.
31 *
32 * PCI devices expose these flags to userspace in the "resource" sysfs file,
33 * so don't move them.
34 */
35 #define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
36
37 #define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
38 #define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
39 #define IORESOURCE_MEM 0x00000200
40 #define IORESOURCE_REG 0x00000300 /* Register offsets */
41 #define IORESOURCE_IRQ 0x00000400
42 #define IORESOURCE_DMA 0x00000800
43 #define IORESOURCE_BUS 0x00001000
44
45 #define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
46 #define IORESOURCE_READONLY 0x00004000
47 #define IORESOURCE_CACHEABLE 0x00008000
48 #define IORESOURCE_RANGELENGTH 0x00010000
49 #define IORESOURCE_SHADOWABLE 0x00020000
50
51 #define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
52 #define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
53
54 #define IORESOURCE_MEM_64 0x00100000
55 #define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
56 #define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
57
58 #define IORESOURCE_EXT_TYPE_BITS 0x01000000 /* Resource extended types */
59 #define IORESOURCE_SYSRAM 0x01000000 /* System RAM (modifier) */
60
61 /* IORESOURCE_SYSRAM specific bits. */
62 #define IORESOURCE_SYSRAM_DRIVER_MANAGED 0x02000000 /* Always detected via a driver. */
63 #define IORESOURCE_SYSRAM_MERGEABLE 0x04000000 /* Resource can be merged. */
64
65 #define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
66
67 #define IORESOURCE_DISABLED 0x10000000
68 #define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
69 #define IORESOURCE_AUTO 0x40000000
70 #define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
71
72 /* I/O resource extended types */
73 #define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM|IORESOURCE_SYSRAM)
74
75 /* PnP IRQ specific bits (IORESOURCE_BITS) */
76 #define IORESOURCE_IRQ_HIGHEDGE (1<<0)
77 #define IORESOURCE_IRQ_LOWEDGE (1<<1)
78 #define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
79 #define IORESOURCE_IRQ_LOWLEVEL (1<<3)
80 #define IORESOURCE_IRQ_SHAREABLE (1<<4)
81 #define IORESOURCE_IRQ_OPTIONAL (1<<5)
82
83 /* PnP DMA specific bits (IORESOURCE_BITS) */
84 #define IORESOURCE_DMA_TYPE_MASK (3<<0)
85 #define IORESOURCE_DMA_8BIT (0<<0)
86 #define IORESOURCE_DMA_8AND16BIT (1<<0)
87 #define IORESOURCE_DMA_16BIT (2<<0)
88
89 #define IORESOURCE_DMA_MASTER (1<<2)
90 #define IORESOURCE_DMA_BYTE (1<<3)
91 #define IORESOURCE_DMA_WORD (1<<4)
92
93 #define IORESOURCE_DMA_SPEED_MASK (3<<6)
94 #define IORESOURCE_DMA_COMPATIBLE (0<<6)
95 #define IORESOURCE_DMA_TYPEA (1<<6)
96 #define IORESOURCE_DMA_TYPEB (2<<6)
97 #define IORESOURCE_DMA_TYPEF (3<<6)
98
99 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
100 #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
101 #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
102 #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
103 #define IORESOURCE_MEM_TYPE_MASK (3<<3)
104 #define IORESOURCE_MEM_8BIT (0<<3)
105 #define IORESOURCE_MEM_16BIT (1<<3)
106 #define IORESOURCE_MEM_8AND16BIT (2<<3)
107 #define IORESOURCE_MEM_32BIT (3<<3)
108 #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
109 #define IORESOURCE_MEM_EXPANSIONROM (1<<6)
110
111 /* PnP I/O specific bits (IORESOURCE_BITS) */
112 #define IORESOURCE_IO_16BIT_ADDR (1<<0)
113 #define IORESOURCE_IO_FIXED (1<<1)
114 #define IORESOURCE_IO_SPARSE (1<<2)
115
116 /* PCI ROM control bits (IORESOURCE_BITS) */
117 #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
118 #define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
119
120 /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
121 #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
122 #define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
123
124 /*
125 * I/O Resource Descriptors
126 *
127 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
128 * for searching a specific resource range in the iomem table. Assign
129 * a new descriptor when a resource range supports the search interfaces.
130 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
131 */
132 enum {
133 IORES_DESC_NONE = 0,
134 IORES_DESC_CRASH_KERNEL = 1,
135 IORES_DESC_ACPI_TABLES = 2,
136 IORES_DESC_ACPI_NV_STORAGE = 3,
137 IORES_DESC_PERSISTENT_MEMORY = 4,
138 IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
139 IORES_DESC_DEVICE_PRIVATE_MEMORY = 6,
140 IORES_DESC_RESERVED = 7,
141 IORES_DESC_SOFT_RESERVED = 8,
142 };
143
144 /*
145 * Flags controlling ioremap() behavior.
146 */
147 enum {
148 IORES_MAP_SYSTEM_RAM = BIT(0),
149 IORES_MAP_ENCRYPTED = BIT(1),
150 };
151
152 /* helpers to define resources */
153 #define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
154 { \
155 .start = (_start), \
156 .end = (_start) + (_size) - 1, \
157 .name = (_name), \
158 .flags = (_flags), \
159 .desc = IORES_DESC_NONE, \
160 }
161
162 #define DEFINE_RES_IO_NAMED(_start, _size, _name) \
163 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
164 #define DEFINE_RES_IO(_start, _size) \
165 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
166
167 #define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
168 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
169 #define DEFINE_RES_MEM(_start, _size) \
170 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
171
172 #define DEFINE_RES_IRQ_NAMED(_irq, _name) \
173 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
174 #define DEFINE_RES_IRQ(_irq) \
175 DEFINE_RES_IRQ_NAMED((_irq), NULL)
176
177 #define DEFINE_RES_DMA_NAMED(_dma, _name) \
178 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
179 #define DEFINE_RES_DMA(_dma) \
180 DEFINE_RES_DMA_NAMED((_dma), NULL)
181
182 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
183 extern struct resource ioport_resource;
184 extern struct resource iomem_resource;
185
186 extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
187 extern int request_resource(struct resource *root, struct resource *new);
188 extern int release_resource(struct resource *new);
189 void release_child_resources(struct resource *new);
190 extern void reserve_region_with_split(struct resource *root,
191 resource_size_t start, resource_size_t end,
192 const char *name);
193 extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
194 extern int insert_resource(struct resource *parent, struct resource *new);
195 extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
196 extern int remove_resource(struct resource *old);
197 extern void arch_remove_reservations(struct resource *avail);
198 extern int allocate_resource(struct resource *root, struct resource *new,
199 resource_size_t size, resource_size_t min,
200 resource_size_t max, resource_size_t align,
201 resource_size_t (*alignf)(void *,
202 const struct resource *,
203 resource_size_t,
204 resource_size_t),
205 void *alignf_data);
206 struct resource *lookup_resource(struct resource *root, resource_size_t start);
207 int adjust_resource(struct resource *res, resource_size_t start,
208 resource_size_t size);
209 resource_size_t resource_alignment(struct resource *res);
resource_size(const struct resource * res)210 static inline resource_size_t resource_size(const struct resource *res)
211 {
212 return res->end - res->start + 1;
213 }
resource_type(const struct resource * res)214 static inline unsigned long resource_type(const struct resource *res)
215 {
216 return res->flags & IORESOURCE_TYPE_BITS;
217 }
resource_ext_type(const struct resource * res)218 static inline unsigned long resource_ext_type(const struct resource *res)
219 {
220 return res->flags & IORESOURCE_EXT_TYPE_BITS;
221 }
222 /* True iff r1 completely contains r2 */
resource_contains(struct resource * r1,struct resource * r2)223 static inline bool resource_contains(struct resource *r1, struct resource *r2)
224 {
225 if (resource_type(r1) != resource_type(r2))
226 return false;
227 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
228 return false;
229 return r1->start <= r2->start && r1->end >= r2->end;
230 }
231
232
233 /* Convenience shorthand with allocation */
234 #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
235 #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
236 #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
237 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
238 #define request_mem_region_exclusive(start,n,name) \
239 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
240 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
241
242 extern struct resource * __request_region(struct resource *,
243 resource_size_t start,
244 resource_size_t n,
245 const char *name, int flags);
246
247 /* Compatibility cruft */
248 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
249 #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
250
251 extern void __release_region(struct resource *, resource_size_t,
252 resource_size_t);
253 #ifdef CONFIG_MEMORY_HOTREMOVE
254 extern void release_mem_region_adjustable(resource_size_t, resource_size_t);
255 #endif
256 #ifdef CONFIG_MEMORY_HOTPLUG
257 extern void merge_system_ram_resource(struct resource *res);
258 #endif
259
260 /* Wrappers for managed devices */
261 struct device;
262
263 extern int devm_request_resource(struct device *dev, struct resource *root,
264 struct resource *new);
265 extern void devm_release_resource(struct device *dev, struct resource *new);
266
267 #define devm_request_region(dev,start,n,name) \
268 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
269 #define devm_request_mem_region(dev,start,n,name) \
270 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
271
272 extern struct resource * __devm_request_region(struct device *dev,
273 struct resource *parent, resource_size_t start,
274 resource_size_t n, const char *name);
275
276 #define devm_release_region(dev, start, n) \
277 __devm_release_region(dev, &ioport_resource, (start), (n))
278 #define devm_release_mem_region(dev, start, n) \
279 __devm_release_region(dev, &iomem_resource, (start), (n))
280
281 extern void __devm_release_region(struct device *dev, struct resource *parent,
282 resource_size_t start, resource_size_t n);
283 extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
284 extern bool iomem_is_exclusive(u64 addr);
285
286 extern int
287 walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
288 void *arg, int (*func)(unsigned long, unsigned long, void *));
289 extern int
290 walk_mem_res(u64 start, u64 end, void *arg,
291 int (*func)(struct resource *, void *));
292 extern int
293 walk_system_ram_res(u64 start, u64 end, void *arg,
294 int (*func)(struct resource *, void *));
295 extern int
296 walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
297 void *arg, int (*func)(struct resource *, void *));
298
299 /* True if any part of r1 overlaps r2 */
resource_overlaps(struct resource * r1,struct resource * r2)300 static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
301 {
302 return (r1->start <= r2->end && r1->end >= r2->start);
303 }
304
305 struct resource *devm_request_free_mem_region(struct device *dev,
306 struct resource *base, unsigned long size);
307 struct resource *request_free_mem_region(struct resource *base,
308 unsigned long size, const char *name);
309
310 #ifdef CONFIG_IO_STRICT_DEVMEM
311 void revoke_devmem(struct resource *res);
312 #else
revoke_devmem(struct resource * res)313 static inline void revoke_devmem(struct resource *res) { };
314 #endif
315
316 #endif /* __ASSEMBLY__ */
317 #endif /* _LINUX_IOPORT_H */
318