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

[Modem, Bhanuprakash]

Hi Swati,

On Mon-14-08-2023 10:34 am, Sharma, Swati2 wrote:
> 
> On 10-Aug-23 10:53 PM, Modem, Bhanuprakash wrote:
>> Hi Swati,
>>
>> On Wed-09-08-2023 01:20 pm, Sharma, Swati2 wrote:
>>> 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_dsc.c | 27 +++++++++++++++++++++++++++
>>>>   1 file changed, 27 insertions(+)
>>>>
>>>> diff --git a/tests/i915/kms_dsc.c b/tests/i915/kms_dsc.c
>>>> index 0a3e29924..4cce7face 100644
>>>> --- a/tests/i915/kms_dsc.c
>>>> +++ b/tests/i915/kms_dsc.c
>>>> @@ -30,8 +30,35 @@
>>>>    *
>>>>    */
>>>> +/**
>>>> + * TEST: kms dsc
>>>> + * Category: Display
>>>> + * Description: Test to validate display stream compression
>>>> + */
>>>>   #include "kms_dsc_helper.h"
>>>> +/**
>>>> + * SUBTEST: dsc-%s
>>>> + * Description: Tests basic display stream compression 
>>>> functionality if supported
>>>> + *              by a connector by forcing %arg[1]
>>>
>>> forcing DSC on all connectors that support it with %arg[1]
>>> (remove this from below subtests description)
>>
>> This description is adopted from igt_describe(), Feel free to update 
>> the subtest description I can pick it from there.
> 
> But you haven't copied it as it is..right? Its the optimized version
> of igt_describe(). I simply meant.

No, I have copied as it is.
You can verify by comparing [1] & [2] from igt repo.

[1]: ./scripts/igt_doc.py --config=tests/kms_test_config.json 
--files=tests/i915/kms_dsc.c --per-test
[2]: ./build/tests/kms_dsc --describe

> "forcing DSC on all connectors that support it with %arg[1]" => is 
> redundant in descriptions you have written below for each subtest.

You mean to say to remove "DSC on all connectors that support it" from 
the description?

Then it'll become:

* SUBTEST: dsc-%s
* Description: Tests Display Stream Compression functionality if 
supported with %arg[1]
*
* arg[1]:
*
* @basic:                default parameters
* @with-bpc:             certain input BPC for that connector

...

- Bhanu

> We don't have to change igt_describe() for this. This should be handled 
> here.
> 
>>
>>>
>>>> + * Driver requirement: any
>>>
>>> This is intel specific test.
>>
>> Yes. As this kms testplan is designed for Intel, the allowed values are:
>>
>> i915: supports i915 driver only
>> xe: supports xe driver only
>> any: supports both i915 & xe
> 
> This ANY seems to correspond to drm_open_driver_master(DRIVER_ANY).
> IDK this is right. @mauro do you have any inputs here?
> Shouldn't "any" correspond to "any" driver. Even if this documentation
> is specific to intel but tests outside i915/ directory are used by other
> vendors too.
> 
>>
>>>
>>>> + * Functionality: dsc
>>>> + * Mega feature: VDSC
>>>> + * Run type: FULL
>>>> + * Test category: functionality test
>>>> + *
>>>> + * arg[1]:
>>>> + *
>>>> + * @basic:                DSC on all connectors that support it 
>>>> with default parameters
>>>> + * @with-bpc:             DSC on all connectors that support it 
>>>> with certain input BPC
>>>> + *                        for the connector
>>>> + * @with-bpc-formats:     DSC on all connectors that support it 
>>>> with certain input
>>>> + *                        BPC for the connector with diff formats
>>>> + * @with-formats:         DSC on all connectors that support it 
>>>> with default parameters
>>>> + *                        and creating fb with diff formats
>>>> + * @with-output-formats:  DSC and output format on all connectors 
>>>> that support it
>>>> + */
>>>> +
>>>
>>> dsc-with-output-formats-with-bpc subtest is added too recently. 
>>> please add.
>>
>> Will add in next rev.
>>
>> - Bhanu
>>
>>>
>>>>   IGT_TEST_DESCRIPTION("Test to validate display stream compression");
>>>>   enum dsc_test_type {