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