[linux-2.6-block.git] / include / linux / ioport.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * ioport.h	Definitions of routines for detecting, reserving and
 *		allocating system resources.
 *
 * Authors:	Linus Torvalds
 */

#ifndef _LINUX_IOPORT_H
#define _LINUX_IOPORT_H

#ifndef __ASSEMBLY__
#include <linux/bits.h>
#include <linux/compiler.h>
#include <linux/minmax.h>
#include <linux/types.h>
/*
 * Resources are tree-like, allowing
 * nesting etc..
 */
struct resource {
	resource_size_t start;
	resource_size_t end;
	const char *name;
	unsigned long flags;
	unsigned long desc;
	struct resource *parent, *sibling, *child;
};

/*
 * IO resources have these defined flags.
 *
 * PCI devices expose these flags to userspace in the "resource" sysfs file,
 * so don't move them.
 */
#define IORESOURCE_BITS		0x000000ff	/* Bus-specific bits */

#define IORESOURCE_TYPE_BITS	0x00001f00	/* Resource type */
#define IORESOURCE_IO		0x00000100	/* PCI/ISA I/O ports */
#define IORESOURCE_MEM		0x00000200
#define IORESOURCE_REG		0x00000300	/* Register offsets */
#define IORESOURCE_IRQ		0x00000400
#define IORESOURCE_DMA		0x00000800
#define IORESOURCE_BUS		0x00001000

#define IORESOURCE_PREFETCH	0x00002000	/* No side effects */
#define IORESOURCE_READONLY	0x00004000
#define IORESOURCE_CACHEABLE	0x00008000
#define IORESOURCE_RANGELENGTH	0x00010000
#define IORESOURCE_SHADOWABLE	0x00020000

#define IORESOURCE_SIZEALIGN	0x00040000	/* size indicates alignment */
#define IORESOURCE_STARTALIGN	0x00080000	/* start field is alignment */

#define IORESOURCE_MEM_64	0x00100000
#define IORESOURCE_WINDOW	0x00200000	/* forwarded by bridge */
#define IORESOURCE_MUXED	0x00400000	/* Resource is software muxed */

#define IORESOURCE_EXT_TYPE_BITS 0x01000000	/* Resource extended types */
#define IORESOURCE_SYSRAM	0x01000000	/* System RAM (modifier) */

/* IORESOURCE_SYSRAM specific bits. */
#define IORESOURCE_SYSRAM_DRIVER_MANAGED	0x02000000 /* Always detected via a driver. */
#define IORESOURCE_SYSRAM_MERGEABLE		0x04000000 /* Resource can be merged. */

#define IORESOURCE_EXCLUSIVE	0x08000000	/* Userland may not map this resource */

#define IORESOURCE_DISABLED	0x10000000
#define IORESOURCE_UNSET	0x20000000	/* No address assigned yet */
#define IORESOURCE_AUTO		0x40000000
#define IORESOURCE_BUSY		0x80000000	/* Driver has marked this resource busy */

/* I/O resource extended types */
#define IORESOURCE_SYSTEM_RAM		(IORESOURCE_MEM|IORESOURCE_SYSRAM)

/* PnP IRQ specific bits (IORESOURCE_BITS) */
#define IORESOURCE_IRQ_HIGHEDGE		(1<<0)
#define IORESOURCE_IRQ_LOWEDGE		(1<<1)
#define IORESOURCE_IRQ_HIGHLEVEL	(1<<2)
#define IORESOURCE_IRQ_LOWLEVEL		(1<<3)
#define IORESOURCE_IRQ_SHAREABLE	(1<<4)
#define IORESOURCE_IRQ_OPTIONAL		(1<<5)
#define IORESOURCE_IRQ_WAKECAPABLE	(1<<6)

/* PnP DMA specific bits (IORESOURCE_BITS) */
#define IORESOURCE_DMA_TYPE_MASK	(3<<0)
#define IORESOURCE_DMA_8BIT		(0<<0)
#define IORESOURCE_DMA_8AND16BIT	(1<<0)
#define IORESOURCE_DMA_16BIT		(2<<0)

#define IORESOURCE_DMA_MASTER		(1<<2)
#define IORESOURCE_DMA_BYTE		(1<<3)
#define IORESOURCE_DMA_WORD		(1<<4)

