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