1 /**************************************************************************
2  *
3  * Copyright © 2012-2014 VMware, Inc., Palo Alto, CA., USA
4  * All Rights Reserved.
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_RESOURCE_PRIV_H_
29 #define _VMWGFX_RESOURCE_PRIV_H_
30 
31 #include "vmwgfx_drv.h"
32 
33 enum vmw_cmdbuf_res_state {
34 	VMW_CMDBUF_RES_COMMITTED,
35 	VMW_CMDBUF_RES_ADD,
36 	VMW_CMDBUF_RES_DEL
37 };
38 
39 /**
40  * struct vmw_user_resource_conv - Identify a derived user-exported resource
41  * type and provide a function to convert its ttm_base_object pointer to
42  * a struct vmw_resource
43  */
44 struct vmw_user_resource_conv {
45 	enum ttm_object_type object_type;
46 	struct vmw_resource *(*base_obj_to_res)(struct ttm_base_object *base);
47 	void (*res_free) (struct vmw_resource *res);
48 };
49 
50 /**
51  * struct vmw_res_func - members and functions common for a resource type
52  *
53  * @res_type:          Enum that identifies the lru list to use for eviction.
54  * @needs_backup:      Whether the resource is guest-backed and needs
55  *                     persistent buffer storage.
56  * @type_name:         String that identifies the resource type.
57  * @backup_placement:  TTM placement for backup buffers.
58  * @may_evict          Whether the resource may be evicted.
59  * @create:            Create a hardware resource.
60  * @destroy:           Destroy a hardware resource.
61  * @bind:              Bind a hardware resource to persistent buffer storage.
62  * @unbind:            Unbind a hardware resource from persistent
63  *                     buffer storage.
64  * @commit_notify:     If the resource is a command buffer managed resource,
65  *                     callback to notify that a define or remove command
66  *                     has been committed to the device.
67  */
68 struct vmw_res_func {
69 	enum vmw_res_type res_type;
70 	bool needs_backup;
71 	const char *type_name;
72 	struct ttm_placement *backup_placement;
73 	bool may_evict;
74 
75 	int (*create) (struct vmw_resource *res);
76 	int (*destroy) (struct vmw_resource *res);
77 	int (*bind) (struct vmw_resource *res,
78 		     struct ttm_validate_buffer *val_buf);
79 	int (*unbind) (struct vmw_resource *res,
80 		       bool readback,
81 		       struct ttm_validate_buffer *val_buf);
82 	void (*commit_notify)(struct vmw_resource *res,
83 			      enum vmw_cmdbuf_res_state state);
84 };
85 
86 int vmw_resource_alloc_id(struct vmw_resource *res);
87 void vmw_resource_release_id(struct vmw_resource *res);
88 int vmw_resource_init(struct vmw_private *dev_priv, struct vmw_resource *res,
89 		      bool delay_id,
90 		      void (*res_free) (struct vmw_resource *res),
91 		      const struct vmw_res_func *func);
92 void vmw_resource_activate(struct vmw_resource *res,
93 			   void (*hw_destroy) (struct vmw_resource *));
94 #endif
95