#define IORESOURCE_DMA_SPEED_MASK	(3<<6)
#define IORESOURCE_DMA_COMPATIBLE	(0<<6)
#define IORESOURCE_DMA_TYPEA		(1<<6)
#define IORESOURCE_DMA_TYPEB		(2<<6)
#define IORESOURCE_DMA_TYPEF		(3<<6)

/* PnP memory I/O specific bits (IORESOURCE_BITS) */
#define IORESOURCE_MEM_WRITEABLE	(1<<0)	/* dup: IORESOURCE_READONLY */
#define IORESOURCE_MEM_CACHEABLE	(1<<1)	/* dup: IORESOURCE_CACHEABLE */
#define IORESOURCE_MEM_RANGELENGTH	(1<<2)	/* dup: IORESOURCE_RANGELENGTH */
#define IORESOURCE_MEM_TYPE_MASK	(3<<3)
#define IORESOURCE_MEM_8BIT		(0<<3)
#define IORESOURCE_MEM_16BIT		(1<<3)
#define IORESOURCE_MEM_8AND16BIT	(2<<3)
#define IORESOURCE_MEM_32BIT		(3<<3)
#define IORESOURCE_MEM_SHADOWABLE	(1<<5)	/* dup: IORESOURCE_SHADOWABLE */
#define IORESOURCE_MEM_EXPANSIONROM	(1<<6)
#define IORESOURCE_MEM_NONPOSTED	(1<<7)

/* PnP I/O specific bits (IORESOURCE_BITS) */
#define IORESOURCE_IO_16BIT_ADDR	(1<<0)
#define IORESOURCE_IO_FIXED		(1<<1)
#define IORESOURCE_IO_SPARSE		(1<<2)

/* PCI ROM control bits (IORESOURCE_BITS) */
#define IORESOURCE_ROM_ENABLE		(1<<0)	/* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
#define IORESOURCE_ROM_SHADOW		(1<<1)	/* Use RAM image, not ROM BAR */

/* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */
#define IORESOURCE_PCI_FIXED		(1<<4)	/* Do not move resource */
#define IORESOURCE_PCI_EA_BEI		(1<<5)	/* BAR Equivalent Indicator */

/*
 * I/O Resource Descriptors
 *
 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
 * for searching a specific resource range in the iomem table.  Assign
 * a new descriptor when a resource range supports the search interfaces.
 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
 */
enum {
	IORES_DESC_NONE				= 0,
	IORES_DESC_CRASH_KERNEL			= 1,
	IORES_DESC_ACPI_TABLES			= 2,
	IORES_DESC_ACPI_NV_STORAGE		= 3,
	IORES_DESC_PERSISTENT_MEMORY		= 4,
	IORES_DESC_PERSISTENT_MEMORY_LEGACY	= 5,
	IORES_DESC_DEVICE_PRIVATE_MEMORY	= 6,
	IORES_DESC_RESERVED			= 7,
	IORES_DESC_SOFT_RESERVED		= 8,
	IORES_DESC_CXL				= 9,
};

/*
 * Flags controlling ioremap() behavior.
 */
enum {
	IORES_MAP_SYSTEM_RAM		= BIT(0),
	IORES_MAP_ENCRYPTED		= BIT(1),
};

/* helpers to define resources */
#define DEFINE_RES_NAMED(_start, _size, _name, _flags)			\
(struct resource) {							\
		.start = (_start),					\
		.end = (_start) + (_size) - 1,				\
		.name = (_name),					\
		.flags = (_flags),					\
		.desc = IORES_DESC_NONE,				\
	}

#define DEFINE_RES_IO_NAMED(_start, _size, _name)			\
	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
#define DEFINE_RES_IO(_start, _size)					\
	DEFINE_RES_IO_NAMED((_start), (_size), NULL)

#define DEFINE_RES_MEM_NAMED(_start, _size, _name)			\
	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
#define DEFINE_RES_MEM(_start, _size)					\
	DEFINE_RES_MEM_NAMED((_start), (_size), NULL)

#define DEFINE_RES_REG_NAMED(_start, _size, _name)			\
	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_REG)
#define DEFINE_RES_REG(_start, _size)					\
	DEFINE_RES_REG_NAMED((_start), (_size), NULL)

#define DEFINE_RES_IRQ_NAMED(_irq, _name)				\
	DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
#define DEFINE_RES_IRQ(_irq)						\
	DEFINE_RES_IRQ_NAMED((_irq), NULL)

