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:613051dac4("drm: locking&new iterators for connector_list") Fixes:5221719517("drm: Extract drm_connector.[hc]") Fixes:b3c6c8bfe3("drm: document drm_display_info") Fixes:50525c332b("drm: content-type property for HDMI connector") Fixes:6c4f52dca3("drm/connector: Allow creation of margin props alone") Fixes:69654c632d("drm/connector: Split out orientation quirk detection (v2)") Fixes:72ad49682d("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
This commit is contained in:
Randy Dunlap
Sam Ravnborg
parent
90c45fc15a
commit
f85d9e59f1
|
|
@ -625,6 +625,8 @@ int drm_connector_register_all(struct drm_device *dev)
|
|||
*
|
||||
* 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_connector *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 drm_subpixel_enum_list[] = {
|
|||
*
|
||||
* 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 drm_link_status_enum_list[] = {
|
|||
* 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_properties(struct drm_device *dev)
|
|||
* @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)
|
||||
{
|
||||
|
|
@ -1409,6 +1418,8 @@ EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
|
|||
* @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)
|
||||
{
|
||||
|
|
@ -1489,6 +1500,9 @@ EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
|
|||
* creates the TV margin properties for a given device. No need to call this
|
||||
* function for an SDTV connector, it's already called from
|
||||
* drm_mode_create_tv_properties().
|
||||
*
|
||||
* Returns:
|
||||
* 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int drm_mode_create_tv_margin_properties(struct drm_device *dev)
|
||||
{
|
||||
|
|
@ -1529,6 +1543,9 @@ EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
|
|||
* the TV specific connector properties for a given device. Caller is
|
||||
* responsible for allocating a list of format names and passing them to
|
||||
* this routine.
|
||||
*
|
||||
* Returns:
|
||||
* 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int drm_mode_create_tv_properties(struct drm_device *dev,
|
||||
unsigned int num_modes,
|
||||
|
|
@ -1624,6 +1641,8 @@ EXPORT_SYMBOL(drm_mode_create_tv_properties);
|
|||
* Atomic drivers should use drm_connector_attach_scaling_mode_property()
|
||||
* instead to correctly assign &drm_connector_state.scaling_mode
|
||||
* in the atomic state.
|
||||
*
|
||||
* Returns: %0
|
||||
*/
|
||||
int drm_mode_create_scaling_mode_property(struct drm_device *dev)
|
||||
{
|
||||
|
|
@ -1941,6 +1960,9 @@ EXPORT_SYMBOL(drm_mode_create_content_type_property);
|
|||
* @dev: DRM device
|
||||
*
|
||||
* Create the suggested x/y offset property for connectors.
|
||||
*
|
||||
* Returns:
|
||||
* 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
|
||||
{
|
||||
|
|
@ -2314,8 +2336,8 @@ int drm_connector_set_panel_orientation(
|
|||
EXPORT_SYMBOL(drm_connector_set_panel_orientation);
|
||||
|
||||
/**
|
||||
* drm_connector_set_panel_orientation_with_quirk -
|
||||
* set the connector's panel_orientation after checking for quirks
|
||||
* drm_connector_set_panel_orientation_with_quirk - set the
|
||||
* connector's panel_orientation after checking for quirks
|
||||
* @connector: connector for which to init the panel-orientation property.
|
||||
* @panel_orientation: drm_panel_orientation value to set
|
||||
* @width: width in pixels of the panel, used for panel quirk detection
|
||||
|
|
@ -2599,7 +2621,7 @@ struct drm_connector *drm_connector_find_by_fwnode(struct fwnode_handle *fwnode)
|
|||
|
||||
/**
|
||||
* drm_connector_oob_hotplug_event - Report out-of-band hotplug event to connector
|
||||
* @connector: connector to report the event on
|
||||
* @connector_fwnode: fwnode_handle to report the event on
|
||||
*
|
||||
* On some hardware a hotplug event notification may come from outside the display
|
||||
* driver / device. An example of this is some USB Type-C setups where the hardware
|
||||
|
|
|
|||
Loading…
Reference in New Issue