1 // SPDX-License-Identifier: GPL-2.0+
3 #include <linux/crc32.h>
5 #include <drm/drm_atomic.h>
6 #include <drm/drm_atomic_helper.h>
7 #include <drm/drm_gem_framebuffer_helper.h>
8 #include <drm/drm_vblank.h>
13 * compute_crc - Compute CRC value on output frame
15 * @vaddr_out: address to final framebuffer
16 * @composer: framebuffer's metadata
18 * returns CRC value computed using crc32 on the visible portion of
19 * the final framebuffer at vaddr_out
21 static uint32_t compute_crc(void *vaddr_out, struct vkms_composer *composer)
24 int x_src = composer->src.x1 >> 16;
25 int y_src = composer->src.y1 >> 16;
26 int h_src = drm_rect_height(&composer->src) >> 16;
27 int w_src = drm_rect_width(&composer->src) >> 16;
30 for (i = y_src; i < y_src + h_src; ++i) {
31 for (j = x_src; j < x_src + w_src; ++j) {
32 src_offset = composer->offset
33 + (i * composer->pitch)
34 + (j * composer->cpp);
35 crc = crc32_le(crc, vaddr_out + src_offset,
43 static u8 blend_channel(u8 src, u8 dst, u8 alpha)
48 pre_blend = (src * 255 + dst * (255 - alpha));
50 /* Faster div by 255 */
51 new_color = ((pre_blend + ((pre_blend + 257) >> 8)) >> 8);
56 static void alpha_blending(const u8 *argb_src, u8 *argb_dst)
61 argb_dst[0] = blend_channel(argb_src[0], argb_dst[0], alpha);
62 argb_dst[1] = blend_channel(argb_src[1], argb_dst[1], alpha);
63 argb_dst[2] = blend_channel(argb_src[2], argb_dst[2], alpha);
69 * blend - blend value at vaddr_src with value at vaddr_dst
70 * @vaddr_dst: destination address
71 * @vaddr_src: source address
72 * @dst_composer: destination framebuffer's metadata
73 * @src_composer: source framebuffer's metadata
75 * Blend the vaddr_src value with the vaddr_dst value using the pre-multiplied
76 * alpha blending equation, since DRM currently assumes that the pixel color
77 * values have already been pre-multiplied with the alpha channel values. See
78 * more drm_plane_create_blend_mode_property(). This function uses buffer's
79 * metadata to locate the new composite values at vaddr_dst.
81 static void blend(void *vaddr_dst, void *vaddr_src,
82 struct vkms_composer *dst_composer,
83 struct vkms_composer *src_composer)
85 int i, j, j_dst, i_dst;
86 int offset_src, offset_dst;
87 u8 *pixel_dst, *pixel_src;
89 int x_src = src_composer->src.x1 >> 16;
90 int y_src = src_composer->src.y1 >> 16;
92 int x_dst = src_composer->dst.x1;
93 int y_dst = src_composer->dst.y1;
94 int h_dst = drm_rect_height(&src_composer->dst);
95 int w_dst = drm_rect_width(&src_composer->dst);
97 int y_limit = y_src + h_dst;
98 int x_limit = x_src + w_dst;
100 for (i = y_src, i_dst = y_dst; i < y_limit; ++i) {
101 for (j = x_src, j_dst = x_dst; j < x_limit; ++j) {
102 offset_dst = dst_composer->offset
103 + (i_dst * dst_composer->pitch)
104 + (j_dst++ * dst_composer->cpp);
105 offset_src = src_composer->offset
106 + (i * src_composer->pitch)
107 + (j * src_composer->cpp);
109 pixel_src = (u8 *)(vaddr_src + offset_src);
110 pixel_dst = (u8 *)(vaddr_dst + offset_dst);
111 alpha_blending(pixel_src, pixel_dst);
117 static void compose_cursor(struct vkms_composer *cursor_composer,
118 struct vkms_composer *primary_composer,
121 struct drm_gem_object *cursor_obj;
122 struct vkms_gem_object *cursor_vkms_obj;
124 cursor_obj = drm_gem_fb_get_obj(&cursor_composer->fb, 0);
125 cursor_vkms_obj = drm_gem_to_vkms_gem(cursor_obj);
127 if (WARN_ON(!cursor_vkms_obj->vaddr))
130 blend(vaddr_out, cursor_vkms_obj->vaddr,
131 primary_composer, cursor_composer);
134 static uint32_t _vkms_get_crc(struct vkms_composer *primary_composer,
135 struct vkms_composer *cursor_composer)
137 struct drm_framebuffer *fb = &primary_composer->fb;
138 struct drm_gem_object *gem_obj = drm_gem_fb_get_obj(fb, 0);
139 struct vkms_gem_object *vkms_obj = drm_gem_to_vkms_gem(gem_obj);
140 void *vaddr_out = kzalloc(vkms_obj->gem.size, GFP_KERNEL);
144 DRM_ERROR("Failed to allocate memory for output frame.");
148 if (WARN_ON(!vkms_obj->vaddr)) {
153 memcpy(vaddr_out, vkms_obj->vaddr, vkms_obj->gem.size);
156 compose_cursor(cursor_composer, primary_composer, vaddr_out);
158 crc = compute_crc(vaddr_out, primary_composer);
166 * vkms_composer_worker - ordered work_struct to compute CRC
170 * Work handler for composing and computing CRCs. work_struct scheduled in
171 * an ordered workqueue that's periodically scheduled to run by
172 * _vblank_handle() and flushed at vkms_atomic_crtc_destroy_state().
174 void vkms_composer_worker(struct work_struct *work)
176 struct vkms_crtc_state *crtc_state = container_of(work,
177 struct vkms_crtc_state,
179 struct drm_crtc *crtc = crtc_state->base.crtc;
180 struct vkms_output *out = drm_crtc_to_vkms_output(crtc);
181 struct vkms_composer *primary_composer = NULL;
182 struct vkms_composer *cursor_composer = NULL;
184 u64 frame_start, frame_end;
187 spin_lock_irq(&out->composer_lock);
188 frame_start = crtc_state->frame_start;
189 frame_end = crtc_state->frame_end;
190 crc_pending = crtc_state->crc_pending;
191 crtc_state->frame_start = 0;
192 crtc_state->frame_end = 0;
193 crtc_state->crc_pending = false;
194 spin_unlock_irq(&out->composer_lock);
197 * We raced with the vblank hrtimer and previous work already computed
198 * the crc, nothing to do.
203 if (crtc_state->num_active_planes >= 1)
204 primary_composer = crtc_state->active_planes[0]->composer;
206 if (crtc_state->num_active_planes == 2)
207 cursor_composer = crtc_state->active_planes[1]->composer;
209 if (primary_composer)
210 crc32 = _vkms_get_crc(primary_composer, cursor_composer);
213 * The worker can fall behind the vblank hrtimer, make sure we catch up.
215 while (frame_start <= frame_end)
216 drm_crtc_add_crc_entry(crtc, true, frame_start++, &crc32);
219 static const char * const pipe_crc_sources[] = {"auto"};
221 const char *const *vkms_get_crc_sources(struct drm_crtc *crtc,
224 *count = ARRAY_SIZE(pipe_crc_sources);
225 return pipe_crc_sources;
228 static int vkms_crc_parse_source(const char *src_name, bool *enabled)
234 } else if (strcmp(src_name, "auto") == 0) {
244 int vkms_verify_crc_source(struct drm_crtc *crtc, const char *src_name,
249 if (vkms_crc_parse_source(src_name, &enabled) < 0) {
250 DRM_DEBUG_DRIVER("unknown source %s\n", src_name);
259 static void vkms_set_composer(struct vkms_output *out, bool enabled)
264 drm_crtc_vblank_get(&out->crtc);
266 spin_lock_irq(&out->lock);
267 old_enabled = out->composer_enabled;
268 out->composer_enabled = enabled;
269 spin_unlock_irq(&out->lock);
272 drm_crtc_vblank_put(&out->crtc);
275 int vkms_set_crc_source(struct drm_crtc *crtc, const char *src_name)
277 struct vkms_output *out = drm_crtc_to_vkms_output(crtc);
278 bool enabled = false;
281 ret = vkms_crc_parse_source(src_name, &enabled);
283 vkms_set_composer(out, enabled);