Clean up all of the kernel-doc issues in drm_connector.c:
drivers/gpu/drm/drm_connector.c:2611: warning: Excess function parameter
'connector' description in 'drm_connector_oob_hotplug_event'
drivers/gpu/drm/drm_connector.c:2611: warning: Function parameter or member
'connector_fwnode' not described in 'drm_connector_oob_hotplug_event'
drm_connector.c:630: warning: No description found for return value of
'drm_get_connector_status_name'
drm_connector.c:715: warning: No description found for return value of
'drm_connector_list_iter_next'
drm_connector.c:785: warning: No description found for return value of
'drm_get_subpixel_order_name'
drm_connector.c:816: warning: No description found for return value of
'drm_display_info_set_bus_formats'
drm_connector.c:1331: warning: No description found for return value of
'drm_mode_create_dvi_i_properties'
drm_connector.c:1412: warning: No description found for return value of
'drm_connector_attach_content_type_property'
drm_connector.c:1492: warning: No description found for return value of
'drm_mode_create_tv_margin_properties'
drm_connector.c:1534: warning: No description found for return value of
'drm_mode_create_tv_properties'
drm_connector.c:1627: warning: No description found for return value of
'drm_mode_create_scaling_mode_property'
drm_connector.c:1944: warning: No description found for return value of
'drm_mode_create_suggested_offset_properties'
drm_connector.c:2315: warning: missing initial short description on line:
* drm_connector_set_panel_orientation_with_quirk -
[The last warning listed is probably a quirk/bug in scripts/kernel-doc.]
Fixes: 613051dac40d ("drm: locking iterators for connector_list")
Fixes: 522171951761 ("drm: Extract drm_connector.[hc]")
Fixes: b3c6c8bfe378 ("drm: document drm_display_info")
Fixes: 50525c332b55 ("drm: content-type property for HDMI connector")
Fixes: 6c4f52dca36f ("drm/connector: Allow creation of margin props alone")
Fixes: 69654c632d80 ("drm/connector: Split out orientation quirk detection
(v2)")
Fixes: 72ad49682dde ("drm/connector: Add support for out-of-band hotplug
notification (v3)")
Signed-off-by: Randy Dunlap
Cc: David Airlie
Cc: Daniel Vetter
Cc: dri-devel@lists.freedesktop.org
Cc: Stanislav Lisovskiy
Cc: Ville Syrjälä
Cc: Derek Basehore
Cc: Hans de Goede
Cc: Maarten Lankhorst
Cc: Maxime Ripard
Cc: Thomas Zimmermann
Cc: Sam Ravnborg
---
v2: drop Cc: Boris Brezillon [bounced]
Address Sam's comment on Returns:
72ad49682dde ("drm/connector: Add support for out-of-band hotplug notification
(v3)")
is only in linux-next. The others are in mainline.
drivers/gpu/drm/drm_connector.c | 30 ++
1 file changed, 26 insertions(+), 4 deletions(-)
--- linux-next-20211007.orig/drivers/gpu/drm/drm_connector.c
+++ linux-next-20211007/drivers/gpu/drm/drm_connector.c
@@ -625,6 +625,8 @@ int drm_connector_register_all(struct dr
*
* In contrast to the other drm_get_*_name functions this one here returns a
* const pointer and hence is threadsafe.
+ *
+ * Returns: connector status string
*/
const char *drm_get_connector_status_name(enum drm_connector_status status)
{
@@ -707,7 +709,7 @@ __drm_connector_put_safe(struct drm_conn
* drm_connector_list_iter_next - return next connector
* @iter: connector_list iterator
*
- * Returns the next connector for @iter, or NULL when the list walk has
+ * Returns: the next connector for @iter, or NULL when the list walk has
* completed.
*/
struct drm_connector *
@@ -780,6 +782,8 @@ static const struct drm_prop_enum_list d
*
* Note you could abuse this and return something out of bounds, but that
* would be a caller error. No unscrubbed user data should make it here.
+ *
+ * Returns: string describing an enumerated subpixel property
*/
const char *drm_get_subpixel_order_name(enum subpixel_order order)
{
@@ -809,6 +813,9 @@ static const struct drm_prop_enum_list d
* Store the supported bus formats in display info structure.
* See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
* a full list of available formats.
+ *
+ * Returns:
+ * 0 on success or a negative error code on failure.
*/
int drm_display_info_set_bus_formats(struct drm_display_info *info,
const u32 *formats,
@@ -1326,6 +1333,8 @@ int drm_connector_create_standard_proper
* @dev: DRM device
*
* Called by a driver the first time a DVI-I connector is made.
+ *
+ * Returns: %0
*/
int drm_mode_create_dvi_i_properties(struct drm_device *dev)
{
@@ -1407,6 +1416,8 @@ EXPORT_SYMBOL(drm_connector_attach_dp_su
* @connector: connector to attach content type property on.
*
* Called by a driver the first time a HDMI connector is made.
+ *
+ * Returns: %0
*/
int drm_connector_attach_content_type_property(struct drm_connector *connector)
{
@@ -1487,6 +1498,9 @@ EXPORT_SYMBOL(drm_connector_attach_tv_ma
* creates the TV margin properties for a given device. No
