Skip to content

Commit 23bee88

Browse files
rddunlaplumag
authored andcommitted
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: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Dmitry 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: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
1 parent a50d877 commit 23bee88

4 files changed

Lines changed: 11 additions & 9 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#if defined(CONFIG_DEBUG_FS)
1313

1414
/**
15-
* msm_dp_debug_get() - configure and get the DisplayPlot debug module data
15+
* msm_dp_debug_init() - configure and get the DisplayPlot debug module data
1616
*
1717
* @dev: device instance of the caller
1818
* @panel: instance of panel module

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
/**
1919
* msm_dp_bridge_detect - callback to determine if connector is connected
2020
* @bridge: Pointer to drm bridge structure
21+
* @connector: Pointer to drm connector structure
2122
* Returns: Bridge's 'is connected' status
2223
*/
2324
static enum drm_connector_status

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ struct msm_dp_link {
8080
};
8181

8282
/**
83-
* mdss_dp_test_bit_depth_to_bpp() - convert test bit depth to bpp
83+
* msm_dp_link_bit_depth_to_bpp() - convert test bit depth to bpp
8484
* @tbd: test bit depth
8585
*
86-
* Returns the bits per pixel (bpp) to be used corresponding to the
87-
* git bit depth value. This function assumes that bit depth has
86+
* Returns: the bits per pixel (bpp) to be used corresponding to the
87+
* bit depth value. This function assumes that bit depth has
8888
* already been validated.
8989
*/
9090
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
120120

121121
/**
122122
* msm_dp_link_get() - get the functionalities of dp test module
123-
*
123+
* @dev: kernel device structure
124+
* @aux: DisplayPort AUX channel
124125
*
125126
* return: a pointer to msm_dp_link struct
126127
*/

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ void msm_dp_panel_disable_vsc_sdp(struct msm_dp_panel *msm_dp_panel);
6363

6464
/**
6565
* is_link_rate_valid() - validates the link rate
66-
* @lane_rate: link rate requested by the sink
66+
* @bw_code: link rate requested by the sink
6767
*
68-
* Returns true if the requested link rate is supported.
68+
* Returns: true if the requested link rate is supported.
6969
*/
7070
static inline bool is_link_rate_valid(u32 bw_code)
7171
{
@@ -76,10 +76,10 @@ static inline bool is_link_rate_valid(u32 bw_code)
7676
}
7777

7878
/**
79-
* msm_dp_link_is_lane_count_valid() - validates the lane count
79+
* is_lane_count_valid() - validates the lane count
8080
* @lane_count: lane count requested by the sink
8181
*
82-
* Returns true if the requested lane count is supported.
82+
* Returns: true if the requested lane count is supported.
8383
*/
8484
static inline bool is_lane_count_valid(u32 lane_count)
8585
{

0 commit comments

Comments
 (0)