Skip to content

Commit e9d2871

Browse files
mchehabdanvet
authored andcommitted
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: Mauro Carvalho Chehab <[email protected]> Acked-by: Jani Nikula <[email protected]> Signed-off-by: Daniel Vetter <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/12d4ca26f6843618200529ce5445063734d38c04.1605521731.git.mchehab+huawei@kernel.org
1 parent 250fe9a commit e9d2871

20 files changed

+32
-28
lines changed

drivers/gpu/drm/drm_atomic_state_helper.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -543,7 +543,7 @@ void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
543543
EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
544544

545545
/**
546-
* __drm_atomic_helper_private_duplicate_state - copy atomic private state
546+
* __drm_atomic_helper_private_obj_duplicate_state - copy atomic private state
547547
* @obj: CRTC object
548548
* @state: new private object state
549549
*

drivers/gpu/drm/drm_connector.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1432,7 +1432,8 @@ void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
14321432
EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
14331433

14341434
/**
1435-
* drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1435+
* drm_connector_attach_tv_margin_properties - attach TV connector margin
1436+
* properties
14361437
* @connector: DRM connector
14371438
*
14381439
* Called by a driver when it needs to attach TV margin props to a connector.

drivers/gpu/drm/drm_dp_helper.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1161,7 +1161,7 @@ drm_dp_subconnector_type(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
11611161
EXPORT_SYMBOL(drm_dp_subconnector_type);
11621162

11631163
/**
1164-
* drm_mode_set_dp_subconnector_property - set subconnector for DP connector
1164+
* drm_dp_set_subconnector_property - set subconnector for DP connector
11651165
* @connector: connector to set property on
11661166
* @status: connector status
11671167
* @dpcd: DisplayPort configuration data

drivers/gpu/drm/drm_framebuffer.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ int drm_mode_getfb(struct drm_device *dev,
552552
}
553553

554554
/**
555-
* drm_mode_getfb2 - get extended FB info
555+
* drm_mode_getfb2_ioctl - get extended FB info
556556
* @dev: drm device for the ioctl
557557
* @data: data pointer for the ioctl
558558
* @file_priv: drm file for the ioctl call

drivers/gpu/drm/drm_gem.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -867,7 +867,7 @@ drm_gem_flink_ioctl(struct drm_device *dev, void *data,
867867
}
868868

869869
/**
870-
* drm_gem_open - implementation of the GEM_OPEN ioctl
870+
* drm_gem_open_ioctl - implementation of the GEM_OPEN ioctl
871871
* @dev: drm_device
872872
* @data: ioctl data
873873
* @file_priv: drm file-private structure
@@ -912,7 +912,7 @@ drm_gem_open_ioctl(struct drm_device *dev, void *data,
912912
}
913913

914914
/**
915-
* gem_gem_open - initalizes GEM file-private structures at devnode open time
915+
* drm_gem_open - initalizes GEM file-private structures at devnode open time
916916
* @dev: drm_device which is being opened by userspace
917917
* @file_private: drm file-private structure to set up
918918
*

drivers/gpu/drm/drm_gem_vram_helper.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,7 @@ static void drm_gem_vram_object_free(struct drm_gem_object *gem)
617617
*/
618618

