MdePkg: Add EFI_UNSUPPORTED return for some Runtime Service functions

According to UEFI Spec 2.10 page 206, if any EFI_RUNTIME_SERVICES* calls
are not supported for use by the OS at runtime, an EFI_RT_PROPERTIES_TABLE
configuration table should be published describing which runtime services
are supported at runtime. So need to add EFI_UNSUPPORTED return for some
Runtime Service functions.

REF: UEFI spec 2.10 section 8 Services ? Runtime Services

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Signed-off-by: Suqiang Ren <suqiangx.ren@intel.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

3 files changed, 122 insertions, 11 deletions

diff --git a/MdePkg/Include/Library/UefiRuntimeLib.h b/MdePkg/Include/Library/UefiRuntimeLib.h
index 2b95b63f9f..c5aca42aa1 100644
--- a/MdePkg/Include/Library/UefiRuntimeLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeLib.h
@@ -64,6 +64,9 @@ EfiGoneVirtual (
   @retval  EFI_SUCCESS            The operation completed successfully.

   @retval  EFI_INVALID_PARAMETER  Time is NULL.

   @retval  EFI_DEVICE_ERROR       The time could not be retrieved due to a hardware error.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -93,6 +96,9 @@ EfiGetTime (
   @retval  EFI_SUCCESS            The operation completed successfully.

   @retval  EFI_INVALID_PARAMETER  A time field is out of range.

   @retval  EFI_DEVICE_ERROR       The time could not be set due to a hardware error.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -119,7 +125,9 @@ EfiSetTime (
   @retval  EFI_INVALID_PARAMETER  Pending is NULL.

   @retval  EFI_INVALID_PARAMETER  Time is NULL.

   @retval  EFI_DEVICE_ERROR       The wakeup time could not be retrieved due to a hardware error.

-  @retval  EFI_UNSUPPORTED        A wakeup timer is not supported on this platform.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -149,7 +157,9 @@ EfiGetWakeupTime (
                                   If Enable is FALSE, then the wakeup alarm was disabled.

   @retval  EFI_INVALID_PARAMETER  A time field is out of range.

   @retval  EFI_DEVICE_ERROR       The wakeup time could not be set due to a hardware error.

-  @retval  EFI_UNSUPPORTED        A wakeup timer is not supported on this platform.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -188,6 +198,10 @@ EfiSetWakeupTime (
   @retval  EFI_INVALID_PARAMETER  The DataSize is not too small and Data is NULL.

   @retval  EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.

   @retval  EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.

+  @retval  EFI_UNSUPPORTED        After ExitBootServices() has been called, this return code may be returned

+                                  if no variable storage is supported. The platform should describe this

+                                  runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                  configuration table.

 **/

 EFI_STATUS

 EFIAPI

@@ -227,6 +241,10 @@ EfiGetVariable (
   @retval  EFI_INVALID_PARAMETER VariableName is NULL.

   @retval  EFI_INVALID_PARAMETER VendorGuid is NULL.

   @retval  EFI_DEVICE_ERROR      The variable name could not be retrieved due to a hardware error.

+  @retval  EFI_UNSUPPORTED       After ExitBootServices() has been called, this return code may be returned

+                                 if no variable storage is supported. The platform should describe this

+                                 runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                 configuration table.

 

 **/

 EFI_STATUS

@@ -264,6 +282,9 @@ EfiGetNextVariableName (
                                   set but the AuthInfo does NOT pass the validation check carried

                                   out by the firmware.

   @retval  EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -290,6 +311,10 @@ EfiSetVariable (
   @retval  EFI_SUCCESS           The next high monotonic count was returned.

   @retval  EFI_DEVICE_ERROR      The device is not functioning properly.

   @retval  EFI_INVALID_PARAMETER HighCount is NULL.

+  @retval  EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                 The platform should describe this runtime service as unsupported at runtime

+                                 via an EFI_RT_PROPERTIES_TABLE configuration table.

+

 

 **/

 EFI_STATUS

@@ -350,7 +375,11 @@ EfiResetSystem (
   @retval  EFI_NOT_FOUND          The pointer pointed to by Address was not found to be part of

                                   the current memory map. This is normally fatal.

   @retval  EFI_INVALID_PARAMETER  Address is NULL.

-  @retval  EFI_INVALID_PARAMETER  *Address is NULL and DebugDispositio

+  @retval  EFI_INVALID_PARAMETER  *Address is NULL and DebugDisposition does

+                                  not have the EFI_OPTIONAL_PTR bit set.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -414,6 +443,9 @@ EfiConvertFunctionPointer (
                                 map that requires a mapping.

   @retval EFI_NOT_FOUND         A virtual address was supplied for an address that is not found

                                 in the memory map.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 **/

 EFI_STATUS

 EFIAPI

@@ -478,6 +510,9 @@ EfiConvertList (
   @retval EFI_DEVICE_ERROR      The capsule update was started, but failed due to a device error.

   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform.

   @retval EFI_OUT_OF_RESOURCES  There were insufficient resources to process the capsule.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -520,6 +555,9 @@ EfiUpdateCapsule (
   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform, and

                                 MaximumCapsuleSize and ResetType are undefined.

   @retval EFI_OUT_OF_RESOURCES  There were insufficient resources to process the query request.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index ad80afbe34..7fcdeab93e 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -320,6 +320,9 @@ EFI_STATUS
                                 map that requires a mapping.

   @retval EFI_NOT_FOUND         A virtual address was supplied for an address that is not found

                                 in the memory map.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -410,11 +413,14 @@ EFI_STATUS
                                      for the new virtual address mappings being applied.

 

   @retval EFI_SUCCESS           The pointer pointed to by Address was modified.

-  @retval EFI_INVALID_PARAMETER 1) Address is NULL.

-                                2) *Address is NULL and DebugDisposition does

-                                not have the EFI_OPTIONAL_PTR bit set.

   @retval EFI_NOT_FOUND         The pointer pointed to by Address was not found to be part

                                 of the current memory map. This is normally fatal.

+  @retval EFI_INVALID_PARAMETER Address is NULL.

+  @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDisposition does

+                                not have the EFI_OPTIONAL_PTR bit set.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -679,6 +685,10 @@ VOID
   @retval EFI_INVALID_PARAMETER  The DataSize is not too small and Data is NULL.

   @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.

   @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.

+  @retval EFI_UNSUPPORTED        After ExitBootServices() has been called, this return code may be returned

+                                 if no variable storage is supported. The platform should describe this

+                                 runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                 configuration table.

 

 **/

 typedef

@@ -715,6 +725,10 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Null-terminator is not found in the first VariableNameSize bytes of

                                 the input VariableName buffer.

   @retval EFI_DEVICE_ERROR      The variable could not be retrieved due to a hardware error.

+  @retval EFI_UNSUPPORTED       After ExitBootServices() has been called, this return code may be returned

+                                if no variable storage is supported. The platform should describe this

+                                runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                configuration table.

 

 **/

 typedef

@@ -757,6 +771,9 @@ EFI_STATUS
                                  but the AuthInfo does NOT pass the validation check carried out by the firmware.

 

   @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.

+  @retval EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                 The platform should describe this runtime service as unsupported at runtime

+                                 via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -809,6 +826,9 @@ typedef struct {
   @retval EFI_SUCCESS           The operation completed successfully.

   @retval EFI_INVALID_PARAMETER Time is NULL.

   @retval EFI_DEVICE_ERROR      The time could not be retrieved due to hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -826,6 +846,9 @@ EFI_STATUS
   @retval EFI_SUCCESS           The operation completed successfully.

   @retval EFI_INVALID_PARAMETER A time field is out of range.

   @retval EFI_DEVICE_ERROR      The time could not be set due due to hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -846,7 +869,9 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Pending is NULL.

   @retval EFI_INVALID_PARAMETER Time is NULL.

   @retval EFI_DEVICE_ERROR      The wakeup time could not be retrieved due to a hardware error.

-  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -868,7 +893,9 @@ EFI_STATUS
                                 Enable is FALSE, then the wakeup alarm was disabled.

   @retval EFI_INVALID_PARAMETER A time field is out of range.

   @retval EFI_DEVICE_ERROR      The wakeup time could not be set due to a hardware error.

-  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -1090,6 +1117,9 @@ EFI_STATUS
   @retval EFI_SUCCESS           The next high monotonic count was returned.

   @retval EFI_INVALID_PARAMETER HighCount is NULL.

   @retval EFI_DEVICE_ERROR      The device is not functioning properly.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -1716,6 +1746,9 @@ typedef struct {
                                 in runtime. The caller may resubmit the capsule prior to ExitBootServices().

   @retval EFI_OUT_OF_RESOURCES  When ExitBootServices() has not been previously called then this error indicates

                                 the capsule is compatible with this platform but there are insufficient resources to process.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

@@ -1747,6 +1780,9 @@ EFI_STATUS
                                 in runtime. The caller may resubmit the capsule prior to ExitBootServices().

   @retval EFI_OUT_OF_RESOURCES  When ExitBootServices() has not been previously called then this error indicates

                                 the capsule is compatible with this platform but there are insufficient resources to process.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 typedef

diff --git a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
index ffc4cf4d2a..2563f6e060 100644
--- a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
+++ b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
@@ -252,6 +252,9 @@ EfiResetSystem (
   @retval  EFI_SUCCESS            The operation completed successfully.

   @retval  EFI_INVALID_PARAMETER  Time is NULL.

   @retval  EFI_DEVICE_ERROR       The time could not be retrieved due to a hardware error.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -284,6 +287,9 @@ EfiGetTime (
   @retval  EFI_SUCCESS            The operation completed successfully.

   @retval  EFI_INVALID_PARAMETER  A time field is out of range.

   @retval  EFI_DEVICE_ERROR       The time could not be set due to a hardware error.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -313,7 +319,9 @@ EfiSetTime (
   @retval  EFI_INVALID_PARAMETER  Pending is NULL.

   @retval  EFI_INVALID_PARAMETER  Time is NULL.

   @retval  EFI_DEVICE_ERROR       The wakeup time could not be retrieved due to a hardware error.

-  @retval  EFI_UNSUPPORTED        A wakeup timer is not supported on this platform.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -346,7 +354,9 @@ EfiGetWakeupTime (
                                   If Enable is FALSE, then the wakeup alarm was disabled.

   @retval  EFI_INVALID_PARAMETER  A time field is out of range.

   @retval  EFI_DEVICE_ERROR       The wakeup time could not be set due to a hardware error.

-  @retval  EFI_UNSUPPORTED        A wakeup timer is not supported on this platform.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -388,6 +398,10 @@ EfiSetWakeupTime (
   @retval  EFI_INVALID_PARAMETER  The DataSize is not too small and Data is NULL.

   @retval  EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.

   @retval  EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.

+  @retval  EFI_UNSUPPORTED        After ExitBootServices() has been called, this return code may be returned

+                                  if no variable storage is supported. The platform should describe this

+                                  runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                  configuration table.

 **/

 EFI_STATUS

 EFIAPI

@@ -430,6 +444,10 @@ EfiGetVariable (
   @retval  EFI_INVALID_PARAMETER VariableName is NULL.

   @retval  EFI_INVALID_PARAMETER VendorGuid is NULL.

   @retval  EFI_DEVICE_ERROR      The variable name could not be retrieved due to a hardware error.

+  @retval  EFI_UNSUPPORTED       After ExitBootServices() has been called, this return code may be returned

+                                 if no variable storage is supported. The platform should describe this

+                                 runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                 configuration table.

 

 **/

 EFI_STATUS

@@ -470,6 +488,9 @@ EfiGetNextVariableName (
                                   set but the AuthInfo does NOT pass the validation check carried

                                   out by the firmware.

   @retval  EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -499,6 +520,9 @@ EfiSetVariable (
   @retval  EFI_SUCCESS           The next high monotonic count was returned.

   @retval  EFI_DEVICE_ERROR      The device is not functioning properly.

   @retval  EFI_INVALID_PARAMETER HighCount is NULL.

+  @retval  EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                 The platform should describe this runtime service as unsupported at runtime

+                                 via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -525,7 +549,11 @@ EfiGetNextHighMonotonicCount (
   @retval  EFI_NOT_FOUND          The pointer pointed to by Address was not found to be part of

                                   the current memory map. This is normally fatal.

   @retval  EFI_INVALID_PARAMETER  Address is NULL.

-  @retval  EFI_INVALID_PARAMETER  *Address is NULL and DebugDispositio

+  @retval  EFI_INVALID_PARAMETER  *Address is NULL and DebugDisposition does

+                                  not have the EFI_OPTIONAL_PTR bit set.

+  @retval  EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.

+                                  The platform should describe this runtime service as unsupported at runtime

+                                  via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -649,6 +677,9 @@ EfiConvertList (
                                 map that requires a mapping.

   @retval EFI_NOT_FOUND         A virtual address was supplied for an address that is not found

                                 in the memory map.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 **/

 EFI_STATUS

 EFIAPI

@@ -699,6 +730,9 @@ EfiSetVirtualAddressMap (
   @retval EFI_DEVICE_ERROR      The capsule update was started, but failed due to a device error.

   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform.

   @retval EFI_OUT_OF_RESOURCES  There were insufficient resources to process the capsule.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -748,6 +782,9 @@ EfiUpdateCapsule (
   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform, and

                                 MaximumCapsuleSize and ResetType are undefined.

   @retval EFI_OUT_OF_RESOURCES  There were insufficient resources to process the query request.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS