[linux.git] / drivers / xen / gntdev-common.h

/* SPDX-License-Identifier: GPL-2.0 */

/*
 * Common functionality of grant device.
 *
 * Copyright (c) 2006-2007, D G Murray.
 *           (c) 2009 Gerd Hoffmann <[email protected]>
 *           (c) 2018 Oleksandr Andrushchenko, EPAM Systems Inc.
 */

#ifndef _GNTDEV_COMMON_H
#define _GNTDEV_COMMON_H

#include <linux/mm.h>
#include <linux/mman.h>
#include <linux/mmu_notifier.h>
#include <linux/types.h>
#include <xen/interface/event_channel.h>
#include <xen/grant_table.h>

struct gntdev_dmabuf_priv;

struct gntdev_priv {
	/* Maps with visible offsets in the file descriptor. */
	struct list_head maps;
	/* lock protects maps and freeable_maps. */
	struct mutex lock;

#ifdef CONFIG_XEN_GRANT_DMA_ALLOC
	/* Device for which DMA memory is allocated. */
	struct device *dma_dev;
#endif

#ifdef CONFIG_XEN_GNTDEV_DMABUF
	struct gntdev_dmabuf_priv *dmabuf_priv;
#endif
};

struct gntdev_unmap_notify {
	int flags;
	/* Address relative to the start of the gntdev_grant_map. */
	int addr;
	evtchn_port_t event;
};

struct gntdev_grant_map {
	atomic_t in_use;
	struct mmu_interval_notifier notifier;
	bool notifier_init;
	struct list_head next;
	int index;
	int count;
	int flags;
	refcount_t users;
	struct gntdev_unmap_notify notify;
	struct ioctl_gntdev_grant_ref *grants;
	struct gnttab_map_grant_ref   *map_ops;
	struct gnttab_unmap_grant_ref *unmap_ops;
	struct gnttab_map_grant_ref   *kmap_ops;
	struct gnttab_unmap_grant_ref *kunmap_ops;
	bool *being_removed;
	struct page **pages;
	unsigned long pages_vm_start;

#ifdef CONFIG_XEN_GRANT_DMA_ALLOC
	/*
	 * If dmabuf_vaddr is not NULL then this mapping is backed by DMA
	 * capable memory.
	 */

	struct device *dma_dev;
	/* Flags used to create this DMA buffer: GNTDEV_DMA_FLAG_XXX. */
	int dma_flags;
	void *dma_vaddr;
	dma_addr_t dma_bus_addr;
	/* Needed to avoid allocation in gnttab_dma_free_pages(). */
	xen_pfn_t *frames;
#endif

	/* Number of live grants */
	atomic_t live_grants;
	/* Needed to avoid allocation in __unmap_grant_pages */
	struct gntab_unmap_queue_data unmap_data;
};

struct gntdev_grant_map *gntdev_alloc_map(struct gntdev_priv *priv, int count,
					  int dma_flags);

void gntdev_add_map(struct gntdev_priv *priv, struct gntdev_grant_map *add);

void gntdev_put_map(struct gntdev_priv *priv, struct gntdev_grant_map *map);

bool gntdev_test_page_count(unsigned int count);

int gntdev_map_grant_pages(struct gntdev_grant_map *map);

#endif
Commit	Line	Data
1d314567 OA	1	/* SPDX-License-Identifier: GPL-2.0 */
	2
	3	/*
	4	* Common functionality of grant device.
	5	*
	6	* Copyright (c) 2006-2007, D G Murray.
	7	* (c) 2009 Gerd Hoffmann <[email protected]>
	8	* (c) 2018 Oleksandr Andrushchenko, EPAM Systems Inc.
	9	*/
	10
	11	#ifndef _GNTDEV_COMMON_H
	12	#define _GNTDEV_COMMON_H
	13
	14	#include <linux/mm.h>
	15	#include <linux/mman.h>
	16	#include <linux/mmu_notifier.h>
	17	#include <linux/types.h>
0102e4ef	18	#include <xen/interface/event_channel.h>
dbe97cff	19	#include <xen/grant_table.h>
1d314567	20
932d6562 OA	21	struct gntdev_dmabuf_priv;
932d6562 OA	22
1d314567 OA	23	struct gntdev_priv {
	24	/* Maps with visible offsets in the file descriptor. */
	25	struct list_head maps;
1d314567 OA	26	/* lock protects maps and freeable_maps. */
1d314567 OA	27	struct mutex lock;
1d314567 OA	28
	29	#ifdef CONFIG_XEN_GRANT_DMA_ALLOC
	30	/* Device for which DMA memory is allocated. */
	31	struct device *dma_dev;
	32	#endif
932d6562 OA	33
	34	#ifdef CONFIG_XEN_GNTDEV_DMABUF
	35	struct gntdev_dmabuf_priv *dmabuf_priv;
	36	#endif
1d314567 OA	37	};
	38
	39	struct gntdev_unmap_notify {
	40	int flags;
	41	/* Address relative to the start of the gntdev_grant_map. */
	42	int addr;
0102e4ef	43	evtchn_port_t event;
1d314567 OA	44	};
	45
	46	struct gntdev_grant_map {
5c13a4a0	47	atomic_t in_use;
d3eeb1d7	48	struct mmu_interval_notifier notifier;
5c13a4a0	49	bool notifier_init;
1d314567	50	struct list_head next;
1d314567 OA	51	int index;
	52	int count;
	53	int flags;
	54	refcount_t users;
	55	struct gntdev_unmap_notify notify;
	56	struct ioctl_gntdev_grant_ref *grants;
	57	struct gnttab_map_grant_ref *map_ops;
	58	struct gnttab_unmap_grant_ref *unmap_ops;
	59	struct gnttab_map_grant_ref *kmap_ops;
	60	struct gnttab_unmap_grant_ref *kunmap_ops;
dbe97cff	61	bool *being_removed;
1d314567 OA	62	struct page **pages;
	63	unsigned long pages_vm_start;
	64
	65	#ifdef CONFIG_XEN_GRANT_DMA_ALLOC
	66	/*
	67	* If dmabuf_vaddr is not NULL then this mapping is backed by DMA
	68	* capable memory.
	69	*/
	70
	71	struct device *dma_dev;
	72	/* Flags used to create this DMA buffer: GNTDEV_DMA_FLAG_XXX. */
	73	int dma_flags;
	74	void *dma_vaddr;
	75	dma_addr_t dma_bus_addr;
	76	/* Needed to avoid allocation in gnttab_dma_free_pages(). */
	77	xen_pfn_t *frames;
	78	#endif
dbe97cff DMO	79
	80	/* Number of live grants */
	81	atomic_t live_grants;
	82	/* Needed to avoid allocation in __unmap_grant_pages */
	83	struct gntab_unmap_queue_data unmap_data;
1d314567 OA	84	};
	85
	86	struct gntdev_grant_map gntdev_alloc_map(struct gntdev_priv priv, int count,
	87	int dma_flags);
	88
	89	void gntdev_add_map(struct gntdev_priv priv, struct gntdev_grant_map add);
	90
	91	void gntdev_put_map(struct gntdev_priv priv, struct gntdev_grant_map map);
	92
3b06ac67	93	bool gntdev_test_page_count(unsigned int count);
1d314567 OA	94
	95	int gntdev_map_grant_pages(struct gntdev_grant_map *map);
	96
	97	#endif