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