#define DEFINE_RES_DMA_NAMED(_dma, _name)				\
	DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
#define DEFINE_RES_DMA(_dma)						\
	DEFINE_RES_DMA_NAMED((_dma), NULL)

/**
 * typedef resource_alignf - Resource alignment callback
 * @data:	Private data used by the callback
 * @res:	Resource candidate range (an empty resource space)
 * @size:	The minimum size of the empty space
 * @align:	Alignment from the constraints
 *
 * Callback allows calculating resource placement and alignment beyond min,
 * max, and align fields in the struct resource_constraint.
 *
 * Return: Start address for the resource.
 */
typedef resource_size_t (*resource_alignf)(void *data,
					   const struct resource *res,
					   resource_size_t size,
					   resource_size_t align);

/**
 * struct resource_constraint - constraints to be met while searching empty
 *				resource space
 * @min:		The minimum address for the memory range
 * @max:		The maximum address for the memory range
 * @align:		Alignment for the start address of the empty space
 * @alignf:		Additional alignment constraints callback
 * @alignf_data:	Data provided for @alignf callback
 *
 * Contains the range and alignment constraints that have to be met during
 * find_resource_space(). @alignf can be NULL indicating no alignment beyond
 * @align is necessary.
 */
struct resource_constraint {
	resource_size_t min, max, align;
	resource_alignf alignf;
	void *alignf_data;
};

/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
extern struct resource ioport_resource;
extern struct resource iomem_resource;

extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
extern int request_resource(struct resource *root, struct resource *new);
extern int release_resource(struct resource *new);
void release_child_resources(struct resource *new);
extern void reserve_region_with_split(struct resource *root,
			     resource_size_t start, resource_size_t end,
			     const char *name);
extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
extern int insert_resource(struct resource *parent, struct resource *new);
extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
extern int remove_resource(struct resource *old);
extern void arch_remove_reservations(struct resource *avail);
extern int allocate_resource(struct resource *root, struct resource *new,
			     resource_size_t size, resource_size_t min,
			     resource_size_t max, resource_size_t align,
			     resource_alignf alignf,
			     void *alignf_data);
struct resource *lookup_resource(struct resource *root, resource_size_t start);
int adjust_resource(struct resource *res, resource_size_t start,
		    resource_size_t size);
resource_size_t resource_alignment(struct resource *res);
static inline resource_size_t resource_size(const struct resource *res)
{
	return res->end - res->start + 1;
}
static inline unsigned long resource_type(const struct resource *res)
{
	return res->flags & IORESOURCE_TYPE_BITS;
}
static inline unsigned long resource_ext_type(const struct resource *res)
{
	return res->flags & IORESOURCE_EXT_TYPE_BITS;
}
/* True iff r1 completely contains r2 */
static inline bool resource_contains(const struct resource *r1, const struct resource *r2)
{
	if (resource_type(r1) != resource_type(r2))
		return false;
	if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
		return false;
	return r1->start <= r2->start && r1->end >= r2->end;
}

/* True if any part of r1 overlaps r2 */
static inline bool resource_overlaps(const struct resource *r1, const struct resource *r2)
{
       return r1->start <= r2->end && r1->end >= r2->start;
}

static inline bool resource_intersection(const struct resource *r1, const struct resource *r2,
					 struct resource *r)
{
	if (!resource_overlaps(r1, r2))
		return false;
	r->start = max(r1->start, r2->start);
	r->end = min(r1->end, r2->end);
	return true;
}

static inline bool resource_union(const struct resource *r1, const struct resource *r2,
				  struct resource *r)
{
	if (!resource_overlaps(r1, r2))
		return false;
	r->start = min(r1->start, r2->start);
	r->end = max(r1->end, r2->end);
	return true;
}

int find_resource_space(struct resource *root, struct resource *new,
			resource_size_t size, struct resource_constraint *constraint);

/* Convenience shorthand with allocation */
#define request_region(start,n,name)		__request_region(&ioport_resource, (start), (n), (name), 0)
#define request_muxed_region(start,n,name)	__request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
#define request_mem_region_muxed(start, n, name) \
	__request_region(&iomem_resource, (start), (n), (name), IORESOURCE_MUXED)
#define request_mem_region_exclusive(start,n,name) \
	__request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
