[igt-dev] [V5 i-g-t 67/81] tests/kms_properties: 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/kms_properties.c | 40 ++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 40 insertions(+)
> 
> diff --git a/tests/kms_properties.c b/tests/kms_properties.c
> index 8645808d1..197c72065 100644
> --- a/tests/kms_properties.c
> +++ b/tests/kms_properties.c
> @@ -28,6 +28,31 @@
>   #include <stdio.h>
>   #include <string.h>
>   #include <time.h>
> +/**
> + * TEST: kms properties
> + * Category: Display
> + *
> + * SUBTEST: %s-properties-%s
> + * Description: Tests %arg[1] properties with %arg[2] commit
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * arg[1]:
> + *
> + * @connector:       Connector
> + * @crtc:            CRTC
> + * @plane:           Plane
> + * @invalid:         Invalid (connector/crtc/plane)
> + *
> + * arg[2]:
> + *
> + * @atomic:          atomic
> + * @legacy:          legacy
> + */
> +
>   
>   struct additional_test {
>   	const char *name;
> @@ -687,6 +712,21 @@ static void expect_no_props(int fd, uint32_t obj_type, uint32_t obj_id)
>   	igt_assert_neq(drmIoctl(fd, DRM_IOCTL_MODE_OBJ_GETPROPERTIES, &properties), 0);
>   }
>   
> +/**
> + * SUBTEST: get_properties-sanity-%s
> + * Description: Test validates the properties of all planes, crtc and connectors
> + *              with %arg[1] commit
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * arg[1]:
> + *
> + * @atomic:          atomic
> + * @non-atomic:      legacy
> + */
>   static void get_prop_sanity(igt_display_t *display, bool atomic)
>   {
>   	int fd = display->drm_fd;