include/drm/ttm/ttm_bo_api.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
  31 #ifndef _TTM_BO_API_H_
  32 #define _TTM_BO_API_H_
  33
  34 #include <drm/drm_hashtab.h>
  35 #include <drm/drm_vma_manager.h>
  36 #include <linux/kref.h>
  37 #include <linux/list.h>
  38 #include <linux/wait.h>
  39 #include <linux/mutex.h>
  40 #include <linux/mm.h>
  41 #include <linux/bitmap.h>
  42 #include <linux/reservation.h>
  43
  44 struct ttm_bo_device;
  45
  46 struct drm_mm_node;
  47
  48 struct ttm_placement;
  49
  50 struct ttm_place;
  51
  52 /**
  53  * struct ttm_bus_placement
  54  *
  55  * @addr:               mapped virtual address
  56  * @base:               bus base address
  57  * @is_iomem:           is this io memory ?
  58  * @size:               size in byte
  59  * @offset:             offset from the base address
  60  * @io_reserved_vm:     The VM system has a refcount in @io_reserved_count
  61  * @io_reserved_count:  Refcounting the numbers of callers to ttm_mem_io_reserve
  62  *
  63  * Structure indicating the bus placement of an object.
  64  */
  65 struct ttm_bus_placement {
  66         void            *addr;
  67         phys_addr_t     base;
  68         unsigned long   size;
  69         unsigned long   offset;
  70         bool            is_iomem;
  71         bool            io_reserved_vm;
  72         uint64_t        io_reserved_count;
  73 };
  74
  75
  76 /**
  77  * struct ttm_mem_reg
  78  *
  79  * @mm_node: Memory manager node.
  80  * @size: Requested size of memory region.
  81  * @num_pages: Actual size of memory region in pages.
  82  * @page_alignment: Page alignment.
  83  * @placement: Placement flags.
  84  * @bus: Placement on io bus accessible to the CPU
  85  *
  86  * Structure indicating the placement and space resources used by a
  87  * buffer object.
  88  */
  89
  90 struct ttm_mem_reg {
  91         void *mm_node;
  92         unsigned long start;
  93         unsigned long size;
  94         unsigned long num_pages;
  95         uint32_t page_alignment;
  96         uint32_t mem_type;
  97         uint32_t placement;
  98         struct ttm_bus_placement bus;
  99 };
 100
 101 /**
 102  * enum ttm_bo_type
 103  *
 104  * @ttm_bo_type_device: These are 'normal' buffers that can
 105  * be mmapped by user space. Each of these bos occupy a slot in the
 106  * device address space, that can be used for normal vm operations.
 107  *
 108  * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
 109  * but they cannot be accessed from user-space. For kernel-only use.
 110  *
 111  * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
 112  * driver.
 113  */
 114
 115 enum ttm_bo_type {
 116         ttm_bo_type_device,
 117         ttm_bo_type_kernel,
 118         ttm_bo_type_sg
 119 };
 120
 121 struct ttm_tt;
 122
 123 /**
 124  * struct ttm_buffer_object
 125  *
 126  * @bdev: Pointer to the buffer object device structure.
 127  * @type: The bo type.
 128  * @destroy: Destruction function. If NULL, kfree is used.
 129  * @num_pages: Actual number of pages.
 130  * @acc_size: Accounted size for this object.
 131  * @kref: Reference count of this buffer object. When this refcount reaches
 132  * zero, the object is put on the delayed delete list.
 133  * @list_kref: List reference count of this buffer object. This member is
 134  * used to avoid destruction while the buffer object is still on a list.
 135  * Lru lists may keep one refcount, the delayed delete list, and kref != 0
 136  * keeps one refcount. When this refcount reaches zero,
 137  * the object is destroyed.
 138  * @mem: structure describing current placement.
 139  * @persistent_swap_storage: Usually the swap storage is deleted for buffers
 140  * pinned in physical memory. If this behaviour is not desired, this member
 141  * holds a pointer to a persistent shmem object.
 142  * @ttm: TTM structure holding system pages.
 143  * @evicted: Whether the object was evicted without user-space knowing.
 144  * @cpu_writes: For synchronization. Number of cpu writers.
 145  * @lru: List head for the lru list.
 146  * @ddestroy: List head for the delayed destroy list.
 147  * @swap: List head for swap LRU list.
 148  * @moving: Fence set when BO is moving
 149  * @vma_node: Address space manager node.
 150  * @offset: The current GPU offset, which can have different meanings
 151  * depending on the memory type. For SYSTEM type memory, it should be 0.
 152  * @cur_placement: Hint of current placement.
 153  * @wu_mutex: Wait unreserved mutex.
 154  *
 155  * Base class for TTM buffer object, that deals with data placement and CPU
 156  * mappings. GPU mappings are really up to the driver, but for simpler GPUs
 157  * the driver can usually use the placement offset @offset directly as the
 158  * GPU virtual address. For drivers implementing multiple
 159  * GPU memory manager contexts, the driver should manage the address space
 160  * in these contexts separately and use these objects to get the correct
 161  * placement and caching for these GPU maps. This makes it possible to use
 162  * these objects for even quite elaborate memory management schemes.
 163  * The destroy member, the API visibility of this object makes it possible
 164  * to derive driver specific types.
 165  */
 166
 167 struct ttm_buffer_object {
 168         /**
 169          * Members constant at init.
 170          */
 171
 172         struct ttm_bo_global *glob;
 173         struct ttm_bo_device *bdev;
 174         enum ttm_bo_type type;
 175         void (*destroy) (struct ttm_buffer_object *);
 176         unsigned long num_pages;
 177         size_t acc_size;
 178
 179         /**
 180         * Members not needing protection.
 181         */
 182
 183         struct kref kref;
 184         struct kref list_kref;
 185
 186         /**
 187          * Members protected by the bo::resv::reserved lock.
 188          */
 189
 190         struct ttm_mem_reg mem;
 191         struct file *persistent_swap_storage;
 192         struct ttm_tt *ttm;
 193         bool evicted;
 194
 195         /**
 196          * Members protected by the bo::reserved lock only when written to.
 197          */
 198
 199         atomic_t cpu_writers;
 200
 201         /**
 202          * Members protected by the bdev::lru_lock.
 203          */
 204
 205         struct list_head lru;
 206         struct list_head ddestroy;
 207         struct list_head swap;
 208         struct list_head io_reserve_lru;
 209
 210         /**
 211          * Members protected by a bo reservation.
 212          */
 213
 214         struct dma_fence *moving;
 215
 216         struct drm_vma_offset_node vma_node;
 217
 218         unsigned priority;
 219
 220         /**
 221          * Special members that are protected by the reserve lock
 222          * and the bo::lock when written to. Can be read with
 223          * either of these locks held.
 224          */
 225
 226         uint64_t offset; /* GPU address space is independent of CPU word size */
 227
 228         struct sg_table *sg;
 229
 230         struct reservation_object *resv;
 231         struct reservation_object ttm_resv;
 232         struct mutex wu_mutex;
 233 };
 234
 235 /**
 236  * struct ttm_bo_kmap_obj
 237  *
 238  * @virtual: The current kernel virtual address.
 239  * @page: The page when kmap'ing a single page.
 240  * @bo_kmap_type: Type of bo_kmap.
 241  *
 242  * Object describing a kernel mapping. Since a TTM bo may be located
 243  * in various memory types with various caching policies, the
 244  * mapping can either be an ioremap, a vmap, a kmap or part of a
 245  * premapped region.
 246  */
 247
 248 #define TTM_BO_MAP_IOMEM_MASK 0x80
 249 struct ttm_bo_kmap_obj {
 250         void *virtual;
 251         struct page *page;
 252         enum {
 253                 ttm_bo_map_iomap        = 1 | TTM_BO_MAP_IOMEM_MASK,
 254                 ttm_bo_map_vmap         = 2,
 255                 ttm_bo_map_kmap         = 3,
 256                 ttm_bo_map_premapped    = 4 | TTM_BO_MAP_IOMEM_MASK,
 257         } bo_kmap_type;
 258         struct ttm_buffer_object *bo;
 259 };
 260
 261 /**
 262  * struct ttm_operation_ctx
 263  *
 264  * @interruptible: Sleep interruptible if sleeping.
 265  * @no_wait_gpu: Return immediately if the GPU is busy.
 266  * @resv: Reservation object to allow reserved evictions with.
 267  * @flags: Including the following flags
 268  *
 269  * Context for TTM operations like changing buffer placement or general memory
 270  * allocation.
 271  */
 272 struct ttm_operation_ctx {
 273         bool interruptible;
 274         bool no_wait_gpu;
 275         struct reservation_object *resv;
 276         uint64_t bytes_moved;
 277         uint32_t flags;
 278 };
 279
 280 /* Allow eviction of reserved BOs */
 281 #define TTM_OPT_FLAG_ALLOW_RES_EVICT    0x1
 282
 283 /**
 284  * ttm_bo_reference - reference a struct ttm_buffer_object
 285  *
 286  * @bo: The buffer object.
 287  *
 288  * Returns a refcounted pointer to a buffer object.
 289  */
 290
 291 static inline struct ttm_buffer_object *
 292 ttm_bo_reference(struct ttm_buffer_object *bo)
 293 {
 294         kref_get(&bo->kref);
 295         return bo;
 296 }
 297
 298 /**
 299  * ttm_bo_wait - wait for buffer idle.
 300  *
 301  * @bo:  The buffer object.
 302  * @interruptible:  Use interruptible wait.
 303  * @no_wait:  Return immediately if buffer is busy.
 304  *
 305  * This function must be called with the bo::mutex held, and makes
 306  * sure any previous rendering to the buffer is completed.
 307  * Note: It might be necessary to block validations before the
 308  * wait by reserving the buffer.
 309  * Returns -EBUSY if no_wait is true and the buffer is busy.
 310  * Returns -ERESTARTSYS if interrupted by a signal.
 311  */
 312 int ttm_bo_wait(struct ttm_buffer_object *bo, bool interruptible, bool no_wait);
 313
 314 /**
 315  * ttm_bo_mem_compat - Check if proposed placement is compatible with a bo
 316  *
 317  * @placement:  Return immediately if buffer is busy.
 318  * @mem:  The struct ttm_mem_reg indicating the region where the bo resides
 319  * @new_flags: Describes compatible placement found
 320  *
 321  * Returns true if the placement is compatible
 322  */
 323 bool ttm_bo_mem_compat(struct ttm_placement *placement, struct ttm_mem_reg *mem,
 324                        uint32_t *new_flags);
 325
 326 /**
 327  * ttm_bo_validate
 328  *
 329  * @bo: The buffer object.
 330  * @placement: Proposed placement for the buffer object.
 331  * @ctx: validation parameters.
 332  *
 333  * Changes placement and caching policy of the buffer object
 334  * according proposed placement.
 335  * Returns
 336  * -EINVAL on invalid proposed placement.
 337  * -ENOMEM on out-of-memory condition.
 338  * -EBUSY if no_wait is true and buffer busy.
 339  * -ERESTARTSYS if interrupted by a signal.
 340  */
 341 int ttm_bo_validate(struct ttm_buffer_object *bo,
 342                     struct ttm_placement *placement,
 343                     struct ttm_operation_ctx *ctx);
 344
 345 /**
 346  * ttm_bo_unref
 347  *
 348  * @bo: The buffer object.
 349  *
 350  * Unreference and clear a pointer to a buffer object.
 351  */
 352 void ttm_bo_unref(struct ttm_buffer_object **bo);
 353
 354 /**
 355  * ttm_bo_add_to_lru
 356  *
 357  * @bo: The buffer object.
 358  *
 359  * Add this bo to the relevant mem type lru and, if it's backed by
 360  * system pages (ttms) to the swap list.
 361  * This function must be called with struct ttm_bo_global::lru_lock held, and
 362  * is typically called immediately prior to unreserving a bo.
 363  */
 364 void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
 365
 366 /**
 367  * ttm_bo_del_from_lru
 368  *
 369  * @bo: The buffer object.
 370  *
 371  * Remove this bo from all lru lists used to lookup and reserve an object.
 372  * This function must be called with struct ttm_bo_global::lru_lock held,
 373  * and is usually called just immediately after the bo has been reserved to
 374  * avoid recursive reservation from lru lists.
 375  */
 376 void ttm_bo_del_from_lru(struct ttm_buffer_object *bo);
 377
 378 /**
 379  * ttm_bo_move_to_lru_tail
 380  *
 381  * @bo: The buffer object.
 382  *
 383  * Move this BO to the tail of all lru lists used to lookup and reserve an
 384  * object. This function must be called with struct ttm_bo_global::lru_lock
 385  * held, and is used to make a BO less likely to be considered for eviction.
 386  */
 387 void ttm_bo_move_to_lru_tail(struct ttm_buffer_object *bo);
 388
 389 /**
 390  * ttm_bo_lock_delayed_workqueue
 391  *
 392  * Prevent the delayed workqueue from running.
 393  * Returns
 394  * True if the workqueue was queued at the time
 395  */
 396 int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev);
 397
 398 /**
 399  * ttm_bo_unlock_delayed_workqueue
 400  *
 401  * Allows the delayed workqueue to run.
 402  */
 403 void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev, int resched);
 404
 405 /**
 406  * ttm_bo_eviction_valuable
 407  *
 408  * @bo: The buffer object to evict
 409  * @place: the placement we need to make room for
 410  *
 411  * Check if it is valuable to evict the BO to make room for the given placement.
 412  */
 413 bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
 414                               const struct ttm_place *place);
 415
 416 /**
 417  * ttm_bo_synccpu_write_grab
 418  *
 419  * @bo: The buffer object:
 420  * @no_wait: Return immediately if buffer is busy.
 421  *
 422  * Synchronizes a buffer object for CPU RW access. This means
 423  * command submission that affects the buffer will return -EBUSY
 424  * until ttm_bo_synccpu_write_release is called.
 425  *
 426  * Returns
 427  * -EBUSY if the buffer is busy and no_wait is true.
 428  * -ERESTARTSYS if interrupted by a signal.
 429  */
 430 int ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
 431
 432 /**
 433  * ttm_bo_synccpu_write_release:
 434  *
 435  * @bo : The buffer object.
 436  *
 437  * Releases a synccpu lock.
 438  */
 439 void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
 440
 441 /**
 442  * ttm_bo_acc_size
 443  *
 444  * @bdev: Pointer to a ttm_bo_device struct.
 445  * @bo_size: size of the buffer object in byte.
 446  * @struct_size: size of the structure holding buffer object datas
 447  *
 448  * Returns size to account for a buffer object
 449  */
 450 size_t ttm_bo_acc_size(struct ttm_bo_device *bdev,
 451                        unsigned long bo_size,
 452                        unsigned struct_size);
 453 size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev,
 454                            unsigned long bo_size,
 455                            unsigned struct_size);
 456
 457 /**
 458  * ttm_bo_init_reserved
 459  *
 460  * @bdev: Pointer to a ttm_bo_device struct.
 461  * @bo: Pointer to a ttm_buffer_object to be initialized.
 462  * @size: Requested size of buffer object.
 463  * @type: Requested type of buffer object.
 464  * @flags: Initial placement flags.
 465  * @page_alignment: Data alignment in pages.
 466  * @ctx: TTM operation context for memory allocation.
 467  * @persistent_swap_storage: Usually the swap storage is deleted for buffers
 468  * pinned in physical memory. If this behaviour is not desired, this member
 469  * holds a pointer to a persistent shmem object. Typically, this would
 470  * point to the shmem object backing a GEM object if TTM is used to back a
 471  * GEM user interface.
 472  * @acc_size: Accounted size for this object.
 473  * @resv: Pointer to a reservation_object, or NULL to let ttm allocate one.
 474  * @destroy: Destroy function. Use NULL for kfree().
 475  *
 476  * This function initializes a pre-allocated struct ttm_buffer_object.
 477  * As this object may be part of a larger structure, this function,
 478  * together with the @destroy function,
 479  * enables driver-specific objects derived from a ttm_buffer_object.
 480  *
 481  * On successful return, the caller owns an object kref to @bo. The kref and
 482  * list_kref are usually set to 1, but note that in some situations, other
 483  * tasks may already be holding references to @bo as well.
 484  * Furthermore, if resv == NULL, the buffer's reservation lock will be held,
 485  * and it is the caller's responsibility to call ttm_bo_unreserve.
 486  *
 487  * If a failure occurs, the function will call the @destroy function, or
 488  * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
 489  * illegal and will likely cause memory corruption.
 490  *
 491  * Returns
 492  * -ENOMEM: Out of memory.
 493  * -EINVAL: Invalid placement flags.
 494  * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
 495  */
 496
 497 int ttm_bo_init_reserved(struct ttm_bo_device *bdev,
 498                          struct ttm_buffer_object *bo,
 499                          unsigned long size,
 500                          enum ttm_bo_type type,
 501                          struct ttm_placement *placement,
 502                          uint32_t page_alignment,
 503                          struct ttm_operation_ctx *ctx,
 504                          struct file *persistent_swap_storage,
 505                          size_t acc_size,
 506                          struct sg_table *sg,
 507                          struct reservation_object *resv,
 508                          void (*destroy) (struct ttm_buffer_object *));
 509
 510 /**
 511  * ttm_bo_init
 512  *
 513  * @bdev: Pointer to a ttm_bo_device struct.
 514  * @bo: Pointer to a ttm_buffer_object to be initialized.
 515  * @size: Requested size of buffer object.
 516  * @type: Requested type of buffer object.
 517  * @flags: Initial placement flags.
 518  * @page_alignment: Data alignment in pages.
 519  * @interruptible: If needing to sleep to wait for GPU resources,
 520  * sleep interruptible.
 521  * @persistent_swap_storage: Usually the swap storage is deleted for buffers
 522  * pinned in physical memory. If this behaviour is not desired, this member
 523  * holds a pointer to a persistent shmem object. Typically, this would
 524  * point to the shmem object backing a GEM object if TTM is used to back a
 525  * GEM user interface.
 526  * @acc_size: Accounted size for this object.
 527  * @resv: Pointer to a reservation_object, or NULL to let ttm allocate one.
 528  * @destroy: Destroy function. Use NULL for kfree().
 529  *
 530  * This function initializes a pre-allocated struct ttm_buffer_object.
 531  * As this object may be part of a larger structure, this function,
 532  * together with the @destroy function,
 533  * enables driver-specific objects derived from a ttm_buffer_object.
 534  *
 535  * On successful return, the caller owns an object kref to @bo. The kref and
 536  * list_kref are usually set to 1, but note that in some situations, other
 537  * tasks may already be holding references to @bo as well.
 538  *
 539  * If a failure occurs, the function will call the @destroy function, or
 540  * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
 541  * illegal and will likely cause memory corruption.
 542  *
 543  * Returns
 544  * -ENOMEM: Out of memory.
 545  * -EINVAL: Invalid placement flags.
 546  * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
 547  */
 548 int ttm_bo_init(struct ttm_bo_device *bdev, struct ttm_buffer_object *bo,
 549                 unsigned long size, enum ttm_bo_type type,
 550                 struct ttm_placement *placement,
 551                 uint32_t page_alignment, bool interrubtible,
 552                 struct file *persistent_swap_storage, size_t acc_size,
 553                 struct sg_table *sg, struct reservation_object *resv,
 554                 void (*destroy) (struct ttm_buffer_object *));
 555
 556 /**
 557  * ttm_bo_create
 558  *
 559  * @bdev: Pointer to a ttm_bo_device struct.
 560  * @size: Requested size of buffer object.
 561  * @type: Requested type of buffer object.
 562  * @placement: Initial placement.
 563  * @page_alignment: Data alignment in pages.
 564  * @interruptible: If needing to sleep while waiting for GPU resources,
 565  * sleep interruptible.
 566  * @persistent_swap_storage: Usually the swap storage is deleted for buffers
 567  * pinned in physical memory. If this behaviour is not desired, this member
 568  * holds a pointer to a persistent shmem object. Typically, this would
 569  * point to the shmem object backing a GEM object if TTM is used to back a
 570  * GEM user interface.
 571  * @p_bo: On successful completion *p_bo points to the created object.
 572  *
 573  * This function allocates a ttm_buffer_object, and then calls ttm_bo_init
 574  * on that object. The destroy function is set to kfree().
 575  * Returns
 576  * -ENOMEM: Out of memory.
 577  * -EINVAL: Invalid placement flags.
 578  * -ERESTARTSYS: Interrupted by signal while waiting for resources.
 579  */
 580 int ttm_bo_create(struct ttm_bo_device *bdev, unsigned long size,
 581                   enum ttm_bo_type type, struct ttm_placement *placement,
 582                   uint32_t page_alignment, bool interruptible,
 583                   struct file *persistent_swap_storage,
 584                   struct ttm_buffer_object **p_bo);
 585
 586 /**
 587  * ttm_bo_init_mm
 588  *
 589  * @bdev: Pointer to a ttm_bo_device struct.
 590  * @mem_type: The memory type.
 591  * @p_size: size managed area in pages.
 592  *
 593  * Initialize a manager for a given memory type.
 594  * Note: if part of driver firstopen, it must be protected from a
 595  * potentially racing lastclose.
 596  * Returns:
 597  * -EINVAL: invalid size or memory type.
 598  * -ENOMEM: Not enough memory.
 599  * May also return driver-specified errors.
 600  */
 601 int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
 602                    unsigned long p_size);
 603
 604 /**
 605  * ttm_bo_clean_mm
 606  *
 607  * @bdev: Pointer to a ttm_bo_device struct.
 608  * @mem_type: The memory type.
 609  *
 610  * Take down a manager for a given memory type after first walking
 611  * the LRU list to evict any buffers left alive.
 612  *
 613  * Normally, this function is part of lastclose() or unload(), and at that
 614  * point there shouldn't be any buffers left created by user-space, since
 615  * there should've been removed by the file descriptor release() method.
 616  * However, before this function is run, make sure to signal all sync objects,
 617  * and verify that the delayed delete queue is empty. The driver must also
 618  * make sure that there are no NO_EVICT buffers present in this memory type
 619  * when the call is made.
 620  *
 621  * If this function is part of a VT switch, the caller must make sure that
 622  * there are no appications currently validating buffers before this
 623  * function is called. The caller can do that by first taking the
 624  * struct ttm_bo_device::ttm_lock in write mode.
 625  *
 626  * Returns:
 627  * -EINVAL: invalid or uninitialized memory type.
 628  * -EBUSY: There are still buffers left in this memory type.
 629  */
 630 int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
 631
 632 /**
 633  * ttm_bo_evict_mm
 634  *
 635  * @bdev: Pointer to a ttm_bo_device struct.
 636  * @mem_type: The memory type.
 637  *
 638  * Evicts all buffers on the lru list of the memory type.
 639  * This is normally part of a VT switch or an
 640  * out-of-memory-space-due-to-fragmentation handler.
 641  * The caller must make sure that there are no other processes
 642  * currently validating buffers, and can do that by taking the
 643  * struct ttm_bo_device::ttm_lock in write mode.
 644  *
 645  * Returns:
 646  * -EINVAL: Invalid or uninitialized memory type.
 647  * -ERESTARTSYS: The call was interrupted by a signal while waiting to
 648  * evict a buffer.
 649  */
 650 int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
 651
 652 /**
 653  * ttm_kmap_obj_virtual
 654  *
 655  * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
 656  * @is_iomem: Pointer to an integer that on return indicates 1 if the
 657  * virtual map is io memory, 0 if normal memory.
 658  *
 659  * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
 660  * If *is_iomem is 1 on return, the virtual address points to an io memory area,
 661  * that should strictly be accessed by the iowriteXX() and similar functions.
 662  */
 663 static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
 664                                          bool *is_iomem)
 665 {
 666         *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
 667         return map->virtual;
 668 }
 669
 670 /**
 671  * ttm_bo_kmap
 672  *
 673  * @bo: The buffer object.
 674  * @start_page: The first page to map.
 675  * @num_pages: Number of pages to map.
 676  * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
 677  *
 678  * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
 679  * data in the buffer object. The ttm_kmap_obj_virtual function can then be
 680  * used to obtain a virtual address to the data.
 681  *
 682  * Returns
 683  * -ENOMEM: Out of memory.
 684  * -EINVAL: Invalid range.
 685  */
 686 int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
 687                 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
 688
 689 /**
 690  * ttm_bo_kunmap
 691  *
 692  * @map: Object describing the map to unmap.
 693  *
 694  * Unmaps a kernel map set up by ttm_bo_kmap.
 695  */
 696 void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
 697
 698 /**
 699  * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
 700  *
 701  * @vma:       vma as input from the fbdev mmap method.
 702  * @bo:        The bo backing the address space. The address space will
 703  * have the same size as the bo, and start at offset 0.
 704  *
 705  * This function is intended to be called by the fbdev mmap method
 706  * if the fbdev address space is to be backed by a bo.
 707  */
 708 int ttm_fbdev_mmap(struct vm_area_struct *vma, struct ttm_buffer_object *bo);
 709
 710 /**
 711  * ttm_bo_mmap - mmap out of the ttm device address space.
 712  *
 713  * @filp:      filp as input from the mmap method.
 714  * @vma:       vma as input from the mmap method.
 715  * @bdev:      Pointer to the ttm_bo_device with the address space manager.
 716  *
 717  * This function is intended to be called by the device mmap method.
 718  * if the device address space is to be backed by the bo manager.
 719  */
 720 int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
 721                 struct ttm_bo_device *bdev);
 722
 723 /**
 724  * ttm_bo_io
 725  *
 726  * @bdev:      Pointer to the struct ttm_bo_device.
 727  * @filp:      Pointer to the struct file attempting to read / write.
 728  * @wbuf:      User-space pointer to address of buffer to write. NULL on read.
 729  * @rbuf:      User-space pointer to address of buffer to read into.
 730  * Null on write.
 731  * @count:     Number of bytes to read / write.
 732  * @f_pos:     Pointer to current file position.
 733  * @write:     1 for read, 0 for write.
 734  *
 735  * This function implements read / write into ttm buffer objects, and is
 736  * intended to
 737  * be called from the fops::read and fops::write method.
 738  * Returns:
 739  * See man (2) write, man(2) read. In particular,
 740  * the function may return -ERESTARTSYS if
 741  * interrupted by a signal.
 742  */
 743 ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
 744                   const char __user *wbuf, char __user *rbuf,
 745                   size_t count, loff_t *f_pos, bool write);
 746
 747 int ttm_bo_swapout(struct ttm_bo_global *glob,
 748                         struct ttm_operation_ctx *ctx);
 749 void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
 750 int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo);
 751 #endif