Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
drm/i915/dp_tunnel: Sanitize documentation of intel_dp_tunnel_detect()
Clarify the documentation of detect_new_tunnel() return values,
including the failure case.
Reviewed-by: Arun R Murthy <arun.r.murthy@intel.com>
Signed-off-by: Imre Deak <imre.deak@intel.com>
Link: https://patch.msgid.link/20260219182823.926702-5-imre.deak@intel.com
+6
-3
+6
-3
drivers/gpu/drm/i915/display/intel_dp_tunnel.c
+6
-3
drivers/gpu/drm/i915/display/intel_dp_tunnel.c
···
241
241
* tunnel. If the tunnel's state change requires this - for instance the
242
242
* tunnel's group ID has changed - the tunnel will be dropped and recreated.
243
243
*
244
-
* Return 0 in case of success - after any tunnel detected and added to
245
-
* @intel_dp - 1 in case the BW on an already existing tunnel has changed in a
246
-
* way that requires notifying user space.
244
+
* Returns:
245
+
* - 0 in case of success - after any tunnel detected and added to @intel_dp
246
+
* - 1 in case the link BW via the new or an already existing tunnel has changed
247
+
* in a way that requires notifying user space
248
+
* - Negative error code, if creating a new tunnel or updating the tunnel
249
+
* state failed
247
250
*/
248
251
int intel_dp_tunnel_detect(struct intel_dp *intel_dp, struct drm_modeset_acquire_ctx *ctx)
249
252
{