Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 */
22struct 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 */
136enum {
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 */
152enum {
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 * @empty_res: Empty resource range without alignment applied
206 * @size: The minimum size of the empty space
207 * @align: Alignment from the constraints
208 *
209 * Callback allows calculating resource placement and alignment beyond min,
210 * max, and align fields in the struct resource_constraint.
211 *
212 * Return: Start address for the resource.
213 */
214typedef resource_size_t (*resource_alignf)(void *data,
215 const struct resource *res,
216 const struct resource *empty_res,
217 resource_size_t size,
218 resource_size_t align);
219
220/**
221 * struct resource_constraint - constraints to be met while searching empty
222 * resource space
223 * @min: The minimum address for the memory range
224 * @max: The maximum address for the memory range
225 * @align: Alignment for the start address of the empty space
226 * @alignf: Additional alignment constraints callback
227 * @alignf_data: Data provided for @alignf callback
228 *
229 * Contains the range and alignment constraints that have to be met during
230 * find_resource_space(). @alignf can be NULL indicating no alignment beyond
231 * @align is necessary.
232 */
233struct resource_constraint {
234 resource_size_t min, max, align;
235 resource_alignf alignf;
236 void *alignf_data;
237};
238
239/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
240extern struct resource ioport_resource;
241extern struct resource iomem_resource;
242extern struct resource soft_reserve_resource;
243
244extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
245extern int request_resource(struct resource *root, struct resource *new);
246extern int release_resource(struct resource *new);
247void release_child_resources(struct resource *new);
248extern void reserve_region_with_split(struct resource *root,
249 resource_size_t start, resource_size_t end,
250 const char *name);
251extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
252extern int insert_resource(struct resource *parent, struct resource *new);
253extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
254extern int remove_resource(struct resource *old);
255extern void arch_remove_reservations(struct resource *avail);
256extern int allocate_resource(struct resource *root, struct resource *new,
257 resource_size_t size, resource_size_t min,
258 resource_size_t max, resource_size_t align,
259 resource_alignf alignf,
260 void *alignf_data);
261struct resource *lookup_resource(struct resource *root, resource_size_t start);
262int adjust_resource(struct resource *res, resource_size_t start,
263 resource_size_t size);
264resource_size_t resource_alignment(struct resource *res);
265
266/**
267 * resource_set_size - Calculate resource end address from size and start
268 * @res: Resource descriptor
269 * @size: Size of the resource
270 *
271 * Calculate the end address for @res based on @size.
272 *
273 * Note: The start address of @res must be set when calling this function.
274 * Prefer resource_set_range() if setting both the start address and @size.
275 */
276static inline void resource_set_size(struct resource *res, resource_size_t size)
277{
278 res->end = res->start + size - 1;
279}
280
281/**
282 * resource_set_range - Set resource start and end addresses
283 * @res: Resource descriptor
284 * @start: Start address for the resource
285 * @size: Size of the resource
286 *
287 * Set @res start address and calculate the end address based on @size.
288 */
289static inline void resource_set_range(struct resource *res,
290 resource_size_t start,
291 resource_size_t size)
292{
293 res->start = start;
294 resource_set_size(res, size);
295}
296
297static inline resource_size_t resource_size(const struct resource *res)
298{
299 return res->end - res->start + 1;
300}
301static inline unsigned long resource_type(const struct resource *res)
302{
303 return res->flags & IORESOURCE_TYPE_BITS;
304}
305static inline unsigned long resource_ext_type(const struct resource *res)
306{
307 return res->flags & IORESOURCE_EXT_TYPE_BITS;
308}
309
310/*
311 * For checking if @r1 completely contains @r2 for resources that have real
312 * addresses but are not yet crafted into the resource tree. Normally
313 * resource_contains() should be used instead of this function as it checks
314 * also IORESOURCE_UNSET flag.
315 */
316static inline bool __resource_contains_unbound(const struct resource *r1,
317 const struct resource *r2)
318{
319 if (resource_type(r1) != resource_type(r2))
320 return false;
321
322 return r1->start <= r2->start && r1->end >= r2->end;
323}
324/* True iff r1 completely contains r2 */
325static inline bool resource_contains(const struct resource *r1, const struct resource *r2)
326{
327 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
328 return false;
329
330 return __resource_contains_unbound(r1, r2);
331}
332
333/* True if any part of r1 overlaps r2 */
334static inline bool resource_overlaps(const struct resource *r1, const struct resource *r2)
335{
336 return r1->start <= r2->end && r1->end >= r2->start;
337}
338
339static inline bool resource_intersection(const struct resource *r1, const struct resource *r2,
340 struct resource *r)
341{
342 if (!resource_overlaps(r1, r2))
343 return false;
344 r->start = max(r1->start, r2->start);
345 r->end = min(r1->end, r2->end);
346 return true;
347}
348
349static inline bool resource_union(const struct resource *r1, const struct resource *r2,
350 struct resource *r)
351{
352 if (!resource_overlaps(r1, r2))
353 return false;
354 r->start = min(r1->start, r2->start);
355 r->end = max(r1->end, r2->end);
356 return true;
357}
358
359/*
360 * Check if this resource is added to a resource tree or detached. Caller is
361 * responsible for not racing assignment.
362 */
363static inline bool resource_assigned(const struct resource *res)
364{
365 return res->parent;
366}
367
368int find_resource_space(struct resource *root, struct resource *new,
369 resource_size_t size, struct resource_constraint *constraint);
370
371/* Convenience shorthand with allocation */
372#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
373#define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
374#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
375#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
376#define request_mem_region_muxed(start, n, name) \
377 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_MUXED)
378#define request_mem_region_exclusive(start,n,name) \
379 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
380#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
381
382extern struct resource * __request_region(struct resource *,
383 resource_size_t start,
384 resource_size_t n,
385 const char *name, int flags);
386
387/* Compatibility cruft */
388#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
389#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
390
391extern void __release_region(struct resource *, resource_size_t,
392 resource_size_t);
393#ifdef CONFIG_MEMORY_HOTREMOVE
394extern void release_mem_region_adjustable(resource_size_t, resource_size_t);
395#endif
396#ifdef CONFIG_MEMORY_HOTPLUG
397extern void merge_system_ram_resource(struct resource *res);
398#endif
399
400/* Wrappers for managed devices */
401struct device;
402
403extern int devm_request_resource(struct device *dev, struct resource *root,
404 struct resource *new);
405extern void devm_release_resource(struct device *dev, struct resource *new);
406
407#define devm_request_region(dev,start,n,name) \
408 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
409#define devm_request_mem_region(dev,start,n,name) \
410 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
411
412extern struct resource * __devm_request_region(struct device *dev,
413 struct resource *parent, resource_size_t start,
414 resource_size_t n, const char *name);
415
416#define devm_release_region(dev, start, n) \
417 __devm_release_region(dev, &ioport_resource, (start), (n))
418#define devm_release_mem_region(dev, start, n) \
419 __devm_release_region(dev, &iomem_resource, (start), (n))
420
421extern void __devm_release_region(struct device *dev, struct resource *parent,
422 resource_size_t start, resource_size_t n);
423extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
424extern bool iomem_is_exclusive(u64 addr);
425extern bool resource_is_exclusive(struct resource *resource, u64 addr,
426 resource_size_t size);
427
428extern int
429walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
430 void *arg, int (*func)(unsigned long, unsigned long, void *));
431extern int
432walk_mem_res(u64 start, u64 end, void *arg,
433 int (*func)(struct resource *, void *));
434extern int
435walk_system_ram_res(u64 start, u64 end, void *arg,
436 int (*func)(struct resource *, void *));
437extern int
438walk_system_ram_res_rev(u64 start, u64 end, void *arg,
439 int (*func)(struct resource *, void *));
440extern int
441walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
442 void *arg, int (*func)(struct resource *, void *));
443extern int walk_soft_reserve_res(u64 start, u64 end, void *arg,
444 int (*func)(struct resource *, void *));
445extern int
446region_intersects_soft_reserve(resource_size_t start, size_t size);
447
448struct resource *devm_request_free_mem_region(struct device *dev,
449 struct resource *base, unsigned long size);
450struct resource *request_free_mem_region(struct resource *base,
451 unsigned long size, const char *name);
452struct resource *alloc_free_mem_region(struct resource *base,
453 unsigned long size, unsigned long align, const char *name);
454
455static inline void irqresource_disabled(struct resource *res, u32 irq)
456{
457 res->start = irq;
458 res->end = irq;
459 res->flags |= IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
460}
461
462extern struct address_space *iomem_get_mapping(void);
463
464#endif /* __ASSEMBLY__ */
465#endif /* _LINUX_IOPORT_H */