Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1 | /************************************************************************** |
| 2 | * |
| 3 | * Copyright (c) 2006-2009 Vmware, Inc., Palo Alto, CA., USA |
| 4 | * All Rights Reserved. |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a |
| 7 | * copy of this software and associated documentation files (the |
| 8 | * "Software"), to deal in the Software without restriction, including |
| 9 | * without limitation the rights to use, copy, modify, merge, publish, |
| 10 | * distribute, sub license, and/or sell copies of the Software, and to |
| 11 | * permit persons to whom the Software is furnished to do so, subject to |
| 12 | * the following conditions: |
| 13 | * |
| 14 | * The above copyright notice and this permission notice (including the |
| 15 | * next paragraph) shall be included in all copies or substantial portions |
| 16 | * of the Software. |
| 17 | * |
| 18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 20 | * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL |
| 21 | * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, |
| 22 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR |
| 23 | * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE |
| 24 | * USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 25 | * |
| 26 | **************************************************************************/ |
| 27 | /* |
| 28 | * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com> |
| 29 | */ |
| 30 | #ifndef _TTM_BO_DRIVER_H_ |
| 31 | #define _TTM_BO_DRIVER_H_ |
| 32 | |
David Howells | a1ce392 | 2012-10-02 18:01:25 +0100 | [diff] [blame] | 33 | #include <ttm/ttm_bo_api.h> |
| 34 | #include <ttm/ttm_memory.h> |
| 35 | #include <ttm/ttm_module.h> |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 36 | #include <ttm/ttm_placement.h> |
David Howells | a1ce392 | 2012-10-02 18:01:25 +0100 | [diff] [blame] | 37 | #include <drm/drm_mm.h> |
| 38 | #include <drm/drm_global.h> |
David Herrmann | 72525b3 | 2013-07-24 21:08:53 +0200 | [diff] [blame] | 39 | #include <drm/drm_vma_manager.h> |
David Howells | a1ce392 | 2012-10-02 18:01:25 +0100 | [diff] [blame] | 40 | #include <linux/workqueue.h> |
| 41 | #include <linux/fs.h> |
| 42 | #include <linux/spinlock.h> |
Maarten Lankhorst | ecff665 | 2013-06-27 13:48:17 +0200 | [diff] [blame] | 43 | #include <linux/reservation.h> |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 44 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 45 | struct ttm_backend_func { |
| 46 | /** |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 47 | * struct ttm_backend_func member bind |
| 48 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 49 | * @ttm: Pointer to a struct ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 50 | * @bo_mem: Pointer to a struct ttm_mem_reg describing the |
| 51 | * memory type and location for binding. |
| 52 | * |
| 53 | * Bind the backend pages into the aperture in the location |
| 54 | * indicated by @bo_mem. This function should be able to handle |
Konrad Rzeszutek Wilk | 0d74f86 | 2011-06-08 17:06:15 +0000 | [diff] [blame] | 55 | * differences between aperture and system page sizes. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 56 | */ |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 57 | int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * struct ttm_backend_func member unbind |
| 61 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 62 | * @ttm: Pointer to a struct ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 63 | * |
| 64 | * Unbind previously bound backend pages. This function should be |
Konrad Rzeszutek Wilk | 0d74f86 | 2011-06-08 17:06:15 +0000 | [diff] [blame] | 65 | * able to handle differences between aperture and system page sizes. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 66 | */ |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 67 | int (*unbind) (struct ttm_tt *ttm); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 68 | |
| 69 | /** |
| 70 | * struct ttm_backend_func member destroy |
| 71 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 72 | * @ttm: Pointer to a struct ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 73 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 74 | * Destroy the backend. This will be call back from ttm_tt_destroy so |
| 75 | * don't call ttm_tt_destroy from the callback or infinite loop. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 76 | */ |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 77 | void (*destroy) (struct ttm_tt *ttm); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 78 | }; |
| 79 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 80 | #define TTM_PAGE_FLAG_WRITE (1 << 3) |
| 81 | #define TTM_PAGE_FLAG_SWAPPED (1 << 4) |
Jan Engelhardt | 5df2397 | 2011-04-04 01:25:18 +0200 | [diff] [blame] | 82 | #define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5) |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 83 | #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6) |
Dave Airlie | ad49f50 | 2009-07-10 22:36:26 +1000 | [diff] [blame] | 84 | #define TTM_PAGE_FLAG_DMA32 (1 << 7) |
Dave Airlie | 129b78b | 2012-04-02 11:46:06 +0100 | [diff] [blame] | 85 | #define TTM_PAGE_FLAG_SG (1 << 8) |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 86 | |
| 87 | enum ttm_caching_state { |
| 88 | tt_uncached, |
| 89 | tt_wc, |
| 90 | tt_cached |
| 91 | }; |
| 92 | |
| 93 | /** |
| 94 | * struct ttm_tt |
| 95 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 96 | * @bdev: Pointer to a struct ttm_bo_device. |
| 97 | * @func: Pointer to a struct ttm_backend_func that describes |
| 98 | * the backend methods. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 99 | * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL |
| 100 | * pointer. |
| 101 | * @pages: Array of pages backing the data. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 102 | * @num_pages: Number of pages in the page array. |
| 103 | * @bdev: Pointer to the current struct ttm_bo_device. |
| 104 | * @be: Pointer to the ttm backend. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 105 | * @swap_storage: Pointer to shmem struct file for swap storage. |
| 106 | * @caching_state: The current caching state of the pages. |
| 107 | * @state: The current binding state of the pages. |
| 108 | * |
| 109 | * This is a structure holding the pages, caching- and aperture binding |
| 110 | * status for a buffer object that isn't backed by fixed (VRAM / AGP) |
| 111 | * memory. |
| 112 | */ |
| 113 | |
| 114 | struct ttm_tt { |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 115 | struct ttm_bo_device *bdev; |
| 116 | struct ttm_backend_func *func; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 117 | struct page *dummy_read_page; |
| 118 | struct page **pages; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 119 | uint32_t page_flags; |
| 120 | unsigned long num_pages; |
Dave Airlie | 129b78b | 2012-04-02 11:46:06 +0100 | [diff] [blame] | 121 | struct sg_table *sg; /* for SG objects via dma-buf */ |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 122 | struct ttm_bo_global *glob; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 123 | struct file *swap_storage; |
| 124 | enum ttm_caching_state caching_state; |
| 125 | enum { |
| 126 | tt_bound, |
| 127 | tt_unbound, |
| 128 | tt_unpopulated, |
| 129 | } state; |
Jerome Glisse | 8e7e705 | 2011-11-09 17:15:26 -0500 | [diff] [blame] | 130 | }; |
| 131 | |
| 132 | /** |
| 133 | * struct ttm_dma_tt |
| 134 | * |
| 135 | * @ttm: Base ttm_tt struct. |
| 136 | * @dma_address: The DMA (bus) addresses of the pages |
| 137 | * @pages_list: used by some page allocation backend |
| 138 | * |
| 139 | * This is a structure holding the pages, caching- and aperture binding |
| 140 | * status for a buffer object that isn't backed by fixed (VRAM / AGP) |
| 141 | * memory. |
| 142 | */ |
| 143 | struct ttm_dma_tt { |
| 144 | struct ttm_tt ttm; |
Konrad Rzeszutek Wilk | f9820a4 | 2010-11-29 13:52:18 -0500 | [diff] [blame] | 145 | dma_addr_t *dma_address; |
Jerome Glisse | 8e7e705 | 2011-11-09 17:15:26 -0500 | [diff] [blame] | 146 | struct list_head pages_list; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 147 | }; |
| 148 | |
| 149 | #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */ |
| 150 | #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */ |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 151 | #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */ |
| 152 | |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 153 | struct ttm_mem_type_manager; |
| 154 | |
| 155 | struct ttm_mem_type_manager_func { |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 156 | /** |
| 157 | * struct ttm_mem_type_manager member init |
| 158 | * |
| 159 | * @man: Pointer to a memory type manager. |
| 160 | * @p_size: Implementation dependent, but typically the size of the |
| 161 | * range to be managed in pages. |
| 162 | * |
| 163 | * Called to initialize a private range manager. The function is |
| 164 | * expected to initialize the man::priv member. |
| 165 | * Returns 0 on success, negative error code on failure. |
| 166 | */ |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 167 | int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size); |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 168 | |
| 169 | /** |
| 170 | * struct ttm_mem_type_manager member takedown |
| 171 | * |
| 172 | * @man: Pointer to a memory type manager. |
| 173 | * |
| 174 | * Called to undo the setup done in init. All allocated resources |
| 175 | * should be freed. |
| 176 | */ |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 177 | int (*takedown)(struct ttm_mem_type_manager *man); |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 178 | |
| 179 | /** |
| 180 | * struct ttm_mem_type_manager member get_node |
| 181 | * |
| 182 | * @man: Pointer to a memory type manager. |
| 183 | * @bo: Pointer to the buffer object we're allocating space for. |
| 184 | * @placement: Placement details. |
Christian König | e3f2027 | 2014-07-03 09:02:23 +0200 | [diff] [blame] | 185 | * @flags: Additional placement flags. |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 186 | * @mem: Pointer to a struct ttm_mem_reg to be filled in. |
| 187 | * |
| 188 | * This function should allocate space in the memory type managed |
| 189 | * by @man. Placement details if |
| 190 | * applicable are given by @placement. If successful, |
| 191 | * @mem::mm_node should be set to a non-null value, and |
| 192 | * @mem::start should be set to a value identifying the beginning |
| 193 | * of the range allocated, and the function should return zero. |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 194 | * If the memory region accommodate the buffer object, @mem::mm_node |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 195 | * should be set to NULL, and the function should return 0. |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 196 | * If a system error occurred, preventing the request to be fulfilled, |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 197 | * the function should return a negative error code. |
| 198 | * |
| 199 | * Note that @mem::mm_node will only be dereferenced by |
| 200 | * struct ttm_mem_type_manager functions and optionally by the driver, |
| 201 | * which has knowledge of the underlying type. |
| 202 | * |
| 203 | * This function may not be called from within atomic context, so |
| 204 | * an implementation can and must use either a mutex or a spinlock to |
| 205 | * protect any data structures managing the space. |
| 206 | */ |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 207 | int (*get_node)(struct ttm_mem_type_manager *man, |
| 208 | struct ttm_buffer_object *bo, |
Christian König | f1217ed | 2014-08-27 13:16:04 +0200 | [diff] [blame] | 209 | const struct ttm_place *place, |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 210 | struct ttm_mem_reg *mem); |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 211 | |
| 212 | /** |
| 213 | * struct ttm_mem_type_manager member put_node |
| 214 | * |
| 215 | * @man: Pointer to a memory type manager. |
| 216 | * @mem: Pointer to a struct ttm_mem_reg to be filled in. |
| 217 | * |
| 218 | * This function frees memory type resources previously allocated |
| 219 | * and that are identified by @mem::mm_node and @mem::start. May not |
| 220 | * be called from within atomic context. |
| 221 | */ |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 222 | void (*put_node)(struct ttm_mem_type_manager *man, |
| 223 | struct ttm_mem_reg *mem); |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 224 | |
| 225 | /** |
| 226 | * struct ttm_mem_type_manager member debug |
| 227 | * |
| 228 | * @man: Pointer to a memory type manager. |
| 229 | * @prefix: Prefix to be used in printout to identify the caller. |
| 230 | * |
| 231 | * This function is called to print out the state of the memory |
| 232 | * type manager to aid debugging of out-of-memory conditions. |
| 233 | * It may not be called from within atomic context. |
| 234 | */ |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 235 | void (*debug)(struct ttm_mem_type_manager *man, const char *prefix); |
| 236 | }; |
| 237 | |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 238 | /** |
| 239 | * struct ttm_mem_type_manager |
| 240 | * |
| 241 | * @has_type: The memory type has been initialized. |
| 242 | * @use_type: The memory type is enabled. |
| 243 | * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory |
| 244 | * managed by this memory type. |
| 245 | * @gpu_offset: If used, the GPU offset of the first managed page of |
| 246 | * fixed memory or the first managed location in an aperture. |
| 247 | * @size: Size of the managed region. |
| 248 | * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX, |
| 249 | * as defined in ttm_placement_common.h |
| 250 | * @default_caching: The default caching policy used for a buffer object |
| 251 | * placed in this memory type if the user doesn't provide one. |
| 252 | * @func: structure pointer implementing the range manager. See above |
| 253 | * @priv: Driver private closure for @func. |
| 254 | * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures |
| 255 | * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions |
| 256 | * reserved by the TTM vm system. |
| 257 | * @io_reserve_lru: Optional lru list for unreserving io mem regions. |
| 258 | * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain |
Christian König | 3ddf4ad | 2016-06-15 13:44:03 +0200 | [diff] [blame] | 259 | * @move_lock: lock for move fence |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 260 | * static information. bdev::driver::io_mem_free is never used. |
| 261 | * @lru: The lru list for this memory type. |
Christian König | 3ddf4ad | 2016-06-15 13:44:03 +0200 | [diff] [blame] | 262 | * @move: The fence of the last pipelined move operation. |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 263 | * |
| 264 | * This structure is used to identify and manage memory types for a device. |
| 265 | * It's set up by the ttm_bo_driver::init_mem_type method. |
| 266 | */ |
| 267 | |
| 268 | |
| 269 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 270 | struct ttm_mem_type_manager { |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 271 | struct ttm_bo_device *bdev; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 272 | |
| 273 | /* |
| 274 | * No protection. Constant from start. |
| 275 | */ |
| 276 | |
| 277 | bool has_type; |
| 278 | bool use_type; |
| 279 | uint32_t flags; |
Alex Deucher | 54c4cd6 | 2015-03-04 00:18:38 -0500 | [diff] [blame] | 280 | uint64_t gpu_offset; /* GPU address space is independent of CPU word size */ |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 281 | uint64_t size; |
| 282 | uint32_t available_caching; |
| 283 | uint32_t default_caching; |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 284 | const struct ttm_mem_type_manager_func *func; |
| 285 | void *priv; |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 286 | struct mutex io_reserve_mutex; |
| 287 | bool use_io_reserve_lru; |
| 288 | bool io_reserve_fastpath; |
Christian König | 3ddf4ad | 2016-06-15 13:44:03 +0200 | [diff] [blame] | 289 | spinlock_t move_lock; |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 290 | |
| 291 | /* |
| 292 | * Protected by @io_reserve_mutex: |
| 293 | */ |
| 294 | |
| 295 | struct list_head io_reserve_lru; |
Thomas Hellstrom | 3205bc2 | 2010-10-29 10:46:44 +0200 | [diff] [blame] | 296 | |
| 297 | /* |
| 298 | * Protected by the global->lru_lock. |
| 299 | */ |
| 300 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 301 | struct list_head lru; |
Christian König | 3ddf4ad | 2016-06-15 13:44:03 +0200 | [diff] [blame] | 302 | |
| 303 | /* |
| 304 | * Protected by @move_lock. |
| 305 | */ |
| 306 | struct fence *move; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 307 | }; |
| 308 | |
| 309 | /** |
| 310 | * struct ttm_bo_driver |
| 311 | * |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 312 | * @create_ttm_backend_entry: Callback to create a struct ttm_backend. |
| 313 | * @invalidate_caches: Callback to invalidate read caches when a buffer object |
| 314 | * has been evicted. |
| 315 | * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager |
| 316 | * structure. |
| 317 | * @evict_flags: Callback to obtain placement flags when a buffer is evicted. |
| 318 | * @move: Callback for a driver to hook in accelerated functions to |
| 319 | * move a buffer. |
| 320 | * If set to NULL, a potentially slow memcpy() move is used. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 321 | */ |
| 322 | |
| 323 | struct ttm_bo_driver { |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 324 | /** |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 325 | * ttm_tt_create |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 326 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 327 | * @bdev: pointer to a struct ttm_bo_device: |
| 328 | * @size: Size of the data needed backing. |
| 329 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. |
| 330 | * @dummy_read_page: See struct ttm_bo_device. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 331 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 332 | * Create a struct ttm_tt to back data with system memory pages. |
| 333 | * No pages are actually allocated. |
| 334 | * Returns: |
| 335 | * NULL: Out of memory. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 336 | */ |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 337 | struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev, |
| 338 | unsigned long size, |
| 339 | uint32_t page_flags, |
| 340 | struct page *dummy_read_page); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 341 | |
| 342 | /** |
Jerome Glisse | b1e5f17 | 2011-11-02 23:59:28 -0400 | [diff] [blame] | 343 | * ttm_tt_populate |
| 344 | * |
| 345 | * @ttm: The struct ttm_tt to contain the backing pages. |
| 346 | * |
| 347 | * Allocate all backing pages |
| 348 | * Returns: |
| 349 | * -ENOMEM: Out of memory. |
| 350 | */ |
| 351 | int (*ttm_tt_populate)(struct ttm_tt *ttm); |
| 352 | |
| 353 | /** |
| 354 | * ttm_tt_unpopulate |
| 355 | * |
| 356 | * @ttm: The struct ttm_tt to contain the backing pages. |
| 357 | * |
| 358 | * Free all backing page |
| 359 | */ |
| 360 | void (*ttm_tt_unpopulate)(struct ttm_tt *ttm); |
| 361 | |
| 362 | /** |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 363 | * struct ttm_bo_driver member invalidate_caches |
| 364 | * |
| 365 | * @bdev: the buffer object device. |
| 366 | * @flags: new placement of the rebound buffer object. |
| 367 | * |
| 368 | * A previosly evicted buffer has been rebound in a |
| 369 | * potentially new location. Tell the driver that it might |
| 370 | * consider invalidating read (texture) caches on the next command |
| 371 | * submission as a consequence. |
| 372 | */ |
| 373 | |
| 374 | int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags); |
| 375 | int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type, |
| 376 | struct ttm_mem_type_manager *man); |
| 377 | /** |
| 378 | * struct ttm_bo_driver member evict_flags: |
| 379 | * |
| 380 | * @bo: the buffer object to be evicted |
| 381 | * |
| 382 | * Return the bo flags for a buffer which is not mapped to the hardware. |
| 383 | * These will be placed in proposed_flags so that when the move is |
| 384 | * finished, they'll end up in bo->mem.flags |
| 385 | */ |
| 386 | |
Jerome Glisse | ca262a999 | 2009-12-08 15:33:32 +0100 | [diff] [blame] | 387 | void(*evict_flags) (struct ttm_buffer_object *bo, |
| 388 | struct ttm_placement *placement); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 389 | /** |
| 390 | * struct ttm_bo_driver member move: |
| 391 | * |
| 392 | * @bo: the buffer to move |
| 393 | * @evict: whether this motion is evicting the buffer from |
| 394 | * the graphics address space |
| 395 | * @interruptible: Use interruptible sleeps if possible when sleeping. |
| 396 | * @no_wait: whether this should give up and return -EBUSY |
| 397 | * if this move would require sleeping |
| 398 | * @new_mem: the new memory region receiving the buffer |
| 399 | * |
| 400 | * Move a buffer between two memory regions. |
| 401 | */ |
| 402 | int (*move) (struct ttm_buffer_object *bo, |
| 403 | bool evict, bool interruptible, |
Maarten Lankhorst | 97a875c | 2012-11-28 11:25:44 +0000 | [diff] [blame] | 404 | bool no_wait_gpu, |
Jerome Glisse | 9d87fa2 | 2010-04-07 10:21:19 +0000 | [diff] [blame] | 405 | struct ttm_mem_reg *new_mem); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 406 | |
| 407 | /** |
| 408 | * struct ttm_bo_driver_member verify_access |
| 409 | * |
| 410 | * @bo: Pointer to a buffer object. |
| 411 | * @filp: Pointer to a struct file trying to access the object. |
| 412 | * |
| 413 | * Called from the map / write / read methods to verify that the |
| 414 | * caller is permitted to access the buffer object. |
| 415 | * This member may be set to NULL, which will refuse this kind of |
| 416 | * access for all buffer objects. |
| 417 | * This function should return 0 if access is granted, -EPERM otherwise. |
| 418 | */ |
| 419 | int (*verify_access) (struct ttm_buffer_object *bo, |
| 420 | struct file *filp); |
| 421 | |
Dave Airlie | e024e11 | 2009-06-24 09:48:08 +1000 | [diff] [blame] | 422 | /* hook to notify driver about a driver move so it |
| 423 | * can do tiling things */ |
| 424 | void (*move_notify)(struct ttm_buffer_object *bo, |
| 425 | struct ttm_mem_reg *new_mem); |
| 426 | /* notify the driver we are taking a fault on this BO |
| 427 | * and have reserved it */ |
Jerome Glisse | 82c5da6 | 2010-04-09 14:39:23 +0200 | [diff] [blame] | 428 | int (*fault_reserve_notify)(struct ttm_buffer_object *bo); |
Thomas Hellstrom | 3f09ea4 | 2010-01-13 22:28:40 +0100 | [diff] [blame] | 429 | |
| 430 | /** |
| 431 | * notify the driver that we're about to swap out this bo |
| 432 | */ |
| 433 | void (*swap_notify) (struct ttm_buffer_object *bo); |
Jerome Glisse | 82c5da6 | 2010-04-09 14:39:23 +0200 | [diff] [blame] | 434 | |
| 435 | /** |
| 436 | * Driver callback on when mapping io memory (for bo_move_memcpy |
| 437 | * for instance). TTM will take care to call io_mem_free whenever |
| 438 | * the mapping is not use anymore. io_mem_reserve & io_mem_free |
| 439 | * are balanced. |
| 440 | */ |
| 441 | int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem); |
| 442 | void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem); |
Christian König | c3ea576 | 2016-04-06 11:12:06 +0200 | [diff] [blame] | 443 | |
| 444 | /** |
| 445 | * Optional driver callback for when BO is removed from the LRU. |
| 446 | * Called with LRU lock held immediately before the removal. |
| 447 | */ |
| 448 | void (*lru_removal)(struct ttm_buffer_object *bo); |
Christian König | 98c2872 | 2016-04-06 11:12:07 +0200 | [diff] [blame] | 449 | |
| 450 | /** |
| 451 | * Return the list_head after which a BO should be inserted in the LRU. |
| 452 | */ |
| 453 | struct list_head *(*lru_tail)(struct ttm_buffer_object *bo); |
| 454 | struct list_head *(*swap_lru_tail)(struct ttm_buffer_object *bo); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 455 | }; |
| 456 | |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 457 | /** |
| 458 | * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global. |
| 459 | */ |
| 460 | |
| 461 | struct ttm_bo_global_ref { |
Dave Airlie | ba4420c | 2010-03-09 10:56:52 +1000 | [diff] [blame] | 462 | struct drm_global_reference ref; |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 463 | struct ttm_mem_global *mem_glob; |
| 464 | }; |
| 465 | |
| 466 | /** |
| 467 | * struct ttm_bo_global - Buffer object driver global data. |
| 468 | * |
| 469 | * @mem_glob: Pointer to a struct ttm_mem_global object for accounting. |
| 470 | * @dummy_read_page: Pointer to a dummy page used for mapping requests |
| 471 | * of unpopulated pages. |
| 472 | * @shrink: A shrink callback object used for buffer object swap. |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 473 | * @device_list_mutex: Mutex protecting the device list. |
| 474 | * This mutex is held while traversing the device list for pm options. |
| 475 | * @lru_lock: Spinlock protecting the bo subsystem lru lists. |
| 476 | * @device_list: List of buffer object devices. |
| 477 | * @swap_lru: Lru list of buffer objects used for swapping. |
| 478 | */ |
| 479 | |
| 480 | struct ttm_bo_global { |
| 481 | |
| 482 | /** |
| 483 | * Constant after init. |
| 484 | */ |
| 485 | |
| 486 | struct kobject kobj; |
| 487 | struct ttm_mem_global *mem_glob; |
| 488 | struct page *dummy_read_page; |
| 489 | struct ttm_mem_shrink shrink; |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 490 | struct mutex device_list_mutex; |
| 491 | spinlock_t lru_lock; |
| 492 | |
| 493 | /** |
| 494 | * Protected by device_list_mutex. |
| 495 | */ |
| 496 | struct list_head device_list; |
| 497 | |
| 498 | /** |
| 499 | * Protected by the lru_lock. |
| 500 | */ |
| 501 | struct list_head swap_lru; |
| 502 | |
| 503 | /** |
| 504 | * Internal protection. |
| 505 | */ |
| 506 | atomic_t bo_count; |
| 507 | }; |
| 508 | |
| 509 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 510 | #define TTM_NUM_MEM_TYPES 8 |
| 511 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 512 | /** |
| 513 | * struct ttm_bo_device - Buffer object driver device-specific data. |
| 514 | * |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 515 | * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 516 | * @man: An array of mem_type_managers. |
David Herrmann | 72525b3 | 2013-07-24 21:08:53 +0200 | [diff] [blame] | 517 | * @vma_manager: Address space manager |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 518 | * lru_lock: Spinlock that protects the buffer+device lru lists and |
| 519 | * ddestroy lists. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 520 | * @dev_mapping: A pointer to the struct address_space representing the |
| 521 | * device address space. |
| 522 | * @wq: Work queue structure for the delayed delete workqueue. |
| 523 | * |
| 524 | */ |
| 525 | |
| 526 | struct ttm_bo_device { |
| 527 | |
| 528 | /* |
| 529 | * Constant after bo device init / atomic. |
| 530 | */ |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 531 | struct list_head device_list; |
| 532 | struct ttm_bo_global *glob; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 533 | struct ttm_bo_driver *driver; |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 534 | struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES]; |
David Herrmann | 72525b3 | 2013-07-24 21:08:53 +0200 | [diff] [blame] | 535 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 536 | /* |
David Herrmann | 72525b3 | 2013-07-24 21:08:53 +0200 | [diff] [blame] | 537 | * Protected by internal locks. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 538 | */ |
David Herrmann | 72525b3 | 2013-07-24 21:08:53 +0200 | [diff] [blame] | 539 | struct drm_vma_offset_manager vma_manager; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 540 | |
| 541 | /* |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 542 | * Protected by the global:lru lock. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 543 | */ |
| 544 | struct list_head ddestroy; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 545 | |
| 546 | /* |
| 547 | * Protected by load / firstopen / lastclose /unload sync. |
| 548 | */ |
| 549 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 550 | struct address_space *dev_mapping; |
| 551 | |
| 552 | /* |
| 553 | * Internal protection. |
| 554 | */ |
| 555 | |
| 556 | struct delayed_work wq; |
Dave Airlie | ad49f50 | 2009-07-10 22:36:26 +1000 | [diff] [blame] | 557 | |
| 558 | bool need_dma32; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 559 | }; |
| 560 | |
| 561 | /** |
| 562 | * ttm_flag_masked |
| 563 | * |
| 564 | * @old: Pointer to the result and original value. |
| 565 | * @new: New value of bits. |
| 566 | * @mask: Mask of bits to change. |
| 567 | * |
| 568 | * Convenience function to change a number of bits identified by a mask. |
| 569 | */ |
| 570 | |
| 571 | static inline uint32_t |
| 572 | ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask) |
| 573 | { |
| 574 | *old ^= (*old ^ new) & mask; |
| 575 | return *old; |
| 576 | } |
| 577 | |
| 578 | /** |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 579 | * ttm_tt_init |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 580 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 581 | * @ttm: The struct ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 582 | * @bdev: pointer to a struct ttm_bo_device: |
| 583 | * @size: Size of the data needed backing. |
| 584 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. |
| 585 | * @dummy_read_page: See struct ttm_bo_device. |
| 586 | * |
| 587 | * Create a struct ttm_tt to back data with system memory pages. |
| 588 | * No pages are actually allocated. |
| 589 | * Returns: |
| 590 | * NULL: Out of memory. |
| 591 | */ |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 592 | extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev, |
| 593 | unsigned long size, uint32_t page_flags, |
| 594 | struct page *dummy_read_page); |
Jerome Glisse | 8e7e705 | 2011-11-09 17:15:26 -0500 | [diff] [blame] | 595 | extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev, |
| 596 | unsigned long size, uint32_t page_flags, |
| 597 | struct page *dummy_read_page); |
| 598 | |
| 599 | /** |
| 600 | * ttm_tt_fini |
| 601 | * |
| 602 | * @ttm: the ttm_tt structure. |
| 603 | * |
| 604 | * Free memory of ttm_tt structure |
| 605 | */ |
| 606 | extern void ttm_tt_fini(struct ttm_tt *ttm); |
| 607 | extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 608 | |
| 609 | /** |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 610 | * ttm_ttm_bind: |
| 611 | * |
| 612 | * @ttm: The struct ttm_tt containing backing pages. |
| 613 | * @bo_mem: The struct ttm_mem_reg identifying the binding location. |
| 614 | * |
| 615 | * Bind the pages of @ttm to an aperture location identified by @bo_mem |
| 616 | */ |
| 617 | extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); |
| 618 | |
| 619 | /** |
| 620 | * ttm_ttm_destroy: |
| 621 | * |
| 622 | * @ttm: The struct ttm_tt. |
| 623 | * |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 624 | * Unbind, unpopulate and destroy common struct ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 625 | */ |
| 626 | extern void ttm_tt_destroy(struct ttm_tt *ttm); |
| 627 | |
| 628 | /** |
Christian König | 2ff2bf1 | 2016-07-21 12:18:19 +0200 | [diff] [blame] | 629 | * ttm_ttm_unbind: |
| 630 | * |
| 631 | * @ttm: The struct ttm_tt. |
| 632 | * |
| 633 | * Unbind a struct ttm_tt. |
| 634 | */ |
| 635 | extern void ttm_tt_unbind(struct ttm_tt *ttm); |
| 636 | |
| 637 | /** |
Jerome Glisse | b1e5f17 | 2011-11-02 23:59:28 -0400 | [diff] [blame] | 638 | * ttm_tt_swapin: |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 639 | * |
| 640 | * @ttm: The struct ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 641 | * |
Jerome Glisse | b1e5f17 | 2011-11-02 23:59:28 -0400 | [diff] [blame] | 642 | * Swap in a previously swap out ttm_tt. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 643 | */ |
Jerome Glisse | b1e5f17 | 2011-11-02 23:59:28 -0400 | [diff] [blame] | 644 | extern int ttm_tt_swapin(struct ttm_tt *ttm); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 645 | |
| 646 | /** |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 647 | * ttm_tt_set_placement_caching: |
| 648 | * |
| 649 | * @ttm A struct ttm_tt the backing pages of which will change caching policy. |
| 650 | * @placement: Flag indicating the desired caching policy. |
| 651 | * |
| 652 | * This function will change caching policy of any default kernel mappings of |
| 653 | * the pages backing @ttm. If changing from cached to uncached or |
| 654 | * write-combined, |
| 655 | * all CPU caches will first be flushed to make sure the data of the pages |
| 656 | * hit RAM. This function may be very costly as it involves global TLB |
| 657 | * and cache flushes and potential page splitting / combining. |
| 658 | */ |
| 659 | extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement); |
| 660 | extern int ttm_tt_swapout(struct ttm_tt *ttm, |
Jan Engelhardt | 5df2397 | 2011-04-04 01:25:18 +0200 | [diff] [blame] | 661 | struct file *persistent_swap_storage); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 662 | |
Thomas Hellstrom | 58aa662 | 2014-01-03 11:47:23 +0100 | [diff] [blame] | 663 | /** |
| 664 | * ttm_tt_unpopulate - free pages from a ttm |
| 665 | * |
| 666 | * @ttm: Pointer to the ttm_tt structure |
| 667 | * |
| 668 | * Calls the driver method to free all pages from a ttm |
| 669 | */ |
| 670 | extern void ttm_tt_unpopulate(struct ttm_tt *ttm); |
| 671 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 672 | /* |
| 673 | * ttm_bo.c |
| 674 | */ |
| 675 | |
| 676 | /** |
| 677 | * ttm_mem_reg_is_pci |
| 678 | * |
| 679 | * @bdev: Pointer to a struct ttm_bo_device. |
| 680 | * @mem: A valid struct ttm_mem_reg. |
| 681 | * |
| 682 | * Returns true if the memory described by @mem is PCI memory, |
| 683 | * false otherwise. |
| 684 | */ |
| 685 | extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, |
| 686 | struct ttm_mem_reg *mem); |
| 687 | |
| 688 | /** |
| 689 | * ttm_bo_mem_space |
| 690 | * |
| 691 | * @bo: Pointer to a struct ttm_buffer_object. the data of which |
| 692 | * we want to allocate space for. |
| 693 | * @proposed_placement: Proposed new placement for the buffer object. |
| 694 | * @mem: A struct ttm_mem_reg. |
| 695 | * @interruptible: Sleep interruptible when sliping. |
Jerome Glisse | 9d87fa2 | 2010-04-07 10:21:19 +0000 | [diff] [blame] | 696 | * @no_wait_gpu: Return immediately if the GPU is busy. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 697 | * |
| 698 | * Allocate memory space for the buffer object pointed to by @bo, using |
| 699 | * the placement flags in @mem, potentially evicting other idle buffer objects. |
| 700 | * This function may sleep while waiting for space to become available. |
| 701 | * Returns: |
| 702 | * -EBUSY: No space available (only if no_wait == 1). |
| 703 | * -ENOMEM: Could not allocate memory for the buffer object, either due to |
| 704 | * fragmentation or concurrent allocators. |
Thomas Hellstrom | 98ffc415 | 2009-12-07 18:36:18 +0100 | [diff] [blame] | 705 | * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 706 | */ |
| 707 | extern int ttm_bo_mem_space(struct ttm_buffer_object *bo, |
Jerome Glisse | ca262a999 | 2009-12-08 15:33:32 +0100 | [diff] [blame] | 708 | struct ttm_placement *placement, |
| 709 | struct ttm_mem_reg *mem, |
Jerome Glisse | 9d87fa2 | 2010-04-07 10:21:19 +0000 | [diff] [blame] | 710 | bool interruptible, |
Maarten Lankhorst | 97a875c | 2012-11-28 11:25:44 +0000 | [diff] [blame] | 711 | bool no_wait_gpu); |
Ben Skeggs | 42311ff | 2010-08-04 12:07:08 +1000 | [diff] [blame] | 712 | |
| 713 | extern void ttm_bo_mem_put(struct ttm_buffer_object *bo, |
| 714 | struct ttm_mem_reg *mem); |
Dave Airlie | c9220b0 | 2010-10-08 08:57:10 +1000 | [diff] [blame] | 715 | extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo, |
| 716 | struct ttm_mem_reg *mem); |
Ben Skeggs | 42311ff | 2010-08-04 12:07:08 +1000 | [diff] [blame] | 717 | |
Dave Airlie | ba4420c | 2010-03-09 10:56:52 +1000 | [diff] [blame] | 718 | extern void ttm_bo_global_release(struct drm_global_reference *ref); |
| 719 | extern int ttm_bo_global_init(struct drm_global_reference *ref); |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 720 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 721 | extern int ttm_bo_device_release(struct ttm_bo_device *bdev); |
| 722 | |
| 723 | /** |
| 724 | * ttm_bo_device_init |
| 725 | * |
| 726 | * @bdev: A pointer to a struct ttm_bo_device to initialize. |
Konrad Rzeszutek Wilk | 0d74f86 | 2011-06-08 17:06:15 +0000 | [diff] [blame] | 727 | * @glob: A pointer to an initialized struct ttm_bo_global. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 728 | * @driver: A pointer to a struct ttm_bo_driver set up by the caller. |
David Herrmann | 44d847b | 2013-08-13 19:10:30 +0200 | [diff] [blame] | 729 | * @mapping: The address space to use for this bo. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 730 | * @file_page_offset: Offset into the device address space that is available |
| 731 | * for buffer data. This ensures compatibility with other users of the |
| 732 | * address space. |
| 733 | * |
| 734 | * Initializes a struct ttm_bo_device: |
| 735 | * Returns: |
| 736 | * !0: Failure. |
| 737 | */ |
| 738 | extern int ttm_bo_device_init(struct ttm_bo_device *bdev, |
Thomas Hellstrom | a987fca | 2009-08-18 16:51:56 +0200 | [diff] [blame] | 739 | struct ttm_bo_global *glob, |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 740 | struct ttm_bo_driver *driver, |
David Herrmann | 44d847b | 2013-08-13 19:10:30 +0200 | [diff] [blame] | 741 | struct address_space *mapping, |
Dave Airlie | ad49f50 | 2009-07-10 22:36:26 +1000 | [diff] [blame] | 742 | uint64_t file_page_offset, bool need_dma32); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 743 | |
| 744 | /** |
Dave Airlie | e024e11 | 2009-06-24 09:48:08 +1000 | [diff] [blame] | 745 | * ttm_bo_unmap_virtual |
| 746 | * |
| 747 | * @bo: tear down the virtual mappings for this BO |
| 748 | */ |
| 749 | extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 750 | |
| 751 | /** |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 752 | * ttm_bo_unmap_virtual |
| 753 | * |
| 754 | * @bo: tear down the virtual mappings for this BO |
| 755 | * |
| 756 | * The caller must take ttm_mem_io_lock before calling this function. |
| 757 | */ |
| 758 | extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo); |
| 759 | |
| 760 | extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo); |
| 761 | extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo); |
| 762 | extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man, |
| 763 | bool interruptible); |
| 764 | extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man); |
| 765 | |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 766 | extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo); |
| 767 | extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo); |
| 768 | |
Christian König | 98c2872 | 2016-04-06 11:12:07 +0200 | [diff] [blame] | 769 | struct list_head *ttm_bo_default_lru_tail(struct ttm_buffer_object *bo); |
| 770 | struct list_head *ttm_bo_default_swap_lru_tail(struct ttm_buffer_object *bo); |
| 771 | |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 772 | /** |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 773 | * __ttm_bo_reserve: |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 774 | * |
| 775 | * @bo: A pointer to a struct ttm_buffer_object. |
| 776 | * @interruptible: Sleep interruptible if waiting. |
| 777 | * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. |
Christian König | dfd5e50 | 2016-04-06 11:12:03 +0200 | [diff] [blame] | 778 | * @ticket: ticket used to acquire the ww_mutex. |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 779 | * |
| 780 | * Will not remove reserved buffers from the lru lists. |
| 781 | * Otherwise identical to ttm_bo_reserve. |
| 782 | * |
| 783 | * Returns: |
| 784 | * -EDEADLK: The reservation may cause a deadlock. |
| 785 | * Release all buffer reservations, wait for @bo to become unreserved and |
| 786 | * try again. (only if use_sequence == 1). |
| 787 | * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by |
| 788 | * a signal. Release all buffer reservations and return to user-space. |
| 789 | * -EBUSY: The function needed to sleep, but @no_wait was true |
| 790 | * -EALREADY: Bo already reserved using @ticket. This error code will only |
| 791 | * be returned if @use_ticket is set to true. |
| 792 | */ |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 793 | static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo, |
Christian König | dfd5e50 | 2016-04-06 11:12:03 +0200 | [diff] [blame] | 794 | bool interruptible, bool no_wait, |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 795 | struct ww_acquire_ctx *ticket) |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 796 | { |
| 797 | int ret = 0; |
| 798 | |
| 799 | if (no_wait) { |
| 800 | bool success; |
| 801 | if (WARN_ON(ticket)) |
| 802 | return -EBUSY; |
| 803 | |
| 804 | success = ww_mutex_trylock(&bo->resv->lock); |
| 805 | return success ? 0 : -EBUSY; |
| 806 | } |
| 807 | |
| 808 | if (interruptible) |
| 809 | ret = ww_mutex_lock_interruptible(&bo->resv->lock, ticket); |
| 810 | else |
| 811 | ret = ww_mutex_lock(&bo->resv->lock, ticket); |
| 812 | if (ret == -EINTR) |
| 813 | return -ERESTARTSYS; |
| 814 | return ret; |
| 815 | } |
Thomas Hellstrom | eba6709 | 2010-11-11 09:41:57 +0100 | [diff] [blame] | 816 | |
| 817 | /** |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 818 | * ttm_bo_reserve: |
| 819 | * |
| 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. |
Christian König | dfd5e50 | 2016-04-06 11:12:03 +0200 | [diff] [blame] | 823 | * @ticket: ticket used to acquire the ww_mutex. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 824 | * |
| 825 | * Locks a buffer object for validation. (Or prevents other processes from |
| 826 | * locking it for validation) and removes it from lru lists, while taking |
| 827 | * a number of measures to prevent deadlocks. |
| 828 | * |
| 829 | * Deadlocks may occur when two processes try to reserve multiple buffers in |
| 830 | * different order, either by will or as a result of a buffer being evicted |
| 831 | * to make room for a buffer already reserved. (Buffers are reserved before |
| 832 | * they are evicted). The following algorithm prevents such deadlocks from |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 833 | * occurring: |
Maarten Lankhorst | 63d0a41 | 2013-01-15 14:56:37 +0100 | [diff] [blame] | 834 | * Processes attempting to reserve multiple buffers other than for eviction, |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 835 | * (typically execbuf), should first obtain a unique 32-bit |
| 836 | * validation sequence number, |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 837 | * and call this function with @use_ticket == 1 and @ticket->stamp == the unique |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 838 | * sequence number. If upon call of this function, the buffer object is already |
| 839 | * reserved, the validation sequence is checked against the validation |
| 840 | * sequence of the process currently reserving the buffer, |
| 841 | * and if the current validation sequence is greater than that of the process |
Nicolai Hähnle | eb227c5 | 2015-12-12 11:42:23 -0500 | [diff] [blame] | 842 | * holding the reservation, the function returns -EDEADLK. Otherwise it sleeps |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 843 | * waiting for the buffer to become unreserved, after which it retries |
| 844 | * reserving. |
Nicolai Hähnle | eb227c5 | 2015-12-12 11:42:23 -0500 | [diff] [blame] | 845 | * The caller should, when receiving an -EDEADLK error |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 846 | * release all its buffer reservations, wait for @bo to become unreserved, and |
| 847 | * then rerun the validation with the same validation sequence. This procedure |
| 848 | * will always guarantee that the process with the lowest validation sequence |
| 849 | * will eventually succeed, preventing both deadlocks and starvation. |
| 850 | * |
| 851 | * Returns: |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 852 | * -EDEADLK: The reservation may cause a deadlock. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 853 | * Release all buffer reservations, wait for @bo to become unreserved and |
| 854 | * try again. (only if use_sequence == 1). |
Thomas Hellstrom | 98ffc415 | 2009-12-07 18:36:18 +0100 | [diff] [blame] | 855 | * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 856 | * a signal. Release all buffer reservations and return to user-space. |
Thomas Hellstrom | 96726fe | 2010-11-17 12:28:28 +0000 | [diff] [blame] | 857 | * -EBUSY: The function needed to sleep, but @no_wait was true |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 858 | * -EALREADY: Bo already reserved using @ticket. This error code will only |
| 859 | * be returned if @use_ticket is set to true. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 860 | */ |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 861 | static inline int ttm_bo_reserve(struct ttm_buffer_object *bo, |
Christian König | dfd5e50 | 2016-04-06 11:12:03 +0200 | [diff] [blame] | 862 | bool interruptible, bool no_wait, |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 863 | struct ww_acquire_ctx *ticket) |
| 864 | { |
| 865 | int ret; |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 866 | |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 867 | WARN_ON(!atomic_read(&bo->kref.refcount)); |
Maarten Lankhorst | 5e45d7d | 2013-01-15 14:57:05 +0100 | [diff] [blame] | 868 | |
Christian König | dfd5e50 | 2016-04-06 11:12:03 +0200 | [diff] [blame] | 869 | ret = __ttm_bo_reserve(bo, interruptible, no_wait, ticket); |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 870 | if (likely(ret == 0)) |
| 871 | ttm_bo_del_sub_from_lru(bo); |
| 872 | |
| 873 | return ret; |
| 874 | } |
Maarten Lankhorst | 5e45d7d | 2013-01-15 14:57:05 +0100 | [diff] [blame] | 875 | |
| 876 | /** |
| 877 | * ttm_bo_reserve_slowpath: |
| 878 | * @bo: A pointer to a struct ttm_buffer_object. |
| 879 | * @interruptible: Sleep interruptible if waiting. |
| 880 | * @sequence: Set (@bo)->sequence to this value after lock |
| 881 | * |
| 882 | * This is called after ttm_bo_reserve returns -EAGAIN and we backed off |
| 883 | * from all our other reservations. Because there are no other reservations |
| 884 | * held by us, this function cannot deadlock any more. |
| 885 | */ |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 886 | static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo, |
| 887 | bool interruptible, |
| 888 | struct ww_acquire_ctx *ticket) |
| 889 | { |
| 890 | int ret = 0; |
Dave Airlie | d6ea888 | 2010-11-22 13:24:40 +1000 | [diff] [blame] | 891 | |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 892 | WARN_ON(!atomic_read(&bo->kref.refcount)); |
Dave Airlie | d6ea888 | 2010-11-22 13:24:40 +1000 | [diff] [blame] | 893 | |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 894 | if (interruptible) |
| 895 | ret = ww_mutex_lock_slow_interruptible(&bo->resv->lock, |
| 896 | ticket); |
| 897 | else |
| 898 | ww_mutex_lock_slow(&bo->resv->lock, ticket); |
| 899 | |
| 900 | if (likely(ret == 0)) |
| 901 | ttm_bo_del_sub_from_lru(bo); |
| 902 | else if (ret == -EINTR) |
| 903 | ret = -ERESTARTSYS; |
| 904 | |
| 905 | return ret; |
| 906 | } |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 907 | |
| 908 | /** |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 909 | * __ttm_bo_unreserve |
Thomas Hellstrom | 95762c2 | 2010-11-17 12:28:30 +0000 | [diff] [blame] | 910 | * @bo: A pointer to a struct ttm_buffer_object. |
| 911 | * |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 912 | * Unreserve a previous reservation of @bo where the buffer object is |
| 913 | * already on lru lists. |
Maarten Lankhorst | ecff665 | 2013-06-27 13:48:17 +0200 | [diff] [blame] | 914 | */ |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 915 | static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo) |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 916 | { |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 917 | ww_mutex_unlock(&bo->resv->lock); |
| 918 | } |
Maarten Lankhorst | ecff665 | 2013-06-27 13:48:17 +0200 | [diff] [blame] | 919 | |
| 920 | /** |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 921 | * ttm_bo_unreserve |
Maarten Lankhorst | ecff665 | 2013-06-27 13:48:17 +0200 | [diff] [blame] | 922 | * |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 923 | * @bo: A pointer to a struct ttm_buffer_object. |
| 924 | * |
| 925 | * Unreserve a previous reservation of @bo. |
Thomas Hellstrom | 95762c2 | 2010-11-17 12:28:30 +0000 | [diff] [blame] | 926 | */ |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 927 | static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo) |
| 928 | { |
Thomas Hellstrom | c752308 | 2014-02-20 11:36:25 +0100 | [diff] [blame] | 929 | if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) { |
| 930 | spin_lock(&bo->glob->lru_lock); |
| 931 | ttm_bo_add_to_lru(bo); |
| 932 | spin_unlock(&bo->glob->lru_lock); |
| 933 | } |
| 934 | __ttm_bo_unreserve(bo); |
| 935 | } |
| 936 | |
| 937 | /** |
| 938 | * ttm_bo_unreserve_ticket |
| 939 | * @bo: A pointer to a struct ttm_buffer_object. |
| 940 | * @ticket: ww_acquire_ctx used for reserving |
| 941 | * |
| 942 | * Unreserve a previous reservation of @bo made with @ticket. |
| 943 | */ |
| 944 | static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo, |
| 945 | struct ww_acquire_ctx *t) |
| 946 | { |
| 947 | ttm_bo_unreserve(bo); |
Maarten Lankhorst | 3482032 | 2013-06-27 13:48:24 +0200 | [diff] [blame] | 948 | } |
Thomas Hellstrom | 95762c2 | 2010-11-17 12:28:30 +0000 | [diff] [blame] | 949 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 950 | /* |
| 951 | * ttm_bo_util.c |
| 952 | */ |
| 953 | |
Dave Airlie | afe6804 | 2013-01-22 13:56:04 +1000 | [diff] [blame] | 954 | int ttm_mem_io_reserve(struct ttm_bo_device *bdev, |
| 955 | struct ttm_mem_reg *mem); |
| 956 | void ttm_mem_io_free(struct ttm_bo_device *bdev, |
| 957 | struct ttm_mem_reg *mem); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 958 | /** |
| 959 | * ttm_bo_move_ttm |
| 960 | * |
| 961 | * @bo: A pointer to a struct ttm_buffer_object. |
Michel Dänzer | 7b8082b | 2016-08-05 18:36:10 +0900 | [diff] [blame] | 962 | * @interruptible: Sleep interruptible if waiting. |
Jerome Glisse | 9d87fa2 | 2010-04-07 10:21:19 +0000 | [diff] [blame] | 963 | * @no_wait_gpu: Return immediately if the GPU is busy. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 964 | * @new_mem: struct ttm_mem_reg indicating where to move. |
| 965 | * |
| 966 | * Optimized move function for a buffer object with both old and |
| 967 | * new placement backed by a TTM. The function will, if successful, |
| 968 | * free any old aperture space, and set (@new_mem)->mm_node to NULL, |
| 969 | * and update the (@bo)->mem placement flags. If unsuccessful, the old |
| 970 | * data remains untouched, and it's up to the caller to free the |
| 971 | * memory space indicated by @new_mem. |
| 972 | * Returns: |
| 973 | * !0: Failure. |
| 974 | */ |
| 975 | |
| 976 | extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo, |
Michel Dänzer | 4e2f0ca | 2016-08-08 12:28:25 +0900 | [diff] [blame] | 977 | bool interruptible, bool no_wait_gpu, |
Maarten Lankhorst | 97a875c | 2012-11-28 11:25:44 +0000 | [diff] [blame] | 978 | struct ttm_mem_reg *new_mem); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 979 | |
| 980 | /** |
| 981 | * ttm_bo_move_memcpy |
| 982 | * |
| 983 | * @bo: A pointer to a struct ttm_buffer_object. |
Christian König | 77dfc28 | 2016-06-06 10:17:54 +0200 | [diff] [blame] | 984 | * @interruptible: Sleep interruptible if waiting. |
Jerome Glisse | 9d87fa2 | 2010-04-07 10:21:19 +0000 | [diff] [blame] | 985 | * @no_wait_gpu: Return immediately if the GPU is busy. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 986 | * @new_mem: struct ttm_mem_reg indicating where to move. |
| 987 | * |
| 988 | * Fallback move function for a mappable buffer object in mappable memory. |
| 989 | * The function will, if successful, |
| 990 | * free any old aperture space, and set (@new_mem)->mm_node to NULL, |
| 991 | * and update the (@bo)->mem placement flags. If unsuccessful, the old |
| 992 | * data remains untouched, and it's up to the caller to free the |
| 993 | * memory space indicated by @new_mem. |
| 994 | * Returns: |
| 995 | * !0: Failure. |
| 996 | */ |
| 997 | |
| 998 | extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo, |
Michel Dänzer | 4499f2a | 2016-08-08 12:28:26 +0900 | [diff] [blame] | 999 | bool interruptible, bool no_wait_gpu, |
Maarten Lankhorst | 97a875c | 2012-11-28 11:25:44 +0000 | [diff] [blame] | 1000 | struct ttm_mem_reg *new_mem); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1001 | |
| 1002 | /** |
| 1003 | * ttm_bo_free_old_node |
| 1004 | * |
| 1005 | * @bo: A pointer to a struct ttm_buffer_object. |
| 1006 | * |
| 1007 | * Utility function to free an old placement after a successful move. |
| 1008 | */ |
| 1009 | extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo); |
| 1010 | |
| 1011 | /** |
| 1012 | * ttm_bo_move_accel_cleanup. |
| 1013 | * |
| 1014 | * @bo: A pointer to a struct ttm_buffer_object. |
Maarten Lankhorst | f2c24b8 | 2014-04-02 17:14:48 +0200 | [diff] [blame] | 1015 | * @fence: A fence object that signals when moving is complete. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1016 | * @evict: This is an evict move. Don't return until the buffer is idle. |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1017 | * @new_mem: struct ttm_mem_reg indicating where to move. |
| 1018 | * |
| 1019 | * Accelerated move function to be called when an accelerated move |
| 1020 | * has been scheduled. The function will create a new temporary buffer object |
| 1021 | * representing the old placement, and put the sync object on both buffer |
| 1022 | * objects. After that the newly created buffer object is unref'd to be |
| 1023 | * destroyed when the move is complete. This will help pipeline |
| 1024 | * buffer moves. |
| 1025 | */ |
| 1026 | |
| 1027 | extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo, |
Christian König | 74561cd | 2016-06-15 13:44:00 +0200 | [diff] [blame] | 1028 | struct fence *fence, bool evict, |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1029 | struct ttm_mem_reg *new_mem); |
Christian König | 3ddf4ad | 2016-06-15 13:44:03 +0200 | [diff] [blame] | 1030 | |
| 1031 | /** |
| 1032 | * ttm_bo_pipeline_move. |
| 1033 | * |
| 1034 | * @bo: A pointer to a struct ttm_buffer_object. |
| 1035 | * @fence: A fence object that signals when moving is complete. |
| 1036 | * @evict: This is an evict move. Don't return until the buffer is idle. |
| 1037 | * @new_mem: struct ttm_mem_reg indicating where to move. |
| 1038 | * |
| 1039 | * Function for pipelining accelerated moves. Either free the memory |
| 1040 | * immediately or hang it on a temporary buffer object. |
| 1041 | */ |
| 1042 | int ttm_bo_pipeline_move(struct ttm_buffer_object *bo, |
| 1043 | struct fence *fence, bool evict, |
| 1044 | struct ttm_mem_reg *new_mem); |
| 1045 | |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1046 | /** |
| 1047 | * ttm_io_prot |
| 1048 | * |
| 1049 | * @c_state: Caching state. |
| 1050 | * @tmp: Page protection flag for a normal, cached mapping. |
| 1051 | * |
| 1052 | * Utility function that returns the pgprot_t that should be used for |
| 1053 | * setting up a PTE with the caching model indicated by @c_state. |
| 1054 | */ |
Randy Dunlap | a55e8d4 | 2010-02-24 14:29:14 -0800 | [diff] [blame] | 1055 | extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1056 | |
Ben Skeggs | d961db7 | 2010-08-05 10:48:18 +1000 | [diff] [blame] | 1057 | extern const struct ttm_mem_type_manager_func ttm_bo_manager_func; |
| 1058 | |
Daniel Vetter | e6bf6e5 | 2016-03-30 13:24:06 +0200 | [diff] [blame] | 1059 | #if IS_ENABLED(CONFIG_AGP) |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1060 | #include <linux/agp_backend.h> |
| 1061 | |
| 1062 | /** |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 1063 | * ttm_agp_tt_create |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1064 | * |
| 1065 | * @bdev: Pointer to a struct ttm_bo_device. |
| 1066 | * @bridge: The agp bridge this device is sitting on. |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 1067 | * @size: Size of the data needed backing. |
| 1068 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. |
| 1069 | * @dummy_read_page: See struct ttm_bo_device. |
| 1070 | * |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1071 | * |
| 1072 | * Create a TTM backend that uses the indicated AGP bridge as an aperture |
| 1073 | * for TT memory. This function uses the linux agpgart interface to |
| 1074 | * bind and unbind memory backing a ttm_tt. |
| 1075 | */ |
Jerome Glisse | 649bf3c | 2011-11-01 20:46:13 -0400 | [diff] [blame] | 1076 | extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev, |
| 1077 | struct agp_bridge_data *bridge, |
| 1078 | unsigned long size, uint32_t page_flags, |
| 1079 | struct page *dummy_read_page); |
Jerome Glisse | dea7e0a | 2012-01-03 17:37:37 -0500 | [diff] [blame] | 1080 | int ttm_agp_tt_populate(struct ttm_tt *ttm); |
| 1081 | void ttm_agp_tt_unpopulate(struct ttm_tt *ttm); |
Thomas Hellstrom | ba4e7d9 | 2009-06-10 15:20:19 +0200 | [diff] [blame] | 1082 | #endif |
| 1083 | |
| 1084 | #endif |