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