drm/i915: Include i915_gem_evict.c kerneldoc into the drm docbook
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Mon, 5 Jan 2015 13:36:59 +0000 (14:36 +0100)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 6 Jan 2015 08:07:59 +0000 (09:07 +0100)
I've written these long before we've had a reasonable docbook
structure, and naturally they've gone stale. Fix this up asap.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Documentation/DocBook/drm.tmpl
drivers/gpu/drm/i915/i915_gem_evict.c

index bd1456ad846014ff1beba407ea076fa08c8b02c7..38f7ef3933c4c4e005e7f4cb0c8120b88b4b09c9 100644 (file)
@@ -4048,6 +4048,17 @@ int num_ioctls;</synopsis>
 !Pdrivers/gpu/drm/i915/i915_gem_gtt.c Global GTT views
 !Idrivers/gpu/drm/i915/i915_gem_gtt.c
       </sect2>
+      <sect2>
+        <title>Buffer Object Eviction</title>
+       <para>
+         This section documents the interface function for evicting buffer
+         objects to make space available in the virtual gpu address spaces.
+         Note that this is mostly orthogonal to shrinking buffer objects
+         caches, which has the goal to make main memory (shared with the gpu
+         through the unified memory architecture) available.
+       </para>
+!Idrivers/gpu/drm/i915/i915_gem_evict.c
+      </sect2>
     </sect1>
 
     <sect1>
index 886ff2ee7a282e0762855e244e40cd8a7493b1fe..d104c9120c4d84d44f308a245069f6005d3f0c98 100644 (file)
@@ -50,11 +50,12 @@ mark_free(struct i915_vma *vma, struct list_head *unwind)
  * i915_gem_evict_something - Evict vmas to make room for binding a new one
  * @dev: drm_device
  * @vm: address space to evict from
- * @size: size of the desired free space
+ * @min_size: size of the desired free space
  * @alignment: alignment constraint of the desired free space
  * @cache_level: cache_level for the desired space
- * @mappable: whether the free space must be mappable
- * @nonblocking: whether evicting active objects is allowed or not
+ * @start: start (inclusive) of the range from which to evict objects
+ * @end: end (exclusive) of the range from which to evict objects
+ * @flags: additional flags to control the eviction algorithm
  *
  * This function will try to evict vmas until a free space satisfying the
  * requirements is found. Callers must check first whether any such hole exists
@@ -196,7 +197,6 @@ found:
 
 /**
  * i915_gem_evict_vm - Evict all idle vmas from a vm
- *
  * @vm: Address space to cleanse
  * @do_idle: Boolean directing whether to idle first.
  *