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 "linux/workqueue.h"
39 #include "linux/spinlock.h"
43 struct ttm_backend_func {
45 * struct ttm_backend_func member populate
47 * @backend: Pointer to a struct ttm_backend.
48 * @num_pages: Number of pages to populate.
49 * @pages: Array of pointers to ttm pages.
50 * @dummy_read_page: Page to be used instead of NULL pages in the
53 * Populate the backend with ttm pages. Depending on the backend,
54 * it may or may not copy the @pages array.
56 int (*populate) (struct ttm_backend *backend,
57 unsigned long num_pages, struct page **pages,
58 struct page *dummy_read_page);
60 * struct ttm_backend_func member clear
62 * @backend: Pointer to a struct ttm_backend.
64 * This is an "unpopulate" function. Release all resources
65 * allocated with populate.
67 void (*clear) (struct ttm_backend *backend);
70 * struct ttm_backend_func member bind
72 * @backend: Pointer to a struct ttm_backend.
73 * @bo_mem: Pointer to a struct ttm_mem_reg describing the
74 * memory type and location for binding.
76 * Bind the backend pages into the aperture in the location
77 * indicated by @bo_mem. This function should be able to handle
78 * differences between aperture- and system page sizes.
80 int (*bind) (struct ttm_backend *backend, struct ttm_mem_reg *bo_mem);
83 * struct ttm_backend_func member unbind
85 * @backend: Pointer to a struct ttm_backend.
87 * Unbind previously bound backend pages. This function should be
88 * able to handle differences between aperture- and system page sizes.
90 int (*unbind) (struct ttm_backend *backend);
93 * struct ttm_backend_func member destroy
95 * @backend: Pointer to a struct ttm_backend.
97 * Destroy the backend.
99 void (*destroy) (struct ttm_backend *backend);
105 * @bdev: Pointer to a struct ttm_bo_device.
106 * @flags: For driver use.
107 * @func: Pointer to a struct ttm_backend_func that describes
108 * the backend methods.
113 struct ttm_bo_device *bdev;
115 struct ttm_backend_func *func;
118 #define TTM_PAGE_FLAG_USER (1 << 1)
119 #define TTM_PAGE_FLAG_USER_DIRTY (1 << 2)
120 #define TTM_PAGE_FLAG_WRITE (1 << 3)
121 #define TTM_PAGE_FLAG_SWAPPED (1 << 4)
122 #define TTM_PAGE_FLAG_PERSISTANT_SWAP (1 << 5)
123 #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
124 #define TTM_PAGE_FLAG_DMA32 (1 << 7)
126 enum ttm_caching_state {
135 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
137 * @pages: Array of pages backing the data.
138 * @first_himem_page: Himem pages are put last in the page array, which
139 * enables us to run caching attribute changes on only the first part
140 * of the page array containing lomem pages. This is the index of the
142 * @last_lomem_page: Index of the last lomem page in the page array.
143 * @num_pages: Number of pages in the page array.
144 * @bdev: Pointer to the current struct ttm_bo_device.
145 * @be: Pointer to the ttm backend.
146 * @tsk: The task for user ttm.
147 * @start: virtual address for user ttm.
148 * @swap_storage: Pointer to shmem struct file for swap storage.
149 * @caching_state: The current caching state of the pages.
150 * @state: The current binding state of the pages.
152 * This is a structure holding the pages, caching- and aperture binding
153 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
158 struct page *dummy_read_page;
160 long first_himem_page;
161 long last_lomem_page;
163 unsigned long num_pages;
164 struct ttm_bo_global *glob;
165 struct ttm_backend *be;
166 struct task_struct *tsk;
168 struct file *swap_storage;
169 enum ttm_caching_state caching_state;
177 #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */
178 #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */
179 #define TTM_MEMTYPE_FLAG_NEEDS_IOREMAP (1 << 2) /* Fixed memory needs ioremap
180 before kernel access. */
181 #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
184 * struct ttm_mem_type_manager
186 * @has_type: The memory type has been initialized.
187 * @use_type: The memory type is enabled.
188 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
189 * managed by this memory type.
190 * @gpu_offset: If used, the GPU offset of the first managed page of
191 * fixed memory or the first managed location in an aperture.
192 * @io_offset: The io_offset of the first managed page of IO memory or
193 * the first managed location in an aperture. For TTM_MEMTYPE_FLAG_CMA
194 * memory, this should be set to NULL.
195 * @io_size: The size of a managed IO region (fixed memory or aperture).
196 * @io_addr: Virtual kernel address if the io region is pre-mapped. For
197 * TTM_MEMTYPE_FLAG_NEEDS_IOREMAP there is no pre-mapped io map and
198 * @io_addr should be set to NULL.
199 * @size: Size of the managed region.
200 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
201 * as defined in ttm_placement_common.h
202 * @default_caching: The default caching policy used for a buffer object
203 * placed in this memory type if the user doesn't provide one.
204 * @manager: The range manager used for this memory type. FIXME: If the aperture
205 * has a page size different from the underlying system, the granularity
206 * of this manager should take care of this. But the range allocating code
207 * in ttm_bo.c needs to be modified for this.
208 * @lru: The lru list for this memory type.
210 * This structure is used to identify and manage memory types for a device.
211 * It's set up by the ttm_bo_driver::init_mem_type method.
214 struct ttm_mem_type_manager {
217 * No protection. Constant from start.
223 unsigned long gpu_offset;
224 unsigned long io_offset;
225 unsigned long io_size;
228 uint32_t available_caching;
229 uint32_t default_caching;
232 * Protected by the bdev->lru_lock.
233 * TODO: Consider one lru_lock per ttm_mem_type_manager.
234 * Plays ill with list removal, though.
237 struct drm_mm manager;
238 struct list_head lru;
242 * struct ttm_bo_driver
244 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
245 * @invalidate_caches: Callback to invalidate read caches when a buffer object
247 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
249 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
250 * @move: Callback for a driver to hook in accelerated functions to
252 * If set to NULL, a potentially slow memcpy() move is used.
253 * @sync_obj_signaled: See ttm_fence_api.h
254 * @sync_obj_wait: See ttm_fence_api.h
255 * @sync_obj_flush: See ttm_fence_api.h
256 * @sync_obj_unref: See ttm_fence_api.h
257 * @sync_obj_ref: See ttm_fence_api.h
260 struct ttm_bo_driver {
262 * struct ttm_bo_driver member create_ttm_backend_entry
264 * @bdev: The buffer object device.
266 * Create a driver specific struct ttm_backend.
269 struct ttm_backend *(*create_ttm_backend_entry)
270 (struct ttm_bo_device *bdev);
273 * struct ttm_bo_driver member invalidate_caches
275 * @bdev: the buffer object device.
276 * @flags: new placement of the rebound buffer object.
278 * A previosly evicted buffer has been rebound in a
279 * potentially new location. Tell the driver that it might
280 * consider invalidating read (texture) caches on the next command
281 * submission as a consequence.
284 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
285 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
286 struct ttm_mem_type_manager *man);
288 * struct ttm_bo_driver member evict_flags:
290 * @bo: the buffer object to be evicted
292 * Return the bo flags for a buffer which is not mapped to the hardware.
293 * These will be placed in proposed_flags so that when the move is
294 * finished, they'll end up in bo->mem.flags
297 void(*evict_flags) (struct ttm_buffer_object *bo,
298 struct ttm_placement *placement);
300 * struct ttm_bo_driver member move:
302 * @bo: the buffer to move
303 * @evict: whether this motion is evicting the buffer from
304 * the graphics address space
305 * @interruptible: Use interruptible sleeps if possible when sleeping.
306 * @no_wait: whether this should give up and return -EBUSY
307 * if this move would require sleeping
308 * @new_mem: the new memory region receiving the buffer
310 * Move a buffer between two memory regions.
312 int (*move) (struct ttm_buffer_object *bo,
313 bool evict, bool interruptible,
314 bool no_wait, struct ttm_mem_reg *new_mem);
317 * struct ttm_bo_driver_member verify_access
319 * @bo: Pointer to a buffer object.
320 * @filp: Pointer to a struct file trying to access the object.
322 * Called from the map / write / read methods to verify that the
323 * caller is permitted to access the buffer object.
324 * This member may be set to NULL, which will refuse this kind of
325 * access for all buffer objects.
326 * This function should return 0 if access is granted, -EPERM otherwise.
328 int (*verify_access) (struct ttm_buffer_object *bo,
332 * In case a driver writer dislikes the TTM fence objects,
333 * the driver writer can replace those with sync objects of
334 * his / her own. If it turns out that no driver writer is
335 * using these. I suggest we remove these hooks and plug in
336 * fences directly. The bo driver needs the following functionality:
337 * See the corresponding functions in the fence object API
341 bool (*sync_obj_signaled) (void *sync_obj, void *sync_arg);
342 int (*sync_obj_wait) (void *sync_obj, void *sync_arg,
343 bool lazy, bool interruptible);
344 int (*sync_obj_flush) (void *sync_obj, void *sync_arg);
345 void (*sync_obj_unref) (void **sync_obj);
346 void *(*sync_obj_ref) (void *sync_obj);
348 /* hook to notify driver about a driver move so it
349 * can do tiling things */
350 void (*move_notify)(struct ttm_buffer_object *bo,
351 struct ttm_mem_reg *new_mem);
352 /* notify the driver we are taking a fault on this BO
353 * and have reserved it */
354 void (*fault_reserve_notify)(struct ttm_buffer_object *bo);
357 * notify the driver that we're about to swap out this bo
359 void (*swap_notify) (struct ttm_buffer_object *bo);
363 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
366 struct ttm_bo_global_ref {
367 struct ttm_global_reference ref;
368 struct ttm_mem_global *mem_glob;
372 * struct ttm_bo_global - Buffer object driver global data.
374 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
375 * @dummy_read_page: Pointer to a dummy page used for mapping requests
376 * of unpopulated pages.
377 * @shrink: A shrink callback object used for buffer object swap.
378 * @ttm_bo_extra_size: Extra size (sizeof(struct ttm_buffer_object) excluded)
379 * used by a buffer object. This is excluding page arrays and backing pages.
380 * @ttm_bo_size: This is @ttm_bo_extra_size + sizeof(struct ttm_buffer_object).
381 * @device_list_mutex: Mutex protecting the device list.
382 * This mutex is held while traversing the device list for pm options.
383 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
384 * @device_list: List of buffer object devices.
385 * @swap_lru: Lru list of buffer objects used for swapping.
388 struct ttm_bo_global {
391 * Constant after init.
395 struct ttm_mem_global *mem_glob;
396 struct page *dummy_read_page;
397 struct ttm_mem_shrink shrink;
398 size_t ttm_bo_extra_size;
400 struct mutex device_list_mutex;
404 * Protected by device_list_mutex.
406 struct list_head device_list;
409 * Protected by the lru_lock.
411 struct list_head swap_lru;
414 * Internal protection.
420 #define TTM_NUM_MEM_TYPES 8
422 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
423 idling before CPU mapping */
424 #define TTM_BO_PRIV_FLAG_MAX 1
426 * struct ttm_bo_device - Buffer object driver device-specific data.
428 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
429 * @man: An array of mem_type_managers.
430 * @addr_space_mm: Range manager for the device address space.
431 * lru_lock: Spinlock that protects the buffer+device lru lists and
433 * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager.
434 * If a GPU lockup has been detected, this is forced to 0.
435 * @dev_mapping: A pointer to the struct address_space representing the
436 * device address space.
437 * @wq: Work queue structure for the delayed delete workqueue.
441 struct ttm_bo_device {
444 * Constant after bo device init / atomic.
446 struct list_head device_list;
447 struct ttm_bo_global *glob;
448 struct ttm_bo_driver *driver;
450 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
452 * Protected by the vm lock.
454 struct rb_root addr_space_rb;
455 struct drm_mm addr_space_mm;
458 * Protected by the global:lru lock.
460 struct list_head ddestroy;
463 * Protected by load / firstopen / lastclose /unload sync.
467 struct address_space *dev_mapping;
470 * Internal protection.
473 struct delayed_work wq;
481 * @old: Pointer to the result and original value.
482 * @new: New value of bits.
483 * @mask: Mask of bits to change.
485 * Convenience function to change a number of bits identified by a mask.
488 static inline uint32_t
489 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
491 *old ^= (*old ^ new) & mask;
498 * @bdev: pointer to a struct ttm_bo_device:
499 * @size: Size of the data needed backing.
500 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
501 * @dummy_read_page: See struct ttm_bo_device.
503 * Create a struct ttm_tt to back data with system memory pages.
504 * No pages are actually allocated.
506 * NULL: Out of memory.
508 extern struct ttm_tt *ttm_tt_create(struct ttm_bo_device *bdev,
511 struct page *dummy_read_page);
516 * @ttm: The struct ttm_tt to populate.
517 * @tsk: A struct task_struct for which @start is a valid user-space address.
518 * @start: A valid user-space address.
519 * @num_pages: Size in pages of the user memory area.
521 * Populate a struct ttm_tt with a user-space memory area after first pinning
522 * the pages backing it.
527 extern int ttm_tt_set_user(struct ttm_tt *ttm,
528 struct task_struct *tsk,
529 unsigned long start, unsigned long num_pages);
534 * @ttm: The struct ttm_tt containing backing pages.
535 * @bo_mem: The struct ttm_mem_reg identifying the binding location.
537 * Bind the pages of @ttm to an aperture location identified by @bo_mem
539 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
544 * @ttm: The struct ttm_tt to contain the backing pages.
546 * Add backing pages to all of @ttm
548 extern int ttm_tt_populate(struct ttm_tt *ttm);
553 * @ttm: The struct ttm_tt.
555 * Unbind, unpopulate and destroy a struct ttm_tt.
557 extern void ttm_tt_destroy(struct ttm_tt *ttm);
562 * @ttm: The struct ttm_tt.
564 * Unbind a struct ttm_tt.
566 extern void ttm_tt_unbind(struct ttm_tt *ttm);
571 * @ttm: The struct ttm_tt.
572 * @index: Index of the desired page.
574 * Return a pointer to the struct page backing @ttm at page
575 * index @index. If the page is unpopulated, one will be allocated to
576 * populate that index.
581 extern struct page *ttm_tt_get_page(struct ttm_tt *ttm, int index);
584 * ttm_tt_cache_flush:
586 * @pages: An array of pointers to struct page:s to flush.
587 * @num_pages: Number of pages to flush.
589 * Flush the data of the indicated pages from the cpu caches.
590 * This is used when changing caching attributes of the pages from
593 extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages);
596 * ttm_tt_set_placement_caching:
598 * @ttm A struct ttm_tt the backing pages of which will change caching policy.
599 * @placement: Flag indicating the desired caching policy.
601 * This function will change caching policy of any default kernel mappings of
602 * the pages backing @ttm. If changing from cached to uncached or
604 * all CPU caches will first be flushed to make sure the data of the pages
605 * hit RAM. This function may be very costly as it involves global TLB
606 * and cache flushes and potential page splitting / combining.
608 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
609 extern int ttm_tt_swapout(struct ttm_tt *ttm,
610 struct file *persistant_swap_storage);
619 * @bdev: Pointer to a struct ttm_bo_device.
620 * @mem: A valid struct ttm_mem_reg.
622 * Returns true if the memory described by @mem is PCI memory,
625 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
626 struct ttm_mem_reg *mem);
631 * @bo: Pointer to a struct ttm_buffer_object. the data of which
632 * we want to allocate space for.
633 * @proposed_placement: Proposed new placement for the buffer object.
634 * @mem: A struct ttm_mem_reg.
635 * @interruptible: Sleep interruptible when sliping.
636 * @no_wait: Don't sleep waiting for space to become available.
638 * Allocate memory space for the buffer object pointed to by @bo, using
639 * the placement flags in @mem, potentially evicting other idle buffer objects.
640 * This function may sleep while waiting for space to become available.
642 * -EBUSY: No space available (only if no_wait == 1).
643 * -ENOMEM: Could not allocate memory for the buffer object, either due to
644 * fragmentation or concurrent allocators.
645 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
647 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
648 struct ttm_placement *placement,
649 struct ttm_mem_reg *mem,
650 bool interruptible, bool no_wait);
652 * ttm_bo_wait_for_cpu
654 * @bo: Pointer to a struct ttm_buffer_object.
655 * @no_wait: Don't sleep while waiting.
657 * Wait until a buffer object is no longer sync'ed for CPU access.
659 * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1).
660 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
663 extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait);
666 * ttm_bo_pci_offset - Get the PCI offset for the buffer object memory.
668 * @bo Pointer to a struct ttm_buffer_object.
669 * @bus_base On return the base of the PCI region
670 * @bus_offset On return the byte offset into the PCI region
671 * @bus_size On return the byte size of the buffer object or zero if
672 * the buffer object memory is not accessible through a PCI region.
675 * -EINVAL if the buffer object is currently not mappable.
679 extern int ttm_bo_pci_offset(struct ttm_bo_device *bdev,
680 struct ttm_mem_reg *mem,
681 unsigned long *bus_base,
682 unsigned long *bus_offset,
683 unsigned long *bus_size);
685 extern void ttm_bo_global_release(struct ttm_global_reference *ref);
686 extern int ttm_bo_global_init(struct ttm_global_reference *ref);
688 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
693 * @bdev: A pointer to a struct ttm_bo_device to initialize.
694 * @mem_global: A pointer to an initialized struct ttm_mem_global.
695 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
696 * @file_page_offset: Offset into the device address space that is available
697 * for buffer data. This ensures compatibility with other users of the
700 * Initializes a struct ttm_bo_device:
704 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
705 struct ttm_bo_global *glob,
706 struct ttm_bo_driver *driver,
707 uint64_t file_page_offset, bool need_dma32);
710 * ttm_bo_unmap_virtual
712 * @bo: tear down the virtual mappings for this BO
714 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
719 * @bo: A pointer to a struct ttm_buffer_object.
720 * @interruptible: Sleep interruptible if waiting.
721 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
722 * @use_sequence: If @bo is already reserved, Only sleep waiting for
723 * it to become unreserved if @sequence < (@bo)->sequence.
725 * Locks a buffer object for validation. (Or prevents other processes from
726 * locking it for validation) and removes it from lru lists, while taking
727 * a number of measures to prevent deadlocks.
729 * Deadlocks may occur when two processes try to reserve multiple buffers in
730 * different order, either by will or as a result of a buffer being evicted
731 * to make room for a buffer already reserved. (Buffers are reserved before
732 * they are evicted). The following algorithm prevents such deadlocks from
734 * 1) Buffers are reserved with the lru spinlock held. Upon successful
735 * reservation they are removed from the lru list. This stops a reserved buffer
736 * from being evicted. However the lru spinlock is released between the time
737 * a buffer is selected for eviction and the time it is reserved.
738 * Therefore a check is made when a buffer is reserved for eviction, that it
739 * is still the first buffer in the lru list, before it is removed from the
740 * list. @check_lru == 1 forces this check. If it fails, the function returns
741 * -EINVAL, and the caller should then choose a new buffer to evict and repeat
743 * 2) Processes attempting to reserve multiple buffers other than for eviction,
744 * (typically execbuf), should first obtain a unique 32-bit
745 * validation sequence number,
746 * and call this function with @use_sequence == 1 and @sequence == the unique
747 * sequence number. If upon call of this function, the buffer object is already
748 * reserved, the validation sequence is checked against the validation
749 * sequence of the process currently reserving the buffer,
750 * and if the current validation sequence is greater than that of the process
751 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
752 * waiting for the buffer to become unreserved, after which it retries
754 * The caller should, when receiving an -EAGAIN error
755 * release all its buffer reservations, wait for @bo to become unreserved, and
756 * then rerun the validation with the same validation sequence. This procedure
757 * will always guarantee that the process with the lowest validation sequence
758 * will eventually succeed, preventing both deadlocks and starvation.
761 * -EAGAIN: The reservation may cause a deadlock.
762 * Release all buffer reservations, wait for @bo to become unreserved and
763 * try again. (only if use_sequence == 1).
764 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
765 * a signal. Release all buffer reservations and return to user-space.
767 extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
769 bool no_wait, bool use_sequence, uint32_t sequence);
774 * @bo: A pointer to a struct ttm_buffer_object.
776 * Unreserve a previous reservation of @bo.
778 extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
781 * ttm_bo_wait_unreserved
783 * @bo: A pointer to a struct ttm_buffer_object.
785 * Wait for a struct ttm_buffer_object to become unreserved.
786 * This is typically used in the execbuf code to relax cpu-usage when
787 * a potential deadlock condition backoff.
789 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo,
793 * ttm_bo_block_reservation
795 * @bo: A pointer to a struct ttm_buffer_object.
796 * @interruptible: Use interruptible sleep when waiting.
797 * @no_wait: Don't sleep, but rather return -EBUSY.
799 * Block reservation for validation by simply reserving the buffer.
800 * This is intended for single buffer use only without eviction,
801 * and thus needs no deadlock protection.
804 * -EBUSY: If no_wait == 1 and the buffer is already reserved.
805 * -ERESTARTSYS: If interruptible == 1 and the process received a signal
808 extern int ttm_bo_block_reservation(struct ttm_buffer_object *bo,
809 bool interruptible, bool no_wait);
812 * ttm_bo_unblock_reservation
814 * @bo: A pointer to a struct ttm_buffer_object.
816 * Unblocks reservation leaving lru lists untouched.
818 extern void ttm_bo_unblock_reservation(struct ttm_buffer_object *bo);
827 * @bo: A pointer to a struct ttm_buffer_object.
828 * @evict: 1: This is an eviction. Don't try to pipeline.
829 * @no_wait: Never sleep, but rather return with -EBUSY.
830 * @new_mem: struct ttm_mem_reg indicating where to move.
832 * Optimized move function for a buffer object with both old and
833 * new placement backed by a TTM. The function will, if successful,
834 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
835 * and update the (@bo)->mem placement flags. If unsuccessful, the old
836 * data remains untouched, and it's up to the caller to free the
837 * memory space indicated by @new_mem.
842 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
843 bool evict, bool no_wait,
844 struct ttm_mem_reg *new_mem);
849 * @bo: A pointer to a struct ttm_buffer_object.
850 * @evict: 1: This is an eviction. Don't try to pipeline.
851 * @no_wait: Never sleep, but rather return with -EBUSY.
852 * @new_mem: struct ttm_mem_reg indicating where to move.
854 * Fallback move function for a mappable buffer object in mappable memory.
855 * The function will, if successful,
856 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
857 * and update the (@bo)->mem placement flags. If unsuccessful, the old
858 * data remains untouched, and it's up to the caller to free the
859 * memory space indicated by @new_mem.
864 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
866 bool no_wait, struct ttm_mem_reg *new_mem);
869 * ttm_bo_free_old_node
871 * @bo: A pointer to a struct ttm_buffer_object.
873 * Utility function to free an old placement after a successful move.
875 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
878 * ttm_bo_move_accel_cleanup.
880 * @bo: A pointer to a struct ttm_buffer_object.
881 * @sync_obj: A sync object that signals when moving is complete.
882 * @sync_obj_arg: An argument to pass to the sync object idle / wait
884 * @evict: This is an evict move. Don't return until the buffer is idle.
885 * @no_wait: Never sleep, but rather return with -EBUSY.
886 * @new_mem: struct ttm_mem_reg indicating where to move.
888 * Accelerated move function to be called when an accelerated move
889 * has been scheduled. The function will create a new temporary buffer object
890 * representing the old placement, and put the sync object on both buffer
891 * objects. After that the newly created buffer object is unref'd to be
892 * destroyed when the move is complete. This will help pipeline
896 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
899 bool evict, bool no_wait,
900 struct ttm_mem_reg *new_mem);
904 * @c_state: Caching state.
905 * @tmp: Page protection flag for a normal, cached mapping.
907 * Utility function that returns the pgprot_t that should be used for
908 * setting up a PTE with the caching model indicated by @c_state.
910 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
912 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
914 #include <linux/agp_backend.h>
917 * ttm_agp_backend_init
919 * @bdev: Pointer to a struct ttm_bo_device.
920 * @bridge: The agp bridge this device is sitting on.
922 * Create a TTM backend that uses the indicated AGP bridge as an aperture
923 * for TT memory. This function uses the linux agpgart interface to
924 * bind and unbind memory backing a ttm_tt.
926 extern struct ttm_backend *ttm_agp_backend_init(struct ttm_bo_device *bdev,
927 struct agp_bridge_data *bridge);