#define rename_region(region, newname) do { (region)->name = (newname); } while (0)

extern struct resource * __request_region(struct resource *,
					resource_size_t start,
					resource_size_t n,
					const char *name, int flags);

/* Compatibility cruft */
#define release_region(start,n)	__release_region(&ioport_resource, (start), (n))
#define release_mem_region(start,n)	__release_region(&iomem_resource, (start), (n))

extern void __release_region(struct resource *, resource_size_t,
				resource_size_t);
#ifdef CONFIG_MEMORY_HOTREMOVE
extern void release_mem_region_adjustable(resource_size_t, resource_size_t);
#endif
#ifdef CONFIG_MEMORY_HOTPLUG
extern void merge_system_ram_resource(struct resource *res);
#endif

/* Wrappers for managed devices */
struct device;

extern int devm_request_resource(struct device *dev, struct resource *root,
				 struct resource *new);
extern void devm_release_resource(struct device *dev, struct resource *new);

#define devm_request_region(dev,start,n,name) \
	__devm_request_region(dev, &ioport_resource, (start), (n), (name))
#define devm_request_mem_region(dev,start,n,name) \
	__devm_request_region(dev, &iomem_resource, (start), (n), (name))

extern struct resource * __devm_request_region(struct device *dev,
				struct resource *parent, resource_size_t start,
				resource_size_t n, const char *name);

#define devm_release_region(dev, start, n) \
	__devm_release_region(dev, &ioport_resource, (start), (n))
#define devm_release_mem_region(dev, start, n) \
	__devm_release_region(dev, &iomem_resource, (start), (n))

extern void __devm_release_region(struct device *dev, struct resource *parent,
				  resource_size_t start, resource_size_t n);
extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
extern bool iomem_is_exclusive(u64 addr);
extern bool resource_is_exclusive(struct resource *resource, u64 addr,
				  resource_size_t size);

extern int
walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
		void *arg, int (*func)(unsigned long, unsigned long, void *));
extern int
walk_mem_res(u64 start, u64 end, void *arg,
	     int (*func)(struct resource *, void *));
extern int
walk_system_ram_res(u64 start, u64 end, void *arg,
		    int (*func)(struct resource *, void *));
extern int
walk_system_ram_res_rev(u64 start, u64 end, void *arg,
			int (*func)(struct resource *, void *));
extern int
walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
		    void *arg, int (*func)(struct resource *, void *));

struct resource *devm_request_free_mem_region(struct device *dev,
		struct resource *base, unsigned long size);
struct resource *request_free_mem_region(struct resource *base,
		unsigned long size, const char *name);
struct resource *alloc_free_mem_region(struct resource *base,
		unsigned long size, unsigned long align, const char *name);

static inline void irqresource_disabled(struct resource *res, u32 irq)
{
	res->start = irq;
	res->end = irq;
	res->flags |= IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
}

extern struct address_space *iomem_get_mapping(void);

#endif /* __ASSEMBLY__ */
#endif	/* _LINUX_IOPORT_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	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
c9cce83d	12	#ifndef __ASSEMBLY__
5562f35d	13	#include <linux/bits.h>
1da177e4	14	#include <linux/compiler.h>
5562f35d	15	#include <linux/minmax.h>
cf7c712c	16	#include <linux/types.h>
1da177e4 LT	17	/*
	18	* Resources are tree-like, allowing
	19	* nesting etc..
	20	*/
	21	struct resource {
cf7c712c GKH	22	resource_size_t start;
cf7c712c GKH	23	resource_size_t end;
1da177e4	24	const char *name;
1da177e4	25	unsigned long flags;
43ee493b	26	unsigned long desc;
1da177e4 LT	27	struct resource parent, sibling, *child;
	28	};
	29
1da177e4 LT	30	/*
1da177e4 LT	31	* IO resources have these defined flags.
92efb1bd AW	32	*
	33	* PCI devices expose these flags to userspace in the "resource" sysfs file,
	34	* so don't move them.
1da177e4 LT	35	*/
	36	#define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
	37
