xref: /linux-6.15/include/linux/ioport.h (revision 1795cf48)
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  */
18 struct 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 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 
37 #define IORESOURCE_IO		0x00000100	/* Resource type */
38 #define IORESOURCE_MEM		0x00000200
39 #define IORESOURCE_IRQ		0x00000400
40 #define IORESOURCE_DMA		0x00000800
41 
42 #define IORESOURCE_PREFETCH	0x00001000	/* No side effects */
43 #define IORESOURCE_READONLY	0x00002000
44 #define IORESOURCE_CACHEABLE	0x00004000
45 #define IORESOURCE_RANGELENGTH	0x00008000
46 #define IORESOURCE_SHADOWABLE	0x00010000
47 
48 #define IORESOURCE_SIZEALIGN	0x00020000	/* size indicates alignment */
49 #define IORESOURCE_STARTALIGN	0x00040000	/* start field is alignment */
50 
51 #define IORESOURCE_DISABLED	0x10000000
52 #define IORESOURCE_UNSET	0x20000000
53 #define IORESOURCE_AUTO		0x40000000
54 #define IORESOURCE_BUSY		0x80000000	/* Driver has marked this resource busy */
55 
56 /* PnP IRQ specific bits (IORESOURCE_BITS) */
57 #define IORESOURCE_IRQ_HIGHEDGE		(1<<0)
58 #define IORESOURCE_IRQ_LOWEDGE		(1<<1)
59 #define IORESOURCE_IRQ_HIGHLEVEL	(1<<2)
60 #define IORESOURCE_IRQ_LOWLEVEL		(1<<3)
61 #define IORESOURCE_IRQ_SHAREABLE	(1<<4)
62 #define IORESOURCE_IRQ_OPTIONAL 	(1<<5)
63 
64 /* PnP DMA specific bits (IORESOURCE_BITS) */
65 #define IORESOURCE_DMA_TYPE_MASK	(3<<0)
66 #define IORESOURCE_DMA_8BIT		(0<<0)
67 #define IORESOURCE_DMA_8AND16BIT	(1<<0)
68 #define IORESOURCE_DMA_16BIT		(2<<0)
69 
70 #define IORESOURCE_DMA_MASTER		(1<<2)
71 #define IORESOURCE_DMA_BYTE		(1<<3)
72 #define IORESOURCE_DMA_WORD		(1<<4)
73 
74 #define IORESOURCE_DMA_SPEED_MASK	(3<<6)
75 #define IORESOURCE_DMA_COMPATIBLE	(0<<6)
76 #define IORESOURCE_DMA_TYPEA		(1<<6)
77 #define IORESOURCE_DMA_TYPEB		(2<<6)
78 #define IORESOURCE_DMA_TYPEF		(3<<6)
79 
80 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
81 #define IORESOURCE_MEM_WRITEABLE	(1<<0)	/* dup: IORESOURCE_READONLY */
82 #define IORESOURCE_MEM_CACHEABLE	(1<<1)	/* dup: IORESOURCE_CACHEABLE */
83 #define IORESOURCE_MEM_RANGELENGTH	(1<<2)	/* dup: IORESOURCE_RANGELENGTH */
84 #define IORESOURCE_MEM_TYPE_MASK	(3<<3)
85 #define IORESOURCE_MEM_8BIT		(0<<3)
86 #define IORESOURCE_MEM_16BIT		(1<<3)
87 #define IORESOURCE_MEM_8AND16BIT	(2<<3)
88 #define IORESOURCE_MEM_32BIT		(3<<3)
89 #define IORESOURCE_MEM_SHADOWABLE	(1<<5)	/* dup: IORESOURCE_SHADOWABLE */
90 #define IORESOURCE_MEM_EXPANSIONROM	(1<<6)
91 
92 /* PnP I/O specific bits (IORESOURCE_BITS) */
93 #define IORESOURCE_IO_16BIT_ADDR	(1<<0)
94 #define IORESOURCE_IO_FIXED		(1<<1)
95 
96 /* PCI ROM control bits (IORESOURCE_BITS) */
97 #define IORESOURCE_ROM_ENABLE		(1<<0)	/* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
98 #define IORESOURCE_ROM_SHADOW		(1<<1)	/* ROM is copy at C000:0 */
99 #define IORESOURCE_ROM_COPY		(1<<2)	/* ROM is alloc'd copy, resource field overlaid */
100 #define IORESOURCE_ROM_BIOS_COPY	(1<<3)	/* ROM is BIOS copy, resource field overlaid */
101 
102 /* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */
103 #define IORESOURCE_PCI_FIXED		(1<<4)	/* Do not move resource */
104 
105 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
106 extern struct resource ioport_resource;
107 extern struct resource iomem_resource;
108 
109 extern int request_resource(struct resource *root, struct resource *new);
110 extern int release_resource(struct resource *new);
111 extern int insert_resource(struct resource *parent, struct resource *new);
112 extern int allocate_resource(struct resource *root, struct resource *new,
113 			     resource_size_t size, resource_size_t min,
114 			     resource_size_t max, resource_size_t align,
115 			     void (*alignf)(void *, struct resource *,
116 					    resource_size_t, resource_size_t),
117 			     void *alignf_data);
118 int adjust_resource(struct resource *res, resource_size_t start,
119 		    resource_size_t size);
120 resource_size_t resource_alignment(struct resource *res);
121 
122 /* Convenience shorthand with allocation */
123 #define request_region(start,n,name)	__request_region(&ioport_resource, (start), (n), (name))
124 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name))
125 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
126 
127 extern struct resource * __request_region(struct resource *,
128 					resource_size_t start,
129 					resource_size_t n, const char *name);
130 
131 /* Compatibility cruft */
132 #define release_region(start,n)	__release_region(&ioport_resource, (start), (n))
133 #define check_mem_region(start,n)	__check_region(&iomem_resource, (start), (n))
134 #define release_mem_region(start,n)	__release_region(&iomem_resource, (start), (n))
135 
136 extern int __check_region(struct resource *, resource_size_t, resource_size_t);
137 extern void __release_region(struct resource *, resource_size_t,
138 				resource_size_t);
139 
140 static inline int __deprecated check_region(resource_size_t s,
141 						resource_size_t n)
142 {
143 	return __check_region(&ioport_resource, s, n);
144 }
145 
146 /* Wrappers for managed devices */
147 struct device;
148 #define devm_request_region(dev,start,n,name) \
149 	__devm_request_region(dev, &ioport_resource, (start), (n), (name))
150 #define devm_request_mem_region(dev,start,n,name) \
151 	__devm_request_region(dev, &iomem_resource, (start), (n), (name))
152 
153 extern struct resource * __devm_request_region(struct device *dev,
154 				struct resource *parent, resource_size_t start,
155 				resource_size_t n, const char *name);
156 
157 #define devm_release_region(start,n) \
158 	__devm_release_region(dev, &ioport_resource, (start), (n))
159 #define devm_release_mem_region(start,n) \
160 	__devm_release_region(dev, &iomem_resource, (start), (n))
161 
162 extern void __devm_release_region(struct device *dev, struct resource *parent,
163 				  resource_size_t start, resource_size_t n);
164 
165 #endif /* __ASSEMBLY__ */
166 #endif	/* _LINUX_IOPORT_H */
167