[igt-dev] [i-g-t V3 21/82] tests/i915/kms_flip_scaled_crc: Document each subtest for testplan

[Bhanuprakash Modem]

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_flip_scaled_crc.c | 191 +++++++++++++++++++++++++++++++
 1 file changed, 191 insertions(+)

diff --git a/tests/i915/kms_flip_scaled_crc.c b/tests/i915/kms_flip_scaled_crc.c
index f5dc430e3..6768926b0 100644
--- a/tests/i915/kms_flip_scaled_crc.c
+++ b/tests/i915/kms_flip_scaled_crc.c
@@ -22,8 +22,199 @@
  *
  */
 
+/**
+ * TEST: kms flip scaled crc
+ * Category: Display
+ * Description: Test flipping between scaled/nonscaled framebuffers
+ */
 #include "igt.h"
 
+/**
+ * SUBTEST: flip-64bpp-ytile-to-32bpp-ytilegen12rcccs-upscaling
+ * Description: Flip from 64bpp non scaled fb to 32bpp upscaled fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-64bpp-ytile-to-32bpp-ytilercccs-downscaling
+ * Description: Flip from 64bpp non scaled fb to 32bpp downscaled fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-linear-to-64bpp-linear-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: any
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-4tile-to-32bpp-4tiledg2rcccs-%s
+ * Description: Flip from 32bpp non scaled fb to 32bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-4tile-to-64bpp-4tile-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-xtile-to-64bpp-xtile-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-yftile-to-32bpp-yftileccs-%s
+ * Description: Flip from 32bpp non scaled fb to 32bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-yftile-to-64bpp-yftile-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-yftileccs-to-64bpp-yftile-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-ytile-to-32bpp-ytileccs-%s
+ * Description: Flip from 32bpp non scaled fb to 32bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-ytile-to-32bpp-ytilegen12rcccs-%s
+ * Description: Flip from 32bpp non scaled fb to 32bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-ytile-to-64bpp-ytile-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-32bpp-ytileccs-to-64bpp-ytile-%s
+ * Description: Flip from 32bpp non scaled fb to 64bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-64bpp-4tile-to-32bpp-4tiledg2rcccs-%s
+ * Description: Flip from 64bpp non scaled fb to 32bpp %arg[1] fb to stress CD
+ *              clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * arg[1]:
+ *
+ * @downscaling:        Downscaled
+ * @upscaling:          Upscaled
+ */
+
+/**
+ * SUBTEST: flip-64bpp-4tile-to-%dbpp-4tile-%s
+ * Description: Flip from 64bpp non scaled fb to %arg[1]bpp %arg[2] fb to stress
+ *              CD clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-64bpp-xtile-to-%dbpp-xtile-%s
+ * Description: Flip from 64bpp non scaled fb to %arg[1]bpp %arg[2] fb to stress
+ *              CD clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-64bpp-yftile-to-%dbpp-yftile-%s
+ * Description: Flip from 64bpp non scaled fb to %arg[1]bpp %arg[2] fb to stress
+ *              CD clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-64bpp-ytile-to-%dbpp-ytile-%s
+ * Description: Flip from 64bpp non scaled fb to %arg[1]bpp %arg[2] fb to stress
+ *              CD clock programming
+ * Driver requirement: i915
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: flip-64bpp-linear-to-%dbpp-linear-%s
+ * Description: Flip from 64bpp non scaled fb to %arg[1]bpp %arg[2] fb to stress
+ *              CD clock programming
+ * Driver requirement: any
+ * Functionality: vblank
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * arg[1].values: 16, 32
+ * arg[2]:
+ *
+ * @downscaling:        Downscaled
+ * @upscaling:          Upscaled
+ */
+
 IGT_TEST_DESCRIPTION("Test flipping between scaled/nonscaled framebuffers");
 
 typedef struct {
-- 
2.40.0