blob: d5d40a9f7929fea5e0ba14b62f21b784c567bbf9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Bernhard Wallec9cce832008-01-30 13:30:32 +010011#ifndef __ASSEMBLY__
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/compiler.h>
Greg Kroah-Hartmancf7c7122006-06-12 15:49:31 -070013#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014/*
15 * Resources are tree-like, allowing
16 * nesting etc..
17 */
18struct resource {
Greg Kroah-Hartmancf7c7122006-06-12 15:49:31 -070019 resource_size_t start;
20 resource_size_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 unsigned long flags;
23 struct resource *parent, *sibling, *child;
24};
25
26struct 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
Ivan Kokshaysky88452562008-03-30 19:50:14 +040047
48#define IORESOURCE_SIZEALIGN 0x00020000 /* size indicates alignment */
49#define IORESOURCE_STARTALIGN 0x00040000 /* start field is alignment */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
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/* ISA 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)
Bjorn Helgaasc32928c2006-07-03 00:24:10 -070061#define IORESOURCE_IRQ_SHAREABLE (1<<4)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63/* ISA 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/* ISA 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/* PCI ROM control bits (IORESOURCE_BITS) */
92#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
93#define IORESOURCE_ROM_SHADOW (1<<1) /* ROM is copy at C000:0 */
94#define IORESOURCE_ROM_COPY (1<<2) /* ROM is alloc'd copy, resource field overlaid */
John Kellera2302c62006-10-04 16:49:52 -050095#define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Ralf Baechlefb0f2b42006-12-19 13:12:08 -080097/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
98#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
101extern struct resource ioport_resource;
102extern struct resource iomem_resource;
103
104extern int request_resource(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105extern int release_resource(struct resource *new);
Adrian Bunkcd6ef2ad2006-06-30 02:15:42 -0700106extern int insert_resource(struct resource *parent, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107extern int allocate_resource(struct resource *root, struct resource *new,
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700108 resource_size_t size, resource_size_t min,
109 resource_size_t max, resource_size_t align,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 void (*alignf)(void *, struct resource *,
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700111 resource_size_t, resource_size_t),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 void *alignf_data);
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700113int adjust_resource(struct resource *res, resource_size_t start,
114 resource_size_t size);
Ivan Kokshaysky88452562008-03-30 19:50:14 +0400115resource_size_t resource_alignment(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117/* Convenience shorthand with allocation */
118#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name))
119#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name))
120#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
121
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700122extern struct resource * __request_region(struct resource *,
123 resource_size_t start,
124 resource_size_t n, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/* Compatibility cruft */
127#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
128#define check_mem_region(start,n) __check_region(&iomem_resource, (start), (n))
129#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
130
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700131extern int __check_region(struct resource *, resource_size_t, resource_size_t);
132extern void __release_region(struct resource *, resource_size_t,
133 resource_size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700135static inline int __deprecated check_region(resource_size_t s,
136 resource_size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137{
138 return __check_region(&ioport_resource, s, n);
139}
Tejun Heo9ac78492007-01-20 16:00:26 +0900140
141/* Wrappers for managed devices */
142struct device;
143#define devm_request_region(dev,start,n,name) \
144 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
145#define devm_request_mem_region(dev,start,n,name) \
146 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
147
148extern struct resource * __devm_request_region(struct device *dev,
149 struct resource *parent, resource_size_t start,
150 resource_size_t n, const char *name);
151
152#define devm_release_region(start,n) \
153 __devm_release_region(dev, &ioport_resource, (start), (n))
154#define devm_release_mem_region(start,n) \
155 __devm_release_region(dev, &iomem_resource, (start), (n))
156
157extern void __devm_release_region(struct device *dev, struct resource *parent,
158 resource_size_t start, resource_size_t n);
159
Bernhard Wallec9cce832008-01-30 13:30:32 +0100160#endif /* __ASSEMBLY__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#endif /* _LINUX_IOPORT_H */