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
90 /* PnP DMA specific bits (IORESOURCE_BITS) */
91 #define IORESOURCE_DMA_TYPE_MASK (3<<0)
92 #define IORESOURCE_DMA_8BIT (0<<0)
93 #define IORESOURCE_DMA_8AND16BIT (1<<0)
94 #define IORESOURCE_DMA_16BIT (2<<0)
95
96 #define IORESOURCE_DMA_MASTER (1<<2)
97 #define IORESOURCE_DMA_BYTE (1<<3)
98 #define IORESOURCE_DMA_WORD (1<<4)
99
100 #define IORESOURCE_DMA_SPEED_MASK (3<<6)
101 #define IORESOURCE_DMA_COMPATIBLE (0<<6)
102 #define IORESOURCE_DMA_TYPEA (1<<6)
103 #define IORESOURCE_DMA_TYPEB (2<<6)
104 #define IORESOURCE_DMA_TYPEF (3<<6)
105
106 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
107 #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
108 #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
109 #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
110 #define IORESOURCE_MEM_TYPE_MASK (3<<3)
111 #define IORESOURCE_MEM_8BIT (0<<3)
112 #define IORESOURCE_MEM_16BIT (1<<3)
113 #define IORESOURCE_MEM_8AND16BIT (2<<3)
114 #define IORESOURCE_MEM_32BIT (3<<3)
115 #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
116 #define IORESOURCE_MEM_EXPANSIONROM (1<<6)
117 #define IORESOURCE_MEM_NONPOSTED (1<<7)
118
119 /* PnP I/O specific bits (IORESOURCE_BITS) */
120 #define IORESOURCE_IO_16BIT_ADDR (1<<0)
121 #define IORESOURCE_IO_FIXED (1<<1)
122 #define IORESOURCE_IO_SPARSE (1<<2)
123
124 /* PCI ROM control bits (IORESOURCE_BITS) */
125 #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
126 #define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
127
128 /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
129 #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
130 #define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
131
132 /*
133 * I/O Resource Descriptors
134 *
135 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
136 * for searching a specific resource range in the iomem table. Assign
137 * a new descriptor when a resource range supports the search interfaces.
138 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
139 */
140 enum {
141 IORES_DESC_NONE = 0,
142 IORES_DESC_CRASH_KERNEL = 1,
143 IORES_DESC_ACPI_TABLES = 2,
144 IORES_DESC_ACPI_NV_STORAGE = 3,
145 IORES_DESC_PERSISTENT_MEMORY = 4,
146 IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
147 IORES_DESC_DEVICE_PRIVATE_MEMORY = 6,
148 IORES_DESC_RESERVED = 7,
149 IORES_DESC_SOFT_RESERVED = 8,
150 };
151
152 /*
153 * Flags controlling ioremap() behavior.
154 */
155 enum {
156 IORES_MAP_SYSTEM_RAM = BIT(0),
157 IORES_MAP_ENCRYPTED = BIT(1),
158 };
159
160 /* helpers to define resources */
161 #define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
162 { \
163 .start = (_start), \
164 .end = (_start) + (_size) - 1, \
165 .name = (_name), \
166 .flags = (_flags), \
167 .desc = IORES_DESC_NONE, \
168 }
169
170 #define DEFINE_RES_IO_NAMED(_start, _size, _name) \
171 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
172 #define DEFINE_RES_IO(_start, _size) \
173 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
174
175 #define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
176 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
177 #define DEFINE_RES_MEM(_start, _size) \
178 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
179
180 #define DEFINE_RES_IRQ_NAMED(_irq, _name) \
181 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
182 #define DEFINE_RES_IRQ(_irq) \
183 DEFINE_RES_IRQ_NAMED((_irq), NULL)
184
185 #define DEFINE_RES_DMA_NAMED(_dma, _name) \
186 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
187 #define DEFINE_RES_DMA(_dma) \
188 DEFINE_RES_DMA_NAMED((_dma), NULL)
189
190 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
191 extern struct resource ioport_resource;
192 extern struct resource iomem_resource;
193
194 extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
195 extern int request_resource(struct resource *root, struct resource *new);
196 extern int release_resource(struct resource *new);
197 void release_child_resources(struct resource *new);
198 extern void reserve_region_with_split(struct resource *root,
199 resource_size_t start, resource_size_t end,
200 const char *name);
201 extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
202 extern int insert_resource(struct resource *parent, struct resource *new);
203 extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
204 extern int remove_resource(struct resource *old);
205 extern void arch_remove_reservations(struct resource *avail);
206 extern int allocate_resource(struct resource *root, struct resource *new,
207 resource_size_t size, resource_size_t min,
208 resource_size_t max, resource_size_t align,
209 resource_size_t (*alignf)(void *,
210 const struct resource *,
211 resource_size_t,
212 resource_size_t),
213 void *alignf_data);
214 struct resource *lookup_resource(struct resource *root, resource_size_t start);
215 int adjust_resource(struct resource *res, resource_size_t start,
216 resource_size_t size);
217 resource_size_t resource_alignment(struct resource *res);
resource_size(const struct resource * res)218 static inline resource_size_t resource_size(const struct resource *res)
219 {
220 return res->end - res->start + 1;
221 }
resource_type(const struct resource * res)222 static inline unsigned long resource_type(const struct resource *res)
223 {
224 return res->flags & IORESOURCE_TYPE_BITS;
225 }
resource_ext_type(const struct resource * res)226 static inline unsigned long resource_ext_type(const struct resource *res)
227 {
228 return res->flags & IORESOURCE_EXT_TYPE_BITS;
229 }
230 /* True iff r1 completely contains r2 */
resource_contains(struct resource * r1,struct resource * r2)231 static inline bool resource_contains(struct resource *r1, struct resource *r2)
232 {
233 if (resource_type(r1) != resource_type(r2))
234 return false;
235 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
236 return false;
237 return r1->start <= r2->start && r1->end >= r2->end;
238 }
239
240 /* True if any part of r1 overlaps r2 */
resource_overlaps(struct resource * r1,struct resource * r2)241 static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
242 {
243 return r1->start <= r2->end && r1->end >= r2->start;
244 }
245
246 static inline bool
resource_intersection(struct resource * r1,struct resource * r2,struct resource * r)247 resource_intersection(struct resource *r1, struct resource *r2, struct resource *r)
248 {
249 if (!resource_overlaps(r1, r2))
250 return false;
251 r->start = max(r1->start, r2->start);
252 r->end = min(r1->end, r2->end);
253 return true;
254 }
255
256 static inline bool
resource_union(struct resource * r1,struct resource * r2,struct resource * r)257 resource_union(struct resource *r1, struct resource *r2, struct resource *r)
258 {
259 if (!resource_overlaps(r1, r2))
260 return false;
261 r->start = min(r1->start, r2->start);
262 r->end = max(r1->end, r2->end);
263 return true;
264 }
265
266 /* Convenience shorthand with allocation */
267 #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
268 #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
269 #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
270 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
271 #define request_mem_region_muxed(start, n, name) \
272 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_MUXED)
273 #define request_mem_region_exclusive(start,n,name) \
274 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
275 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
276
277 extern struct resource * __request_region(struct resource *,
278 resource_size_t start,
279 resource_size_t n,
280 const char *name, int flags);
281
282 /* Compatibility cruft */
283 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
284 #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
285
286 extern void __release_region(struct resource *, resource_size_t,
287 resource_size_t);
288 #ifdef CONFIG_MEMORY_HOTREMOVE
289 extern void release_mem_region_adjustable(resource_size_t, resource_size_t);
290 #endif
291 #ifdef CONFIG_MEMORY_HOTPLUG
292 extern void merge_system_ram_resource(struct resource *res);
293 #endif
294
295 /* Wrappers for managed devices */
296 struct device;
297
298 extern int devm_request_resource(struct device *dev, struct resource *root,
299 struct resource *new);
300 extern void devm_release_resource(struct device *dev, struct resource *new);
301
302 #define devm_request_region(dev,start,n,name) \
303 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
304 #define devm_request_mem_region(dev,start,n,name) \
305 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
306
307 extern struct resource * __devm_request_region(struct device *dev,
308 struct resource *parent, resource_size_t start,
309 resource_size_t n, const char *name);
310
311 #define devm_release_region(dev, start, n) \
312 __devm_release_region(dev, &ioport_resource, (start), (n))
313 #define devm_release_mem_region(dev, start, n) \
314 __devm_release_region(dev, &iomem_resource, (start), (n))
315
316 extern void __devm_release_region(struct device *dev, struct resource *parent,
317 resource_size_t start, resource_size_t n);
318 extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
319 extern bool iomem_is_exclusive(u64 addr);
320
321 extern int
322 walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
323 void *arg, int (*func)(unsigned long, unsigned long, void *));
324 extern int
325 walk_mem_res(u64 start, u64 end, void *arg,
326 int (*func)(struct resource *, void *));
327 extern int
328 walk_system_ram_res(u64 start, u64 end, void *arg,
329 int (*func)(struct resource *, void *));
330 extern int
331 walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
332 void *arg, int (*func)(struct resource *, void *));
333
334 struct resource *devm_request_free_mem_region(struct device *dev,
335 struct resource *base, unsigned long size);
336 struct resource *request_free_mem_region(struct resource *base,
337 unsigned long size, const char *name);
338
irqresource_disabled(struct resource * res,u32 irq)339 static inline void irqresource_disabled(struct resource *res, u32 irq)
340 {
341 res->start = irq;
342 res->end = irq;
343 res->flags |= IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
344 }
345
346 extern struct address_space *iomem_get_mapping(void);
347
348 #endif /* __ASSEMBLY__ */
349 #endif /* _LINUX_IOPORT_H */
350