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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2006, Intel Corporation.
 *
 * Copyright (C) 2006-2008 Intel Corporation
 * Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
 */

#ifndef _IOVA_H_
#define _IOVA_H_

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/rbtree.h>
#include <linux/dma-mapping.h>

/* iova structure */
struct iova {
	struct rb_node	node;
	unsigned long	pfn_hi; /* Highest allocated pfn */
	unsigned long	pfn_lo; /* Lowest allocated pfn */
};


struct iova_rcache;

/* holds all the iova translations for a domain */
struct iova_domain {
	spinlock_t	iova_rbtree_lock; /* Lock to protect update of rbtree */
	struct rb_root	rbroot;		/* iova domain rbtree root */
	struct rb_node	*cached_node;	/* Save last alloced node */
	struct rb_node	*cached32_node; /* Save last 32-bit alloced node */
	unsigned long	granule;	/* pfn granularity for this domain */
	unsigned long	start_pfn;	/* Lower limit for this domain */
	unsigned long	dma_32bit_pfn;
	unsigned long	max32_alloc_size; /* Size of last failed allocation */
	struct iova	anchor;		/* rbtree lookup anchor */

	struct iova_rcache	*rcaches;
	struct hlist_node	cpuhp_dead;
};

static inline unsigned long iova_size(struct iova *iova)
{
	return iova->pfn_hi - iova->pfn_lo + 1;
}

static inline unsigned long iova_shift(struct iova_domain *iovad)
{
	return __ffs(iovad->granule);
}

static inline unsigned long iova_mask(struct iova_domain *iovad)
{
	return iovad->granule - 1;
}

static inline size_t iova_offset(struct iova_domain *iovad, dma_addr_t iova)
{
	return iova & iova_mask(iovad);
}

static inline size_t iova_align(struct iova_domain *iovad, size_t size)
{
	return ALIGN(size, iovad->granule);
}

static inline size_t iova_align_down(struct iova_domain *iovad, size_t size)
{
	return ALIGN_DOWN(size, iovad->granule);
}

static inline dma_addr_t iova_dma_addr(struct iova_domain *iovad, struct iova *iova)
{
	return (dma_addr_t)iova->pfn_lo << iova_shift(iovad);
}

static inline unsigned long iova_pfn(struct iova_domain *iovad, dma_addr_t iova)
{
	return iova >> iova_shift(iovad);
}

#if IS_REACHABLE(CONFIG_IOMMU_IOVA)
int iova_cache_get(void);
void iova_cache_put(void);

unsigned long iova_rcache_range(void);

void free_iova(struct iova_domain *iovad, unsigned long pfn);
void __free_iova(struct iova_domain *iovad, struct iova *iova);
struct iova *alloc_iova(struct iova_domain *iovad, unsigned long size,
	unsigned long limit_pfn,
	bool size_aligned);
void free_iova_fast(struct iova_domain *iovad, unsigned long pfn,
		    unsigned long size);
unsigned long alloc_iova_fast(struct iova_domain *iovad, unsigned long size,
			      unsigned long limit_pfn, bool flush_rcache);
struct iova *reserve_iova(struct iova_domain *iovad, unsigned long pfn_lo,
	unsigned long pfn_hi);
void init_iova_domain(struct iova_domain *iovad, unsigned long granule,
	unsigned long start_pfn);
int iova_domain_init_rcaches(struct iova_domain *iovad);
struct iova *find_iova(struct iova_domain *iovad, unsigned long pfn);
void put_iova_domain(struct iova_domain *iovad);
#else
static inline int iova_cache_get(void)
{
	return -ENOTSUPP;
}

static inline void iova_cache_put(void)
{
}

static inline void free_iova(struct iova_domain *iovad, unsigned long pfn)
{
}

static inline void __free_iova(struct iova_domain *iovad, struct iova *iova)
{
}

static inline struct iova *alloc_iova(struct iova_domain *iovad,
				      unsigned long size,
				      unsigned long limit_pfn,
				      bool size_aligned)
{
	return NULL;
}

