gro: Allow tunnel stacking in the case of FOU/GUE
[linux/fpc-iii.git] / include / drm / ttm / ttm_bo_api.h
blobb7bfa513e6ed5cbd0ff615201391905b735d0c5f
1 /**************************************************************************
3 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
4 * All Rights Reserved.
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:
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.
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.
26 **************************************************************************/
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
31 #ifndef _TTM_BO_API_H_
32 #define _TTM_BO_API_H_
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>
44 struct ttm_bo_device;
46 struct drm_mm_node;
48 /**
49 * struct ttm_place
51 * @fpfn: first valid page frame number to put the object
52 * @lpfn: last valid page frame number to put the object
53 * @flags: memory domain and caching flags for the object
55 * Structure indicating a possible place to put an object.
57 struct ttm_place {
58 unsigned fpfn;
59 unsigned lpfn;
60 uint32_t flags;
63 /**
64 * struct ttm_placement
66 * @num_placement: number of preferred placements
67 * @placement: preferred placements
68 * @num_busy_placement: number of preferred placements when need to evict buffer
69 * @busy_placement: preferred placements when need to evict buffer
71 * Structure indicating the placement you request for an object.
73 struct ttm_placement {
74 unsigned num_placement;
75 const struct ttm_place *placement;
76 unsigned num_busy_placement;
77 const struct ttm_place *busy_placement;
80 /**
81 * struct ttm_bus_placement
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
91 * Structure indicating the bus placement of an object.
93 struct 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;
105 * struct ttm_mem_reg
107 * @mm_node: Memory manager node.
108 * @size: Requested size of memory region.
109 * @num_pages: Actual size of memory region in pages.
110 * @page_alignment: Page alignment.
111 * @placement: Placement flags.
112 * @bus: Placement on io bus accessible to the CPU
114 * Structure indicating the placement and space resources used by a
115 * buffer object.
118 struct ttm_mem_reg {
119 void *mm_node;
120 unsigned long start;
121 unsigned long size;
122 unsigned long num_pages;
123 uint32_t page_alignment;
124 uint32_t mem_type;
125 uint32_t placement;
126 struct ttm_bus_placement bus;
130 * enum ttm_bo_type
132 * @ttm_bo_type_device: These are 'normal' buffers that can
133 * be mmapped by user space. Each of these bos occupy a slot in the
134 * device address space, that can be used for normal vm operations.
136 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
137 * but they cannot be accessed from user-space. For kernel-only use.
139 * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
140 * driver.
143 enum ttm_bo_type {
144 ttm_bo_type_device,
145 ttm_bo_type_kernel,
146 ttm_bo_type_sg
149 struct ttm_tt;
152 * struct ttm_buffer_object
154 * @bdev: Pointer to the buffer object device structure.
155 * @type: The bo type.
156 * @destroy: Destruction function. If NULL, kfree is used.
157 * @num_pages: Actual number of pages.
158 * @acc_size: Accounted size for this object.
159 * @kref: Reference count of this buffer object. When this refcount reaches
160 * zero, the object is put on the delayed delete list.
161 * @list_kref: List reference count of this buffer object. This member is
162 * used to avoid destruction while the buffer object is still on a list.
163 * Lru lists may keep one refcount, the delayed delete list, and kref != 0
164 * keeps one refcount. When this refcount reaches zero,
165 * the object is destroyed.
166 * @mem: structure describing current placement.
167 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
168 * pinned in physical memory. If this behaviour is not desired, this member
169 * holds a pointer to a persistent shmem object.
170 * @ttm: TTM structure holding system pages.
171 * @evicted: Whether the object was evicted without user-space knowing.
172 * @cpu_writes: For synchronization. Number of cpu writers.
173 * @lru: List head for the lru list.
174 * @ddestroy: List head for the delayed destroy list.
175 * @swap: List head for swap LRU list.
176 * @priv_flags: Flags describing buffer object internal state.
177 * @vma_node: Address space manager node.
178 * @offset: The current GPU offset, which can have different meanings
179 * depending on the memory type. For SYSTEM type memory, it should be 0.
180 * @cur_placement: Hint of current placement.
181 * @wu_mutex: Wait unreserved mutex.
183 * Base class for TTM buffer object, that deals with data placement and CPU
184 * mappings. GPU mappings are really up to the driver, but for simpler GPUs
185 * the driver can usually use the placement offset @offset directly as the
186 * GPU virtual address. For drivers implementing multiple
187 * GPU memory manager contexts, the driver should manage the address space
188 * in these contexts separately and use these objects to get the correct
189 * placement and caching for these GPU maps. This makes it possible to use
190 * these objects for even quite elaborate memory management schemes.
191 * The destroy member, the API visibility of this object makes it possible
192 * to derive driver specific types.
195 struct ttm_buffer_object {
197 * Members constant at init.
200 struct ttm_bo_global *glob;
201 struct ttm_bo_device *bdev;
202 enum ttm_bo_type type;
203 void (*destroy) (struct ttm_buffer_object *);
204 unsigned long num_pages;
205 size_t acc_size;
208 * Members not needing protection.
211 struct kref kref;
212 struct kref list_kref;
215 * Members protected by the bo::resv::reserved lock.
218 struct ttm_mem_reg mem;
219 struct file *persistent_swap_storage;
220 struct ttm_tt *ttm;
221 bool evicted;
224 * Members protected by the bo::reserved lock only when written to.
227 atomic_t cpu_writers;
230 * Members protected by the bdev::lru_lock.
233 struct list_head lru;
234 struct list_head ddestroy;
235 struct list_head swap;
236 struct list_head io_reserve_lru;
239 * Members protected by a bo reservation.
242 unsigned long priv_flags;
244 struct drm_vma_offset_node vma_node;
247 * Special members that are protected by the reserve lock
248 * and the bo::lock when written to. Can be read with
249 * either of these locks held.
252 uint64_t offset; /* GPU address space is independent of CPU word size */
253 uint32_t cur_placement;
255 struct sg_table *sg;
257 struct reservation_object *resv;
258 struct reservation_object ttm_resv;
259 struct mutex wu_mutex;
263 * struct ttm_bo_kmap_obj
265 * @virtual: The current kernel virtual address.
266 * @page: The page when kmap'ing a single page.
267 * @bo_kmap_type: Type of bo_kmap.
269 * Object describing a kernel mapping. Since a TTM bo may be located
270 * in various memory types with various caching policies, the
271 * mapping can either be an ioremap, a vmap, a kmap or part of a
272 * premapped region.
275 #define TTM_BO_MAP_IOMEM_MASK 0x80
276 struct ttm_bo_kmap_obj {
277 void *virtual;
278 struct page *page;
279 enum {
280 ttm_bo_map_iomap = 1 | TTM_BO_MAP_IOMEM_MASK,
281 ttm_bo_map_vmap = 2,
282 ttm_bo_map_kmap = 3,
283 ttm_bo_map_premapped = 4 | TTM_BO_MAP_IOMEM_MASK,
284 } bo_kmap_type;
285 struct ttm_buffer_object *bo;
289 * ttm_bo_reference - reference a struct ttm_buffer_object
291 * @bo: The buffer object.
293 * Returns a refcounted pointer to a buffer object.
296 static inline struct ttm_buffer_object *
297 ttm_bo_reference(struct ttm_buffer_object *bo)
299 kref_get(&bo->kref);
300 return bo;
304 * ttm_bo_wait - wait for buffer idle.
306 * @bo: The buffer object.
307 * @interruptible: Use interruptible wait.
308 * @no_wait: Return immediately if buffer is busy.
310 * This function must be called with the bo::mutex held, and makes
311 * sure any previous rendering to the buffer is completed.
312 * Note: It might be necessary to block validations before the
313 * wait by reserving the buffer.
314 * Returns -EBUSY if no_wait is true and the buffer is busy.
315 * Returns -ERESTARTSYS if interrupted by a signal.
317 extern int ttm_bo_wait(struct ttm_buffer_object *bo, bool lazy,
318 bool interruptible, bool no_wait);
321 * ttm_bo_mem_compat - Check if proposed placement is compatible with a bo
323 * @placement: Return immediately if buffer is busy.
324 * @mem: The struct ttm_mem_reg indicating the region where the bo resides
325 * @new_flags: Describes compatible placement found
327 * Returns true if the placement is compatible
329 extern bool ttm_bo_mem_compat(struct ttm_placement *placement,
330 struct ttm_mem_reg *mem,
331 uint32_t *new_flags);
334 * ttm_bo_validate
336 * @bo: The buffer object.
337 * @placement: Proposed placement for the buffer object.
338 * @interruptible: Sleep interruptible if sleeping.
339 * @no_wait_gpu: Return immediately if the GPU is busy.
341 * Changes placement and caching policy of the buffer object
342 * according proposed placement.
343 * Returns
344 * -EINVAL on invalid proposed placement.
345 * -ENOMEM on out-of-memory condition.
346 * -EBUSY if no_wait is true and buffer busy.
347 * -ERESTARTSYS if interrupted by a signal.
349 extern int ttm_bo_validate(struct ttm_buffer_object *bo,
350 struct ttm_placement *placement,
351 bool interruptible,
352 bool no_wait_gpu);
355 * ttm_bo_unref
357 * @bo: The buffer object.
359 * Unreference and clear a pointer to a buffer object.
361 extern void ttm_bo_unref(struct ttm_buffer_object **bo);
365 * ttm_bo_list_ref_sub
367 * @bo: The buffer object.
368 * @count: The number of references with which to decrease @bo::list_kref;
369 * @never_free: The refcount should not reach zero with this operation.
371 * Release @count lru list references to this buffer object.
373 extern void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count,
374 bool never_free);
377 * ttm_bo_add_to_lru
379 * @bo: The buffer object.
381 * Add this bo to the relevant mem type lru and, if it's backed by
382 * system pages (ttms) to the swap list.
383 * This function must be called with struct ttm_bo_global::lru_lock held, and
384 * is typically called immediately prior to unreserving a bo.
386 extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
389 * ttm_bo_del_from_lru
391 * @bo: The buffer object.
393 * Remove this bo from all lru lists used to lookup and reserve an object.
394 * This function must be called with struct ttm_bo_global::lru_lock held,
395 * and is usually called just immediately after the bo has been reserved to
396 * avoid recursive reservation from lru lists.
398 extern int ttm_bo_del_from_lru(struct ttm_buffer_object *bo);
402 * ttm_bo_lock_delayed_workqueue
404 * Prevent the delayed workqueue from running.
405 * Returns
406 * True if the workqueue was queued at the time
408 extern int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev);
411 * ttm_bo_unlock_delayed_workqueue
413 * Allows the delayed workqueue to run.
415 extern void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev,
416 int resched);
419 * ttm_bo_synccpu_write_grab
421 * @bo: The buffer object:
422 * @no_wait: Return immediately if buffer is busy.
424 * Synchronizes a buffer object for CPU RW access. This means
425 * command submission that affects the buffer will return -EBUSY
426 * until ttm_bo_synccpu_write_release is called.
428 * Returns
429 * -EBUSY if the buffer is busy and no_wait is true.
430 * -ERESTARTSYS if interrupted by a signal.
432 extern int
433 ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
436 * ttm_bo_synccpu_write_release:
438 * @bo : The buffer object.
440 * Releases a synccpu lock.
442 extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
445 * ttm_bo_acc_size
447 * @bdev: Pointer to a ttm_bo_device struct.
448 * @bo_size: size of the buffer object in byte.
449 * @struct_size: size of the structure holding buffer object datas
451 * Returns size to account for a buffer object
453 size_t ttm_bo_acc_size(struct ttm_bo_device *bdev,
454 unsigned long bo_size,
455 unsigned struct_size);
456 size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev,
457 unsigned long bo_size,
458 unsigned struct_size);
461 * ttm_bo_init
463 * @bdev: Pointer to a ttm_bo_device struct.
464 * @bo: Pointer to a ttm_buffer_object to be initialized.
465 * @size: Requested size of buffer object.
466 * @type: Requested type of buffer object.
467 * @flags: Initial placement flags.
468 * @page_alignment: Data alignment in pages.
469 * @interruptible: If needing to sleep to wait for GPU resources,
470 * sleep interruptible.
471 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
472 * pinned in physical memory. If this behaviour is not desired, this member
473 * holds a pointer to a persistent shmem object. Typically, this would
474 * point to the shmem object backing a GEM object if TTM is used to back a
475 * GEM user interface.
476 * @acc_size: Accounted size for this object.
477 * @resv: Pointer to a reservation_object, or NULL to let ttm allocate one.
478 * @destroy: Destroy function. Use NULL for kfree().
480 * This function initializes a pre-allocated struct ttm_buffer_object.
481 * As this object may be part of a larger structure, this function,
482 * together with the @destroy function,
483 * enables driver-specific objects derived from a ttm_buffer_object.
484 * On successful return, the object kref and list_kref are set to 1.
485 * If a failure occurs, the function will call the @destroy function, or
486 * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
487 * illegal and will likely cause memory corruption.
489 * Returns
490 * -ENOMEM: Out of memory.
491 * -EINVAL: Invalid placement flags.
492 * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
495 extern int ttm_bo_init(struct ttm_bo_device *bdev,
496 struct ttm_buffer_object *bo,
497 unsigned long size,
498 enum ttm_bo_type type,
499 struct ttm_placement *placement,
500 uint32_t page_alignment,
501 bool interrubtible,
502 struct file *persistent_swap_storage,
503 size_t acc_size,
504 struct sg_table *sg,
505 struct reservation_object *resv,
506 void (*destroy) (struct ttm_buffer_object *));
509 * ttm_bo_create
511 * @bdev: Pointer to a ttm_bo_device struct.
512 * @size: Requested size of buffer object.
513 * @type: Requested type of buffer object.
514 * @placement: Initial placement.
515 * @page_alignment: Data alignment in pages.
516 * @interruptible: If needing to sleep while waiting for GPU resources,
517 * sleep interruptible.
518 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
519 * pinned in physical memory. If this behaviour is not desired, this member
520 * holds a pointer to a persistent shmem object. Typically, this would
521 * point to the shmem object backing a GEM object if TTM is used to back a
522 * GEM user interface.
523 * @p_bo: On successful completion *p_bo points to the created object.
525 * This function allocates a ttm_buffer_object, and then calls ttm_bo_init
526 * on that object. The destroy function is set to kfree().
527 * Returns
528 * -ENOMEM: Out of memory.
529 * -EINVAL: Invalid placement flags.
530 * -ERESTARTSYS: Interrupted by signal while waiting for resources.
533 extern int ttm_bo_create(struct ttm_bo_device *bdev,
534 unsigned long size,
535 enum ttm_bo_type type,
536 struct ttm_placement *placement,
537 uint32_t page_alignment,
538 bool interruptible,
539 struct file *persistent_swap_storage,
540 struct ttm_buffer_object **p_bo);
543 * ttm_bo_init_mm
545 * @bdev: Pointer to a ttm_bo_device struct.
546 * @mem_type: The memory type.
547 * @p_size: size managed area in pages.
549 * Initialize a manager for a given memory type.
550 * Note: if part of driver firstopen, it must be protected from a
551 * potentially racing lastclose.
552 * Returns:
553 * -EINVAL: invalid size or memory type.
554 * -ENOMEM: Not enough memory.
555 * May also return driver-specified errors.
558 extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
559 unsigned long p_size);
561 * ttm_bo_clean_mm
563 * @bdev: Pointer to a ttm_bo_device struct.
564 * @mem_type: The memory type.
566 * Take down a manager for a given memory type after first walking
567 * the LRU list to evict any buffers left alive.
569 * Normally, this function is part of lastclose() or unload(), and at that
570 * point there shouldn't be any buffers left created by user-space, since
571 * there should've been removed by the file descriptor release() method.
572 * However, before this function is run, make sure to signal all sync objects,
573 * and verify that the delayed delete queue is empty. The driver must also
574 * make sure that there are no NO_EVICT buffers present in this memory type
575 * when the call is made.
577 * If this function is part of a VT switch, the caller must make sure that
578 * there are no appications currently validating buffers before this
579 * function is called. The caller can do that by first taking the
580 * struct ttm_bo_device::ttm_lock in write mode.
582 * Returns:
583 * -EINVAL: invalid or uninitialized memory type.
584 * -EBUSY: There are still buffers left in this memory type.
587 extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
590 * ttm_bo_evict_mm
592 * @bdev: Pointer to a ttm_bo_device struct.
593 * @mem_type: The memory type.
595 * Evicts all buffers on the lru list of the memory type.
596 * This is normally part of a VT switch or an
597 * out-of-memory-space-due-to-fragmentation handler.
598 * The caller must make sure that there are no other processes
599 * currently validating buffers, and can do that by taking the
600 * struct ttm_bo_device::ttm_lock in write mode.
602 * Returns:
603 * -EINVAL: Invalid or uninitialized memory type.
604 * -ERESTARTSYS: The call was interrupted by a signal while waiting to
605 * evict a buffer.
608 extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
611 * ttm_kmap_obj_virtual
613 * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
614 * @is_iomem: Pointer to an integer that on return indicates 1 if the
615 * virtual map is io memory, 0 if normal memory.
617 * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
618 * If *is_iomem is 1 on return, the virtual address points to an io memory area,
619 * that should strictly be accessed by the iowriteXX() and similar functions.
622 static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
623 bool *is_iomem)
625 *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
626 return map->virtual;
630 * ttm_bo_kmap
632 * @bo: The buffer object.
633 * @start_page: The first page to map.
634 * @num_pages: Number of pages to map.
635 * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
637 * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
638 * data in the buffer object. The ttm_kmap_obj_virtual function can then be
639 * used to obtain a virtual address to the data.
641 * Returns
642 * -ENOMEM: Out of memory.
643 * -EINVAL: Invalid range.
646 extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
647 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
650 * ttm_bo_kunmap
652 * @map: Object describing the map to unmap.
654 * Unmaps a kernel map set up by ttm_bo_kmap.
657 extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
660 * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
662 * @vma: vma as input from the fbdev mmap method.
663 * @bo: The bo backing the address space. The address space will
664 * have the same size as the bo, and start at offset 0.
666 * This function is intended to be called by the fbdev mmap method
667 * if the fbdev address space is to be backed by a bo.
670 extern int ttm_fbdev_mmap(struct vm_area_struct *vma,
671 struct ttm_buffer_object *bo);
674 * ttm_bo_mmap - mmap out of the ttm device address space.
676 * @filp: filp as input from the mmap method.
677 * @vma: vma as input from the mmap method.
678 * @bdev: Pointer to the ttm_bo_device with the address space manager.
680 * This function is intended to be called by the device mmap method.
681 * if the device address space is to be backed by the bo manager.
684 extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
685 struct ttm_bo_device *bdev);
688 * ttm_bo_io
690 * @bdev: Pointer to the struct ttm_bo_device.
691 * @filp: Pointer to the struct file attempting to read / write.
692 * @wbuf: User-space pointer to address of buffer to write. NULL on read.
693 * @rbuf: User-space pointer to address of buffer to read into.
694 * Null on write.
695 * @count: Number of bytes to read / write.
696 * @f_pos: Pointer to current file position.
697 * @write: 1 for read, 0 for write.
699 * This function implements read / write into ttm buffer objects, and is
700 * intended to
701 * be called from the fops::read and fops::write method.
702 * Returns:
703 * See man (2) write, man(2) read. In particular,
704 * the function may return -ERESTARTSYS if
705 * interrupted by a signal.
708 extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
709 const char __user *wbuf, char __user *rbuf,
710 size_t count, loff_t *f_pos, bool write);
712 extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
713 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo);
714 #endif