cd7e9fcd	38	#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
c04a9cb8	39	#define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
1da177e4	40	#define IORESOURCE_MEM 0x00000200
72dcb119	41	#define IORESOURCE_REG 0x00000300 /* Register offsets */
1da177e4 LT	42	#define IORESOURCE_IRQ 0x00000400
1da177e4 LT	43	#define IORESOURCE_DMA 0x00000800
0f4050c7	44	#define IORESOURCE_BUS 0x00001000
1da177e4	45
cd7e9fcd BH	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
88452565	51
cd7e9fcd BH	52	#define IORESOURCE_SIZEALIGN 0x00040000 /* size indicates alignment */
cd7e9fcd BH	53	#define IORESOURCE_STARTALIGN 0x00080000 /* start field is alignment */
1da177e4	54
1f82de10	55	#define IORESOURCE_MEM_64 0x00100000
9d7cca04	56	#define IORESOURCE_WINDOW 0x00200000 /* forwarded by bridge */
8b6d043b	57	#define IORESOURCE_MUXED 0x00400000 /* Resource is software muxed */
1f82de10	58
9babd5c8 TK	59	#define IORESOURCE_EXT_TYPE_BITS 0x01000000 /* Resource extended types */
	60	#define IORESOURCE_SYSRAM 0x01000000 /* System RAM (modifier) */
	61
7cf603d1 DH	62	/* IORESOURCE_SYSRAM specific bits. */
7cf603d1 DH	63	#define IORESOURCE_SYSRAM_DRIVER_MANAGED 0x02000000 /* Always detected via a driver. */
9ca6551e	64	#define IORESOURCE_SYSRAM_MERGEABLE 0x04000000 /* Resource can be merged. */
7cf603d1	65
e8de1481	66	#define IORESOURCE_EXCLUSIVE 0x08000000 /* Userland may not map this resource */
9babd5c8	67
1da177e4	68	#define IORESOURCE_DISABLED 0x10000000
d19cb803	69	#define IORESOURCE_UNSET 0x20000000 /* No address assigned yet */
1da177e4 LT	70	#define IORESOURCE_AUTO 0x40000000
	71	#define IORESOURCE_BUSY 0x80000000 /* Driver has marked this resource busy */
	72
9babd5c8 TK	73	/* I/O resource extended types */
	74	#define IORESOURCE_SYSTEM_RAM (IORESOURCE_MEM\|IORESOURCE_SYSRAM)
	75
e9fe9e18	76	/* PnP IRQ specific bits (IORESOURCE_BITS) */
1da177e4 LT	77	#define IORESOURCE_IRQ_HIGHEDGE (1<<0)
	78	#define IORESOURCE_IRQ_LOWEDGE (1<<1)
	79	#define IORESOURCE_IRQ_HIGHLEVEL (1<<2)
	80	#define IORESOURCE_IRQ_LOWLEVEL (1<<3)
c32928c5	81	#define IORESOURCE_IRQ_SHAREABLE (1<<4)
5ff81160 RR	82	#define IORESOURCE_IRQ_OPTIONAL (1<<5)
5ff81160 RR	83	#define IORESOURCE_IRQ_WAKECAPABLE (1<<6)
1da177e4	84
e9fe9e18	85	/* PnP DMA specific bits (IORESOURCE_BITS) */
1da177e4 LT	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
e9fe9e18	101	/* PnP memory I/O specific bits (IORESOURCE_BITS) */
1da177e4 LT	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)
7c566bb5	112	#define IORESOURCE_MEM_NONPOSTED (1<<7)
1da177e4	113
08c9f262 BH	114	/* PnP I/O specific bits (IORESOURCE_BITS) */
	115	#define IORESOURCE_IO_16BIT_ADDR (1<<0)
	116	#define IORESOURCE_IO_FIXED (1<<1)
