2 * ioport.h Definitions of routines for detecting, reserving and
3 * allocating system resources.
5 * Authors: Linus Torvalds
8 #ifndef _LINUX_IOPORT_H
9 #define _LINUX_IOPORT_H
12 #include <linux/compiler.h>
13 #include <linux/types.h>
15 * Resources are tree-like, allowing
19 resource_size_t start;
24 struct resource *parent, *sibling, *child;
28 * IO resources have these defined flags.
30 * PCI devices expose these flags to userspace in the "resource" sysfs file,
33 #define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
35 #define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
36 #define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
37 #define IORESOURCE_MEM 0x00000200
38 #define IORESOURCE_REG 0x00000300 /* Register offsets */
39 #define IORESOURCE_IRQ 0x00000400
40 #define IORESOURCE_DMA 0x00000800
41 #define IORESOURCE_BUS 0x00001000
43 #define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
44 #define IORESOURCE_READONLY 0x00004000
45 #define IORESOURCE_CACHEABLE 0x00008000
46 #define IORESOURCE_RANGELENGTH 0x00010000
47 #define IORESOURCE_SHADOWABLE 0x00020000
49 #define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
50 #define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
52 #define IORESOURCE_MEM_64 0x00100000
53 #define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
54 #define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
56 #define IORESOURCE_EXT_TYPE_BITS 0x01000000 /* Resource extended types */
57 #define IORESOURCE_SYSRAM 0x01000000 /* System RAM (modifier) */
59 #define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
61 #define IORESOURCE_DISABLED 0x10000000
62 #define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
63 #define IORESOURCE_AUTO 0x40000000
64 #define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
66 /* I/O resource extended types */
67 #define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM|IORESOURCE_SYSRAM)
69 /* PnP IRQ specific bits (IORESOURCE_BITS) */
70 #define IORESOURCE_IRQ_HIGHEDGE (1<<0)
71 #define IORESOURCE_IRQ_LOWEDGE (1<<1)
72 #define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
73 #define IORESOURCE_IRQ_LOWLEVEL (1<<3)
74 #define IORESOURCE_IRQ_SHAREABLE (1<<4)
75 #define IORESOURCE_IRQ_OPTIONAL (1<<5)
77 /* PnP DMA specific bits (IORESOURCE_BITS) */
78 #define IORESOURCE_DMA_TYPE_MASK (3<<0)
79 #define IORESOURCE_DMA_8BIT (0<<0)
80 #define IORESOURCE_DMA_8AND16BIT (1<<0)
81 #define IORESOURCE_DMA_16BIT (2<<0)
83 #define IORESOURCE_DMA_MASTER (1<<2)
84 #define IORESOURCE_DMA_BYTE (1<<3)
85 #define IORESOURCE_DMA_WORD (1<<4)
87 #define IORESOURCE_DMA_SPEED_MASK (3<<6)
88 #define IORESOURCE_DMA_COMPATIBLE (0<<6)
89 #define IORESOURCE_DMA_TYPEA (1<<6)
90 #define IORESOURCE_DMA_TYPEB (2<<6)
91 #define IORESOURCE_DMA_TYPEF (3<<6)
93 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
94 #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
95 #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
96 #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
97 #define IORESOURCE_MEM_TYPE_MASK (3<<3)
98 #define IORESOURCE_MEM_8BIT (0<<3)
99 #define IORESOURCE_MEM_16BIT (1<<3)
100 #define IORESOURCE_MEM_8AND16BIT (2<<3)
101 #define IORESOURCE_MEM_32BIT (3<<3)
102 #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
103 #define IORESOURCE_MEM_EXPANSIONROM (1<<6)
105 /* PnP I/O specific bits (IORESOURCE_BITS) */
106 #define IORESOURCE_IO_16BIT_ADDR (1<<0)
107 #define IORESOURCE_IO_FIXED (1<<1)
108 #define IORESOURCE_IO_SPARSE (1<<2)
110 /* PCI ROM control bits (IORESOURCE_BITS) */
111 #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
112 #define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
114 /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
115 #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
116 #define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
119 * I/O Resource Descriptors
121 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
122 * for searching a specific resource range in the iomem table. Assign
123 * a new descriptor when a resource range supports the search interfaces.
124 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
128 IORES_DESC_CRASH_KERNEL = 1,
129 IORES_DESC_ACPI_TABLES = 2,
130 IORES_DESC_ACPI_NV_STORAGE = 3,
131 IORES_DESC_PERSISTENT_MEMORY = 4,
132 IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
133 IORES_DESC_DEVICE_PRIVATE_MEMORY = 6,
134 IORES_DESC_DEVICE_PUBLIC_MEMORY = 7,
137 /* helpers to define resources */
138 #define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
141 .end = (_start) + (_size) - 1, \
144 .desc = IORES_DESC_NONE, \
147 #define DEFINE_RES_IO_NAMED(_start, _size, _name) \
148 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
149 #define DEFINE_RES_IO(_start, _size) \
150 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
152 #define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
153 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
154 #define DEFINE_RES_MEM(_start, _size) \
155 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
157 #define DEFINE_RES_IRQ_NAMED(_irq, _name) \
158 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
159 #define DEFINE_RES_IRQ(_irq) \
160 DEFINE_RES_IRQ_NAMED((_irq), NULL)
162 #define DEFINE_RES_DMA_NAMED(_dma, _name) \
163 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
164 #define DEFINE_RES_DMA(_dma) \
165 DEFINE_RES_DMA_NAMED((_dma), NULL)
167 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
168 extern struct resource ioport_resource;
169 extern struct resource iomem_resource;
171 extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
172 extern int request_resource(struct resource *root, struct resource *new);
173 extern int release_resource(struct resource *new);
174 void release_child_resources(struct resource *new);
175 extern void reserve_region_with_split(struct resource *root,
176 resource_size_t start, resource_size_t end,
178 extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
179 extern int insert_resource(struct resource *parent, struct resource *new);
180 extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
181 extern int remove_resource(struct resource *old);
182 extern void arch_remove_reservations(struct resource *avail);
183 extern int allocate_resource(struct resource *root, struct resource *new,
184 resource_size_t size, resource_size_t min,
185 resource_size_t max, resource_size_t align,
186 resource_size_t (*alignf)(void *,
187 const struct resource *,
191 struct resource *lookup_resource(struct resource *root, resource_size_t start);
192 int adjust_resource(struct resource *res, resource_size_t start,
193 resource_size_t size);
194 resource_size_t resource_alignment(struct resource *res);
195 static inline resource_size_t resource_size(const struct resource *res)
197 return res->end - res->start + 1;
199 static inline unsigned long resource_type(const struct resource *res)
201 return res->flags & IORESOURCE_TYPE_BITS;
203 static inline unsigned long resource_ext_type(const struct resource *res)
205 return res->flags & IORESOURCE_EXT_TYPE_BITS;
207 /* True iff r1 completely contains r2 */
208 static inline bool resource_contains(struct resource *r1, struct resource *r2)
210 if (resource_type(r1) != resource_type(r2))
212 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
214 return r1->start <= r2->start && r1->end >= r2->end;
218 /* Convenience shorthand with allocation */
219 #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
220 #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
221 #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
222 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
223 #define request_mem_region_exclusive(start,n,name) \
224 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
225 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
227 extern struct resource * __request_region(struct resource *,
228 resource_size_t start,
230 const char *name, int flags);
232 /* Compatibility cruft */
233 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
234 #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
236 extern void __release_region(struct resource *, resource_size_t,
238 #ifdef CONFIG_MEMORY_HOTREMOVE
239 extern int release_mem_region_adjustable(struct resource *, resource_size_t,
243 /* Wrappers for managed devices */
246 extern int devm_request_resource(struct device *dev, struct resource *root,
247 struct resource *new);
248 extern void devm_release_resource(struct device *dev, struct resource *new);
250 #define devm_request_region(dev,start,n,name) \
251 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
252 #define devm_request_mem_region(dev,start,n,name) \
253 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
255 extern struct resource * __devm_request_region(struct device *dev,
256 struct resource *parent, resource_size_t start,
257 resource_size_t n, const char *name);
259 #define devm_release_region(dev, start, n) \
260 __devm_release_region(dev, &ioport_resource, (start), (n))
261 #define devm_release_mem_region(dev, start, n) \
262 __devm_release_region(dev, &iomem_resource, (start), (n))
264 extern void __devm_release_region(struct device *dev, struct resource *parent,
265 resource_size_t start, resource_size_t n);
266 extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
267 extern int iomem_is_exclusive(u64 addr);
270 walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
271 void *arg, int (*func)(unsigned long, unsigned long, void *));
273 walk_system_ram_res(u64 start, u64 end, void *arg,
274 int (*func)(u64, u64, void *));
276 walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
277 void *arg, int (*func)(u64, u64, void *));
279 /* True if any part of r1 overlaps r2 */
280 static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
282 return (r1->start <= r2->end && r1->end >= r2->start);
286 #endif /* __ASSEMBLY__ */
287 #endif /* _LINUX_IOPORT_H */