Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm/connector: fix all kernel-doc warnings

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&new 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 <rdunlap@infradead.org>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Cc: Stanislav Lisovskiy <stanislav.lisovskiy@intel.com>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Cc: Derek Basehore <dbasehore@chromium.org>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Sam Ravnborg <sam@ravnborg.org>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20211010224459.3603-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Sam Ravnborg
f85d9e59 90c45fc1

+26 -4
+26 -4
drivers/gpu/drm/drm_connector.c
··· 625 625 * 626 626 * In contrast to the other drm_get_*_name functions this one here returns a 627 627 * const pointer and hence is threadsafe. 628 + * 629 + * Returns: connector status string 628 630 */ 629 631 const char *drm_get_connector_status_name(enum drm_connector_status status) 630 632 { ··· 709 707 * drm_connector_list_iter_next - return next connector 710 708 * @iter: connector_list iterator 711 709 * 712 - * Returns the next connector for @iter, or NULL when the list walk has 710 + * Returns: the next connector for @iter, or NULL when the list walk has 713 711 * completed. 714 712 */ 715 713 struct drm_connector * ··· 782 780 * 783 781 * Note you could abuse this and return something out of bounds, but that 784 782 * would be a caller error. No unscrubbed user data should make it here. 783 + * 784 + * Returns: string describing an enumerated subpixel property 785 785 */ 786 786 const char *drm_get_subpixel_order_name(enum subpixel_order order) 787 787 { ··· 813 809 * Store the supported bus formats in display info structure. 814 810 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for 815 811 * a full list of available formats. 812 + * 813 + * Returns: 814 + * 0 on success or a negative error code on failure. 816 815 */ 817 816 int drm_display_info_set_bus_formats(struct drm_display_info *info, 818 817 const u32 *formats, ··· 1333 1326 * @dev: DRM device 1334 1327 * 1335 1328 * Called by a driver the first time a DVI-I connector is made. 1329 + * 1330 + * Returns: %0 1336 1331 */ 1337 1332 int drm_mode_create_dvi_i_properties(struct drm_device *dev) 1338 1333 { ··· 1418 1409 * @connector: connector to attach content type property on. 1419 1410 * 1420 1411 * Called by a driver the first time a HDMI connector is made. 1412 + * 1413 + * Returns: %0 1421 1414 */ 1422 1415 int drm_connector_attach_content_type_property(struct drm_connector *connector) 1423 1416 { ··· 1500 1489 * creates the TV margin properties for a given device. No need to call this 1501 1490 * function for an SDTV connector, it's already called from 1502 1491 * drm_mode_create_tv_properties(). 1492 + * 1493 + * Returns: 1494 + * 0 on success or a negative error code on failure. 1503 1495 */ 1504 1496 int drm_mode_create_tv_margin_properties(struct drm_device *dev) 1505 1497 { ··· 1543 1529 * the TV specific connector properties for a given device. Caller is 1544 1530 * responsible for allocating a list of format names and passing them to 1545 1531 * this routine. 1532 + * 1533 + * Returns: 1534 + * 0 on success or a negative error code on failure. 1546 1535 */ 1547 1536 int drm_mode_create_tv_properties(struct drm_device *dev, 1548 1537 unsigned int num_modes, ··· 1641 1624 * Atomic drivers should use drm_connector_attach_scaling_mode_property() 1642 1625 * instead to correctly assign &drm_connector_state.scaling_mode 1643 1626 * in the atomic state. 1627 + * 1628 + * Returns: %0 1644 1629 */ 1645 1630 int drm_mode_create_scaling_mode_property(struct drm_device *dev) 1646 1631 { ··· 1960 1941 * @dev: DRM device 1961 1942 * 1962 1943 * Create the suggested x/y offset property for connectors. 1944 + * 1945 + * Returns: 1946 + * 0 on success or a negative error code on failure. 1963 1947 */ 1964 1948 int drm_mode_create_suggested_offset_properties(struct drm_device *dev) 1965 1949 { ··· 2336 2314 EXPORT_SYMBOL(drm_connector_set_panel_orientation); 2337 2315 2338 2316 /** 2339 - * drm_connector_set_panel_orientation_with_quirk - 2340 - * set the connector's panel_orientation after checking for quirks 2317 + * drm_connector_set_panel_orientation_with_quirk - set the 2318 + * connector's panel_orientation after checking for quirks 2341 2319 * @connector: connector for which to init the panel-orientation property. 2342 2320 * @panel_orientation: drm_panel_orientation value to set 2343 2321 * @width: width in pixels of the panel, used for panel quirk detection ··· 2621 2599 2622 2600 /** 2623 2601 * drm_connector_oob_hotplug_event - Report out-of-band hotplug event to connector 2624 - * @connector: connector to report the event on 2602 + * @connector_fwnode: fwnode_handle to report the event on 2625 2603 * 2626 2604 * On some hardware a hotplug event notification may come from outside the display 2627 2605 * driver / device. An example of this is some USB Type-C setups where the hardware