Commit e9d2871f authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Daniel Vetter

drm: fix some kernel-doc markups

Some identifiers have different names between their prototypes
and the kernel-doc markup.

Others need to be fixed, as kernel-doc markups should use this format:
        identifier - description
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/12d4ca26f6843618200529ce5445063734d38c04.1605521731.git.mchehab+huawei@kernel.org
parent 250fe9a5
...@@ -543,7 +543,7 @@ void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, ...@@ -543,7 +543,7 @@ void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state); EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
/** /**
* __drm_atomic_helper_private_duplicate_state - copy atomic private state * __drm_atomic_helper_private_obj_duplicate_state - copy atomic private state
* @obj: CRTC object * @obj: CRTC object
* @state: new private object state * @state: new private object state
* *
......
...@@ -1432,7 +1432,8 @@ void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame, ...@@ -1432,7 +1432,8 @@ void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type); EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
/** /**
* drm_mode_attach_tv_margin_properties - attach TV connector margin properties * drm_connector_attach_tv_margin_properties - attach TV connector margin
* properties
* @connector: DRM connector * @connector: DRM connector
* *
* Called by a driver when it needs to attach TV margin props to a connector. * Called by a driver when it needs to attach TV margin props to a connector.
......
...@@ -1161,7 +1161,7 @@ drm_dp_subconnector_type(const u8 dpcd[DP_RECEIVER_CAP_SIZE], ...@@ -1161,7 +1161,7 @@ drm_dp_subconnector_type(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
EXPORT_SYMBOL(drm_dp_subconnector_type); EXPORT_SYMBOL(drm_dp_subconnector_type);
/** /**
* drm_mode_set_dp_subconnector_property - set subconnector for DP connector * drm_dp_set_subconnector_property - set subconnector for DP connector
* @connector: connector to set property on * @connector: connector to set property on
* @status: connector status * @status: connector status
* @dpcd: DisplayPort configuration data * @dpcd: DisplayPort configuration data
......
...@@ -552,7 +552,7 @@ int drm_mode_getfb(struct drm_device *dev, ...@@ -552,7 +552,7 @@ int drm_mode_getfb(struct drm_device *dev,
} }
/** /**
* drm_mode_getfb2 - get extended FB info * drm_mode_getfb2_ioctl - get extended FB info
* @dev: drm device for the ioctl * @dev: drm device for the ioctl
* @data: data pointer for the ioctl * @data: data pointer for the ioctl
* @file_priv: drm file for the ioctl call * @file_priv: drm file for the ioctl call
......
...@@ -867,7 +867,7 @@ drm_gem_flink_ioctl(struct drm_device *dev, void *data, ...@@ -867,7 +867,7 @@ drm_gem_flink_ioctl(struct drm_device *dev, void *data,
} }
/** /**
* drm_gem_open - implementation of the GEM_OPEN ioctl * drm_gem_open_ioctl - implementation of the GEM_OPEN ioctl
* @dev: drm_device * @dev: drm_device
* @data: ioctl data * @data: ioctl data
* @file_priv: drm file-private structure * @file_priv: drm file-private structure
...@@ -912,7 +912,7 @@ drm_gem_open_ioctl(struct drm_device *dev, void *data, ...@@ -912,7 +912,7 @@ drm_gem_open_ioctl(struct drm_device *dev, void *data,
} }
/** /**
* gem_gem_open - initalizes GEM file-private structures at devnode open time * drm_gem_open - initalizes GEM file-private structures at devnode open time
* @dev: drm_device which is being opened by userspace * @dev: drm_device which is being opened by userspace
* @file_private: drm file-private structure to set up * @file_private: drm file-private structure to set up
* *
......
...@@ -617,7 +617,7 @@ static void drm_gem_vram_object_free(struct drm_gem_object *gem) ...@@ -617,7 +617,7 @@ static void drm_gem_vram_object_free(struct drm_gem_object *gem)
*/ */
/** /**
* drm_gem_vram_driver_create_dumb() - \ * drm_gem_vram_driver_dumb_create() - \
Implements &struct drm_driver.dumb_create Implements &struct drm_driver.dumb_create
* @file: the DRM file * @file: the DRM file
* @dev: the DRM device * @dev: the DRM device
......
...@@ -115,7 +115,7 @@ void drm_mode_object_unregister(struct drm_device *dev, ...@@ -115,7 +115,7 @@ void drm_mode_object_unregister(struct drm_device *dev,
} }
/** /**
* drm_lease_required - check types which must be leased to be used * drm_mode_object_lease_required - check types which must be leased to be used
* @type: type of object * @type: type of object
* *
* Returns whether the provided type of drm_mode_object must * Returns whether the provided type of drm_mode_object must
......
...@@ -1889,7 +1889,7 @@ drm_mode_create_from_cmdline_mode(struct drm_device *dev, ...@@ -1889,7 +1889,7 @@ drm_mode_create_from_cmdline_mode(struct drm_device *dev,
EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode); EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode);
/** /**
* drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo * drm_mode_convert_to_umode - convert a drm_display_mode into a modeinfo
* @out: drm_mode_modeinfo struct to return to the user * @out: drm_mode_modeinfo struct to return to the user
* @in: drm_display_mode to use * @in: drm_display_mode to use
* *
...@@ -1941,7 +1941,7 @@ void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out, ...@@ -1941,7 +1941,7 @@ void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
} }
/** /**
* drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode * drm_mode_convert_umode - convert a modeinfo into a drm_display_mode
* @dev: drm device * @dev: drm device
* @out: drm_display_mode to return to the user * @out: drm_display_mode to return to the user
* @in: drm_mode_modeinfo to use * @in: drm_mode_modeinfo to use
......
...@@ -125,7 +125,7 @@ ssize_t drm_scdc_write(struct i2c_adapter *adapter, u8 offset, ...@@ -125,7 +125,7 @@ ssize_t drm_scdc_write(struct i2c_adapter *adapter, u8 offset,
EXPORT_SYMBOL(drm_scdc_write); EXPORT_SYMBOL(drm_scdc_write);
/** /**
* drm_scdc_check_scrambling_status - what is status of scrambling? * drm_scdc_get_scrambling_status - what is status of scrambling?
* @adapter: I2C adapter for DDC channel * @adapter: I2C adapter for DDC channel
* *
* Reads the scrambler status over SCDC, and checks the * Reads the scrambler status over SCDC, and checks the
......
...@@ -4587,7 +4587,7 @@ void intel_dpll_sanitize_state(struct drm_i915_private *i915) ...@@ -4587,7 +4587,7 @@ void intel_dpll_sanitize_state(struct drm_i915_private *i915)
} }
/** /**
* intel_shared_dpll_dump_hw_state - write hw_state to dmesg * intel_dpll_dump_hw_state - write hw_state to dmesg
* @dev_priv: i915 drm device * @dev_priv: i915 drm device
* @hw_state: hw state to be written to the log * @hw_state: hw state to be written to the log
* *
......
...@@ -238,7 +238,7 @@ i915_gem_evict_something(struct i915_address_space *vm, ...@@ -238,7 +238,7 @@ i915_gem_evict_something(struct i915_address_space *vm,
} }
/** /**
* i915_gem_evict_for_vma - Evict vmas to make room for binding a new one * i915_gem_evict_for_node - Evict vmas to make room for binding a new one
* @vm: address space to evict from * @vm: address space to evict from
* @target: range (and color) to evict for * @target: range (and color) to evict for
* @flags: additional flags to control the eviction algorithm * @flags: additional flags to control the eviction algorithm
......
...@@ -625,7 +625,8 @@ static int append_oa_sample(struct i915_perf_stream *stream, ...@@ -625,7 +625,8 @@ static int append_oa_sample(struct i915_perf_stream *stream,
} }
/** /**
* Copies all buffered OA reports into userspace read() buffer. * gen8_append_oa_reports - Copies all buffered OA reports into
* userspace read() buffer.
* @stream: An i915-perf stream opened for OA metrics * @stream: An i915-perf stream opened for OA metrics
* @buf: destination buffer given by userspace * @buf: destination buffer given by userspace
* @count: the number of bytes userspace wants to read * @count: the number of bytes userspace wants to read
...@@ -917,7 +918,8 @@ static int gen8_oa_read(struct i915_perf_stream *stream, ...@@ -917,7 +918,8 @@ static int gen8_oa_read(struct i915_perf_stream *stream,
} }
/** /**
* Copies all buffered OA reports into userspace read() buffer. * gen7_append_oa_reports - Copies all buffered OA reports into
* userspace read() buffer.
* @stream: An i915-perf stream opened for OA metrics * @stream: An i915-perf stream opened for OA metrics
* @buf: destination buffer given by userspace * @buf: destination buffer given by userspace
* @count: the number of bytes userspace wants to read * @count: the number of bytes userspace wants to read
...@@ -3227,7 +3229,7 @@ static long i915_perf_config_locked(struct i915_perf_stream *stream, ...@@ -3227,7 +3229,7 @@ static long i915_perf_config_locked(struct i915_perf_stream *stream,
} }
/** /**
* i915_perf_ioctl - support ioctl() usage with i915 perf stream FDs * i915_perf_ioctl_locked - support ioctl() usage with i915 perf stream FDs
* @stream: An i915 perf stream * @stream: An i915 perf stream
* @cmd: the ioctl request * @cmd: the ioctl request
* @arg: the ioctl data * @arg: the ioctl data
......
...@@ -446,7 +446,7 @@ void drm_sched_stop(struct drm_gpu_scheduler *sched, struct drm_sched_job *bad) ...@@ -446,7 +446,7 @@ void drm_sched_stop(struct drm_gpu_scheduler *sched, struct drm_sched_job *bad)
EXPORT_SYMBOL(drm_sched_stop); EXPORT_SYMBOL(drm_sched_stop);
/** /**
* drm_sched_job_recovery - recover jobs after a reset * drm_sched_start - recover jobs after a reset
* *
* @sched: scheduler instance * @sched: scheduler instance
* @full_recovery: proceed with complete sched restart * @full_recovery: proceed with complete sched restart
......
...@@ -64,7 +64,7 @@ v3d_job_free(struct drm_sched_job *sched_job) ...@@ -64,7 +64,7 @@ v3d_job_free(struct drm_sched_job *sched_job)
} }
/** /**
* Returns the fences that the job depends on, one by one. * v3d_job_dependency - Returns the fences that the job depends on, one by one.
* *
* If placed in the scheduler's .dependency method, the corresponding * If placed in the scheduler's .dependency method, the corresponding
* .run_job won't be called until all of them have been signaled. * .run_job won't be called until all of them have been signaled.
......
...@@ -391,7 +391,7 @@ static const struct drm_gem_object_funcs vc4_gem_object_funcs = { ...@@ -391,7 +391,7 @@ static const struct drm_gem_object_funcs vc4_gem_object_funcs = {
}; };
/** /**
* vc4_gem_create_object - Implementation of driver->gem_create_object. * vc4_create_object - Implementation of driver->gem_create_object.
* @dev: DRM device * @dev: DRM device
* @size: Size in bytes of the memory the object will reference * @size: Size in bytes of the memory the object will reference
* *
......
...@@ -167,7 +167,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, ...@@ -167,7 +167,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
/** /**
* drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state
* @plane: the loop cursor * @plane: the loop cursor
* @crtc_state: the incoming CRTC state * @crtc_state: the incoming CRTC state
* *
...@@ -180,7 +180,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc, ...@@ -180,7 +180,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
/** /**
* drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state
* @plane: the loop cursor * @plane: the loop cursor
* @plane_state: loop cursor for the plane's state, must be const * @plane_state: loop cursor for the plane's state, must be const
* @crtc_state: the incoming CRTC state * @crtc_state: the incoming CRTC state
......
...@@ -84,7 +84,7 @@ enum drm_connector_status { ...@@ -84,7 +84,7 @@ enum drm_connector_status {
}; };
/** /**
* enum drm_connector_registration_status - userspace registration status for * enum drm_connector_registration_state - userspace registration status for
* a &drm_connector * a &drm_connector
* *
* This enum is used to track the status of initializing a connector and * This enum is used to track the status of initializing a connector and
......
...@@ -27,7 +27,7 @@ struct pci_controller; ...@@ -27,7 +27,7 @@ struct pci_controller;
/** /**
* enum drm_switch_power - power state of drm device * enum switch_power_state - power state of drm device
*/ */
enum switch_power_state { enum switch_power_state {
......
...@@ -273,7 +273,8 @@ struct drm_dsc_config { ...@@ -273,7 +273,8 @@ struct drm_dsc_config {
}; };
/** /**
* struct picture_parameter_set - Represents 128 bytes of Picture Parameter Set * struct drm_dsc_picture_parameter_set - Represents 128 bytes of
* Picture Parameter Set
* *
* The VESA DSC standard defines picture parameter set (PPS) which display * The VESA DSC standard defines picture parameter set (PPS) which display
* stream compression encoders must communicate to decoders. * stream compression encoders must communicate to decoders.
......
...@@ -66,8 +66,8 @@ struct drm_gem_vram_object { ...@@ -66,8 +66,8 @@ struct drm_gem_vram_object {
}; };
/** /**
* Returns the container of type &struct drm_gem_vram_object * drm_gem_vram_of_bo - Returns the container of type
* for field bo. * &struct drm_gem_vram_object for field bo.
* @bo: the VRAM buffer object * @bo: the VRAM buffer object
* Returns: The containing GEM VRAM object * Returns: The containing GEM VRAM object
*/ */
...@@ -78,8 +78,8 @@ static inline struct drm_gem_vram_object *drm_gem_vram_of_bo( ...@@ -78,8 +78,8 @@ static inline struct drm_gem_vram_object *drm_gem_vram_of_bo(
} }
/** /**
* Returns the container of type &struct drm_gem_vram_object * drm_gem_vram_of_gem - Returns the container of type
* for field gem. * &struct drm_gem_vram_object for field gem.
* @gem: the GEM object * @gem: the GEM object
* Returns: The containing GEM VRAM object * Returns: The containing GEM VRAM object
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment