1 /**************************************************************************
2  *
3  * Copyright (c) 2006-2009 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  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
29  */
30 
31 #ifndef _TTM_PLACEMENT_H_
32 #define _TTM_PLACEMENT_H_
33 
34 #include <linux/types.h>
35 
36 /*
37  * Memory regions for data placement.
38  *
39  * Buffers placed in TTM_PL_SYSTEM are considered under TTMs control and can
40  * be swapped out whenever TTMs thinks it is a good idea.
41  * In cases where drivers would like to use TTM_PL_SYSTEM as a valid
42  * placement they need to be able to handle the issues that arise due to the
43  * above manually.
44  *
45  * For BO's which reside in system memory but for which the accelerator
46  * requires direct access (i.e. their usage needs to be synchronized
47  * between the CPU and accelerator via fences) a new, driver private
48  * placement that can handle such scenarios is a good idea.
49  */
50 
51 #define TTM_PL_SYSTEM           0
52 #define TTM_PL_TT               1
53 #define TTM_PL_VRAM             2
54 #define TTM_PL_PRIV             3
55 
56 /*
57  * TTM_PL_FLAG_TOPDOWN requests to be placed from the
58  * top of the memory area, instead of the bottom.
59  */
60 
61 #define TTM_PL_FLAG_CONTIGUOUS  (1 << 0)
62 #define TTM_PL_FLAG_TOPDOWN     (1 << 1)
63 
64 /* For multihop handling */
65 #define TTM_PL_FLAG_TEMPORARY   (1 << 2)
66 
67 /**
68  * struct ttm_place
69  *
70  * @fpfn:	first valid page frame number to put the object
71  * @lpfn:	last valid page frame number to put the object
72  * @mem_type:	One of TTM_PL_* where the resource should be allocated from.
73  * @flags:	memory domain and caching flags for the object
74  *
75  * Structure indicating a possible place to put an object.
76  */
77 struct ttm_place {
78 	unsigned	fpfn;
79 	unsigned	lpfn;
80 	uint32_t	mem_type;
81 	uint32_t	flags;
82 };
83 
84 /**
85  * struct ttm_placement
86  *
87  * @num_placement:	number of preferred placements
88  * @placement:		preferred placements
89  * @num_busy_placement:	number of preferred placements when need to evict buffer
90  * @busy_placement:	preferred placements when need to evict buffer
91  *
92  * Structure indicating the placement you request for an object.
93  */
94 struct ttm_placement {
95 	unsigned		num_placement;
96 	const struct ttm_place	*placement;
97 	unsigned		num_busy_placement;
98 	const struct ttm_place	*busy_placement;
99 };
100 
101 #endif
102