ttm_bo_driver.h revision 254863
185587Sobrien/************************************************************************** 285587Sobrien * 385587Sobrien * Copyright (c) 2006-2009 Vmware, Inc., Palo Alto, CA., USA 485587Sobrien * All Rights Reserved. 585587Sobrien * 685587Sobrien * Permission is hereby granted, free of charge, to any person obtaining a 785587Sobrien * copy of this software and associated documentation files (the 885587Sobrien * "Software"), to deal in the Software without restriction, including 985587Sobrien * without limitation the rights to use, copy, modify, merge, publish, 1085587Sobrien * distribute, sub license, and/or sell copies of the Software, and to 1185587Sobrien * permit persons to whom the Software is furnished to do so, subject to 1285587Sobrien * the following conditions: 1385587Sobrien * 1485587Sobrien * The above copyright notice and this permission notice (including the 1585587Sobrien * next paragraph) shall be included in all copies or substantial portions 1685587Sobrien * of the Software. 1785587Sobrien * 1885587Sobrien * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 1985587Sobrien * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 2085587Sobrien * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 2185587Sobrien * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, 2285587Sobrien * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 2385587Sobrien * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 2485587Sobrien * USE OR OTHER DEALINGS IN THE SOFTWARE. 2585587Sobrien * 2685587Sobrien **************************************************************************/ 2785587Sobrien/* 2885587Sobrien * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com> 2985587Sobrien */ 3085587Sobrien/* $FreeBSD: head/sys/dev/drm2/ttm/ttm_bo_driver.h 254863 2013-08-25 14:47:22Z dumbbell $ */ 3185587Sobrien 3285587Sobrien#ifndef _TTM_BO_DRIVER_H_ 3385587Sobrien#define _TTM_BO_DRIVER_H_ 3485587Sobrien 3585587Sobrien#include <dev/drm2/drmP.h> 3685587Sobrien#include <dev/drm2/ttm/ttm_bo_api.h> 3785587Sobrien#include <dev/drm2/ttm/ttm_memory.h> 3885587Sobrien#include <dev/drm2/ttm/ttm_module.h> 3985587Sobrien#include <dev/drm2/drm_global.h> 4085587Sobrien#include <sys/rwlock.h> 4185587Sobrien#include <sys/tree.h> 4285587Sobrien 4385587Sobrienstruct ttm_backend_func { 4485587Sobrien /** 4585587Sobrien * struct ttm_backend_func member bind 4685587Sobrien * 4785587Sobrien * @ttm: Pointer to a struct ttm_tt. 4885587Sobrien * @bo_mem: Pointer to a struct ttm_mem_reg describing the 4985587Sobrien * memory type and location for binding. 5085587Sobrien * 5185587Sobrien * Bind the backend pages into the aperture in the location 5285587Sobrien * indicated by @bo_mem. This function should be able to handle 5385587Sobrien * differences between aperture and system page sizes. 54146299Sru */ 5585587Sobrien int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); 5685587Sobrien 5785587Sobrien /** 5885587Sobrien * struct ttm_backend_func member unbind 5985587Sobrien * 6085587Sobrien * @ttm: Pointer to a struct ttm_tt. 6185587Sobrien * 6285587Sobrien * Unbind previously bound backend pages. This function should be 6385587Sobrien * able to handle differences between aperture and system page sizes. 6485587Sobrien */ 6585587Sobrien int (*unbind) (struct ttm_tt *ttm); 6685587Sobrien 6785587Sobrien /** 6885587Sobrien * struct ttm_backend_func member destroy 6985587Sobrien * 7085587Sobrien * @ttm: Pointer to a struct ttm_tt. 7185587Sobrien * 7285587Sobrien * Destroy the backend. This will be call back from ttm_tt_destroy so 7385587Sobrien * don't call ttm_tt_destroy from the callback or infinite loop. 7485587Sobrien */ 7585587Sobrien void (*destroy) (struct ttm_tt *ttm); 7685587Sobrien}; 77146299Sru 78146299Sru#define TTM_PAGE_FLAG_WRITE (1 << 3) 7985587Sobrien#define TTM_PAGE_FLAG_SWAPPED (1 << 4) 8085587Sobrien#define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5) 8185587Sobrien#define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6) 8285587Sobrien#define TTM_PAGE_FLAG_DMA32 (1 << 7) 8385587Sobrien#define TTM_PAGE_FLAG_SG (1 << 8) 8485587Sobrien 8585587Sobrienenum ttm_caching_state { 8685587Sobrien tt_uncached, 8785587Sobrien tt_wc, 8885587Sobrien tt_cached 8985587Sobrien}; 9085587Sobrien 9185587Sobrien/** 9285587Sobrien * struct ttm_tt 9385587Sobrien * 9485587Sobrien * @bdev: Pointer to a struct ttm_bo_device. 9585587Sobrien * @func: Pointer to a struct ttm_backend_func that describes 9685587Sobrien * the backend methods. 9785587Sobrien * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL 9885587Sobrien * pointer. 9985587Sobrien * @pages: Array of pages backing the data. 10085587Sobrien * @num_pages: Number of pages in the page array. 10185587Sobrien * @bdev: Pointer to the current struct ttm_bo_device. 10285587Sobrien * @be: Pointer to the ttm backend. 10385587Sobrien * @swap_storage: Pointer to shmem struct file for swap storage. 10485587Sobrien * @caching_state: The current caching state of the pages. 10585587Sobrien * @state: The current binding state of the pages. 10685587Sobrien * 10785587Sobrien * This is a structure holding the pages, caching- and aperture binding 10885587Sobrien * status for a buffer object that isn't backed by fixed (VRAM / AGP) 10985587Sobrien * memory. 11085587Sobrien */ 11185587Sobrien 11285587Sobrienstruct ttm_tt { 11385587Sobrien struct ttm_bo_device *bdev; 11485587Sobrien struct ttm_backend_func *func; 11585587Sobrien struct vm_page *dummy_read_page; 11685587Sobrien struct vm_page **pages; 11785587Sobrien uint32_t page_flags; 11885587Sobrien unsigned long num_pages; 11985587Sobrien struct sg_table *sg; /* for SG objects via dma-buf */ 12085587Sobrien struct ttm_bo_global *glob; 12185587Sobrien struct vm_object *swap_storage; 12285587Sobrien enum ttm_caching_state caching_state; 12385587Sobrien enum { 12485587Sobrien tt_bound, 12585587Sobrien tt_unbound, 12685587Sobrien tt_unpopulated, 12785587Sobrien } state; 12885587Sobrien}; 12985587Sobrien 13085587Sobrien/** 13185587Sobrien * struct ttm_dma_tt 13285587Sobrien * 13385587Sobrien * @ttm: Base ttm_tt struct. 13485587Sobrien * @dma_address: The DMA (bus) addresses of the pages 13585587Sobrien * @pages_list: used by some page allocation backend 13685587Sobrien * 13785587Sobrien * This is a structure holding the pages, caching- and aperture binding 13885587Sobrien * status for a buffer object that isn't backed by fixed (VRAM / AGP) 13985587Sobrien * memory. 14085587Sobrien */ 14185587Sobrienstruct ttm_dma_tt { 14285587Sobrien struct ttm_tt ttm; 14385587Sobrien dma_addr_t *dma_address; 14485587Sobrien struct list_head pages_list; 14585587Sobrien}; 14685587Sobrien 14785587Sobrien#define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */ 14885587Sobrien#define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */ 14985587Sobrien#define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */ 15085587Sobrien 15185587Sobrienstruct ttm_mem_type_manager; 15285587Sobrien 15385587Sobrienstruct ttm_mem_type_manager_func { 15485587Sobrien /** 15585587Sobrien * struct ttm_mem_type_manager member init 15685587Sobrien * 15785587Sobrien * @man: Pointer to a memory type manager. 15885587Sobrien * @p_size: Implementation dependent, but typically the size of the 15985587Sobrien * range to be managed in pages. 16085587Sobrien * 16185587Sobrien * Called to initialize a private range manager. The function is 16285587Sobrien * expected to initialize the man::priv member. 16385587Sobrien * Returns 0 on success, negative error code on failure. 16485587Sobrien */ 16585587Sobrien int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size); 16685587Sobrien 16785587Sobrien /** 16885587Sobrien * struct ttm_mem_type_manager member takedown 16985587Sobrien * 17085587Sobrien * @man: Pointer to a memory type manager. 17185587Sobrien * 17285587Sobrien * Called to undo the setup done in init. All allocated resources 17385587Sobrien * should be freed. 17485587Sobrien */ 17590902Sdes int (*takedown)(struct ttm_mem_type_manager *man); 17685587Sobrien 17785587Sobrien /** 17885587Sobrien * struct ttm_mem_type_manager member get_node 17990902Sdes * 18090902Sdes * @man: Pointer to a memory type manager. 18185587Sobrien * @bo: Pointer to the buffer object we're allocating space for. 18285587Sobrien * @placement: Placement details. 18385587Sobrien * @mem: Pointer to a struct ttm_mem_reg to be filled in. 18485587Sobrien * 185107806Sobrien * This function should allocate space in the memory type managed 18685587Sobrien * by @man. Placement details if 18785587Sobrien * applicable are given by @placement. If successful, 18885587Sobrien * @mem::mm_node should be set to a non-null value, and 18985587Sobrien * @mem::start should be set to a value identifying the beginning 19085587Sobrien * of the range allocated, and the function should return zero. 19185587Sobrien * If the memory region accommodate the buffer object, @mem::mm_node 19285587Sobrien * should be set to NULL, and the function should return 0. 19385587Sobrien * If a system error occurred, preventing the request to be fulfilled, 19485587Sobrien * the function should return a negative error code. 19585587Sobrien * 19685587Sobrien * Note that @mem::mm_node will only be dereferenced by 19785587Sobrien * struct ttm_mem_type_manager functions and optionally by the driver, 19885587Sobrien * which has knowledge of the underlying type. 19985587Sobrien * 20085587Sobrien * This function may not be called from within atomic context, so 20185587Sobrien * an implementation can and must use either a mutex or a spinlock to 20285587Sobrien * protect any data structures managing the space. 20385587Sobrien */ 20485587Sobrien int (*get_node)(struct ttm_mem_type_manager *man, 20585587Sobrien struct ttm_buffer_object *bo, 20685587Sobrien struct ttm_placement *placement, 20785587Sobrien struct ttm_mem_reg *mem); 208107806Sobrien 20985587Sobrien /** 21085587Sobrien * struct ttm_mem_type_manager member put_node 21185587Sobrien * 21285587Sobrien * @man: Pointer to a memory type manager. 21385587Sobrien * @mem: Pointer to a struct ttm_mem_reg to be filled in. 21485587Sobrien * 215107806Sobrien * This function frees memory type resources previously allocated 21685587Sobrien * and that are identified by @mem::mm_node and @mem::start. May not 21785587Sobrien * be called from within atomic context. 21885587Sobrien */ 21985587Sobrien void (*put_node)(struct ttm_mem_type_manager *man, 22085587Sobrien struct ttm_mem_reg *mem); 22185587Sobrien 22285587Sobrien /** 22385587Sobrien * struct ttm_mem_type_manager member debug 22485587Sobrien * 22585587Sobrien * @man: Pointer to a memory type manager. 22685587Sobrien * @prefix: Prefix to be used in printout to identify the caller. 22785587Sobrien * 22885587Sobrien * This function is called to print out the state of the memory 22985587Sobrien * type manager to aid debugging of out-of-memory conditions. 23085587Sobrien * It may not be called from within atomic context. 23185587Sobrien */ 23285587Sobrien void (*debug)(struct ttm_mem_type_manager *man, const char *prefix); 23385587Sobrien}; 23485587Sobrien 23585587Sobrien/** 23685587Sobrien * struct ttm_mem_type_manager 23785587Sobrien * 238107806Sobrien * @has_type: The memory type has been initialized. 23985587Sobrien * @use_type: The memory type is enabled. 24085587Sobrien * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory 24185587Sobrien * managed by this memory type. 24285587Sobrien * @gpu_offset: If used, the GPU offset of the first managed page of 24385587Sobrien * fixed memory or the first managed location in an aperture. 24485587Sobrien * @size: Size of the managed region. 24585587Sobrien * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX, 24685587Sobrien * as defined in ttm_placement_common.h 24785587Sobrien * @default_caching: The default caching policy used for a buffer object 24885587Sobrien * placed in this memory type if the user doesn't provide one. 24985587Sobrien * @func: structure pointer implementing the range manager. See above 25085587Sobrien * @priv: Driver private closure for @func. 25185587Sobrien * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures 25285587Sobrien * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions 25385587Sobrien * reserved by the TTM vm system. 25485587Sobrien * @io_reserve_lru: Optional lru list for unreserving io mem regions. 25585587Sobrien * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain 25685587Sobrien * static information. bdev::driver::io_mem_free is never used. 25785587Sobrien * @lru: The lru list for this memory type. 25885587Sobrien * 25985587Sobrien * This structure is used to identify and manage memory types for a device. 26085587Sobrien * It's set up by the ttm_bo_driver::init_mem_type method. 26185587Sobrien */ 26285587Sobrien 26385587Sobrien 26485587Sobrien 26585587Sobrienstruct ttm_mem_type_manager { 26685587Sobrien struct ttm_bo_device *bdev; 26785587Sobrien 26885587Sobrien /* 269107806Sobrien * No protection. Constant from start. 27085587Sobrien */ 27185587Sobrien 27285587Sobrien bool has_type; 27385587Sobrien bool use_type; 27485587Sobrien uint32_t flags; 27585587Sobrien unsigned long gpu_offset; 27685587Sobrien uint64_t size; 27785587Sobrien uint32_t available_caching; 27885587Sobrien uint32_t default_caching; 27985587Sobrien const struct ttm_mem_type_manager_func *func; 28085587Sobrien void *priv; 28185587Sobrien struct sx io_reserve_mutex; 28285587Sobrien bool use_io_reserve_lru; 28385587Sobrien bool io_reserve_fastpath; 28485587Sobrien 28585587Sobrien /* 28685587Sobrien * Protected by @io_reserve_mutex: 28785587Sobrien */ 28885587Sobrien 28985587Sobrien struct list_head io_reserve_lru; 29085587Sobrien 29185587Sobrien /* 29285587Sobrien * Protected by the global->lru_lock. 29385587Sobrien */ 29485587Sobrien 29585587Sobrien struct list_head lru; 29685587Sobrien}; 29785587Sobrien 29885587Sobrien/** 29985587Sobrien * struct ttm_bo_driver 30085587Sobrien * 301107806Sobrien * @create_ttm_backend_entry: Callback to create a struct ttm_backend. 30285587Sobrien * @invalidate_caches: Callback to invalidate read caches when a buffer object 30385587Sobrien * has been evicted. 30485587Sobrien * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager 305107806Sobrien * structure. 30685587Sobrien * @evict_flags: Callback to obtain placement flags when a buffer is evicted. 30785587Sobrien * @move: Callback for a driver to hook in accelerated functions to 30885587Sobrien * move a buffer. 30985587Sobrien * If set to NULL, a potentially slow memcpy() move is used. 31085587Sobrien * @sync_obj_signaled: See ttm_fence_api.h 31185587Sobrien * @sync_obj_wait: See ttm_fence_api.h 31285587Sobrien * @sync_obj_flush: See ttm_fence_api.h 31385587Sobrien * @sync_obj_unref: See ttm_fence_api.h 31485587Sobrien * @sync_obj_ref: See ttm_fence_api.h 315107806Sobrien */ 31685587Sobrien 31785587Sobrienstruct ttm_bo_driver { 31885587Sobrien /** 31985587Sobrien * ttm_tt_create 320146299Sru * 321146299Sru * @bdev: pointer to a struct ttm_bo_device: 32285587Sobrien * @size: Size of the data needed backing. 32385587Sobrien * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 32485587Sobrien * @dummy_read_page: See struct ttm_bo_device. 32585587Sobrien * 32685587Sobrien * Create a struct ttm_tt to back data with system memory pages. 32785587Sobrien * No pages are actually allocated. 32885587Sobrien * Returns: 32985587Sobrien * NULL: Out of memory. 33085587Sobrien */ 33185587Sobrien struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev, 33285587Sobrien unsigned long size, 33385587Sobrien uint32_t page_flags, 33485587Sobrien struct vm_page *dummy_read_page); 335172958Sobrien 336172958Sobrien /** 33785587Sobrien * ttm_tt_populate 33885587Sobrien * 33985587Sobrien * @ttm: The struct ttm_tt to contain the backing pages. 340146299Sru * 341146299Sru * Allocate all backing pages 34285587Sobrien * Returns: 34385587Sobrien * -ENOMEM: Out of memory. 34485587Sobrien */ 34585587Sobrien int (*ttm_tt_populate)(struct ttm_tt *ttm); 34685587Sobrien 34785587Sobrien /** 34885587Sobrien * ttm_tt_unpopulate 34985587Sobrien * 35085587Sobrien * @ttm: The struct ttm_tt to contain the backing pages. 35185587Sobrien * 35285587Sobrien * Free all backing page 35385587Sobrien */ 35485587Sobrien void (*ttm_tt_unpopulate)(struct ttm_tt *ttm); 35585587Sobrien 35685587Sobrien /** 35785587Sobrien * struct ttm_bo_driver member invalidate_caches 358107806Sobrien * 35985587Sobrien * @bdev: the buffer object device. 36085587Sobrien * @flags: new placement of the rebound buffer object. 36185587Sobrien * 362146299Sru * A previosly evicted buffer has been rebound in a 36385587Sobrien * potentially new location. Tell the driver that it might 36485587Sobrien * consider invalidating read (texture) caches on the next command 36585587Sobrien * submission as a consequence. 36685587Sobrien */ 36785587Sobrien 36885587Sobrien int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags); 36985587Sobrien int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type, 37085587Sobrien struct ttm_mem_type_manager *man); 37185587Sobrien /** 37285587Sobrien * struct ttm_bo_driver member evict_flags: 37385587Sobrien * 37485587Sobrien * @bo: the buffer object to be evicted 37585587Sobrien * 37685587Sobrien * Return the bo flags for a buffer which is not mapped to the hardware. 37785587Sobrien * These will be placed in proposed_flags so that when the move is 37885587Sobrien * finished, they'll end up in bo->mem.flags 379107806Sobrien */ 38085587Sobrien 38185587Sobrien void(*evict_flags) (struct ttm_buffer_object *bo, 38285587Sobrien struct ttm_placement *placement); 38385587Sobrien /** 384107806Sobrien * struct ttm_bo_driver member move: 38585587Sobrien * 38685587Sobrien * @bo: the buffer to move 38785587Sobrien * @evict: whether this motion is evicting the buffer from 388107806Sobrien * the graphics address space 38985587Sobrien * @interruptible: Use interruptible sleeps if possible when sleeping. 390107806Sobrien * @no_wait: whether this should give up and return -EBUSY 391107806Sobrien * if this move would require sleeping 392107806Sobrien * @new_mem: the new memory region receiving the buffer 393107806Sobrien * 394107806Sobrien * Move a buffer between two memory regions. 395107806Sobrien */ 396107806Sobrien int (*move) (struct ttm_buffer_object *bo, 397107806Sobrien bool evict, bool interruptible, 398107806Sobrien bool no_wait_gpu, 399107806Sobrien struct ttm_mem_reg *new_mem); 400107806Sobrien 40185587Sobrien /** 40285587Sobrien * struct ttm_bo_driver_member verify_access 40385587Sobrien * 40485587Sobrien * @bo: Pointer to a buffer object. 40585587Sobrien * @filp: Pointer to a struct file trying to access the object. 40685587Sobrien * FreeBSD: use devfs_get_cdevpriv etc. 40785587Sobrien * 40885587Sobrien * Called from the map / write / read methods to verify that the 40985587Sobrien * caller is permitted to access the buffer object. 410107806Sobrien * This member may be set to NULL, which will refuse this kind of 41185587Sobrien * access for all buffer objects. 412107806Sobrien * This function should return 0 if access is granted, -EPERM otherwise. 41385587Sobrien */ 41485587Sobrien int (*verify_access) (struct ttm_buffer_object *bo); 41585587Sobrien 41685587Sobrien /** 41790902Sdes * In case a driver writer dislikes the TTM fence objects, 41885587Sobrien * the driver writer can replace those with sync objects of 41985587Sobrien * his / her own. If it turns out that no driver writer is 42085587Sobrien * using these. I suggest we remove these hooks and plug in 42185587Sobrien * fences directly. The bo driver needs the following functionality: 42285587Sobrien * See the corresponding functions in the fence object API 42385587Sobrien * documentation. 42485587Sobrien */ 42585587Sobrien 42685587Sobrien bool (*sync_obj_signaled) (void *sync_obj); 42785587Sobrien int (*sync_obj_wait) (void *sync_obj, 42885587Sobrien bool lazy, bool interruptible); 42985587Sobrien int (*sync_obj_flush) (void *sync_obj); 43085587Sobrien void (*sync_obj_unref) (void **sync_obj); 43185587Sobrien void *(*sync_obj_ref) (void *sync_obj); 43285587Sobrien 43385587Sobrien /* hook to notify driver about a driver move so it 43485587Sobrien * can do tiling things */ 43585587Sobrien void (*move_notify)(struct ttm_buffer_object *bo, 43685587Sobrien struct ttm_mem_reg *new_mem); 43785587Sobrien /* notify the driver we are taking a fault on this BO 43885587Sobrien * and have reserved it */ 43985587Sobrien int (*fault_reserve_notify)(struct ttm_buffer_object *bo); 44085587Sobrien 44185587Sobrien /** 44285587Sobrien * notify the driver that we're about to swap out this bo 44385587Sobrien */ 44485587Sobrien void (*swap_notify) (struct ttm_buffer_object *bo); 44585587Sobrien 44685587Sobrien /** 44785587Sobrien * Driver callback on when mapping io memory (for bo_move_memcpy 44885587Sobrien * for instance). TTM will take care to call io_mem_free whenever 44985587Sobrien * the mapping is not use anymore. io_mem_reserve & io_mem_free 45085587Sobrien * are balanced. 45185587Sobrien */ 45285587Sobrien int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem); 45385587Sobrien void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem); 45485587Sobrien}; 45585587Sobrien 456/** 457 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global. 458 */ 459 460struct ttm_bo_global_ref { 461 struct drm_global_reference ref; 462 struct ttm_mem_global *mem_glob; 463}; 464 465/** 466 * struct ttm_bo_global - Buffer object driver global data. 467 * 468 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting. 469 * @dummy_read_page: Pointer to a dummy page used for mapping requests 470 * of unpopulated pages. 471 * @shrink: A shrink callback object used for buffer object swap. 472 * @device_list_mutex: Mutex protecting the device list. 473 * This mutex is held while traversing the device list for pm options. 474 * @lru_lock: Spinlock protecting the bo subsystem lru lists. 475 * @device_list: List of buffer object devices. 476 * @swap_lru: Lru list of buffer objects used for swapping. 477 */ 478 479struct ttm_bo_global { 480 u_int kobj_ref; 481 482 /** 483 * Constant after init. 484 */ 485 486 struct ttm_mem_global *mem_glob; 487 struct vm_page *dummy_read_page; 488 struct ttm_mem_shrink shrink; 489 struct sx device_list_mutex; 490 struct mtx lru_lock; 491 492 /** 493 * Protected by device_list_mutex. 494 */ 495 struct list_head device_list; 496 497 /** 498 * Protected by the lru_lock. 499 */ 500 struct list_head swap_lru; 501 502 /** 503 * Internal protection. 504 */ 505 atomic_t bo_count; 506}; 507 508 509#define TTM_NUM_MEM_TYPES 8 510 511#define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs 512 idling before CPU mapping */ 513#define TTM_BO_PRIV_FLAG_MAX 1 514/** 515 * struct ttm_bo_device - Buffer object driver device-specific data. 516 * 517 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver. 518 * @man: An array of mem_type_managers. 519 * @fence_lock: Protects the synchronizing members on *all* bos belonging 520 * to this device. 521 * @addr_space_mm: Range manager for the device address space. 522 * lru_lock: Spinlock that protects the buffer+device lru lists and 523 * ddestroy lists. 524 * @val_seq: Current validation sequence. 525 * @dev_mapping: A pointer to the struct address_space representing the 526 * device address space. 527 * @wq: Work queue structure for the delayed delete workqueue. 528 * 529 */ 530 531struct ttm_bo_device { 532 533 /* 534 * Constant after bo device init / atomic. 535 */ 536 struct list_head device_list; 537 struct ttm_bo_global *glob; 538 struct ttm_bo_driver *driver; 539 struct rwlock vm_lock; 540 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES]; 541 struct mtx fence_lock; 542 /* 543 * Protected by the vm lock. 544 */ 545 RB_HEAD(ttm_bo_device_buffer_objects, ttm_buffer_object) addr_space_rb; 546 struct drm_mm addr_space_mm; 547 548 /* 549 * Protected by the global:lru lock. 550 */ 551 struct list_head ddestroy; 552 uint32_t val_seq; 553 554 /* 555 * Protected by load / firstopen / lastclose /unload sync. 556 */ 557 558 struct address_space *dev_mapping; 559 560 /* 561 * Internal protection. 562 */ 563 564 struct timeout_task wq; 565 566 bool need_dma32; 567}; 568 569/** 570 * ttm_flag_masked 571 * 572 * @old: Pointer to the result and original value. 573 * @new: New value of bits. 574 * @mask: Mask of bits to change. 575 * 576 * Convenience function to change a number of bits identified by a mask. 577 */ 578 579static inline uint32_t 580ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask) 581{ 582 *old ^= (*old ^ new) & mask; 583 return *old; 584} 585 586/** 587 * ttm_tt_init 588 * 589 * @ttm: The struct ttm_tt. 590 * @bdev: pointer to a struct ttm_bo_device: 591 * @size: Size of the data needed backing. 592 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 593 * @dummy_read_page: See struct ttm_bo_device. 594 * 595 * Create a struct ttm_tt to back data with system memory pages. 596 * No pages are actually allocated. 597 * Returns: 598 * NULL: Out of memory. 599 */ 600extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev, 601 unsigned long size, uint32_t page_flags, 602 struct vm_page *dummy_read_page); 603extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev, 604 unsigned long size, uint32_t page_flags, 605 struct vm_page *dummy_read_page); 606 607/** 608 * ttm_tt_fini 609 * 610 * @ttm: the ttm_tt structure. 611 * 612 * Free memory of ttm_tt structure 613 */ 614extern void ttm_tt_fini(struct ttm_tt *ttm); 615extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma); 616 617/** 618 * ttm_ttm_bind: 619 * 620 * @ttm: The struct ttm_tt containing backing pages. 621 * @bo_mem: The struct ttm_mem_reg identifying the binding location. 622 * 623 * Bind the pages of @ttm to an aperture location identified by @bo_mem 624 */ 625extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); 626 627/** 628 * ttm_ttm_destroy: 629 * 630 * @ttm: The struct ttm_tt. 631 * 632 * Unbind, unpopulate and destroy common struct ttm_tt. 633 */ 634extern void ttm_tt_destroy(struct ttm_tt *ttm); 635 636/** 637 * ttm_ttm_unbind: 638 * 639 * @ttm: The struct ttm_tt. 640 * 641 * Unbind a struct ttm_tt. 642 */ 643extern void ttm_tt_unbind(struct ttm_tt *ttm); 644 645/** 646 * ttm_tt_swapin: 647 * 648 * @ttm: The struct ttm_tt. 649 * 650 * Swap in a previously swap out ttm_tt. 651 */ 652extern int ttm_tt_swapin(struct ttm_tt *ttm); 653 654/** 655 * ttm_tt_cache_flush: 656 * 657 * @pages: An array of pointers to struct page:s to flush. 658 * @num_pages: Number of pages to flush. 659 * 660 * Flush the data of the indicated pages from the cpu caches. 661 * This is used when changing caching attributes of the pages from 662 * cache-coherent. 663 */ 664extern void ttm_tt_cache_flush(struct vm_page *pages[], unsigned long num_pages); 665 666/** 667 * ttm_tt_set_placement_caching: 668 * 669 * @ttm A struct ttm_tt the backing pages of which will change caching policy. 670 * @placement: Flag indicating the desired caching policy. 671 * 672 * This function will change caching policy of any default kernel mappings of 673 * the pages backing @ttm. If changing from cached to uncached or 674 * write-combined, 675 * all CPU caches will first be flushed to make sure the data of the pages 676 * hit RAM. This function may be very costly as it involves global TLB 677 * and cache flushes and potential page splitting / combining. 678 */ 679extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement); 680extern int ttm_tt_swapout(struct ttm_tt *ttm, 681 struct vm_object *persistent_swap_storage); 682 683/* 684 * ttm_bo.c 685 */ 686 687/** 688 * ttm_mem_reg_is_pci 689 * 690 * @bdev: Pointer to a struct ttm_bo_device. 691 * @mem: A valid struct ttm_mem_reg. 692 * 693 * Returns true if the memory described by @mem is PCI memory, 694 * false otherwise. 695 */ 696extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, 697 struct ttm_mem_reg *mem); 698 699/** 700 * ttm_bo_mem_space 701 * 702 * @bo: Pointer to a struct ttm_buffer_object. the data of which 703 * we want to allocate space for. 704 * @proposed_placement: Proposed new placement for the buffer object. 705 * @mem: A struct ttm_mem_reg. 706 * @interruptible: Sleep interruptible when sliping. 707 * @no_wait_gpu: Return immediately if the GPU is busy. 708 * 709 * Allocate memory space for the buffer object pointed to by @bo, using 710 * the placement flags in @mem, potentially evicting other idle buffer objects. 711 * This function may sleep while waiting for space to become available. 712 * Returns: 713 * -EBUSY: No space available (only if no_wait == 1). 714 * -ENOMEM: Could not allocate memory for the buffer object, either due to 715 * fragmentation or concurrent allocators. 716 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. 717 */ 718extern int ttm_bo_mem_space(struct ttm_buffer_object *bo, 719 struct ttm_placement *placement, 720 struct ttm_mem_reg *mem, 721 bool interruptible, 722 bool no_wait_gpu); 723 724extern void ttm_bo_mem_put(struct ttm_buffer_object *bo, 725 struct ttm_mem_reg *mem); 726extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo, 727 struct ttm_mem_reg *mem); 728 729extern void ttm_bo_global_release(struct drm_global_reference *ref); 730extern int ttm_bo_global_init(struct drm_global_reference *ref); 731 732extern int ttm_bo_device_release(struct ttm_bo_device *bdev); 733 734/** 735 * ttm_bo_device_init 736 * 737 * @bdev: A pointer to a struct ttm_bo_device to initialize. 738 * @glob: A pointer to an initialized struct ttm_bo_global. 739 * @driver: A pointer to a struct ttm_bo_driver set up by the caller. 740 * @file_page_offset: Offset into the device address space that is available 741 * for buffer data. This ensures compatibility with other users of the 742 * address space. 743 * 744 * Initializes a struct ttm_bo_device: 745 * Returns: 746 * !0: Failure. 747 */ 748extern int ttm_bo_device_init(struct ttm_bo_device *bdev, 749 struct ttm_bo_global *glob, 750 struct ttm_bo_driver *driver, 751 uint64_t file_page_offset, bool need_dma32); 752 753/** 754 * ttm_bo_unmap_virtual 755 * 756 * @bo: tear down the virtual mappings for this BO 757 */ 758extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo); 759 760/** 761 * ttm_bo_unmap_virtual 762 * 763 * @bo: tear down the virtual mappings for this BO 764 * 765 * The caller must take ttm_mem_io_lock before calling this function. 766 */ 767extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo); 768 769extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo); 770extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo); 771extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man, 772 bool interruptible); 773extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man); 774 775 776/** 777 * ttm_bo_reserve: 778 * 779 * @bo: A pointer to a struct ttm_buffer_object. 780 * @interruptible: Sleep interruptible if waiting. 781 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. 782 * @use_sequence: If @bo is already reserved, Only sleep waiting for 783 * it to become unreserved if @sequence < (@bo)->sequence. 784 * 785 * Locks a buffer object for validation. (Or prevents other processes from 786 * locking it for validation) and removes it from lru lists, while taking 787 * a number of measures to prevent deadlocks. 788 * 789 * Deadlocks may occur when two processes try to reserve multiple buffers in 790 * different order, either by will or as a result of a buffer being evicted 791 * to make room for a buffer already reserved. (Buffers are reserved before 792 * they are evicted). The following algorithm prevents such deadlocks from 793 * occurring: 794 * Processes attempting to reserve multiple buffers other than for eviction, 795 * (typically execbuf), should first obtain a unique 32-bit 796 * validation sequence number, 797 * and call this function with @use_sequence == 1 and @sequence == the unique 798 * sequence number. If upon call of this function, the buffer object is already 799 * reserved, the validation sequence is checked against the validation 800 * sequence of the process currently reserving the buffer, 801 * and if the current validation sequence is greater than that of the process 802 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps 803 * waiting for the buffer to become unreserved, after which it retries 804 * reserving. 805 * The caller should, when receiving an -EAGAIN error 806 * release all its buffer reservations, wait for @bo to become unreserved, and 807 * then rerun the validation with the same validation sequence. This procedure 808 * will always guarantee that the process with the lowest validation sequence 809 * will eventually succeed, preventing both deadlocks and starvation. 810 * 811 * Returns: 812 * -EAGAIN: The reservation may cause a deadlock. 813 * Release all buffer reservations, wait for @bo to become unreserved and 814 * try again. (only if use_sequence == 1). 815 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 816 * a signal. Release all buffer reservations and return to user-space. 817 * -EBUSY: The function needed to sleep, but @no_wait was true 818 * -EDEADLK: Bo already reserved using @sequence. This error code will only 819 * be returned if @use_sequence is set to true. 820 */ 821extern int ttm_bo_reserve(struct ttm_buffer_object *bo, 822 bool interruptible, 823 bool no_wait, bool use_sequence, uint32_t sequence); 824 825/** 826 * ttm_bo_reserve_slowpath_nolru: 827 * @bo: A pointer to a struct ttm_buffer_object. 828 * @interruptible: Sleep interruptible if waiting. 829 * @sequence: Set (@bo)->sequence to this value after lock 830 * 831 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off 832 * from all our other reservations. Because there are no other reservations 833 * held by us, this function cannot deadlock any more. 834 * 835 * Will not remove reserved buffers from the lru lists. 836 * Otherwise identical to ttm_bo_reserve_slowpath. 837 */ 838extern int ttm_bo_reserve_slowpath_nolru(struct ttm_buffer_object *bo, 839 bool interruptible, 840 uint32_t sequence); 841 842 843/** 844 * ttm_bo_reserve_slowpath: 845 * @bo: A pointer to a struct ttm_buffer_object. 846 * @interruptible: Sleep interruptible if waiting. 847 * @sequence: Set (@bo)->sequence to this value after lock 848 * 849 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off 850 * from all our other reservations. Because there are no other reservations 851 * held by us, this function cannot deadlock any more. 852 */ 853extern int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo, 854 bool interruptible, uint32_t sequence); 855 856/** 857 * ttm_bo_reserve_nolru: 858 * 859 * @bo: A pointer to a struct ttm_buffer_object. 860 * @interruptible: Sleep interruptible if waiting. 861 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. 862 * @use_sequence: If @bo is already reserved, Only sleep waiting for 863 * it to become unreserved if @sequence < (@bo)->sequence. 864 * 865 * Will not remove reserved buffers from the lru lists. 866 * Otherwise identical to ttm_bo_reserve. 867 * 868 * Returns: 869 * -EAGAIN: The reservation may cause a deadlock. 870 * Release all buffer reservations, wait for @bo to become unreserved and 871 * try again. (only if use_sequence == 1). 872 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 873 * a signal. Release all buffer reservations and return to user-space. 874 * -EBUSY: The function needed to sleep, but @no_wait was true 875 * -EDEADLK: Bo already reserved using @sequence. This error code will only 876 * be returned if @use_sequence is set to true. 877 */ 878extern int ttm_bo_reserve_nolru(struct ttm_buffer_object *bo, 879 bool interruptible, 880 bool no_wait, bool use_sequence, 881 uint32_t sequence); 882 883/** 884 * ttm_bo_unreserve 885 * 886 * @bo: A pointer to a struct ttm_buffer_object. 887 * 888 * Unreserve a previous reservation of @bo. 889 */ 890extern void ttm_bo_unreserve(struct ttm_buffer_object *bo); 891 892/** 893 * ttm_bo_unreserve_locked 894 * 895 * @bo: A pointer to a struct ttm_buffer_object. 896 * 897 * Unreserve a previous reservation of @bo. 898 * Needs to be called with struct ttm_bo_global::lru_lock held. 899 */ 900extern void ttm_bo_unreserve_locked(struct ttm_buffer_object *bo); 901 902/** 903 * ttm_bo_wait_unreserved 904 * 905 * @bo: A pointer to a struct ttm_buffer_object. 906 * 907 * Wait for a struct ttm_buffer_object to become unreserved. 908 * This is typically used in the execbuf code to relax cpu-usage when 909 * a potential deadlock condition backoff. 910 */ 911extern int ttm_bo_wait_unreserved_locked(struct ttm_buffer_object *bo, 912 bool interruptible); 913 914/* 915 * ttm_bo_util.c 916 */ 917 918/** 919 * ttm_bo_move_ttm 920 * 921 * @bo: A pointer to a struct ttm_buffer_object. 922 * @evict: 1: This is an eviction. Don't try to pipeline. 923 * @no_wait_gpu: Return immediately if the GPU is busy. 924 * @new_mem: struct ttm_mem_reg indicating where to move. 925 * 926 * Optimized move function for a buffer object with both old and 927 * new placement backed by a TTM. The function will, if successful, 928 * free any old aperture space, and set (@new_mem)->mm_node to NULL, 929 * and update the (@bo)->mem placement flags. If unsuccessful, the old 930 * data remains untouched, and it's up to the caller to free the 931 * memory space indicated by @new_mem. 932 * Returns: 933 * !0: Failure. 934 */ 935 936extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo, 937 bool evict, bool no_wait_gpu, 938 struct ttm_mem_reg *new_mem); 939 940/** 941 * ttm_bo_move_memcpy 942 * 943 * @bo: A pointer to a struct ttm_buffer_object. 944 * @evict: 1: This is an eviction. Don't try to pipeline. 945 * @no_wait_gpu: Return immediately if the GPU is busy. 946 * @new_mem: struct ttm_mem_reg indicating where to move. 947 * 948 * Fallback move function for a mappable buffer object in mappable memory. 949 * The function will, if successful, 950 * free any old aperture space, and set (@new_mem)->mm_node to NULL, 951 * and update the (@bo)->mem placement flags. If unsuccessful, the old 952 * data remains untouched, and it's up to the caller to free the 953 * memory space indicated by @new_mem. 954 * Returns: 955 * !0: Failure. 956 */ 957 958extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo, 959 bool evict, bool no_wait_gpu, 960 struct ttm_mem_reg *new_mem); 961 962/** 963 * ttm_bo_free_old_node 964 * 965 * @bo: A pointer to a struct ttm_buffer_object. 966 * 967 * Utility function to free an old placement after a successful move. 968 */ 969extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo); 970 971/** 972 * ttm_bo_move_accel_cleanup. 973 * 974 * @bo: A pointer to a struct ttm_buffer_object. 975 * @sync_obj: A sync object that signals when moving is complete. 976 * @evict: This is an evict move. Don't return until the buffer is idle. 977 * @no_wait_gpu: Return immediately if the GPU is busy. 978 * @new_mem: struct ttm_mem_reg indicating where to move. 979 * 980 * Accelerated move function to be called when an accelerated move 981 * has been scheduled. The function will create a new temporary buffer object 982 * representing the old placement, and put the sync object on both buffer 983 * objects. After that the newly created buffer object is unref'd to be 984 * destroyed when the move is complete. This will help pipeline 985 * buffer moves. 986 */ 987 988extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo, 989 void *sync_obj, 990 bool evict, bool no_wait_gpu, 991 struct ttm_mem_reg *new_mem); 992/** 993 * ttm_io_prot 994 * 995 * @c_state: Caching state. 996 * @tmp: Page protection flag for a normal, cached mapping. 997 * 998 * Utility function that returns the pgprot_t that should be used for 999 * setting up a PTE with the caching model indicated by @c_state. 1000 */ 1001extern vm_memattr_t ttm_io_prot(uint32_t caching_flags); 1002 1003extern const struct ttm_mem_type_manager_func ttm_bo_manager_func; 1004 1005#if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE))) 1006#define TTM_HAS_AGP 1007#include <linux/agp_backend.h> 1008 1009/** 1010 * ttm_agp_tt_create 1011 * 1012 * @bdev: Pointer to a struct ttm_bo_device. 1013 * @bridge: The agp bridge this device is sitting on. 1014 * @size: Size of the data needed backing. 1015 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 1016 * @dummy_read_page: See struct ttm_bo_device. 1017 * 1018 * 1019 * Create a TTM backend that uses the indicated AGP bridge as an aperture 1020 * for TT memory. This function uses the linux agpgart interface to 1021 * bind and unbind memory backing a ttm_tt. 1022 */ 1023extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev, 1024 struct agp_bridge_data *bridge, 1025 unsigned long size, uint32_t page_flags, 1026 struct vm_page *dummy_read_page); 1027int ttm_agp_tt_populate(struct ttm_tt *ttm); 1028void ttm_agp_tt_unpopulate(struct ttm_tt *ttm); 1029#endif 1030 1031int ttm_bo_cmp_rb_tree_items(struct ttm_buffer_object *a, 1032 struct ttm_buffer_object *b); 1033 1034RB_PROTOTYPE(ttm_bo_device_buffer_objects, ttm_buffer_object, vm_rb, 1035 ttm_bo_cmp_rb_tree_items); 1036 1037#endif 1038