Commit 23bee889 authored by Randy Dunlap's avatar Randy Dunlap Committed by Dmitry Baryshkov
Browse files

drm/msm/dp: fix all kernel-doc warnings 



Correct and add kernel-doc comments to eliminate all warnings:

Warning: ../drivers/gpu/drm/msm/dp/dp_debug.h:31 expecting prototype for
 msm_dp_debug_get(). Prototype was for msm_dp_debug_init() instead
Warning: ../drivers/gpu/drm/msm/dp/dp_drm.c:24 function parameter
 'connector' not described in 'msm_dp_bridge_detect'
Warning: ../drivers/gpu/drm/msm/dp/dp_link.h:90 expecting prototype for
 mdss_dp_test_bit_depth_to_bpp(). Prototype was for
 msm_dp_link_bit_depth_to_bpp() instead
Warning: ../drivers/gpu/drm/msm/dp/dp_link.h:126 function parameter
 'aux' not described in 'msm_dp_link_get'
Warning: ../drivers/gpu/drm/msm/dp/dp_link.h:126 function parameter
 'dev' not described in 'msm_dp_link_get'
Warning: ../drivers/gpu/drm/msm/dp/dp_panel.h:70 function parameter
 'bw_code' not described in 'is_link_rate_valid'
Warning: ../drivers/gpu/drm/msm/dp/dp_panel.h:84 expecting prototype for
 msm_dp_link_is_lane_count_valid(). Prototype was for
 is_lane_count_valid() instead

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarDmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
Patchwork: https://patchwork.freedesktop.org/patch/695647/
Link: https://lore.kernel.org/r/20251219184638.1813181-3-rdunlap@infradead.org


Signed-off-by: default avatarDmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
parent a50d8777

drivers/gpu/drm/msm/dp/dp_debug.h

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ 
#if defined(CONFIG_DEBUG_FS)



/**

 * msm_dp_debug_get() - configure and get the DisplayPlot debug module data

 * msm_dp_debug_init() - configure and get the DisplayPlot debug module data

 *

 * @dev: device instance of the caller

 * @panel: instance of panel module

drivers/gpu/drm/msm/dp/dp_drm.c

+1 −0
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ 
/**

 * msm_dp_bridge_detect - callback to determine if connector is connected

 * @bridge: Pointer to drm bridge structure

 * @connector: Pointer to drm connector structure

 * Returns: Bridge's 'is connected' status

 */

static enum drm_connector_status

drivers/gpu/drm/msm/dp/dp_link.h

+5 −4
Original line number Diff line number Diff line
@@ -80,11 +80,11 @@ struct msm_dp_link { 
};



/**

 * mdss_dp_test_bit_depth_to_bpp() - convert test bit depth to bpp

 * msm_dp_link_bit_depth_to_bpp() - convert test bit depth to bpp

 * @tbd: test bit depth

 *

 * Returns the bits per pixel (bpp) to be used corresponding to the

 * git bit depth value. This function assumes that bit depth has

 * Returns: the bits per pixel (bpp) to be used corresponding to the

 * bit depth value. This function assumes that bit depth has

 * already been validated.

 */

static inline u32 msm_dp_link_bit_depth_to_bpp(u32 tbd)
@@ -120,7 +120,8 @@ bool msm_dp_link_send_edid_checksum(struct msm_dp_link *msm_dp_link, u8 checksum 


/**

 * msm_dp_link_get() - get the functionalities of dp test module

 *

 * @dev: kernel device structure

 * @aux: DisplayPort AUX channel

 *

 * return: a pointer to msm_dp_link struct

 */

drivers/gpu/drm/msm/dp/dp_panel.h

+4 −4
Original line number Diff line number Diff line
@@ -63,9 +63,9 @@ void msm_dp_panel_disable_vsc_sdp(struct msm_dp_panel *msm_dp_panel); 


/**

 * is_link_rate_valid() - validates the link rate

 * @lane_rate: link rate requested by the sink

 * @bw_code: link rate requested by the sink

 *

 * Returns true if the requested link rate is supported.

 * Returns: true if the requested link rate is supported.

 */

static inline bool is_link_rate_valid(u32 bw_code)

{
@@ -76,10 +76,10 @@ static inline bool is_link_rate_valid(u32 bw_code) 
}



/**

 * msm_dp_link_is_lane_count_valid() - validates the lane count

 * is_lane_count_valid() - validates the lane count

 * @lane_count: lane count requested by the sink

 *

 * Returns true if the requested lane count is supported.

 * Returns: true if the requested lane count is supported.

 */

static inline bool is_lane_count_valid(u32 lane_count)

{