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