[PATCH i-g-t 1/2] tests/kms: Align test documentation
Karthik B S
karthik.b.s at intel.com
Fri Mar 14 08:48:04 UTC 2025
On 3/12/2025 2:56 PM, Swati Sharma wrote:
> Formatting of test documentation in few KMS tests differs from
> the established pattern.
>
> /**
> * TEST:
> * Category:
> * Description:
> * Driver requirement:
> * Mega feature:
> *
> * SUBTEST:
> * Description:
> */
>
> Also there is no need to duplicate documentation fields in subtests
> if Category/Driver requirement/Mega feature are same for subtest
> as for whole binary.
>
> Signed-off-by: Swati Sharma <swati2.sharma at intel.com>
Reviewed-by: Karthik B S <karthik.b.s at intel.com>
> ---
> tests/intel/kms_fb_coherency.c | 4 ++--
> tests/intel/kms_fbcon_fbt.c | 3 +--
> tests/intel/kms_fence_pin_leak.c | 4 ++--
> tests/intel/kms_flip_tiling.c | 4 ++--
> tests/intel/kms_mmap_write_crc.c | 4 ++--
> tests/intel/kms_pipe_stress.c | 3 ++-
> tests/intel/kms_pm_dc.c | 1 +
> tests/intel/kms_pm_lpsp.c | 2 +-
> tests/intel/kms_psr_stress_test.c | 3 +++
> tests/intel/kms_pwrite_crc.c | 4 ++--
> tests/kms_3d.c | 4 ++--
> tests/kms_atomic_transition.c | 3 +++
> tests/kms_concurrent.c | 4 ++--
> tests/kms_dp_aux_dev.c | 4 ++--
> tests/kms_flip_event_leak.c | 4 ++--
> tests/kms_multipipe_modeset.c | 4 ++--
> tests/kms_sysfs_edid_timing.c | 4 ++--
> tests/kms_tv_load_detect.c | 4 ++--
> tests/testdisplay.c | 4 ++--
> 19 files changed, 37 insertions(+), 30 deletions(-)
>
> diff --git a/tests/intel/kms_fb_coherency.c b/tests/intel/kms_fb_coherency.c
> index c5338568d..573037db1 100644
> --- a/tests/intel/kms_fb_coherency.c
> +++ b/tests/intel/kms_fb_coherency.c
> @@ -7,6 +7,8 @@
> * TEST: kms_fb_coherency
> * Category: Display
> * Description: Exercise coherency of future scanout buffer objects
> + * Mega feature: General Display Features
> + * Driver requirement: i915, xe
> */
>
> #include <errno.h>
> @@ -23,8 +25,6 @@
> * Description: Use display controller CRC hardware to validate (non)coherency
> * of memset operations on future scanout buffer objects
> * mmapped with different mmap methods and different caching modes.
> - * Mega feature: General Display Features
> - * Driver requirement: i915, xe
> */
>
> typedef struct {
> diff --git a/tests/intel/kms_fbcon_fbt.c b/tests/intel/kms_fbcon_fbt.c
> index 160f475f2..fedacec94 100644
> --- a/tests/intel/kms_fbcon_fbt.c
> +++ b/tests/intel/kms_fbcon_fbt.c
> @@ -30,6 +30,7 @@
> * Description: Test the relationship between fbcon and the frontbuffer tracking
> * infrastructure.
> * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -44,12 +45,10 @@
> * SUBTEST: fbc
> * Description: Test the relationship between fbcon and the frontbuffer tracking
> * infrastructure with fbc enabled.
> - * Mega feature: General Display Features
> *
> * SUBTEST: fbc-suspend
> * Description: Suspend test to validate the relationship between fbcon and the
> * frontbuffer tracking infrastructure with fbc enabled.
> - * Mega feature: General Display Features
> *
> * SUBTEST: psr
> * Description: Test the relationship between fbcon and the frontbuffer tracking
> diff --git a/tests/intel/kms_fence_pin_leak.c b/tests/intel/kms_fence_pin_leak.c
> index ed064aba0..4c1ac2653 100644
> --- a/tests/intel/kms_fence_pin_leak.c
> +++ b/tests/intel/kms_fence_pin_leak.c
> @@ -26,6 +26,8 @@
> * TEST: kms fence pin leak
> * Category: Display
> * Description: Exercises full ppgtt fence pin_count leak in the kernel.
> + * Driver requirement: i915
> + * Mega feature: General Display Features
> */
>
> #include <errno.h>
> @@ -40,8 +42,6 @@
> /**
> * SUBTEST:
> * Description: Along with the modeset, validate fence pin_count leakage.
> - * Driver requirement: i915
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Exercises full ppgtt fence pin_count leak in the "
> diff --git a/tests/intel/kms_flip_tiling.c b/tests/intel/kms_flip_tiling.c
> index 3880534a7..ff9ad1229 100644
> --- a/tests/intel/kms_flip_tiling.c
> +++ b/tests/intel/kms_flip_tiling.c
> @@ -28,6 +28,8 @@
> * TEST: kms flip tiling
> * Category: Display
> * Description: Test page flips and tiling scenarios
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include <errno.h>
> @@ -40,8 +42,6 @@
> /**
> * SUBTEST: flip-change-tiling
> * Description: Check pageflip between modifiers
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Test page flips and tiling scenarios");
> diff --git a/tests/intel/kms_mmap_write_crc.c b/tests/intel/kms_mmap_write_crc.c
> index 24b5c70f2..ddc5ed63e 100644
> --- a/tests/intel/kms_mmap_write_crc.c
> +++ b/tests/intel/kms_mmap_write_crc.c
> @@ -29,6 +29,8 @@
> * Category: Display
> * Description: Use the display CRC support to validate mmap write to an already
> * uncached future scanout buffer.
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include <errno.h>
> @@ -48,8 +50,6 @@
> /**
> * SUBTEST: main
> * Description: Tests that caching mode has become UC/WT and flushed using mmap write
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION(
> diff --git a/tests/intel/kms_pipe_stress.c b/tests/intel/kms_pipe_stress.c
> index 5ac3ea7d2..296c93b58 100644
> --- a/tests/intel/kms_pipe_stress.c
> +++ b/tests/intel/kms_pipe_stress.c
> @@ -21,10 +21,11 @@
> #include "xe/xe_query.h"
> /**
> * TEST: kms pipe stress
> + * Category: Display
> * Description: Stress test how gpu and cpu behaves if maximum amount of
> * planes, cpu and gpu utilization is achieved in order to reveal
> * possible bandwidth/watermark and similar problems.
> - * Category: Display
> + * Driver requirement: i915, xe
> * Mega feature: General Display Features
> *
> * SUBTEST: stress-xrgb8888-untiled
> diff --git a/tests/intel/kms_pm_dc.c b/tests/intel/kms_pm_dc.c
> index 50473321a..cdac469e4 100644
> --- a/tests/intel/kms_pm_dc.c
> +++ b/tests/intel/kms_pm_dc.c
> @@ -27,6 +27,7 @@
> * Category: Display
> * Description: Tests to validate display power DC states.
> * Driver requirement: i915, xe
> + * Mega feature: Display Power Management
> */
>
> #include <errno.h>
> diff --git a/tests/intel/kms_pm_lpsp.c b/tests/intel/kms_pm_lpsp.c
> index 7ebff1062..771dc4134 100644
> --- a/tests/intel/kms_pm_lpsp.c
> +++ b/tests/intel/kms_pm_lpsp.c
> @@ -28,6 +28,7 @@
> * TEST: kms pm lpsp
> * Category: Display
> * Description: These tests validates display Low Power Single Pipe configurations
> + * Driver requirement: i915, xe
> * Mega feature: Display Power Management
> */
>
> @@ -43,7 +44,6 @@
> /**
> * SUBTEST: kms-lpsp
> * Description: This test validates lpsp on all connected outputs on low power pipes
> - * Driver requirement: i915, xe
> *
> * SUBTEST: screens-disabled
> * Description: This test validates lpsp while all crtc are disabled
> diff --git a/tests/intel/kms_psr_stress_test.c b/tests/intel/kms_psr_stress_test.c
> index 89dd377da..cc8155a75 100644
> --- a/tests/intel/kms_psr_stress_test.c
> +++ b/tests/intel/kms_psr_stress_test.c
> @@ -2,6 +2,9 @@
> /**
> * TEST: kms psr stress test
> * Category: Display
> + * Description: This test mixes page flips and frontbuffer writes in primary and overlay
> + * planes and expects that PSR stays active after each subtest without
> + * any warnings or underruns.
> * Driver requirement: i915, xe
> * Mega feature: PSR
> */
> diff --git a/tests/intel/kms_pwrite_crc.c b/tests/intel/kms_pwrite_crc.c
> index b40a423b1..981d7b38e 100644
> --- a/tests/intel/kms_pwrite_crc.c
> +++ b/tests/intel/kms_pwrite_crc.c
> @@ -26,6 +26,8 @@
> * TEST: kms pwrite crc
> * Category: Display
> * Description: Test to validate pwrite buffer using the display CRC
> + * Driver requirement: i915
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -39,8 +41,6 @@
> * SUBTEST:
> * Description: Use the display CRC support to validate pwrite to an already
> * uncached future scanout buffer.
> - * Driver requirement: i915
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION(
> diff --git a/tests/kms_3d.c b/tests/kms_3d.c
> index bdbf389b4..31242c5f5 100644
> --- a/tests/kms_3d.c
> +++ b/tests/kms_3d.c
> @@ -26,6 +26,8 @@
> * TEST: kms 3d
> * Category: Display
> * Description: Tests 3D mode setting.
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -34,8 +36,6 @@
> /**
> * SUBTEST:
> * Description: Tests 3D mode setting.
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Tests 3D mode setting.");
> diff --git a/tests/kms_atomic_transition.c b/tests/kms_atomic_transition.c
> index 0342af206..2b64424ce 100644
> --- a/tests/kms_atomic_transition.c
> +++ b/tests/kms_atomic_transition.c
> @@ -24,6 +24,9 @@
> /**
> * TEST: kms atomic transition
> * Category: Display
> + * Description: This is a stress test, to ensure that all combinations of
> + * atomic transitions work correctly. For i915/xe this will mainly be a
> + * stress test on watermark calculations.
> * Driver requirement: i915, xe
> * Mega feature: General Display Features
> */
> diff --git a/tests/kms_concurrent.c b/tests/kms_concurrent.c
> index 86e9eae67..4f16f8b89 100644
> --- a/tests/kms_concurrent.c
> +++ b/tests/kms_concurrent.c
> @@ -27,6 +27,8 @@
> * Category: Display
> * Description: Test atomic mode setting concurrently with multiple planes and
> * screen resolution
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -36,8 +38,6 @@
> * SUBTEST: multi-plane-atomic-lowres
> * Description: Test atomic mode setting concurrently with multiple planes and
> * screen resolution.
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Test atomic mode setting concurrently with multiple planes and screen resolution");
> diff --git a/tests/kms_dp_aux_dev.c b/tests/kms_dp_aux_dev.c
> index 24cfdcb68..e74902111 100644
> --- a/tests/kms_dp_aux_dev.c
> +++ b/tests/kms_dp_aux_dev.c
> @@ -26,6 +26,8 @@
> * TEST: kms dp aux dev
> * Category: Display
> * Description: Test that /dev/drm_dp_aux reads work
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "config.h"
> @@ -41,8 +43,6 @@
> /**
> * SUBTEST:
> * Description: Test that /dev/drm_dp_aux reads work
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Test that /dev/drm_dp_aux reads work");
> diff --git a/tests/kms_flip_event_leak.c b/tests/kms_flip_event_leak.c
> index 56d5128b8..71b58b4df 100644
> --- a/tests/kms_flip_event_leak.c
> +++ b/tests/kms_flip_event_leak.c
> @@ -26,6 +26,8 @@
> * TEST: kms flip event leak
> * Category: Display
> * Description: Test to validate flip event leak
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -43,8 +45,6 @@
> * page flip event when the fd is closed before the flip has
> * completed. The test itself won't fail even if the kernel leaks
> * the event, but the resulting dmesg WARN will indicate a failure.
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> typedef struct {
> diff --git a/tests/kms_multipipe_modeset.c b/tests/kms_multipipe_modeset.c
> index 84c2c58f8..69dc62e38 100644
> --- a/tests/kms_multipipe_modeset.c
> +++ b/tests/kms_multipipe_modeset.c
> @@ -28,6 +28,8 @@
> * TEST: kms multipipe modeset
> * Category: Display
> * Description: Test simultaneous modeset on all the supported pipes
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -36,8 +38,6 @@
> * SUBTEST: basic-max-pipe-crc-check
> * Description: Verify if simultaneous modesets on all the supported pipes is
> * successful. Validate using CRC verification
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Test simultaneous modeset on all the supported pipes");
> diff --git a/tests/kms_sysfs_edid_timing.c b/tests/kms_sysfs_edid_timing.c
> index b77ebc3d6..bb900d709 100644
> --- a/tests/kms_sysfs_edid_timing.c
> +++ b/tests/kms_sysfs_edid_timing.c
> @@ -25,6 +25,8 @@
> * TEST: kms sysfs edid timing
> * Category: Display
> * Description: Test to check the time it takes to reprobe each connector.
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -41,8 +43,6 @@
> * if the mean time it takes to reprobe one connector is too long.
> * Additionally, make sure that the mean time for all connectors is
> * not too long.
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> #define THRESHOLD_PER_CONNECTOR 150
> diff --git a/tests/kms_tv_load_detect.c b/tests/kms_tv_load_detect.c
> index a6dbb8823..03d0729ae 100644
> --- a/tests/kms_tv_load_detect.c
> +++ b/tests/kms_tv_load_detect.c
> @@ -26,6 +26,8 @@
> * TEST: kms tv load detect
> * Category: Display
> * Description: Test to check tv load detection.
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "igt.h"
> @@ -33,8 +35,6 @@
> /**
> * SUBTEST: load-detect
> * Description: Check tv load detection works correctly.
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Check tv load detection works correctly.");
> diff --git a/tests/testdisplay.c b/tests/testdisplay.c
> index d498eb04c..5131750ce 100644
> --- a/tests/testdisplay.c
> +++ b/tests/testdisplay.c
> @@ -50,6 +50,8 @@
> * TEST: testdisplay
> * Category: Display
> * Description: Tests basic display functionality.
> + * Driver requirement: i915, xe
> + * Mega feature: General Display Features
> */
>
> #include "config.h"
> @@ -80,8 +82,6 @@
> * SUBTEST:
> * Description: This test is intended for testing of display functionality like
> * modeset, clone modes, test patterns & pixel generators etc..
> - * Driver requirement: i915, xe
> - * Mega feature: General Display Features
> */
>
> IGT_TEST_DESCRIPTION("Tests basic display functionality.");
More information about the igt-dev
mailing list