static inline void free_iova_fast(struct iova_domain *iovad,
				  unsigned long pfn,
				  unsigned long size)
{
}

static inline unsigned long alloc_iova_fast(struct iova_domain *iovad,
					    unsigned long size,
					    unsigned long limit_pfn,
					    bool flush_rcache)
{
	return 0;
}

static inline struct iova *reserve_iova(struct iova_domain *iovad,
					unsigned long pfn_lo,
					unsigned long pfn_hi)
{
	return NULL;
}

static inline void init_iova_domain(struct iova_domain *iovad,
				    unsigned long granule,
				    unsigned long start_pfn)
{
}

static inline struct iova *find_iova(struct iova_domain *iovad,
				     unsigned long pfn)
{
	return NULL;
}

static inline void put_iova_domain(struct iova_domain *iovad)
{
}

#endif

#endif
Commit	Line	Data
55716d26	1	/* SPDX-License-Identifier: GPL-2.0-only */
f8de50eb KA	2	/*
	3	* Copyright (c) 2006, Intel Corporation.
	4	*
98bcef56	5	* Copyright (C) 2006-2008 Intel Corporation
98bcef56	6	* Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
f8de50eb KA	7	*/
	8
	9	#ifndef _IOVA_H_
	10	#define _IOVA_H_
	11
	12	#include <linux/types.h>
	13	#include <linux/kernel.h>
	14	#include <linux/rbtree.h>
aade40b6	15	#include <linux/dma-mapping.h>
f8de50eb	16
f8de50eb KA	17	/* iova structure */
	18	struct iova {
	19	struct rb_node node;
9257b4a2 OP	20	unsigned long pfn_hi; /* Highest allocated pfn */
	21	unsigned long pfn_lo; /* Lowest allocated pfn */
	22	};
	23
9257b4a2	24
32e92d9f	25	struct iova_rcache;
f8de50eb KA	26
	27	/* holds all the iova translations for a domain */
	28	struct iova_domain {
f8de50eb KA	29	spinlock_t iova_rbtree_lock; /* Lock to protect update of rbtree */
f8de50eb KA	30	struct rb_root rbroot; /* iova domain rbtree root */
e60aa7b5 RM	31	struct rb_node cached_node; / Save last alloced node */
e60aa7b5 RM	32	struct rb_node cached32_node; / Save last 32-bit alloced node */
0fb5fe87	33	unsigned long granule; /* pfn granularity for this domain */
1b722500	34	unsigned long start_pfn; /* Lower limit for this domain */
f661197e	35	unsigned long dma_32bit_pfn;
bee60e94	36	unsigned long max32_alloc_size; /* Size of last failed allocation */
bb68b2fb	37	struct iova anchor; /* rbtree lookup anchor */
42f87e71	38
32e92d9f	39	struct iova_rcache *rcaches;
f598a497	40	struct hlist_node cpuhp_dead;
f8de50eb KA	41	};
f8de50eb KA	42
a156ef99 JL	43	static inline unsigned long iova_size(struct iova *iova)
	44	{
	45	return iova->pfn_hi - iova->pfn_lo + 1;
	46	}
	47
0fb5fe87 RM	48	static inline unsigned long iova_shift(struct iova_domain *iovad)
	49	{
	50	return __ffs(iovad->granule);
	51	}
	52
	53	static inline unsigned long iova_mask(struct iova_domain *iovad)
	54	{
	55	return iovad->granule - 1;
	56	}
	57
	58	static inline size_t iova_offset(struct iova_domain *iovad, dma_addr_t iova)
	59	{
	60	return iova & iova_mask(iovad);
	61	}
	62
	63	static inline size_t iova_align(struct iova_domain *iovad, size_t size)
	64	{
	65	return ALIGN(size, iovad->granule);
	66	}
	67
2650073f MK	68	static inline size_t iova_align_down(struct iova_domain *iovad, size_t size)
	69	{
	70	return ALIGN_DOWN(size, iovad->granule);
	71	}
	72
