1 /*
2 * ioport.h Definitions of routines for detecting, reserving and
3 * allocating system resources.
4 *
5 * Authors: Linus Torvalds
6 */
7
8 #ifndef _LINUX_IOPORT_H
9 #define _LINUX_IOPORT_H
10
11 #ifndef __ASSEMBLY__
12 #include <linux/compiler.h>
13 #include <linux/types.h>
14 /*
15 * Resources are tree-like, allowing
16 * nesting etc..
17 */
18 struct resource {
19 resource_size_t start;
20 resource_size_t end;
21 const char *name;
22 unsigned long flags;
23 struct resource *parent, *sibling, *child;
24 };
25
26 /*
27 * IO resources have these defined flags.
28 */
29 #define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
30
31 #define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
32 #define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
33 #define IORESOURCE_MEM 0x00000200
34 #define IORESOURCE_REG 0x00000300 /* Register offsets */
35 #define IORESOURCE_IRQ 0x00000400
36 #define IORESOURCE_DMA 0x00000800
37 #define IORESOURCE_BUS 0x00001000
38
39 #define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
40 #define IORESOURCE_READONLY 0x00004000
41 #define IORESOURCE_CACHEABLE 0x00008000
42 #define IORESOURCE_RANGELENGTH 0x00010000
43 #define IORESOURCE_SHADOWABLE 0x00020000
44
45 #define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
46 #define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
47
48 #define IORESOURCE_MEM_64 0x00100000
49 #define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
50 #define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
51
52 #define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
53 #define IORESOURCE_DISABLED 0x10000000
54 #define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
55 #define IORESOURCE_AUTO 0x40000000
56 #define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
57
58 /* PnP IRQ specific bits (IORESOURCE_BITS) */
59 #define IORESOURCE_IRQ_HIGHEDGE (1<<0)
60 #define IORESOURCE_IRQ_LOWEDGE (1<<1)
61 #define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
62 #define IORESOURCE_IRQ_LOWLEVEL (1<<3)
63 #define IORESOURCE_IRQ_SHAREABLE (1<<4)
64 #define IORESOURCE_IRQ_OPTIONAL (1<<5)
65
66 /* PnP DMA specific bits (IORESOURCE_BITS) */
67 #define IORESOURCE_DMA_TYPE_MASK (3<<0)
68 #define IORESOURCE_DMA_8BIT (0<<0)
69 #define IORESOURCE_DMA_8AND16BIT (1<<0)
70 #define IORESOURCE_DMA_16BIT (2<<0)
71
72 #define IORESOURCE_DMA_MASTER (1<<2)
73 #define IORESOURCE_DMA_BYTE (1<<3)
74 #define IORESOURCE_DMA_WORD (1<<4)
75
76 #define IORESOURCE_DMA_SPEED_MASK (3<<6)
77 #define IORESOURCE_DMA_COMPATIBLE (0<<6)
78 #define IORESOURCE_DMA_TYPEA (1<<6)
79 #define IORESOURCE_DMA_TYPEB (2<<6)
80 #define IORESOURCE_DMA_TYPEF (3<<6)
81
82 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
83 #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
84 #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
85 #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
86 #define IORESOURCE_MEM_TYPE_MASK (3<<3)
87 #define IORESOURCE_MEM_8BIT (0<<3)
88 #define IORESOURCE_MEM_16BIT (1<<3)
89 #define IORESOURCE_MEM_8AND16BIT (2<<3)
90 #define IORESOURCE_MEM_32BIT (3<<3)
91 #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
92 #define IORESOURCE_MEM_EXPANSIONROM (1<<6)
93
94 /* PnP I/O specific bits (IORESOURCE_BITS) */
95 #define IORESOURCE_IO_16BIT_ADDR (1<<0)
96 #define IORESOURCE_IO_FIXED (1<<1)
97 #define IORESOURCE_IO_SPARSE (1<<2)
98
99 /* PCI ROM control bits (IORESOURCE_BITS) */
100 #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
101 #define IORESOURCE_ROM_SHADOW (1<<1) /* ROM is copy at C000:0 */
102 #define IORESOURCE_ROM_COPY (1<<2) /* ROM is alloc'd copy, resource field overlaid */
103 #define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */
104
105 /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
106 #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
107
108
109 /* helpers to define resources */
110 #define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
111 { \
112 .start = (_start), \
113 .end = (_start) + (_size) - 1, \
114 .name = (_name), \
115 .flags = (_flags), \
116 }
117
118 #define DEFINE_RES_IO_NAMED(_start, _size, _name) \
119 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
120 #define DEFINE_RES_IO(_start, _size) \
121 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
122
123 #define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
124 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
125 #define DEFINE_RES_MEM(_start, _size) \
126 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
127
128 #define DEFINE_RES_IRQ_NAMED(_irq, _name) \
129 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
130 #define DEFINE_RES_IRQ(_irq) \
131 DEFINE_RES_IRQ_NAMED((_irq), NULL)
132
133 #define DEFINE_RES_DMA_NAMED(_dma, _name) \
134 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
135 #define DEFINE_RES_DMA(_dma) \
136 DEFINE_RES_DMA_NAMED((_dma), NULL)
137
138 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
139 extern struct resource ioport_resource;
140 extern struct resource iomem_resource;
141
142 extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
143 extern int request_resource(struct resource *root, struct resource *new);
144 extern int release_resource(struct resource *new);
145 void release_child_resources(struct resource *new);
146 extern void reserve_region_with_split(struct resource *root,
147 resource_size_t start, resource_size_t end,
148 const char *name);
149 extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
150 extern int insert_resource(struct resource *parent, struct resource *new);
151 extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
152 extern void arch_remove_reservations(struct resource *avail);
153 extern int allocate_resource(struct resource *root, struct resource *new,
154 resource_size_t size, resource_size_t min,
155 resource_size_t max, resource_size_t align,
156 resource_size_t (*alignf)(void *,
157 const struct resource *,
158 resource_size_t,
159 resource_size_t),
160 void *alignf_data);
161 struct resource *lookup_resource(struct resource *root, resource_size_t start);
162 int adjust_resource(struct resource *res, resource_size_t start,
163 resource_size_t size);
164 resource_size_t resource_alignment(struct resource *res);
resource_size(const struct resource * res)165 static inline resource_size_t resource_size(const struct resource *res)
166 {
167 return res->end - res->start + 1;
168 }
resource_type(const struct resource * res)169 static inline unsigned long resource_type(const struct resource *res)
170 {
171 return res->flags & IORESOURCE_TYPE_BITS;
172 }
173 /* True iff r1 completely contains r2 */
resource_contains(struct resource * r1,struct resource * r2)174 static inline bool resource_contains(struct resource *r1, struct resource *r2)
175 {
176 if (resource_type(r1) != resource_type(r2))
177 return false;
178 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
179 return false;
180 return r1->start <= r2->start && r1->end >= r2->end;
181 }
182
183
184 /* Convenience shorthand with allocation */
185 #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
186 #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
187 #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
188 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
189 #define request_mem_region_exclusive(start,n,name) \
190 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
191 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
192
193 extern struct resource * __request_region(struct resource *,
194 resource_size_t start,
195 resource_size_t n,
196 const char *name, int flags);
197
198 /* Compatibility cruft */
199 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
200 #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
201
202 extern void __release_region(struct resource *, resource_size_t,
203 resource_size_t);
204 #ifdef CONFIG_MEMORY_HOTREMOVE
205 extern int release_mem_region_adjustable(struct resource *, resource_size_t,
206 resource_size_t);
207 #endif
208
209 /* Wrappers for managed devices */
210 struct device;
211
212 extern int devm_request_resource(struct device *dev, struct resource *root,
213 struct resource *new);
214 extern void devm_release_resource(struct device *dev, struct resource *new);
215
216 #define devm_request_region(dev,start,n,name) \
217 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
218 #define devm_request_mem_region(dev,start,n,name) \
219 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
220
221 extern struct resource * __devm_request_region(struct device *dev,
222 struct resource *parent, resource_size_t start,
223 resource_size_t n, const char *name);
224
225 #define devm_release_region(dev, start, n) \
226 __devm_release_region(dev, &ioport_resource, (start), (n))
227 #define devm_release_mem_region(dev, start, n) \
228 __devm_release_region(dev, &iomem_resource, (start), (n))
229
230 extern void __devm_release_region(struct device *dev, struct resource *parent,
231 resource_size_t start, resource_size_t n);
232 extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
233 extern int iomem_is_exclusive(u64 addr);
234
235 extern int
236 walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
237 void *arg, int (*func)(unsigned long, unsigned long, void *));
238 extern int
239 walk_system_ram_res(u64 start, u64 end, void *arg,
240 int (*func)(u64, u64, void *));
241 extern int
242 walk_iomem_res(char *name, unsigned long flags, u64 start, u64 end, void *arg,
243 int (*func)(u64, u64, void *));
244
245 /* True if any part of r1 overlaps r2 */
resource_overlaps(struct resource * r1,struct resource * r2)246 static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
247 {
248 return (r1->start <= r2->end && r1->end >= r2->start);
249 }
250
251
252 #endif /* __ASSEMBLY__ */
253 #endif /* _LINUX_IOPORT_H */
254