include/drm/ttm/ttm_bo_driver.h

   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 <drm/drm_mm.h>
  34 #include <drm/drm_vma_manager.h>
  35 #include <linux/workqueue.h>
  36 #include <linux/fs.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/dma-resv.h>
  39
  40 #include "ttm_bo_api.h"
  41 #include "ttm_memory.h"
  42 #include "ttm_module.h"
  43 #include "ttm_placement.h"
  44 #include "ttm_tt.h"
  45
  46 /**
  47  * struct ttm_bo_driver
  48  *
  49  * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
  50  * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
  51  * @move: Callback for a driver to hook in accelerated functions to
  52  * move a buffer.
  53  * If set to NULL, a potentially slow memcpy() move is used.
  54  */
  55
  56 struct ttm_bo_driver {
  57         /**
  58          * ttm_tt_create
  59          *
  60          * @bo: The buffer object to create the ttm for.
  61          * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
  62          *
  63          * Create a struct ttm_tt to back data with system memory pages.
  64          * No pages are actually allocated.
  65          * Returns:
  66          * NULL: Out of memory.
  67          */
  68         struct ttm_tt *(*ttm_tt_create)(struct ttm_buffer_object *bo,
  69                                         uint32_t page_flags);
  70
  71         /**
  72          * ttm_tt_populate
  73          *
  74          * @ttm: The struct ttm_tt to contain the backing pages.
  75          *
  76          * Allocate all backing pages
  77          * Returns:
  78          * -ENOMEM: Out of memory.
  79          */
  80         int (*ttm_tt_populate)(struct ttm_bo_device *bdev,
  81                                struct ttm_tt *ttm,
  82                                struct ttm_operation_ctx *ctx);
  83
  84         /**
  85          * ttm_tt_unpopulate
  86          *
  87          * @ttm: The struct ttm_tt to contain the backing pages.
  88          *
  89          * Free all backing page
  90          */
  91         void (*ttm_tt_unpopulate)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
  92
  93         /**
  94          * ttm_tt_bind
  95          *
  96          * @bdev: Pointer to a ttm device
  97          * @ttm: Pointer to a struct ttm_tt.
  98          * @bo_mem: Pointer to a struct ttm_resource describing the
  99          * memory type and location for binding.
 100          *
 101          * Bind the backend pages into the aperture in the location
 102          * indicated by @bo_mem. This function should be able to handle
 103          * differences between aperture and system page sizes.
 104          */
 105         int (*ttm_tt_bind)(struct ttm_bo_device *bdev, struct ttm_tt *ttm, struct ttm_resource *bo_mem);
 106
 107         /**
 108          * ttm_tt_unbind
 109          *
 110          * @bdev: Pointer to a ttm device
 111          * @ttm: Pointer to a struct ttm_tt.
 112          *
 113          * Unbind previously bound backend pages. This function should be
 114          * able to handle differences between aperture and system page sizes.
 115          */
 116         void (*ttm_tt_unbind)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
 117
 118         /**
 119          * ttm_tt_destroy
 120          *
 121          * @bdev: Pointer to a ttm device
 122          * @ttm: Pointer to a struct ttm_tt.
 123          *
 124          * Destroy the backend. This will be call back from ttm_tt_destroy so
 125          * don't call ttm_tt_destroy from the callback or infinite loop.
 126          */
 127         void (*ttm_tt_destroy)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
 128
 129         /**
 130          * struct ttm_bo_driver member eviction_valuable
 131          *
 132          * @bo: the buffer object to be evicted
 133          * @place: placement we need room for
 134          *
 135          * Check with the driver if it is valuable to evict a BO to make room
 136          * for a certain placement.
 137          */
 138         bool (*eviction_valuable)(struct ttm_buffer_object *bo,
 139                                   const struct ttm_place *place);
 140         /**
 141          * struct ttm_bo_driver member evict_flags:
 142          *
 143          * @bo: the buffer object to be evicted
 144          *
 145          * Return the bo flags for a buffer which is not mapped to the hardware.
 146          * These will be placed in proposed_flags so that when the move is
 147          * finished, they'll end up in bo->mem.flags
 148          */
 149
 150         void (*evict_flags)(struct ttm_buffer_object *bo,
 151                             struct ttm_placement *placement);
 152
 153         /**
 154          * struct ttm_bo_driver member move:
 155          *
 156          * @bo: the buffer to move
 157          * @evict: whether this motion is evicting the buffer from
 158          * the graphics address space
 159          * @ctx: context for this move with parameters
 160          * @new_mem: the new memory region receiving the buffer
 161          *
 162          * Move a buffer between two memory regions.
 163          */
 164         int (*move)(struct ttm_buffer_object *bo, bool evict,
 165                     struct ttm_operation_ctx *ctx,
 166                     struct ttm_resource *new_mem);
 167
 168         /**
 169          * struct ttm_bo_driver_member verify_access
 170          *
 171          * @bo: Pointer to a buffer object.
 172          * @filp: Pointer to a struct file trying to access the object.
 173          *
 174          * Called from the map / write / read methods to verify that the
 175          * caller is permitted to access the buffer object.
 176          * This member may be set to NULL, which will refuse this kind of
 177          * access for all buffer objects.
 178          * This function should return 0 if access is granted, -EPERM otherwise.
 179          */
 180         int (*verify_access)(struct ttm_buffer_object *bo,
 181                              struct file *filp);
 182
 183         /**
 184          * Hook to notify driver about a driver move so it
 185          * can do tiling things and book-keeping.
 186          *
 187          * @evict: whether this move is evicting the buffer from the graphics
 188          * address space
 189          */
 190         void (*move_notify)(struct ttm_buffer_object *bo,
 191                             bool evict,
 192                             struct ttm_resource *new_mem);
 193
 194         /**
 195          * notify the driver that we're about to swap out this bo
 196          */
 197         void (*swap_notify)(struct ttm_buffer_object *bo);
 198
 199         /**
 200          * Driver callback on when mapping io memory (for bo_move_memcpy
 201          * for instance). TTM will take care to call io_mem_free whenever
 202          * the mapping is not use anymore. io_mem_reserve & io_mem_free
 203          * are balanced.
 204          */
 205         int (*io_mem_reserve)(struct ttm_bo_device *bdev,
 206                               struct ttm_resource *mem);
 207         void (*io_mem_free)(struct ttm_bo_device *bdev,
 208                             struct ttm_resource *mem);
 209
 210         /**
 211          * Return the pfn for a given page_offset inside the BO.
 212          *
 213          * @bo: the BO to look up the pfn for
 214          * @page_offset: the offset to look up
 215          */
 216         unsigned long (*io_mem_pfn)(struct ttm_buffer_object *bo,
 217                                     unsigned long page_offset);
 218
 219         /**
 220          * Read/write memory buffers for ptrace access
 221          *
 222          * @bo: the BO to access
 223          * @offset: the offset from the start of the BO
 224          * @buf: pointer to source/destination buffer
 225          * @len: number of bytes to copy
 226          * @write: whether to read (0) from or write (non-0) to BO
 227          *
 228          * If successful, this function should return the number of
 229          * bytes copied, -EIO otherwise. If the number of bytes
 230          * returned is < len, the function may be called again with
 231          * the remainder of the buffer to copy.
 232          */
 233         int (*access_memory)(struct ttm_buffer_object *bo, unsigned long offset,
 234                              void *buf, int len, int write);
 235
 236         /**
 237          * struct ttm_bo_driver member del_from_lru_notify
 238          *
 239          * @bo: the buffer object deleted from lru
 240          *
 241          * notify driver that a BO was deleted from LRU.
 242          */
 243         void (*del_from_lru_notify)(struct ttm_buffer_object *bo);
 244
 245         /**
 246          * Notify the driver that we're about to release a BO
 247          *
 248          * @bo: BO that is about to be released
 249          *
 250          * Gives the driver a chance to do any cleanup, including
 251          * adding fences that may force a delayed delete
 252          */
 253         void (*release_notify)(struct ttm_buffer_object *bo);
 254 };
 255
 256 /**
 257  * struct ttm_bo_global - Buffer object driver global data.
 258  *
 259  * @dummy_read_page: Pointer to a dummy page used for mapping requests
 260  * of unpopulated pages.
 261  * @shrink: A shrink callback object used for buffer object swap.
 262  * @device_list_mutex: Mutex protecting the device list.
 263  * This mutex is held while traversing the device list for pm options.
 264  * @lru_lock: Spinlock protecting the bo subsystem lru lists.
 265  * @device_list: List of buffer object devices.
 266  * @swap_lru: Lru list of buffer objects used for swapping.
 267  */
 268
 269 extern struct ttm_bo_global {
 270
 271         /**
 272          * Constant after init.
 273          */
 274
 275         struct kobject kobj;
 276         struct page *dummy_read_page;
 277         spinlock_t lru_lock;
 278
 279         /**
 280          * Protected by ttm_global_mutex.
 281          */
 282         struct list_head device_list;
 283
 284         /**
 285          * Protected by the lru_lock.
 286          */
 287         struct list_head swap_lru[TTM_MAX_BO_PRIORITY];
 288
 289         /**
 290          * Internal protection.
 291          */
 292         atomic_t bo_count;
 293 } ttm_bo_glob;
 294
 295
 296 #define TTM_NUM_MEM_TYPES 8
 297
 298 /**
 299  * struct ttm_bo_device - Buffer object driver device-specific data.
 300  *
 301  * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
 302  * @man: An array of resource_managers.
 303  * @vma_manager: Address space manager (pointer)
 304  * lru_lock: Spinlock that protects the buffer+device lru lists and
 305  * ddestroy lists.
 306  * @dev_mapping: A pointer to the struct address_space representing the
 307  * device address space.
 308  * @wq: Work queue structure for the delayed delete workqueue.
 309  * @no_retry: Don't retry allocation if it fails
 310  *
 311  */
 312
 313 struct ttm_bo_device {
 314
 315         /*
 316          * Constant after bo device init / atomic.
 317          */
 318         struct list_head device_list;
 319         struct ttm_bo_driver *driver;
 320         /*
 321          * access via ttm_manager_type.
 322          */
 323         struct ttm_resource_manager sysman;
 324         struct ttm_resource_manager *man_drv[TTM_NUM_MEM_TYPES];
 325         /*
 326          * Protected by internal locks.
 327          */
 328         struct drm_vma_offset_manager *vma_manager;
 329
 330         /*
 331          * Protected by the global:lru lock.
 332          */
 333         struct list_head ddestroy;
 334
 335         /*
 336          * Protected by load / firstopen / lastclose /unload sync.
 337          */
 338
 339         struct address_space *dev_mapping;
 340
 341         /*
 342          * Internal protection.
 343          */
 344
 345         struct delayed_work wq;
 346
 347         bool need_dma32;
 348
 349         bool no_retry;
 350 };
 351
 352 static inline struct ttm_resource_manager *ttm_manager_type(struct ttm_bo_device *bdev,
 353                                                             int mem_type)
 354 {
 355         return bdev->man_drv[mem_type];
 356 }
 357
 358 static inline void ttm_set_driver_manager(struct ttm_bo_device *bdev,
 359                                           int type,
 360                                           struct ttm_resource_manager *manager)
 361 {
 362         bdev->man_drv[type] = manager;
 363 }
 364
 365 /**
 366  * struct ttm_lru_bulk_move_pos
 367  *
 368  * @first: first BO in the bulk move range
 369  * @last: last BO in the bulk move range
 370  *
 371  * Positions for a lru bulk move.
 372  */
 373 struct ttm_lru_bulk_move_pos {
 374         struct ttm_buffer_object *first;
 375         struct ttm_buffer_object *last;
 376 };
 377
 378 /**
 379  * struct ttm_lru_bulk_move
 380  *
 381  * @tt: first/last lru entry for BOs in the TT domain
 382  * @vram: first/last lru entry for BOs in the VRAM domain
 383  * @swap: first/last lru entry for BOs on the swap list
 384  *
 385  * Helper structure for bulk moves on the LRU list.
 386  */
 387 struct ttm_lru_bulk_move {
 388         struct ttm_lru_bulk_move_pos tt[TTM_MAX_BO_PRIORITY];
 389         struct ttm_lru_bulk_move_pos vram[TTM_MAX_BO_PRIORITY];
 390         struct ttm_lru_bulk_move_pos swap[TTM_MAX_BO_PRIORITY];
 391 };
 392
 393 /*
 394  * ttm_bo.c
 395  */
 396
 397 /**
 398  * ttm_bo_mem_space
 399  *
 400  * @bo: Pointer to a struct ttm_buffer_object. the data of which
 401  * we want to allocate space for.
 402  * @proposed_placement: Proposed new placement for the buffer object.
 403  * @mem: A struct ttm_resource.
 404  * @interruptible: Sleep interruptible when sliping.
 405  * @no_wait_gpu: Return immediately if the GPU is busy.
 406  *
 407  * Allocate memory space for the buffer object pointed to by @bo, using
 408  * the placement flags in @mem, potentially evicting other idle buffer objects.
 409  * This function may sleep while waiting for space to become available.
 410  * Returns:
 411  * -EBUSY: No space available (only if no_wait == 1).
 412  * -ENOMEM: Could not allocate memory for the buffer object, either due to
 413  * fragmentation or concurrent allocators.
 414  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
 415  */
 416 int ttm_bo_mem_space(struct ttm_buffer_object *bo,
 417                      struct ttm_placement *placement,
 418                      struct ttm_resource *mem,
 419                      struct ttm_operation_ctx *ctx);
 420
 421 int ttm_bo_device_release(struct ttm_bo_device *bdev);
 422
 423 /**
 424  * ttm_bo_device_init
 425  *
 426  * @bdev: A pointer to a struct ttm_bo_device to initialize.
 427  * @glob: A pointer to an initialized struct ttm_bo_global.
 428  * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
 429  * @mapping: The address space to use for this bo.
 430  * @vma_manager: A pointer to a vma manager.
 431  * @file_page_offset: Offset into the device address space that is available
 432  * for buffer data. This ensures compatibility with other users of the
 433  * address space.
 434  *
 435  * Initializes a struct ttm_bo_device:
 436  * Returns:
 437  * !0: Failure.
 438  */
 439 int ttm_bo_device_init(struct ttm_bo_device *bdev,
 440                        struct ttm_bo_driver *driver,
 441                        struct address_space *mapping,
 442                        struct drm_vma_offset_manager *vma_manager,
 443                        bool need_dma32);
 444
 445 /**
 446  * ttm_bo_unmap_virtual
 447  *
 448  * @bo: tear down the virtual mappings for this BO
 449  */
 450 void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
 451
 452 /**
 453  * ttm_bo_unmap_virtual
 454  *
 455  * @bo: tear down the virtual mappings for this BO
 456  *
 457  * The caller must take ttm_mem_io_lock before calling this function.
 458  */
 459 void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
 460
 461 /**
 462  * ttm_bo_reserve:
 463  *
 464  * @bo: A pointer to a struct ttm_buffer_object.
 465  * @interruptible: Sleep interruptible if waiting.
 466  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
 467  * @ticket: ticket used to acquire the ww_mutex.
 468  *
 469  * Locks a buffer object for validation. (Or prevents other processes from
 470  * locking it for validation), while taking a number of measures to prevent
 471  * deadlocks.
 472  *
 473  * Returns:
 474  * -EDEADLK: The reservation may cause a deadlock.
 475  * Release all buffer reservations, wait for @bo to become unreserved and
 476  * try again.
 477  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
 478  * a signal. Release all buffer reservations and return to user-space.
 479  * -EBUSY: The function needed to sleep, but @no_wait was true
 480  * -EALREADY: Bo already reserved using @ticket. This error code will only
 481  * be returned if @use_ticket is set to true.
 482  */
 483 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
 484                                  bool interruptible, bool no_wait,
 485                                  struct ww_acquire_ctx *ticket)
 486 {
 487         int ret = 0;
 488
 489         if (no_wait) {
 490                 bool success;
 491                 if (WARN_ON(ticket))
 492                         return -EBUSY;
 493
 494                 success = dma_resv_trylock(bo->base.resv);
 495                 return success ? 0 : -EBUSY;
 496         }
 497
 498         if (interruptible)
 499                 ret = dma_resv_lock_interruptible(bo->base.resv, ticket);
 500         else
 501                 ret = dma_resv_lock(bo->base.resv, ticket);
 502         if (ret == -EINTR)
 503                 return -ERESTARTSYS;
 504         return ret;
 505 }
 506
 507 /**
 508  * ttm_bo_reserve_slowpath:
 509  * @bo: A pointer to a struct ttm_buffer_object.
 510  * @interruptible: Sleep interruptible if waiting.
 511  * @sequence: Set (@bo)->sequence to this value after lock
 512  *
 513  * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
 514  * from all our other reservations. Because there are no other reservations
 515  * held by us, this function cannot deadlock any more.
 516  */
 517 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
 518                                           bool interruptible,
 519                                           struct ww_acquire_ctx *ticket)
 520 {
 521         if (interruptible) {
 522                 int ret = dma_resv_lock_slow_interruptible(bo->base.resv,
 523                                                            ticket);
 524                 if (ret == -EINTR)
 525                         ret = -ERESTARTSYS;
 526                 return ret;
 527         }
 528         dma_resv_lock_slow(bo->base.resv, ticket);
 529         return 0;
 530 }
 531
 532 static inline void ttm_bo_move_to_lru_tail_unlocked(struct ttm_buffer_object *bo)
 533 {
 534         spin_lock(&ttm_bo_glob.lru_lock);
 535         ttm_bo_move_to_lru_tail(bo, NULL);
 536         spin_unlock(&ttm_bo_glob.lru_lock);
 537 }
 538
 539 static inline void ttm_bo_assign_mem(struct ttm_buffer_object *bo,
 540                                      struct ttm_resource *new_mem)
 541 {
 542         bo->mem = *new_mem;
 543         new_mem->mm_node = NULL;
 544 }
 545
 546 /**
 547  * ttm_bo_move_null = assign memory for a buffer object.
 548  * @bo: The bo to assign the memory to
 549  * @new_mem: The memory to be assigned.
 550  *
 551  * Assign the memory from new_mem to the memory of the buffer object bo.
 552  */
 553 static inline void ttm_bo_move_null(struct ttm_buffer_object *bo,
 554                                     struct ttm_resource *new_mem)
 555 {
 556         struct ttm_resource *old_mem = &bo->mem;
 557
 558         WARN_ON(old_mem->mm_node != NULL);
 559         ttm_bo_assign_mem(bo, new_mem);
 560 }
 561
 562 /**
 563  * ttm_bo_unreserve
 564  *
 565  * @bo: A pointer to a struct ttm_buffer_object.
 566  *
 567  * Unreserve a previous reservation of @bo.
 568  */
 569 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
 570 {
 571         ttm_bo_move_to_lru_tail_unlocked(bo);
 572         dma_resv_unlock(bo->base.resv);
 573 }
 574
 575 /*
 576  * ttm_bo_util.c
 577  */
 578
 579 int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
 580                        struct ttm_resource *mem);
 581 void ttm_mem_io_free(struct ttm_bo_device *bdev,
 582                      struct ttm_resource *mem);
 583 /**
 584  * ttm_bo_move_ttm
 585  *
 586  * @bo: A pointer to a struct ttm_buffer_object.
 587  * @interruptible: Sleep interruptible if waiting.
 588  * @no_wait_gpu: Return immediately if the GPU is busy.
 589  * @new_mem: struct ttm_resource indicating where to move.
 590  *
 591  * Optimized move function for a buffer object with both old and
 592  * new placement backed by a TTM. The function will, if successful,
 593  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
 594  * and update the (@bo)->mem placement flags. If unsuccessful, the old
 595  * data remains untouched, and it's up to the caller to free the
 596  * memory space indicated by @new_mem.
 597  * Returns:
 598  * !0: Failure.
 599  */
 600
 601 int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
 602                     struct ttm_operation_ctx *ctx,
 603                     struct ttm_resource *new_mem);
 604
 605 /**
 606  * ttm_bo_move_memcpy
 607  *
 608  * @bo: A pointer to a struct ttm_buffer_object.
 609  * @interruptible: Sleep interruptible if waiting.
 610  * @no_wait_gpu: Return immediately if the GPU is busy.
 611  * @new_mem: struct ttm_resource indicating where to move.
 612  *
 613  * Fallback move function for a mappable buffer object in mappable memory.
 614  * The function will, if successful,
 615  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
 616  * and update the (@bo)->mem placement flags. If unsuccessful, the old
 617  * data remains untouched, and it's up to the caller to free the
 618  * memory space indicated by @new_mem.
 619  * Returns:
 620  * !0: Failure.
 621  */
 622
 623 int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
 624                        struct ttm_operation_ctx *ctx,
 625                        struct ttm_resource *new_mem);
 626
 627 /**
 628  * ttm_bo_free_old_node
 629  *
 630  * @bo: A pointer to a struct ttm_buffer_object.
 631  *
 632  * Utility function to free an old placement after a successful move.
 633  */
 634 void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
 635
 636 /**
 637  * ttm_bo_move_accel_cleanup.
 638  *
 639  * @bo: A pointer to a struct ttm_buffer_object.
 640  * @fence: A fence object that signals when moving is complete.
 641  * @evict: This is an evict move. Don't return until the buffer is idle.
 642  * @pipeline: evictions are to be pipelined.
 643  * @new_mem: struct ttm_resource indicating where to move.
 644  *
 645  * Accelerated move function to be called when an accelerated move
 646  * has been scheduled. The function will create a new temporary buffer object
 647  * representing the old placement, and put the sync object on both buffer
 648  * objects. After that the newly created buffer object is unref'd to be
 649  * destroyed when the move is complete. This will help pipeline
 650  * buffer moves.
 651  */
 652 int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
 653                               struct dma_fence *fence, bool evict,
 654                               bool pipeline,
 655                               struct ttm_resource *new_mem);
 656
 657 /**
 658  * ttm_bo_pipeline_gutting.
 659  *
 660  * @bo: A pointer to a struct ttm_buffer_object.
 661  *
 662  * Pipelined gutting a BO of its backing store.
 663  */
 664 int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo);
 665
 666 /**
 667  * ttm_io_prot
 668  *
 669  * @c_state: Caching state.
 670  * @tmp: Page protection flag for a normal, cached mapping.
 671  *
 672  * Utility function that returns the pgprot_t that should be used for
 673  * setting up a PTE with the caching model indicated by @c_state.
 674  */
 675 pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
 676
 677 /**
 678  * ttm_bo_tt_bind
 679  *
 680  * Bind the object tt to a memory resource.
 681  */
 682 int ttm_bo_tt_bind(struct ttm_buffer_object *bo, struct ttm_resource *mem);
 683
 684 /**
 685  * ttm_bo_tt_bind
 686  *
 687  * Unbind the object tt from a memory resource.
 688  */
 689 void ttm_bo_tt_unbind(struct ttm_buffer_object *bo);
 690
 691 /**
 692  * ttm_bo_tt_destroy.
 693  */
 694 void ttm_bo_tt_destroy(struct ttm_buffer_object *bo);
 695
 696 /**
 697  * ttm_range_man_init
 698  *
 699  * @bdev: ttm device
 700  * @type: memory manager type
 701  * @use_tt: if the memory manager uses tt
 702  * @p_size: size of area to be managed in pages.
 703  *
 704  * Initialise a generic range manager for the selected memory type.
 705  * The range manager is installed for this device in the type slot.
 706  */
 707 int ttm_range_man_init(struct ttm_bo_device *bdev,
 708                        unsigned type, bool use_tt,
 709                        unsigned long p_size);
 710
 711 /**
 712  * ttm_range_man_fini
 713  *
 714  * @bdev: ttm device
 715  * @type: memory manager type
 716  *
 717  * Remove the generic range manager from a slot and tear it down.
 718  */
 719 int ttm_range_man_fini(struct ttm_bo_device *bdev,
 720                        unsigned type);
 721
 722 #endif