39db059ffb8b3c342210e544b4f76b4d5a33690e
[linux-2.6.git] / include / linux / ioport.h
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 struct resource_list {
27         struct resource_list *next;
28         struct resource *res;
29         struct pci_dev *dev;
30 };
31
32 /*
33  * IO resources have these defined flags.
34  */
35 #define IORESOURCE_BITS         0x000000ff      /* Bus-specific bits */
36
37 #define IORESOURCE_IO           0x00000100      /* Resource type */
38 #define IORESOURCE_MEM          0x00000200
39 #define IORESOURCE_IRQ          0x00000400
40 #define IORESOURCE_DMA          0x00000800
41
42 #define IORESOURCE_PREFETCH     0x00001000      /* No side effects */
43 #define IORESOURCE_READONLY     0x00002000
44 #define IORESOURCE_CACHEABLE    0x00004000
45 #define IORESOURCE_RANGELENGTH  0x00008000
46 #define IORESOURCE_SHADOWABLE   0x00010000
47
48 #define IORESOURCE_SIZEALIGN    0x00020000      /* size indicates alignment */
49 #define IORESOURCE_STARTALIGN   0x00040000      /* start field is alignment */
50
51 #define IORESOURCE_DISABLED     0x10000000
52 #define IORESOURCE_UNSET        0x20000000
53 #define IORESOURCE_AUTO         0x40000000
54 #define IORESOURCE_BUSY         0x80000000      /* Driver has marked this resource busy */
55
56 /* PnP IRQ specific bits (IORESOURCE_BITS) */
57 #define IORESOURCE_IRQ_HIGHEDGE         (1<<0)
58 #define IORESOURCE_IRQ_LOWEDGE          (1<<1)
59 #define IORESOURCE_IRQ_HIGHLEVEL        (1<<2)
60 #define IORESOURCE_IRQ_LOWLEVEL         (1<<3)
61 #define IORESOURCE_IRQ_SHAREABLE        (1<<4)
62
63 /* PnP DMA specific bits (IORESOURCE_BITS) */
64 #define IORESOURCE_DMA_TYPE_MASK        (3<<0)
65 #define IORESOURCE_DMA_8BIT             (0<<0)
66 #define IORESOURCE_DMA_8AND16BIT        (1<<0)
67 #define IORESOURCE_DMA_16BIT            (2<<0)
68
69 #define IORESOURCE_DMA_MASTER           (1<<2)
70 #define IORESOURCE_DMA_BYTE             (1<<3)
71 #define IORESOURCE_DMA_WORD             (1<<4)
72
73 #define IORESOURCE_DMA_SPEED_MASK       (3<<6)
74 #define IORESOURCE_DMA_COMPATIBLE       (0<<6)
75 #define IORESOURCE_DMA_TYPEA            (1<<6)
76 #define IORESOURCE_DMA_TYPEB            (2<<6)
77 #define IORESOURCE_DMA_TYPEF            (3<<6)
78
79 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
80 #define IORESOURCE_MEM_WRITEABLE        (1<<0)  /* dup: IORESOURCE_READONLY */
81 #define IORESOURCE_MEM_CACHEABLE        (1<<1)  /* dup: IORESOURCE_CACHEABLE */
82 #define IORESOURCE_MEM_RANGELENGTH      (1<<2)  /* dup: IORESOURCE_RANGELENGTH */
83 #define IORESOURCE_MEM_TYPE_MASK        (3<<3)
84 #define IORESOURCE_MEM_8BIT             (0<<3)
85 #define IORESOURCE_MEM_16BIT            (1<<3)
86 #define IORESOURCE_MEM_8AND16BIT        (2<<3)
87 #define IORESOURCE_MEM_32BIT            (3<<3)
88 #define IORESOURCE_MEM_SHADOWABLE       (1<<5)  /* dup: IORESOURCE_SHADOWABLE */
89 #define IORESOURCE_MEM_EXPANSIONROM     (1<<6)
90
91 /* PnP I/O specific bits (IORESOURCE_BITS) */
92 #define IORESOURCE_IO_16BIT_ADDR        (1<<0)
93 #define IORESOURCE_IO_FIXED             (1<<1)
94
95 /* PCI ROM control bits (IORESOURCE_BITS) */
96 #define IORESOURCE_ROM_ENABLE           (1<<0)  /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
97 #define IORESOURCE_ROM_SHADOW           (1<<1)  /* ROM is copy at C000:0 */
98 #define IORESOURCE_ROM_COPY             (1<<2)  /* ROM is alloc'd copy, resource field overlaid */
99 #define IORESOURCE_ROM_BIOS_COPY        (1<<3)  /* ROM is BIOS copy, resource field overlaid */
100
101 /* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */
102 #define IORESOURCE_PCI_FIXED            (1<<4)  /* Do not move resource */
103
104 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
105 extern struct resource ioport_resource;
106 extern struct resource iomem_resource;
107
108 extern int request_resource(struct resource *root, struct resource *new);
109 extern int release_resource(struct resource *new);
110 extern int insert_resource(struct resource *parent, struct resource *new);
111 extern int allocate_resource(struct resource *root, struct resource *new,
112                              resource_size_t size, resource_size_t min,
113                              resource_size_t max, resource_size_t align,
114                              void (*alignf)(void *, struct resource *,
115                                             resource_size_t, resource_size_t),
116                              void *alignf_data);
117 int adjust_resource(struct resource *res, resource_size_t start,
118                     resource_size_t size);
119 resource_size_t resource_alignment(struct resource *res);
120
121 /* Convenience shorthand with allocation */
122 #define request_region(start,n,name)    __request_region(&ioport_resource, (start), (n), (name))
123 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name))
124 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
125
126 extern struct resource * __request_region(struct resource *,
127                                         resource_size_t start,
128                                         resource_size_t n, const char *name);
129
130 /* Compatibility cruft */
131 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
132 #define check_mem_region(start,n)       __check_region(&iomem_resource, (start), (n))
133 #define release_mem_region(start,n)     __release_region(&iomem_resource, (start), (n))
134
135 extern int __check_region(struct resource *, resource_size_t, resource_size_t);
136 extern void __release_region(struct resource *, resource_size_t,
137                                 resource_size_t);
138
139 static inline int __deprecated check_region(resource_size_t s,
140                                                 resource_size_t n)
141 {
142         return __check_region(&ioport_resource, s, n);
143 }
144
145 /* Wrappers for managed devices */
146 struct device;
147 #define devm_request_region(dev,start,n,name) \
148         __devm_request_region(dev, &ioport_resource, (start), (n), (name))
149 #define devm_request_mem_region(dev,start,n,name) \
150         __devm_request_region(dev, &iomem_resource, (start), (n), (name))
151
152 extern struct resource * __devm_request_region(struct device *dev,
153                                 struct resource *parent, resource_size_t start,
154                                 resource_size_t n, const char *name);
155
156 #define devm_release_region(start,n) \
157         __devm_release_region(dev, &ioport_resource, (start), (n))
158 #define devm_release_mem_region(start,n) \
159         __devm_release_region(dev, &iomem_resource, (start), (n))
160
161 extern void __devm_release_region(struct device *dev, struct resource *parent,
162                                   resource_size_t start, resource_size_t n);
163
164 #endif /* __ASSEMBLY__ */
165 #endif  /* _LINUX_IOPORT_H */