[igt-dev] [i-g-t V7 53/81] tests/kms_invalid_mode: Document each subtest for testplan

[Bhanuprakash Modem]

Add documentation for all kms tests which is used by IGT testplan
documentation.

V2: - Fix test description
V3: - Driver requirement: s/any/i915, xe/

Cc: Swati Sharma <swati2.sharma at intel.com>
Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
Reviewed-by: Swati Sharma <swati2.sharma at intel.com>
---
 tests/kms_invalid_mode.c | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/tests/kms_invalid_mode.c b/tests/kms_invalid_mode.c
index c26f8befe..306fa972f 100644
--- a/tests/kms_invalid_mode.c
+++ b/tests/kms_invalid_mode.c
@@ -22,10 +22,42 @@
  *
  */
 
+/**
+ * TEST: kms invalid mode
+ * Category: Display
+ * Description: Make sure all modesets are rejected when the requested mode is
+ *              invalid
+ */
 #include "igt.h"
 #include <limits.h>
 #include <stdbool.h>
 
+/**
+ * SUBTEST: %s
+ * Description: Make sure all modesets are rejected when the requested mode
+ *              (%arg[1]) is invalid
+ * Driver requirement: i915, xe
+ * Functionality: kms_core
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * arg[1]:
+ *
+ * @bad-hsync-end:    Bad hsync_end
+ * @bad-hsync-start:  Bad hsync_start
+ * @bad-htotal:       Bad htotal
+ * @bad-vsync-end:    Bad vsync_end
+ * @bad-vsync-start:  Bad vsync_start
+ * @bad-vtotal:       Bad vtotal
+ * @clock-too-high:   High clock
+ * @int-max-clock:    Clock as INT_MAX
+ * @uint-max-clock:   Clock as UINT_MAX
+ * @zero-clock:       Clock as zero
+ * @zero-hdisplay:    hdisplay as zero
+ * @zero-vdisplay:    vdisplay as zero
+ */
+
 IGT_TEST_DESCRIPTION("Make sure all modesets are rejected when the requested mode is invalid");
 
 typedef struct _data data_t;
-- 
2.40.0