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