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