1 /**************************************************************************
3 * Copyright (c) 2006-2009 Vmware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
30 #ifndef _TTM_BO_DRIVER_H_
31 #define _TTM_BO_DRIVER_H_
33 #include "ttm/ttm_bo_api.h"
34 #include "ttm/ttm_memory.h"
35 #include "ttm/ttm_module.h"
37 #include "drm_global.h"
38 #include "linux/workqueue.h"
40 #include "linux/spinlock.h"
44 struct ttm_backend_func {
46 * struct ttm_backend_func member populate
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
54 * Populate the backend with ttm pages. Depending on the backend,
55 * it may or may not copy the @pages array.
57 int (*populate) (struct ttm_backend *backend,
58 unsigned long num_pages, struct page **pages,
59 struct page *dummy_read_page);
61 * struct ttm_backend_func member clear
63 * @backend: Pointer to a struct ttm_backend.
65 * This is an "unpopulate" function. Release all resources
66 * allocated with populate.
68 void (*clear) (struct ttm_backend *backend);
71 * struct ttm_backend_func member bind
73 * @backend: Pointer to a struct ttm_backend.
74 * @bo_mem: Pointer to a struct ttm_mem_reg describing the
75 * memory type and location for binding.
77 * Bind the backend pages into the aperture in the location
78 * indicated by @bo_mem. This function should be able to handle
79 * differences between aperture- and system page sizes.
81 int (*bind) (struct ttm_backend *backend, struct ttm_mem_reg *bo_mem);
84 * struct ttm_backend_func member unbind
86 * @backend: Pointer to a struct ttm_backend.
88 * Unbind previously bound backend pages. This function should be
89 * able to handle differences between aperture- and system page sizes.
91 int (*unbind) (struct ttm_backend *backend);
94 * struct ttm_backend_func member destroy
96 * @backend: Pointer to a struct ttm_backend.
98 * Destroy the backend.
100 void (*destroy) (struct ttm_backend *backend);
106 * @bdev: Pointer to a struct ttm_bo_device.
107 * @flags: For driver use.
108 * @func: Pointer to a struct ttm_backend_func that describes
109 * the backend methods.
114 struct ttm_bo_device *bdev;
116 struct ttm_backend_func *func;
119 #define TTM_PAGE_FLAG_USER (1 << 1)
120 #define TTM_PAGE_FLAG_USER_DIRTY (1 << 2)
121 #define TTM_PAGE_FLAG_WRITE (1 << 3)
122 #define TTM_PAGE_FLAG_SWAPPED (1 << 4)
123 #define TTM_PAGE_FLAG_PERSISTANT_SWAP (1 << 5)
124 #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
125 #define TTM_PAGE_FLAG_DMA32 (1 << 7)
127 enum ttm_caching_state {
136 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
138 * @pages: Array of pages backing the data.
139 * @first_himem_page: Himem pages are put last in the page array, which
140 * enables us to run caching attribute changes on only the first part
141 * of the page array containing lomem pages. This is the index of the
143 * @last_lomem_page: Index of the last lomem page in the page array.
144 * @num_pages: Number of pages in the page array.
145 * @bdev: Pointer to the current struct ttm_bo_device.
146 * @be: Pointer to the ttm backend.
147 * @tsk: The task for user ttm.
148 * @start: virtual address for user ttm.
149 * @swap_storage: Pointer to shmem struct file for swap storage.
150 * @caching_state: The current caching state of the pages.
151 * @state: The current binding state of the pages.
153 * This is a structure holding the pages, caching- and aperture binding
154 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
159 struct page *dummy_read_page;
161 long first_himem_page;
162 long last_lomem_page;
164 unsigned long num_pages;
165 struct ttm_bo_global *glob;
166 struct ttm_backend *be;
167 struct task_struct *tsk;
169 struct file *swap_storage;
170 enum ttm_caching_state caching_state;
178 #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */
179 #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */
180 #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
183 * struct ttm_mem_type_manager
185 * @has_type: The memory type has been initialized.
186 * @use_type: The memory type is enabled.
187 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
188 * managed by this memory type.
189 * @gpu_offset: If used, the GPU offset of the first managed page of
190 * fixed memory or the first managed location in an aperture.
191 * @size: Size of the managed region.
192 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
193 * as defined in ttm_placement_common.h
194 * @default_caching: The default caching policy used for a buffer object
195 * placed in this memory type if the user doesn't provide one.
196 * @manager: The range manager used for this memory type. FIXME: If the aperture
197 * has a page size different from the underlying system, the granularity
198 * of this manager should take care of this. But the range allocating code
199 * in ttm_bo.c needs to be modified for this.
200 * @lru: The lru list for this memory type.
202 * This structure is used to identify and manage memory types for a device.
203 * It's set up by the ttm_bo_driver::init_mem_type method.
206 struct ttm_mem_type_manager;
208 struct ttm_mem_type_manager_func {
209 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
210 int (*takedown)(struct ttm_mem_type_manager *man);
211 int (*get_node)(struct ttm_mem_type_manager *man,
212 struct ttm_buffer_object *bo,
213 struct ttm_placement *placement,
214 struct ttm_mem_reg *mem);
215 void (*put_node)(struct ttm_mem_type_manager *man,
216 struct ttm_mem_reg *mem);
217 void (*put_node_locked)(struct ttm_mem_type_manager *man,
218 struct ttm_mem_reg *mem);
219 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
222 struct ttm_mem_type_manager {
223 struct ttm_bo_device *bdev;
226 * No protection. Constant from start.
232 unsigned long gpu_offset;
234 uint32_t available_caching;
235 uint32_t default_caching;
238 * Protected by the bdev->lru_lock.
239 * TODO: Consider one lru_lock per ttm_mem_type_manager.
240 * Plays ill with list removal, though.
242 const struct ttm_mem_type_manager_func *func;
244 struct list_head lru;
248 * struct ttm_bo_driver
250 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
251 * @invalidate_caches: Callback to invalidate read caches when a buffer object
253 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
255 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
256 * @move: Callback for a driver to hook in accelerated functions to
258 * If set to NULL, a potentially slow memcpy() move is used.
259 * @sync_obj_signaled: See ttm_fence_api.h
260 * @sync_obj_wait: See ttm_fence_api.h
261 * @sync_obj_flush: See ttm_fence_api.h
262 * @sync_obj_unref: See ttm_fence_api.h
263 * @sync_obj_ref: See ttm_fence_api.h
266 struct ttm_bo_driver {
268 * struct ttm_bo_driver member create_ttm_backend_entry
270 * @bdev: The buffer object device.
272 * Create a driver specific struct ttm_backend.
275 struct ttm_backend *(*create_ttm_backend_entry)
276 (struct ttm_bo_device *bdev);
279 * struct ttm_bo_driver member invalidate_caches
281 * @bdev: the buffer object device.
282 * @flags: new placement of the rebound buffer object.
284 * A previosly evicted buffer has been rebound in a
285 * potentially new location. Tell the driver that it might
286 * consider invalidating read (texture) caches on the next command
287 * submission as a consequence.
290 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
291 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
292 struct ttm_mem_type_manager *man);
294 * struct ttm_bo_driver member evict_flags:
296 * @bo: the buffer object to be evicted
298 * Return the bo flags for a buffer which is not mapped to the hardware.
299 * These will be placed in proposed_flags so that when the move is
300 * finished, they'll end up in bo->mem.flags
303 void(*evict_flags) (struct ttm_buffer_object *bo,
304 struct ttm_placement *placement);
306 * struct ttm_bo_driver member move:
308 * @bo: the buffer to move
309 * @evict: whether this motion is evicting the buffer from
310 * the graphics address space
311 * @interruptible: Use interruptible sleeps if possible when sleeping.
312 * @no_wait: whether this should give up and return -EBUSY
313 * if this move would require sleeping
314 * @new_mem: the new memory region receiving the buffer
316 * Move a buffer between two memory regions.
318 int (*move) (struct ttm_buffer_object *bo,
319 bool evict, bool interruptible,
320 bool no_wait_reserve, bool no_wait_gpu,
321 struct ttm_mem_reg *new_mem);
324 * struct ttm_bo_driver_member verify_access
326 * @bo: Pointer to a buffer object.
327 * @filp: Pointer to a struct file trying to access the object.
329 * Called from the map / write / read methods to verify that the
330 * caller is permitted to access the buffer object.
331 * This member may be set to NULL, which will refuse this kind of
332 * access for all buffer objects.
333 * This function should return 0 if access is granted, -EPERM otherwise.
335 int (*verify_access) (struct ttm_buffer_object *bo,
339 * In case a driver writer dislikes the TTM fence objects,
340 * the driver writer can replace those with sync objects of
341 * his / her own. If it turns out that no driver writer is
342 * using these. I suggest we remove these hooks and plug in
343 * fences directly. The bo driver needs the following functionality:
344 * See the corresponding functions in the fence object API
348 bool (*sync_obj_signaled) (void *sync_obj, void *sync_arg);
349 int (*sync_obj_wait) (void *sync_obj, void *sync_arg,
350 bool lazy, bool interruptible);
351 int (*sync_obj_flush) (void *sync_obj, void *sync_arg);
352 void (*sync_obj_unref) (void **sync_obj);
353 void *(*sync_obj_ref) (void *sync_obj);
355 /* hook to notify driver about a driver move so it
356 * can do tiling things */
357 void (*move_notify)(struct ttm_buffer_object *bo,
358 struct ttm_mem_reg *new_mem);
359 /* notify the driver we are taking a fault on this BO
360 * and have reserved it */
361 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
364 * notify the driver that we're about to swap out this bo
366 void (*swap_notify) (struct ttm_buffer_object *bo);
369 * Driver callback on when mapping io memory (for bo_move_memcpy
370 * for instance). TTM will take care to call io_mem_free whenever
371 * the mapping is not use anymore. io_mem_reserve & io_mem_free
374 int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
375 void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
379 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
382 struct ttm_bo_global_ref {
383 struct drm_global_reference ref;
384 struct ttm_mem_global *mem_glob;
388 * struct ttm_bo_global - Buffer object driver global data.
390 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
391 * @dummy_read_page: Pointer to a dummy page used for mapping requests
392 * of unpopulated pages.
393 * @shrink: A shrink callback object used for buffer object swap.
394 * @ttm_bo_extra_size: Extra size (sizeof(struct ttm_buffer_object) excluded)
395 * used by a buffer object. This is excluding page arrays and backing pages.
396 * @ttm_bo_size: This is @ttm_bo_extra_size + sizeof(struct ttm_buffer_object).
397 * @device_list_mutex: Mutex protecting the device list.
398 * This mutex is held while traversing the device list for pm options.
399 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
400 * @device_list: List of buffer object devices.
401 * @swap_lru: Lru list of buffer objects used for swapping.
404 struct ttm_bo_global {
407 * Constant after init.
411 struct ttm_mem_global *mem_glob;
412 struct page *dummy_read_page;
413 struct ttm_mem_shrink shrink;
414 size_t ttm_bo_extra_size;
416 struct mutex device_list_mutex;
420 * Protected by device_list_mutex.
422 struct list_head device_list;
425 * Protected by the lru_lock.
427 struct list_head swap_lru;
430 * Internal protection.
436 #define TTM_NUM_MEM_TYPES 8
438 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
439 idling before CPU mapping */
440 #define TTM_BO_PRIV_FLAG_MAX 1
442 * struct ttm_bo_device - Buffer object driver device-specific data.
444 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
445 * @man: An array of mem_type_managers.
446 * @addr_space_mm: Range manager for the device address space.
447 * lru_lock: Spinlock that protects the buffer+device lru lists and
449 * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager.
450 * If a GPU lockup has been detected, this is forced to 0.
451 * @dev_mapping: A pointer to the struct address_space representing the
452 * device address space.
453 * @wq: Work queue structure for the delayed delete workqueue.
457 struct ttm_bo_device {
460 * Constant after bo device init / atomic.
462 struct list_head device_list;
463 struct ttm_bo_global *glob;
464 struct ttm_bo_driver *driver;
466 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
468 * Protected by the vm lock.
470 struct rb_root addr_space_rb;
471 struct drm_mm addr_space_mm;
474 * Protected by the global:lru lock.
476 struct list_head ddestroy;
479 * Protected by load / firstopen / lastclose /unload sync.
483 struct address_space *dev_mapping;
486 * Internal protection.
489 struct delayed_work wq;
497 * @old: Pointer to the result and original value.
498 * @new: New value of bits.
499 * @mask: Mask of bits to change.
501 * Convenience function to change a number of bits identified by a mask.
504 static inline uint32_t
505 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
507 *old ^= (*old ^ new) & mask;
514 * @bdev: pointer to a struct ttm_bo_device:
515 * @size: Size of the data needed backing.
516 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
517 * @dummy_read_page: See struct ttm_bo_device.
519 * Create a struct ttm_tt to back data with system memory pages.
520 * No pages are actually allocated.
522 * NULL: Out of memory.
524 extern struct ttm_tt *ttm_tt_create(struct ttm_bo_device *bdev,
527 struct page *dummy_read_page);
532 * @ttm: The struct ttm_tt to populate.
533 * @tsk: A struct task_struct for which @start is a valid user-space address.
534 * @start: A valid user-space address.
535 * @num_pages: Size in pages of the user memory area.
537 * Populate a struct ttm_tt with a user-space memory area after first pinning
538 * the pages backing it.
543 extern int ttm_tt_set_user(struct ttm_tt *ttm,
544 struct task_struct *tsk,
545 unsigned long start, unsigned long num_pages);
550 * @ttm: The struct ttm_tt containing backing pages.
551 * @bo_mem: The struct ttm_mem_reg identifying the binding location.
553 * Bind the pages of @ttm to an aperture location identified by @bo_mem
555 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
560 * @ttm: The struct ttm_tt to contain the backing pages.
562 * Add backing pages to all of @ttm
564 extern int ttm_tt_populate(struct ttm_tt *ttm);
569 * @ttm: The struct ttm_tt.
571 * Unbind, unpopulate and destroy a struct ttm_tt.
573 extern void ttm_tt_destroy(struct ttm_tt *ttm);
578 * @ttm: The struct ttm_tt.
580 * Unbind a struct ttm_tt.
582 extern void ttm_tt_unbind(struct ttm_tt *ttm);
587 * @ttm: The struct ttm_tt.
588 * @index: Index of the desired page.
590 * Return a pointer to the struct page backing @ttm at page
591 * index @index. If the page is unpopulated, one will be allocated to
592 * populate that index.
597 extern struct page *ttm_tt_get_page(struct ttm_tt *ttm, int index);
600 * ttm_tt_cache_flush:
602 * @pages: An array of pointers to struct page:s to flush.
603 * @num_pages: Number of pages to flush.
605 * Flush the data of the indicated pages from the cpu caches.
606 * This is used when changing caching attributes of the pages from
609 extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages);
612 * ttm_tt_set_placement_caching:
614 * @ttm A struct ttm_tt the backing pages of which will change caching policy.
615 * @placement: Flag indicating the desired caching policy.
617 * This function will change caching policy of any default kernel mappings of
618 * the pages backing @ttm. If changing from cached to uncached or
620 * all CPU caches will first be flushed to make sure the data of the pages
621 * hit RAM. This function may be very costly as it involves global TLB
622 * and cache flushes and potential page splitting / combining.
624 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
625 extern int ttm_tt_swapout(struct ttm_tt *ttm,
626 struct file *persistant_swap_storage);
635 * @bdev: Pointer to a struct ttm_bo_device.
636 * @mem: A valid struct ttm_mem_reg.
638 * Returns true if the memory described by @mem is PCI memory,
641 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
642 struct ttm_mem_reg *mem);
647 * @bo: Pointer to a struct ttm_buffer_object. the data of which
648 * we want to allocate space for.
649 * @proposed_placement: Proposed new placement for the buffer object.
650 * @mem: A struct ttm_mem_reg.
651 * @interruptible: Sleep interruptible when sliping.
652 * @no_wait_reserve: Return immediately if other buffers are busy.
653 * @no_wait_gpu: Return immediately if the GPU is busy.
655 * Allocate memory space for the buffer object pointed to by @bo, using
656 * the placement flags in @mem, potentially evicting other idle buffer objects.
657 * This function may sleep while waiting for space to become available.
659 * -EBUSY: No space available (only if no_wait == 1).
660 * -ENOMEM: Could not allocate memory for the buffer object, either due to
661 * fragmentation or concurrent allocators.
662 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
664 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
665 struct ttm_placement *placement,
666 struct ttm_mem_reg *mem,
668 bool no_wait_reserve, bool no_wait_gpu);
670 extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
671 struct ttm_mem_reg *mem);
672 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
673 struct ttm_mem_reg *mem);
676 * ttm_bo_wait_for_cpu
678 * @bo: Pointer to a struct ttm_buffer_object.
679 * @no_wait: Don't sleep while waiting.
681 * Wait until a buffer object is no longer sync'ed for CPU access.
683 * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1).
684 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
687 extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait);
690 * ttm_bo_pci_offset - Get the PCI offset for the buffer object memory.
692 * @bo Pointer to a struct ttm_buffer_object.
693 * @bus_base On return the base of the PCI region
694 * @bus_offset On return the byte offset into the PCI region
695 * @bus_size On return the byte size of the buffer object or zero if
696 * the buffer object memory is not accessible through a PCI region.
699 * -EINVAL if the buffer object is currently not mappable.
703 extern int ttm_bo_pci_offset(struct ttm_bo_device *bdev,
704 struct ttm_mem_reg *mem,
705 unsigned long *bus_base,
706 unsigned long *bus_offset,
707 unsigned long *bus_size);
709 extern int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
710 struct ttm_mem_reg *mem);
711 extern void ttm_mem_io_free(struct ttm_bo_device *bdev,
712 struct ttm_mem_reg *mem);
714 extern void ttm_bo_global_release(struct drm_global_reference *ref);
715 extern int ttm_bo_global_init(struct drm_global_reference *ref);
717 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
722 * @bdev: A pointer to a struct ttm_bo_device to initialize.
723 * @mem_global: A pointer to an initialized struct ttm_mem_global.
724 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
725 * @file_page_offset: Offset into the device address space that is available
726 * for buffer data. This ensures compatibility with other users of the
729 * Initializes a struct ttm_bo_device:
733 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
734 struct ttm_bo_global *glob,
735 struct ttm_bo_driver *driver,
736 uint64_t file_page_offset, bool need_dma32);
739 * ttm_bo_unmap_virtual
741 * @bo: tear down the virtual mappings for this BO
743 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
748 * @bo: A pointer to a struct ttm_buffer_object.
749 * @interruptible: Sleep interruptible if waiting.
750 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
751 * @use_sequence: If @bo is already reserved, Only sleep waiting for
752 * it to become unreserved if @sequence < (@bo)->sequence.
754 * Locks a buffer object for validation. (Or prevents other processes from
755 * locking it for validation) and removes it from lru lists, while taking
756 * a number of measures to prevent deadlocks.
758 * Deadlocks may occur when two processes try to reserve multiple buffers in
759 * different order, either by will or as a result of a buffer being evicted
760 * to make room for a buffer already reserved. (Buffers are reserved before
761 * they are evicted). The following algorithm prevents such deadlocks from
763 * 1) Buffers are reserved with the lru spinlock held. Upon successful
764 * reservation they are removed from the lru list. This stops a reserved buffer
765 * from being evicted. However the lru spinlock is released between the time
766 * a buffer is selected for eviction and the time it is reserved.
767 * Therefore a check is made when a buffer is reserved for eviction, that it
768 * is still the first buffer in the lru list, before it is removed from the
769 * list. @check_lru == 1 forces this check. If it fails, the function returns
770 * -EINVAL, and the caller should then choose a new buffer to evict and repeat
772 * 2) Processes attempting to reserve multiple buffers other than for eviction,
773 * (typically execbuf), should first obtain a unique 32-bit
774 * validation sequence number,
775 * and call this function with @use_sequence == 1 and @sequence == the unique
776 * sequence number. If upon call of this function, the buffer object is already
777 * reserved, the validation sequence is checked against the validation
778 * sequence of the process currently reserving the buffer,
779 * and if the current validation sequence is greater than that of the process
780 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
781 * waiting for the buffer to become unreserved, after which it retries
783 * The caller should, when receiving an -EAGAIN error
784 * release all its buffer reservations, wait for @bo to become unreserved, and
785 * then rerun the validation with the same validation sequence. This procedure
786 * will always guarantee that the process with the lowest validation sequence
787 * will eventually succeed, preventing both deadlocks and starvation.
790 * -EAGAIN: The reservation may cause a deadlock.
791 * Release all buffer reservations, wait for @bo to become unreserved and
792 * try again. (only if use_sequence == 1).
793 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
794 * a signal. Release all buffer reservations and return to user-space.
796 extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
798 bool no_wait, bool use_sequence, uint32_t sequence);
803 * @bo: A pointer to a struct ttm_buffer_object.
805 * Unreserve a previous reservation of @bo.
807 extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
810 * ttm_bo_wait_unreserved
812 * @bo: A pointer to a struct ttm_buffer_object.
814 * Wait for a struct ttm_buffer_object to become unreserved.
815 * This is typically used in the execbuf code to relax cpu-usage when
816 * a potential deadlock condition backoff.
818 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo,
828 * @bo: A pointer to a struct ttm_buffer_object.
829 * @evict: 1: This is an eviction. Don't try to pipeline.
830 * @no_wait_reserve: Return immediately if other buffers are busy.
831 * @no_wait_gpu: Return immediately if the GPU is busy.
832 * @new_mem: struct ttm_mem_reg indicating where to move.
834 * Optimized move function for a buffer object with both old and
835 * new placement backed by a TTM. The function will, if successful,
836 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
837 * and update the (@bo)->mem placement flags. If unsuccessful, the old
838 * data remains untouched, and it's up to the caller to free the
839 * memory space indicated by @new_mem.
844 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
845 bool evict, bool no_wait_reserve,
846 bool no_wait_gpu, struct ttm_mem_reg *new_mem);
851 * @bo: A pointer to a struct ttm_buffer_object.
852 * @evict: 1: This is an eviction. Don't try to pipeline.
853 * @no_wait_reserve: Return immediately if other buffers are busy.
854 * @no_wait_gpu: Return immediately if the GPU is busy.
855 * @new_mem: struct ttm_mem_reg indicating where to move.
857 * Fallback move function for a mappable buffer object in mappable memory.
858 * The function will, if successful,
859 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
860 * and update the (@bo)->mem placement flags. If unsuccessful, the old
861 * data remains untouched, and it's up to the caller to free the
862 * memory space indicated by @new_mem.
867 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
868 bool evict, bool no_wait_reserve,
869 bool no_wait_gpu, struct ttm_mem_reg *new_mem);
872 * ttm_bo_free_old_node
874 * @bo: A pointer to a struct ttm_buffer_object.
876 * Utility function to free an old placement after a successful move.
878 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
881 * ttm_bo_move_accel_cleanup.
883 * @bo: A pointer to a struct ttm_buffer_object.
884 * @sync_obj: A sync object that signals when moving is complete.
885 * @sync_obj_arg: An argument to pass to the sync object idle / wait
887 * @evict: This is an evict move. Don't return until the buffer is idle.
888 * @no_wait_reserve: Return immediately if other buffers are busy.
889 * @no_wait_gpu: Return immediately if the GPU is busy.
890 * @new_mem: struct ttm_mem_reg indicating where to move.
892 * Accelerated move function to be called when an accelerated move
893 * has been scheduled. The function will create a new temporary buffer object
894 * representing the old placement, and put the sync object on both buffer
895 * objects. After that the newly created buffer object is unref'd to be
896 * destroyed when the move is complete. This will help pipeline
900 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
903 bool evict, bool no_wait_reserve,
905 struct ttm_mem_reg *new_mem);
909 * @c_state: Caching state.
910 * @tmp: Page protection flag for a normal, cached mapping.
912 * Utility function that returns the pgprot_t that should be used for
913 * setting up a PTE with the caching model indicated by @c_state.
915 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
917 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
919 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
921 #include <linux/agp_backend.h>
924 * ttm_agp_backend_init
926 * @bdev: Pointer to a struct ttm_bo_device.
927 * @bridge: The agp bridge this device is sitting on.
929 * Create a TTM backend that uses the indicated AGP bridge as an aperture
930 * for TT memory. This function uses the linux agpgart interface to
931 * bind and unbind memory backing a ttm_tt.
933 extern struct ttm_backend *ttm_agp_backend_init(struct ttm_bo_device *bdev,
934 struct agp_bridge_data *bridge);