[linux-block.git] / drivers / gpu / drm / vmwgfx / vmwgfx_bo.h

/* SPDX-License-Identifier: GPL-2.0 OR MIT */
/**************************************************************************
 *
 * Copyright 2023 VMware, Inc., Palo Alto, CA., USA
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

#ifndef VMWGFX_BO_H
#define VMWGFX_BO_H

#include "device_include/svga_reg.h"

#include <drm/ttm/ttm_bo.h>
#include <drm/ttm/ttm_placement.h>

#include <linux/rbtree_types.h>
#include <linux/types.h>

struct vmw_bo_dirty;
struct vmw_fence_obj;
struct vmw_private;
struct vmw_resource;

enum vmw_bo_domain {
	VMW_BO_DOMAIN_SYS           = BIT(0),
	VMW_BO_DOMAIN_WAITABLE_SYS  = BIT(1),
	VMW_BO_DOMAIN_VRAM          = BIT(2),
	VMW_BO_DOMAIN_GMR           = BIT(3),
	VMW_BO_DOMAIN_MOB           = BIT(4),
};

struct vmw_bo_params {
	u32 domain;
	u32 busy_domain;
	enum ttm_bo_type bo_type;
	size_t size;
	bool pin;
};

/**
 * struct vmw_bo - TTM buffer object with vmwgfx additions
 * @tbo: The TTM buffer object
 * @placement: The preferred placement for this buffer object
 * @places: The chosen places for the preferred placement.
 * @busy_places: Chosen busy places for the preferred placement
 * @map: Kmap object for semi-persistent mappings
 * @res_tree: RB tree of resources using this buffer object as a backing MOB
 * @res_prios: Eviction priority counts for attached resources
 * @cpu_writers: Number of synccpu write grabs. Protected by reservation when
 * increased. May be decreased without reservation.
 * @dx_query_ctx: DX context if this buffer object is used as a DX query MOB
 * @dirty: structure for user-space dirty-tracking
 */
struct vmw_bo {
	struct ttm_buffer_object tbo;

	struct ttm_placement placement;
	struct ttm_place places[5];
	struct ttm_place busy_places[5];

	/* Protected by reservation */
	struct ttm_bo_kmap_obj map;

	struct rb_root res_tree;
	u32 res_prios[TTM_MAX_BO_PRIORITY];

	atomic_t cpu_writers;
	/* Not ref-counted.  Protected by binding_mutex */
	struct vmw_resource *dx_query_ctx;
	struct vmw_bo_dirty *dirty;
};

void vmw_bo_placement_set(struct vmw_bo *bo, u32 domain, u32 busy_domain);
void vmw_bo_placement_set_default_accelerated(struct vmw_bo *bo);

int vmw_bo_create(struct vmw_private *dev_priv,
		  struct vmw_bo_params *params,
		  struct vmw_bo **p_bo);

int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
		       struct drm_file *file_priv);

int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
		       struct vmw_bo *buf,
		       bool interruptible);
int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
			      struct vmw_bo *buf,
			      bool interruptible);
int vmw_bo_pin_in_start_of_vram(struct vmw_private *vmw_priv,
				struct vmw_bo *bo,
				bool interruptible);
void vmw_bo_pin_reserved(struct vmw_bo *bo, bool pin);
int vmw_bo_unpin(struct vmw_private *vmw_priv,
		 struct vmw_bo *bo,
		 bool interruptible);

void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
			  SVGAGuestPtr *ptr);
int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
			      struct drm_file *file_priv);
void vmw_bo_fence_single(struct ttm_buffer_object *bo,
			 struct vmw_fence_obj *fence);

void *vmw_bo_map_and_cache(struct vmw_bo *vbo);
void vmw_bo_unmap(struct vmw_bo *vbo);

void vmw_bo_move_notify(struct ttm_buffer_object *bo,
			struct ttm_resource *mem);
void vmw_bo_swap_notify(struct ttm_buffer_object *bo);

