Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
11#ifndef __ASSEMBLY__
12#include <linux/compiler.h>
13#include <linux/types.h>
14/*
15 * Resources are tree-like, allowing
16 * nesting etc..
17 */
18struct resource {
19 resource_size_t start;
20 resource_size_t end;
21 const char *name;
22 unsigned long flags;
23 unsigned long desc;
24 struct resource *parent, *sibling, *child;
25};
26
27/*
28 * IO resources have these defined flags.
29 *
30 * PCI devices expose these flags to userspace in the "resource" sysfs file,
31 * so don't move them.
32 */
33#define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
34
35#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
36#define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
37#define IORESOURCE_MEM 0x00000200
38#define IORESOURCE_REG 0x00000300 /* Register offsets */
39#define IORESOURCE_IRQ 0x00000400
40#define IORESOURCE_DMA 0x00000800
41#define IORESOURCE_BUS 0x00001000
42
43#define IORESOURCE_PREFETCH 0x00002000 /* No side effects */
44#define IORESOURCE_READONLY 0x00004000
45#define IORESOURCE_CACHEABLE 0x00008000
46#define IORESOURCE_RANGELENGTH 0x00010000
47#define IORESOURCE_SHADOWABLE 0x00020000
48
49#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
50#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
51
52#define IORESOURCE_MEM_64 0x00100000
53#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
54#define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
55
56#define IORESOURCE_EXT_TYPE_BITS 0x01000000 /* Resource extended types */
57#define IORESOURCE_SYSRAM 0x01000000 /* System RAM (modifier) */
58
59#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
60
61#define IORESOURCE_DISABLED 0x10000000
62#define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
63#define IORESOURCE_AUTO 0x40000000
64#define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
65
66/* I/O resource extended types */
67#define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM|IORESOURCE_SYSRAM)
68
69/* PnP IRQ specific bits (IORESOURCE_BITS) */
70#define IORESOURCE_IRQ_HIGHEDGE (1<<0)
71#define IORESOURCE_IRQ_LOWEDGE (1<<1)
72#define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
73#define IORESOURCE_IRQ_LOWLEVEL (1<<3)
74#define IORESOURCE_IRQ_SHAREABLE (1<<4)
75#define IORESOURCE_IRQ_OPTIONAL (1<<5)
76
77/* PnP DMA specific bits (IORESOURCE_BITS) */
78#define IORESOURCE_DMA_TYPE_MASK (3<<0)
79#define IORESOURCE_DMA_8BIT (0<<0)
80#define IORESOURCE_DMA_8AND16BIT (1<<0)
81#define IORESOURCE_DMA_16BIT (2<<0)
82
83#define IORESOURCE_DMA_MASTER (1<<2)
84#define IORESOURCE_DMA_BYTE (1<<3)
85#define IORESOURCE_DMA_WORD (1<<4)
86
87#define IORESOURCE_DMA_SPEED_MASK (3<<6)
88#define IORESOURCE_DMA_COMPATIBLE (0<<6)
89#define IORESOURCE_DMA_TYPEA (1<<6)
90#define IORESOURCE_DMA_TYPEB (2<<6)
91#define IORESOURCE_DMA_TYPEF (3<<6)
92
93/* PnP memory I/O specific bits (IORESOURCE_BITS) */
94#define IORESOURCE_MEM_WRITEABLE (1<<0) /* dup: IORESOURCE_READONLY */
95#define IORESOURCE_MEM_CACHEABLE (1<<1) /* dup: IORESOURCE_CACHEABLE */
96#define IORESOURCE_MEM_RANGELENGTH (1<<2) /* dup: IORESOURCE_RANGELENGTH */
97#define IORESOURCE_MEM_TYPE_MASK (3<<3)
98#define IORESOURCE_MEM_8BIT (0<<3)
99#define IORESOURCE_MEM_16BIT (1<<3)
100#define IORESOURCE_MEM_8AND16BIT (2<<3)
101#define IORESOURCE_MEM_32BIT (3<<3)
102#define IORESOURCE_MEM_SHADOWABLE (1<<5) /* dup: IORESOURCE_SHADOWABLE */
103#define IORESOURCE_MEM_EXPANSIONROM (1<<6)
104
105/* PnP I/O specific bits (IORESOURCE_BITS) */
106#define IORESOURCE_IO_16BIT_ADDR (1<<0)
107#define IORESOURCE_IO_FIXED (1<<1)
108#define IORESOURCE_IO_SPARSE (1<<2)
109
110/* PCI ROM control bits (IORESOURCE_BITS) */
111#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
112#define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
113
114/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
115#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
116#define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
117
118/*
119 * I/O Resource Descriptors
120 *
121 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
122 * for searching a specific resource range in the iomem table. Assign
123 * a new descriptor when a resource range supports the search interfaces.
124 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
125 */
126enum {
127 IORES_DESC_NONE = 0,
128 IORES_DESC_CRASH_KERNEL = 1,
129 IORES_DESC_ACPI_TABLES = 2,
130 IORES_DESC_ACPI_NV_STORAGE = 3,
131 IORES_DESC_PERSISTENT_MEMORY = 4,
132 IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
133};
134
135/* helpers to define resources */
136#define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
137 { \
138 .start = (_start), \
139 .end = (_start) + (_size) - 1, \
140 .name = (_name), \
141 .flags = (_flags), \
142 .desc = IORES_DESC_NONE, \
143 }
144
145#define DEFINE_RES_IO_NAMED(_start, _size, _name) \
146 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
147#define DEFINE_RES_IO(_start, _size) \
148 DEFINE_RES_IO_NAMED((_start), (_size), NULL)
149
150#define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
151 DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
152#define DEFINE_RES_MEM(_start, _size) \
153 DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
154
155#define DEFINE_RES_IRQ_NAMED(_irq, _name) \
156 DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
157#define DEFINE_RES_IRQ(_irq) \
158 DEFINE_RES_IRQ_NAMED((_irq), NULL)
159
160#define DEFINE_RES_DMA_NAMED(_dma, _name) \
161 DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
162#define DEFINE_RES_DMA(_dma) \
163 DEFINE_RES_DMA_NAMED((_dma), NULL)
164
165/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
166extern struct resource ioport_resource;
167extern struct resource iomem_resource;
168
169extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
170extern int request_resource(struct resource *root, struct resource *new);
171extern int release_resource(struct resource *new);
172void release_child_resources(struct resource *new);
173extern void reserve_region_with_split(struct resource *root,
174 resource_size_t start, resource_size_t end,
175 const char *name);
176extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
177extern int insert_resource(struct resource *parent, struct resource *new);
178extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
179extern int remove_resource(struct resource *old);
180extern void arch_remove_reservations(struct resource *avail);
181extern int allocate_resource(struct resource *root, struct resource *new,
182 resource_size_t size, resource_size_t min,
183 resource_size_t max, resource_size_t align,
184 resource_size_t (*alignf)(void *,
185 const struct resource *,
186 resource_size_t,
187 resource_size_t),
188 void *alignf_data);
189struct resource *lookup_resource(struct resource *root, resource_size_t start);
190int adjust_resource(struct resource *res, resource_size_t start,
191 resource_size_t size);
192resource_size_t resource_alignment(struct resource *res);
193static inline resource_size_t resource_size(const struct resource *res)
194{
195 return res->end - res->start + 1;
196}
197static inline unsigned long resource_type(const struct resource *res)
198{
199 return res->flags & IORESOURCE_TYPE_BITS;
200}
201static inline unsigned long resource_ext_type(const struct resource *res)
202{
203 return res->flags & IORESOURCE_EXT_TYPE_BITS;
204}
205/* True iff r1 completely contains r2 */
206static inline bool resource_contains(struct resource *r1, struct resource *r2)
207{
208 if (resource_type(r1) != resource_type(r2))
209 return false;
210 if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
211 return false;
212 return r1->start <= r2->start && r1->end >= r2->end;
213}
214
215
216/* Convenience shorthand with allocation */
217#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
218#define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
219#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
220#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
221#define request_mem_region_exclusive(start,n,name) \
222 __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
223#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
224
225extern struct resource * __request_region(struct resource *,
226 resource_size_t start,
227 resource_size_t n,
228 const char *name, int flags);
229
230/* Compatibility cruft */
231#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
232#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
233
234extern void __release_region(struct resource *, resource_size_t,
235 resource_size_t);
236#ifdef CONFIG_MEMORY_HOTREMOVE
237extern int release_mem_region_adjustable(struct resource *, resource_size_t,
238 resource_size_t);
239#endif
240
241/* Wrappers for managed devices */
242struct device;
243
244extern int devm_request_resource(struct device *dev, struct resource *root,
245 struct resource *new);
246extern void devm_release_resource(struct device *dev, struct resource *new);
247
248#define devm_request_region(dev,start,n,name) \
249 __devm_request_region(dev, &ioport_resource, (start), (n), (name))
250#define devm_request_mem_region(dev,start,n,name) \
251 __devm_request_region(dev, &iomem_resource, (start), (n), (name))
252
253extern struct resource * __devm_request_region(struct device *dev,
254 struct resource *parent, resource_size_t start,
255 resource_size_t n, const char *name);
256
257#define devm_release_region(dev, start, n) \
258 __devm_release_region(dev, &ioport_resource, (start), (n))
259#define devm_release_mem_region(dev, start, n) \
260 __devm_release_region(dev, &iomem_resource, (start), (n))
261
262extern void __devm_release_region(struct device *dev, struct resource *parent,
263 resource_size_t start, resource_size_t n);
264extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
265extern int iomem_is_exclusive(u64 addr);
266
267extern int
268walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
269 void *arg, int (*func)(unsigned long, unsigned long, void *));
270extern int
271walk_system_ram_res(u64 start, u64 end, void *arg,
272 int (*func)(u64, u64, void *));
273extern int
274walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
275 void *arg, int (*func)(u64, u64, void *));
276
277/* True if any part of r1 overlaps r2 */
278static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
279{
280 return (r1->start <= r2->end && r1->end >= r2->start);
281}
282
283
284#endif /* __ASSEMBLY__ */
285#endif /* _LINUX_IOPORT_H */