Home | History | Annotate | Line # | Download | only in vmwgfx
vmwgfx_resource_priv.h revision 1.1.1.1.12.2 
      1 /**************************************************************************
      2  *
      3  * Copyright  2012 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 /**
     34  * struct vmw_user_resource_conv - Identify a derived user-exported resource
     35  * type and provide a function to convert its ttm_base_object pointer to
     36  * a struct vmw_resource
     37  */
     38 struct vmw_user_resource_conv {
     39 	enum ttm_object_type object_type;
     40 	struct vmw_resource *(*base_obj_to_res)(struct ttm_base_object *base);
     41 	void (*res_free) (struct vmw_resource *res);
     42 };
     43 
     44 /**
     45  * struct vmw_res_func - members and functions common for a resource type
     46  *
     47  * @res_type:          Enum that identifies the lru list to use for eviction.
     48  * @needs_backup:      Whether the resource is guest-backed and needs
     49  *                     persistent buffer storage.
     50  * @type_name:         String that identifies the resource type.
     51  * @backup_placement:  TTM placement for backup buffers.
     52  * @may_evict          Whether the resource may be evicted.
     53  * @create:            Create a hardware resource.
     54  * @destroy:           Destroy a hardware resource.
     55  * @bind:              Bind a hardware resource to persistent buffer storage.
     56  * @unbind:            Unbind a hardware resource from persistent
     57  *                     buffer storage.
     58  */
     59 
     60 struct vmw_res_func {
     61 	enum vmw_res_type res_type;
     62 	bool needs_backup;
     63 	const char *type_name;
     64 	struct ttm_placement *backup_placement;
     65 	bool may_evict;
     66 
     67 	int (*create) (struct vmw_resource *res);
     68 	int (*destroy) (struct vmw_resource *res);
     69 	int (*bind) (struct vmw_resource *res,
     70 		     struct ttm_validate_buffer *val_buf);
     71 	int (*unbind) (struct vmw_resource *res,
     72 		       bool readback,
     73 		       struct ttm_validate_buffer *val_buf);
     74 };
     75 
     76 int vmw_resource_alloc_id(struct vmw_resource *res);
     77 void vmw_resource_release_id(struct vmw_resource *res);
     78 int vmw_resource_init(struct vmw_private *dev_priv, struct vmw_resource *res,
     79 		      bool delay_id,
     80 		      void (*res_free) (struct vmw_resource *res),
     81 		      const struct vmw_res_func *func);
     82 void vmw_resource_activate(struct vmw_resource *res,
     83 			   void (*hw_destroy) (struct vmw_resource *));
     84 #endif
     85