Skip to content

Commit

Permalink
drm/dp: Fix documentation of DP tunnel functions
Browse files Browse the repository at this point in the history
Fix the documentation issues below, also reported by 'make htmldocs':

drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tunnel' not described in 'drm_dp_tunnel_put'
drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tracker' not described in 'drm_dp_tunnel_put'
drivers/gpu/drm/display/drm_dp_tunnel.c:1185: warning: expecting prototype for drm_dp_tunnel_atomic_get_allocated_bw(). Prototype was for drm_dp_tunnel_get_allocated_bw() instead
drivers/gpu/drm/display/drm_dp_tunnel.c:1903: warning: Function parameter or struct member 'max_group_count' not described in 'drm_dp_tunnel_mgr_create'

Fixes: 295654f ("drm/dp: Add support for DP tunneling")
Reported-by: kernel test robot <lkp@intel.com>
Reviewed-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
Signed-off-by: Imre Deak <imre.deak@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240228164636.1540903-1-imre.deak@intel.com
  • Loading branch information
Imre Deak committed Mar 4, 2024
1 parent 711c487 commit a0d1cf4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions drivers/gpu/drm/display/drm_dp_tunnel.c
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,8 @@ EXPORT_SYMBOL(drm_dp_tunnel_get);

/**
* drm_dp_tunnel_put - Put a reference for a DP tunnel
* @tunnel - Tunnel object
* @tracker - Debug tracker for the reference
* @tunnel: Tunnel object
* @tracker: Debug tracker for the reference
*
* Put a reference for @tunnel along with its debug *@tracker, which
* was obtained with drm_dp_tunnel_get().
Expand Down Expand Up @@ -1170,7 +1170,7 @@ int drm_dp_tunnel_alloc_bw(struct drm_dp_tunnel *tunnel, int bw)
EXPORT_SYMBOL(drm_dp_tunnel_alloc_bw);

/**
* drm_dp_tunnel_atomic_get_allocated_bw - Get the BW allocated for a DP tunnel
* drm_dp_tunnel_get_allocated_bw - Get the BW allocated for a DP tunnel
* @tunnel: Tunnel object
*
* Get the current BW allocated for @tunnel. After the tunnel is created /
Expand Down Expand Up @@ -1892,6 +1892,7 @@ static void destroy_mgr(struct drm_dp_tunnel_mgr *mgr)
/**
* drm_dp_tunnel_mgr_create - Create a DP tunnel manager
* @dev: DRM device object
* @max_group_count: Maximum number of tunnel groups
*
* Creates a DP tunnel manager for @dev.
*
Expand Down

0 comments on commit a0d1cf4

Please sign in to comment.