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

Configure Feed

Select the types of activity you want to include in your feed.

drm/atomic: Spell CRTC consistently

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 <tzimmermann@suse.de>
Signed-off-by: Thierry Reding <treding@nvidia.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20191206135336.2084564-2-thierry.reding@gmail.com

+69 -69
+10 -10
drivers/gpu/drm/drm_atomic.c
··· 251 251 * @ref: This atomic state to deallocate 252 252 * 253 253 * This frees all memory associated with an atomic state, including all the 254 - * per-object state for planes, crtcs and connectors. 254 + * per-object state for planes, CRTCs and connectors. 255 255 */ 256 256 void __drm_atomic_state_free(struct kref *ref) 257 257 { ··· 272 272 EXPORT_SYMBOL(__drm_atomic_state_free); 273 273 274 274 /** 275 - * drm_atomic_get_crtc_state - get crtc state 275 + * drm_atomic_get_crtc_state - get CRTC state 276 276 * @state: global atomic state object 277 - * @crtc: crtc to get state object for 277 + * @crtc: CRTC to get state object for 278 278 * 279 - * This function returns the crtc state for the given crtc, allocating it if 280 - * needed. It will also grab the relevant crtc lock to make sure that the state 279 + * This function returns the CRTC state for the given CRTC, allocating it if 280 + * needed. It will also grab the relevant CRTC lock to make sure that the state 281 281 * is consistent. 282 282 * 283 283 * Returns: ··· 1018 1018 } 1019 1019 1020 1020 /** 1021 - * drm_atomic_add_affected_connectors - add connectors for crtc 1021 + * drm_atomic_add_affected_connectors - add connectors for CRTC 1022 1022 * @state: atomic state 1023 - * @crtc: DRM crtc 1023 + * @crtc: DRM CRTC 1024 1024 * 1025 1025 * This function walks the current configuration and adds all connectors 1026 1026 * currently using @crtc to the atomic configuration @state. Note that this 1027 1027 * function must acquire the connection mutex. This can potentially cause 1028 - * unneeded seralization if the update is just for the planes on one crtc. Hence 1028 + * unneeded seralization if the update is just for the planes on one CRTC. Hence 1029 1029 * drivers and helpers should only call this when really needed (e.g. when a 1030 1030 * full modeset needs to happen due to some change). 1031 1031 * ··· 1078 1078 EXPORT_SYMBOL(drm_atomic_add_affected_connectors); 1079 1079 1080 1080 /** 1081 - * drm_atomic_add_affected_planes - add planes for crtc 1081 + * drm_atomic_add_affected_planes - add planes for CRTC 1082 1082 * @state: atomic state 1083 - * @crtc: DRM crtc 1083 + * @crtc: DRM CRTC 1084 1084 * 1085 1085 * This function walks the current configuration and adds all planes 1086 1086 * currently used by @crtc to the atomic configuration @state. This is useful
+32 -32
drivers/gpu/drm/drm_atomic_helper.c
··· 150 150 * is not set, an error is returned. Userspace can provide a solution 151 151 * through the atomic ioctl. 152 152 * 153 - * If the flag is set conflicting connectors are removed from the crtc 154 - * and the crtc is disabled if no encoder is left. This preserves 153 + * If the flag is set conflicting connectors are removed from the CRTC 154 + * and the CRTC is disabled if no encoder is left. This preserves 155 155 * compatibility with the legacy set_config behavior. 156 156 */ 157 157 drm_connector_list_iter_begin(state->dev, &conn_iter); ··· 561 561 * @state: the driver state object 562 562 * 563 563 * Check the state object to see if the requested state is physically possible. 564 - * This does all the crtc and connector related computations for an atomic 564 + * This does all the CRTC and connector related computations for an atomic 565 565 * update and adds any additional connectors needed for full modesets. It calls 566 566 * the various per-object callbacks in the follow order: 567 567 * 568 568 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder. 569 569 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state. 570 570 * 3. If it's determined a modeset is needed then all connectors on the affected 571 - * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them. 571 + * CRTC are added and &drm_connector_helper_funcs.atomic_check is run on them. 572 572 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and 573 573 * &drm_crtc_helper_funcs.mode_valid are called on the affected components. 574 574 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges. 575 575 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state. 576 - * This function is only called when the encoder will be part of a configured crtc, 576 + * This function is only called when the encoder will be part of a configured CRTC, 577 577 * it must not be used for implementing connector property validation. 578 578 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called 579 579 * instead. 580 - * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with crtc constraints. 580 + * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with CRTC constraints. 581 581 * 582 582 * &drm_crtc_state.mode_changed is set when the input mode is changed. 583 583 * &drm_crtc_state.connectors_changed is set when a connector is added or 584 - * removed from the crtc. &drm_crtc_state.active_changed is set when 584 + * removed from the CRTC. &drm_crtc_state.active_changed is set when 585 585 * &drm_crtc_state.active changes, which is used for DPMS. 586 586 * See also: drm_atomic_crtc_needs_modeset() 587 587 * ··· 692 692 693 693 /* 694 694 * After all the routing has been prepared we need to add in any 695 - * connector which is itself unchanged, but whose crtc changes its 695 + * connector which is itself unchanged, but whose CRTC changes its 696 696 * configuration. This must be done before calling mode_fixup in case a 697 697 * crtc only changed its mode but has the same set of connectors. 698 698 */ ··· 741 741 /** 742 742 * drm_atomic_helper_check_plane_state() - Check plane state for validity 743 743 * @plane_state: plane state to check 744 - * @crtc_state: crtc state to check 744 + * @crtc_state: CRTC state to check 745 745 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point 746 746 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point 747 747 * @can_position: is it legal to position the plane such that it 748 - * doesn't cover the entire crtc? This will generally 748 + * doesn't cover the entire CRTC? This will generally 749 749 * only be false for primary planes. 750 - * @can_update_disabled: can the plane be updated while the crtc 750 + * @can_update_disabled: can the plane be updated while the CRTC 751 751 * is disabled? 752 752 * 753 753 * Checks that a desired plane update is valid, and updates various ··· 844 844 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check 845 845 * hooks provided by the driver. 846 846 * 847 - * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has 847 + * It also sets &drm_crtc_state.planes_changed to indicate that a CRTC has 848 848 * updated planes. 849 849 * 850 850 * RETURNS: ··· 908 908 * @state: the driver state object 909 909 * 910 910 * Check the state object to see if the requested state is physically possible. 911 - * Only crtcs and planes have check callbacks, so for any additional (global) 911 + * Only CRTCs and planes have check callbacks, so for any additional (global) 912 912 * checking that a driver needs it can simply wrap that around this function. 913 913 * Drivers without such needs can directly use this as their 914 914 * &drm_mode_config_funcs.atomic_check callback. ··· 961 961 struct drm_crtc_state *new_state) 962 962 { 963 963 /* 964 - * No new_state means the crtc is off, so the only criteria is whether 964 + * No new_state means the CRTC is off, so the only criteria is whether 965 965 * it's currently active or in self refresh mode. 966 966 */ 967 967 if (!new_state) 968 968 return drm_atomic_crtc_effectively_active(old_state); 969 969 970 970 /* 971 - * We need to run through the crtc_funcs->disable() function if the crtc 971 + * We need to run through the crtc_funcs->disable() function if the CRTC 972 972 * is currently on, if it's transitioning to self refresh mode, or if 973 973 * it's in self refresh mode and needs to be fully disabled. 974 974 */ ··· 1087 1087 * @old_state: atomic state object with old state structures 1088 1088 * 1089 1089 * This function updates all the various legacy modeset state pointers in 1090 - * connectors, encoders and crtcs. It also updates the timestamping constants 1090 + * connectors, encoders and CRTCs. It also updates the timestamping constants 1091 1091 * used for precise vblank timestamps by calling 1092 1092 * drm_calc_timestamping_constants(). 1093 1093 * ··· 1236 1236 * This function shuts down all the outputs that need to be shut down and 1237 1237 * prepares them (if required) with the new mode. 1238 1238 * 1239 - * For compatibility with legacy crtc helpers this should be called before 1239 + * For compatibility with legacy CRTC helpers this should be called before 1240 1240 * drm_atomic_helper_commit_planes(), which is what the default commit function 1241 1241 * does. But drivers with different needs can group the modeset commits together 1242 1242 * and do the plane commits at the end. This is useful for drivers doing runtime ··· 1282 1282 * This function enables all the outputs with the new configuration which had to 1283 1283 * be turned off for the update. 1284 1284 * 1285 - * For compatibility with legacy crtc helpers this should be called after 1285 + * For compatibility with legacy CRTC helpers this should be called after 1286 1286 * drm_atomic_helper_commit_planes(), which is what the default commit function 1287 1287 * does. But drivers with different needs can group the modeset commits together 1288 1288 * and do the plane commits at the end. This is useful for drivers doing runtime ··· 1414 1414 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences); 1415 1415 1416 1416 /** 1417 - * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs 1417 + * drm_atomic_helper_wait_for_vblanks - wait for vblank on CRTCs 1418 1418 * @dev: DRM device 1419 1419 * @old_state: atomic state object with old state structures 1420 1420 * 1421 1421 * Helper to, after atomic commit, wait for vblanks on all affected 1422 - * crtcs (ie. before cleaning up old framebuffers using 1422 + * CRTCs (ie. before cleaning up old framebuffers using 1423 1423 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the 1424 1424 * framebuffers have actually changed to optimize for the legacy cursor and 1425 1425 * plane update use-case. ··· 2391 2391 * @flags: flags for committing plane state 2392 2392 * 2393 2393 * This function commits the new plane state using the plane and atomic helper 2394 - * functions for planes and crtcs. It assumes that the atomic state has already 2394 + * functions for planes and CRTCs. It assumes that the atomic state has already 2395 2395 * been pushed into the relevant object state pointers, since this step can no 2396 2396 * longer fail. 2397 2397 * ··· 2512 2512 EXPORT_SYMBOL(drm_atomic_helper_commit_planes); 2513 2513 2514 2514 /** 2515 - * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc 2516 - * @old_crtc_state: atomic state object with the old crtc state 2515 + * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a CRTC 2516 + * @old_crtc_state: atomic state object with the old CRTC state 2517 2517 * 2518 2518 * This function commits the new plane state using the plane and atomic helper 2519 - * functions for planes on the specific crtc. It assumes that the atomic state 2519 + * functions for planes on the specific CRTC. It assumes that the atomic state 2520 2520 * has already been pushed into the relevant object state pointers, since this 2521 2521 * step can no longer fail. 2522 2522 * 2523 - * This function is useful when plane updates should be done crtc-by-crtc 2523 + * This function is useful when plane updates should be done CRTC-by-CRTC 2524 2524 * instead of one global step like drm_atomic_helper_commit_planes() does. 2525 2525 * 2526 2526 * This function can only be savely used when planes are not allowed to move ··· 2810 2810 * @plane: plane object to update 2811 2811 * @crtc: owning CRTC of owning plane 2812 2812 * @fb: framebuffer to flip onto plane 2813 - * @crtc_x: x offset of primary plane on crtc 2814 - * @crtc_y: y offset of primary plane on crtc 2815 - * @crtc_w: width of primary plane rectangle on crtc 2816 - * @crtc_h: height of primary plane rectangle on crtc 2813 + * @crtc_x: x offset of primary plane on @crtc 2814 + * @crtc_y: y offset of primary plane on @crtc 2815 + * @crtc_w: width of primary plane rectangle on @crtc 2816 + * @crtc_h: height of primary plane rectangle on @crtc 2817 2817 * @src_x: x offset of @fb for panning 2818 2818 * @src_y: y offset of @fb for panning 2819 2819 * @src_w: width of source rectangle in @fb ··· 2919 2919 * @set: mode set configuration 2920 2920 * @ctx: lock acquisition context 2921 2921 * 2922 - * Provides a default crtc set_config handler using the atomic driver interface. 2922 + * Provides a default CRTC set_config handler using the atomic driver interface. 2923 2923 * 2924 2924 * NOTE: For backwards compatibility with old userspace this automatically 2925 2925 * resets the "link-status" property to GOOD, to force any link ··· 3332 3332 3333 3333 /** 3334 3334 * drm_atomic_helper_page_flip - execute a legacy page flip 3335 - * @crtc: DRM crtc 3335 + * @crtc: DRM CRTC 3336 3336 * @fb: DRM framebuffer 3337 3337 * @event: optional DRM event to signal upon completion 3338 3338 * @flags: flip flags for non-vblank sync'ed updates ··· 3376 3376 3377 3377 /** 3378 3378 * drm_atomic_helper_page_flip_target - do page flip on target vblank period. 3379 - * @crtc: DRM crtc 3379 + * @crtc: DRM CRTC 3380 3380 * @fb: DRM framebuffer 3381 3381 * @event: optional DRM event to signal upon completion 3382 3382 * @flags: flip flags for non-vblank sync'ed updates
+8 -8
drivers/gpu/drm/drm_atomic_uapi.c
··· 160 160 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc); 161 161 162 162 /** 163 - * drm_atomic_set_crtc_for_plane - set crtc for plane 163 + * drm_atomic_set_crtc_for_plane - set CRTC for plane 164 164 * @plane_state: the plane whose incoming state to update 165 - * @crtc: crtc to use for the plane 165 + * @crtc: CRTC to use for the plane 166 166 * 167 - * Changing the assigned crtc for a plane requires us to grab the lock and state 168 - * for the new crtc, as needed. This function takes care of all these details 167 + * Changing the assigned CRTC for a plane requires us to grab the lock and state 168 + * for the new CRTC, as needed. This function takes care of all these details 169 169 * besides updating the pointer in the state object itself. 170 170 * 171 171 * Returns: ··· 279 279 EXPORT_SYMBOL(drm_atomic_set_fence_for_plane); 280 280 281 281 /** 282 - * drm_atomic_set_crtc_for_connector - set crtc for connector 282 + * drm_atomic_set_crtc_for_connector - set CRTC for connector 283 283 * @conn_state: atomic state object for the connector 284 - * @crtc: crtc to use for the connector 284 + * @crtc: CRTC to use for the connector 285 285 * 286 - * Changing the assigned crtc for a connector requires us to grab the lock and 287 - * state for the new crtc, as needed. This function takes care of all these 286 + * Changing the assigned CRTC for a connector requires us to grab the lock and 287 + * state for the new CRTC, as needed. This function takes care of all these 288 288 * details besides updating the pointer in the state object itself. 289 289 * 290 290 * Returns:
+15 -15
include/drm/drm_atomic.h
··· 363 363 * When a connector or plane is not bound to any CRTC, it's still important 364 364 * to preserve linearity to prevent the atomic states from being freed to early. 365 365 * 366 - * This commit (if set) is not bound to any crtc, but will be completed when 366 + * This commit (if set) is not bound to any CRTC, but will be completed when 367 367 * drm_atomic_helper_commit_hw_done() is called. 368 368 */ 369 369 struct drm_crtc_commit *fake_commit; ··· 476 476 struct drm_encoder *encoder); 477 477 478 478 /** 479 - * drm_atomic_get_existing_crtc_state - get crtc state, if it exists 479 + * drm_atomic_get_existing_crtc_state - get CRTC state, if it exists 480 480 * @state: global atomic state object 481 - * @crtc: crtc to grab 481 + * @crtc: CRTC to grab 482 482 * 483 - * This function returns the crtc state for the given crtc, or NULL 484 - * if the crtc is not part of the global atomic state. 483 + * This function returns the CRTC state for the given CRTC, or NULL 484 + * if the CRTC is not part of the global atomic state. 485 485 * 486 486 * This function is deprecated, @drm_atomic_get_old_crtc_state or 487 487 * @drm_atomic_get_new_crtc_state should be used instead. ··· 494 494 } 495 495 496 496 /** 497 - * drm_atomic_get_old_crtc_state - get old crtc state, if it exists 497 + * drm_atomic_get_old_crtc_state - get old CRTC state, if it exists 498 498 * @state: global atomic state object 499 - * @crtc: crtc to grab 499 + * @crtc: CRTC to grab 500 500 * 501 - * This function returns the old crtc state for the given crtc, or 502 - * NULL if the crtc is not part of the global atomic state. 501 + * This function returns the old CRTC state for the given CRTC, or 502 + * NULL if the CRTC is not part of the global atomic state. 503 503 */ 504 504 static inline struct drm_crtc_state * 505 505 drm_atomic_get_old_crtc_state(struct drm_atomic_state *state, ··· 508 508 return state->crtcs[drm_crtc_index(crtc)].old_state; 509 509 } 510 510 /** 511 - * drm_atomic_get_new_crtc_state - get new crtc state, if it exists 511 + * drm_atomic_get_new_crtc_state - get new CRTC state, if it exists 512 512 * @state: global atomic state object 513 - * @crtc: crtc to grab 513 + * @crtc: CRTC to grab 514 514 * 515 - * This function returns the new crtc state for the given crtc, or 516 - * NULL if the crtc is not part of the global atomic state. 515 + * This function returns the new CRTC state for the given CRTC, or 516 + * NULL if the CRTC is not part of the global atomic state. 517 517 */ 518 518 static inline struct drm_crtc_state * 519 519 drm_atomic_get_new_crtc_state(struct drm_atomic_state *state, ··· 978 978 } 979 979 980 980 /** 981 - * drm_atomic_crtc_effectively_active - compute whether crtc is actually active 981 + * drm_atomic_crtc_effectively_active - compute whether CRTC is actually active 982 982 * @state: &drm_crtc_state for the CRTC 983 983 * 984 984 * When in self refresh mode, the crtc_state->active value will be false, since 985 - * the crtc is off. However in some cases we're interested in whether the crtc 985 + * the CRTC is off. However in some cases we're interested in whether the CRTC 986 986 * is active, or effectively active (ie: it's connected to an active display). 987 987 * In these cases, use this function instead of just checking active. 988 988 */
+4 -4
include/drm/drm_atomic_helper.h
··· 152 152 /** 153 153 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC 154 154 * @plane: the loop cursor 155 - * @crtc: the crtc whose planes are iterated 155 + * @crtc: the CRTC whose planes are iterated 156 156 * 157 157 * This iterates over the current state, useful (for example) when applying 158 158 * atomic state after it has been checked and swapped. To iterate over the ··· 166 166 /** 167 167 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state 168 168 * @plane: the loop cursor 169 - * @crtc_state: the incoming crtc-state 169 + * @crtc_state: the incoming CRTC state 170 170 * 171 171 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 172 172 * attached if the specified state is applied. Useful during for example ··· 180 180 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state 181 181 * @plane: the loop cursor 182 182 * @plane_state: loop cursor for the plane's state, must be const 183 - * @crtc_state: the incoming crtc-state 183 + * @crtc_state: the incoming CRTC state 184 184 * 185 185 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be 186 186 * attached if the specified state is applied. Useful during for example ··· 189 189 * 190 190 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a 191 191 * const plane_state. This is useful when a driver just wants to peek at other 192 - * active planes on this crtc, but does not need to change it. 192 + * active planes on this CRTC, but does not need to change it. 193 193 */ 194 194 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \ 195 195 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \