Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Bernhard Walle | c9cce83 | 2008-01-30 13:30:32 +0100 | [diff] [blame] | 11 | #ifndef __ASSEMBLY__ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 12 | #include <linux/compiler.h> |
Greg Kroah-Hartman | cf7c712 | 2006-06-12 15:49:31 -0700 | [diff] [blame] | 13 | #include <linux/types.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | /* |
| 15 | * Resources are tree-like, allowing |
| 16 | * nesting etc.. |
| 17 | */ |
| 18 | struct resource { |
Greg Kroah-Hartman | cf7c712 | 2006-06-12 15:49:31 -0700 | [diff] [blame] | 19 | resource_size_t start; |
| 20 | resource_size_t end; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | const char *name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Magnus Damm | c9f6616 | 2008-10-15 22:05:15 -0700 | [diff] [blame] | 37 | #define IORESOURCE_TYPE_BITS 0x00000f00 /* Resource type */ |
| 38 | #define IORESOURCE_IO 0x00000100 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | #define IORESOURCE_MEM 0x00000200 |
| 40 | #define IORESOURCE_IRQ 0x00000400 |
| 41 | #define IORESOURCE_DMA 0x00000800 |
| 42 | |
| 43 | #define IORESOURCE_PREFETCH 0x00001000 /* No side effects */ |
| 44 | #define IORESOURCE_READONLY 0x00002000 |
| 45 | #define IORESOURCE_CACHEABLE 0x00004000 |
| 46 | #define IORESOURCE_RANGELENGTH 0x00008000 |
| 47 | #define IORESOURCE_SHADOWABLE 0x00010000 |
Ivan Kokshaysky | 8845256 | 2008-03-30 19:50:14 +0400 | [diff] [blame] | 48 | |
| 49 | #define IORESOURCE_SIZEALIGN 0x00020000 /* size indicates alignment */ |
| 50 | #define IORESOURCE_STARTALIGN 0x00040000 /* start field is alignment */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | |
Yinghai Lu | 1f82de1 | 2009-04-23 20:48:32 -0700 | [diff] [blame] | 52 | #define IORESOURCE_MEM_64 0x00100000 |
| 53 | |
Arjan van de Ven | e8de148 | 2008-10-22 19:55:31 -0700 | [diff] [blame] | 54 | #define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | #define IORESOURCE_DISABLED 0x10000000 |
| 56 | #define IORESOURCE_UNSET 0x20000000 |
| 57 | #define IORESOURCE_AUTO 0x40000000 |
| 58 | #define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */ |
| 59 | |
Bjorn Helgaas | e9fe9e1 | 2008-06-09 16:52:04 -0700 | [diff] [blame] | 60 | /* PnP IRQ specific bits (IORESOURCE_BITS) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | #define IORESOURCE_IRQ_HIGHEDGE (1<<0) |
| 62 | #define IORESOURCE_IRQ_LOWEDGE (1<<1) |
| 63 | #define IORESOURCE_IRQ_HIGHLEVEL (1<<2) |
| 64 | #define IORESOURCE_IRQ_LOWLEVEL (1<<3) |
Bjorn Helgaas | c32928c | 2006-07-03 00:24:10 -0700 | [diff] [blame] | 65 | #define IORESOURCE_IRQ_SHAREABLE (1<<4) |
Bjorn Helgaas | d5ebde6 | 2008-06-27 16:57:14 -0600 | [diff] [blame] | 66 | #define IORESOURCE_IRQ_OPTIONAL (1<<5) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | |
Bjorn Helgaas | e9fe9e1 | 2008-06-09 16:52:04 -0700 | [diff] [blame] | 68 | /* PnP DMA specific bits (IORESOURCE_BITS) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | #define IORESOURCE_DMA_TYPE_MASK (3<<0) |
| 70 | #define IORESOURCE_DMA_8BIT (0<<0) |
| 71 | #define IORESOURCE_DMA_8AND16BIT (1<<0) |
| 72 | #define IORESOURCE_DMA_16BIT (2<<0) |
| 73 | |
| 74 | #define IORESOURCE_DMA_MASTER (1<<2) |
| 75 | #define IORESOURCE_DMA_BYTE (1<<3) |
| 76 | #define IORESOURCE_DMA_WORD (1<<4) |
| 77 | |
| 78 | #define IORESOURCE_DMA_SPEED_MASK (3<<6) |
| 79 | #define IORESOURCE_DMA_COMPATIBLE (0<<6) |
| 80 | #define IORESOURCE_DMA_TYPEA (1<<6) |
| 81 | #define IORESOURCE_DMA_TYPEB (2<<6) |
| 82 | #define IORESOURCE_DMA_TYPEF (3<<6) |
| 83 | |
Bjorn Helgaas | e9fe9e1 | 2008-06-09 16:52:04 -0700 | [diff] [blame] | 84 | /* PnP memory I/O specific bits (IORESOURCE_BITS) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | #define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */ |
| 86 | #define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */ |
| 87 | #define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */ |
| 88 | #define IORESOURCE_MEM_TYPE_MASK (3<<3) |
| 89 | #define IORESOURCE_MEM_8BIT (0<<3) |
| 90 | #define IORESOURCE_MEM_16BIT (1<<3) |
| 91 | #define IORESOURCE_MEM_8AND16BIT (2<<3) |
| 92 | #define IORESOURCE_MEM_32BIT (3<<3) |
| 93 | #define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */ |
| 94 | #define IORESOURCE_MEM_EXPANSIONROM (1<<6) |
| 95 | |
Bjorn Helgaas | 08c9f26 | 2008-06-27 16:57:03 -0600 | [diff] [blame] | 96 | /* PnP I/O specific bits (IORESOURCE_BITS) */ |
| 97 | #define IORESOURCE_IO_16BIT_ADDR (1<<0) |
| 98 | #define IORESOURCE_IO_FIXED (1<<1) |
| 99 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | /* PCI ROM control bits (IORESOURCE_BITS) */ |
| 101 | #define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */ |
| 102 | #define IORESOURCE_ROM_SHADOW (1<<1) /* ROM is copy at C000:0 */ |
| 103 | #define IORESOURCE_ROM_COPY (1<<2) /* ROM is alloc'd copy, resource field overlaid */ |
John Keller | a2302c6 | 2006-10-04 16:49:52 -0500 | [diff] [blame] | 104 | #define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | |
Ralf Baechle | fb0f2b4 | 2006-12-19 13:12:08 -0800 | [diff] [blame] | 106 | /* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */ |
| 107 | #define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */ |
| 108 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | /* PC/ISA/whatever - the normal PC address spaces: IO and memory */ |
| 110 | extern struct resource ioport_resource; |
| 111 | extern struct resource iomem_resource; |
| 112 | |
| 113 | extern int request_resource(struct resource *root, struct resource *new); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | extern int release_resource(struct resource *new); |
Yinghai Lu | 5eeec0e | 2009-12-22 15:02:22 -0800 | [diff] [blame] | 115 | void release_child_resources(struct resource *new); |
Yinghai Lu | 268364a | 2008-09-04 21:02:44 +0200 | [diff] [blame] | 116 | extern void reserve_region_with_split(struct resource *root, |
| 117 | resource_size_t start, resource_size_t end, |
| 118 | const char *name); |
Adrian Bunk | cd6ef2ad | 2006-06-30 02:15:42 -0700 | [diff] [blame] | 119 | extern int insert_resource(struct resource *parent, struct resource *new); |
Linus Torvalds | bef69ea | 2008-08-29 20:18:31 -0700 | [diff] [blame] | 120 | extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | extern int allocate_resource(struct resource *root, struct resource *new, |
Greg Kroah-Hartman | d75fc8b | 2006-06-12 16:09:23 -0700 | [diff] [blame] | 122 | resource_size_t size, resource_size_t min, |
| 123 | resource_size_t max, resource_size_t align, |
Dominik Brodowski | b26b2d4 | 2010-01-01 17:40:49 +0100 | [diff] [blame] | 124 | resource_size_t (*alignf)(void *, |
Dominik Brodowski | 3b7a17f | 2010-01-01 17:40:50 +0100 | [diff] [blame] | 125 | const struct resource *, |
Dominik Brodowski | b26b2d4 | 2010-01-01 17:40:49 +0100 | [diff] [blame] | 126 | resource_size_t, |
| 127 | resource_size_t), |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | void *alignf_data); |
Greg Kroah-Hartman | d75fc8b | 2006-06-12 16:09:23 -0700 | [diff] [blame] | 129 | int adjust_resource(struct resource *res, resource_size_t start, |
| 130 | resource_size_t size); |
Ivan Kokshaysky | 8845256 | 2008-03-30 19:50:14 +0400 | [diff] [blame] | 131 | resource_size_t resource_alignment(struct resource *res); |
Jean Delvare | f65380c | 2009-12-15 16:48:21 -0800 | [diff] [blame] | 132 | static inline resource_size_t resource_size(const struct resource *res) |
Magnus Damm | 1a4e564 | 2008-07-29 22:32:57 -0700 | [diff] [blame] | 133 | { |
| 134 | return res->end - res->start + 1; |
| 135 | } |
Jean Delvare | f65380c | 2009-12-15 16:48:21 -0800 | [diff] [blame] | 136 | static inline unsigned long resource_type(const struct resource *res) |
Magnus Damm | c9f6616 | 2008-10-15 22:05:15 -0700 | [diff] [blame] | 137 | { |
| 138 | return res->flags & IORESOURCE_TYPE_BITS; |
| 139 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | /* Convenience shorthand with allocation */ |
Arjan van de Ven | e8de148 | 2008-10-22 19:55:31 -0700 | [diff] [blame] | 142 | #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0) |
| 143 | #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl) |
| 144 | #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0) |
| 145 | #define request_mem_region_exclusive(start,n,name) \ |
| 146 | __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | #define rename_region(region, newname) do { (region)->name = (newname); } while (0) |
| 148 | |
Greg Kroah-Hartman | d75fc8b | 2006-06-12 16:09:23 -0700 | [diff] [blame] | 149 | extern struct resource * __request_region(struct resource *, |
| 150 | resource_size_t start, |
Randy Dunlap | 6ae301e | 2009-01-15 13:51:01 -0800 | [diff] [blame] | 151 | resource_size_t n, |
| 152 | const char *name, int flags); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | |
| 154 | /* Compatibility cruft */ |
| 155 | #define release_region(start,n) __release_region(&ioport_resource, (start), (n)) |
| 156 | #define check_mem_region(start,n) __check_region(&iomem_resource, (start), (n)) |
| 157 | #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n)) |
| 158 | |
Greg Kroah-Hartman | d75fc8b | 2006-06-12 16:09:23 -0700 | [diff] [blame] | 159 | extern int __check_region(struct resource *, resource_size_t, resource_size_t); |
| 160 | extern void __release_region(struct resource *, resource_size_t, |
| 161 | resource_size_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
Greg Kroah-Hartman | d75fc8b | 2006-06-12 16:09:23 -0700 | [diff] [blame] | 163 | static inline int __deprecated check_region(resource_size_t s, |
| 164 | resource_size_t n) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | { |
| 166 | return __check_region(&ioport_resource, s, n); |
| 167 | } |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 168 | |
| 169 | /* Wrappers for managed devices */ |
| 170 | struct device; |
| 171 | #define devm_request_region(dev,start,n,name) \ |
| 172 | __devm_request_region(dev, &ioport_resource, (start), (n), (name)) |
| 173 | #define devm_request_mem_region(dev,start,n,name) \ |
| 174 | __devm_request_region(dev, &iomem_resource, (start), (n), (name)) |
| 175 | |
| 176 | extern struct resource * __devm_request_region(struct device *dev, |
| 177 | struct resource *parent, resource_size_t start, |
| 178 | resource_size_t n, const char *name); |
| 179 | |
Hiroshi DOYU | dea420c | 2008-09-13 02:33:07 -0700 | [diff] [blame] | 180 | #define devm_release_region(dev, start, n) \ |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 181 | __devm_release_region(dev, &ioport_resource, (start), (n)) |
Hiroshi DOYU | dea420c | 2008-09-13 02:33:07 -0700 | [diff] [blame] | 182 | #define devm_release_mem_region(dev, start, n) \ |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 183 | __devm_release_region(dev, &iomem_resource, (start), (n)) |
| 184 | |
| 185 | extern void __devm_release_region(struct device *dev, struct resource *parent, |
| 186 | resource_size_t start, resource_size_t n); |
Suresh Siddha | 379daf6 | 2008-09-25 18:43:34 -0700 | [diff] [blame] | 187 | extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size); |
Arjan van de Ven | e8de148 | 2008-10-22 19:55:31 -0700 | [diff] [blame] | 188 | extern int iomem_is_exclusive(u64 addr); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 189 | |
KAMEZAWA Hiroyuki | 908eedc | 2009-09-22 16:45:46 -0700 | [diff] [blame] | 190 | extern int |
| 191 | walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages, |
| 192 | void *arg, int (*func)(unsigned long, unsigned long, void *)); |
| 193 | |
Bernhard Walle | c9cce83 | 2008-01-30 13:30:32 +0100 | [diff] [blame] | 194 | #endif /* __ASSEMBLY__ */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | #endif /* _LINUX_IOPORT_H */ |