Branch data Line data Source code
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 : : #define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
62 : :
63 : : #define IORESOURCE_DISABLED 0x10000000
64 : : #define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
65 : : #define IORESOURCE_AUTO 0x40000000
66 : : #define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
67 : :
68 : : /* I/O resource extended types */
69 : : #define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM|IORESOURCE_SYSRAM)
70 : :
71 : : /* PnP IRQ specific bits (IORESOURCE_BITS) */
72 : : #define IORESOURCE_IRQ_HIGHEDGE (1<<0)
73 : : #define IORESOURCE_IRQ_LOWEDGE (1<<1)
74 : : #define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
75 : : #define IORESOURCE_IRQ_LOWLEVEL (1<<3)
76 : : #define IORESOURCE_IRQ_SHAREABLE (1<<4)
77 : : #define IORESOURCE_IRQ_OPTIONAL (1<<5)
78 : :
79 : : /* PnP DMA specific bits (IORESOURCE_BITS) */
80 : : #define IORESOURCE_DMA_TYPE_MASK (3<<0)
81 : : #define IORESOURCE_DMA_8BIT (0<<0)
82 : : #define IORESOURCE_DMA_8AND16BIT (1<<0)
83 : : #define IORESOURCE_DMA_16BIT (2<<0)
84 : :
85 : : #define IORESOURCE_DMA_MASTER (1<<2)
86 : : #define IORESOURCE_DMA_BYTE (1<<3)
87 : : #define IORESOURCE_DMA_WORD (1<<4)
88 : :
89 : : #define IORESOURCE_DMA_SPEED_MASK (3<<6)
90 : : #define IORESOURCE_DMA_COMPATIBLE (0<<6)
91 : : #define IORESOURCE_DMA_TYPEA (1<<6)
92 : : #define IORESOURCE_DMA_TYPEB (2<<6)
93 : : #define IORESOURCE_DMA_TYPEF (3<<6)
94 : :
95 : : /* PnP memory I/O specific bits (IORESOURCE_BITS) */
96 : : #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
97 : : #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
98 : : #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
99 : : #define IORESOURCE_MEM_TYPE_MASK (3<<3)
100 : : #define IORESOURCE_MEM_8BIT (0<<3)
101 : : #define IORESOURCE_MEM_16BIT (1<<3)
102 : : #define IORESOURCE_MEM_8AND16BIT (2<<3)
103 : : #define IORESOURCE_MEM_32BIT (3<<3)
104 : : #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
105 : : #define IORESOURCE_MEM_EXPANSIONROM (1<<6)
106 : :
107 : : /* PnP I/O specific bits (IORESOURCE_BITS) */
108 : : #define IORESOURCE_IO_16BIT_ADDR (1<<0)
109 : : #define IORESOURCE_IO_FIXED (1<<1)
110 : : #define IORESOURCE_IO_SPARSE (1<<2)
111 : :
112 : : /* PCI ROM control bits (IORESOURCE_BITS) */
113 : : #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
114 : : #define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
115 : :
116 : : /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
117 : : #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
118 : : #define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
119 : :
120 : : /*
121 : : * I/O Resource Descriptors
122 : : *
123 : : * Descriptors are used by walk_iomem_res_desc() and region_intersects()
124 : : * for searching a specific resource range in the iomem table. Assign
125 : : * a new descriptor when a resource range supports the search interfaces.
126 : : * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
127 : : */
128 : : enum {
129 : : IORES_DESC_NONE = 0,
130 : : IORES_DESC_CRASH_KERNEL = 1,
131 : : IORES_DESC_ACPI_TABLES = 2,
132 : : IORES_DESC_ACPI_NV_STORAGE = 3,
133 : : IORES_DESC_PERSISTENT_MEMORY = 4,
134 : : IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
135 : : IORES_DESC_DEVICE_PRIVATE_MEMORY = 6,
136 : : IORES_DESC_RESERVED = 7,
137 : : IORES_DESC_SOFT_RESERVED = 8,
138 : : };
139 : :
140 : : /*
141 : : * Flags controlling ioremap() behavior.
142 : : */
143 : : enum {
144 : : IORES_MAP_SYSTEM_RAM = BIT(0),
145 : : IORES_MAP_ENCRYPTED = BIT(1),
146 : : };
147 : :
148 : : /* helpers to define resources */
149 : : #define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
150 : : { \
151 : : .start = (_start), \
152 : : .end = (_start) + (_size) - 1, \
153 : : .name = (_name), \
154 : : .flags = (_flags), \
155 : : .desc = IORES_DESC_NONE, \
156 : : }
157 : :
158 : : #define DEFINE_RES_IO_NAMED(_start, _size, _name) \
159 : : DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
160 : : #define DEFINE_RES_IO(_start, _size) \
161 : : DEFINE_RES_IO_NAMED((_start), (_size), NULL)
162 : :
163 : : #define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
164 : : DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
165 : : #define DEFINE_RES_MEM(_start, _size) \
166 : : DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
167 : :
168 : : #define DEFINE_RES_IRQ_NAMED(_irq, _name) \
169 : : DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
170 : : #define DEFINE_RES_IRQ(_irq) \
171 : : DEFINE_RES_IRQ_NAMED((_irq), NULL)
172 : :
173 : : #define DEFINE_RES_DMA_NAMED(_dma, _name) \
174 : : DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
175 : : #define DEFINE_RES_DMA(_dma) \
176 : : DEFINE_RES_DMA_NAMED((_dma), NULL)
177 : :
178 : : /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
179 : : extern struct resource ioport_resource;
180 : : extern struct resource iomem_resource;
181 : :
182 : : extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
183 : : extern int request_resource(struct resource *root, struct resource *new);
184 : : extern int release_resource(struct resource *new);
185 : : void release_child_resources(struct resource *new);
186 : : extern void reserve_region_with_split(struct resource *root,
187 : : resource_size_t start, resource_size_t end,
188 : : const char *name);
189 : : extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
190 : : extern int insert_resource(struct resource *parent, struct resource *new);
191 : : extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
192 : : extern int remove_resource(struct resource *old);
193 : : extern void arch_remove_reservations(struct resource *avail);
194 : : extern int allocate_resource(struct resource *root, struct resource *new,
195 : : resource_size_t size, resource_size_t min,
196 : : resource_size_t max, resource_size_t align,
197 : : resource_size_t (*alignf)(void *,
198 : : const struct resource *,
199 : : resource_size_t,
200 : : resource_size_t),
201 : : void *alignf_data);
202 : : struct resource *lookup_resource(struct resource *root, resource_size_t start);
203 : : int adjust_resource(struct resource *res, resource_size_t start,
204 : : resource_size_t size);
205 : : resource_size_t resource_alignment(struct resource *res);
206 : 120 : static inline resource_size_t resource_size(const struct resource *res)
207 : : {
208 [ - - - - : 120 : return res->end - res->start + 1;
# # # # #
# # # # #
# # # # #
# # # #
# ]
209 : : }
210 : 4110 : static inline unsigned long resource_type(const struct resource *res)
211 : : {
212 [ + + + - : 1080 : return res->flags & IORESOURCE_TYPE_BITS;
- - - - -
- - - -
- ]
213 : : }
214 : 1260 : static inline unsigned long resource_ext_type(const struct resource *res)
215 : : {
216 : 1260 : return res->flags & IORESOURCE_EXT_TYPE_BITS;
217 : : }
218 : : /* True iff r1 completely contains r2 */
219 : 1740 : static inline bool resource_contains(struct resource *r1, struct resource *r2)
220 : : {
221 [ + + + + : 1740 : if (resource_type(r1) != resource_type(r2))
# # ]
222 : : return false;
223 [ + - + - : 1020 : if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
+ - + - #
# ]
224 : : return false;
225 [ + - + + : 1440 : return r1->start <= r2->start && r1->end >= r2->end;
+ + + - +
+ + + # #
# # # # ]
226 : : }
227 : :
228 : :
229 : : /* Convenience shorthand with allocation */
230 : : #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
231 : : #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
232 : : #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
233 : : #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
234 : : #define request_mem_region_exclusive(start,n,name) \
235 : : __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
236 : : #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
237 : :
238 : : extern struct resource * __request_region(struct resource *,
239 : : resource_size_t start,
240 : : resource_size_t n,
241 : : const char *name, int flags);
242 : :
243 : : /* Compatibility cruft */
244 : : #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
245 : : #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
246 : :
247 : : extern void __release_region(struct resource *, resource_size_t,
248 : : resource_size_t);
249 : : #ifdef CONFIG_MEMORY_HOTREMOVE
250 : : extern int release_mem_region_adjustable(struct resource *, resource_size_t,
251 : : resource_size_t);
252 : : #endif
253 : :
254 : : /* Wrappers for managed devices */
255 : : struct device;
256 : :
257 : : extern int devm_request_resource(struct device *dev, struct resource *root,
258 : : struct resource *new);
259 : : extern void devm_release_resource(struct device *dev, struct resource *new);
260 : :
261 : : #define devm_request_region(dev,start,n,name) \
262 : : __devm_request_region(dev, &ioport_resource, (start), (n), (name))
263 : : #define devm_request_mem_region(dev,start,n,name) \
264 : : __devm_request_region(dev, &iomem_resource, (start), (n), (name))
265 : :
266 : : extern struct resource * __devm_request_region(struct device *dev,
267 : : struct resource *parent, resource_size_t start,
268 : : resource_size_t n, const char *name);
269 : :
270 : : #define devm_release_region(dev, start, n) \
271 : : __devm_release_region(dev, &ioport_resource, (start), (n))
272 : : #define devm_release_mem_region(dev, start, n) \
273 : : __devm_release_region(dev, &iomem_resource, (start), (n))
274 : :
275 : : extern void __devm_release_region(struct device *dev, struct resource *parent,
276 : : resource_size_t start, resource_size_t n);
277 : : extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
278 : : extern bool iomem_is_exclusive(u64 addr);
279 : :
280 : : extern int
281 : : walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
282 : : void *arg, int (*func)(unsigned long, unsigned long, void *));
283 : : extern int
284 : : walk_mem_res(u64 start, u64 end, void *arg,
285 : : int (*func)(struct resource *, void *));
286 : : extern int
287 : : walk_system_ram_res(u64 start, u64 end, void *arg,
288 : : int (*func)(struct resource *, void *));
289 : : extern int
290 : : walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
291 : : void *arg, int (*func)(struct resource *, void *));
292 : :
293 : : /* True if any part of r1 overlaps r2 */
294 : 420 : static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
295 : : {
296 [ + + + + : 810 : return (r1->start <= r2->end && r1->end >= r2->start);
+ + ]
297 : : }
298 : :
299 : : struct resource *devm_request_free_mem_region(struct device *dev,
300 : : struct resource *base, unsigned long size);
301 : : struct resource *request_free_mem_region(struct resource *base,
302 : : unsigned long size, const char *name);
303 : :
304 : : #endif /* __ASSEMBLY__ */
305 : : #endif /* _LINUX_IOPORT_H */
|
