blob: 71ab79da7e7f6b3a12019849978e2da58a00b61c [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
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070037#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
Magnus Dammc9f66162008-10-15 22:05:15 -070038#define IORESOURCE_IO 0x00000100
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#define IORESOURCE_MEM 0x00000200
40#define IORESOURCE_IRQ 0x00000400
41#define IORESOURCE_DMA 0x00000800
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -070042#define IORESOURCE_BUS 0x00001000
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070044#define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
45#define IORESOURCE_READONLY 0x00004000
46#define IORESOURCE_CACHEABLE 0x00008000
47#define IORESOURCE_RANGELENGTH 0x00010000
48#define IORESOURCE_SHADOWABLE 0x00020000
Ivan Kokshaysky88452562008-03-30 19:50:14 +040049
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070050#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
51#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Yinghai Lu1f82de12009-04-23 20:48:32 -070053#define IORESOURCE_MEM_64 0x00100000
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -070054#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
Yinghai Lu1f82de12009-04-23 20:48:32 -070055
Arjan van de Vene8de1482008-10-22 19:55:31 -070056#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#define IORESOURCE_DISABLED 0x10000000
58#define IORESOURCE_UNSET 0x20000000
59#define IORESOURCE_AUTO 0x40000000
60#define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
61
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070062/* PnP IRQ specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#define IORESOURCE_IRQ_HIGHEDGE (1<<0)
64#define IORESOURCE_IRQ_LOWEDGE (1<<1)
65#define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
66#define IORESOURCE_IRQ_LOWLEVEL (1<<3)
Bjorn Helgaasc32928c2006-07-03 00:24:10 -070067#define IORESOURCE_IRQ_SHAREABLE (1<<4)
Bjorn Helgaasd5ebde62008-06-27 16:57:14 -060068#define IORESOURCE_IRQ_OPTIONAL (1<<5)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070070/* PnP DMA specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#define IORESOURCE_DMA_TYPE_MASK (3<<0)
72#define IORESOURCE_DMA_8BIT (0<<0)
73#define IORESOURCE_DMA_8AND16BIT (1<<0)
74#define IORESOURCE_DMA_16BIT (2<<0)
75
76#define IORESOURCE_DMA_MASTER (1<<2)
77#define IORESOURCE_DMA_BYTE (1<<3)
78#define IORESOURCE_DMA_WORD (1<<4)
79
80#define IORESOURCE_DMA_SPEED_MASK (3<<6)
81#define IORESOURCE_DMA_COMPATIBLE (0<<6)
82#define IORESOURCE_DMA_TYPEA (1<<6)
83#define IORESOURCE_DMA_TYPEB (2<<6)
84#define IORESOURCE_DMA_TYPEF (3<<6)
85
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070086/* PnP memory I/O specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
88#define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
89#define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
90#define IORESOURCE_MEM_TYPE_MASK (3<<3)
91#define IORESOURCE_MEM_8BIT (0<<3)
92#define IORESOURCE_MEM_16BIT (1<<3)
93#define IORESOURCE_MEM_8AND16BIT (2<<3)
94#define IORESOURCE_MEM_32BIT (3<<3)
95#define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
96#define IORESOURCE_MEM_EXPANSIONROM (1<<6)
97
Bjorn Helgaas08c9f262008-06-27 16:57:03 -060098/* PnP I/O specific bits (IORESOURCE_BITS) */
99#define IORESOURCE_IO_16BIT_ADDR (1<<0)
100#define IORESOURCE_IO_FIXED (1<<1)
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102/* PCI ROM control bits (IORESOURCE_BITS) */
103#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
104#define IORESOURCE_ROM_SHADOW (1<<1) /* ROM is copy at C000:0 */
105#define IORESOURCE_ROM_COPY (1<<2) /* ROM is alloc'd copy, resource field overlaid */
John Kellera2302c62006-10-04 16:49:52 -0500106#define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Ralf Baechlefb0f2b42006-12-19 13:12:08 -0800108/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
109#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
112extern struct resource ioport_resource;
113extern struct resource iomem_resource;
114
115extern int request_resource(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116extern int release_resource(struct resource *new);
Yinghai Lu5eeec0e2009-12-22 15:02:22 -0800117void release_child_resources(struct resource *new);
Yinghai Lu268364a2008-09-04 21:02:44 +0200118extern void reserve_region_with_split(struct resource *root,
119 resource_size_t start, resource_size_t end,
120 const char *name);
Adrian Bunkcd6ef2ad2006-06-30 02:15:42 -0700121extern int insert_resource(struct resource *parent, struct resource *new);
Linus Torvaldsbef69ea2008-08-29 20:18:31 -0700122extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123extern int allocate_resource(struct resource *root, struct resource *new,
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700124 resource_size_t size, resource_size_t min,
125 resource_size_t max, resource_size_t align,
Dominik Brodowskib26b2d42010-01-01 17:40:49 +0100126 resource_size_t (*alignf)(void *,
Dominik Brodowski3b7a17f2010-01-01 17:40:50 +0100127 const struct resource *,
Dominik Brodowskib26b2d42010-01-01 17:40:49 +0100128 resource_size_t,
129 resource_size_t),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 void *alignf_data);
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700131int adjust_resource(struct resource *res, resource_size_t start,
132 resource_size_t size);
Ivan Kokshaysky88452562008-03-30 19:50:14 +0400133resource_size_t resource_alignment(struct resource *res);
Jean Delvaref65380c2009-12-15 16:48:21 -0800134static inline resource_size_t resource_size(const struct resource *res)
Magnus Damm1a4e5642008-07-29 22:32:57 -0700135{
136 return res->end - res->start + 1;
137}
Jean Delvaref65380c2009-12-15 16:48:21 -0800138static inline unsigned long resource_type(const struct resource *res)
Magnus Dammc9f66162008-10-15 22:05:15 -0700139{
140 return res->flags & IORESOURCE_TYPE_BITS;
141}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143/* Convenience shorthand with allocation */
Arjan van de Vene8de1482008-10-22 19:55:31 -0700144#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
145#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
146#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
147#define request_mem_region_exclusive(start,n,name) \
148 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
150
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700151extern struct resource * __request_region(struct resource *,
152 resource_size_t start,
Randy Dunlap6ae301e2009-01-15 13:51:01 -0800153 resource_size_t n,
154 const char *name, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156/* Compatibility cruft */
157#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
158#define check_mem_region(start,n) __check_region(&iomem_resource, (start), (n))
159#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
160
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700161extern int __check_region(struct resource *, resource_size_t, resource_size_t);
162extern void __release_region(struct resource *, resource_size_t,
163 resource_size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700165static inline int __deprecated check_region(resource_size_t s,
166 resource_size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
168 return __check_region(&ioport_resource, s, n);
169}
Tejun Heo9ac78492007-01-20 16:00:26 +0900170
171/* Wrappers for managed devices */
172struct device;
173#define devm_request_region(dev,start,n,name) \
174 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
175#define devm_request_mem_region(dev,start,n,name) \
176 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
177
178extern struct resource * __devm_request_region(struct device *dev,
179 struct resource *parent, resource_size_t start,
180 resource_size_t n, const char *name);
181
Hiroshi DOYUdea420c2008-09-13 02:33:07 -0700182#define devm_release_region(dev, start, n) \
Tejun Heo9ac78492007-01-20 16:00:26 +0900183 __devm_release_region(dev, &ioport_resource, (start), (n))
Hiroshi DOYUdea420c2008-09-13 02:33:07 -0700184#define devm_release_mem_region(dev, start, n) \
Tejun Heo9ac78492007-01-20 16:00:26 +0900185 __devm_release_region(dev, &iomem_resource, (start), (n))
186
187extern void __devm_release_region(struct device *dev, struct resource *parent,
188 resource_size_t start, resource_size_t n);
Suresh Siddha379daf62008-09-25 18:43:34 -0700189extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
Arjan van de Vene8de1482008-10-22 19:55:31 -0700190extern int iomem_is_exclusive(u64 addr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900191
KAMEZAWA Hiroyuki908eedc2009-09-22 16:45:46 -0700192extern int
193walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
194 void *arg, int (*func)(unsigned long, unsigned long, void *));
195
Bernhard Wallec9cce832008-01-30 13:30:32 +0100196#endif /* __ASSEMBLY__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197#endif /* _LINUX_IOPORT_H */