blob: 2c5250222278069dabb31cf4dfbb8ce41fea95ca [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 */
Mark Brownc04a9cb2012-08-07 19:42:46 +010032#define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define IORESOURCE_MEM 0x00000200
Mark Brown72dcb112012-08-07 19:42:45 +010034#define IORESOURCE_REG 0x00000300 /* Register offsets */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define IORESOURCE_IRQ 0x00000400
36#define IORESOURCE_DMA 0x00000800
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -070037#define IORESOURCE_BUS 0x00001000
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070039#define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
40#define IORESOURCE_READONLY 0x00004000
41#define IORESOURCE_CACHEABLE 0x00008000
42#define IORESOURCE_RANGELENGTH 0x00010000
43#define IORESOURCE_SHADOWABLE 0x00020000
Ivan Kokshaysky88452562008-03-30 19:50:14 +040044
Bjorn Helgaascd7e9fc2010-03-05 10:47:26 -070045#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
46#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Yinghai Lu1f82de12009-04-23 20:48:32 -070048#define IORESOURCE_MEM_64 0x00100000
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -070049#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
Alan Cox8b6d0432010-03-29 19:38:00 +020050#define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
Yinghai Lu1f82de12009-04-23 20:48:32 -070051
Arjan van de Vene8de1482008-10-22 19:55:31 -070052#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#define IORESOURCE_DISABLED 0x10000000
Bjorn Helgaasd19cb802014-02-26 11:25:56 -070054#define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#define IORESOURCE_AUTO 0x40000000
56#define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
57
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070058/* PnP IRQ specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059#define IORESOURCE_IRQ_HIGHEDGE (1<<0)
60#define IORESOURCE_IRQ_LOWEDGE (1<<1)
61#define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
62#define IORESOURCE_IRQ_LOWLEVEL (1<<3)
Bjorn Helgaasc32928c2006-07-03 00:24:10 -070063#define IORESOURCE_IRQ_SHAREABLE (1<<4)
Bjorn Helgaasd5ebde62008-06-27 16:57:14 -060064#define IORESOURCE_IRQ_OPTIONAL (1<<5)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070066/* PnP DMA specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#define IORESOURCE_DMA_TYPE_MASK (3<<0)
68#define IORESOURCE_DMA_8BIT (0<<0)
69#define IORESOURCE_DMA_8AND16BIT (1<<0)
70#define IORESOURCE_DMA_16BIT (2<<0)
71
72#define IORESOURCE_DMA_MASTER (1<<2)
73#define IORESOURCE_DMA_BYTE (1<<3)
74#define IORESOURCE_DMA_WORD (1<<4)
75
76#define IORESOURCE_DMA_SPEED_MASK (3<<6)
77#define IORESOURCE_DMA_COMPATIBLE (0<<6)
78#define IORESOURCE_DMA_TYPEA (1<<6)
79#define IORESOURCE_DMA_TYPEB (2<<6)
80#define IORESOURCE_DMA_TYPEF (3<<6)
81
Bjorn Helgaase9fe9e12008-06-09 16:52:04 -070082/* PnP memory I/O specific bits (IORESOURCE_BITS) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
84#define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
85#define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
86#define IORESOURCE_MEM_TYPE_MASK (3<<3)
87#define IORESOURCE_MEM_8BIT (0<<3)
88#define IORESOURCE_MEM_16BIT (1<<3)
89#define IORESOURCE_MEM_8AND16BIT (2<<3)
90#define IORESOURCE_MEM_32BIT (3<<3)
91#define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
92#define IORESOURCE_MEM_EXPANSIONROM (1<<6)
93
Bjorn Helgaas08c9f262008-06-27 16:57:03 -060094/* PnP I/O specific bits (IORESOURCE_BITS) */
95#define IORESOURCE_IO_16BIT_ADDR (1<<0)
96#define IORESOURCE_IO_FIXED (1<<1)
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098/* PCI ROM control bits (IORESOURCE_BITS) */
99#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
100#define IORESOURCE_ROM_SHADOW (1<<1) /* ROM is copy at C000:0 */
101#define IORESOURCE_ROM_COPY (1<<2) /* ROM is alloc'd copy, resource field overlaid */
John Kellera2302c62006-10-04 16:49:52 -0500102#define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Ralf Baechlefb0f2b42006-12-19 13:12:08 -0800104/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
105#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
106
Uwe Kleine-Königa0e44d42011-07-25 17:13:00 -0700107
108/* helpers to define resources */
109#define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
110 { \
111 .start = (_start), \
112 .end = (_start) + (_size) - 1, \
113 .name = (_name), \
114 .flags = (_flags), \
115 }
116
117#define DEFINE_RES_IO_NAMED(_start, _size, _name) \
118 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
119#define DEFINE_RES_IO(_start, _size) \
120 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
121
122#define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
123 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
124#define DEFINE_RES_MEM(_start, _size) \
125 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
126
127#define DEFINE_RES_IRQ_NAMED(_irq, _name) \
128 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
129#define DEFINE_RES_IRQ(_irq) \
130 DEFINE_RES_IRQ_NAMED((_irq), NULL)
131
132#define DEFINE_RES_DMA_NAMED(_dma, _name) \
133 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
134#define DEFINE_RES_DMA(_dma) \
135 DEFINE_RES_DMA_NAMED((_dma), NULL)
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
138extern struct resource ioport_resource;
139extern struct resource iomem_resource;
140
Bjorn Helgaas66f12072010-03-11 17:01:09 -0700141extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142extern int request_resource(struct resource *root, struct resource *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143extern int release_resource(struct resource *new);
Yinghai Lu5eeec0e2009-12-22 15:02:22 -0800144void release_child_resources(struct resource *new);
Yinghai Lu268364a2008-09-04 21:02:44 +0200145extern void reserve_region_with_split(struct resource *root,
146 resource_size_t start, resource_size_t end,
147 const char *name);
Bjorn Helgaas66f12072010-03-11 17:01:09 -0700148extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
Adrian Bunkcd6ef2ad2006-06-30 02:15:42 -0700149extern int insert_resource(struct resource *parent, struct resource *new);
Linus Torvaldsbef69ea2008-08-29 20:18:31 -0700150extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
Bjorn Helgaasfcb11912010-12-16 10:38:46 -0700151extern void arch_remove_reservations(struct resource *avail);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152extern int allocate_resource(struct resource *root, struct resource *new,
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700153 resource_size_t size, resource_size_t min,
154 resource_size_t max, resource_size_t align,
Dominik Brodowskib26b2d42010-01-01 17:40:49 +0100155 resource_size_t (*alignf)(void *,
Dominik Brodowski3b7a17f2010-01-01 17:40:50 +0100156 const struct resource *,
Dominik Brodowskib26b2d42010-01-01 17:40:49 +0100157 resource_size_t,
158 resource_size_t),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 void *alignf_data);
Geert Uytterhoeven1c388912011-05-07 20:53:16 +0200160struct resource *lookup_resource(struct resource *root, resource_size_t start);
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700161int adjust_resource(struct resource *res, resource_size_t start,
162 resource_size_t size);
Ivan Kokshaysky88452562008-03-30 19:50:14 +0400163resource_size_t resource_alignment(struct resource *res);
Jean Delvaref65380c2009-12-15 16:48:21 -0800164static inline resource_size_t resource_size(const struct resource *res)
Magnus Damm1a4e5642008-07-29 22:32:57 -0700165{
166 return res->end - res->start + 1;
167}
Jean Delvaref65380c2009-12-15 16:48:21 -0800168static inline unsigned long resource_type(const struct resource *res)
Magnus Dammc9f66162008-10-15 22:05:15 -0700169{
170 return res->flags & IORESOURCE_TYPE_BITS;
171}
Bjorn Helgaas5edb93b2014-02-04 19:32:28 -0800172/* True iff r1 completely contains r2 */
173static inline bool resource_contains(struct resource *r1, struct resource *r2)
174{
175 if (resource_type(r1) != resource_type(r2))
176 return false;
177 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
178 return false;
179 return r1->start <= r2->start && r1->end >= r2->end;
180}
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183/* Convenience shorthand with allocation */
Alan Cox8b6d0432010-03-29 19:38:00 +0200184#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
185#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 -0700186#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
187#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
188#define request_mem_region_exclusive(start,n,name) \
189 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
191
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700192extern struct resource * __request_region(struct resource *,
193 resource_size_t start,
Randy Dunlap6ae301e2009-01-15 13:51:01 -0800194 resource_size_t n,
195 const char *name, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197/* Compatibility cruft */
198#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
199#define check_mem_region(start,n) __check_region(&iomem_resource, (start), (n))
200#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
201
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700202extern int __check_region(struct resource *, resource_size_t, resource_size_t);
203extern void __release_region(struct resource *, resource_size_t,
204 resource_size_t);
Toshi Kani825f7872013-04-29 15:08:19 -0700205#ifdef CONFIG_MEMORY_HOTREMOVE
206extern int release_mem_region_adjustable(struct resource *, resource_size_t,
207 resource_size_t);
208#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Greg Kroah-Hartmand75fc8b2006-06-12 16:09:23 -0700210static inline int __deprecated check_region(resource_size_t s,
211 resource_size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212{
213 return __check_region(&ioport_resource, s, n);
214}
Tejun Heo9ac78492007-01-20 16:00:26 +0900215
216/* Wrappers for managed devices */
217struct device;
Thierry Reding8d388212014-08-01 14:15:10 +0200218
219extern int devm_request_resource(struct device *dev, struct resource *root,
220 struct resource *new);
221extern void devm_release_resource(struct device *dev, struct resource *new);
222
Tejun Heo9ac78492007-01-20 16:00:26 +0900223#define devm_request_region(dev,start,n,name) \
224 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
225#define devm_request_mem_region(dev,start,n,name) \
226 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
227
228extern struct resource * __devm_request_region(struct device *dev,
229 struct resource *parent, resource_size_t start,
230 resource_size_t n, const char *name);
231
Hiroshi DOYUdea420c2008-09-13 02:33:07 -0700232#define devm_release_region(dev, start, n) \
Tejun Heo9ac78492007-01-20 16:00:26 +0900233 __devm_release_region(dev, &ioport_resource, (start), (n))
Hiroshi DOYUdea420c2008-09-13 02:33:07 -0700234#define devm_release_mem_region(dev, start, n) \
Tejun Heo9ac78492007-01-20 16:00:26 +0900235 __devm_release_region(dev, &iomem_resource, (start), (n))
236
237extern void __devm_release_region(struct device *dev, struct resource *parent,
238 resource_size_t start, resource_size_t n);
Suresh Siddha379daf62008-09-25 18:43:34 -0700239extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
Arjan van de Vene8de1482008-10-22 19:55:31 -0700240extern int iomem_is_exclusive(u64 addr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900241
KAMEZAWA Hiroyuki908eedc2009-09-22 16:45:46 -0700242extern int
243walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
244 void *arg, int (*func)(unsigned long, unsigned long, void *));
Vivek Goyal8c86e702014-08-08 14:25:50 -0700245extern int
246walk_system_ram_res(u64 start, u64 end, void *arg,
247 int (*func)(u64, u64, void *));
248extern int
249walk_iomem_res(char *name, unsigned long flags, u64 start, u64 end, void *arg,
250 int (*func)(u64, u64, void *));
KAMEZAWA Hiroyuki908eedc2009-09-22 16:45:46 -0700251
Wei Yang74d24b22012-04-26 15:32:55 +0800252/* True if any part of r1 overlaps r2 */
253static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
254{
255 return (r1->start <= r2->end && r1->end >= r2->start);
256}
257
258
Bernhard Wallec9cce832008-01-30 13:30:32 +0100259#endif /* __ASSEMBLY__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260#endif /* _LINUX_IOPORT_H */