]>
Commit | Line | Data |
---|---|---|
ba4e7d97 TH |
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 | #ifndef _TTM_BO_DRIVER_H_ | |
31 | #define _TTM_BO_DRIVER_H_ | |
32 | ||
a1ce3928 DH |
33 | #include <ttm/ttm_bo_api.h> |
34 | #include <ttm/ttm_memory.h> | |
35 | #include <ttm/ttm_module.h> | |
34820324 | 36 | #include <ttm/ttm_placement.h> |
a1ce3928 DH |
37 | #include <drm/drm_mm.h> |
38 | #include <drm/drm_global.h> | |
72525b3f | 39 | #include <drm/drm_vma_manager.h> |
a1ce3928 DH |
40 | #include <linux/workqueue.h> |
41 | #include <linux/fs.h> | |
42 | #include <linux/spinlock.h> | |
ecff665f | 43 | #include <linux/reservation.h> |
ba4e7d97 | 44 | |
ba4e7d97 | 45 | struct ttm_backend_func { |
ba4e7d97 TH |
46 | /** |
47 | * struct ttm_backend_func member bind | |
48 | * | |
649bf3ca | 49 | * @ttm: Pointer to a struct ttm_tt. |
ba4e7d97 TH |
50 | * @bo_mem: Pointer to a struct ttm_mem_reg describing the |
51 | * memory type and location for binding. | |
52 | * | |
53 | * Bind the backend pages into the aperture in the location | |
54 | * indicated by @bo_mem. This function should be able to handle | |
0d74f86f | 55 | * differences between aperture and system page sizes. |
ba4e7d97 | 56 | */ |
649bf3ca | 57 | int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); |
ba4e7d97 TH |
58 | |
59 | /** | |
60 | * struct ttm_backend_func member unbind | |
61 | * | |
649bf3ca | 62 | * @ttm: Pointer to a struct ttm_tt. |
ba4e7d97 TH |
63 | * |
64 | * Unbind previously bound backend pages. This function should be | |
0d74f86f | 65 | * able to handle differences between aperture and system page sizes. |
ba4e7d97 | 66 | */ |
649bf3ca | 67 | int (*unbind) (struct ttm_tt *ttm); |
ba4e7d97 TH |
68 | |
69 | /** | |
70 | * struct ttm_backend_func member destroy | |
71 | * | |
649bf3ca | 72 | * @ttm: Pointer to a struct ttm_tt. |
ba4e7d97 | 73 | * |
649bf3ca JG |
74 | * Destroy the backend. This will be call back from ttm_tt_destroy so |
75 | * don't call ttm_tt_destroy from the callback or infinite loop. | |
ba4e7d97 | 76 | */ |
649bf3ca | 77 | void (*destroy) (struct ttm_tt *ttm); |
ba4e7d97 TH |
78 | }; |
79 | ||
ba4e7d97 TH |
80 | #define TTM_PAGE_FLAG_WRITE (1 << 3) |
81 | #define TTM_PAGE_FLAG_SWAPPED (1 << 4) | |
5df23979 | 82 | #define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5) |
ba4e7d97 | 83 | #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6) |
ad49f501 | 84 | #define TTM_PAGE_FLAG_DMA32 (1 << 7) |
129b78bf | 85 | #define TTM_PAGE_FLAG_SG (1 << 8) |
ba4e7d97 TH |
86 | |
87 | enum ttm_caching_state { | |
88 | tt_uncached, | |
89 | tt_wc, | |
90 | tt_cached | |
91 | }; | |
92 | ||
93 | /** | |
94 | * struct ttm_tt | |
95 | * | |
649bf3ca JG |
96 | * @bdev: Pointer to a struct ttm_bo_device. |
97 | * @func: Pointer to a struct ttm_backend_func that describes | |
98 | * the backend methods. | |
ba4e7d97 TH |
99 | * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL |
100 | * pointer. | |
101 | * @pages: Array of pages backing the data. | |
ba4e7d97 TH |
102 | * @num_pages: Number of pages in the page array. |
103 | * @bdev: Pointer to the current struct ttm_bo_device. | |
104 | * @be: Pointer to the ttm backend. | |
ba4e7d97 TH |
105 | * @swap_storage: Pointer to shmem struct file for swap storage. |
106 | * @caching_state: The current caching state of the pages. | |
107 | * @state: The current binding state of the pages. | |
108 | * | |
109 | * This is a structure holding the pages, caching- and aperture binding | |
110 | * status for a buffer object that isn't backed by fixed (VRAM / AGP) | |
111 | * memory. | |
112 | */ | |
113 | ||
114 | struct ttm_tt { | |
649bf3ca JG |
115 | struct ttm_bo_device *bdev; |
116 | struct ttm_backend_func *func; | |
ba4e7d97 TH |
117 | struct page *dummy_read_page; |
118 | struct page **pages; | |
ba4e7d97 TH |
119 | uint32_t page_flags; |
120 | unsigned long num_pages; | |
129b78bf | 121 | struct sg_table *sg; /* for SG objects via dma-buf */ |
a987fcaa | 122 | struct ttm_bo_global *glob; |
ba4e7d97 TH |
123 | struct file *swap_storage; |
124 | enum ttm_caching_state caching_state; | |
125 | enum { | |
126 | tt_bound, | |
127 | tt_unbound, | |
128 | tt_unpopulated, | |
129 | } state; | |
8e7e7052 JG |
130 | }; |
131 | ||
132 | /** | |
133 | * struct ttm_dma_tt | |
134 | * | |
135 | * @ttm: Base ttm_tt struct. | |
136 | * @dma_address: The DMA (bus) addresses of the pages | |
137 | * @pages_list: used by some page allocation backend | |
138 | * | |
139 | * This is a structure holding the pages, caching- and aperture binding | |
140 | * status for a buffer object that isn't backed by fixed (VRAM / AGP) | |
141 | * memory. | |
142 | */ | |
143 | struct ttm_dma_tt { | |
144 | struct ttm_tt ttm; | |
f9820a46 | 145 | dma_addr_t *dma_address; |
8e7e7052 | 146 | struct list_head pages_list; |
ba4e7d97 TH |
147 | }; |
148 | ||
149 | #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */ | |
150 | #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */ | |
ba4e7d97 TH |
151 | #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */ |
152 | ||
d961db75 BS |
153 | struct ttm_mem_type_manager; |
154 | ||
155 | struct ttm_mem_type_manager_func { | |
3205bc24 TH |
156 | /** |
157 | * struct ttm_mem_type_manager member init | |
158 | * | |
159 | * @man: Pointer to a memory type manager. | |
160 | * @p_size: Implementation dependent, but typically the size of the | |
161 | * range to be managed in pages. | |
162 | * | |
163 | * Called to initialize a private range manager. The function is | |
164 | * expected to initialize the man::priv member. | |
165 | * Returns 0 on success, negative error code on failure. | |
166 | */ | |
d961db75 | 167 | int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size); |
3205bc24 TH |
168 | |
169 | /** | |
170 | * struct ttm_mem_type_manager member takedown | |
171 | * | |
172 | * @man: Pointer to a memory type manager. | |
173 | * | |
174 | * Called to undo the setup done in init. All allocated resources | |
175 | * should be freed. | |
176 | */ | |
d961db75 | 177 | int (*takedown)(struct ttm_mem_type_manager *man); |
3205bc24 TH |
178 | |
179 | /** | |
180 | * struct ttm_mem_type_manager member get_node | |
181 | * | |
182 | * @man: Pointer to a memory type manager. | |
183 | * @bo: Pointer to the buffer object we're allocating space for. | |
184 | * @placement: Placement details. | |
e3f20279 | 185 | * @flags: Additional placement flags. |
3205bc24 TH |
186 | * @mem: Pointer to a struct ttm_mem_reg to be filled in. |
187 | * | |
188 | * This function should allocate space in the memory type managed | |
189 | * by @man. Placement details if | |
190 | * applicable are given by @placement. If successful, | |
191 | * @mem::mm_node should be set to a non-null value, and | |
192 | * @mem::start should be set to a value identifying the beginning | |
193 | * of the range allocated, and the function should return zero. | |
25985edc | 194 | * If the memory region accommodate the buffer object, @mem::mm_node |
3205bc24 | 195 | * should be set to NULL, and the function should return 0. |
25985edc | 196 | * If a system error occurred, preventing the request to be fulfilled, |
3205bc24 TH |
197 | * the function should return a negative error code. |
198 | * | |
199 | * Note that @mem::mm_node will only be dereferenced by | |
200 | * struct ttm_mem_type_manager functions and optionally by the driver, | |
201 | * which has knowledge of the underlying type. | |
202 | * | |
203 | * This function may not be called from within atomic context, so | |
204 | * an implementation can and must use either a mutex or a spinlock to | |
205 | * protect any data structures managing the space. | |
206 | */ | |
d961db75 BS |
207 | int (*get_node)(struct ttm_mem_type_manager *man, |
208 | struct ttm_buffer_object *bo, | |
f1217ed0 | 209 | const struct ttm_place *place, |
d961db75 | 210 | struct ttm_mem_reg *mem); |
3205bc24 TH |
211 | |
212 | /** | |
213 | * struct ttm_mem_type_manager member put_node | |
214 | * | |
215 | * @man: Pointer to a memory type manager. | |
216 | * @mem: Pointer to a struct ttm_mem_reg to be filled in. | |
217 | * | |
218 | * This function frees memory type resources previously allocated | |
219 | * and that are identified by @mem::mm_node and @mem::start. May not | |
220 | * be called from within atomic context. | |
221 | */ | |
d961db75 BS |
222 | void (*put_node)(struct ttm_mem_type_manager *man, |
223 | struct ttm_mem_reg *mem); | |
3205bc24 TH |
224 | |
225 | /** | |
226 | * struct ttm_mem_type_manager member debug | |
227 | * | |
228 | * @man: Pointer to a memory type manager. | |
229 | * @prefix: Prefix to be used in printout to identify the caller. | |
230 | * | |
231 | * This function is called to print out the state of the memory | |
232 | * type manager to aid debugging of out-of-memory conditions. | |
233 | * It may not be called from within atomic context. | |
234 | */ | |
d961db75 BS |
235 | void (*debug)(struct ttm_mem_type_manager *man, const char *prefix); |
236 | }; | |
237 | ||
eba67093 TH |
238 | /** |
239 | * struct ttm_mem_type_manager | |
240 | * | |
241 | * @has_type: The memory type has been initialized. | |
242 | * @use_type: The memory type is enabled. | |
243 | * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory | |
244 | * managed by this memory type. | |
245 | * @gpu_offset: If used, the GPU offset of the first managed page of | |
246 | * fixed memory or the first managed location in an aperture. | |
247 | * @size: Size of the managed region. | |
248 | * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX, | |
249 | * as defined in ttm_placement_common.h | |
250 | * @default_caching: The default caching policy used for a buffer object | |
251 | * placed in this memory type if the user doesn't provide one. | |
252 | * @func: structure pointer implementing the range manager. See above | |
253 | * @priv: Driver private closure for @func. | |
254 | * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures | |
255 | * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions | |
256 | * reserved by the TTM vm system. | |
257 | * @io_reserve_lru: Optional lru list for unreserving io mem regions. | |
258 | * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain | |
3ddf4ad9 | 259 | * @move_lock: lock for move fence |
eba67093 TH |
260 | * static information. bdev::driver::io_mem_free is never used. |
261 | * @lru: The lru list for this memory type. | |
3ddf4ad9 | 262 | * @move: The fence of the last pipelined move operation. |
eba67093 TH |
263 | * |
264 | * This structure is used to identify and manage memory types for a device. | |
265 | * It's set up by the ttm_bo_driver::init_mem_type method. | |
266 | */ | |
267 | ||
268 | ||
269 | ||
ba4e7d97 | 270 | struct ttm_mem_type_manager { |
d961db75 | 271 | struct ttm_bo_device *bdev; |
ba4e7d97 TH |
272 | |
273 | /* | |
274 | * No protection. Constant from start. | |
275 | */ | |
276 | ||
277 | bool has_type; | |
278 | bool use_type; | |
279 | uint32_t flags; | |
54c4cd68 | 280 | uint64_t gpu_offset; /* GPU address space is independent of CPU word size */ |
ba4e7d97 TH |
281 | uint64_t size; |
282 | uint32_t available_caching; | |
283 | uint32_t default_caching; | |
3205bc24 TH |
284 | const struct ttm_mem_type_manager_func *func; |
285 | void *priv; | |
eba67093 TH |
286 | struct mutex io_reserve_mutex; |
287 | bool use_io_reserve_lru; | |
288 | bool io_reserve_fastpath; | |
3ddf4ad9 | 289 | spinlock_t move_lock; |
eba67093 TH |
290 | |
291 | /* | |
292 | * Protected by @io_reserve_mutex: | |
293 | */ | |
294 | ||
295 | struct list_head io_reserve_lru; | |
ba4e7d97 TH |
296 | |
297 | /* | |
3205bc24 | 298 | * Protected by the global->lru_lock. |
ba4e7d97 | 299 | */ |
3205bc24 | 300 | |
ba4e7d97 | 301 | struct list_head lru; |
3ddf4ad9 CK |
302 | |
303 | /* | |
304 | * Protected by @move_lock. | |
305 | */ | |
f54d1867 | 306 | struct dma_fence *move; |
ba4e7d97 TH |
307 | }; |
308 | ||
309 | /** | |
310 | * struct ttm_bo_driver | |
311 | * | |
ba4e7d97 TH |
312 | * @create_ttm_backend_entry: Callback to create a struct ttm_backend. |
313 | * @invalidate_caches: Callback to invalidate read caches when a buffer object | |
314 | * has been evicted. | |
315 | * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager | |
316 | * structure. | |
317 | * @evict_flags: Callback to obtain placement flags when a buffer is evicted. | |
318 | * @move: Callback for a driver to hook in accelerated functions to | |
319 | * move a buffer. | |
320 | * If set to NULL, a potentially slow memcpy() move is used. | |
ba4e7d97 TH |
321 | */ |
322 | ||
323 | struct ttm_bo_driver { | |
ba4e7d97 | 324 | /** |
649bf3ca | 325 | * ttm_tt_create |
ba4e7d97 | 326 | * |
649bf3ca JG |
327 | * @bdev: pointer to a struct ttm_bo_device: |
328 | * @size: Size of the data needed backing. | |
329 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. | |
330 | * @dummy_read_page: See struct ttm_bo_device. | |
ba4e7d97 | 331 | * |
649bf3ca JG |
332 | * Create a struct ttm_tt to back data with system memory pages. |
333 | * No pages are actually allocated. | |
334 | * Returns: | |
335 | * NULL: Out of memory. | |
ba4e7d97 | 336 | */ |
649bf3ca JG |
337 | struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev, |
338 | unsigned long size, | |
339 | uint32_t page_flags, | |
340 | struct page *dummy_read_page); | |
ba4e7d97 | 341 | |
b1e5f172 JG |
342 | /** |
343 | * ttm_tt_populate | |
344 | * | |
345 | * @ttm: The struct ttm_tt to contain the backing pages. | |
346 | * | |
347 | * Allocate all backing pages | |
348 | * Returns: | |
349 | * -ENOMEM: Out of memory. | |
350 | */ | |
351 | int (*ttm_tt_populate)(struct ttm_tt *ttm); | |
352 | ||
353 | /** | |
354 | * ttm_tt_unpopulate | |
355 | * | |
356 | * @ttm: The struct ttm_tt to contain the backing pages. | |
357 | * | |
358 | * Free all backing page | |
359 | */ | |
360 | void (*ttm_tt_unpopulate)(struct ttm_tt *ttm); | |
361 | ||
ba4e7d97 TH |
362 | /** |
363 | * struct ttm_bo_driver member invalidate_caches | |
364 | * | |
365 | * @bdev: the buffer object device. | |
366 | * @flags: new placement of the rebound buffer object. | |
367 | * | |
368 | * A previosly evicted buffer has been rebound in a | |
369 | * potentially new location. Tell the driver that it might | |
370 | * consider invalidating read (texture) caches on the next command | |
371 | * submission as a consequence. | |
372 | */ | |
373 | ||
585ffd65 CK |
374 | int (*invalidate_caches)(struct ttm_bo_device *bdev, uint32_t flags); |
375 | int (*init_mem_type)(struct ttm_bo_device *bdev, uint32_t type, | |
376 | struct ttm_mem_type_manager *man); | |
a2ab19fe CK |
377 | |
378 | /** | |
379 | * struct ttm_bo_driver member eviction_valuable | |
380 | * | |
381 | * @bo: the buffer object to be evicted | |
382 | * @place: placement we need room for | |
383 | * | |
384 | * Check with the driver if it is valuable to evict a BO to make room | |
385 | * for a certain placement. | |
386 | */ | |
387 | bool (*eviction_valuable)(struct ttm_buffer_object *bo, | |
388 | const struct ttm_place *place); | |
ba4e7d97 TH |
389 | /** |
390 | * struct ttm_bo_driver member evict_flags: | |
391 | * | |
392 | * @bo: the buffer object to be evicted | |
393 | * | |
394 | * Return the bo flags for a buffer which is not mapped to the hardware. | |
395 | * These will be placed in proposed_flags so that when the move is | |
396 | * finished, they'll end up in bo->mem.flags | |
397 | */ | |
398 | ||
585ffd65 CK |
399 | void (*evict_flags)(struct ttm_buffer_object *bo, |
400 | struct ttm_placement *placement); | |
401 | ||
ba4e7d97 TH |
402 | /** |
403 | * struct ttm_bo_driver member move: | |
404 | * | |
405 | * @bo: the buffer to move | |
406 | * @evict: whether this motion is evicting the buffer from | |
407 | * the graphics address space | |
408 | * @interruptible: Use interruptible sleeps if possible when sleeping. | |
409 | * @no_wait: whether this should give up and return -EBUSY | |
410 | * if this move would require sleeping | |
411 | * @new_mem: the new memory region receiving the buffer | |
412 | * | |
413 | * Move a buffer between two memory regions. | |
414 | */ | |
585ffd65 CK |
415 | int (*move)(struct ttm_buffer_object *bo, bool evict, |
416 | bool interruptible, bool no_wait_gpu, | |
417 | struct ttm_mem_reg *new_mem); | |
ba4e7d97 TH |
418 | |
419 | /** | |
420 | * struct ttm_bo_driver_member verify_access | |
421 | * | |
422 | * @bo: Pointer to a buffer object. | |
423 | * @filp: Pointer to a struct file trying to access the object. | |
424 | * | |
425 | * Called from the map / write / read methods to verify that the | |
426 | * caller is permitted to access the buffer object. | |
427 | * This member may be set to NULL, which will refuse this kind of | |
428 | * access for all buffer objects. | |
429 | * This function should return 0 if access is granted, -EPERM otherwise. | |
430 | */ | |
585ffd65 CK |
431 | int (*verify_access)(struct ttm_buffer_object *bo, |
432 | struct file *filp); | |
ba4e7d97 | 433 | |
e024e110 DA |
434 | /* hook to notify driver about a driver move so it |
435 | * can do tiling things */ | |
436 | void (*move_notify)(struct ttm_buffer_object *bo, | |
437 | struct ttm_mem_reg *new_mem); | |
438 | /* notify the driver we are taking a fault on this BO | |
439 | * and have reserved it */ | |
82c5da6b | 440 | int (*fault_reserve_notify)(struct ttm_buffer_object *bo); |
3f09ea4e TH |
441 | |
442 | /** | |
443 | * notify the driver that we're about to swap out this bo | |
444 | */ | |
585ffd65 | 445 | void (*swap_notify)(struct ttm_buffer_object *bo); |
82c5da6b JG |
446 | |
447 | /** | |
448 | * Driver callback on when mapping io memory (for bo_move_memcpy | |
449 | * for instance). TTM will take care to call io_mem_free whenever | |
450 | * the mapping is not use anymore. io_mem_reserve & io_mem_free | |
451 | * are balanced. | |
452 | */ | |
585ffd65 CK |
453 | int (*io_mem_reserve)(struct ttm_bo_device *bdev, |
454 | struct ttm_mem_reg *mem); | |
455 | void (*io_mem_free)(struct ttm_bo_device *bdev, | |
456 | struct ttm_mem_reg *mem); | |
c3ea576e CK |
457 | |
458 | /** | |
459 | * Optional driver callback for when BO is removed from the LRU. | |
460 | * Called with LRU lock held immediately before the removal. | |
461 | */ | |
462 | void (*lru_removal)(struct ttm_buffer_object *bo); | |
98c2872a CK |
463 | |
464 | /** | |
465 | * Return the list_head after which a BO should be inserted in the LRU. | |
466 | */ | |
467 | struct list_head *(*lru_tail)(struct ttm_buffer_object *bo); | |
468 | struct list_head *(*swap_lru_tail)(struct ttm_buffer_object *bo); | |
ba4e7d97 TH |
469 | }; |
470 | ||
a987fcaa TH |
471 | /** |
472 | * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global. | |
473 | */ | |
474 | ||
475 | struct ttm_bo_global_ref { | |
ba4420c2 | 476 | struct drm_global_reference ref; |
a987fcaa TH |
477 | struct ttm_mem_global *mem_glob; |
478 | }; | |
ba4e7d97 | 479 | |
ba4e7d97 | 480 | /** |
a987fcaa | 481 | * struct ttm_bo_global - Buffer object driver global data. |
ba4e7d97 TH |
482 | * |
483 | * @mem_glob: Pointer to a struct ttm_mem_global object for accounting. | |
ba4e7d97 TH |
484 | * @dummy_read_page: Pointer to a dummy page used for mapping requests |
485 | * of unpopulated pages. | |
a987fcaa | 486 | * @shrink: A shrink callback object used for buffer object swap. |
a987fcaa TH |
487 | * @device_list_mutex: Mutex protecting the device list. |
488 | * This mutex is held while traversing the device list for pm options. | |
489 | * @lru_lock: Spinlock protecting the bo subsystem lru lists. | |
490 | * @device_list: List of buffer object devices. | |
491 | * @swap_lru: Lru list of buffer objects used for swapping. | |
492 | */ | |
493 | ||
494 | struct ttm_bo_global { | |
495 | ||
496 | /** | |
497 | * Constant after init. | |
498 | */ | |
499 | ||
500 | struct kobject kobj; | |
501 | struct ttm_mem_global *mem_glob; | |
502 | struct page *dummy_read_page; | |
503 | struct ttm_mem_shrink shrink; | |
a987fcaa TH |
504 | struct mutex device_list_mutex; |
505 | spinlock_t lru_lock; | |
506 | ||
507 | /** | |
508 | * Protected by device_list_mutex. | |
509 | */ | |
510 | struct list_head device_list; | |
511 | ||
512 | /** | |
513 | * Protected by the lru_lock. | |
514 | */ | |
515 | struct list_head swap_lru; | |
516 | ||
517 | /** | |
518 | * Internal protection. | |
519 | */ | |
520 | atomic_t bo_count; | |
521 | }; | |
522 | ||
523 | ||
524 | #define TTM_NUM_MEM_TYPES 8 | |
525 | ||
a987fcaa TH |
526 | /** |
527 | * struct ttm_bo_device - Buffer object driver device-specific data. | |
528 | * | |
529 | * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver. | |
ba4e7d97 | 530 | * @man: An array of mem_type_managers. |
72525b3f | 531 | * @vma_manager: Address space manager |
ba4e7d97 TH |
532 | * lru_lock: Spinlock that protects the buffer+device lru lists and |
533 | * ddestroy lists. | |
ba4e7d97 TH |
534 | * @dev_mapping: A pointer to the struct address_space representing the |
535 | * device address space. | |
536 | * @wq: Work queue structure for the delayed delete workqueue. | |
537 | * | |
538 | */ | |
539 | ||
540 | struct ttm_bo_device { | |
541 | ||
542 | /* | |
543 | * Constant after bo device init / atomic. | |
544 | */ | |
a987fcaa TH |
545 | struct list_head device_list; |
546 | struct ttm_bo_global *glob; | |
ba4e7d97 | 547 | struct ttm_bo_driver *driver; |
a987fcaa | 548 | struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES]; |
72525b3f | 549 | |
ba4e7d97 | 550 | /* |
72525b3f | 551 | * Protected by internal locks. |
ba4e7d97 | 552 | */ |
72525b3f | 553 | struct drm_vma_offset_manager vma_manager; |
ba4e7d97 TH |
554 | |
555 | /* | |
a987fcaa | 556 | * Protected by the global:lru lock. |
ba4e7d97 TH |
557 | */ |
558 | struct list_head ddestroy; | |
ba4e7d97 TH |
559 | |
560 | /* | |
561 | * Protected by load / firstopen / lastclose /unload sync. | |
562 | */ | |
563 | ||
ba4e7d97 TH |
564 | struct address_space *dev_mapping; |
565 | ||
566 | /* | |
567 | * Internal protection. | |
568 | */ | |
569 | ||
570 | struct delayed_work wq; | |
ad49f501 DA |
571 | |
572 | bool need_dma32; | |
ba4e7d97 TH |
573 | }; |
574 | ||
575 | /** | |
576 | * ttm_flag_masked | |
577 | * | |
578 | * @old: Pointer to the result and original value. | |
579 | * @new: New value of bits. | |
580 | * @mask: Mask of bits to change. | |
581 | * | |
582 | * Convenience function to change a number of bits identified by a mask. | |
583 | */ | |
584 | ||
585 | static inline uint32_t | |
586 | ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask) | |
587 | { | |
588 | *old ^= (*old ^ new) & mask; | |
589 | return *old; | |
590 | } | |
591 | ||
592 | /** | |
649bf3ca | 593 | * ttm_tt_init |
ba4e7d97 | 594 | * |
649bf3ca | 595 | * @ttm: The struct ttm_tt. |
ba4e7d97 TH |
596 | * @bdev: pointer to a struct ttm_bo_device: |
597 | * @size: Size of the data needed backing. | |
598 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. | |
599 | * @dummy_read_page: See struct ttm_bo_device. | |
600 | * | |
601 | * Create a struct ttm_tt to back data with system memory pages. | |
602 | * No pages are actually allocated. | |
603 | * Returns: | |
604 | * NULL: Out of memory. | |
605 | */ | |
649bf3ca JG |
606 | extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev, |
607 | unsigned long size, uint32_t page_flags, | |
608 | struct page *dummy_read_page); | |
8e7e7052 JG |
609 | extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev, |
610 | unsigned long size, uint32_t page_flags, | |
611 | struct page *dummy_read_page); | |
612 | ||
613 | /** | |
614 | * ttm_tt_fini | |
615 | * | |
616 | * @ttm: the ttm_tt structure. | |
617 | * | |
618 | * Free memory of ttm_tt structure | |
619 | */ | |
620 | extern void ttm_tt_fini(struct ttm_tt *ttm); | |
621 | extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma); | |
ba4e7d97 | 622 | |
ba4e7d97 TH |
623 | /** |
624 | * ttm_ttm_bind: | |
625 | * | |
626 | * @ttm: The struct ttm_tt containing backing pages. | |
627 | * @bo_mem: The struct ttm_mem_reg identifying the binding location. | |
628 | * | |
629 | * Bind the pages of @ttm to an aperture location identified by @bo_mem | |
630 | */ | |
631 | extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); | |
632 | ||
633 | /** | |
634 | * ttm_ttm_destroy: | |
635 | * | |
636 | * @ttm: The struct ttm_tt. | |
637 | * | |
649bf3ca | 638 | * Unbind, unpopulate and destroy common struct ttm_tt. |
ba4e7d97 TH |
639 | */ |
640 | extern void ttm_tt_destroy(struct ttm_tt *ttm); | |
641 | ||
2ff2bf1e CK |
642 | /** |
643 | * ttm_ttm_unbind: | |
644 | * | |
645 | * @ttm: The struct ttm_tt. | |
646 | * | |
647 | * Unbind a struct ttm_tt. | |
648 | */ | |
649 | extern void ttm_tt_unbind(struct ttm_tt *ttm); | |
650 | ||
ba4e7d97 | 651 | /** |
b1e5f172 | 652 | * ttm_tt_swapin: |
ba4e7d97 TH |
653 | * |
654 | * @ttm: The struct ttm_tt. | |
ba4e7d97 | 655 | * |
b1e5f172 | 656 | * Swap in a previously swap out ttm_tt. |
ba4e7d97 | 657 | */ |
b1e5f172 | 658 | extern int ttm_tt_swapin(struct ttm_tt *ttm); |
ba4e7d97 | 659 | |
ba4e7d97 TH |
660 | /** |
661 | * ttm_tt_set_placement_caching: | |
662 | * | |
663 | * @ttm A struct ttm_tt the backing pages of which will change caching policy. | |
664 | * @placement: Flag indicating the desired caching policy. | |
665 | * | |
666 | * This function will change caching policy of any default kernel mappings of | |
667 | * the pages backing @ttm. If changing from cached to uncached or | |
668 | * write-combined, | |
669 | * all CPU caches will first be flushed to make sure the data of the pages | |
670 | * hit RAM. This function may be very costly as it involves global TLB | |
671 | * and cache flushes and potential page splitting / combining. | |
672 | */ | |
673 | extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement); | |
674 | extern int ttm_tt_swapout(struct ttm_tt *ttm, | |
5df23979 | 675 | struct file *persistent_swap_storage); |
ba4e7d97 | 676 | |
58aa6622 TH |
677 | /** |
678 | * ttm_tt_unpopulate - free pages from a ttm | |
679 | * | |
680 | * @ttm: Pointer to the ttm_tt structure | |
681 | * | |
682 | * Calls the driver method to free all pages from a ttm | |
683 | */ | |
684 | extern void ttm_tt_unpopulate(struct ttm_tt *ttm); | |
685 | ||
ba4e7d97 TH |
686 | /* |
687 | * ttm_bo.c | |
688 | */ | |
689 | ||
690 | /** | |
691 | * ttm_mem_reg_is_pci | |
692 | * | |
693 | * @bdev: Pointer to a struct ttm_bo_device. | |
694 | * @mem: A valid struct ttm_mem_reg. | |
695 | * | |
696 | * Returns true if the memory described by @mem is PCI memory, | |
697 | * false otherwise. | |
698 | */ | |
699 | extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, | |
700 | struct ttm_mem_reg *mem); | |
701 | ||
702 | /** | |
703 | * ttm_bo_mem_space | |
704 | * | |
705 | * @bo: Pointer to a struct ttm_buffer_object. the data of which | |
706 | * we want to allocate space for. | |
707 | * @proposed_placement: Proposed new placement for the buffer object. | |
708 | * @mem: A struct ttm_mem_reg. | |
709 | * @interruptible: Sleep interruptible when sliping. | |
9d87fa21 | 710 | * @no_wait_gpu: Return immediately if the GPU is busy. |
ba4e7d97 TH |
711 | * |
712 | * Allocate memory space for the buffer object pointed to by @bo, using | |
713 | * the placement flags in @mem, potentially evicting other idle buffer objects. | |
714 | * This function may sleep while waiting for space to become available. | |
715 | * Returns: | |
716 | * -EBUSY: No space available (only if no_wait == 1). | |
717 | * -ENOMEM: Could not allocate memory for the buffer object, either due to | |
718 | * fragmentation or concurrent allocators. | |
98ffc415 | 719 | * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. |
ba4e7d97 TH |
720 | */ |
721 | extern int ttm_bo_mem_space(struct ttm_buffer_object *bo, | |
ca262a99 JG |
722 | struct ttm_placement *placement, |
723 | struct ttm_mem_reg *mem, | |
9d87fa21 | 724 | bool interruptible, |
97a875cb | 725 | bool no_wait_gpu); |
42311ff9 BS |
726 | |
727 | extern void ttm_bo_mem_put(struct ttm_buffer_object *bo, | |
728 | struct ttm_mem_reg *mem); | |
c9220b0f DA |
729 | extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo, |
730 | struct ttm_mem_reg *mem); | |
42311ff9 | 731 | |
ba4420c2 DA |
732 | extern void ttm_bo_global_release(struct drm_global_reference *ref); |
733 | extern int ttm_bo_global_init(struct drm_global_reference *ref); | |
a987fcaa | 734 | |
ba4e7d97 TH |
735 | extern int ttm_bo_device_release(struct ttm_bo_device *bdev); |
736 | ||
737 | /** | |
738 | * ttm_bo_device_init | |
739 | * | |
740 | * @bdev: A pointer to a struct ttm_bo_device to initialize. | |
0d74f86f | 741 | * @glob: A pointer to an initialized struct ttm_bo_global. |
ba4e7d97 | 742 | * @driver: A pointer to a struct ttm_bo_driver set up by the caller. |
44d847b7 | 743 | * @mapping: The address space to use for this bo. |
ba4e7d97 TH |
744 | * @file_page_offset: Offset into the device address space that is available |
745 | * for buffer data. This ensures compatibility with other users of the | |
746 | * address space. | |
747 | * | |
748 | * Initializes a struct ttm_bo_device: | |
749 | * Returns: | |
750 | * !0: Failure. | |
751 | */ | |
752 | extern int ttm_bo_device_init(struct ttm_bo_device *bdev, | |
a987fcaa | 753 | struct ttm_bo_global *glob, |
ba4e7d97 | 754 | struct ttm_bo_driver *driver, |
44d847b7 | 755 | struct address_space *mapping, |
ad49f501 | 756 | uint64_t file_page_offset, bool need_dma32); |
ba4e7d97 | 757 | |
e024e110 DA |
758 | /** |
759 | * ttm_bo_unmap_virtual | |
760 | * | |
761 | * @bo: tear down the virtual mappings for this BO | |
762 | */ | |
763 | extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo); | |
ba4e7d97 | 764 | |
eba67093 TH |
765 | /** |
766 | * ttm_bo_unmap_virtual | |
767 | * | |
768 | * @bo: tear down the virtual mappings for this BO | |
769 | * | |
770 | * The caller must take ttm_mem_io_lock before calling this function. | |
771 | */ | |
772 | extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo); | |
773 | ||
774 | extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo); | |
775 | extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo); | |
776 | extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man, | |
777 | bool interruptible); | |
778 | extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man); | |
779 | ||
34820324 ML |
780 | extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo); |
781 | extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo); | |
782 | ||
98c2872a CK |
783 | struct list_head *ttm_bo_default_lru_tail(struct ttm_buffer_object *bo); |
784 | struct list_head *ttm_bo_default_swap_lru_tail(struct ttm_buffer_object *bo); | |
785 | ||
34820324 | 786 | /** |
c7523083 | 787 | * __ttm_bo_reserve: |
34820324 ML |
788 | * |
789 | * @bo: A pointer to a struct ttm_buffer_object. | |
790 | * @interruptible: Sleep interruptible if waiting. | |
791 | * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. | |
dfd5e50e | 792 | * @ticket: ticket used to acquire the ww_mutex. |
34820324 ML |
793 | * |
794 | * Will not remove reserved buffers from the lru lists. | |
795 | * Otherwise identical to ttm_bo_reserve. | |
796 | * | |
797 | * Returns: | |
798 | * -EDEADLK: The reservation may cause a deadlock. | |
799 | * Release all buffer reservations, wait for @bo to become unreserved and | |
800 | * try again. (only if use_sequence == 1). | |
801 | * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by | |
802 | * a signal. Release all buffer reservations and return to user-space. | |
803 | * -EBUSY: The function needed to sleep, but @no_wait was true | |
804 | * -EALREADY: Bo already reserved using @ticket. This error code will only | |
805 | * be returned if @use_ticket is set to true. | |
806 | */ | |
c7523083 | 807 | static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo, |
dfd5e50e | 808 | bool interruptible, bool no_wait, |
c7523083 | 809 | struct ww_acquire_ctx *ticket) |
34820324 ML |
810 | { |
811 | int ret = 0; | |
812 | ||
813 | if (no_wait) { | |
814 | bool success; | |
815 | if (WARN_ON(ticket)) | |
816 | return -EBUSY; | |
817 | ||
818 | success = ww_mutex_trylock(&bo->resv->lock); | |
819 | return success ? 0 : -EBUSY; | |
820 | } | |
821 | ||
822 | if (interruptible) | |
823 | ret = ww_mutex_lock_interruptible(&bo->resv->lock, ticket); | |
824 | else | |
825 | ret = ww_mutex_lock(&bo->resv->lock, ticket); | |
826 | if (ret == -EINTR) | |
827 | return -ERESTARTSYS; | |
828 | return ret; | |
829 | } | |
eba67093 | 830 | |
ba4e7d97 TH |
831 | /** |
832 | * ttm_bo_reserve: | |
833 | * | |
834 | * @bo: A pointer to a struct ttm_buffer_object. | |
835 | * @interruptible: Sleep interruptible if waiting. | |
836 | * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. | |
dfd5e50e | 837 | * @ticket: ticket used to acquire the ww_mutex. |
ba4e7d97 TH |
838 | * |
839 | * Locks a buffer object for validation. (Or prevents other processes from | |
840 | * locking it for validation) and removes it from lru lists, while taking | |
841 | * a number of measures to prevent deadlocks. | |
842 | * | |
843 | * Deadlocks may occur when two processes try to reserve multiple buffers in | |
844 | * different order, either by will or as a result of a buffer being evicted | |
845 | * to make room for a buffer already reserved. (Buffers are reserved before | |
846 | * they are evicted). The following algorithm prevents such deadlocks from | |
25985edc | 847 | * occurring: |
63d0a419 | 848 | * Processes attempting to reserve multiple buffers other than for eviction, |
ba4e7d97 TH |
849 | * (typically execbuf), should first obtain a unique 32-bit |
850 | * validation sequence number, | |
34820324 | 851 | * and call this function with @use_ticket == 1 and @ticket->stamp == the unique |
ba4e7d97 TH |
852 | * sequence number. If upon call of this function, the buffer object is already |
853 | * reserved, the validation sequence is checked against the validation | |
854 | * sequence of the process currently reserving the buffer, | |
855 | * and if the current validation sequence is greater than that of the process | |
eb227c55 | 856 | * holding the reservation, the function returns -EDEADLK. Otherwise it sleeps |
ba4e7d97 TH |
857 | * waiting for the buffer to become unreserved, after which it retries |
858 | * reserving. | |
eb227c55 | 859 | * The caller should, when receiving an -EDEADLK error |
ba4e7d97 TH |
860 | * release all its buffer reservations, wait for @bo to become unreserved, and |
861 | * then rerun the validation with the same validation sequence. This procedure | |
862 | * will always guarantee that the process with the lowest validation sequence | |
863 | * will eventually succeed, preventing both deadlocks and starvation. | |
864 | * | |
865 | * Returns: | |
34820324 | 866 | * -EDEADLK: The reservation may cause a deadlock. |
ba4e7d97 TH |
867 | * Release all buffer reservations, wait for @bo to become unreserved and |
868 | * try again. (only if use_sequence == 1). | |
98ffc415 | 869 | * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by |
ba4e7d97 | 870 | * a signal. Release all buffer reservations and return to user-space. |
96726fe5 | 871 | * -EBUSY: The function needed to sleep, but @no_wait was true |
34820324 ML |
872 | * -EALREADY: Bo already reserved using @ticket. This error code will only |
873 | * be returned if @use_ticket is set to true. | |
ba4e7d97 | 874 | */ |
34820324 | 875 | static inline int ttm_bo_reserve(struct ttm_buffer_object *bo, |
dfd5e50e | 876 | bool interruptible, bool no_wait, |
34820324 ML |
877 | struct ww_acquire_ctx *ticket) |
878 | { | |
879 | int ret; | |
ba4e7d97 | 880 | |
2c935bc5 | 881 | WARN_ON(!kref_read(&bo->kref)); |
34820324 | 882 | |
dfd5e50e | 883 | ret = __ttm_bo_reserve(bo, interruptible, no_wait, ticket); |
34820324 ML |
884 | if (likely(ret == 0)) |
885 | ttm_bo_del_sub_from_lru(bo); | |
5e45d7df | 886 | |
34820324 ML |
887 | return ret; |
888 | } | |
5e45d7df ML |
889 | |
890 | /** | |
891 | * ttm_bo_reserve_slowpath: | |
892 | * @bo: A pointer to a struct ttm_buffer_object. | |
893 | * @interruptible: Sleep interruptible if waiting. | |
894 | * @sequence: Set (@bo)->sequence to this value after lock | |
895 | * | |
896 | * This is called after ttm_bo_reserve returns -EAGAIN and we backed off | |
897 | * from all our other reservations. Because there are no other reservations | |
898 | * held by us, this function cannot deadlock any more. | |
899 | */ | |
34820324 ML |
900 | static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo, |
901 | bool interruptible, | |
902 | struct ww_acquire_ctx *ticket) | |
903 | { | |
904 | int ret = 0; | |
d6ea8886 | 905 | |
2c935bc5 | 906 | WARN_ON(!kref_read(&bo->kref)); |
d6ea8886 | 907 | |
34820324 ML |
908 | if (interruptible) |
909 | ret = ww_mutex_lock_slow_interruptible(&bo->resv->lock, | |
910 | ticket); | |
911 | else | |
912 | ww_mutex_lock_slow(&bo->resv->lock, ticket); | |
913 | ||
914 | if (likely(ret == 0)) | |
915 | ttm_bo_del_sub_from_lru(bo); | |
916 | else if (ret == -EINTR) | |
917 | ret = -ERESTARTSYS; | |
918 | ||
919 | return ret; | |
920 | } | |
ba4e7d97 | 921 | |
95762c2b | 922 | /** |
c7523083 | 923 | * __ttm_bo_unreserve |
ecff665f | 924 | * @bo: A pointer to a struct ttm_buffer_object. |
95762c2b | 925 | * |
c7523083 TH |
926 | * Unreserve a previous reservation of @bo where the buffer object is |
927 | * already on lru lists. | |
ecff665f | 928 | */ |
c7523083 | 929 | static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo) |
34820324 | 930 | { |
34820324 ML |
931 | ww_mutex_unlock(&bo->resv->lock); |
932 | } | |
ecff665f ML |
933 | |
934 | /** | |
34820324 ML |
935 | * ttm_bo_unreserve |
936 | * | |
95762c2b TH |
937 | * @bo: A pointer to a struct ttm_buffer_object. |
938 | * | |
34820324 | 939 | * Unreserve a previous reservation of @bo. |
95762c2b | 940 | */ |
34820324 ML |
941 | static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo) |
942 | { | |
c7523083 TH |
943 | if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) { |
944 | spin_lock(&bo->glob->lru_lock); | |
945 | ttm_bo_add_to_lru(bo); | |
946 | spin_unlock(&bo->glob->lru_lock); | |
947 | } | |
948 | __ttm_bo_unreserve(bo); | |
949 | } | |
950 | ||
951 | /** | |
952 | * ttm_bo_unreserve_ticket | |
953 | * @bo: A pointer to a struct ttm_buffer_object. | |
954 | * @ticket: ww_acquire_ctx used for reserving | |
955 | * | |
956 | * Unreserve a previous reservation of @bo made with @ticket. | |
957 | */ | |
958 | static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo, | |
959 | struct ww_acquire_ctx *t) | |
960 | { | |
961 | ttm_bo_unreserve(bo); | |
34820324 | 962 | } |
95762c2b | 963 | |
ba4e7d97 TH |
964 | /* |
965 | * ttm_bo_util.c | |
966 | */ | |
967 | ||
afe6804c DA |
968 | int ttm_mem_io_reserve(struct ttm_bo_device *bdev, |
969 | struct ttm_mem_reg *mem); | |
970 | void ttm_mem_io_free(struct ttm_bo_device *bdev, | |
971 | struct ttm_mem_reg *mem); | |
ba4e7d97 TH |
972 | /** |
973 | * ttm_bo_move_ttm | |
974 | * | |
975 | * @bo: A pointer to a struct ttm_buffer_object. | |
7b8082bc | 976 | * @interruptible: Sleep interruptible if waiting. |
9d87fa21 | 977 | * @no_wait_gpu: Return immediately if the GPU is busy. |
ba4e7d97 TH |
978 | * @new_mem: struct ttm_mem_reg indicating where to move. |
979 | * | |
980 | * Optimized move function for a buffer object with both old and | |
981 | * new placement backed by a TTM. The function will, if successful, | |
982 | * free any old aperture space, and set (@new_mem)->mm_node to NULL, | |
983 | * and update the (@bo)->mem placement flags. If unsuccessful, the old | |
984 | * data remains untouched, and it's up to the caller to free the | |
985 | * memory space indicated by @new_mem. | |
986 | * Returns: | |
987 | * !0: Failure. | |
988 | */ | |
989 | ||
990 | extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo, | |
4e2f0caa | 991 | bool interruptible, bool no_wait_gpu, |
97a875cb | 992 | struct ttm_mem_reg *new_mem); |
ba4e7d97 TH |
993 | |
994 | /** | |
995 | * ttm_bo_move_memcpy | |
996 | * | |
997 | * @bo: A pointer to a struct ttm_buffer_object. | |
77dfc28b | 998 | * @interruptible: Sleep interruptible if waiting. |
9d87fa21 | 999 | * @no_wait_gpu: Return immediately if the GPU is busy. |
ba4e7d97 TH |
1000 | * @new_mem: struct ttm_mem_reg indicating where to move. |
1001 | * | |
1002 | * Fallback move function for a mappable buffer object in mappable memory. | |
1003 | * The function will, if successful, | |
1004 | * free any old aperture space, and set (@new_mem)->mm_node to NULL, | |
1005 | * and update the (@bo)->mem placement flags. If unsuccessful, the old | |
1006 | * data remains untouched, and it's up to the caller to free the | |
1007 | * memory space indicated by @new_mem. | |
1008 | * Returns: | |
1009 | * !0: Failure. | |
1010 | */ | |
1011 | ||
1012 | extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo, | |
4499f2ac | 1013 | bool interruptible, bool no_wait_gpu, |
97a875cb | 1014 | struct ttm_mem_reg *new_mem); |
ba4e7d97 TH |
1015 | |
1016 | /** | |
1017 | * ttm_bo_free_old_node | |
1018 | * | |
1019 | * @bo: A pointer to a struct ttm_buffer_object. | |
1020 | * | |
1021 | * Utility function to free an old placement after a successful move. | |
1022 | */ | |
1023 | extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo); | |
1024 | ||
1025 | /** | |
1026 | * ttm_bo_move_accel_cleanup. | |
1027 | * | |
1028 | * @bo: A pointer to a struct ttm_buffer_object. | |
f2c24b83 | 1029 | * @fence: A fence object that signals when moving is complete. |
ba4e7d97 | 1030 | * @evict: This is an evict move. Don't return until the buffer is idle. |
ba4e7d97 TH |
1031 | * @new_mem: struct ttm_mem_reg indicating where to move. |
1032 | * | |
1033 | * Accelerated move function to be called when an accelerated move | |
1034 | * has been scheduled. The function will create a new temporary buffer object | |
1035 | * representing the old placement, and put the sync object on both buffer | |
1036 | * objects. After that the newly created buffer object is unref'd to be | |
1037 | * destroyed when the move is complete. This will help pipeline | |
1038 | * buffer moves. | |
1039 | */ | |
1040 | ||
1041 | extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo, | |
f54d1867 | 1042 | struct dma_fence *fence, bool evict, |
ba4e7d97 | 1043 | struct ttm_mem_reg *new_mem); |
3ddf4ad9 CK |
1044 | |
1045 | /** | |
1046 | * ttm_bo_pipeline_move. | |
1047 | * | |
1048 | * @bo: A pointer to a struct ttm_buffer_object. | |
1049 | * @fence: A fence object that signals when moving is complete. | |
1050 | * @evict: This is an evict move. Don't return until the buffer is idle. | |
1051 | * @new_mem: struct ttm_mem_reg indicating where to move. | |
1052 | * | |
1053 | * Function for pipelining accelerated moves. Either free the memory | |
1054 | * immediately or hang it on a temporary buffer object. | |
1055 | */ | |
1056 | int ttm_bo_pipeline_move(struct ttm_buffer_object *bo, | |
f54d1867 | 1057 | struct dma_fence *fence, bool evict, |
3ddf4ad9 CK |
1058 | struct ttm_mem_reg *new_mem); |
1059 | ||
ba4e7d97 TH |
1060 | /** |
1061 | * ttm_io_prot | |
1062 | * | |
1063 | * @c_state: Caching state. | |
1064 | * @tmp: Page protection flag for a normal, cached mapping. | |
1065 | * | |
1066 | * Utility function that returns the pgprot_t that should be used for | |
1067 | * setting up a PTE with the caching model indicated by @c_state. | |
1068 | */ | |
a55e8d45 | 1069 | extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp); |
ba4e7d97 | 1070 | |
d961db75 BS |
1071 | extern const struct ttm_mem_type_manager_func ttm_bo_manager_func; |
1072 | ||
e6bf6e57 | 1073 | #if IS_ENABLED(CONFIG_AGP) |
ba4e7d97 TH |
1074 | #include <linux/agp_backend.h> |
1075 | ||
1076 | /** | |
649bf3ca | 1077 | * ttm_agp_tt_create |
ba4e7d97 TH |
1078 | * |
1079 | * @bdev: Pointer to a struct ttm_bo_device. | |
1080 | * @bridge: The agp bridge this device is sitting on. | |
649bf3ca JG |
1081 | * @size: Size of the data needed backing. |
1082 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. | |
1083 | * @dummy_read_page: See struct ttm_bo_device. | |
1084 | * | |
ba4e7d97 TH |
1085 | * |
1086 | * Create a TTM backend that uses the indicated AGP bridge as an aperture | |
1087 | * for TT memory. This function uses the linux agpgart interface to | |
1088 | * bind and unbind memory backing a ttm_tt. | |
1089 | */ | |
649bf3ca JG |
1090 | extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev, |
1091 | struct agp_bridge_data *bridge, | |
1092 | unsigned long size, uint32_t page_flags, | |
1093 | struct page *dummy_read_page); | |
dea7e0ac JG |
1094 | int ttm_agp_tt_populate(struct ttm_tt *ttm); |
1095 | void ttm_agp_tt_unpopulate(struct ttm_tt *ttm); | |
ba4e7d97 TH |
1096 | #endif |
1097 | ||
1098 | #endif |