[edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

[edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

[Heinrich Schuchardt]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2169

The UEFI specification allows EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.SetState()
to return EFI_UNSUPPORTED if a state change is not supported. This for
instance may be the case when connecting via a serial connection.

Up to now the SCT has marked the conformance test as FAILED if SetState()
was called with invalid parameters and EFI_UNSUPPORTED was returned which
contradicts the specification.

Instead create a warning if SetState() returns EFI_UNSUPPORTED. This allows
the user to check if the non-support is justified.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
v2:
	Issue warning if EFI_UNSUPPORTED is returned when called with
	invalid parameters.
---
 .../BlackBoxTest/SimpleTextInputExBBTestConformance.c       | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
index d997b651..946cb274 100644
--- a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
+++ b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
@@ -483,8 +483,10 @@ BBTestSetStateConformanceTestCheckpoint1 (
                         );
     }
   }
-  
-  if ( EFI_INVALID_PARAMETER != Status) {
+
+  if (Status == EFI_UNSUPPORTED) {
+    AssertionType = EFI_TEST_ASSERTION_WARNING;
+  } else if (Status != EFI_INVALID_PARAMETER) {
     AssertionType = EFI_TEST_ASSERTION_FAILED;
   } else {
     AssertionType = EFI_TEST_ASSERTION_PASSED;
-- 
2.20.1

Re: [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

[Eric Jin]

Heinrich,

Could you please provide your company/organization info in copyright part?
I could help to add it when I push the patch.

With that - Reviewed by: Eric Jin <eric.jin@intel.com>

Best Regards
Eric

-----Original Message-----
From: Heinrich Schuchardt <xypron.glpk@gmx.de> 
Sent: Thursday, September 12, 2019 2:45 AM
To: EDK II Development <devel@edk2.groups.io>
Cc: Jin, Eric <eric.jin@intel.com>; Supreeth Venkatesh <supreeth.venkatesh@arm.com>; Stephano Cetola <stephano.cetola@linux.intel.com>; Heinrich Schuchardt <xypron.glpk@gmx.de>
Subject: [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2169

The UEFI specification allows EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.SetState()
to return EFI_UNSUPPORTED if a state change is not supported. This for instance may be the case when connecting via a serial connection.

Up to now the SCT has marked the conformance test as FAILED if SetState() was called with invalid parameters and EFI_UNSUPPORTED was returned which contradicts the specification.

Instead create a warning if SetState() returns EFI_UNSUPPORTED. This allows the user to check if the non-support is justified.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
v2:
	Issue warning if EFI_UNSUPPORTED is returned when called with
	invalid parameters.
---
 .../BlackBoxTest/SimpleTextInputExBBTestConformance.c       | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
index d997b651..946cb274 100644
--- a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
+++ b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/Black
+++ BoxTest/SimpleTextInputExBBTestConformance.c
@@ -483,8 +483,10 @@ BBTestSetStateConformanceTestCheckpoint1 (
                         );     }   }-  -  if ( EFI_INVALID_PARAMETER != Status) {++  if (Status == EFI_UNSUPPORTED) {+    AssertionType = EFI_TEST_ASSERTION_WARNING;+  } else if (Status != EFI_INVALID_PARAMETER) {     AssertionType = EFI_TEST_ASSERTION_FAILED;   } else {     AssertionType = EFI_TEST_ASSERTION_PASSED;-- 
2.20.1

Re: [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

[Heinrich Schuchardt]

On 9/12/19 4:32 AM, Jin, Eric wrote:
> Heinrich,
>
> Could you please provide your company/organization info in copyright part?

Hello Eric,

my work on EDK2 has neither been on behalf of a company or organization,
nor have I received any remuneration for it. If you deem it appropriate,
feel free to add my name.

Best regards

Heinrich Schuchardt

> I could help to add it when I push the patch.
>
> With that - Reviewed by: Eric Jin <eric.jin@intel.com>
>
> Best Regards
> Eric
>
> -----Original Message-----
> From: Heinrich Schuchardt <xypron.glpk@gmx.de>
> Sent: Thursday, September 12, 2019 2:45 AM
> To: EDK II Development <devel@edk2.groups.io>
> Cc: Jin, Eric <eric.jin@intel.com>; Supreeth Venkatesh <supreeth.venkatesh@arm.com>; Stephano Cetola <stephano.cetola@linux.intel.com>; Heinrich Schuchardt <xypron.glpk@gmx.de>
> Subject: [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported
>
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2169
>
> The UEFI specification allows EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.SetState()
> to return EFI_UNSUPPORTED if a state change is not supported. This for instance may be the case when connecting via a serial connection.
>
> Up to now the SCT has marked the conformance test as FAILED if SetState() was called with invalid parameters and EFI_UNSUPPORTED was returned which contradicts the specification.
>
> Instead create a warning if SetState() returns EFI_UNSUPPORTED. This allows the user to check if the non-support is justified.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
> v2:
> 	Issue warning if EFI_UNSUPPORTED is returned when called with
> 	invalid parameters.
> ---
>   .../BlackBoxTest/SimpleTextInputExBBTestConformance.c       | 6 ++++--
>   1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
> index d997b651..946cb274 100644
> --- a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
> +++ b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/Black
> +++ BoxTest/SimpleTextInputExBBTestConformance.c
> @@ -483,8 +483,10 @@ BBTestSetStateConformanceTestCheckpoint1 (
>                           );     }   }-  -  if ( EFI_INVALID_PARAMETER != Status) {++  if (Status == EFI_UNSUPPORTED) {+    AssertionType = EFI_TEST_ASSERTION_WARNING;+  } else if (Status != EFI_INVALID_PARAMETER) {     AssertionType = EFI_TEST_ASSERTION_FAILED;   } else {     AssertionType = EFI_TEST_ASSERTION_PASSED;--
> 2.20.1
>
>

Re: [edk2-devel] [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

[Eric Jin]

Pushed at fc1a95f7b1a4c157d0536bc159bc5114cdfcb9b4

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Eric Jin
Sent: Thursday, September 12, 2019 10:33 AM
To: Heinrich Schuchardt <xypron.glpk@gmx.de>; EDK II Development <devel@edk2.groups.io>
Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>; Stephano Cetola <stephano.cetola@linux.intel.com>
Subject: Re: [edk2-devel] [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

Heinrich,

Could you please provide your company/organization info in copyright part?
I could help to add it when I push the patch.

With that - Reviewed by: Eric Jin <eric.jin@intel.com>

Best Regards
Eric

-----Original Message-----
From: Heinrich Schuchardt <xypron.glpk@gmx.de> 
Sent: Thursday, September 12, 2019 2:45 AM
To: EDK II Development <devel@edk2.groups.io>
Cc: Jin, Eric <eric.jin@intel.com>; Supreeth Venkatesh <supreeth.venkatesh@arm.com>; Stephano Cetola <stephano.cetola@linux.intel.com>; Heinrich Schuchardt <xypron.glpk@gmx.de>
Subject: [edk2-test] [PATCH v2 1/1] uefi-sct/SctPkg: setting key toggle state may be unsupported

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2169

The UEFI specification allows EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.SetState()
to return EFI_UNSUPPORTED if a state change is not supported. This for instance may be the case when connecting via a serial connection.

Up to now the SCT has marked the conformance test as FAILED if SetState() was called with invalid parameters and EFI_UNSUPPORTED was returned which contradicts the specification.

Instead create a warning if SetState() returns EFI_UNSUPPORTED. This allows the user to check if the non-support is justified.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
v2:
	Issue warning if EFI_UNSUPPORTED is returned when called with
	invalid parameters.
---
 .../BlackBoxTest/SimpleTextInputExBBTestConformance.c       | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
index d997b651..946cb274 100644
--- a/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/BlackBoxTest/SimpleTextInputExBBTestConformance.c
+++ b/uefi-sct/SctPkg/TestCase/UEFI/EFI/Protocol/SimpleTextInputEx/Black
+++ BoxTest/SimpleTextInputExBBTestConformance.c
@@ -483,8 +483,10 @@ BBTestSetStateConformanceTestCheckpoint1 (
                         );     }   }-  -  if ( EFI_INVALID_PARAMETER != Status) {++  if (Status == EFI_UNSUPPORTED) {+    AssertionType = EFI_TEST_ASSERTION_WARNING;+  } else if (Status != EFI_INVALID_PARAMETER) {     AssertionType = EFI_TEST_ASSERTION_FAILED;   } else {     AssertionType = EFI_TEST_ASSERTION_PASSED;-- 
2.20.1