blob: e885ba23de7017882457ff0dc2d6fbb6f6575b13 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/*
27 * IO resources have these defined flags.
28 */
29#define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
30
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070031#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
Magnus Dammc9f66162008-10-15 22:05:15 -070032#define IORESOURCE_IO 0x00000100
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define IORESOURCE_MEM 0x00000200
34#define IORESOURCE_IRQ 0x00000400
35#define IORESOURCE_DMA 0x00000800
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -070036#define IORESOURCE_BUS 0x00001000
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070038#define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
39#define IORESOURCE_READONLY 0x00004000
40#define IORESOURCE_CACHEABLE 0x00008000
41#define IORESOURCE_RANGELENGTH 0x00010000
42#define IORESOURCE_SHADOWABLE 0x00020000
Ivan Kokshaysky88452562008-03-30 19:50:14 +040043
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070044#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
45#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Yinghai Lu1f82de12009-04-23 20:48:32 -070047#define IORESOURCE_MEM_64 0x00100000
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -070048#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
Alan Cox8b6d0432010-03-29 19:38:00 +020049#define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
Yinghai Lu1f82de12009-04-23 20:48:32 -070050
Arjan van de Vene8de1482008-10-22 19:55:31 -070051#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#define IORESOURCE_DISABLED 0x10000000
53#define IORESOURCE_UNSET 0x20000000
54#define IORESOURCE_AUTO 0x40000000
55#define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
56
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070057/* PnP IRQ specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#define IORESOURCE_IRQ_HIGHEDGE (1<<0)
59#define IORESOURCE_IRQ_LOWEDGE (1<<1)
60#define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
61#define IORESOURCE_IRQ_LOWLEVEL (1<<3)
Bjorn Helgaasc32928c2006-07-03 00:24:10 -070062#define IORESOURCE_IRQ_SHAREABLE (1<<4)
Bjorn Helgaasd5ebde62008-06-27 16:57:14 -060063#define IORESOURCE_IRQ_OPTIONAL (1<<5)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070065/* PnP DMA specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#define IORESOURCE_DMA_TYPE_MASK (3<<0)
67#define IORESOURCE_DMA_8BIT (0<<0)
68#define IORESOURCE_DMA_8AND16BIT (1<<0)
69#define IORESOURCE_DMA_16BIT (2<<0)
70
71#define IORESOURCE_DMA_MASTER (1<<2)
72#define IORESOURCE_DMA_BYTE (1<<3)
73#define IORESOURCE_DMA_WORD (1<<4)
74
75#define IORESOURCE_DMA_SPEED_MASK (3<<6)
76#define IORESOURCE_DMA_COMPATIBLE (0<<6)
77#define IORESOURCE_DMA_TYPEA (1<<6)
78#define IORESOURCE_DMA_TYPEB (2<<6)
79#define IORESOURCE_DMA_TYPEF (3<<6)
80
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070081/* PnP memory I/O specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
83#define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
84#define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
85#define IORESOURCE_MEM_TYPE_MASK (3<<3)
86#define IORESOURCE_MEM_8BIT (0<<3)
87#define IORESOURCE_MEM_16BIT (1<<3)
88#define IORESOURCE_MEM_8AND16BIT (2<<3)
89#define IORESOURCE_MEM_32BIT (3<<3)
90#define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
91#define IORESOURCE_MEM_EXPANSIONROM (1<<6)
92
Bjorn Helgaas08c9f262008-06-27 16:57:03 -060093/* PnP I/O specific bits (IORESOURCE_BITS) */
94#define IORESOURCE_IO_16BIT_ADDR (1<<0)
95#define IORESOURCE_IO_FIXED (1<<1)
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/* PCI ROM control bits (IORESOURCE_BITS) */
98#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
99#define IORESOURCE_ROM_SHADOW (1<<1) /* ROM is copy at C000:0 */
100#define IORESOURCE_ROM_COPY (1<<2) /* ROM is alloc'd copy, resource field overlaid */
John Kellera2302c62006-10-04 16:49:52 -0500101#define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Ralf Baechlefb0f2b42006-12-19 13:12:08 -0800103/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
104#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
105
Uwe Kleine-Königa0e44d42011-07-25 17:13:00 -0700106
107/* helpers to define resources */
108#define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
109 { \
110 .start = (_start), \
111 .end = (_start) + (_size) - 1, \
112 .name = (_name), \
113 .flags = (_flags), \
114 }
115
116#define DEFINE_RES_IO_NAMED(_start, _size, _name) \
117 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
118#define DEFINE_RES_IO(_start, _size) \
119 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
120
121#define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
122 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
123#define DEFINE_RES_MEM(_start, _size) \
124 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
125
126#define DEFINE_RES_IRQ_NAMED(_irq, _name) \
127 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
128#define DEFINE_RES_IRQ(_irq) \
129 DEFINE_RES_IRQ_NAMED((_irq), NULL)
130
131#define DEFINE_RES_DMA_NAMED(_dma, _name) \
132 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
133#define DEFINE_RES_DMA(_dma) \
134 DEFINE_RES_DMA_NAMED((_dma), NULL)
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
137extern struct resource ioport_resource;
138extern struct resource iomem_resource;
139
Bjorn Helgaas66f12072010-03-11 17:01:09 -0700140extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141extern int request_resource(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142extern int release_resource(struct resource *new);
Yinghai Lu5eeec0e2009-12-22 15:02:22 -0800143void release_child_resources(struct resource *new);
Yinghai Lu268364a2008-09-04 21:02:44 +0200144extern void reserve_region_with_split(struct resource *root,
145 resource_size_t start, resource_size_t end,
146 const char *name);
Bjorn Helgaas66f12072010-03-11 17:01:09 -0700147extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
Adrian Bunkcd6ef2ad2006-06-30 02:15:42 -0700148extern int insert_resource(struct resource *parent, struct resource *new);
Linus Torvaldsbef69ea2008-08-29 20:18:31 -0700149extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
Bjorn Helgaasfcb11912010-12-16 10:38:46 -0700150extern void arch_remove_reservations(struct resource *avail);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151extern int allocate_resource(struct resource *root, struct resource *new,
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700152 resource_size_t size, resource_size_t min,
153 resource_size_t max, resource_size_t align,
Dominik Brodowskib26b2d42010-01-01 17:40:49 +0100154 resource_size_t (*alignf)(void *,
Dominik Brodowski3b7a17f2010-01-01 17:40:50 +0100155 const struct resource *,
Dominik Brodowskib26b2d42010-01-01 17:40:49 +0100156 resource_size_t,
157 resource_size_t),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 void *alignf_data);
Geert Uytterhoeven1c388912011-05-07 20:53:16 +0200159struct resource *lookup_resource(struct resource *root, resource_size_t start);
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700160int adjust_resource(struct resource *res, resource_size_t start,
161 resource_size_t size);
Ivan Kokshaysky88452562008-03-30 19:50:14 +0400162resource_size_t resource_alignment(struct resource *res);
Jean Delvaref65380c2009-12-15 16:48:21 -0800163static inline resource_size_t resource_size(const struct resource *res)
Magnus Damm1a4e5642008-07-29 22:32:57 -0700164{
165 return res->end - res->start + 1;
166}
Jean Delvaref65380c2009-12-15 16:48:21 -0800167static inline unsigned long resource_type(const struct resource *res)
Magnus Dammc9f66162008-10-15 22:05:15 -0700168{
169 return res->flags & IORESOURCE_TYPE_BITS;
170}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172/* Convenience shorthand with allocation */
Alan Cox8b6d0432010-03-29 19:38:00 +0200173#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
174#define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
Arjan van de Vene8de1482008-10-22 19:55:31 -0700175#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
176#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
177#define request_mem_region_exclusive(start,n,name) \
178 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
180
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700181extern struct resource * __request_region(struct resource *,
182 resource_size_t start,
Randy Dunlap6ae301e2009-01-15 13:51:01 -0800183 resource_size_t n,
184 const char *name, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186/* Compatibility cruft */
187#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
188#define check_mem_region(start,n) __check_region(&iomem_resource, (start), (n))
189#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
190
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700191extern int __check_region(struct resource *, resource_size_t, resource_size_t);
192extern void __release_region(struct resource *, resource_size_t,
193 resource_size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700195static inline int __deprecated check_region(resource_size_t s,
196 resource_size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
198 return __check_region(&ioport_resource, s, n);
199}
Tejun Heo9ac78492007-01-20 16:00:26 +0900200
201/* Wrappers for managed devices */
202struct device;
203#define devm_request_region(dev,start,n,name) \
204 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
205#define devm_request_mem_region(dev,start,n,name) \
206 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
207
208extern struct resource * __devm_request_region(struct device *dev,
209 struct resource *parent, resource_size_t start,
210 resource_size_t n, const char *name);
211
Hiroshi DOYUdea420c2008-09-13 02:33:07 -0700212#define devm_release_region(dev, start, n) \
Tejun Heo9ac78492007-01-20 16:00:26 +0900213 __devm_release_region(dev, &ioport_resource, (start), (n))
Hiroshi DOYUdea420c2008-09-13 02:33:07 -0700214#define devm_release_mem_region(dev, start, n) \
Tejun Heo9ac78492007-01-20 16:00:26 +0900215 __devm_release_region(dev, &iomem_resource, (start), (n))
216
217extern void __devm_release_region(struct device *dev, struct resource *parent,
218 resource_size_t start, resource_size_t n);
Suresh Siddha379daf62008-09-25 18:43:34 -0700219extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
Arjan van de Vene8de1482008-10-22 19:55:31 -0700220extern int iomem_is_exclusive(u64 addr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900221
KAMEZAWA Hiroyuki908eedc2009-09-22 16:45:46 -0700222extern int
223walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
224 void *arg, int (*func)(unsigned long, unsigned long, void *));
225
Bernhard Wallec9cce832008-01-30 13:30:32 +0100226#endif /* __ASSEMBLY__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#endif /* _LINUX_IOPORT_H */