Subversion Repositories Kolibri OS

/**************************************************************************

 *

 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA

 * All Rights Reserved.

 *

 * 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.

 *

 **************************************************************************/

/*

 * Authors: Thomas Hellstrom 

 */

#ifndef _TTM_BO_API_H_

#define _TTM_BO_API_H_

#include "drm_hashtab.h"

#include 

#include 

#include 

//#include 

//#include 

//#include 

//#include 

#include 

struct ttm_bo_device;

struct drm_mm_node;

/**

 * struct ttm_placement

 *

 * @fpfn:		first valid page frame number to put the object

 * @lpfn:		last valid page frame number to put the object

 * @num_placement:	number of prefered placements

 * @placement:		prefered placements

 * @num_busy_placement:	number of prefered placements when need to evict buffer

 * @busy_placement:	prefered placements when need to evict buffer

 *

 * Structure indicating the placement you request for an object.

 */

struct ttm_placement {

	unsigned	fpfn;

	unsigned	lpfn;

	unsigned	num_placement;

	const uint32_t	*placement;

	unsigned	num_busy_placement;

	const uint32_t	*busy_placement;

};

/**

 * struct ttm_mem_reg

 *

 * @mm_node: Memory manager node.

 * @size: Requested size of memory region.

 * @num_pages: Actual size of memory region in pages.

 * @page_alignment: Page alignment.

 * @placement: Placement flags.

 *

 * Structure indicating the placement and space resources used by a

 * buffer object.

 */

struct ttm_mem_reg {

	struct drm_mm_node *mm_node;

	unsigned long size;

	unsigned long num_pages;

	uint32_t page_alignment;

	uint32_t mem_type;

	uint32_t placement;

};

/**

 * enum ttm_bo_type

 *

 * @ttm_bo_type_device:	These are 'normal' buffers that can

 * be mmapped by user space. Each of these bos occupy a slot in the

 * device address space, that can be used for normal vm operations.

 *

 * @ttm_bo_type_user: These are user-space memory areas that are made

 * available to the GPU by mapping the buffer pages into the GPU aperture

 * space. These buffers cannot be mmaped from the device address space.

 *

 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,

 * but they cannot be accessed from user-space. For kernel-only use.

 */

enum ttm_bo_type {

	ttm_bo_type_device,

	ttm_bo_type_user,

	ttm_bo_type_kernel

};

struct ttm_tt;

/**

 * struct ttm_buffer_object

 *

 * @bdev: Pointer to the buffer object device structure.

 * @buffer_start: The virtual user-space start address of ttm_bo_type_user

 * buffers.

 * @type: The bo type.

 * @destroy: Destruction function. If NULL, kfree is used.

 * @num_pages: Actual number of pages.

 * @addr_space_offset: Address space offset.

 * @acc_size: Accounted size for this object.

 * @kref: Reference count of this buffer object. When this refcount reaches

 * zero, the object is put on the delayed delete list.

 * @list_kref: List reference count of this buffer object. This member is

 * used to avoid destruction while the buffer object is still on a list.

 * Lru lists may keep one refcount, the delayed delete list, and kref != 0

 * keeps one refcount. When this refcount reaches zero,

 * the object is destroyed.

 * @event_queue: Queue for processes waiting on buffer object status change.

 * @lock: spinlock protecting mostly synchronization members.

 * @mem: structure describing current placement.

 * @persistant_swap_storage: Usually the swap storage is deleted for buffers

 * pinned in physical memory. If this behaviour is not desired, this member

 * holds a pointer to a persistant shmem object.

 * @ttm: TTM structure holding system pages.

 * @evicted: Whether the object was evicted without user-space knowing.

 * @cpu_writes: For synchronization. Number of cpu writers.

 * @lru: List head for the lru list.

 * @ddestroy: List head for the delayed destroy list.

 * @swap: List head for swap LRU list.

 * @val_seq: Sequence of the validation holding the @reserved lock.

 * Used to avoid starvation when many processes compete to validate the

 * buffer. This member is protected by the bo_device::lru_lock.

 * @seq_valid: The value of @val_seq is valid. This value is protected by

 * the bo_device::lru_lock.

 * @reserved: Deadlock-free lock used for synchronization state transitions.

 * @sync_obj_arg: Opaque argument to synchronization object function.

 * @sync_obj: Pointer to a synchronization object.

 * @priv_flags: Flags describing buffer object internal state.

 * @vm_rb: Rb node for the vm rb tree.

 * @vm_node: Address space manager node.

 * @offset: The current GPU offset, which can have different meanings

 * depending on the memory type. For SYSTEM type memory, it should be 0.

 * @cur_placement: Hint of current placement.

 *

 * Base class for TTM buffer object, that deals with data placement and CPU

 * mappings. GPU mappings are really up to the driver, but for simpler GPUs

 * the driver can usually use the placement offset @offset directly as the

 * GPU virtual address. For drivers implementing multiple

 * GPU memory manager contexts, the driver should manage the address space

 * in these contexts separately and use these objects to get the correct

 * placement and caching for these GPU maps. This makes it possible to use

 * these objects for even quite elaborate memory management schemes.

 * The destroy member, the API visibility of this object makes it possible

 * to derive driver specific types.

 */

struct ttm_buffer_object {

	/**

	 * Members constant at init.

	 */

	struct ttm_bo_global *glob;

	struct ttm_bo_device *bdev;

	unsigned long buffer_start;

	enum ttm_bo_type type;

	void (*destroy) (struct ttm_buffer_object *);

	unsigned long num_pages;

	uint64_t addr_space_offset;

	size_t acc_size;

	/**

	* Members not needing protection.

	*/

   struct kref kref;

   struct kref list_kref;

//   wait_queue_head_t event_queue;

   spinlock_t lock;

	/**

	 * Members protected by the bo::reserved lock.

	 */

	struct ttm_mem_reg mem;

//   struct file *persistant_swap_storage;

	struct ttm_tt *ttm;

	bool evicted;

	/**

	 * Members protected by the bo::reserved lock only when written to.

	 */

   atomic_t cpu_writers;

	/**

	 * Members protected by the bdev::lru_lock.

	 */

	struct list_head lru;

	struct list_head ddestroy;

	struct list_head swap;

	uint32_t val_seq;

	bool seq_valid;

	/**

	 * Members protected by the bdev::lru_lock

	 * only when written to.

	 */

   atomic_t reserved;

	/**

	 * Members protected by the bo::lock

	 */

	void *sync_obj_arg;

	void *sync_obj;

	unsigned long priv_flags;

	/**

	 * Members protected by the bdev::vm_lock

	 */

//   struct rb_node vm_rb;

	struct drm_mm_node *vm_node;

	/**

	 * Special members that are protected by the reserve lock

	 * and the bo::lock when written to. Can be read with

	 * either of these locks held.

	 */

	unsigned long offset;

	uint32_t cur_placement;

};

/**

 * struct ttm_bo_kmap_obj

 *

 * @virtual: The current kernel virtual address.

 * @page: The page when kmap'ing a single page.

 * @bo_kmap_type: Type of bo_kmap.

 *

 * Object describing a kernel mapping. Since a TTM bo may be located

 * in various memory types with various caching policies, the

 * mapping can either be an ioremap, a vmap, a kmap or part of a

 * premapped region.