619619
/**
620-
* drm_gem_vram_driver_create_dumb() - \
620+
* drm_gem_vram_driver_dumb_create() - \
621621
Implements &struct drm_driver.dumb_create
622622
* @file: the DRM file
623623
* @dev: the DRM device

drivers/gpu/drm/drm_mode_object.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ void drm_mode_object_unregister(struct drm_device *dev,
115115
}
116116

117117
/**
118-
* drm_lease_required - check types which must be leased to be used
118+
* drm_mode_object_lease_required - check types which must be leased to be used
119119
* @type: type of object
120120
*
121121
* Returns whether the provided type of drm_mode_object must

drivers/gpu/drm/drm_modes.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1889,7 +1889,7 @@ drm_mode_create_from_cmdline_mode(struct drm_device *dev,
18891889
EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode);
18901890

18911891
/**
1892-
* drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1892+
* drm_mode_convert_to_umode - convert a drm_display_mode into a modeinfo
18931893
* @out: drm_mode_modeinfo struct to return to the user
18941894
* @in: drm_display_mode to use
18951895
*
@@ -1941,7 +1941,7 @@ void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
19411941
}
19421942

19431943
/**
1944-
* drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1944+
* drm_mode_convert_umode - convert a modeinfo into a drm_display_mode
19451945
* @dev: drm device
19461946
* @out: drm_display_mode to return to the user
19471947
* @in: drm_mode_modeinfo to use

drivers/gpu/drm/drm_scdc_helper.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ ssize_t drm_scdc_write(struct i2c_adapter *adapter, u8 offset,
125125
EXPORT_SYMBOL(drm_scdc_write);
126126

127127
/**
128-
* drm_scdc_check_scrambling_status - what is status of scrambling?
128+
* drm_scdc_get_scrambling_status - what is status of scrambling?
129129
* @adapter: I2C adapter for DDC channel
130130
*
131131
* Reads the scrambler status over SCDC, and checks the

drivers/gpu/drm/i915/display/intel_dpll_mgr.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4587,7 +4587,7 @@ void intel_dpll_sanitize_state(struct drm_i915_private *i915)
45874587
}
45884588

45894589
/**
4590-
* intel_shared_dpll_dump_hw_state - write hw_state to dmesg
4590+
* intel_dpll_dump_hw_state - write hw_state to dmesg
45914591
* @dev_priv: i915 drm device
45924592
* @hw_state: hw state to be written to the log
45934593
*

drivers/gpu/drm/i915/i915_gem_evict.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ i915_gem_evict_something(struct i915_address_space *vm,
238238
}
239239

240240
/**
241-
* i915_gem_evict_for_vma - Evict vmas to make room for binding a new one
241+
* i915_gem_evict_for_node - Evict vmas to make room for binding a new one
242242
* @vm: address space to evict from
243243
* @target: range (and color) to evict for
244244
* @flags: additional flags to control the eviction algorithm

drivers/gpu/drm/i915/i915_perf.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,8 @@ static int append_oa_sample(struct i915_perf_stream *stream,
625625
}
626626

627627
/**
628-
* Copies all buffered OA reports into userspace read() buffer.
628+
* gen8_append_oa_reports - Copies all buffered OA reports into
629+
* userspace read() buffer.
629630
* @stream: An i915-perf stream opened for OA metrics
630631
* @buf: destination buffer given by userspace
631632
* @count: the number of bytes userspace wants to read
@@ -917,7 +918,8 @@ static int gen8_oa_read(struct i915_perf_stream *stream,
917918
}
918919

919920
/**
920-
* Copies all buffered OA reports into userspace read() buffer.
921+
* gen7_append_oa_reports - Copies all buffered OA reports into
922+
* userspace read() buffer.
921923
* @stream: An i915-perf stream opened for OA metrics
922924
* @buf: destination buffer given by userspace
923925
* @count: the number of bytes userspace wants to read
@@ -3227,7 +3229,7 @@ static long i915_perf_config_locked(struct i915_perf_stream *stream,
32273229
}
32283230

32293231
/**
3230-
* i915_perf_ioctl - support ioctl() usage with i915 perf stream FDs
3232+
* i915_perf_ioctl_locked - support ioctl() usage with i915 perf stream FDs
32313233
* @stream: An i915 perf stream
32323234
* @cmd: the ioctl request
32333235
* @arg: the ioctl data

drivers/gpu/drm/scheduler/sched_main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ void drm_sched_stop(struct drm_gpu_scheduler *sched, struct drm_sched_job *bad)
446446
EXPORT_SYMBOL(drm_sched_stop);
447447

448448
/**
449-
* drm_sched_job_recovery - recover jobs after a reset
449+
* drm_sched_start - recover jobs after a reset
450450
*
451451
* @sched: scheduler instance
452452
* @full_recovery: proceed with complete sched restart

drivers/gpu/drm/v3d/v3d_sched.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ v3d_job_free(struct drm_sched_job *sched_job)
6464
}
6565

6666
/**
67-
* Returns the fences that the job depends on, one by one.
67+
* v3d_job_dependency - Returns the fences that the job depends on, one by one.
6868
*
6969
* If placed in the scheduler's .dependency method, the corresponding
7070
* .run_job won't be called until all of them have been signaled.

drivers/gpu/drm/vc4/vc4_bo.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ static const struct drm_gem_object_funcs vc4_gem_object_funcs = {
391391
};
392392

393393
/**
394-
* vc4_gem_create_object - Implementation of driver->gem_create_object.
394+
* vc4_create_object - Implementation of driver->gem_create_object.
395395
* @dev: DRM device
396396
* @size: Size in bytes of the memory the object will reference
397397
*

include/drm/drm_atomic_helper.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
167167
drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
168168

169169
/**
170-
* drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
170+
* drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state
171171
* @plane: the loop cursor
172172
* @crtc_state: the incoming CRTC state
173173
*
@@ -180,7 +180,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
180180
drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
181181

182182
/**
183-
* drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
183+
* drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state
184184
* @plane: the loop cursor
185185
* @plane_state: loop cursor for the plane's state, must be const
186186
* @crtc_state: the incoming CRTC state

include/drm/drm_connector.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ enum drm_connector_status {
8484
};
8585

8686
/**
87-
* enum drm_connector_registration_status - userspace registration status for
87+
* enum drm_connector_registration_state - userspace registration status for
8888
* a &drm_connector
8989
*
9090
* This enum is used to track the status of initializing a connector and

include/drm/drm_device.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ struct pci_controller;
2727

2828

2929
/**
30-
* enum drm_switch_power - power state of drm device
30+
* enum switch_power_state - power state of drm device
3131
*/
3232

3333
enum switch_power_state {

include/drm/drm_dsc.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,8 @@ struct drm_dsc_config {
273273
};
274274

275275
/**
276-
* struct picture_parameter_set - Represents 128 bytes of Picture Parameter Set
276+
* struct drm_dsc_picture_parameter_set - Represents 128 bytes of
277+
* Picture Parameter Set
277278
*
278279
* The VESA DSC standard defines picture parameter set (PPS) which display
279280
* stream compression encoders must communicate to decoders.

include/drm/drm_gem_vram_helper.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ struct drm_gem_vram_object {
6666
};
6767

6868
/**
69-
* Returns the container of type &struct drm_gem_vram_object
70-
* for field bo.
69+
* drm_gem_vram_of_bo - Returns the container of type
70+
* &struct drm_gem_vram_object for field bo.
7171
* @bo: the VRAM buffer object
7272
* Returns: The containing GEM VRAM object
7373
*/
@@ -78,8 +78,8 @@ static inline struct drm_gem_vram_object *drm_gem_vram_of_bo(
7878
}
7979

8080
/**
81-
* Returns the container of type &struct drm_gem_vram_object
82-
* for field gem.
81+
* drm_gem_vram_of_gem - Returns the container of type
82+
* &struct drm_gem_vram_object for field gem.
8383
* @gem: the GEM object
8484
* Returns: The containing GEM VRAM object
8585
*/

0 commit comments

Comments
 (0)