blob: 4f0a92185995db9b52d2062d2eecf1d1b80c3abb [file] [log] [blame]
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001/**************************************************************************
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 Howellsa1ce3922012-10-02 18:01:25 +010033#include <ttm/ttm_bo_api.h>
34#include <ttm/ttm_memory.h>
35#include <ttm/ttm_module.h>
Maarten Lankhorst34820322013-06-27 13:48:24 +020036#include <ttm/ttm_placement.h>
David Howellsa1ce3922012-10-02 18:01:25 +010037#include <drm/drm_mm.h>
38#include <drm/drm_global.h>
David Herrmann72525b32013-07-24 21:08:53 +020039#include <drm/drm_vma_manager.h>
David Howellsa1ce3922012-10-02 18:01:25 +010040#include <linux/workqueue.h>
41#include <linux/fs.h>
42#include <linux/spinlock.h>
Maarten Lankhorstecff6652013-06-27 13:48:17 +020043#include <linux/reservation.h>
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020044
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020045struct ttm_backend_func {
46 /**
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020047 * struct ttm_backend_func member bind
48 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -040049 * @ttm: Pointer to a struct ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020050 * @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 Wilk0d74f862011-06-08 17:06:15 +000055 * differences between aperture and system page sizes.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020056 */
Jerome Glisse649bf3c2011-11-01 20:46:13 -040057 int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020058
59 /**
60 * struct ttm_backend_func member unbind
61 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -040062 * @ttm: Pointer to a struct ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020063 *
64 * Unbind previously bound backend pages. This function should be
Konrad Rzeszutek Wilk0d74f862011-06-08 17:06:15 +000065 * able to handle differences between aperture and system page sizes.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020066 */
Jerome Glisse649bf3c2011-11-01 20:46:13 -040067 int (*unbind) (struct ttm_tt *ttm);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020068
69 /**
70 * struct ttm_backend_func member destroy
71 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -040072 * @ttm: Pointer to a struct ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020073 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -040074 * 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 Hellstromba4e7d92009-06-10 15:20:19 +020076 */
Jerome Glisse649bf3c2011-11-01 20:46:13 -040077 void (*destroy) (struct ttm_tt *ttm);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020078};
79
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020080#define TTM_PAGE_FLAG_WRITE (1 << 3)
81#define TTM_PAGE_FLAG_SWAPPED (1 << 4)
Jan Engelhardt5df23972011-04-04 01:25:18 +020082#define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5)
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020083#define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
Dave Airliead49f502009-07-10 22:36:26 +100084#define TTM_PAGE_FLAG_DMA32 (1 << 7)
Dave Airlie129b78b2012-04-02 11:46:06 +010085#define TTM_PAGE_FLAG_SG (1 << 8)
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020086
87enum ttm_caching_state {
88 tt_uncached,
89 tt_wc,
90 tt_cached
91};
92
93/**
94 * struct ttm_tt
95 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -040096 * @bdev: Pointer to a struct ttm_bo_device.
97 * @func: Pointer to a struct ttm_backend_func that describes
98 * the backend methods.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020099 * @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 Hellstromba4e7d92009-06-10 15:20:19 +0200102 * @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 Hellstromba4e7d92009-06-10 15:20:19 +0200105 * @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
114struct ttm_tt {
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400115 struct ttm_bo_device *bdev;
116 struct ttm_backend_func *func;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200117 struct page *dummy_read_page;
118 struct page **pages;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200119 uint32_t page_flags;
120 unsigned long num_pages;
Dave Airlie129b78b2012-04-02 11:46:06 +0100121 struct sg_table *sg; /* for SG objects via dma-buf */
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200122 struct ttm_bo_global *glob;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200123 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 Glisse8e7e7052011-11-09 17:15:26 -0500130};
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 */
143struct ttm_dma_tt {
144 struct ttm_tt ttm;
Konrad Rzeszutek Wilkf9820a42010-11-29 13:52:18 -0500145 dma_addr_t *dma_address;
Jerome Glisse8e7e7052011-11-09 17:15:26 -0500146 struct list_head pages_list;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200147};
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 Hellstromba4e7d92009-06-10 15:20:19 +0200151#define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
152
Ben Skeggsd961db72010-08-05 10:48:18 +1000153struct ttm_mem_type_manager;
154
155struct ttm_mem_type_manager_func {
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200156 /**
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 Skeggsd961db72010-08-05 10:48:18 +1000167 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200168
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 Skeggsd961db72010-08-05 10:48:18 +1000177 int (*takedown)(struct ttm_mem_type_manager *man);
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200178
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önige3f20272014-07-03 09:02:23 +0200185 * @flags: Additional placement flags.
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200186 * @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 Marchi25985ed2011-03-30 22:57:33 -0300194 * If the memory region accommodate the buffer object, @mem::mm_node
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200195 * should be set to NULL, and the function should return 0.
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300196 * If a system error occurred, preventing the request to be fulfilled,
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200197 * 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 Skeggsd961db72010-08-05 10:48:18 +1000207 int (*get_node)(struct ttm_mem_type_manager *man,
208 struct ttm_buffer_object *bo,
Christian Königf1217ed2014-08-27 13:16:04 +0200209 const struct ttm_place *place,
Ben Skeggsd961db72010-08-05 10:48:18 +1000210 struct ttm_mem_reg *mem);
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200211
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 Skeggsd961db72010-08-05 10:48:18 +1000222 void (*put_node)(struct ttm_mem_type_manager *man,
223 struct ttm_mem_reg *mem);
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200224
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 Skeggsd961db72010-08-05 10:48:18 +1000235 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
236};
237
Thomas Hellstromeba67092010-11-11 09:41:57 +0100238/**
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önig3ddf4ad2016-06-15 13:44:03 +0200259 * @move_lock: lock for move fence
Thomas Hellstromeba67092010-11-11 09:41:57 +0100260 * static information. bdev::driver::io_mem_free is never used.
261 * @lru: The lru list for this memory type.
Christian König3ddf4ad2016-06-15 13:44:03 +0200262 * @move: The fence of the last pipelined move operation.
Thomas Hellstromeba67092010-11-11 09:41:57 +0100263 *
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 Hellstromba4e7d92009-06-10 15:20:19 +0200270struct ttm_mem_type_manager {
Ben Skeggsd961db72010-08-05 10:48:18 +1000271 struct ttm_bo_device *bdev;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200272
273 /*
274 * No protection. Constant from start.
275 */
276
277 bool has_type;
278 bool use_type;
279 uint32_t flags;
Alex Deucher54c4cd62015-03-04 00:18:38 -0500280 uint64_t gpu_offset; /* GPU address space is independent of CPU word size */
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200281 uint64_t size;
282 uint32_t available_caching;
283 uint32_t default_caching;
Ben Skeggsd961db72010-08-05 10:48:18 +1000284 const struct ttm_mem_type_manager_func *func;
285 void *priv;
Thomas Hellstromeba67092010-11-11 09:41:57 +0100286 struct mutex io_reserve_mutex;
287 bool use_io_reserve_lru;
288 bool io_reserve_fastpath;
Christian König3ddf4ad2016-06-15 13:44:03 +0200289 spinlock_t move_lock;
Thomas Hellstromeba67092010-11-11 09:41:57 +0100290
291 /*
292 * Protected by @io_reserve_mutex:
293 */
294
295 struct list_head io_reserve_lru;
Thomas Hellstrom3205bc22010-10-29 10:46:44 +0200296
297 /*
298 * Protected by the global->lru_lock.
299 */
300
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200301 struct list_head lru;
Christian König3ddf4ad2016-06-15 13:44:03 +0200302
303 /*
304 * Protected by @move_lock.
305 */
306 struct fence *move;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200307};
308
309/**
310 * struct ttm_bo_driver
311 *
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200312 * @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 Hellstromba4e7d92009-06-10 15:20:19 +0200321 */
322
323struct ttm_bo_driver {
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200324 /**
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400325 * ttm_tt_create
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200326 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400327 * @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 Hellstromba4e7d92009-06-10 15:20:19 +0200331 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400332 * 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 Hellstromba4e7d92009-06-10 15:20:19 +0200336 */
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400337 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 Hellstromba4e7d92009-06-10 15:20:19 +0200341
342 /**
Jerome Glisseb1e5f172011-11-02 23:59:28 -0400343 * 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 Hellstromba4e7d92009-06-10 15:20:19 +0200363 * 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 Glisseca262a9992009-12-08 15:33:32 +0100387 void(*evict_flags) (struct ttm_buffer_object *bo,
388 struct ttm_placement *placement);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200389 /**
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 Lankhorst97a875c2012-11-28 11:25:44 +0000404 bool no_wait_gpu,
Jerome Glisse9d87fa22010-04-07 10:21:19 +0000405 struct ttm_mem_reg *new_mem);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200406
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 Airliee024e112009-06-24 09:48:08 +1000422 /* 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 Glisse82c5da62010-04-09 14:39:23 +0200428 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
Thomas Hellstrom3f09ea42010-01-13 22:28:40 +0100429
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 Glisse82c5da62010-04-09 14:39:23 +0200434
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önigc3ea5762016-04-06 11:12:06 +0200443
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önig98c28722016-04-06 11:12:07 +0200449
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 Hellstromba4e7d92009-06-10 15:20:19 +0200455};
456
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200457/**
458 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
459 */
460
461struct ttm_bo_global_ref {
Dave Airlieba4420c2010-03-09 10:56:52 +1000462 struct drm_global_reference ref;
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200463 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 Hellstroma987fca2009-08-18 16:51:56 +0200473 * @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
480struct 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 Hellstroma987fca2009-08-18 16:51:56 +0200490 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 Hellstromba4e7d92009-06-10 15:20:19 +0200510#define TTM_NUM_MEM_TYPES 8
511
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200512/**
513 * struct ttm_bo_device - Buffer object driver device-specific data.
514 *
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200515 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200516 * @man: An array of mem_type_managers.
David Herrmann72525b32013-07-24 21:08:53 +0200517 * @vma_manager: Address space manager
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200518 * lru_lock: Spinlock that protects the buffer+device lru lists and
519 * ddestroy lists.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200520 * @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
526struct ttm_bo_device {
527
528 /*
529 * Constant after bo device init / atomic.
530 */
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200531 struct list_head device_list;
532 struct ttm_bo_global *glob;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200533 struct ttm_bo_driver *driver;
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200534 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
David Herrmann72525b32013-07-24 21:08:53 +0200535
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200536 /*
David Herrmann72525b32013-07-24 21:08:53 +0200537 * Protected by internal locks.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200538 */
David Herrmann72525b32013-07-24 21:08:53 +0200539 struct drm_vma_offset_manager vma_manager;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200540
541 /*
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200542 * Protected by the global:lru lock.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200543 */
544 struct list_head ddestroy;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200545
546 /*
547 * Protected by load / firstopen / lastclose /unload sync.
548 */
549
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200550 struct address_space *dev_mapping;
551
552 /*
553 * Internal protection.
554 */
555
556 struct delayed_work wq;
Dave Airliead49f502009-07-10 22:36:26 +1000557
558 bool need_dma32;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200559};
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
571static inline uint32_t
572ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
573{
574 *old ^= (*old ^ new) & mask;
575 return *old;
576}
577
578/**
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400579 * ttm_tt_init
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200580 *
Jerome Glisse649bf3c2011-11-01 20:46:13 -0400581 * @ttm: The struct ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200582 * @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 Glisse649bf3c2011-11-01 20:46:13 -0400592extern 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 Glisse8e7e7052011-11-09 17:15:26 -0500595extern 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 */
606extern void ttm_tt_fini(struct ttm_tt *ttm);
607extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200608
609/**
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200610 * 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 */
617extern 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 Glisse649bf3c2011-11-01 20:46:13 -0400624 * Unbind, unpopulate and destroy common struct ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200625 */
626extern void ttm_tt_destroy(struct ttm_tt *ttm);
627
628/**
Christian König2ff2bf12016-07-21 12:18:19 +0200629 * ttm_ttm_unbind:
630 *
631 * @ttm: The struct ttm_tt.
632 *
633 * Unbind a struct ttm_tt.
634 */
635extern void ttm_tt_unbind(struct ttm_tt *ttm);
636
637/**
Jerome Glisseb1e5f172011-11-02 23:59:28 -0400638 * ttm_tt_swapin:
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200639 *
640 * @ttm: The struct ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200641 *
Jerome Glisseb1e5f172011-11-02 23:59:28 -0400642 * Swap in a previously swap out ttm_tt.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200643 */
Jerome Glisseb1e5f172011-11-02 23:59:28 -0400644extern int ttm_tt_swapin(struct ttm_tt *ttm);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200645
646/**
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200647 * 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 */
659extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
660extern int ttm_tt_swapout(struct ttm_tt *ttm,
Jan Engelhardt5df23972011-04-04 01:25:18 +0200661 struct file *persistent_swap_storage);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200662
Thomas Hellstrom58aa6622014-01-03 11:47:23 +0100663/**
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 */
670extern void ttm_tt_unpopulate(struct ttm_tt *ttm);
671
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200672/*
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 */
685extern 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 Glisse9d87fa22010-04-07 10:21:19 +0000696 * @no_wait_gpu: Return immediately if the GPU is busy.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200697 *
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 Hellstrom98ffc4152009-12-07 18:36:18 +0100705 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200706 */
707extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
Jerome Glisseca262a9992009-12-08 15:33:32 +0100708 struct ttm_placement *placement,
709 struct ttm_mem_reg *mem,
Jerome Glisse9d87fa22010-04-07 10:21:19 +0000710 bool interruptible,
Maarten Lankhorst97a875c2012-11-28 11:25:44 +0000711 bool no_wait_gpu);
Ben Skeggs42311ff2010-08-04 12:07:08 +1000712
713extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
714 struct ttm_mem_reg *mem);
Dave Airliec9220b02010-10-08 08:57:10 +1000715extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
716 struct ttm_mem_reg *mem);
Ben Skeggs42311ff2010-08-04 12:07:08 +1000717
Dave Airlieba4420c2010-03-09 10:56:52 +1000718extern void ttm_bo_global_release(struct drm_global_reference *ref);
719extern int ttm_bo_global_init(struct drm_global_reference *ref);
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200720
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200721extern 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 Wilk0d74f862011-06-08 17:06:15 +0000727 * @glob: A pointer to an initialized struct ttm_bo_global.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200728 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
David Herrmann44d847b2013-08-13 19:10:30 +0200729 * @mapping: The address space to use for this bo.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200730 * @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 */
738extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200739 struct ttm_bo_global *glob,
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200740 struct ttm_bo_driver *driver,
David Herrmann44d847b2013-08-13 19:10:30 +0200741 struct address_space *mapping,
Dave Airliead49f502009-07-10 22:36:26 +1000742 uint64_t file_page_offset, bool need_dma32);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200743
744/**
Dave Airliee024e112009-06-24 09:48:08 +1000745 * ttm_bo_unmap_virtual
746 *
747 * @bo: tear down the virtual mappings for this BO
748 */
749extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200750
751/**
Thomas Hellstromeba67092010-11-11 09:41:57 +0100752 * 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 */
758extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
759
760extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo);
761extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo);
762extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man,
763 bool interruptible);
764extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man);
765
Maarten Lankhorst34820322013-06-27 13:48:24 +0200766extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo);
767extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
768
Christian König98c28722016-04-06 11:12:07 +0200769struct list_head *ttm_bo_default_lru_tail(struct ttm_buffer_object *bo);
770struct list_head *ttm_bo_default_swap_lru_tail(struct ttm_buffer_object *bo);
771
Maarten Lankhorst34820322013-06-27 13:48:24 +0200772/**
Thomas Hellstromc7523082014-02-20 11:36:25 +0100773 * __ttm_bo_reserve:
Maarten Lankhorst34820322013-06-27 13:48:24 +0200774 *
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önigdfd5e502016-04-06 11:12:03 +0200778 * @ticket: ticket used to acquire the ww_mutex.
Maarten Lankhorst34820322013-06-27 13:48:24 +0200779 *
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 Hellstromc7523082014-02-20 11:36:25 +0100793static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo,
Christian Königdfd5e502016-04-06 11:12:03 +0200794 bool interruptible, bool no_wait,
Thomas Hellstromc7523082014-02-20 11:36:25 +0100795 struct ww_acquire_ctx *ticket)
Maarten Lankhorst34820322013-06-27 13:48:24 +0200796{
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 Hellstromeba67092010-11-11 09:41:57 +0100816
817/**
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200818 * 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önigdfd5e502016-04-06 11:12:03 +0200823 * @ticket: ticket used to acquire the ww_mutex.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200824 *
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 Marchi25985ed2011-03-30 22:57:33 -0300833 * occurring:
Maarten Lankhorst63d0a412013-01-15 14:56:37 +0100834 * Processes attempting to reserve multiple buffers other than for eviction,
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200835 * (typically execbuf), should first obtain a unique 32-bit
836 * validation sequence number,
Maarten Lankhorst34820322013-06-27 13:48:24 +0200837 * and call this function with @use_ticket == 1 and @ticket->stamp == the unique
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200838 * 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ähnleeb227c52015-12-12 11:42:23 -0500842 * holding the reservation, the function returns -EDEADLK. Otherwise it sleeps
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200843 * waiting for the buffer to become unreserved, after which it retries
844 * reserving.
Nicolai Hähnleeb227c52015-12-12 11:42:23 -0500845 * The caller should, when receiving an -EDEADLK error
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200846 * 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 Lankhorst34820322013-06-27 13:48:24 +0200852 * -EDEADLK: The reservation may cause a deadlock.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200853 * Release all buffer reservations, wait for @bo to become unreserved and
854 * try again. (only if use_sequence == 1).
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100855 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200856 * a signal. Release all buffer reservations and return to user-space.
Thomas Hellstrom96726fe2010-11-17 12:28:28 +0000857 * -EBUSY: The function needed to sleep, but @no_wait was true
Maarten Lankhorst34820322013-06-27 13:48:24 +0200858 * -EALREADY: Bo already reserved using @ticket. This error code will only
859 * be returned if @use_ticket is set to true.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200860 */
Maarten Lankhorst34820322013-06-27 13:48:24 +0200861static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
Christian Königdfd5e502016-04-06 11:12:03 +0200862 bool interruptible, bool no_wait,
Maarten Lankhorst34820322013-06-27 13:48:24 +0200863 struct ww_acquire_ctx *ticket)
864{
865 int ret;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200866
Maarten Lankhorst34820322013-06-27 13:48:24 +0200867 WARN_ON(!atomic_read(&bo->kref.refcount));
Maarten Lankhorst5e45d7d2013-01-15 14:57:05 +0100868
Christian Königdfd5e502016-04-06 11:12:03 +0200869 ret = __ttm_bo_reserve(bo, interruptible, no_wait, ticket);
Maarten Lankhorst34820322013-06-27 13:48:24 +0200870 if (likely(ret == 0))
871 ttm_bo_del_sub_from_lru(bo);
872
873 return ret;
874}
Maarten Lankhorst5e45d7d2013-01-15 14:57:05 +0100875
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 Lankhorst34820322013-06-27 13:48:24 +0200886static 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 Airlied6ea8882010-11-22 13:24:40 +1000891
Maarten Lankhorst34820322013-06-27 13:48:24 +0200892 WARN_ON(!atomic_read(&bo->kref.refcount));
Dave Airlied6ea8882010-11-22 13:24:40 +1000893
Maarten Lankhorst34820322013-06-27 13:48:24 +0200894 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 Hellstromba4e7d92009-06-10 15:20:19 +0200907
908/**
Thomas Hellstromc7523082014-02-20 11:36:25 +0100909 * __ttm_bo_unreserve
Thomas Hellstrom95762c22010-11-17 12:28:30 +0000910 * @bo: A pointer to a struct ttm_buffer_object.
911 *
Thomas Hellstromc7523082014-02-20 11:36:25 +0100912 * Unreserve a previous reservation of @bo where the buffer object is
913 * already on lru lists.
Maarten Lankhorstecff6652013-06-27 13:48:17 +0200914 */
Thomas Hellstromc7523082014-02-20 11:36:25 +0100915static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo)
Maarten Lankhorst34820322013-06-27 13:48:24 +0200916{
Maarten Lankhorst34820322013-06-27 13:48:24 +0200917 ww_mutex_unlock(&bo->resv->lock);
918}
Maarten Lankhorstecff6652013-06-27 13:48:17 +0200919
920/**
Maarten Lankhorst34820322013-06-27 13:48:24 +0200921 * ttm_bo_unreserve
Maarten Lankhorstecff6652013-06-27 13:48:17 +0200922 *
Maarten Lankhorst34820322013-06-27 13:48:24 +0200923 * @bo: A pointer to a struct ttm_buffer_object.
924 *
925 * Unreserve a previous reservation of @bo.
Thomas Hellstrom95762c22010-11-17 12:28:30 +0000926 */
Maarten Lankhorst34820322013-06-27 13:48:24 +0200927static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
928{
Thomas Hellstromc7523082014-02-20 11:36:25 +0100929 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 */
944static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo,
945 struct ww_acquire_ctx *t)
946{
947 ttm_bo_unreserve(bo);
Maarten Lankhorst34820322013-06-27 13:48:24 +0200948}
Thomas Hellstrom95762c22010-11-17 12:28:30 +0000949
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200950/*
951 * ttm_bo_util.c
952 */
953
Dave Airlieafe68042013-01-22 13:56:04 +1000954int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
955 struct ttm_mem_reg *mem);
956void ttm_mem_io_free(struct ttm_bo_device *bdev,
957 struct ttm_mem_reg *mem);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200958/**
959 * ttm_bo_move_ttm
960 *
961 * @bo: A pointer to a struct ttm_buffer_object.
Michel Dänzer7b8082b2016-08-05 18:36:10 +0900962 * @interruptible: Sleep interruptible if waiting.
Jerome Glisse9d87fa22010-04-07 10:21:19 +0000963 * @no_wait_gpu: Return immediately if the GPU is busy.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200964 * @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
976extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
Michel Dänzer4e2f0ca2016-08-08 12:28:25 +0900977 bool interruptible, bool no_wait_gpu,
Maarten Lankhorst97a875c2012-11-28 11:25:44 +0000978 struct ttm_mem_reg *new_mem);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200979
980/**
981 * ttm_bo_move_memcpy
982 *
983 * @bo: A pointer to a struct ttm_buffer_object.
Christian König77dfc282016-06-06 10:17:54 +0200984 * @interruptible: Sleep interruptible if waiting.
Jerome Glisse9d87fa22010-04-07 10:21:19 +0000985 * @no_wait_gpu: Return immediately if the GPU is busy.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200986 * @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
998extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
Michel Dänzer4499f2a2016-08-08 12:28:26 +0900999 bool interruptible, bool no_wait_gpu,
Maarten Lankhorst97a875c2012-11-28 11:25:44 +00001000 struct ttm_mem_reg *new_mem);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001001
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 */
1009extern 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 Lankhorstf2c24b82014-04-02 17:14:48 +02001015 * @fence: A fence object that signals when moving is complete.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001016 * @evict: This is an evict move. Don't return until the buffer is idle.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001017 * @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
1027extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
Christian König74561cd2016-06-15 13:44:00 +02001028 struct fence *fence, bool evict,
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001029 struct ttm_mem_reg *new_mem);
Christian König3ddf4ad2016-06-15 13:44:03 +02001030
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 */
1042int ttm_bo_pipeline_move(struct ttm_buffer_object *bo,
1043 struct fence *fence, bool evict,
1044 struct ttm_mem_reg *new_mem);
1045
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001046/**
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 Dunlapa55e8d42010-02-24 14:29:14 -08001055extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001056
Ben Skeggsd961db72010-08-05 10:48:18 +10001057extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
1058
Daniel Vettere6bf6e52016-03-30 13:24:06 +02001059#if IS_ENABLED(CONFIG_AGP)
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001060#include <linux/agp_backend.h>
1061
1062/**
Jerome Glisse649bf3c2011-11-01 20:46:13 -04001063 * ttm_agp_tt_create
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001064 *
1065 * @bdev: Pointer to a struct ttm_bo_device.
1066 * @bridge: The agp bridge this device is sitting on.
Jerome Glisse649bf3c2011-11-01 20:46:13 -04001067 * @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 Hellstromba4e7d92009-06-10 15:20:19 +02001071 *
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 Glisse649bf3c2011-11-01 20:46:13 -04001076extern 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 Glissedea7e0a2012-01-03 17:37:37 -05001080int ttm_agp_tt_populate(struct ttm_tt *ttm);
1081void ttm_agp_tt_unpopulate(struct ttm_tt *ttm);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001082#endif
1083
1084#endif