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