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

[Sharma, Swati2]

LGTM
Reviewed-by: Swati Sharma <swati2.sharma at intel.com>

On 29-Jun-23 8:18 PM, Bhanuprakash Modem wrote:
> Add documentation for all kms tests which is used by IGT testplan
> documentation.
> 
> Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
> ---
>   tests/i915/kms_cdclk.c | 32 ++++++++++++++++++++++++++++++++
>   1 file changed, 32 insertions(+)
> 
> diff --git a/tests/i915/kms_cdclk.c b/tests/i915/kms_cdclk.c
> index 40eca24f0..276cda4c4 100644
> --- a/tests/i915/kms_cdclk.c
> +++ b/tests/i915/kms_cdclk.c
> @@ -24,6 +24,11 @@
>    *  Swati Sharma <swati2.sharma at intel.com>
>    */
>   
> +/**
> + * TEST: kms cdclk
> + * Category: Display
> + * Description: Test cdclk features : crawling and squashing
> + */
>   #include "igt.h"
>   
>   IGT_TEST_DESCRIPTION("Test cdclk features : crawling and squashing");
> @@ -248,6 +253,16 @@ static void test_mode_transition(data_t *data, enum pipe pipe, igt_output_t *out
>   	igt_remove_fb(display->drm_fd, &fb);
>   }
>   
> +/**
> + * SUBTEST: mode-transition-all-outputs
> + * Description: Mode transition (low to high) test to validate cdclk frequency
> + *              change by simultaneous modesets on all pipes with valid outputs.
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + */
>   static void test_mode_transition_on_all_outputs(data_t *data)
>   {
>   	igt_display_t *display = &data->display;
> @@ -344,6 +359,23 @@ static void test_mode_transition_on_all_outputs(data_t *data)
>   	igt_remove_fb(data->drm_fd, &fb);
>   }
>   
> +/**
> + * SUBTEST: mode-transition
> + * Description: Mode transition (low to high) test to validate cdclk frequency change.
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: plane-scaling
> + * Description: Plane scaling test to validate cdclk frequency change.
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + */
>   static void run_cdclk_test(data_t *data, uint32_t flags)
>   {
>   	igt_display_t *display = &data->display;