91236ecc	117	#define IORESOURCE_IO_SPARSE (1<<2)
08c9f262	118
1da177e4 LT	119	/* PCI ROM control bits (IORESOURCE_BITS) */
1da177e4 LT	120	#define IORESOURCE_ROM_ENABLE (1<<0) /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
0c0e0736	121	#define IORESOURCE_ROM_SHADOW (1<<1) /* Use RAM image, not ROM BAR */
1da177e4	122
fb0f2b40 RB	123	/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
fb0f2b40 RB	124	#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */
92efb1bd	125	#define IORESOURCE_PCI_EA_BEI (1<<5) /* BAR Equivalent Indicator */
fb0f2b40	126
43ee493b TK	127	/*
	128	* I/O Resource Descriptors
	129	*
	130	* Descriptors are used by walk_iomem_res_desc() and region_intersects()
	131	* for searching a specific resource range in the iomem table. Assign
	132	* a new descriptor when a resource range supports the search interfaces.
	133	* Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
	134	*/
	135	enum {
	136	IORES_DESC_NONE = 0,
	137	IORES_DESC_CRASH_KERNEL = 1,
	138	IORES_DESC_ACPI_TABLES = 2,
	139	IORES_DESC_ACPI_NV_STORAGE = 3,
	140	IORES_DESC_PERSISTENT_MEMORY = 4,
	141	IORES_DESC_PERSISTENT_MEMORY_LEGACY = 5,
5042db43	142	IORES_DESC_DEVICE_PRIVATE_MEMORY = 6,
fec88ab0	143	IORES_DESC_RESERVED = 7,
262b45ae	144	IORES_DESC_SOFT_RESERVED = 8,
974854ab	145	IORES_DESC_CXL = 9,
43ee493b	146	};
a0e44d4a	147
5da04cc8 LJ	148	/*
	149	* Flags controlling ioremap() behavior.
	150	*/
	151	enum {
	152	IORES_MAP_SYSTEM_RAM = BIT(0),
	153	IORES_MAP_ENCRYPTED = BIT(1),
	154	};
	155
a0e44d4a UKK	156	/* helpers to define resources */
a0e44d4a UKK	157	#define DEFINE_RES_NAMED(_start, _size, _name, _flags) \
52c4d11f	158	(struct resource) { \
a0e44d4a UKK	159	.start = (_start), \
	160	.end = (_start) + (_size) - 1, \
	161	.name = (_name), \
	162	.flags = (_flags), \
43ee493b	163	.desc = IORES_DESC_NONE, \
a0e44d4a UKK	164	}
	165
	166	#define DEFINE_RES_IO_NAMED(_start, _size, _name) \
	167	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
	168	#define DEFINE_RES_IO(_start, _size) \
	169	DEFINE_RES_IO_NAMED((_start), (_size), NULL)
	170
	171	#define DEFINE_RES_MEM_NAMED(_start, _size, _name) \
	172	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
	173	#define DEFINE_RES_MEM(_start, _size) \
	174	DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
	175
39f7d083 CF	176	#define DEFINE_RES_REG_NAMED(_start, _size, _name) \
	177	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_REG)
	178	#define DEFINE_RES_REG(_start, _size) \
	179	DEFINE_RES_REG_NAMED((_start), (_size), NULL)
	180
a0e44d4a UKK	181	#define DEFINE_RES_IRQ_NAMED(_irq, _name) \
	182	DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
	183	#define DEFINE_RES_IRQ(_irq) \
	184	DEFINE_RES_IRQ_NAMED((_irq), NULL)
	185
	186	#define DEFINE_RES_DMA_NAMED(_dma, _name) \
	187	DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
	188	#define DEFINE_RES_DMA(_dma) \
	189	DEFINE_RES_DMA_NAMED((_dma), NULL)
	190
4eed3dd7 IJ	191	/**
	192	* typedef resource_alignf - Resource alignment callback
	193	* @data: Private data used by the callback
	194	* @res: Resource candidate range (an empty resource space)
	195	* @size: The minimum size of the empty space
	196	* @align: Alignment from the constraints
	197	*
	198	* Callback allows calculating resource placement and alignment beyond min,
	199	* max, and align fields in the struct resource_constraint.
	200	*
	201	* Return: Start address for the resource.
	202	*/
	203	typedef resource_size_t (resource_alignf)(void data,
	204	const struct resource *res,
	205	resource_size_t size,
	206	resource_size_t align);
	207
27002253 IJ	208	/**
	209	* struct resource_constraint - constraints to be met while searching empty
	210	* resource space
	211	* @min: The minimum address for the memory range
	212	* @max: The maximum address for the memory range
	213	* @align: Alignment for the start address of the empty space
	214	* @alignf: Additional alignment constraints callback
	215	* @alignf_data: Data provided for @alignf callback
	216	*
	217	* Contains the range and alignment constraints that have to be met during
	218	* find_resource_space(). @alignf can be NULL indicating no alignment beyond
	219	* @align is necessary.
	220	*/
	221	struct resource_constraint {
	222	resource_size_t min, max, align;
	223	resource_alignf alignf;
	224	void *alignf_data;
	225	};
	226
1da177e4 LT	227	/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
	228	extern struct resource ioport_resource;
	229	extern struct resource iomem_resource;
	230
66f1207b	231	extern struct resource request_resource_conflict(struct resource root, struct resource *new);
1da177e4	232	extern int request_resource(struct resource root, struct resource new);
1da177e4	233	extern int release_resource(struct resource *new);
5eeec0ec	234	void release_child_resources(struct resource *new);
268364a0 YL	235	extern void reserve_region_with_split(struct resource *root,
	236	resource_size_t start, resource_size_t end,
	237	const char *name);
66f1207b	238	extern struct resource insert_resource_conflict(struct resource parent, struct resource *new);
cd6ef2ad	239	extern int insert_resource(struct resource parent, struct resource new);
bef69ea0	240	extern void insert_resource_expand_to_fit(struct resource root, struct resource new);
ff3cc952	241	extern int remove_resource(struct resource *old);
fcb11918	242	extern void arch_remove_reservations(struct resource *avail);
1da177e4	243	extern int allocate_resource(struct resource root, struct resource new,
d75fc8bb GKH	244	resource_size_t size, resource_size_t min,
d75fc8bb GKH	245	resource_size_t max, resource_size_t align,
4eed3dd7	246	resource_alignf alignf,
1da177e4	247	void *alignf_data);
1c388919	248	struct resource lookup_resource(struct resource root, resource_size_t start);
d75fc8bb GKH	249	int adjust_resource(struct resource *res, resource_size_t start,
d75fc8bb GKH	250	resource_size_t size);
88452565	251	resource_size_t resource_alignment(struct resource *res);
f65380c0	252	static inline resource_size_t resource_size(const struct resource *res)
1a4e564b MD	253	{
	254	return res->end - res->start + 1;
	255	}
f65380c0	256	static inline unsigned long resource_type(const struct resource *res)
c9f66169 MD	257	{
	258	return res->flags & IORESOURCE_TYPE_BITS;
	259	}
9babd5c8 TK	260	static inline unsigned long resource_ext_type(const struct resource *res)
	261	{
	262	return res->flags & IORESOURCE_EXT_TYPE_BITS;
	263	}
5edb93b8	264	/* True iff r1 completely contains r2 */
eb7581de	265	static inline bool resource_contains(const struct resource r1, const struct resource r2)
5edb93b8 BH	266	{
	267	if (resource_type(r1) != resource_type(r2))
	268	return false;
	269	if (r1->flags & IORESOURCE_UNSET \|\| r2->flags & IORESOURCE_UNSET)
	270	return false;
	271	return r1->start <= r2->start && r1->end >= r2->end;
	272	}
	273
1f90f6a8	274	/* True if any part of r1 overlaps r2 */
eb7581de	275	static inline bool resource_overlaps(const struct resource r1, const struct resource r2)
1f90f6a8 AS	276	{
	277	return r1->start <= r2->end && r1->end >= r2->start;
	278	}
1da177e4	279
eb7581de AS	280	static inline bool resource_intersection(const struct resource r1, const struct resource r2,
eb7581de AS	281	struct resource *r)
f65674df AS	282	{
	283	if (!resource_overlaps(r1, r2))
	284	return false;
	285	r->start = max(r1->start, r2->start);
	286	r->end = min(r1->end, r2->end);
	287	return true;
	288	}
	289
eb7581de AS	290	static inline bool resource_union(const struct resource r1, const struct resource r2,
eb7581de AS	291	struct resource *r)
5562f35d AS	292	{
	293	if (!resource_overlaps(r1, r2))
	294	return false;
	295	r->start = min(r1->start, r2->start);
	296	r->end = max(r1->end, r2->end);
	297	return true;
	298	}
1da177e4	299
27002253 IJ	300	int find_resource_space(struct resource root, struct resource new,
	301	resource_size_t size, struct resource_constraint *constraint);
	302
1da177e4	303	/* Convenience shorthand with allocation */
8b6d043b AC	304	#define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0)
8b6d043b AC	305	#define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
e8de1481 AV	306	#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
e8de1481 AV	307	#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
27c196c7 TB	308	#define request_mem_region_muxed(start, n, name) \
27c196c7 TB	309	__request_region(&iomem_resource, (start), (n), (name), IORESOURCE_MUXED)
e8de1481 AV	310	#define request_mem_region_exclusive(start,n,name) \
e8de1481 AV	311	__request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
1da177e4 LT	312	#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
1da177e4 LT	313
d75fc8bb GKH	314	extern struct resource * __request_region(struct resource *,
d75fc8bb GKH	315	resource_size_t start,
6ae301e8 RD	316	resource_size_t n,
6ae301e8 RD	317	const char *name, int flags);
1da177e4 LT	318
	319	/* Compatibility cruft */
	320	#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
1da177e4 LT	321	#define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n))
1da177e4 LT	322
d75fc8bb GKH	323	extern void __release_region(struct resource *, resource_size_t,
d75fc8bb GKH	324	resource_size_t);
825f787b	325	#ifdef CONFIG_MEMORY_HOTREMOVE
cb8e3c8b	326	extern void release_mem_region_adjustable(resource_size_t, resource_size_t);
825f787b	327	#endif
9ca6551e DH	328	#ifdef CONFIG_MEMORY_HOTPLUG
	329	extern void merge_system_ram_resource(struct resource *res);
	330	#endif
1da177e4	331
9ac7849e TH	332	/* Wrappers for managed devices */
9ac7849e TH	333	struct device;
8d38821c TR	334
	335	extern int devm_request_resource(struct device dev, struct resource root,
	336	struct resource *new);
	337	extern void devm_release_resource(struct device dev, struct resource new);
	338
9ac7849e TH	339	#define devm_request_region(dev,start,n,name) \
	340	__devm_request_region(dev, &ioport_resource, (start), (n), (name))
	341	#define devm_request_mem_region(dev,start,n,name) \
	342	__devm_request_region(dev, &iomem_resource, (start), (n), (name))
	343
	344	extern struct resource * __devm_request_region(struct device *dev,
	345	struct resource *parent, resource_size_t start,
	346	resource_size_t n, const char *name);
	347
dea420ce	348	#define devm_release_region(dev, start, n) \
9ac7849e	349	__devm_release_region(dev, &ioport_resource, (start), (n))
dea420ce	350	#define devm_release_mem_region(dev, start, n) \
9ac7849e TH	351	__devm_release_region(dev, &iomem_resource, (start), (n))
	352
	353	extern void __devm_release_region(struct device dev, struct resource parent,
	354	resource_size_t start, resource_size_t n);
379daf62	355	extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
9825b451	356	extern bool iomem_is_exclusive(u64 addr);
27829479 IW	357	extern bool resource_is_exclusive(struct resource *resource, u64 addr,
27829479 IW	358	resource_size_t size);
9ac7849e	359
908eedc6 KH	360	extern int
	361	walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
	362	void arg, int (func)(unsigned long, unsigned long, void *));
8c86e70a	363	extern int
0e4c12b4 TL	364	walk_mem_res(u64 start, u64 end, void *arg,
	365	int (func)(struct resource , void *));
	366	extern int
8c86e70a	367	walk_system_ram_res(u64 start, u64 end, void *arg,
1d2e733b	368	int (func)(struct resource , void *));
8c86e70a	369	extern int
7acf164b BH	370	walk_system_ram_res_rev(u64 start, u64 end, void *arg,
	371	int (func)(struct resource , void *));
	372	extern int
3f33647c	373	walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end,
1d2e733b	374	void arg, int (func)(struct resource , void ));
908eedc6	375
0092908d CH	376	struct resource devm_request_free_mem_region(struct device dev,
0092908d CH	377	struct resource *base, unsigned long size);
0c385190 CH	378	struct resource request_free_mem_region(struct resource base,
0c385190 CH	379	unsigned long size, const char *name);
14b80582 DW	380	struct resource alloc_free_mem_region(struct resource base,
14b80582 DW	381	unsigned long size, unsigned long align, const char *name);
74d24b21	382
9806731d JG	383	static inline void irqresource_disabled(struct resource *res, u32 irq)
	384	{
	385	res->start = irq;
	386	res->end = irq;
d08a7457	387	res->flags \|= IORESOURCE_IRQ \| IORESOURCE_DISABLED \| IORESOURCE_UNSET;
9806731d JG	388	}
9806731d JG	389
71a1d8ed	390	extern struct address_space *iomem_get_mapping(void);
3234ac66	391
c9cce83d	392	#endif /* __ASSEMBLY__ */
1da177e4	393	#endif /* _LINUX_IOPORT_H */