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
53 * @dma_addrs: Array of DMA (bus) address of the ttm pages.
55 * Populate the backend with ttm pages. Depending on the backend,
56 * it may or may not copy the @pages array.
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);
63 * struct ttm_backend_func member clear
65 * @backend: Pointer to a struct ttm_backend.
67 * This is an "unpopulate" function. Release all resources
68 * allocated with populate.
70 void (*clear) (struct ttm_backend *backend);
73 * struct ttm_backend_func member bind
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.
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.
83 int (*bind) (struct ttm_backend *backend, struct ttm_mem_reg *bo_mem);
86 * struct ttm_backend_func member unbind
88 * @backend: Pointer to a struct ttm_backend.
90 * Unbind previously bound backend pages. This function should be
91 * able to handle differences between aperture- and system page sizes.
93 int (*unbind) (struct ttm_backend *backend);
96 * struct ttm_backend_func member destroy
98 * @backend: Pointer to a struct ttm_backend.
100 * Destroy the backend.
102 void (*destroy) (struct ttm_backend *backend);
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.
116 struct ttm_bo_device *bdev;
118 struct ttm_backend_func *func;
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_PERSISTANT_SWAP (1 << 5)
126 #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
127 #define TTM_PAGE_FLAG_DMA32 (1 << 7)
129 enum ttm_caching_state {
138 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
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
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)
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)
162 struct page *dummy_read_page;
164 long first_himem_page;
165 long last_lomem_page;
167 unsigned long num_pages;
168 struct ttm_bo_global *glob;
169 struct ttm_backend *be;
170 struct task_struct *tsk;
172 struct file *swap_storage;
173 enum ttm_caching_state caching_state;
179 dma_addr_t *dma_address;
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 */
187 * struct ttm_mem_type_manager
189 * @has_type: The memory type has been initialized.
190 * @use_type: The memory type is enabled.
191 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
192 * managed by this memory type.
193 * @gpu_offset: If used, the GPU offset of the first managed page of
194 * fixed memory or the first managed location in an aperture.
195 * @size: Size of the managed region.
196 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
197 * as defined in ttm_placement_common.h
198 * @default_caching: The default caching policy used for a buffer object
199 * placed in this memory type if the user doesn't provide one.
200 * @manager: The range manager used for this memory type. FIXME: If the aperture
201 * has a page size different from the underlying system, the granularity
202 * of this manager should take care of this. But the range allocating code
203 * in ttm_bo.c needs to be modified for this.
204 * @lru: The lru list for this memory type.
206 * This structure is used to identify and manage memory types for a device.
207 * It's set up by the ttm_bo_driver::init_mem_type method.
210 struct ttm_mem_type_manager;
212 struct ttm_mem_type_manager_func {
214 * struct ttm_mem_type_manager member init
216 * @man: Pointer to a memory type manager.
217 * @p_size: Implementation dependent, but typically the size of the
218 * range to be managed in pages.
220 * Called to initialize a private range manager. The function is
221 * expected to initialize the man::priv member.
222 * Returns 0 on success, negative error code on failure.
224 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
227 * struct ttm_mem_type_manager member takedown
229 * @man: Pointer to a memory type manager.
231 * Called to undo the setup done in init. All allocated resources
234 int (*takedown)(struct ttm_mem_type_manager *man);
237 * struct ttm_mem_type_manager member get_node
239 * @man: Pointer to a memory type manager.
240 * @bo: Pointer to the buffer object we're allocating space for.
241 * @placement: Placement details.
242 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
244 * This function should allocate space in the memory type managed
245 * by @man. Placement details if
246 * applicable are given by @placement. If successful,
247 * @mem::mm_node should be set to a non-null value, and
248 * @mem::start should be set to a value identifying the beginning
249 * of the range allocated, and the function should return zero.
250 * If the memory region accomodate the buffer object, @mem::mm_node
251 * should be set to NULL, and the function should return 0.
252 * If a system error occured, preventing the request to be fulfilled,
253 * the function should return a negative error code.
255 * Note that @mem::mm_node will only be dereferenced by
256 * struct ttm_mem_type_manager functions and optionally by the driver,
257 * which has knowledge of the underlying type.
259 * This function may not be called from within atomic context, so
260 * an implementation can and must use either a mutex or a spinlock to
261 * protect any data structures managing the space.
263 int (*get_node)(struct ttm_mem_type_manager *man,
264 struct ttm_buffer_object *bo,
265 struct ttm_placement *placement,
266 struct ttm_mem_reg *mem);
269 * struct ttm_mem_type_manager member put_node
271 * @man: Pointer to a memory type manager.
272 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
274 * This function frees memory type resources previously allocated
275 * and that are identified by @mem::mm_node and @mem::start. May not
276 * be called from within atomic context.
278 void (*put_node)(struct ttm_mem_type_manager *man,
279 struct ttm_mem_reg *mem);
282 * struct ttm_mem_type_manager member debug
284 * @man: Pointer to a memory type manager.
285 * @prefix: Prefix to be used in printout to identify the caller.
287 * This function is called to print out the state of the memory
288 * type manager to aid debugging of out-of-memory conditions.
289 * It may not be called from within atomic context.
291 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
294 struct ttm_mem_type_manager {
295 struct ttm_bo_device *bdev;
298 * No protection. Constant from start.
304 unsigned long gpu_offset;
306 uint32_t available_caching;
307 uint32_t default_caching;
308 const struct ttm_mem_type_manager_func *func;
312 * Protected by the global->lru_lock.
315 struct list_head lru;
319 * struct ttm_bo_driver
321 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
322 * @invalidate_caches: Callback to invalidate read caches when a buffer object
324 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
326 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
327 * @move: Callback for a driver to hook in accelerated functions to
329 * If set to NULL, a potentially slow memcpy() move is used.
330 * @sync_obj_signaled: See ttm_fence_api.h
331 * @sync_obj_wait: See ttm_fence_api.h
332 * @sync_obj_flush: See ttm_fence_api.h
333 * @sync_obj_unref: See ttm_fence_api.h
334 * @sync_obj_ref: See ttm_fence_api.h
337 struct ttm_bo_driver {
339 * struct ttm_bo_driver member create_ttm_backend_entry
341 * @bdev: The buffer object device.
343 * Create a driver specific struct ttm_backend.
346 struct ttm_backend *(*create_ttm_backend_entry)
347 (struct ttm_bo_device *bdev);
350 * struct ttm_bo_driver member invalidate_caches
352 * @bdev: the buffer object device.
353 * @flags: new placement of the rebound buffer object.
355 * A previosly evicted buffer has been rebound in a
356 * potentially new location. Tell the driver that it might
357 * consider invalidating read (texture) caches on the next command
358 * submission as a consequence.
361 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
362 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
363 struct ttm_mem_type_manager *man);
365 * struct ttm_bo_driver member evict_flags:
367 * @bo: the buffer object to be evicted
369 * Return the bo flags for a buffer which is not mapped to the hardware.
370 * These will be placed in proposed_flags so that when the move is
371 * finished, they'll end up in bo->mem.flags
374 void(*evict_flags) (struct ttm_buffer_object *bo,
375 struct ttm_placement *placement);
377 * struct ttm_bo_driver member move:
379 * @bo: the buffer to move
380 * @evict: whether this motion is evicting the buffer from
381 * the graphics address space
382 * @interruptible: Use interruptible sleeps if possible when sleeping.
383 * @no_wait: whether this should give up and return -EBUSY
384 * if this move would require sleeping
385 * @new_mem: the new memory region receiving the buffer
387 * Move a buffer between two memory regions.
389 int (*move) (struct ttm_buffer_object *bo,
390 bool evict, bool interruptible,
391 bool no_wait_reserve, bool no_wait_gpu,
392 struct ttm_mem_reg *new_mem);
395 * struct ttm_bo_driver_member verify_access
397 * @bo: Pointer to a buffer object.
398 * @filp: Pointer to a struct file trying to access the object.
400 * Called from the map / write / read methods to verify that the
401 * caller is permitted to access the buffer object.
402 * This member may be set to NULL, which will refuse this kind of
403 * access for all buffer objects.
404 * This function should return 0 if access is granted, -EPERM otherwise.
406 int (*verify_access) (struct ttm_buffer_object *bo,
410 * In case a driver writer dislikes the TTM fence objects,
411 * the driver writer can replace those with sync objects of
412 * his / her own. If it turns out that no driver writer is
413 * using these. I suggest we remove these hooks and plug in
414 * fences directly. The bo driver needs the following functionality:
415 * See the corresponding functions in the fence object API
419 bool (*sync_obj_signaled) (void *sync_obj, void *sync_arg);
420 int (*sync_obj_wait) (void *sync_obj, void *sync_arg,
421 bool lazy, bool interruptible);
422 int (*sync_obj_flush) (void *sync_obj, void *sync_arg);
423 void (*sync_obj_unref) (void **sync_obj);
424 void *(*sync_obj_ref) (void *sync_obj);
426 /* hook to notify driver about a driver move so it
427 * can do tiling things */
428 void (*move_notify)(struct ttm_buffer_object *bo,
429 struct ttm_mem_reg *new_mem);
430 /* notify the driver we are taking a fault on this BO
431 * and have reserved it */
432 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
435 * notify the driver that we're about to swap out this bo
437 void (*swap_notify) (struct ttm_buffer_object *bo);
440 * Driver callback on when mapping io memory (for bo_move_memcpy
441 * for instance). TTM will take care to call io_mem_free whenever
442 * the mapping is not use anymore. io_mem_reserve & io_mem_free
445 int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
446 void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
450 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
453 struct ttm_bo_global_ref {
454 struct drm_global_reference ref;
455 struct ttm_mem_global *mem_glob;
459 * struct ttm_bo_global - Buffer object driver global data.
461 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
462 * @dummy_read_page: Pointer to a dummy page used for mapping requests
463 * of unpopulated pages.
464 * @shrink: A shrink callback object used for buffer object swap.
465 * @ttm_bo_extra_size: Extra size (sizeof(struct ttm_buffer_object) excluded)
466 * used by a buffer object. This is excluding page arrays and backing pages.
467 * @ttm_bo_size: This is @ttm_bo_extra_size + sizeof(struct ttm_buffer_object).
468 * @device_list_mutex: Mutex protecting the device list.
469 * This mutex is held while traversing the device list for pm options.
470 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
471 * @device_list: List of buffer object devices.
472 * @swap_lru: Lru list of buffer objects used for swapping.
475 struct ttm_bo_global {
478 * Constant after init.
482 struct ttm_mem_global *mem_glob;
483 struct page *dummy_read_page;
484 struct ttm_mem_shrink shrink;
485 size_t ttm_bo_extra_size;
487 struct mutex device_list_mutex;
491 * Protected by device_list_mutex.
493 struct list_head device_list;
496 * Protected by the lru_lock.
498 struct list_head swap_lru;
501 * Internal protection.
507 #define TTM_NUM_MEM_TYPES 8
509 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
510 idling before CPU mapping */
511 #define TTM_BO_PRIV_FLAG_MAX 1
513 * struct ttm_bo_device - Buffer object driver device-specific data.
515 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
516 * @man: An array of mem_type_managers.
517 * @addr_space_mm: Range manager for the device address space.
518 * lru_lock: Spinlock that protects the buffer+device lru lists and
520 * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager.
521 * If a GPU lockup has been detected, this is forced to 0.
522 * @dev_mapping: A pointer to the struct address_space representing the
523 * device address space.
524 * @wq: Work queue structure for the delayed delete workqueue.
528 struct ttm_bo_device {
531 * Constant after bo device init / atomic.
533 struct list_head device_list;
534 struct ttm_bo_global *glob;
535 struct ttm_bo_driver *driver;
538 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
540 * Protected by the vm lock.
542 struct rb_root addr_space_rb;
543 struct drm_mm addr_space_mm;
546 * Protected by the global:lru lock.
548 struct list_head ddestroy;
551 * Protected by load / firstopen / lastclose /unload sync.
555 struct address_space *dev_mapping;
558 * Internal protection.
561 struct delayed_work wq;
569 * @old: Pointer to the result and original value.
570 * @new: New value of bits.
571 * @mask: Mask of bits to change.
573 * Convenience function to change a number of bits identified by a mask.
576 static inline uint32_t
577 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
579 *old ^= (*old ^ new) & mask;
586 * @bdev: pointer to a struct ttm_bo_device:
587 * @size: Size of the data needed backing.
588 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
589 * @dummy_read_page: See struct ttm_bo_device.
591 * Create a struct ttm_tt to back data with system memory pages.
592 * No pages are actually allocated.
594 * NULL: Out of memory.
596 extern struct ttm_tt *ttm_tt_create(struct ttm_bo_device *bdev,
599 struct page *dummy_read_page);
604 * @ttm: The struct ttm_tt to populate.
605 * @tsk: A struct task_struct for which @start is a valid user-space address.
606 * @start: A valid user-space address.
607 * @num_pages: Size in pages of the user memory area.
609 * Populate a struct ttm_tt with a user-space memory area after first pinning
610 * the pages backing it.
615 extern int ttm_tt_set_user(struct ttm_tt *ttm,
616 struct task_struct *tsk,
617 unsigned long start, unsigned long num_pages);
622 * @ttm: The struct ttm_tt containing backing pages.
623 * @bo_mem: The struct ttm_mem_reg identifying the binding location.
625 * Bind the pages of @ttm to an aperture location identified by @bo_mem
627 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
632 * @ttm: The struct ttm_tt to contain the backing pages.
634 * Add backing pages to all of @ttm
636 extern int ttm_tt_populate(struct ttm_tt *ttm);
641 * @ttm: The struct ttm_tt.
643 * Unbind, unpopulate and destroy a struct ttm_tt.
645 extern void ttm_tt_destroy(struct ttm_tt *ttm);
650 * @ttm: The struct ttm_tt.
652 * Unbind a struct ttm_tt.
654 extern void ttm_tt_unbind(struct ttm_tt *ttm);
659 * @ttm: The struct ttm_tt.
660 * @index: Index of the desired page.
662 * Return a pointer to the struct page backing @ttm at page
663 * index @index. If the page is unpopulated, one will be allocated to
664 * populate that index.
669 extern struct page *ttm_tt_get_page(struct ttm_tt *ttm, int index);
672 * ttm_tt_cache_flush:
674 * @pages: An array of pointers to struct page:s to flush.
675 * @num_pages: Number of pages to flush.
677 * Flush the data of the indicated pages from the cpu caches.
678 * This is used when changing caching attributes of the pages from
681 extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages);
684 * ttm_tt_set_placement_caching:
686 * @ttm A struct ttm_tt the backing pages of which will change caching policy.
687 * @placement: Flag indicating the desired caching policy.
689 * This function will change caching policy of any default kernel mappings of
690 * the pages backing @ttm. If changing from cached to uncached or
692 * all CPU caches will first be flushed to make sure the data of the pages
693 * hit RAM. This function may be very costly as it involves global TLB
694 * and cache flushes and potential page splitting / combining.
696 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
697 extern int ttm_tt_swapout(struct ttm_tt *ttm,
698 struct file *persistant_swap_storage);
707 * @bdev: Pointer to a struct ttm_bo_device.
708 * @mem: A valid struct ttm_mem_reg.
710 * Returns true if the memory described by @mem is PCI memory,
713 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
714 struct ttm_mem_reg *mem);
719 * @bo: Pointer to a struct ttm_buffer_object. the data of which
720 * we want to allocate space for.
721 * @proposed_placement: Proposed new placement for the buffer object.
722 * @mem: A struct ttm_mem_reg.
723 * @interruptible: Sleep interruptible when sliping.
724 * @no_wait_reserve: Return immediately if other buffers are busy.
725 * @no_wait_gpu: Return immediately if the GPU is busy.
727 * Allocate memory space for the buffer object pointed to by @bo, using
728 * the placement flags in @mem, potentially evicting other idle buffer objects.
729 * This function may sleep while waiting for space to become available.
731 * -EBUSY: No space available (only if no_wait == 1).
732 * -ENOMEM: Could not allocate memory for the buffer object, either due to
733 * fragmentation or concurrent allocators.
734 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
736 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
737 struct ttm_placement *placement,
738 struct ttm_mem_reg *mem,
740 bool no_wait_reserve, bool no_wait_gpu);
742 extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
743 struct ttm_mem_reg *mem);
744 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
745 struct ttm_mem_reg *mem);
748 * ttm_bo_wait_for_cpu
750 * @bo: Pointer to a struct ttm_buffer_object.
751 * @no_wait: Don't sleep while waiting.
753 * Wait until a buffer object is no longer sync'ed for CPU access.
755 * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1).
756 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
759 extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait);
762 * ttm_bo_pci_offset - Get the PCI offset for the buffer object memory.
764 * @bo Pointer to a struct ttm_buffer_object.
765 * @bus_base On return the base of the PCI region
766 * @bus_offset On return the byte offset into the PCI region
767 * @bus_size On return the byte size of the buffer object or zero if
768 * the buffer object memory is not accessible through a PCI region.
771 * -EINVAL if the buffer object is currently not mappable.
775 extern int ttm_bo_pci_offset(struct ttm_bo_device *bdev,
776 struct ttm_mem_reg *mem,
777 unsigned long *bus_base,
778 unsigned long *bus_offset,
779 unsigned long *bus_size);
781 extern int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
782 struct ttm_mem_reg *mem);
783 extern void ttm_mem_io_free(struct ttm_bo_device *bdev,
784 struct ttm_mem_reg *mem);
786 extern void ttm_bo_global_release(struct drm_global_reference *ref);
787 extern int ttm_bo_global_init(struct drm_global_reference *ref);
789 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
794 * @bdev: A pointer to a struct ttm_bo_device to initialize.
795 * @mem_global: A pointer to an initialized struct ttm_mem_global.
796 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
797 * @file_page_offset: Offset into the device address space that is available
798 * for buffer data. This ensures compatibility with other users of the
801 * Initializes a struct ttm_bo_device:
805 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
806 struct ttm_bo_global *glob,
807 struct ttm_bo_driver *driver,
808 uint64_t file_page_offset, bool need_dma32);
811 * ttm_bo_unmap_virtual
813 * @bo: tear down the virtual mappings for this BO
815 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
820 * @bo: A pointer to a struct ttm_buffer_object.
821 * @interruptible: Sleep interruptible if waiting.
822 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
823 * @use_sequence: If @bo is already reserved, Only sleep waiting for
824 * it to become unreserved if @sequence < (@bo)->sequence.
826 * Locks a buffer object for validation. (Or prevents other processes from
827 * locking it for validation) and removes it from lru lists, while taking
828 * a number of measures to prevent deadlocks.
830 * Deadlocks may occur when two processes try to reserve multiple buffers in
831 * different order, either by will or as a result of a buffer being evicted
832 * to make room for a buffer already reserved. (Buffers are reserved before
833 * they are evicted). The following algorithm prevents such deadlocks from
835 * 1) Buffers are reserved with the lru spinlock held. Upon successful
836 * reservation they are removed from the lru list. This stops a reserved buffer
837 * from being evicted. However the lru spinlock is released between the time
838 * a buffer is selected for eviction and the time it is reserved.
839 * Therefore a check is made when a buffer is reserved for eviction, that it
840 * is still the first buffer in the lru list, before it is removed from the
841 * list. @check_lru == 1 forces this check. If it fails, the function returns
842 * -EINVAL, and the caller should then choose a new buffer to evict and repeat
844 * 2) Processes attempting to reserve multiple buffers other than for eviction,
845 * (typically execbuf), should first obtain a unique 32-bit
846 * validation sequence number,
847 * and call this function with @use_sequence == 1 and @sequence == the unique
848 * sequence number. If upon call of this function, the buffer object is already
849 * reserved, the validation sequence is checked against the validation
850 * sequence of the process currently reserving the buffer,
851 * and if the current validation sequence is greater than that of the process
852 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
853 * waiting for the buffer to become unreserved, after which it retries
855 * The caller should, when receiving an -EAGAIN error
856 * release all its buffer reservations, wait for @bo to become unreserved, and
857 * then rerun the validation with the same validation sequence. This procedure
858 * will always guarantee that the process with the lowest validation sequence
859 * will eventually succeed, preventing both deadlocks and starvation.
862 * -EAGAIN: The reservation may cause a deadlock.
863 * Release all buffer reservations, wait for @bo to become unreserved and
864 * try again. (only if use_sequence == 1).
865 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
866 * a signal. Release all buffer reservations and return to user-space.
868 extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
870 bool no_wait, bool use_sequence, uint32_t sequence);
875 * @bo: A pointer to a struct ttm_buffer_object.
877 * Unreserve a previous reservation of @bo.
879 extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
882 * ttm_bo_wait_unreserved
884 * @bo: A pointer to a struct ttm_buffer_object.
886 * Wait for a struct ttm_buffer_object to become unreserved.
887 * This is typically used in the execbuf code to relax cpu-usage when
888 * a potential deadlock condition backoff.
890 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo,
900 * @bo: A pointer to a struct ttm_buffer_object.
901 * @evict: 1: This is an eviction. Don't try to pipeline.
902 * @no_wait_reserve: Return immediately if other buffers are busy.
903 * @no_wait_gpu: Return immediately if the GPU is busy.
904 * @new_mem: struct ttm_mem_reg indicating where to move.
906 * Optimized move function for a buffer object with both old and
907 * new placement backed by a TTM. The function will, if successful,
908 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
909 * and update the (@bo)->mem placement flags. If unsuccessful, the old
910 * data remains untouched, and it's up to the caller to free the
911 * memory space indicated by @new_mem.
916 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
917 bool evict, bool no_wait_reserve,
918 bool no_wait_gpu, struct ttm_mem_reg *new_mem);
923 * @bo: A pointer to a struct ttm_buffer_object.
924 * @evict: 1: This is an eviction. Don't try to pipeline.
925 * @no_wait_reserve: Return immediately if other buffers are busy.
926 * @no_wait_gpu: Return immediately if the GPU is busy.
927 * @new_mem: struct ttm_mem_reg indicating where to move.
929 * Fallback move function for a mappable buffer object in mappable memory.
930 * The function will, if successful,
931 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
932 * and update the (@bo)->mem placement flags. If unsuccessful, the old
933 * data remains untouched, and it's up to the caller to free the
934 * memory space indicated by @new_mem.
939 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
940 bool evict, bool no_wait_reserve,
941 bool no_wait_gpu, struct ttm_mem_reg *new_mem);
944 * ttm_bo_free_old_node
946 * @bo: A pointer to a struct ttm_buffer_object.
948 * Utility function to free an old placement after a successful move.
950 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
953 * ttm_bo_move_accel_cleanup.
955 * @bo: A pointer to a struct ttm_buffer_object.
956 * @sync_obj: A sync object that signals when moving is complete.
957 * @sync_obj_arg: An argument to pass to the sync object idle / wait
959 * @evict: This is an evict move. Don't return until the buffer is idle.
960 * @no_wait_reserve: Return immediately if other buffers are busy.
961 * @no_wait_gpu: Return immediately if the GPU is busy.
962 * @new_mem: struct ttm_mem_reg indicating where to move.
964 * Accelerated move function to be called when an accelerated move
965 * has been scheduled. The function will create a new temporary buffer object
966 * representing the old placement, and put the sync object on both buffer
967 * objects. After that the newly created buffer object is unref'd to be
968 * destroyed when the move is complete. This will help pipeline
972 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
975 bool evict, bool no_wait_reserve,
977 struct ttm_mem_reg *new_mem);
981 * @c_state: Caching state.
982 * @tmp: Page protection flag for a normal, cached mapping.
984 * Utility function that returns the pgprot_t that should be used for
985 * setting up a PTE with the caching model indicated by @c_state.
987 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
989 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
991 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
993 #include <linux/agp_backend.h>
996 * ttm_agp_backend_init
998 * @bdev: Pointer to a struct ttm_bo_device.
999 * @bridge: The agp bridge this device is sitting on.
1001 * Create a TTM backend that uses the indicated AGP bridge as an aperture
1002 * for TT memory. This function uses the linux agpgart interface to
1003 * bind and unbind memory backing a ttm_tt.
1005 extern struct ttm_backend *ttm_agp_backend_init(struct ttm_bo_device *bdev,
1006 struct agp_bridge_data *bridge);