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/args.h>
14 #include <linux/bits.h>
15 #include <linux/compiler.h>
16 #include <linux/minmax.h>
17 #include <linux/types.h>
18 /*
19 * Resources are tree-like, allowing
20 * nesting etc..
21 */
22 struct resource {
23 resource_size_t start;
24 resource_size_t end;
25 const char *name;
26 unsigned long flags;
27 unsigned long desc;
28 struct resource *parent, *sibling, *child;
29 };
30
31 /*
32 * IO resources have these defined flags.
33 *
34 * PCI devices expose these flags to userspace in the "resource" sysfs file,
35 * so don't move them.
36 */
37 #define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
38
39 #define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
40 #define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
41 #define IORESOURCE_MEM 0x00000200
42 #define IORESOURCE_REG 0x00000300 /* Register offsets */
43 #define IORESOURCE_IRQ 0x00000400
44 #define IORESOURCE_DMA 0x00000800
45 #define IORESOURCE_BUS 0x00001000
46
47 #define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
48 #define IORESOURCE_READONLY 0x00004000
49 #define IORESOURCE_CACHEABLE 0x00008000
50 #define IORESOURCE_RANGELENGTH 0x00010000
51 #define IORESOURCE_SHADOWABLE 0x00020000
52
53 #define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
54 #define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
55
56 #define IORESOURCE_MEM_64 0x00100000
57 #define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
58 #define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
59
60 #define IORESOURCE_EXT_TYPE_BITS 0x01000000 /* Resource extended types */
61 #define IORESOURCE_SYSRAM 0x01000000 /* System RAM (modifier) */
62
63 /* IORESOURCE_SYSRAM specific bits. */
64 #define IORESOURCE_SYSRAM_DRIVER_MANAGED 0x02000000 /* Always detected via a driver. */
65 #define IORESOURCE_SYSRAM_MERGEABLE 0x04000000 /* Resource can be merged. */
66
67 #define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
68
69 #define IORESOURCE_DISABLED 0x10000000
70 #define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
71 #define IORESOURCE_AUTO 0x40000000
72 #define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
73
74 /* I/O resource extended types */
75 #define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM|IORESOURCE_SYSRAM)
76
77 /* PnP IRQ specific bits (IORESOURCE_BITS) */
78 #define IORESOURCE_IRQ_HIGHEDGE (1<<0)
79 #define IORESOURCE_IRQ_LOWEDGE (1<<1)
80 #define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
81 #define IORESOURCE_IRQ_LOWLEVEL (1<<3)
82 #define IORESOURCE_IRQ_SHAREABLE (1<<4)
83 #define IORESOURCE_IRQ_OPTIONAL (1<<5)
84 #define IORESOURCE_IRQ_WAKECAPABLE (1<<6)
85
86 /* PnP DMA specific bits (IORESOURCE_BITS) */
87 #define IORESOURCE_DMA_TYPE_MASK (3<<0)
88 #define IORESOURCE_DMA_8BIT (0<<0)
89 #define IORESOURCE_DMA_8AND16BIT (1<<0)
90 #define IORESOURCE_DMA_16BIT (2<<0)
91
92 #define IORESOURCE_DMA_MASTER (1<<2)
93 #define IORESOURCE_DMA_BYTE (1<<3)
94 #define IORESOURCE_DMA_WORD (1<<4)
95
96 #define IORESOURCE_DMA_SPEED_MASK (3<<6)
97 #define IORESOURCE_DMA_COMPATIBLE (0<<6)
98 #define IORESOURCE_DMA_TYPEA (1<<6)
99 #define IORESOURCE_DMA_TYPEB (2<<6)
100 #define IORESOURCE_DMA_TYPEF (3<<6)
101
102 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
103 #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
104 #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
105 #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
106 #define IORESOURCE_MEM_TYPE_MASK (3<<3)
107 #define IORESOURCE_MEM_8BIT (0<<3)
108 #define IORESOURCE_MEM_16BIT (1<<3)
109 #define IORESOURCE_MEM_8AND16BIT (2<<3)
110 #define IORESOURCE_MEM_32BIT (3<<3)
111 #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
112 #define IORESOURCE_MEM_EXPANSIONROM (1<<6)
113 #define IORESOURCE_MEM_NONPOSTED (1<<7)
114
115 /* PnP I/O specific bits (IORESOURCE_BITS) */
116 #define IORESOURCE_IO_16BIT_ADDR (1<<0)
117 #define IORESOURCE_IO_FIXED (1<<1)
118 #define IORESOURCE_IO_SPARSE (1<<2)
119
120 /* PCI ROM control bits (IORESOURCE_BITS) */
121 #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
122 #define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
123
124 /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
125 #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
126 #define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
127
128 /*
129 * I/O Resource Descriptors
130 *
131 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
132 * for searching a specific resource range in the iomem table. Assign
133 * a new descriptor when a resource range supports the search interfaces.
134 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
135 */
136 enum {
137 IORES_DESC_NONE = 0,
138 IORES_DESC_CRASH_KERNEL = 1,
139 IORES_DESC_ACPI_TABLES = 2,
140 IORES_DESC_ACPI_NV_STORAGE = 3,
141 IORES_DESC_PERSISTENT_MEMORY = 4,
142 IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
143 IORES_DESC_DEVICE_PRIVATE_MEMORY = 6,
144 IORES_DESC_RESERVED = 7,
145 IORES_DESC_SOFT_RESERVED = 8,
146 IORES_DESC_CXL = 9,
147 };
148
149 /*
150 * Flags controlling ioremap() behavior.
151 */
152 enum {
153 IORES_MAP_SYSTEM_RAM = BIT(0),
154 IORES_MAP_ENCRYPTED = BIT(1),
155 };
156
157 /* helpers to define resources */
158 #define DEFINE_RES_NAMED_DESC(_start, _size, _name, _flags, _desc) \
159 (struct resource) { \
160 .start = (_start), \
161 .end = (_start) + (_size) - 1, \
162 .name = (_name), \
163 .flags = (_flags), \
164 .desc = (_desc), \
165 }
166
167 #define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
168 DEFINE_RES_NAMED_DESC(_start, _size, _name, _flags, IORES_DESC_NONE)
169 #define __DEFINE_RES0() \
170 DEFINE_RES_NAMED(0, 0, NULL, IORESOURCE_UNSET)
171 #define __DEFINE_RES3(_start, _size, _flags) \
172 DEFINE_RES_NAMED(_start, _size, NULL, _flags)
173 #define DEFINE_RES(...) \
174 CONCATENATE(__DEFINE_RES, COUNT_ARGS(__VA_ARGS__))(__VA_ARGS__)
175
176 #define DEFINE_RES_IO_NAMED(_start, _size, _name) \
177 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
178 #define DEFINE_RES_IO(_start, _size) \
179 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
180
181 #define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
182 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
183 #define DEFINE_RES_MEM(_start, _size) \
184 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
185
186 #define DEFINE_RES_REG_NAMED(_start, _size, _name) \
187 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_REG)
188 #define DEFINE_RES_REG(_start, _size) \
189 DEFINE_RES_REG_NAMED((_start), (_size), NULL)
190
191 #define DEFINE_RES_IRQ_NAMED(_irq, _name) \
192 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
193 #define DEFINE_RES_IRQ(_irq) \
194 DEFINE_RES_IRQ_NAMED((_irq), NULL)
195
196 #define DEFINE_RES_DMA_NAMED(_dma, _name) \
197 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
198 #define DEFINE_RES_DMA(_dma) \
199 DEFINE_RES_DMA_NAMED((_dma), NULL)
200
201 /**
202 * typedef resource_alignf - Resource alignment callback
203 * @data: Private data used by the callback
204 * @res: Resource candidate range (an empty resource space)
205 * @size: The minimum size of the empty space
206 * @align: Alignment from the constraints
207 *
208 * Callback allows calculating resource placement and alignment beyond min,
209 * max, and align fields in the struct resource_constraint.
210 *
211 * Return: Start address for the resource.
212 */
213 typedef resource_size_t (*resource_alignf)(void *data,
214 const struct resource *res,
215 resource_size_t size,
216 resource_size_t align);
217
218 /**
219 * struct resource_constraint - constraints to be met while searching empty
220 * resource space
221 * @min: The minimum address for the memory range
222 * @max: The maximum address for the memory range
223 * @align: Alignment for the start address of the empty space
224 * @alignf: Additional alignment constraints callback
225 * @alignf_data: Data provided for @alignf callback
226 *
227 * Contains the range and alignment constraints that have to be met during
228 * find_resource_space(). @alignf can be NULL indicating no alignment beyond
229 * @align is necessary.
230 */
231 struct resource_constraint {
232 resource_size_t min, max, align;
233 resource_alignf alignf;
234 void *alignf_data;
235 };
236
237 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
238 extern struct resource ioport_resource;
239 extern struct resource iomem_resource;
240 extern struct resource soft_reserve_resource;
241
242 extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
243 extern int request_resource(struct resource *root, struct resource *new);
244 extern int release_resource(struct resource *new);
245 void release_child_resources(struct resource *new);
246 extern void reserve_region_with_split(struct resource *root,
247 resource_size_t start, resource_size_t end,
248 const char *name);
249 extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
250 extern int insert_resource(struct resource *parent, struct resource *new);
251 extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
252 extern int remove_resource(struct resource *old);
253 extern void arch_remove_reservations(struct resource *avail);
254 extern int allocate_resource(struct resource *root, struct resource *new,
255 resource_size_t size, resource_size_t min,
256 resource_size_t max, resource_size_t align,
257 resource_alignf alignf,
258 void *alignf_data);
259 struct resource *lookup_resource(struct resource *root, resource_size_t start);
260 int adjust_resource(struct resource *res, resource_size_t start,
261 resource_size_t size);
262 resource_size_t resource_alignment(struct resource *res);
263
264 /**
265 * resource_set_size - Calculate resource end address from size and start
266 * @res: Resource descriptor
267 * @size: Size of the resource
268 *
269 * Calculate the end address for @res based on @size.
270 *
271 * Note: The start address of @res must be set when calling this function.
272 * Prefer resource_set_range() if setting both the start address and @size.
273 */
resource_set_size(struct resource * res,resource_size_t size)274 static inline void resource_set_size(struct resource *res, resource_size_t size)
275 {
276 res->end = res->start + size - 1;
277 }
278
279 /**
280 * resource_set_range - Set resource start and end addresses
281 * @res: Resource descriptor
282 * @start: Start address for the resource
283 * @size: Size of the resource
284 *
285 * Set @res start address and calculate the end address based on @size.
286 */
resource_set_range(struct resource * res,resource_size_t start,resource_size_t size)287 static inline void resource_set_range(struct resource *res,
288 resource_size_t start,
289 resource_size_t size)
290 {
291 res->start = start;
292 resource_set_size(res, size);
293 }
294
resource_size(const struct resource * res)295 static inline resource_size_t resource_size(const struct resource *res)
296 {
297 return res->end - res->start + 1;
298 }
resource_type(const struct resource * res)299 static inline unsigned long resource_type(const struct resource *res)
300 {
301 return res->flags & IORESOURCE_TYPE_BITS;
302 }
resource_ext_type(const struct resource * res)303 static inline unsigned long resource_ext_type(const struct resource *res)
304 {
305 return res->flags & IORESOURCE_EXT_TYPE_BITS;
306 }
307 /* True iff r1 completely contains r2 */
resource_contains(const struct resource * r1,const struct resource * r2)308 static inline bool resource_contains(const struct resource *r1, const struct resource *r2)
309 {
310 if (resource_type(r1) != resource_type(r2))
311 return false;
312 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
313 return false;
314 return r1->start <= r2->start && r1->end >= r2->end;
315 }
316
317 /* True if any part of r1 overlaps r2 */
resource_overlaps(const struct resource * r1,const struct resource * r2)318 static inline bool resource_overlaps(const struct resource *r1, const struct resource *r2)
319 {
320 return r1->start <= r2->end && r1->end >= r2->start;
321 }
322
resource_intersection(const struct resource * r1,const struct resource * r2,struct resource * r)323 static inline bool resource_intersection(const struct resource *r1, const struct resource *r2,
324 struct resource *r)
325 {
326 if (!resource_overlaps(r1, r2))
327 return false;
328 r->start = max(r1->start, r2->start);
329 r->end = min(r1->end, r2->end);
330 return true;
331 }
332
resource_union(const struct resource * r1,const struct resource * r2,struct resource * r)333 static inline bool resource_union(const struct resource *r1, const struct resource *r2,
334 struct resource *r)
335 {
336 if (!resource_overlaps(r1, r2))
337 return false;
338 r->start = min(r1->start, r2->start);
339 r->end = max(r1->end, r2->end);
340 return true;
341 }
342
343 /*
344 * Check if this resource is added to a resource tree or detached. Caller is
345 * responsible for not racing assignment.
346 */
resource_assigned(const struct resource * res)347 static inline bool resource_assigned(const struct resource *res)
348 {
349 return res->parent;
350 }
351
352 int find_resource_space(struct resource *root, struct resource *new,
353 resource_size_t size, struct resource_constraint *constraint);
354
355 /* Convenience shorthand with allocation */
356 #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
357 #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
358 #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
359 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
360 #define request_mem_region_muxed(start, n, name) \
361 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_MUXED)
362 #define request_mem_region_exclusive(start,n,name) \
363 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
364 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
365
366 extern struct resource * __request_region(struct resource *,
367 resource_size_t start,
368 resource_size_t n,
369 const char *name, int flags);
370
371 /* Compatibility cruft */
372 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
373 #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
374
375 extern void __release_region(struct resource *, resource_size_t,
376 resource_size_t);
377 #ifdef CONFIG_MEMORY_HOTREMOVE
378 extern void release_mem_region_adjustable(resource_size_t, resource_size_t);
379 #endif
380 #ifdef CONFIG_MEMORY_HOTPLUG
381 extern void merge_system_ram_resource(struct resource *res);
382 #endif
383
384 /* Wrappers for managed devices */
385 struct device;
386
387 extern int devm_request_resource(struct device *dev, struct resource *root,
388 struct resource *new);
389 extern void devm_release_resource(struct device *dev, struct resource *new);
390
391 #define devm_request_region(dev,start,n,name) \
392 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
393 #define devm_request_mem_region(dev,start,n,name) \
394 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
395
396 extern struct resource * __devm_request_region(struct device *dev,
397 struct resource *parent, resource_size_t start,
398 resource_size_t n, const char *name);
399
400 #define devm_release_region(dev, start, n) \
401 __devm_release_region(dev, &ioport_resource, (start), (n))
402 #define devm_release_mem_region(dev, start, n) \
403 __devm_release_region(dev, &iomem_resource, (start), (n))
404
405 extern void __devm_release_region(struct device *dev, struct resource *parent,
406 resource_size_t start, resource_size_t n);
407 extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
408 extern bool iomem_is_exclusive(u64 addr);
409 extern bool resource_is_exclusive(struct resource *resource, u64 addr,
410 resource_size_t size);
411
412 extern int
413 walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
414 void *arg, int (*func)(unsigned long, unsigned long, void *));
415 extern int
416 walk_mem_res(u64 start, u64 end, void *arg,
417 int (*func)(struct resource *, void *));
418 extern int
419 walk_system_ram_res(u64 start, u64 end, void *arg,
420 int (*func)(struct resource *, void *));
421 extern int
422 walk_system_ram_res_rev(u64 start, u64 end, void *arg,
423 int (*func)(struct resource *, void *));
424 extern int
425 walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
426 void *arg, int (*func)(struct resource *, void *));
427 extern int walk_soft_reserve_res(u64 start, u64 end, void *arg,
428 int (*func)(struct resource *, void *));
429 extern int
430 region_intersects_soft_reserve(resource_size_t start, size_t size);
431
432 struct resource *devm_request_free_mem_region(struct device *dev,
433 struct resource *base, unsigned long size);
434 struct resource *request_free_mem_region(struct resource *base,
435 unsigned long size, const char *name);
436 struct resource *alloc_free_mem_region(struct resource *base,
437 unsigned long size, unsigned long align, const char *name);
438
irqresource_disabled(struct resource * res,u32 irq)439 static inline void irqresource_disabled(struct resource *res, u32 irq)
440 {
441 res->start = irq;
442 res->end = irq;
443 res->flags |= IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
444 }
445
446 extern struct address_space *iomem_get_mapping(void);
447
448 #endif /* __ASSEMBLY__ */
449 #endif /* _LINUX_IOPORT_H */
450