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 struct resource *parent, *sibling, *child;
24};
25
26/*
27 * IO resources have these defined flags.
28 */
29#define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
30
31#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
32#define IORESOURCE_IO 0x00000100
33#define IORESOURCE_MEM 0x00000200
34#define IORESOURCE_IRQ 0x00000400
35#define IORESOURCE_DMA 0x00000800
36#define IORESOURCE_BUS 0x00001000
37
38#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
43
44#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
45#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
46
47#define IORESOURCE_MEM_64 0x00100000
48#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
49#define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
50
51#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
52#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
57/* PnP IRQ specific bits (IORESOURCE_BITS) */
58#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)
62#define IORESOURCE_IRQ_SHAREABLE (1<<4)
63#define IORESOURCE_IRQ_OPTIONAL (1<<5)
64
65/* PnP DMA specific bits (IORESOURCE_BITS) */
66#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
81/* PnP memory I/O specific bits (IORESOURCE_BITS) */
82#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
93/* PnP I/O specific bits (IORESOURCE_BITS) */
94#define IORESOURCE_IO_16BIT_ADDR (1<<0)
95#define IORESOURCE_IO_FIXED (1<<1)
96
97/* 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 */
101#define IORESOURCE_ROM_BIOS_COPY (1<<3) /* ROM is BIOS copy, resource field overlaid */
102
103/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
104#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
105
106
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
136/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
137extern struct resource ioport_resource;
138extern struct resource iomem_resource;
139
140extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
141extern int request_resource(struct resource *root, struct resource *new);
142extern int release_resource(struct resource *new);
143void release_child_resources(struct resource *new);
144extern void reserve_region_with_split(struct resource *root,
145 resource_size_t start, resource_size_t end,
146 const char *name);
147extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
148extern int insert_resource(struct resource *parent, struct resource *new);
149extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
150extern void arch_remove_reservations(struct resource *avail);
151extern int allocate_resource(struct resource *root, struct resource *new,
152 resource_size_t size, resource_size_t min,
153 resource_size_t max, resource_size_t align,
154 resource_size_t (*alignf)(void *,
155 const struct resource *,
156 resource_size_t,
157 resource_size_t),
158 void *alignf_data);
159struct resource *lookup_resource(struct resource *root, resource_size_t start);
160int adjust_resource(struct resource *res, resource_size_t start,
161 resource_size_t size);
162resource_size_t resource_alignment(struct resource *res);
163static inline resource_size_t resource_size(const struct resource *res)
164{
165 return res->end - res->start + 1;
166}
167static inline unsigned long resource_type(const struct resource *res)
168{
169 return res->flags & IORESOURCE_TYPE_BITS;
170}
171
172/* Convenience shorthand with allocation */
173#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)
175#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)
179#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
180
181extern struct resource * __request_region(struct resource *,
182 resource_size_t start,
183 resource_size_t n,
184 const char *name, int flags);
185
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
191extern int __check_region(struct resource *, resource_size_t, resource_size_t);
192extern void __release_region(struct resource *, resource_size_t,
193 resource_size_t);
194
195static inline int __deprecated check_region(resource_size_t s,
196 resource_size_t n)
197{
198 return __check_region(&ioport_resource, s, n);
199}
200
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
212#define devm_release_region(dev, start, n) \
213 __devm_release_region(dev, &ioport_resource, (start), (n))
214#define devm_release_mem_region(dev, start, n) \
215 __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);
219extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
220extern int iomem_is_exclusive(u64 addr);
221
222extern int
223walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
224 void *arg, int (*func)(unsigned long, unsigned long, void *));
225
226#endif /* __ASSEMBLY__ */
227#endif /* _LINUX_IOPORT_H */