Loading...
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
33#include "ttm/ttm_bo_api.h"
34#include "ttm/ttm_memory.h"
35#include "ttm/ttm_module.h"
36#include "drm_mm.h"
37#include "drm_global.h"
38#include "linux/workqueue.h"
39#include "linux/fs.h"
40#include "linux/spinlock.h"
41
42struct ttm_backend;
43
44struct ttm_backend_func {
45 /**
46 * struct ttm_backend_func member bind
47 *
48 * @ttm: Pointer to a struct ttm_tt.
49 * @bo_mem: Pointer to a struct ttm_mem_reg describing the
50 * memory type and location for binding.
51 *
52 * Bind the backend pages into the aperture in the location
53 * indicated by @bo_mem. This function should be able to handle
54 * differences between aperture and system page sizes.
55 */
56 int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
57
58 /**
59 * struct ttm_backend_func member unbind
60 *
61 * @ttm: Pointer to a struct ttm_tt.
62 *
63 * Unbind previously bound backend pages. This function should be
64 * able to handle differences between aperture and system page sizes.
65 */
66 int (*unbind) (struct ttm_tt *ttm);
67
68 /**
69 * struct ttm_backend_func member destroy
70 *
71 * @ttm: Pointer to a struct ttm_tt.
72 *
73 * Destroy the backend. This will be call back from ttm_tt_destroy so
74 * don't call ttm_tt_destroy from the callback or infinite loop.
75 */
76 void (*destroy) (struct ttm_tt *ttm);
77};
78
79#define TTM_PAGE_FLAG_WRITE (1 << 3)
80#define TTM_PAGE_FLAG_SWAPPED (1 << 4)
81#define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5)
82#define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
83#define TTM_PAGE_FLAG_DMA32 (1 << 7)
84#define TTM_PAGE_FLAG_SG (1 << 8)
85
86enum ttm_caching_state {
87 tt_uncached,
88 tt_wc,
89 tt_cached
90};
91
92/**
93 * struct ttm_tt
94 *
95 * @bdev: Pointer to a struct ttm_bo_device.
96 * @func: Pointer to a struct ttm_backend_func that describes
97 * the backend methods.
98 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
99 * pointer.
100 * @pages: Array of pages backing the data.
101 * @num_pages: Number of pages in the page array.
102 * @bdev: Pointer to the current struct ttm_bo_device.
103 * @be: Pointer to the ttm backend.
104 * @swap_storage: Pointer to shmem struct file for swap storage.
105 * @caching_state: The current caching state of the pages.
106 * @state: The current binding state of the pages.
107 *
108 * This is a structure holding the pages, caching- and aperture binding
109 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
110 * memory.
111 */
112
113struct ttm_tt {
114 struct ttm_bo_device *bdev;
115 struct ttm_backend_func *func;
116 struct page *dummy_read_page;
117 struct page **pages;
118 uint32_t page_flags;
119 unsigned long num_pages;
120 struct sg_table *sg; /* for SG objects via dma-buf */
121 struct ttm_bo_global *glob;
122 struct ttm_backend *be;
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;
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 */
143struct ttm_dma_tt {
144 struct ttm_tt ttm;
145 dma_addr_t *dma_address;
146 struct list_head pages_list;
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 */
151#define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
152
153struct ttm_mem_type_manager;
154
155struct ttm_mem_type_manager_func {
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 */
167 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
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 */
177 int (*takedown)(struct ttm_mem_type_manager *man);
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.
185 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
186 *
187 * This function should allocate space in the memory type managed
188 * by @man. Placement details if
189 * applicable are given by @placement. If successful,
190 * @mem::mm_node should be set to a non-null value, and
191 * @mem::start should be set to a value identifying the beginning
192 * of the range allocated, and the function should return zero.
193 * If the memory region accommodate the buffer object, @mem::mm_node
194 * should be set to NULL, and the function should return 0.
195 * If a system error occurred, preventing the request to be fulfilled,
196 * the function should return a negative error code.
197 *
198 * Note that @mem::mm_node will only be dereferenced by
199 * struct ttm_mem_type_manager functions and optionally by the driver,
200 * which has knowledge of the underlying type.
201 *
202 * This function may not be called from within atomic context, so
203 * an implementation can and must use either a mutex or a spinlock to
204 * protect any data structures managing the space.
205 */
206 int (*get_node)(struct ttm_mem_type_manager *man,
207 struct ttm_buffer_object *bo,
208 struct ttm_placement *placement,
209 struct ttm_mem_reg *mem);
210
211 /**
212 * struct ttm_mem_type_manager member put_node
213 *
214 * @man: Pointer to a memory type manager.
215 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
216 *
217 * This function frees memory type resources previously allocated
218 * and that are identified by @mem::mm_node and @mem::start. May not
219 * be called from within atomic context.
220 */
221 void (*put_node)(struct ttm_mem_type_manager *man,
222 struct ttm_mem_reg *mem);
223
224 /**
225 * struct ttm_mem_type_manager member debug
226 *
227 * @man: Pointer to a memory type manager.
228 * @prefix: Prefix to be used in printout to identify the caller.
229 *
230 * This function is called to print out the state of the memory
231 * type manager to aid debugging of out-of-memory conditions.
232 * It may not be called from within atomic context.
233 */
234 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
235};
236
237/**
238 * struct ttm_mem_type_manager
239 *
240 * @has_type: The memory type has been initialized.
241 * @use_type: The memory type is enabled.
242 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
243 * managed by this memory type.
244 * @gpu_offset: If used, the GPU offset of the first managed page of
245 * fixed memory or the first managed location in an aperture.
246 * @size: Size of the managed region.
247 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
248 * as defined in ttm_placement_common.h
249 * @default_caching: The default caching policy used for a buffer object
250 * placed in this memory type if the user doesn't provide one.
251 * @func: structure pointer implementing the range manager. See above
252 * @priv: Driver private closure for @func.
253 * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures
254 * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions
255 * reserved by the TTM vm system.
256 * @io_reserve_lru: Optional lru list for unreserving io mem regions.
257 * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain
258 * static information. bdev::driver::io_mem_free is never used.
259 * @lru: The lru list for this memory type.
260 *
261 * This structure is used to identify and manage memory types for a device.
262 * It's set up by the ttm_bo_driver::init_mem_type method.
263 */
264
265
266
267struct ttm_mem_type_manager {
268 struct ttm_bo_device *bdev;
269
270 /*
271 * No protection. Constant from start.
272 */
273
274 bool has_type;
275 bool use_type;
276 uint32_t flags;
277 unsigned long gpu_offset;
278 uint64_t size;
279 uint32_t available_caching;
280 uint32_t default_caching;
281 const struct ttm_mem_type_manager_func *func;
282 void *priv;
283 struct mutex io_reserve_mutex;
284 bool use_io_reserve_lru;
285 bool io_reserve_fastpath;
286
287 /*
288 * Protected by @io_reserve_mutex:
289 */
290
291 struct list_head io_reserve_lru;
292
293 /*
294 * Protected by the global->lru_lock.
295 */
296
297 struct list_head lru;
298};
299
300/**
301 * struct ttm_bo_driver
302 *
303 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
304 * @invalidate_caches: Callback to invalidate read caches when a buffer object
305 * has been evicted.
306 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
307 * structure.
308 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
309 * @move: Callback for a driver to hook in accelerated functions to
310 * move a buffer.
311 * If set to NULL, a potentially slow memcpy() move is used.
312 * @sync_obj_signaled: See ttm_fence_api.h
313 * @sync_obj_wait: See ttm_fence_api.h
314 * @sync_obj_flush: See ttm_fence_api.h
315 * @sync_obj_unref: See ttm_fence_api.h
316 * @sync_obj_ref: See ttm_fence_api.h
317 */
318
319struct ttm_bo_driver {
320 /**
321 * ttm_tt_create
322 *
323 * @bdev: pointer to a struct ttm_bo_device:
324 * @size: Size of the data needed backing.
325 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
326 * @dummy_read_page: See struct ttm_bo_device.
327 *
328 * Create a struct ttm_tt to back data with system memory pages.
329 * No pages are actually allocated.
330 * Returns:
331 * NULL: Out of memory.
332 */
333 struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev,
334 unsigned long size,
335 uint32_t page_flags,
336 struct page *dummy_read_page);
337
338 /**
339 * ttm_tt_populate
340 *
341 * @ttm: The struct ttm_tt to contain the backing pages.
342 *
343 * Allocate all backing pages
344 * Returns:
345 * -ENOMEM: Out of memory.
346 */
347 int (*ttm_tt_populate)(struct ttm_tt *ttm);
348
349 /**
350 * ttm_tt_unpopulate
351 *
352 * @ttm: The struct ttm_tt to contain the backing pages.
353 *
354 * Free all backing page
355 */
356 void (*ttm_tt_unpopulate)(struct ttm_tt *ttm);
357
358 /**
359 * struct ttm_bo_driver member invalidate_caches
360 *
361 * @bdev: the buffer object device.
362 * @flags: new placement of the rebound buffer object.
363 *
364 * A previosly evicted buffer has been rebound in a
365 * potentially new location. Tell the driver that it might
366 * consider invalidating read (texture) caches on the next command
367 * submission as a consequence.
368 */
369
370 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
371 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
372 struct ttm_mem_type_manager *man);
373 /**
374 * struct ttm_bo_driver member evict_flags:
375 *
376 * @bo: the buffer object to be evicted
377 *
378 * Return the bo flags for a buffer which is not mapped to the hardware.
379 * These will be placed in proposed_flags so that when the move is
380 * finished, they'll end up in bo->mem.flags
381 */
382
383 void(*evict_flags) (struct ttm_buffer_object *bo,
384 struct ttm_placement *placement);
385 /**
386 * struct ttm_bo_driver member move:
387 *
388 * @bo: the buffer to move
389 * @evict: whether this motion is evicting the buffer from
390 * the graphics address space
391 * @interruptible: Use interruptible sleeps if possible when sleeping.
392 * @no_wait: whether this should give up and return -EBUSY
393 * if this move would require sleeping
394 * @new_mem: the new memory region receiving the buffer
395 *
396 * Move a buffer between two memory regions.
397 */
398 int (*move) (struct ttm_buffer_object *bo,
399 bool evict, bool interruptible,
400 bool no_wait_reserve, bool no_wait_gpu,
401 struct ttm_mem_reg *new_mem);
402
403 /**
404 * struct ttm_bo_driver_member verify_access
405 *
406 * @bo: Pointer to a buffer object.
407 * @filp: Pointer to a struct file trying to access the object.
408 *
409 * Called from the map / write / read methods to verify that the
410 * caller is permitted to access the buffer object.
411 * This member may be set to NULL, which will refuse this kind of
412 * access for all buffer objects.
413 * This function should return 0 if access is granted, -EPERM otherwise.
414 */
415 int (*verify_access) (struct ttm_buffer_object *bo,
416 struct file *filp);
417
418 /**
419 * In case a driver writer dislikes the TTM fence objects,
420 * the driver writer can replace those with sync objects of
421 * his / her own. If it turns out that no driver writer is
422 * using these. I suggest we remove these hooks and plug in
423 * fences directly. The bo driver needs the following functionality:
424 * See the corresponding functions in the fence object API
425 * documentation.
426 */
427
428 bool (*sync_obj_signaled) (void *sync_obj, void *sync_arg);
429 int (*sync_obj_wait) (void *sync_obj, void *sync_arg,
430 bool lazy, bool interruptible);
431 int (*sync_obj_flush) (void *sync_obj, void *sync_arg);
432 void (*sync_obj_unref) (void **sync_obj);
433 void *(*sync_obj_ref) (void *sync_obj);
434
435 /* hook to notify driver about a driver move so it
436 * can do tiling things */
437 void (*move_notify)(struct ttm_buffer_object *bo,
438 struct ttm_mem_reg *new_mem);
439 /* notify the driver we are taking a fault on this BO
440 * and have reserved it */
441 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
442
443 /**
444 * notify the driver that we're about to swap out this bo
445 */
446 void (*swap_notify) (struct ttm_buffer_object *bo);
447
448 /**
449 * Driver callback on when mapping io memory (for bo_move_memcpy
450 * for instance). TTM will take care to call io_mem_free whenever
451 * the mapping is not use anymore. io_mem_reserve & io_mem_free
452 * are balanced.
453 */
454 int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
455 void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
456};
457
458/**
459 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
460 */
461
462struct ttm_bo_global_ref {
463 struct drm_global_reference ref;
464 struct ttm_mem_global *mem_glob;
465};
466
467/**
468 * struct ttm_bo_global - Buffer object driver global data.
469 *
470 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
471 * @dummy_read_page: Pointer to a dummy page used for mapping requests
472 * of unpopulated pages.
473 * @shrink: A shrink callback object used for buffer object swap.
474 * @device_list_mutex: Mutex protecting the device list.
475 * This mutex is held while traversing the device list for pm options.
476 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
477 * @device_list: List of buffer object devices.
478 * @swap_lru: Lru list of buffer objects used for swapping.
479 */
480
481struct ttm_bo_global {
482
483 /**
484 * Constant after init.
485 */
486
487 struct kobject kobj;
488 struct ttm_mem_global *mem_glob;
489 struct page *dummy_read_page;
490 struct ttm_mem_shrink shrink;
491 struct mutex device_list_mutex;
492 spinlock_t lru_lock;
493
494 /**
495 * Protected by device_list_mutex.
496 */
497 struct list_head device_list;
498
499 /**
500 * Protected by the lru_lock.
501 */
502 struct list_head swap_lru;
503
504 /**
505 * Internal protection.
506 */
507 atomic_t bo_count;
508};
509
510
511#define TTM_NUM_MEM_TYPES 8
512
513#define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
514 idling before CPU mapping */
515#define TTM_BO_PRIV_FLAG_MAX 1
516/**
517 * struct ttm_bo_device - Buffer object driver device-specific data.
518 *
519 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
520 * @man: An array of mem_type_managers.
521 * @fence_lock: Protects the synchronizing members on *all* bos belonging
522 * to this device.
523 * @addr_space_mm: Range manager for the device address space.
524 * lru_lock: Spinlock that protects the buffer+device lru lists and
525 * ddestroy lists.
526 * @val_seq: Current validation sequence.
527 * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager.
528 * If a GPU lockup has been detected, this is forced to 0.
529 * @dev_mapping: A pointer to the struct address_space representing the
530 * device address space.
531 * @wq: Work queue structure for the delayed delete workqueue.
532 *
533 */
534
535struct ttm_bo_device {
536
537 /*
538 * Constant after bo device init / atomic.
539 */
540 struct list_head device_list;
541 struct ttm_bo_global *glob;
542 struct ttm_bo_driver *driver;
543 rwlock_t vm_lock;
544 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
545 spinlock_t fence_lock;
546 /*
547 * Protected by the vm lock.
548 */
549 struct rb_root addr_space_rb;
550 struct drm_mm addr_space_mm;
551
552 /*
553 * Protected by the global:lru lock.
554 */
555 struct list_head ddestroy;
556 uint32_t val_seq;
557
558 /*
559 * Protected by load / firstopen / lastclose /unload sync.
560 */
561
562 bool nice_mode;
563 struct address_space *dev_mapping;
564
565 /*
566 * Internal protection.
567 */
568
569 struct delayed_work wq;
570
571 bool need_dma32;
572};
573
574/**
575 * ttm_flag_masked
576 *
577 * @old: Pointer to the result and original value.
578 * @new: New value of bits.
579 * @mask: Mask of bits to change.
580 *
581 * Convenience function to change a number of bits identified by a mask.
582 */
583
584static inline uint32_t
585ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
586{
587 *old ^= (*old ^ new) & mask;
588 return *old;
589}
590
591/**
592 * ttm_tt_init
593 *
594 * @ttm: The struct ttm_tt.
595 * @bdev: pointer to a struct ttm_bo_device:
596 * @size: Size of the data needed backing.
597 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
598 * @dummy_read_page: See struct ttm_bo_device.
599 *
600 * Create a struct ttm_tt to back data with system memory pages.
601 * No pages are actually allocated.
602 * Returns:
603 * NULL: Out of memory.
604 */
605extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
606 unsigned long size, uint32_t page_flags,
607 struct page *dummy_read_page);
608extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
609 unsigned long size, uint32_t page_flags,
610 struct page *dummy_read_page);
611
612/**
613 * ttm_tt_fini
614 *
615 * @ttm: the ttm_tt structure.
616 *
617 * Free memory of ttm_tt structure
618 */
619extern void ttm_tt_fini(struct ttm_tt *ttm);
620extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma);
621
622/**
623 * ttm_ttm_bind:
624 *
625 * @ttm: The struct ttm_tt containing backing pages.
626 * @bo_mem: The struct ttm_mem_reg identifying the binding location.
627 *
628 * Bind the pages of @ttm to an aperture location identified by @bo_mem
629 */
630extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
631
632/**
633 * ttm_ttm_destroy:
634 *
635 * @ttm: The struct ttm_tt.
636 *
637 * Unbind, unpopulate and destroy common struct ttm_tt.
638 */
639extern void ttm_tt_destroy(struct ttm_tt *ttm);
640
641/**
642 * ttm_ttm_unbind:
643 *
644 * @ttm: The struct ttm_tt.
645 *
646 * Unbind a struct ttm_tt.
647 */
648extern void ttm_tt_unbind(struct ttm_tt *ttm);
649
650/**
651 * ttm_tt_swapin:
652 *
653 * @ttm: The struct ttm_tt.
654 *
655 * Swap in a previously swap out ttm_tt.
656 */
657extern int ttm_tt_swapin(struct ttm_tt *ttm);
658
659/**
660 * ttm_tt_cache_flush:
661 *
662 * @pages: An array of pointers to struct page:s to flush.
663 * @num_pages: Number of pages to flush.
664 *
665 * Flush the data of the indicated pages from the cpu caches.
666 * This is used when changing caching attributes of the pages from
667 * cache-coherent.
668 */
669extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages);
670
671/**
672 * ttm_tt_set_placement_caching:
673 *
674 * @ttm A struct ttm_tt the backing pages of which will change caching policy.
675 * @placement: Flag indicating the desired caching policy.
676 *
677 * This function will change caching policy of any default kernel mappings of
678 * the pages backing @ttm. If changing from cached to uncached or
679 * write-combined,
680 * all CPU caches will first be flushed to make sure the data of the pages
681 * hit RAM. This function may be very costly as it involves global TLB
682 * and cache flushes and potential page splitting / combining.
683 */
684extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
685extern int ttm_tt_swapout(struct ttm_tt *ttm,
686 struct file *persistent_swap_storage);
687
688/*
689 * ttm_bo.c
690 */
691
692/**
693 * ttm_mem_reg_is_pci
694 *
695 * @bdev: Pointer to a struct ttm_bo_device.
696 * @mem: A valid struct ttm_mem_reg.
697 *
698 * Returns true if the memory described by @mem is PCI memory,
699 * false otherwise.
700 */
701extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
702 struct ttm_mem_reg *mem);
703
704/**
705 * ttm_bo_mem_space
706 *
707 * @bo: Pointer to a struct ttm_buffer_object. the data of which
708 * we want to allocate space for.
709 * @proposed_placement: Proposed new placement for the buffer object.
710 * @mem: A struct ttm_mem_reg.
711 * @interruptible: Sleep interruptible when sliping.
712 * @no_wait_reserve: Return immediately if other buffers are busy.
713 * @no_wait_gpu: Return immediately if the GPU is busy.
714 *
715 * Allocate memory space for the buffer object pointed to by @bo, using
716 * the placement flags in @mem, potentially evicting other idle buffer objects.
717 * This function may sleep while waiting for space to become available.
718 * Returns:
719 * -EBUSY: No space available (only if no_wait == 1).
720 * -ENOMEM: Could not allocate memory for the buffer object, either due to
721 * fragmentation or concurrent allocators.
722 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
723 */
724extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
725 struct ttm_placement *placement,
726 struct ttm_mem_reg *mem,
727 bool interruptible,
728 bool no_wait_reserve, bool no_wait_gpu);
729
730extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
731 struct ttm_mem_reg *mem);
732extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
733 struct ttm_mem_reg *mem);
734
735/**
736 * ttm_bo_wait_for_cpu
737 *
738 * @bo: Pointer to a struct ttm_buffer_object.
739 * @no_wait: Don't sleep while waiting.
740 *
741 * Wait until a buffer object is no longer sync'ed for CPU access.
742 * Returns:
743 * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1).
744 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
745 */
746
747extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait);
748
749extern void ttm_bo_global_release(struct drm_global_reference *ref);
750extern int ttm_bo_global_init(struct drm_global_reference *ref);
751
752extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
753
754/**
755 * ttm_bo_device_init
756 *
757 * @bdev: A pointer to a struct ttm_bo_device to initialize.
758 * @glob: A pointer to an initialized struct ttm_bo_global.
759 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
760 * @file_page_offset: Offset into the device address space that is available
761 * for buffer data. This ensures compatibility with other users of the
762 * address space.
763 *
764 * Initializes a struct ttm_bo_device:
765 * Returns:
766 * !0: Failure.
767 */
768extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
769 struct ttm_bo_global *glob,
770 struct ttm_bo_driver *driver,
771 uint64_t file_page_offset, bool need_dma32);
772
773/**
774 * ttm_bo_unmap_virtual
775 *
776 * @bo: tear down the virtual mappings for this BO
777 */
778extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
779
780/**
781 * ttm_bo_unmap_virtual
782 *
783 * @bo: tear down the virtual mappings for this BO
784 *
785 * The caller must take ttm_mem_io_lock before calling this function.
786 */
787extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
788
789extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo);
790extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo);
791extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man,
792 bool interruptible);
793extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man);
794
795
796/**
797 * ttm_bo_reserve:
798 *
799 * @bo: A pointer to a struct ttm_buffer_object.
800 * @interruptible: Sleep interruptible if waiting.
801 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
802 * @use_sequence: If @bo is already reserved, Only sleep waiting for
803 * it to become unreserved if @sequence < (@bo)->sequence.
804 *
805 * Locks a buffer object for validation. (Or prevents other processes from
806 * locking it for validation) and removes it from lru lists, while taking
807 * a number of measures to prevent deadlocks.
808 *
809 * Deadlocks may occur when two processes try to reserve multiple buffers in
810 * different order, either by will or as a result of a buffer being evicted
811 * to make room for a buffer already reserved. (Buffers are reserved before
812 * they are evicted). The following algorithm prevents such deadlocks from
813 * occurring:
814 * 1) Buffers are reserved with the lru spinlock held. Upon successful
815 * reservation they are removed from the lru list. This stops a reserved buffer
816 * from being evicted. However the lru spinlock is released between the time
817 * a buffer is selected for eviction and the time it is reserved.
818 * Therefore a check is made when a buffer is reserved for eviction, that it
819 * is still the first buffer in the lru list, before it is removed from the
820 * list. @check_lru == 1 forces this check. If it fails, the function returns
821 * -EINVAL, and the caller should then choose a new buffer to evict and repeat
822 * the procedure.
823 * 2) Processes attempting to reserve multiple buffers other than for eviction,
824 * (typically execbuf), should first obtain a unique 32-bit
825 * validation sequence number,
826 * and call this function with @use_sequence == 1 and @sequence == the unique
827 * sequence number. If upon call of this function, the buffer object is already
828 * reserved, the validation sequence is checked against the validation
829 * sequence of the process currently reserving the buffer,
830 * and if the current validation sequence is greater than that of the process
831 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
832 * waiting for the buffer to become unreserved, after which it retries
833 * reserving.
834 * The caller should, when receiving an -EAGAIN error
835 * release all its buffer reservations, wait for @bo to become unreserved, and
836 * then rerun the validation with the same validation sequence. This procedure
837 * will always guarantee that the process with the lowest validation sequence
838 * will eventually succeed, preventing both deadlocks and starvation.
839 *
840 * Returns:
841 * -EAGAIN: The reservation may cause a deadlock.
842 * Release all buffer reservations, wait for @bo to become unreserved and
843 * try again. (only if use_sequence == 1).
844 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
845 * a signal. Release all buffer reservations and return to user-space.
846 * -EBUSY: The function needed to sleep, but @no_wait was true
847 * -EDEADLK: Bo already reserved using @sequence. This error code will only
848 * be returned if @use_sequence is set to true.
849 */
850extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
851 bool interruptible,
852 bool no_wait, bool use_sequence, uint32_t sequence);
853
854
855/**
856 * ttm_bo_reserve_locked:
857 *
858 * @bo: A pointer to a struct ttm_buffer_object.
859 * @interruptible: Sleep interruptible if waiting.
860 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
861 * @use_sequence: If @bo is already reserved, Only sleep waiting for
862 * it to become unreserved if @sequence < (@bo)->sequence.
863 *
864 * Must be called with struct ttm_bo_global::lru_lock held,
865 * and will not remove reserved buffers from the lru lists.
866 * The function may release the LRU spinlock if it needs to sleep.
867 * Otherwise identical to ttm_bo_reserve.
868 *
869 * Returns:
870 * -EAGAIN: The reservation may cause a deadlock.
871 * Release all buffer reservations, wait for @bo to become unreserved and
872 * try again. (only if use_sequence == 1).
873 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
874 * a signal. Release all buffer reservations and return to user-space.
875 * -EBUSY: The function needed to sleep, but @no_wait was true
876 * -EDEADLK: Bo already reserved using @sequence. This error code will only
877 * be returned if @use_sequence is set to true.
878 */
879extern int ttm_bo_reserve_locked(struct ttm_buffer_object *bo,
880 bool interruptible,
881 bool no_wait, bool use_sequence,
882 uint32_t sequence);
883
884/**
885 * ttm_bo_unreserve
886 *
887 * @bo: A pointer to a struct ttm_buffer_object.
888 *
889 * Unreserve a previous reservation of @bo.
890 */
891extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
892
893/**
894 * ttm_bo_unreserve_locked
895 *
896 * @bo: A pointer to a struct ttm_buffer_object.
897 *
898 * Unreserve a previous reservation of @bo.
899 * Needs to be called with struct ttm_bo_global::lru_lock held.
900 */
901extern void ttm_bo_unreserve_locked(struct ttm_buffer_object *bo);
902
903/**
904 * ttm_bo_wait_unreserved
905 *
906 * @bo: A pointer to a struct ttm_buffer_object.
907 *
908 * Wait for a struct ttm_buffer_object to become unreserved.
909 * This is typically used in the execbuf code to relax cpu-usage when
910 * a potential deadlock condition backoff.
911 */
912extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo,
913 bool interruptible);
914
915/*
916 * ttm_bo_util.c
917 */
918
919/**
920 * ttm_bo_move_ttm
921 *
922 * @bo: A pointer to a struct ttm_buffer_object.
923 * @evict: 1: This is an eviction. Don't try to pipeline.
924 * @no_wait_reserve: Return immediately if other buffers are busy.
925 * @no_wait_gpu: Return immediately if the GPU is busy.
926 * @new_mem: struct ttm_mem_reg indicating where to move.
927 *
928 * Optimized move function for a buffer object with both old and
929 * new placement backed by a TTM. The function will, if successful,
930 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
931 * and update the (@bo)->mem placement flags. If unsuccessful, the old
932 * data remains untouched, and it's up to the caller to free the
933 * memory space indicated by @new_mem.
934 * Returns:
935 * !0: Failure.
936 */
937
938extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
939 bool evict, bool no_wait_reserve,
940 bool no_wait_gpu, struct ttm_mem_reg *new_mem);
941
942/**
943 * ttm_bo_move_memcpy
944 *
945 * @bo: A pointer to a struct ttm_buffer_object.
946 * @evict: 1: This is an eviction. Don't try to pipeline.
947 * @no_wait_reserve: Return immediately if other buffers are busy.
948 * @no_wait_gpu: Return immediately if the GPU is busy.
949 * @new_mem: struct ttm_mem_reg indicating where to move.
950 *
951 * Fallback move function for a mappable buffer object in mappable memory.
952 * The function will, if successful,
953 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
954 * and update the (@bo)->mem placement flags. If unsuccessful, the old
955 * data remains untouched, and it's up to the caller to free the
956 * memory space indicated by @new_mem.
957 * Returns:
958 * !0: Failure.
959 */
960
961extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
962 bool evict, bool no_wait_reserve,
963 bool no_wait_gpu, struct ttm_mem_reg *new_mem);
964
965/**
966 * ttm_bo_free_old_node
967 *
968 * @bo: A pointer to a struct ttm_buffer_object.
969 *
970 * Utility function to free an old placement after a successful move.
971 */
972extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
973
974/**
975 * ttm_bo_move_accel_cleanup.
976 *
977 * @bo: A pointer to a struct ttm_buffer_object.
978 * @sync_obj: A sync object that signals when moving is complete.
979 * @sync_obj_arg: An argument to pass to the sync object idle / wait
980 * functions.
981 * @evict: This is an evict move. Don't return until the buffer is idle.
982 * @no_wait_reserve: Return immediately if other buffers are busy.
983 * @no_wait_gpu: Return immediately if the GPU is busy.
984 * @new_mem: struct ttm_mem_reg indicating where to move.
985 *
986 * Accelerated move function to be called when an accelerated move
987 * has been scheduled. The function will create a new temporary buffer object
988 * representing the old placement, and put the sync object on both buffer
989 * objects. After that the newly created buffer object is unref'd to be
990 * destroyed when the move is complete. This will help pipeline
991 * buffer moves.
992 */
993
994extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
995 void *sync_obj,
996 void *sync_obj_arg,
997 bool evict, bool no_wait_reserve,
998 bool no_wait_gpu,
999 struct ttm_mem_reg *new_mem);
1000/**
1001 * ttm_io_prot
1002 *
1003 * @c_state: Caching state.
1004 * @tmp: Page protection flag for a normal, cached mapping.
1005 *
1006 * Utility function that returns the pgprot_t that should be used for
1007 * setting up a PTE with the caching model indicated by @c_state.
1008 */
1009extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
1010
1011extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
1012
1013#if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
1014#define TTM_HAS_AGP
1015#include <linux/agp_backend.h>
1016
1017/**
1018 * ttm_agp_tt_create
1019 *
1020 * @bdev: Pointer to a struct ttm_bo_device.
1021 * @bridge: The agp bridge this device is sitting on.
1022 * @size: Size of the data needed backing.
1023 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
1024 * @dummy_read_page: See struct ttm_bo_device.
1025 *
1026 *
1027 * Create a TTM backend that uses the indicated AGP bridge as an aperture
1028 * for TT memory. This function uses the linux agpgart interface to
1029 * bind and unbind memory backing a ttm_tt.
1030 */
1031extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev,
1032 struct agp_bridge_data *bridge,
1033 unsigned long size, uint32_t page_flags,
1034 struct page *dummy_read_page);
1035int ttm_agp_tt_populate(struct ttm_tt *ttm);
1036void ttm_agp_tt_unpopulate(struct ttm_tt *ttm);
1037#endif
1038
1039#endif