0fb5fe87 RM	73	static inline dma_addr_t iova_dma_addr(struct iova_domain iovad, struct iova iova)
	74	{
	75	return (dma_addr_t)iova->pfn_lo << iova_shift(iovad);
	76	}
	77
	78	static inline unsigned long iova_pfn(struct iova_domain *iovad, dma_addr_t iova)
	79	{
	80	return iova >> iova_shift(iovad);
	81	}
	82
4f58330f	83	#if IS_REACHABLE(CONFIG_IOMMU_IOVA)
ae1ff3d6 SA	84	int iova_cache_get(void);
ae1ff3d6 SA	85	void iova_cache_put(void);
85b45456	86
6d9870b7 JG	87	unsigned long iova_rcache_range(void);
6d9870b7 JG	88
f8de50eb KA	89	void free_iova(struct iova_domain *iovad, unsigned long pfn);
	90	void __free_iova(struct iova_domain iovad, struct iova iova);
	91	struct iova alloc_iova(struct iova_domain iovad, unsigned long size,
f76aec76 KA	92	unsigned long limit_pfn,
f76aec76 KA	93	bool size_aligned);
9257b4a2 OP	94	void free_iova_fast(struct iova_domain *iovad, unsigned long pfn,
	95	unsigned long size);
	96	unsigned long alloc_iova_fast(struct iova_domain *iovad, unsigned long size,
538d5b33	97	unsigned long limit_pfn, bool flush_rcache);
f8de50eb KA	98	struct iova reserve_iova(struct iova_domain iovad, unsigned long pfn_lo,
f8de50eb KA	99	unsigned long pfn_hi);
0fb5fe87	100	void init_iova_domain(struct iova_domain *iovad, unsigned long granule,
aa3ac946	101	unsigned long start_pfn);
32e92d9f	102	int iova_domain_init_rcaches(struct iova_domain *iovad);
f8de50eb KA	103	struct iova find_iova(struct iova_domain iovad, unsigned long pfn);
f8de50eb KA	104	void put_iova_domain(struct iova_domain *iovad);
21aff52a TR	105	#else
	106	static inline int iova_cache_get(void)
	107	{
	108	return -ENOTSUPP;
	109	}
	110
	111	static inline void iova_cache_put(void)
	112	{
	113	}
	114
21aff52a TR	115	static inline void free_iova(struct iova_domain *iovad, unsigned long pfn)
	116	{
	117	}
	118
	119	static inline void __free_iova(struct iova_domain iovad, struct iova iova)
	120	{
	121	}
	122
	123	static inline struct iova alloc_iova(struct iova_domain iovad,
	124	unsigned long size,
	125	unsigned long limit_pfn,
	126	bool size_aligned)
	127	{
	128	return NULL;
	129	}
	130
	131	static inline void free_iova_fast(struct iova_domain *iovad,
	132	unsigned long pfn,
	133	unsigned long size)
	134	{
	135	}
	136
	137	static inline unsigned long alloc_iova_fast(struct iova_domain *iovad,
	138	unsigned long size,
538d5b33 TN	139	unsigned long limit_pfn,
538d5b33 TN	140	bool flush_rcache)
21aff52a TR	141	{
	142	return 0;
	143	}
	144
	145	static inline struct iova reserve_iova(struct iova_domain iovad,
	146	unsigned long pfn_lo,
	147	unsigned long pfn_hi)
	148	{
	149	return NULL;
	150	}
	151
21aff52a TR	152	static inline void init_iova_domain(struct iova_domain *iovad,
21aff52a TR	153	unsigned long granule,
aa3ac946	154	unsigned long start_pfn)
21aff52a TR	155	{
	156	}
	157
	158	static inline struct iova find_iova(struct iova_domain iovad,
	159	unsigned long pfn)
	160	{
	161	return NULL;
	162	}
	163
	164	static inline void put_iova_domain(struct iova_domain *iovad)
	165	{
	166	}
	167
21aff52a	168	#endif
f8de50eb KA	169
f8de50eb KA	170	#endif