[igt-dev] [V5 i-g-t 15/81] tests/i915/kms_draw_crc: Document each subtest for testplan

[B, Jeevan]

> -----Original Message-----
> From: igt-dev <igt-dev-bounces at lists.freedesktop.org> On Behalf Of
> Bhanuprakash Modem
> Sent: Thursday, June 29, 2023 8:18 PM
> To: igt-dev at lists.freedesktop.org
> Subject: [igt-dev] [V5 i-g-t 15/81] tests/i915/kms_draw_crc: Document each
> subtest for testplan
> 
> Add documentation for all kms tests which is used by IGT testplan
> documentation.
> 
> Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
LGTM.
Reviewed-by: Jeevan B <jeevan.b at intel.com>

> ---
>  tests/i915/kms_draw_crc.c | 49
> +++++++++++++++++++++++++++++++++++++--
>  1 file changed, 47 insertions(+), 2 deletions(-)
> 
> diff --git a/tests/i915/kms_draw_crc.c b/tests/i915/kms_draw_crc.c index
> 01ecb7bb9..8a001f6b6 100644
> --- a/tests/i915/kms_draw_crc.c
> +++ b/tests/i915/kms_draw_crc.c
> @@ -22,8 +22,11 @@
>   *
>   */
> 
> -/* This program tests whether the igt_draw library actually works. */
> -
> +/**
> + * TEST: kms draw crc
> + * Category: Display
> + * Description: Tests whether the igt_draw library actually works.
> + */
>  #include "i915/gem.h"
>  #include "igt.h"
> 
> @@ -140,6 +143,39 @@ static void get_method_crc(enum igt_draw_method
> method, uint32_t drm_format,
>  	igt_remove_fb(drm_fd, &fb);
>  }
> 
> +/**
> + * SUBTEST: draw-method-%s
> + * Description: Verify that igt draw library works for the %arg[1] method
> with
> + *              different modifiers & DRM formats.
> + * Driver requirement: any
> + * Functionality: kms_gem_interop
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * arg[1]:
> + *
> + * @blt:          Blitter
> + * @mmap-wc:      MMAP-WC
> + * @render:       Render
> + */
> +
> +/**
> + * SUBTEST: draw-method-%s
> + * Description: Verify that igt draw library works for the %arg[1] method
> with
> + *              different modifiers & DRM formats.
> + * Driver requirement: i915
> + * Functionality: kms_gem_interop
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * arg[1]:
> + *
> + * @mmap-cpu:     MMAP-CPU
> + * @mmap-gtt:     MMAP-GTT
> + * @pwrite:       PWRITE
> + */
>  static void draw_method_subtest(enum igt_draw_method method,
>  				uint32_t format_index, uint64_t modifier)  {
> @@ -179,6 +215,15 @@ static void get_fill_crc(uint64_t modifier, igt_crc_t
> *crc)
>  	igt_remove_fb(drm_fd, &fb);
>  }
> 
> +/**
> + * SUBTEST: fill-fb
> + * Description: This subtest verifies CRC after filling fb with x-tiling or none.
> + * Driver requirement: any
> + * Functionality: kms_gem_interop
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + */
>  static void fill_fb_subtest(void)
>  {
>  	int rc;
> --
> 2.40.0