25  * DOC: atomic plane helpers
27  * The functions here are used by the atomic plane helper functions to
28  * implement legacy plane updates (i.e., drm_plane->update_plane() and
29  * drm_plane->disable_plane()).  This allows plane updates to use the
30  * atomic state infrastructure and perform plane updates as separate
50 				    struct intel_plane *plane)  in intel_plane_state_reset()  argument
54 	__drm_atomic_helper_plane_state_reset(&plane_state->uapi, &plane->base);  in intel_plane_state_reset()
62 	struct intel_plane *plane;  in intel_plane_alloc()  local
64 	plane = kzalloc(sizeof(*plane), GFP_KERNEL);  in intel_plane_alloc()
65 	if (!plane)  in intel_plane_alloc()
70 		kfree(plane);  in intel_plane_alloc()
74 	intel_plane_state_reset(plane_state, plane);  in intel_plane_alloc()
76 	plane->base.state = &plane_state->uapi;  in intel_plane_alloc()
78 	return plane;  in intel_plane_alloc()
81 void intel_plane_free(struct intel_plane *plane)  in intel_plane_free()  argument
83 	intel_plane_destroy_state(&plane->base, plane->base.state);  in intel_plane_free()
84 	kfree(plane);  in intel_plane_free()
88  * intel_plane_duplicate_state - duplicate plane state
89  * @plane: drm plane
91  * Allocates and returns a copy of the plane state (both common and
92  * Intel-specific) for the specified plane.
94  * Returns: The newly allocated plane state, or NULL on failure.
97 intel_plane_duplicate_state(struct drm_plane *plane)  in intel_plane_duplicate_state()  argument
101 	intel_state = to_intel_plane_state(plane->state);  in intel_plane_duplicate_state()
107 	__drm_atomic_helper_plane_duplicate_state(plane, &intel_state->uapi);  in intel_plane_duplicate_state()
121  * intel_plane_destroy_state - destroy plane state
122  * @plane: drm plane
125  * Destroys the plane state (both common and Intel-specific) for the
126  * specified plane.
129 intel_plane_destroy_state(struct drm_plane *plane,  in intel_plane_destroy_state()  argument
134 	drm_WARN_ON(plane->dev, plane_state->ggtt_vma);  in intel_plane_destroy_state()
135 	drm_WARN_ON(plane->dev, plane_state->dpt_vma);  in intel_plane_destroy_state()
166 	 * Note we don't check for plane visibility here as  in intel_plane_pixel_rate()
197 	    struct intel_plane *plane)  in use_min_ddb()  argument
199 	struct drm_i915_private *i915 = to_i915(plane->base.dev);  in use_min_ddb()
203 	       plane->async_flip;  in use_min_ddb()
211 	struct intel_plane *plane = to_intel_plane(plane_state->uapi.plane);  in intel_plane_relative_data_rate()  local
215 	if (plane->id == PLANE_CURSOR)  in intel_plane_relative_data_rate()
222 	 * We calculate extra ddb based on ratio plane rate/total data rate  in intel_plane_relative_data_rate()
223 	 * in case, in some cases we should not allocate extra ddb for the plane,  in intel_plane_relative_data_rate()
226 	if (use_min_ddb(crtc_state, plane))  in intel_plane_relative_data_rate()
231 	 * the 90/270 degree plane rotation cases (to match the  in intel_plane_relative_data_rate()
237 	/* UV plane does 1/2 pixel sub-sampling */  in intel_plane_relative_data_rate()
247 			       struct intel_plane *plane,  in intel_plane_calc_min_cdclk()  argument
250 	struct drm_i915_private *dev_priv = to_i915(plane->base.dev);  in intel_plane_calc_min_cdclk()
252 		intel_atomic_get_new_plane_state(state, plane);  in intel_plane_calc_min_cdclk()
258 	if (!plane_state->uapi.visible || !plane->min_cdclk)  in intel_plane_calc_min_cdclk()
264 	new_crtc_state->min_cdclk[plane->id] =  in intel_plane_calc_min_cdclk()
265 		plane->min_cdclk(new_crtc_state, plane_state);  in intel_plane_calc_min_cdclk()
269 	 * the min cdclk for the plane doesn't increase.  in intel_plane_calc_min_cdclk()
271 	 * Ie. we only ever increase the cdclk due to plane  in intel_plane_calc_min_cdclk()
275 	if (new_crtc_state->min_cdclk[plane->id] <=  in intel_plane_calc_min_cdclk()
276 	    old_crtc_state->min_cdclk[plane->id])  in intel_plane_calc_min_cdclk()
287 	 * Ie. we only ever increase the cdclk due to plane  in intel_plane_calc_min_cdclk()
291 	if (new_crtc_state->min_cdclk[plane->id] <=  in intel_plane_calc_min_cdclk()
296 		    "[PLANE:%d:%s] min cdclk (%d kHz) > [CRTC:%d:%s] min cdclk (%d kHz)\n",  in intel_plane_calc_min_cdclk()
297 		    plane->base.base.id, plane->base.name,  in intel_plane_calc_min_cdclk()
298 		    new_crtc_state->min_cdclk[plane->id],  in intel_plane_calc_min_cdclk()
324 	 * the plane is logically enabled on the uapi level.  in intel_plane_copy_uapi_to_hw_state()
359 	struct intel_plane *plane = to_intel_plane(plane_state->uapi.plane);  in intel_plane_set_invisible()  local
361 	crtc_state->active_planes &= ~BIT(plane->id);  in intel_plane_set_invisible()
362 	crtc_state->scaled_planes &= ~BIT(plane->id);  in intel_plane_set_invisible()
363 	crtc_state->nv12_planes &= ~BIT(plane->id);  in intel_plane_set_invisible()
364 	crtc_state->c8_planes &= ~BIT(plane->id);  in intel_plane_set_invisible()
365 	crtc_state->data_rate[plane->id] = 0;  in intel_plane_set_invisible()
366 	crtc_state->data_rate_y[plane->id] = 0;  in intel_plane_set_invisible()
367 	crtc_state->rel_data_rate[plane->id] = 0;  in intel_plane_set_invisible()
368 	crtc_state->rel_data_rate_y[plane->id] = 0;  in intel_plane_set_invisible()
369 	crtc_state->min_cdclk[plane->id] = 0;  in intel_plane_set_invisible()
406 static bool intel_plane_do_async_flip(struct intel_plane *plane,  in intel_plane_do_async_flip()  argument
410 	struct drm_i915_private *i915 = to_i915(plane->base.dev);  in intel_plane_do_async_flip()
412 	if (!plane->async_flip)  in intel_plane_do_async_flip()
434 	struct intel_plane *plane = to_intel_plane(new_plane_state->uapi.plane);  in intel_plane_atomic_calc_changes()  local
442 	if (DISPLAY_VER(dev_priv) >= 9 && plane->id != PLANE_CURSOR) {  in intel_plane_atomic_calc_changes()
461 	 * per-plane wm computation to the .check_plane() hook, and  in intel_plane_atomic_calc_changes()
476 		       "[CRTC:%d:%s] with [PLANE:%d:%s] visible %i -> %i, off %i, on %i, ms %i\n",  in intel_plane_atomic_calc_changes()
478 		       plane->base.base.id, plane->base.name,  in intel_plane_atomic_calc_changes()
486 		/* must disable cxsr around plane enable/disable */  in intel_plane_atomic_calc_changes()
487 		if (plane->id != PLANE_CURSOR)  in intel_plane_atomic_calc_changes()
493 		/* must disable cxsr around plane enable/disable */  in intel_plane_atomic_calc_changes()
494 		if (plane->id != PLANE_CURSOR)  in intel_plane_atomic_calc_changes()
505 		new_crtc_state->fb_bits |= plane->frontbuffer_bit;  in intel_plane_atomic_calc_changes()
511 	 *  plane will be internally buffered and delayed while Big FIFO  in intel_plane_atomic_calc_changes()
538 	 * plane, not only sprite plane.  in intel_plane_atomic_calc_changes()
540 	if (plane->id != PLANE_CURSOR &&  in intel_plane_atomic_calc_changes()
547 	if (intel_plane_do_async_flip(plane, old_crtc_state, new_crtc_state))  in intel_plane_atomic_calc_changes()
558 	struct intel_plane *plane = to_intel_plane(new_plane_state->uapi.plane);  in intel_plane_atomic_check_with_state()  local
563 	new_crtc_state->enabled_planes &= ~BIT(plane->id);  in intel_plane_atomic_check_with_state()
568 	ret = plane->check_plane(new_crtc_state, new_plane_state);  in intel_plane_atomic_check_with_state()
573 		new_crtc_state->enabled_planes |= BIT(plane->id);  in intel_plane_atomic_check_with_state()
577 		new_crtc_state->active_planes |= BIT(plane->id);  in intel_plane_atomic_check_with_state()
581 		new_crtc_state->scaled_planes |= BIT(plane->id);  in intel_plane_atomic_check_with_state()
585 		new_crtc_state->nv12_planes |= BIT(plane->id);  in intel_plane_atomic_check_with_state()
589 		new_crtc_state->c8_planes |= BIT(plane->id);  in intel_plane_atomic_check_with_state()
592 		new_crtc_state->update_planes |= BIT(plane->id);  in intel_plane_atomic_check_with_state()
596 		new_crtc_state->data_rate_y[plane->id] =  in intel_plane_atomic_check_with_state()
598 		new_crtc_state->data_rate[plane->id] =  in intel_plane_atomic_check_with_state()
601 		new_crtc_state->rel_data_rate_y[plane->id] =  in intel_plane_atomic_check_with_state()
604 		new_crtc_state->rel_data_rate[plane->id] =  in intel_plane_atomic_check_with_state()
608 		new_crtc_state->data_rate[plane->id] =  in intel_plane_atomic_check_with_state()
611 		new_crtc_state->rel_data_rate[plane->id] =  in intel_plane_atomic_check_with_state()
624 	struct intel_plane *plane;  in intel_crtc_get_plane()  local
626 	for_each_intel_plane_on_crtc(&i915->drm, crtc, plane) {  in intel_crtc_get_plane()
627 		if (plane->id == plane_id)  in intel_crtc_get_plane()
628 			return plane;  in intel_crtc_get_plane()
635 			     struct intel_plane *plane)  in intel_plane_atomic_check()  argument
639 		intel_atomic_get_new_plane_state(state, plane);  in intel_plane_atomic_check()
641 		intel_atomic_get_old_plane_state(state, plane);  in intel_plane_atomic_check()
643 	struct intel_crtc *crtc = intel_crtc_for_pipe(i915, plane->pipe);  in intel_plane_atomic_check()
653 			intel_crtc_get_plane(master_crtc, plane->id);  in intel_plane_atomic_check()
685 	struct intel_plane *plane;  in skl_next_plane_to_commit()  local
691 	for_each_new_intel_plane_in_state(state, plane, plane_state, i) {  in skl_next_plane_to_commit()
692 		enum plane_id plane_id = plane->id;  in skl_next_plane_to_commit()
694 		if (crtc->pipe != plane->pipe ||  in skl_next_plane_to_commit()
708 		return plane;  in skl_next_plane_to_commit()
717 void intel_plane_update_noarm(struct intel_plane *plane,  in intel_plane_update_noarm()  argument
723 	trace_intel_plane_update_noarm(&plane->base, crtc);  in intel_plane_update_noarm()
725 	if (plane->update_noarm)  in intel_plane_update_noarm()
726 		plane->update_noarm(plane, crtc_state, plane_state);  in intel_plane_update_noarm()
729 void intel_plane_update_arm(struct intel_plane *plane,  in intel_plane_update_arm()  argument
735 	trace_intel_plane_update_arm(&plane->base, crtc);  in intel_plane_update_arm()
737 	if (crtc_state->do_async_flip && plane->async_flip)  in intel_plane_update_arm()
738 		plane->async_flip(plane, crtc_state, plane_state, true);  in intel_plane_update_arm()
740 		plane->update_arm(plane, crtc_state, plane_state);  in intel_plane_update_arm()
743 void intel_plane_disable_arm(struct intel_plane *plane,  in intel_plane_disable_arm()  argument
748 	trace_intel_plane_disable_arm(&plane->base, crtc);  in intel_plane_disable_arm()
749 	plane->disable_arm(plane, crtc_state);  in intel_plane_disable_arm()
759 	struct intel_plane *plane;  in intel_crtc_planes_update_noarm()  local
769 	for_each_new_intel_plane_in_state(state, plane, new_plane_state, i) {  in intel_crtc_planes_update_noarm()
770 		if (crtc->pipe != plane->pipe ||  in intel_crtc_planes_update_noarm()
771 		    !(update_mask & BIT(plane->id)))  in intel_crtc_planes_update_noarm()
777 			intel_plane_update_noarm(plane, new_crtc_state, new_plane_state);  in intel_crtc_planes_update_noarm()
791 	struct intel_plane *plane;  in skl_crtc_planes_update_arm()  local
798 	while ((plane = skl_next_plane_to_commit(state, crtc, ddb, ddb_y, &update_mask))) {  in skl_crtc_planes_update_arm()
800 			intel_atomic_get_new_plane_state(state, plane);  in skl_crtc_planes_update_arm()
808 			intel_plane_update_arm(plane, new_crtc_state, new_plane_state);  in skl_crtc_planes_update_arm()
810 			intel_plane_disable_arm(plane, new_crtc_state);  in skl_crtc_planes_update_arm()
821 	struct intel_plane *plane;  in i9xx_crtc_planes_update_arm()  local
824 	for_each_new_intel_plane_in_state(state, plane, new_plane_state, i) {  in i9xx_crtc_planes_update_arm()
825 		if (crtc->pipe != plane->pipe ||  in i9xx_crtc_planes_update_arm()
826 		    !(update_mask & BIT(plane->id)))  in i9xx_crtc_planes_update_arm()
834 			intel_plane_update_arm(plane, new_crtc_state, new_plane_state);  in i9xx_crtc_planes_update_arm()
836 			intel_plane_disable_arm(plane, new_crtc_state);  in i9xx_crtc_planes_update_arm()
856 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);  in intel_atomic_plane_check_clipping()
875 		drm_dbg_kms(&i915->drm, "Invalid scaling of plane\n");  in intel_atomic_plane_check_clipping()
891 		drm_dbg_kms(&i915->drm, "Plane must cover entire CRTC\n");  in intel_atomic_plane_check_clipping()
897 	/* final plane coordinates will be relative to the plane's pipe */  in intel_atomic_plane_check_clipping()
962  * intel_prepare_plane_fb - Prepare fb for usage on plane
963  * @_plane: drm plane to prepare for
964  * @_new_plane_state: the plane state being prepared
966  * Prepares a framebuffer for usage on a display plane.  Generally this
978 	struct intel_plane *plane = to_intel_plane(_plane);  in intel_prepare_plane_fb()  local
983 	struct drm_i915_private *dev_priv = to_i915(plane->base.dev);  in intel_prepare_plane_fb()
985 		intel_atomic_get_old_plane_state(state, plane);  in intel_prepare_plane_fb()
1083  * intel_cleanup_plane_fb - Cleans up an fb after plane use
1084  * @plane: drm plane to clean up for
1087  * Cleans up a framebuffer that has just been removed from a plane.
1090 intel_cleanup_plane_fb(struct drm_plane *plane,  in intel_cleanup_plane_fb()  argument
1097 	struct drm_i915_private *dev_priv = to_i915(plane->dev);  in intel_cleanup_plane_fb()
1117 void intel_plane_helper_add(struct intel_plane *plane)  in intel_plane_helper_add()  argument
1119 	drm_plane_helper_add(&plane->base, &intel_plane_helper_funcs);  in intel_plane_helper_add()