ioport.h 13 KB

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