drm: Fix a couple of typos, punctation and whitespace issues
Subsystems (2)
PATCH v2 1/2 drm: Fix a couple of typos, punctation and whitespace issues
From: Thierry Reding <[email protected]>
These are just a couple of things that I came across as I was reading through the code and comments.
v2: added one more hunk that ended up in the wrong patch
Reviewed-by Thomas Zimmermann <[email protected]>
Signed-off-by Thierry Reding <[email protected]>
--- drivers/gpu/drm/drm_atomic_helper.c | 12 ++++++------ drivers/gpu/drm/drm_edid.c | 2 +- include/drm/drm_atomic.h | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-)
drivers/gpu/drm/drm_atomic_helper.c +6 -6
@@ -220,7 +220,7 @@ set_best_encoder(struct drm_atomic_state *state, crtc = conn_state->connector->state->crtc;/* A NULL crtc is an error here because we should have -* duplicated a NULL best_encoder when crtc was NULL. +* duplicated a NULL best_encoder when crtc was NULL. * As an exception restoring duplicated atomic state * during resume is allowed, so don't warn when * best_encoder is equal to encoder we intend to set.
@@ -562,7 +562,7 @@ mode_valid(struct drm_atomic_state *state)* * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder. * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state. -* 3. If it's determined a modeset is needed then all connectors on the affected crtc +* 3. If it's determined a modeset is needed then all connectors on the affected * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them. * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
@@ -1407,7 +1407,7 @@ EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);* @dev: DRM device * @old_state: atomic state object with old state structures * -* Helper to, after atomic commit, wait for vblanks on all effected +* Helper to, after atomic commit, wait for vblanks on all affected * crtcs (ie. before cleaning up old framebuffers using * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the * framebuffers have actually changed to optimize for the legacy cursor and
@@ -1467,10 +1467,10 @@ EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);* @dev: DRM device * @old_state: atomic state object with old state structures * -* Helper to, after atomic commit, wait for page flips on all effected +* Helper to, after atomic commit, wait for page flips on all affected * crtcs (ie. before cleaning up old framebuffers using * drm_atomic_helper_cleanup_planes()). Compared to -* drm_atomic_helper_wait_for_vblanks() this waits for the completion of on all +* drm_atomic_helper_wait_for_vblanks() this waits for the completion on all * CRTCs, assuming that cursors-only updates are signalling their completion * immediately (or using a different path). *
@@ -2197,7 +2197,7 @@ EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);* drm_atomic_helper_fake_vblank - fake VBLANK events if needed * @old_state: atomic state object with old state structures * -* This function walks all CRTCs and fake VBLANK events on those with +* This function walks all CRTCs and fakes VBLANK events on those with * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL. * The primary use of this function is writeback connectors working in oneshot * mode and faking VBLANK events. In this case they only fake the VBLANK event
drivers/gpu/drm/drm_edid.c +1 -1
@@ -4573,7 +4573,7 @@ static void drm_parse_hdmi_forum_vsdb(struct drm_connector *connector,if (scdc->supported) { scdc->scrambling.supported = true; -/* Few sinks support scrambling for cloks < 340M */ +/* Few sinks support scrambling for clocks < 340M */ if ((hf_vsdb[6 ] &0x8 )) scdc->scrambling.low_rates = true; }
include/drm/drm_atomic.h +1 -1
@@ -35,7 +35,7 @@* struct drm_crtc_commit - track modeset commits on a CRTC * * This structure is used to track pending modeset changes and atomic commit on -* a per-CRTC basis. Since updating the list should never block this structure +* a per-CRTC basis. Since updating the list should never block, this structure * is reference counted to allow waiters to safely wait on an event to complete, * without holding any locks. *
Signature · 6 lines
2.23.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v2 2/2 drm/atomic: Spell CRTC consistently
From: Thierry Reding <[email protected]>
CRTC is an abbreviation and should be all caps in prose. Update all kerneldoc comments to use a consistent spelling.
v2: remove hunk unrelated to the CRTC spelling fixes
Reviewed-by Thomas Zimmermann <[email protected]>
Signed-off-by Thierry Reding <[email protected]>
--- drivers/gpu/drm/drm_atomic.c | 20 ++++----- drivers/gpu/drm/drm_atomic_helper.c | 66 ++++++++++++++--------------- drivers/gpu/drm/drm_atomic_uapi.c | 16 +++---- include/drm/drm_atomic.h | 30 ++++++------- include/drm/drm_atomic_helper.h | 8 ++-- 5 files changed, 70 insertions(+), 70 deletions(-)
drivers/gpu/drm/drm_atomic.c +10 -10
@@ -251,7 +251,7 @@ EXPORT_SYMBOL(drm_atomic_state_clear);* @ref: This atomic state to deallocate * * This frees all memory associated with an atomic state, including all the -* per-object state for planes, crtcs and connectors. +* per-object state for planes, CRTCs and connectors. */ void __drm_atomic_state_free (struct kref *ref) {
@@ -272,12 +272,12 @@ void __drm_atomic_state_free(struct kref *ref)EXPORT_SYMBOL (__drm_atomic_state_free);/** -* drm_atomic_get_crtc_state - get crtc state +* drm_atomic_get_crtc_state - get CRTC state * @state: global atomic state object -* @crtc: crtc to get state object for +* @crtc: CRTC to get state object for * -* This function returns the crtc state for the given crtc, allocating it if -* needed. It will also grab the relevant crtc lock to make sure that the state +* This function returns the CRTC state for the given CRTC, allocating it if +* needed. It will also grab the relevant CRTC lock to make sure that the state * is consistent. * * Returns:
@@ -1018,14 +1018,14 @@ static void drm_atomic_connector_print_state(struct drm_printer *p, }/** -* drm_atomic_add_affected_connectors - add connectors for crtc +* drm_atomic_add_affected_connectors - add connectors for CRTC * @state: atomic state -* @crtc: DRM crtc +* @crtc: DRM CRTC * * This function walks the current configuration and adds all connectors * currently using @crtc to the atomic configuration @state. Note that this * function must acquire the connection mutex. This can potentially cause -* unneeded seralization if the update is just for the planes on one crtc. Hence +* unneeded seralization if the update is just for the planes on one CRTC. Hence * drivers and helpers should only call this when really needed (e.g. when a * full modeset needs to happen due to some change). *
@@ -1078,9 +1078,9 @@ drm_atomic_add_affected_connectors(struct drm_atomic_state *state,EXPORT_SYMBOL (drm_atomic_add_affected_connectors);/** -* drm_atomic_add_affected_planes - add planes for crtc +* drm_atomic_add_affected_planes - add planes for CRTC * @state: atomic state -* @crtc: DRM crtc +* @crtc: DRM CRTC * * This function walks the current configuration and adds all planes * currently used by @crtc to the atomic configuration @state. This is useful
drivers/gpu/drm/drm_atomic_helper.c +33 -33
209 lines not on this page · raw message
drivers/gpu/drm/drm_atomic_uapi.c +8 -8
@@ -160,12 +160,12 @@ int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,EXPORT_SYMBOL (drm_atomic_set_mode_prop_for_crtc);/** -* drm_atomic_set_crtc_for_plane - set crtc for plane +* drm_atomic_set_crtc_for_plane - set CRTC for plane * @plane_state: the plane whose incoming state to update -* @crtc: crtc to use for the plane +* @crtc: CRTC to use for the plane * -* Changing the assigned crtc for a plane requires us to grab the lock and state -* for the new crtc, as needed. This function takes care of all these details +* Changing the assigned CRTC for a plane requires us to grab the lock and state +* for the new CRTC, as needed. This function takes care of all these details * besides updating the pointer in the state object itself. * * Returns:
@@ -279,12 +279,12 @@ drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,EXPORT_SYMBOL (drm_atomic_set_fence_for_plane);/** -* drm_atomic_set_crtc_for_connector - set crtc for connector +* drm_atomic_set_crtc_for_connector - set CRTC for connector * @conn_state: atomic state object for the connector -* @crtc: crtc to use for the connector +* @crtc: CRTC to use for the connector * -* Changing the assigned crtc for a connector requires us to grab the lock and -* state for the new crtc, as needed. This function takes care of all these +* Changing the assigned CRTC for a connector requires us to grab the lock and +* state for the new CRTC, as needed. This function takes care of all these * details besides updating the pointer in the state object itself. * * Returns:
include/drm/drm_atomic.h +15 -15
@@ -363,7 +363,7 @@ struct drm_atomic_state {* When a connector or plane is not bound to any CRTC, it's still important * to preserve linearity to prevent the atomic states from being freed to early. * -* This commit (if set) is not bound to any crtc, but will be completed when +* This commit (if set) is not bound to any CRTC, but will be completed when * drm_atomic_helper_commit_hw_done() is called. */ struct drm_crtc_commit *fake_commit;
@@ -476,12 +476,12 @@ drm_atomic_get_new_connector_for_encoder(struct drm_atomic_state *state, struct drm_encoder *encoder);/** -* drm_atomic_get_existing_crtc_state - get crtc state, if it exists +* drm_atomic_get_existing_crtc_state - get CRTC state, if it exists * @state: global atomic state object -* @crtc: crtc to grab +* @crtc: CRTC to grab * -* This function returns the crtc state for the given crtc, or NULL -* if the crtc is not part of the global atomic state. +* This function returns the CRTC state for the given CRTC, or NULL +* if the CRTC is not part of the global atomic state. * * This function is deprecated, @drm_atomic_get_old_crtc_state or * @drm_atomic_get_new_crtc_state should be used instead.
@@ -494,12 +494,12 @@ drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state, }/** -* drm_atomic_get_old_crtc_state - get old crtc state, if it exists +* drm_atomic_get_old_crtc_state - get old CRTC state, if it exists * @state: global atomic state object -* @crtc: crtc to grab +* @crtc: CRTC to grab * -* This function returns the old crtc state for the given crtc, or -* NULL if the crtc is not part of the global atomic state. +* This function returns the old CRTC state for the given CRTC, or +* NULL if the CRTC is not part of the global atomic state. */ static inline struct drm_crtc_state * drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,
@@ -508,12 +508,12 @@ drm_atomic_get_old_crtc_state(struct drm_atomic_state *state,return state->crtcs[drm_crtc_index (crtc)].old_state; }/** -* drm_atomic_get_new_crtc_state - get new crtc state, if it exists +* drm_atomic_get_new_crtc_state - get new CRTC state, if it exists * @state: global atomic state object -* @crtc: crtc to grab +* @crtc: CRTC to grab * -* This function returns the new crtc state for the given crtc, or -* NULL if the crtc is not part of the global atomic state. +* This function returns the new CRTC state for the given CRTC, or +* NULL if the CRTC is not part of the global atomic state. */ static inline struct drm_crtc_state * drm_atomic_get_new_crtc_state(struct drm_atomic_state *state,
@@ -967,11 +967,11 @@ drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state) }/** -* drm_atomic_crtc_effectively_active - compute whether crtc is actually active +* drm_atomic_crtc_effectively_active - compute whether CRTC is actually active * @state: &drm_crtc_state for the CRTC * * When in self refresh mode, the crtc_state->active value will be false, since -* the crtc is off. However in some cases we're interested in whether the crtc +* the CRTC is off. However in some cases we're interested in whether the CRTC * is active, or effectively active (ie: it's connected to an active display). * In these cases, use this function instead of just checking active. */
include/drm/drm_atomic_helper.h +4 -4
@@ -152,7 +152,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,/** * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC * @plane: the loop cursor -* @crtc: the crtc whose planes are iterated +* @crtc: the CRTC whose planes are iterated * * This iterates over the current state, useful (for example) when applying * atomic state after it has been checked and swapped. To iterate over the
@@ -166,7 +166,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,/** * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state * @plane: the loop cursor -* @crtc_state: the incoming crtc-state +* @crtc_state: the incoming CRTC state * * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be * attached if the specified state is applied. Useful during for example
@@ -180,7 +180,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,* drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state * @plane: the loop cursor * @plane_state: loop cursor for the plane's state, must be const -* @crtc_state: the incoming crtc-state +* @crtc_state: the incoming CRTC state * * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be * attached if the specified state is applied. Useful during for example
@@ -189,7 +189,7 @@ int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,* * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a * const plane_state. This is useful when a driver just wants to peek at other -* active planes on this crtc, but does not need to change it. +* active planes on this CRTC, but does not need to change it. */ #define drm_atomic_crtc_state_for_each_plane_state (plane, plane_state, crtc_state) \ drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
Signature · 6 lines
2.23.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel