aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gpu/drm/i915/i915_gem.c
diff options
context:
space:
mode:
authorTvrtko Ursulin <tvrtko.ursulin@intel.com>2016-06-03 09:02:17 -0400
committerTvrtko Ursulin <tvrtko.ursulin@intel.com>2016-06-06 08:04:26 -0400
commit14bb2c11796d70bf20b92fa4a1459743c6afecb2 (patch)
tree8dda18e17784f93ac74fe177beee15dab67198d2 /drivers/gpu/drm/i915/i915_gem.c
parentf90e8c36c8864472e4f8524de78633272de33b88 (diff)
drm/i915: Fix a buch of kerneldoc warnings
Just a bunch of stale kerneldocs generating warnings when building the docs. Mostly function parameters so not very useful but still. v2: Tidy. Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com> Cc: Daniel Vetter <daniel.vetter@ffwll.ch> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: http://patchwork.freedesktop.org/patch/msgid/1464958937-23344-1-git-send-email-tvrtko.ursulin@linux.intel.com
Diffstat (limited to 'drivers/gpu/drm/i915/i915_gem.c')
-rw-r--r--drivers/gpu/drm/i915/i915_gem.c52
1 files changed, 48 insertions, 4 deletions
diff --git a/drivers/gpu/drm/i915/i915_gem.c b/drivers/gpu/drm/i915/i915_gem.c
index 343d88114f3b..1bfc260c59ad 100644
--- a/drivers/gpu/drm/i915/i915_gem.c
+++ b/drivers/gpu/drm/i915/i915_gem.c
@@ -409,6 +409,9 @@ i915_gem_dumb_create(struct drm_file *file,
409 409
410/** 410/**
411 * Creates a new mm object and returns a handle to it. 411 * Creates a new mm object and returns a handle to it.
412 * @dev: drm device pointer
413 * @data: ioctl data blob
414 * @file: drm file pointer
412 */ 415 */
413int 416int
414i915_gem_create_ioctl(struct drm_device *dev, void *data, 417i915_gem_create_ioctl(struct drm_device *dev, void *data,
@@ -672,6 +675,9 @@ out:
672 675
673/** 676/**
674 * Reads data from the object referenced by handle. 677 * Reads data from the object referenced by handle.
678 * @dev: drm device pointer
679 * @data: ioctl data blob
680 * @file: drm file pointer
675 * 681 *
676 * On error, the contents of *data are undefined. 682 * On error, the contents of *data are undefined.
677 */ 683 */
@@ -753,6 +759,10 @@ fast_user_write(struct io_mapping *mapping,
753/** 759/**
754 * This is the fast pwrite path, where we copy the data directly from the 760 * This is the fast pwrite path, where we copy the data directly from the
755 * user into the GTT, uncached. 761 * user into the GTT, uncached.
762 * @dev: drm device pointer
763 * @obj: i915 gem object
764 * @args: pwrite arguments structure
765 * @file: drm file pointer
756 */ 766 */
757static int 767static int
758i915_gem_gtt_pwrite_fast(struct drm_device *dev, 768i915_gem_gtt_pwrite_fast(struct drm_device *dev,
@@ -1016,6 +1026,9 @@ out:
1016 1026
1017/** 1027/**
1018 * Writes data to the object referenced by handle. 1028 * Writes data to the object referenced by handle.
1029 * @dev: drm device
1030 * @data: ioctl data blob
1031 * @file: drm file
1019 * 1032 *
1020 * On error, the contents of the buffer that were to be modified are undefined. 1033 * On error, the contents of the buffer that were to be modified are undefined.
1021 */ 1034 */
@@ -1213,6 +1226,7 @@ static int __i915_spin_request(struct drm_i915_gem_request *req, int state)
1213 * @req: duh! 1226 * @req: duh!
1214 * @interruptible: do an interruptible wait (normally yes) 1227 * @interruptible: do an interruptible wait (normally yes)
1215 * @timeout: in - how long to wait (NULL forever); out - how much time remaining 1228 * @timeout: in - how long to wait (NULL forever); out - how much time remaining
1229 * @rps: RPS client
1216 * 1230 *
1217 * Note: It is of utmost importance that the passed in seqno and reset_counter 1231 * Note: It is of utmost importance that the passed in seqno and reset_counter
1218 * values have been read by the caller in an smp safe manner. Where read-side 1232 * values have been read by the caller in an smp safe manner. Where read-side
@@ -1446,6 +1460,7 @@ __i915_gem_request_retire__upto(struct drm_i915_gem_request *req)
1446/** 1460/**
1447 * Waits for a request to be signaled, and cleans up the 1461 * Waits for a request to be signaled, and cleans up the
1448 * request and object lists appropriately for that event. 1462 * request and object lists appropriately for that event.
1463 * @req: request to wait on
1449 */ 1464 */
1450int 1465int
1451i915_wait_request(struct drm_i915_gem_request *req) 1466i915_wait_request(struct drm_i915_gem_request *req)
@@ -1472,6 +1487,8 @@ i915_wait_request(struct drm_i915_gem_request *req)
1472/** 1487/**
1473 * Ensures that all rendering to the object has completed and the object is 1488 * Ensures that all rendering to the object has completed and the object is
1474 * safe to unbind from the GTT or access from the CPU. 1489 * safe to unbind from the GTT or access from the CPU.
1490 * @obj: i915 gem object
1491 * @readonly: waiting for read access or write
1475 */ 1492 */
1476int 1493int
1477i915_gem_object_wait_rendering(struct drm_i915_gem_object *obj, 1494i915_gem_object_wait_rendering(struct drm_i915_gem_object *obj,
@@ -1589,6 +1606,9 @@ static struct intel_rps_client *to_rps_client(struct drm_file *file)
1589/** 1606/**
1590 * Called when user space prepares to use an object with the CPU, either 1607 * Called when user space prepares to use an object with the CPU, either
1591 * through the mmap ioctl's mapping or a GTT mapping. 1608 * through the mmap ioctl's mapping or a GTT mapping.
1609 * @dev: drm device
1610 * @data: ioctl data blob
1611 * @file: drm file
1592 */ 1612 */
1593int 1613int
1594i915_gem_set_domain_ioctl(struct drm_device *dev, void *data, 1614i915_gem_set_domain_ioctl(struct drm_device *dev, void *data,
@@ -1652,6 +1672,9 @@ unlock:
1652 1672
1653/** 1673/**
1654 * Called when user space has done writes to this buffer 1674 * Called when user space has done writes to this buffer
1675 * @dev: drm device
1676 * @data: ioctl data blob
1677 * @file: drm file
1655 */ 1678 */
1656int 1679int
1657i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data, 1680i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data,
@@ -1682,8 +1705,11 @@ unlock:
1682} 1705}
1683 1706
1684/** 1707/**
1685 * Maps the contents of an object, returning the address it is mapped 1708 * i915_gem_mmap_ioctl - Maps the contents of an object, returning the address
1686 * into. 1709 * it is mapped to.
1710 * @dev: drm device
1711 * @data: ioctl data blob
1712 * @file: drm file
1687 * 1713 *
1688 * While the mapping holds a reference on the contents of the object, it doesn't 1714 * While the mapping holds a reference on the contents of the object, it doesn't
1689 * imply a ref on the object itself. 1715 * imply a ref on the object itself.
@@ -2001,7 +2027,10 @@ i915_gem_get_gtt_size(struct drm_device *dev, uint32_t size, int tiling_mode)
2001 2027
2002/** 2028/**
2003 * i915_gem_get_gtt_alignment - return required GTT alignment for an object 2029 * i915_gem_get_gtt_alignment - return required GTT alignment for an object
2004 * @obj: object to check 2030 * @dev: drm device
2031 * @size: object size
2032 * @tiling_mode: tiling mode
2033 * @fenced: is fenced alignemned required or not
2005 * 2034 *
2006 * Return the required GTT alignment for an object, taking into account 2035 * Return the required GTT alignment for an object, taking into account
2007 * potential fence register mapping. 2036 * potential fence register mapping.
@@ -2951,6 +2980,7 @@ void i915_gem_reset(struct drm_device *dev)
2951 2980
2952/** 2981/**
2953 * This function clears the request list as sequence numbers are passed. 2982 * This function clears the request list as sequence numbers are passed.
2983 * @engine: engine to retire requests on
2954 */ 2984 */
2955void 2985void
2956i915_gem_retire_requests_ring(struct intel_engine_cs *engine) 2986i915_gem_retire_requests_ring(struct intel_engine_cs *engine)
@@ -3074,6 +3104,7 @@ i915_gem_idle_work_handler(struct work_struct *work)
3074 * Ensures that an object will eventually get non-busy by flushing any required 3104 * Ensures that an object will eventually get non-busy by flushing any required
3075 * write domains, emitting any outstanding lazy request and retiring and 3105 * write domains, emitting any outstanding lazy request and retiring and
3076 * completed requests. 3106 * completed requests.
3107 * @obj: object to flush
3077 */ 3108 */
3078static int 3109static int
3079i915_gem_object_flush_active(struct drm_i915_gem_object *obj) 3110i915_gem_object_flush_active(struct drm_i915_gem_object *obj)
@@ -3099,7 +3130,9 @@ i915_gem_object_flush_active(struct drm_i915_gem_object *obj)
3099 3130
3100/** 3131/**
3101 * i915_gem_wait_ioctl - implements DRM_IOCTL_I915_GEM_WAIT 3132 * i915_gem_wait_ioctl - implements DRM_IOCTL_I915_GEM_WAIT
3102 * @DRM_IOCTL_ARGS: standard ioctl arguments 3133 * @dev: drm device pointer
3134 * @data: ioctl data blob
3135 * @file: drm file pointer
3103 * 3136 *
3104 * Returns 0 if successful, else an error is returned with the remaining time in 3137 * Returns 0 if successful, else an error is returned with the remaining time in
3105 * the timeout parameter. 3138 * the timeout parameter.
@@ -3489,6 +3522,11 @@ static bool i915_gem_valid_gtt_space(struct i915_vma *vma,
3489/** 3522/**
3490 * Finds free space in the GTT aperture and binds the object or a view of it 3523 * Finds free space in the GTT aperture and binds the object or a view of it
3491 * there. 3524 * there.
3525 * @obj: object to bind
3526 * @vm: address space to bind into
3527 * @ggtt_view: global gtt view if applicable
3528 * @alignment: requested alignment
3529 * @flags: mask of PIN_* flags to use
3492 */ 3530 */
3493static struct i915_vma * 3531static struct i915_vma *
3494i915_gem_object_bind_to_vm(struct drm_i915_gem_object *obj, 3532i915_gem_object_bind_to_vm(struct drm_i915_gem_object *obj,
@@ -3746,6 +3784,8 @@ i915_gem_object_flush_cpu_write_domain(struct drm_i915_gem_object *obj)
3746 3784
3747/** 3785/**
3748 * Moves a single object to the GTT read, and possibly write domain. 3786 * Moves a single object to the GTT read, and possibly write domain.
3787 * @obj: object to act on
3788 * @write: ask for write access or read only
3749 * 3789 *
3750 * This function returns when the move is complete, including waiting on 3790 * This function returns when the move is complete, including waiting on
3751 * flushes to occur. 3791 * flushes to occur.
@@ -3817,6 +3857,8 @@ i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj, bool write)
3817 3857
3818/** 3858/**
3819 * Changes the cache-level of an object across all VMA. 3859 * Changes the cache-level of an object across all VMA.
3860 * @obj: object to act on
3861 * @cache_level: new cache level to set for the object
3820 * 3862 *
3821 * After this function returns, the object will be in the new cache-level 3863 * After this function returns, the object will be in the new cache-level
3822 * across all GTT and the contents of the backing storage will be coherent, 3864 * across all GTT and the contents of the backing storage will be coherent,
@@ -4098,6 +4140,8 @@ i915_gem_object_unpin_from_display_plane(struct drm_i915_gem_object *obj,
4098 4140
4099/** 4141/**
4100 * Moves a single object to the CPU read, and possibly write domain. 4142 * Moves a single object to the CPU read, and possibly write domain.
4143 * @obj: object to act on
4144 * @write: requesting write or read-only access
4101 * 4145 *
4102 * This function returns when the move is complete, including waiting on 4146 * This function returns when the move is complete, including waiting on
4103 * flushes to occur. 4147 * flushes to occur.