Pull out string hash to <linux/stringhash.h>
[linux-2.6-block.git] / include / linux / ioport.h
CommitLineData
1da177e4
LT
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
c9cce83d 11#ifndef __ASSEMBLY__
1da177e4 12#include <linux/compiler.h>
cf7c712c 13#include <linux/types.h>
1da177e4
LT
14/*
15 * Resources are tree-like, allowing
16 * nesting etc..
17 */
18struct resource {
cf7c712c
GKH
19 resource_size_t start;
20 resource_size_t end;
1da177e4 21 const char *name;
1da177e4 22 unsigned long flags;
43ee493b 23 unsigned long desc;
1da177e4
LT
24 struct resource *parent, *sibling, *child;
25};
26
1da177e4
LT
27/*
28 * IO resources have these defined flags.
29 */
30#define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
31
cd7e9fcd 32#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
c04a9cb8 33#define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
1da177e4 34#define IORESOURCE_MEM 0x00000200
72dcb119 35#define IORESOURCE_REG 0x00000300 /* Register offsets */
1da177e4
LT
36#define IORESOURCE_IRQ 0x00000400
37#define IORESOURCE_DMA 0x00000800
0f4050c7 38#define IORESOURCE_BUS 0x00001000
1da177e4 39
cd7e9fcd
BH
40#define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
41#define IORESOURCE_READONLY 0x00004000
42#define IORESOURCE_CACHEABLE 0x00008000
43#define IORESOURCE_RANGELENGTH 0x00010000
44#define IORESOURCE_SHADOWABLE 0x00020000
88452565 45
cd7e9fcd
BH
46#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
47#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
1da177e4 48
1f82de10 49#define IORESOURCE_MEM_64 0x00100000
9d7cca04 50#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
8b6d043b 51#define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
1f82de10 52
9babd5c8
TK
53#define IORESOURCE_EXT_TYPE_BITS 0x01000000 /* Resource extended types */
54#define IORESOURCE_SYSRAM 0x01000000 /* System RAM (modifier) */
55
e8de1481 56#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
9babd5c8 57
1da177e4 58#define IORESOURCE_DISABLED 0x10000000
d19cb803 59#define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
1da177e4
LT
60#define IORESOURCE_AUTO 0x40000000
61#define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
62
9babd5c8
TK
63/* I/O resource extended types */
64#define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM|IORESOURCE_SYSRAM)
65
e9fe9e18 66/* PnP IRQ specific bits (IORESOURCE_BITS) */
1da177e4
LT
67#define IORESOURCE_IRQ_HIGHEDGE (1<<0)
68#define IORESOURCE_IRQ_LOWEDGE (1<<1)
69#define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
70#define IORESOURCE_IRQ_LOWLEVEL (1<<3)
c32928c5 71#define IORESOURCE_IRQ_SHAREABLE (1<<4)
d5ebde6e 72#define IORESOURCE_IRQ_OPTIONAL (1<<5)
1da177e4 73
e9fe9e18 74/* PnP DMA specific bits (IORESOURCE_BITS) */
1da177e4
LT
75#define IORESOURCE_DMA_TYPE_MASK (3<<0)
76#define IORESOURCE_DMA_8BIT (0<<0)
77#define IORESOURCE_DMA_8AND16BIT (1<<0)
78#define IORESOURCE_DMA_16BIT (2<<0)
79
80#define IORESOURCE_DMA_MASTER (1<<2)
81#define IORESOURCE_DMA_BYTE (1<<3)
82#define IORESOURCE_DMA_WORD (1<<4)
83
84#define IORESOURCE_DMA_SPEED_MASK (3<<6)
85#define IORESOURCE_DMA_COMPATIBLE (0<<6)
86#define IORESOURCE_DMA_TYPEA (1<<6)
87#define IORESOURCE_DMA_TYPEB (2<<6)
88#define IORESOURCE_DMA_TYPEF (3<<6)
89
e9fe9e18 90/* PnP memory I/O specific bits (IORESOURCE_BITS) */
1da177e4
LT
91#define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
92#define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
93#define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
94#define IORESOURCE_MEM_TYPE_MASK (3<<3)
95#define IORESOURCE_MEM_8BIT (0<<3)
96#define IORESOURCE_MEM_16BIT (1<<3)
97#define IORESOURCE_MEM_8AND16BIT (2<<3)
98#define IORESOURCE_MEM_32BIT (3<<3)
99#define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
100#define IORESOURCE_MEM_EXPANSIONROM (1<<6)
101
08c9f262
BH
102/* PnP I/O specific bits (IORESOURCE_BITS) */
103#define IORESOURCE_IO_16BIT_ADDR (1<<0)
104#define IORESOURCE_IO_FIXED (1<<1)
91236ecc 105#define IORESOURCE_IO_SPARSE (1<<2)
08c9f262 106
1da177e4
LT
107/* PCI ROM control bits (IORESOURCE_BITS) */
108#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
0c0e0736 109#define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
1da177e4 110
fb0f2b40
RB
111/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
112#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
113
43ee493b
TK
114/*
115 * I/O Resource Descriptors
116 *
117 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
118 * for searching a specific resource range in the iomem table. Assign
119 * a new descriptor when a resource range supports the search interfaces.
120 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
121 */
122enum {
123 IORES_DESC_NONE = 0,
124 IORES_DESC_CRASH_KERNEL = 1,
125 IORES_DESC_ACPI_TABLES = 2,
126 IORES_DESC_ACPI_NV_STORAGE = 3,
127 IORES_DESC_PERSISTENT_MEMORY = 4,
128 IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
129};
a0e44d4a
UKK
130
131/* helpers to define resources */
132#define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
133 { \
134 .start = (_start), \
135 .end = (_start) + (_size) - 1, \
136 .name = (_name), \
137 .flags = (_flags), \
43ee493b 138 .desc = IORES_DESC_NONE, \
a0e44d4a
UKK
139 }
140
141#define DEFINE_RES_IO_NAMED(_start, _size, _name) \
142 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
143#define DEFINE_RES_IO(_start, _size) \
144 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
145
146#define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
147 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
148#define DEFINE_RES_MEM(_start, _size) \
149 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
150
151#define DEFINE_RES_IRQ_NAMED(_irq, _name) \
152 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
153#define DEFINE_RES_IRQ(_irq) \
154 DEFINE_RES_IRQ_NAMED((_irq), NULL)
155
156#define DEFINE_RES_DMA_NAMED(_dma, _name) \
157 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
158#define DEFINE_RES_DMA(_dma) \
159 DEFINE_RES_DMA_NAMED((_dma), NULL)
160
1da177e4
LT
161/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
162extern struct resource ioport_resource;
163extern struct resource iomem_resource;
164
66f1207b 165extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
1da177e4 166extern int request_resource(struct resource *root, struct resource *new);
1da177e4 167extern int release_resource(struct resource *new);
5eeec0ec 168void release_child_resources(struct resource *new);
268364a0
YL
169extern void reserve_region_with_split(struct resource *root,
170 resource_size_t start, resource_size_t end,
171 const char *name);
66f1207b 172extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
cd6ef2ad 173extern int insert_resource(struct resource *parent, struct resource *new);
bef69ea0 174extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
ff3cc952 175extern int remove_resource(struct resource *old);
fcb11918 176extern void arch_remove_reservations(struct resource *avail);
1da177e4 177extern int allocate_resource(struct resource *root, struct resource *new,
d75fc8bb
GKH
178 resource_size_t size, resource_size_t min,
179 resource_size_t max, resource_size_t align,
b26b2d49 180 resource_size_t (*alignf)(void *,
3b7a17fc 181 const struct resource *,
b26b2d49
DB
182 resource_size_t,
183 resource_size_t),
1da177e4 184 void *alignf_data);
1c388919 185struct resource *lookup_resource(struct resource *root, resource_size_t start);
d75fc8bb
GKH
186int adjust_resource(struct resource *res, resource_size_t start,
187 resource_size_t size);
88452565 188resource_size_t resource_alignment(struct resource *res);
f65380c0 189static inline resource_size_t resource_size(const struct resource *res)
1a4e564b
MD
190{
191 return res->end - res->start + 1;
192}
f65380c0 193static inline unsigned long resource_type(const struct resource *res)
c9f66169
MD
194{
195 return res->flags & IORESOURCE_TYPE_BITS;
196}
9babd5c8
TK
197static inline unsigned long resource_ext_type(const struct resource *res)
198{
199 return res->flags & IORESOURCE_EXT_TYPE_BITS;
200}
5edb93b8
BH
201/* True iff r1 completely contains r2 */
202static inline bool resource_contains(struct resource *r1, struct resource *r2)
203{
204 if (resource_type(r1) != resource_type(r2))
205 return false;
206 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
207 return false;
208 return r1->start <= r2->start && r1->end >= r2->end;
209}
210
1da177e4
LT
211
212/* Convenience shorthand with allocation */
8b6d043b
AC
213#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
214#define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
e8de1481
AV
215#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
216#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
217#define request_mem_region_exclusive(start,n,name) \
218 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
1da177e4
LT
219#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
220
d75fc8bb
GKH
221extern struct resource * __request_region(struct resource *,
222 resource_size_t start,
6ae301e8
RD
223 resource_size_t n,
224 const char *name, int flags);
1da177e4
LT
225
226/* Compatibility cruft */
227#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
1da177e4
LT
228#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
229
d75fc8bb
GKH
230extern void __release_region(struct resource *, resource_size_t,
231 resource_size_t);
825f787b
TK
232#ifdef CONFIG_MEMORY_HOTREMOVE
233extern int release_mem_region_adjustable(struct resource *, resource_size_t,
234 resource_size_t);
235#endif
1da177e4 236
9ac7849e
TH
237/* Wrappers for managed devices */
238struct device;
8d38821c
TR
239
240extern int devm_request_resource(struct device *dev, struct resource *root,
241 struct resource *new);
242extern void devm_release_resource(struct device *dev, struct resource *new);
243
9ac7849e
TH
244#define devm_request_region(dev,start,n,name) \
245 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
246#define devm_request_mem_region(dev,start,n,name) \
247 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
248
249extern struct resource * __devm_request_region(struct device *dev,
250 struct resource *parent, resource_size_t start,
251 resource_size_t n, const char *name);
252
dea420ce 253#define devm_release_region(dev, start, n) \
9ac7849e 254 __devm_release_region(dev, &ioport_resource, (start), (n))
dea420ce 255#define devm_release_mem_region(dev, start, n) \
9ac7849e
TH
256 __devm_release_region(dev, &iomem_resource, (start), (n))
257
258extern void __devm_release_region(struct device *dev, struct resource *parent,
259 resource_size_t start, resource_size_t n);
379daf62 260extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
e8de1481 261extern int iomem_is_exclusive(u64 addr);
9ac7849e 262
908eedc6
KH
263extern int
264walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
265 void *arg, int (*func)(unsigned long, unsigned long, void *));
8c86e70a
VG
266extern int
267walk_system_ram_res(u64 start, u64 end, void *arg,
268 int (*func)(u64, u64, void *));
269extern int
3f33647c
TK
270walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
271 void *arg, int (*func)(u64, u64, void *));
908eedc6 272
74d24b21
WY
273/* True if any part of r1 overlaps r2 */
274static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
275{
276 return (r1->start <= r2->end && r1->end >= r2->start);
277}
278
279
c9cce83d 280#endif /* __ASSEMBLY__ */
1da177e4 281#endif /* _LINUX_IOPORT_H */