1 // SPDX-License-Identifier: GPL-2.0
3 * Test case for drm_damage_helper functions
6 #define pr_fmt(fmt) "drm_damage_helper: " fmt
8 #include <drm/drm_damage_helper.h>
9 #include <drm/drm_plane.h>
10 #include <drm/drm_drv.h>
12 #include "test-drm_modeset_common.h"
14 struct drm_driver mock_driver;
15 static struct drm_device mock_device;
16 static struct drm_object_properties mock_obj_props;
17 static struct drm_plane mock_plane;
18 static struct drm_property mock_prop;
20 static void mock_setup(struct drm_plane_state *state)
22 static bool setup_done = false;
24 state->plane = &mock_plane;
29 /* just enough so that drm_plane_enable_fb_damage_clips() works */
30 mock_device.driver = &mock_driver;
31 mock_device.mode_config.prop_fb_damage_clips = &mock_prop;
32 mock_plane.dev = &mock_device;
33 mock_obj_props.count = 0;
34 mock_plane.base.properties = &mock_obj_props;
35 mock_prop.base.id = 1; /* 0 is an invalid id */
36 mock_prop.dev = &mock_device;
38 drm_plane_enable_fb_damage_clips(&mock_plane);
41 static void set_plane_src(struct drm_plane_state *state, int x1, int y1, int x2,
50 static void set_damage_clip(struct drm_mode_rect *r, int x1, int y1, int x2,
59 static void set_damage_blob(struct drm_property_blob *damage_blob,
60 struct drm_mode_rect *r, uint32_t size)
62 damage_blob->length = size;
63 damage_blob->data = r;
66 static void set_plane_damage(struct drm_plane_state *state,
67 struct drm_property_blob *damage_blob)
69 state->fb_damage_clips = damage_blob;
72 static bool check_damage_clip(struct drm_plane_state *state, struct drm_rect *r,
73 int x1, int y1, int x2, int y2)
76 * Round down x1/y1 and round up x2/y2. This is because damage is not in
77 * 16.16 fixed point so to catch all pixels.
79 int src_x1 = state->src.x1 >> 16;
80 int src_y1 = state->src.y1 >> 16;
81 int src_x2 = (state->src.x2 >> 16) + !!(state->src.x2 & 0xFFFF);
82 int src_y2 = (state->src.y2 >> 16) + !!(state->src.y2 & 0xFFFF);
84 if (x1 >= x2 || y1 >= y2) {
85 pr_err("Cannot have damage clip with no dimension.\n");
89 if (x1 < src_x1 || y1 < src_y1 || x2 > src_x2 || y2 > src_y2) {
90 pr_err("Damage cannot be outside rounded plane src.\n");
94 if (r->x1 != x1 || r->y1 != y1 || r->x2 != x2 || r->y2 != y2) {
95 pr_err("Damage = %d %d %d %d\n", r->x1, r->y1, r->x2, r->y2);
102 const struct drm_framebuffer fb = {
107 /* common mocked structs many tests need */
108 #define MOCK_VARIABLES() \
109 struct drm_plane_state old_state; \
110 struct drm_plane_state state = { \
111 .crtc = ZERO_SIZE_PTR, \
112 .fb = (struct drm_framebuffer *) &fb, \
115 mock_setup(&old_state); \
118 int igt_damage_iter_no_damage(void *ignored)
120 struct drm_atomic_helper_damage_iter iter;
121 struct drm_rect clip;
122 uint32_t num_hits = 0;
126 /* Plane src same as fb size. */
127 set_plane_src(&old_state, 0, 0, fb.width << 16, fb.height << 16);
128 set_plane_src(&state, 0, 0, fb.width << 16, fb.height << 16);
129 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
130 drm_atomic_for_each_plane_damage(&iter, &clip)
133 FAIL(num_hits != 1, "Should return plane src as damage.");
134 FAIL_ON(!check_damage_clip(&state, &clip, 0, 0, 2048, 2048));
139 int igt_damage_iter_no_damage_fractional_src(void *ignored)
141 struct drm_atomic_helper_damage_iter iter;
142 struct drm_rect clip;
143 uint32_t num_hits = 0;
147 /* Plane src has fractional part. */
148 set_plane_src(&old_state, 0x3fffe, 0x3fffe,
149 0x3fffe + (1024 << 16), 0x3fffe + (768 << 16));
150 set_plane_src(&state, 0x3fffe, 0x3fffe,
151 0x3fffe + (1024 << 16), 0x3fffe + (768 << 16));
152 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
153 drm_atomic_for_each_plane_damage(&iter, &clip)
156 FAIL(num_hits != 1, "Should return rounded off plane src as damage.");
157 FAIL_ON(!check_damage_clip(&state, &clip, 3, 3, 1028, 772));
162 int igt_damage_iter_no_damage_src_moved(void *ignored)
164 struct drm_atomic_helper_damage_iter iter;
165 struct drm_rect clip;
166 uint32_t num_hits = 0;
170 /* Plane src moved since old plane state. */
171 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
172 set_plane_src(&state, 10 << 16, 10 << 16,
173 (10 + 1024) << 16, (10 + 768) << 16);
174 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
175 drm_atomic_for_each_plane_damage(&iter, &clip)
178 FAIL(num_hits != 1, "Should return plane src as damage.");
179 FAIL_ON(!check_damage_clip(&state, &clip, 10, 10, 1034, 778));
184 int igt_damage_iter_no_damage_fractional_src_moved(void *ignored)
186 struct drm_atomic_helper_damage_iter iter;
187 struct drm_rect clip;
188 uint32_t num_hits = 0;
192 /* Plane src has fractional part and it moved since old plane state. */
193 set_plane_src(&old_state, 0x3fffe, 0x3fffe,
194 0x3fffe + (1024 << 16), 0x3fffe + (768 << 16));
195 set_plane_src(&state, 0x40002, 0x40002,
196 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
197 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
198 drm_atomic_for_each_plane_damage(&iter, &clip)
201 FAIL(num_hits != 1, "Should return plane src as damage.");
202 FAIL_ON(!check_damage_clip(&state, &clip, 4, 4, 1029, 773));
207 int igt_damage_iter_no_damage_not_visible(void *ignored)
209 struct drm_atomic_helper_damage_iter iter;
210 struct drm_rect clip;
211 uint32_t num_hits = 0;
215 state.visible = false;
217 mock_setup(&old_state);
219 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
220 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
221 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
222 drm_atomic_for_each_plane_damage(&iter, &clip)
225 FAIL(num_hits != 0, "Should have no damage.");
230 int igt_damage_iter_no_damage_no_crtc(void *ignored)
232 struct drm_atomic_helper_damage_iter iter;
233 struct drm_rect clip;
234 uint32_t num_hits = 0;
240 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
241 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
242 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
243 drm_atomic_for_each_plane_damage(&iter, &clip)
246 FAIL(num_hits != 0, "Should have no damage.");
251 int igt_damage_iter_no_damage_no_fb(void *ignored)
253 struct drm_atomic_helper_damage_iter iter;
254 struct drm_plane_state old_state;
255 struct drm_rect clip;
256 uint32_t num_hits = 0;
258 struct drm_plane_state state = {
259 .crtc = ZERO_SIZE_PTR,
263 mock_setup(&old_state);
265 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
266 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
267 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
268 drm_atomic_for_each_plane_damage(&iter, &clip)
271 FAIL(num_hits != 0, "Should have no damage.");
276 int igt_damage_iter_simple_damage(void *ignored)
278 struct drm_atomic_helper_damage_iter iter;
279 struct drm_property_blob damage_blob;
280 struct drm_mode_rect damage;
281 struct drm_rect clip;
282 uint32_t num_hits = 0;
286 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
287 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
288 /* Damage set to plane src */
289 set_damage_clip(&damage, 0, 0, 1024, 768);
290 set_damage_blob(&damage_blob, &damage, sizeof(damage));
291 set_plane_damage(&state, &damage_blob);
292 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
293 drm_atomic_for_each_plane_damage(&iter, &clip)
296 FAIL(num_hits != 1, "Should return damage when set.");
297 FAIL_ON(!check_damage_clip(&state, &clip, 0, 0, 1024, 768));
302 int igt_damage_iter_single_damage(void *ignored)
304 struct drm_atomic_helper_damage_iter iter;
305 struct drm_property_blob damage_blob;
306 struct drm_mode_rect damage;
307 struct drm_rect clip;
308 uint32_t num_hits = 0;
312 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
313 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
314 set_damage_clip(&damage, 256, 192, 768, 576);
315 set_damage_blob(&damage_blob, &damage, sizeof(damage));
316 set_plane_damage(&state, &damage_blob);
317 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
318 drm_atomic_for_each_plane_damage(&iter, &clip)
321 FAIL(num_hits != 1, "Should return damage when set.");
322 FAIL_ON(!check_damage_clip(&state, &clip, 256, 192, 768, 576));
327 int igt_damage_iter_single_damage_intersect_src(void *ignored)
329 struct drm_atomic_helper_damage_iter iter;
330 struct drm_property_blob damage_blob;
331 struct drm_mode_rect damage;
332 struct drm_rect clip;
333 uint32_t num_hits = 0;
337 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
338 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
339 /* Damage intersect with plane src. */
340 set_damage_clip(&damage, 256, 192, 1360, 768);
341 set_damage_blob(&damage_blob, &damage, sizeof(damage));
342 set_plane_damage(&state, &damage_blob);
343 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
344 drm_atomic_for_each_plane_damage(&iter, &clip)
347 FAIL(num_hits != 1, "Should return damage clipped to src.");
348 FAIL_ON(!check_damage_clip(&state, &clip, 256, 192, 1024, 768));
353 int igt_damage_iter_single_damage_outside_src(void *ignored)
355 struct drm_atomic_helper_damage_iter iter;
356 struct drm_property_blob damage_blob;
357 struct drm_mode_rect damage;
358 struct drm_rect clip;
359 uint32_t num_hits = 0;
363 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
364 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
365 /* Damage clip outside plane src */
366 set_damage_clip(&damage, 1360, 1360, 1380, 1380);
367 set_damage_blob(&damage_blob, &damage, sizeof(damage));
368 set_plane_damage(&state, &damage_blob);
369 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
370 drm_atomic_for_each_plane_damage(&iter, &clip)
373 FAIL(num_hits != 0, "Should have no damage.");
378 int igt_damage_iter_single_damage_fractional_src(void *ignored)
380 struct drm_atomic_helper_damage_iter iter;
381 struct drm_property_blob damage_blob;
382 struct drm_mode_rect damage;
383 struct drm_rect clip;
384 uint32_t num_hits = 0;
388 /* Plane src has fractional part. */
389 set_plane_src(&old_state, 0x40002, 0x40002,
390 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
391 set_plane_src(&state, 0x40002, 0x40002,
392 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
393 set_damage_clip(&damage, 10, 10, 256, 330);
394 set_damage_blob(&damage_blob, &damage, sizeof(damage));
395 set_plane_damage(&state, &damage_blob);
396 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
397 drm_atomic_for_each_plane_damage(&iter, &clip)
400 FAIL(num_hits != 1, "Should return damage when set.");
401 FAIL_ON(!check_damage_clip(&state, &clip, 10, 10, 256, 330));
406 int igt_damage_iter_single_damage_intersect_fractional_src(void *ignored)
408 struct drm_atomic_helper_damage_iter iter;
409 struct drm_property_blob damage_blob;
410 struct drm_mode_rect damage;
411 struct drm_rect clip;
412 uint32_t num_hits = 0;
416 /* Plane src has fractional part. */
417 set_plane_src(&old_state, 0x40002, 0x40002,
418 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
419 set_plane_src(&state, 0x40002, 0x40002,
420 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
421 /* Damage intersect with plane src. */
422 set_damage_clip(&damage, 10, 1, 1360, 330);
423 set_damage_blob(&damage_blob, &damage, sizeof(damage));
424 set_plane_damage(&state, &damage_blob);
425 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
426 drm_atomic_for_each_plane_damage(&iter, &clip)
429 FAIL(num_hits != 1, "Should return damage clipped to rounded off src.");
430 FAIL_ON(!check_damage_clip(&state, &clip, 10, 4, 1029, 330));
435 int igt_damage_iter_single_damage_outside_fractional_src(void *ignored)
437 struct drm_atomic_helper_damage_iter iter;
438 struct drm_property_blob damage_blob;
439 struct drm_mode_rect damage;
440 struct drm_rect clip;
441 uint32_t num_hits = 0;
445 /* Plane src has fractional part. */
446 set_plane_src(&old_state, 0x40002, 0x40002,
447 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
448 set_plane_src(&state, 0x40002, 0x40002,
449 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
450 /* Damage clip outside plane src */
451 set_damage_clip(&damage, 1360, 1360, 1380, 1380);
452 set_damage_blob(&damage_blob, &damage, sizeof(damage));
453 set_plane_damage(&state, &damage_blob);
454 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
455 drm_atomic_for_each_plane_damage(&iter, &clip)
458 FAIL(num_hits != 0, "Should have no damage.");
463 int igt_damage_iter_single_damage_src_moved(void *ignored)
465 struct drm_atomic_helper_damage_iter iter;
466 struct drm_property_blob damage_blob;
467 struct drm_mode_rect damage;
468 struct drm_rect clip;
469 uint32_t num_hits = 0;
473 /* Plane src moved since old plane state. */
474 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
475 set_plane_src(&state, 10 << 16, 10 << 16,
476 (10 + 1024) << 16, (10 + 768) << 16);
477 set_damage_clip(&damage, 20, 30, 256, 256);
478 set_damage_blob(&damage_blob, &damage, sizeof(damage));
479 set_plane_damage(&state, &damage_blob);
480 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
481 drm_atomic_for_each_plane_damage(&iter, &clip)
484 FAIL(num_hits != 1, "Should return plane src as damage.");
485 FAIL_ON(!check_damage_clip(&state, &clip, 10, 10, 1034, 778));
490 int igt_damage_iter_single_damage_fractional_src_moved(void *ignored)
492 struct drm_atomic_helper_damage_iter iter;
493 struct drm_property_blob damage_blob;
494 struct drm_mode_rect damage;
495 struct drm_rect clip;
496 uint32_t num_hits = 0;
500 /* Plane src with fractional part moved since old plane state. */
501 set_plane_src(&old_state, 0x3fffe, 0x3fffe,
502 0x3fffe + (1024 << 16), 0x3fffe + (768 << 16));
503 set_plane_src(&state, 0x40002, 0x40002,
504 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
505 /* Damage intersect with plane src. */
506 set_damage_clip(&damage, 20, 30, 1360, 256);
507 set_damage_blob(&damage_blob, &damage, sizeof(damage));
508 set_plane_damage(&state, &damage_blob);
509 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
510 drm_atomic_for_each_plane_damage(&iter, &clip)
513 FAIL(num_hits != 1, "Should return rounded off plane src as damage.");
514 FAIL_ON(!check_damage_clip(&state, &clip, 4, 4, 1029, 773));
519 int igt_damage_iter_damage(void *ignored)
521 struct drm_atomic_helper_damage_iter iter;
522 struct drm_property_blob damage_blob;
523 struct drm_mode_rect damage[2];
524 struct drm_rect clip;
525 uint32_t num_hits = 0;
529 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
530 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
531 /* 2 damage clips. */
532 set_damage_clip(&damage[0], 20, 30, 200, 180);
533 set_damage_clip(&damage[1], 240, 200, 280, 250);
534 set_damage_blob(&damage_blob, &damage[0], sizeof(damage));
535 set_plane_damage(&state, &damage_blob);
536 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
537 drm_atomic_for_each_plane_damage(&iter, &clip) {
539 FAIL_ON(!check_damage_clip(&state, &clip, 20, 30, 200, 180));
541 FAIL_ON(!check_damage_clip(&state, &clip, 240, 200, 280, 250));
545 FAIL(num_hits != 2, "Should return damage when set.");
550 int igt_damage_iter_damage_one_intersect(void *ignored)
552 struct drm_atomic_helper_damage_iter iter;
553 struct drm_property_blob damage_blob;
554 struct drm_mode_rect damage[2];
555 struct drm_rect clip;
556 uint32_t num_hits = 0;
560 set_plane_src(&old_state, 0x40002, 0x40002,
561 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
562 set_plane_src(&state, 0x40002, 0x40002,
563 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
564 /* 2 damage clips, one intersect plane src. */
565 set_damage_clip(&damage[0], 20, 30, 200, 180);
566 set_damage_clip(&damage[1], 2, 2, 1360, 1360);
567 set_damage_blob(&damage_blob, &damage[0], sizeof(damage));
568 set_plane_damage(&state, &damage_blob);
569 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
570 drm_atomic_for_each_plane_damage(&iter, &clip) {
572 FAIL_ON(!check_damage_clip(&state, &clip, 20, 30, 200, 180));
574 FAIL_ON(!check_damage_clip(&state, &clip, 4, 4, 1029, 773));
578 FAIL(num_hits != 2, "Should return damage when set.");
583 int igt_damage_iter_damage_one_outside(void *ignored)
585 struct drm_atomic_helper_damage_iter iter;
586 struct drm_property_blob damage_blob;
587 struct drm_mode_rect damage[2];
588 struct drm_rect clip;
589 uint32_t num_hits = 0;
593 set_plane_src(&old_state, 0, 0, 1024 << 16, 768 << 16);
594 set_plane_src(&state, 0, 0, 1024 << 16, 768 << 16);
595 /* 2 damage clips, one outside plane src. */
596 set_damage_clip(&damage[0], 1360, 1360, 1380, 1380);
597 set_damage_clip(&damage[1], 240, 200, 280, 250);
598 set_damage_blob(&damage_blob, &damage[0], sizeof(damage));
599 set_plane_damage(&state, &damage_blob);
600 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
601 drm_atomic_for_each_plane_damage(&iter, &clip)
604 FAIL(num_hits != 1, "Should return damage when set.");
605 FAIL_ON(!check_damage_clip(&state, &clip, 240, 200, 280, 250));
610 int igt_damage_iter_damage_src_moved(void *ignored)
612 struct drm_atomic_helper_damage_iter iter;
613 struct drm_property_blob damage_blob;
614 struct drm_mode_rect damage[2];
615 struct drm_rect clip;
616 uint32_t num_hits = 0;
620 set_plane_src(&old_state, 0x40002, 0x40002,
621 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
622 set_plane_src(&state, 0x3fffe, 0x3fffe,
623 0x3fffe + (1024 << 16), 0x3fffe + (768 << 16));
624 /* 2 damage clips, one outside plane src. */
625 set_damage_clip(&damage[0], 1360, 1360, 1380, 1380);
626 set_damage_clip(&damage[1], 240, 200, 280, 250);
627 set_damage_blob(&damage_blob, &damage[0], sizeof(damage));
628 set_plane_damage(&state, &damage_blob);
629 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
630 drm_atomic_for_each_plane_damage(&iter, &clip)
633 FAIL(num_hits != 1, "Should return round off plane src as damage.");
634 FAIL_ON(!check_damage_clip(&state, &clip, 3, 3, 1028, 772));
639 int igt_damage_iter_damage_not_visible(void *ignored)
641 struct drm_atomic_helper_damage_iter iter;
642 struct drm_property_blob damage_blob;
643 struct drm_mode_rect damage[2];
644 struct drm_rect clip;
645 uint32_t num_hits = 0;
649 state.visible = false;
651 set_plane_src(&old_state, 0x40002, 0x40002,
652 0x40002 + (1024 << 16), 0x40002 + (768 << 16));
653 set_plane_src(&state, 0x3fffe, 0x3fffe,
654 0x3fffe + (1024 << 16), 0x3fffe + (768 << 16));
655 /* 2 damage clips, one outside plane src. */
656 set_damage_clip(&damage[0], 1360, 1360, 1380, 1380);
657 set_damage_clip(&damage[1], 240, 200, 280, 250);
658 set_damage_blob(&damage_blob, &damage[0], sizeof(damage));
659 set_plane_damage(&state, &damage_blob);
660 drm_atomic_helper_damage_iter_init(&iter, &old_state, &state);
661 drm_atomic_for_each_plane_damage(&iter, &clip)
664 FAIL(num_hits != 0, "Should not return any damage.");