int vmw_user_bo_lookup(struct drm_file *filp,
		       u32 handle,
		       struct vmw_bo **out);
/**
 * vmw_bo_adjust_prio - Adjust the buffer object eviction priority
 * according to attached resources
 * @vbo: The struct vmw_bo
 */
static inline void vmw_bo_prio_adjust(struct vmw_bo *vbo)
{
	int i = ARRAY_SIZE(vbo->res_prios);

	while (i--) {
		if (vbo->res_prios[i]) {
			vbo->tbo.priority = i;
			return;
		}
	}

	vbo->tbo.priority = 3;
}

/**
 * vmw_bo_prio_add - Notify a buffer object of a newly attached resource
 * eviction priority
 * @vbo: The struct vmw_bo
 * @prio: The resource priority
 *
 * After being notified, the code assigns the highest resource eviction priority
 * to the backing buffer object (mob).
 */
static inline void vmw_bo_prio_add(struct vmw_bo *vbo, int prio)
{
	if (vbo->res_prios[prio]++ == 0)
		vmw_bo_prio_adjust(vbo);
}

/**
 * vmw_bo_used_prio_del - Notify a buffer object of a resource with a certain
 * priority being removed
 * @vbo: The struct vmw_bo
 * @prio: The resource priority
 *
 * After being notified, the code assigns the highest resource eviction priority
 * to the backing buffer object (mob).
 */
static inline void vmw_bo_prio_del(struct vmw_bo *vbo, int prio)
{
	if (--vbo->res_prios[prio] == 0)
		vmw_bo_prio_adjust(vbo);
}

static inline void vmw_bo_unreference(struct vmw_bo **buf)
{
	struct vmw_bo *tmp_buf = *buf;

	*buf = NULL;
	if (tmp_buf)
		ttm_bo_put(&tmp_buf->tbo);
}

static inline struct vmw_bo *vmw_bo_reference(struct vmw_bo *buf)
{
	ttm_bo_get(&buf->tbo);
	return buf;
}

static inline struct vmw_bo *vmw_user_bo_ref(struct vmw_bo *vbo)
{
	drm_gem_object_get(&vbo->tbo.base);
	return vbo;
}

static inline void vmw_user_bo_unref(struct vmw_bo **buf)
{
	struct vmw_bo *tmp_buf = *buf;

	*buf = NULL;
	if (tmp_buf)
		drm_gem_object_put(&tmp_buf->tbo.base);
}

static inline struct vmw_bo *to_vmw_bo(struct drm_gem_object *gobj)
{
	return container_of((gobj), struct vmw_bo, tbo.base);
}

#endif // VMWGFX_BO_H
Commit	Line	Data
09881d29 ZR	1	/* SPDX-License-Identifier: GPL-2.0 OR MIT */
	2	/**************************************************************************
	3	*
	4	* Copyright 2023 VMware, Inc., Palo Alto, CA., USA
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a
	7	* copy of this software and associated documentation files (the
	8	* "Software"), to deal in the Software without restriction, including
	9	* without limitation the rights to use, copy, modify, merge, publish,
	10	* distribute, sub license, and/or sell copies of the Software, and to
	11	* permit persons to whom the Software is furnished to do so, subject to
	12	* the following conditions:
	13	*
	14	* The above copyright notice and this permission notice (including the
	15	* next paragraph) shall be included in all copies or substantial portions
	16	* of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
	21	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
	22	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
	23	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
	24	* USE OR OTHER DEALINGS IN THE SOFTWARE.
	25	*
	26	**************************************************************************/
	27
	28	#ifndef VMWGFX_BO_H
	29	#define VMWGFX_BO_H
	30
	31	#include "device_include/svga_reg.h"
	32
	33	#include <drm/ttm/ttm_bo.h>
39985eea	34	#include <drm/ttm/ttm_placement.h>
09881d29 ZR	35
	36	#include <linux/rbtree_types.h>
	37	#include <linux/types.h>
	38
	39	struct vmw_bo_dirty;
	40	struct vmw_fence_obj;
	41	struct vmw_private;
	42	struct vmw_resource;
	43
