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