39985eea ZR	44	enum vmw_bo_domain {
	45	VMW_BO_DOMAIN_SYS = BIT(0),
	46	VMW_BO_DOMAIN_WAITABLE_SYS = BIT(1),
	47	VMW_BO_DOMAIN_VRAM = BIT(2),
	48	VMW_BO_DOMAIN_GMR = BIT(3),
	49	VMW_BO_DOMAIN_MOB = BIT(4),
	50	};
	51
668b2066 ZR	52	struct vmw_bo_params {
	53	u32 domain;
	54	u32 busy_domain;
	55	enum ttm_bo_type bo_type;
	56	size_t size;
	57	bool pin;
	58	};
	59
09881d29 ZR	60	/**
09881d29 ZR	61	* struct vmw_bo - TTM buffer object with vmwgfx additions
668b2066 ZR	62	* @tbo: The TTM buffer object
	63	* @placement: The preferred placement for this buffer object
	64	* @places: The chosen places for the preferred placement.
	65	* @busy_places: Chosen busy places for the preferred placement
	66	* @map: Kmap object for semi-persistent mappings
09881d29	67	* @res_tree: RB tree of resources using this buffer object as a backing MOB
668b2066	68	* @res_prios: Eviction priority counts for attached resources
09881d29 ZR	69	* @cpu_writers: Number of synccpu write grabs. Protected by reservation when
	70	* increased. May be decreased without reservation.
	71	* @dx_query_ctx: DX context if this buffer object is used as a DX query MOB
09881d29 ZR	72	* @dirty: structure for user-space dirty-tracking
	73	*/
	74	struct vmw_bo {
668b2066	75	struct ttm_buffer_object tbo;
39985eea ZR	76
	77	struct ttm_placement placement;
	78	struct ttm_place places[5];
	79	struct ttm_place busy_places[5];
	80
668b2066 ZR	81	/* Protected by reservation */
	82	struct ttm_bo_kmap_obj map;
	83
09881d29	84	struct rb_root res_tree;
668b2066	85	u32 res_prios[TTM_MAX_BO_PRIORITY];
09881d29 ZR	86
	87	atomic_t cpu_writers;
	88	/* Not ref-counted. Protected by binding_mutex */
	89	struct vmw_resource *dx_query_ctx;
09881d29 ZR	90	struct vmw_bo_dirty *dirty;
	91	};
	92
39985eea ZR	93	void vmw_bo_placement_set(struct vmw_bo *bo, u32 domain, u32 busy_domain);
	94	void vmw_bo_placement_set_default_accelerated(struct vmw_bo *bo);
	95
09881d29	96	int vmw_bo_create(struct vmw_private *dev_priv,
668b2066	97	struct vmw_bo_params *params,
09881d29	98	struct vmw_bo **p_bo);
668b2066	99
09881d29 ZR	100	int vmw_bo_unref_ioctl(struct drm_device dev, void data,
	101	struct drm_file *file_priv);
	102
09881d29 ZR	103	int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
	104	struct vmw_bo *buf,
	105	bool interruptible);
	106	int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
	107	struct vmw_bo *buf,
	108	bool interruptible);
	109	int vmw_bo_pin_in_start_of_vram(struct vmw_private *vmw_priv,
	110	struct vmw_bo *bo,
	111	bool interruptible);
	112	void vmw_bo_pin_reserved(struct vmw_bo *bo, bool pin);
	113	int vmw_bo_unpin(struct vmw_private *vmw_priv,
	114	struct vmw_bo *bo,
	115	bool interruptible);
	116
	117	void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
	118	SVGAGuestPtr *ptr);
	119	int vmw_user_bo_synccpu_ioctl(struct drm_device dev, void data,
	120	struct drm_file *file_priv);
09881d29 ZR	121	void vmw_bo_fence_single(struct ttm_buffer_object *bo,
	122	struct vmw_fence_obj *fence);
	123
	124	void vmw_bo_map_and_cache(struct vmw_bo vbo);
	125	void vmw_bo_unmap(struct vmw_bo *vbo);
	126
	127	void vmw_bo_move_notify(struct ttm_buffer_object *bo,
	128	struct ttm_resource *mem);
	129	void vmw_bo_swap_notify(struct ttm_buffer_object *bo);
	130
668b2066 ZR	131	int vmw_user_bo_lookup(struct drm_file *filp,
	132	u32 handle,
	133	struct vmw_bo **out);
09881d29 ZR	134	/**
	135	* vmw_bo_adjust_prio - Adjust the buffer object eviction priority
	136	* according to attached resources
	137	* @vbo: The struct vmw_bo
	138	*/
	139	static inline void vmw_bo_prio_adjust(struct vmw_bo *vbo)
	140	{
	141	int i = ARRAY_SIZE(vbo->res_prios);
	142
	143	while (i--) {
	144	if (vbo->res_prios[i]) {
668b2066	145	vbo->tbo.priority = i;
09881d29 ZR	146	return;
	147	}
	148	}
	149
668b2066	150	vbo->tbo.priority = 3;
09881d29 ZR	151	}
	152
	153	/**
	154	* vmw_bo_prio_add - Notify a buffer object of a newly attached resource
	155	* eviction priority
	156	* @vbo: The struct vmw_bo
	157	* @prio: The resource priority
	158	*
	159	* After being notified, the code assigns the highest resource eviction priority
	160	* to the backing buffer object (mob).
	161	*/
	162	static inline void vmw_bo_prio_add(struct vmw_bo *vbo, int prio)
	163	{
	164	if (vbo->res_prios[prio]++ == 0)
	165	vmw_bo_prio_adjust(vbo);
	166	}
	167
	168	/**
668b2066	169	* vmw_bo_used_prio_del - Notify a buffer object of a resource with a certain
09881d29 ZR	170	* priority being removed
	171	* @vbo: The struct vmw_bo
	172	* @prio: The resource priority
	173	*
	174	* After being notified, the code assigns the highest resource eviction priority
	175	* to the backing buffer object (mob).
	176	*/
	177	static inline void vmw_bo_prio_del(struct vmw_bo *vbo, int prio)
	178	{
	179	if (--vbo->res_prios[prio] == 0)
	180	vmw_bo_prio_adjust(vbo);
	181	}
	182
	183	static inline void vmw_bo_unreference(struct vmw_bo **buf)
	184	{
	185	struct vmw_bo tmp_buf = buf;
	186
	187	*buf = NULL;
	188	if (tmp_buf)
668b2066	189	ttm_bo_put(&tmp_buf->tbo);
09881d29 ZR	190	}
	191
	192	static inline struct vmw_bo vmw_bo_reference(struct vmw_bo buf)
	193	{
668b2066	194	ttm_bo_get(&buf->tbo);
09881d29 ZR	195	return buf;
	196	}
	197
91398b41	198	static inline struct vmw_bo vmw_user_bo_ref(struct vmw_bo vbo)
f9e96bf1	199	{
91398b41 ZR	200	drm_gem_object_get(&vbo->tbo.base);
	201	return vbo;
	202	}
	203
	204	static inline void vmw_user_bo_unref(struct vmw_bo **buf)
	205	{
	206	struct vmw_bo tmp_buf = buf;
	207
	208	*buf = NULL;
	209	if (tmp_buf)
	210	drm_gem_object_put(&tmp_buf->tbo.base);
f9e96bf1 ZR	211	}
f9e96bf1 ZR	212
09881d29 ZR	213	static inline struct vmw_bo to_vmw_bo(struct drm_gem_object gobj)
09881d29 ZR	214	{
668b2066	215	return container_of((gobj), struct vmw_bo, tbo.base);
09881d29 ZR	216	}
	217
	218	#endif // VMWGFX_BO_H