MdePkg: Add new enum EfiPlatformConfigurationActionUnsupportedGuid
authorRuiyu Ni <ruiyu.ni@intel.com>
Mon, 1 Feb 2016 03:01:39 +0000 (03:01 +0000)
committerniruiyu <niruiyu@Edk2>
Mon, 1 Feb 2016 03:01:39 +0000 (03:01 +0000)
Add new enum EfiPlatformConfigurationActionUnsupportedGuid to
EFI_PLATFORM_CONFIGURATION_ACTION to be used by Response() when
Query() returns a unsupported ParameterTypeGuid.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@19784 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Protocol/PlatformToDriverConfiguration.h

index ee10dc74f7af38ac87f6c26166f4f2f3b4cf65e8..4756af45160011d88c154730f55a46a4455cb044 100644 (file)
@@ -5,7 +5,7 @@
   by a UEFI Driver in its Start() function. This protocol allows the driver to receive \r
   configuration information as part of being started.\r
 \r
-  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -44,7 +44,15 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
   returned by the platform, and calls Response passing in the\r
   arguments returned from Query. The Instance value passed into\r
   Response must be the same value passed into the corresponding\r
-  call to Query.\r
+  call to Query. The UEFI driver must continuously call Query and\r
+  Response until EFI_NOT_FOUND is returned by Query.\r
+  If the UEFI driver does not recognize the ParameterTypeGuid, it\r
+  calls Response with a ConfigurationAction of\r
+  EfiPlatformConfigurationActionUnsupportedGuid. The UEFI driver\r
+  must then continue calling Query and Response until EFI_NOT_FOUND\r
+  is returned by Query. This gives the platform an opportunity to\r
+  pass additional configuration settings using a different\r
+  ParameterTypeGuid that may be supported by the driver.\r
   An Instance value of zero means return the first ParameterBlock\r
   in the set of unprocessed parameter blocks. The driver should\r
   increment the Instance value by one for each successive call to Query.\r
@@ -183,6 +191,20 @@ typedef enum {
   ///  after ControllerHandle is stopped. \r
   /// \r
   EfiPlatformConfigurationActionNvramFailed       = 4,\r
+\r
+  ///\r
+  /// The controller specified by ControllerHandle is still\r
+  /// in a usable state; its configuration has not been updated\r
+  /// via parsing the ParameterBlock. The driver did not support\r
+  /// the ParameterBlock format identified by ParameterTypeGuid.\r
+  /// No actions are required before this controller can be used\r
+  /// again. On additional Query calls from this ControllerHandle,\r
+  /// the platform should stop returning a ParameterBlock\r
+  /// qualified by this same ParameterTypeGuid. If no other\r
+  /// ParameterTypeGuid is supported by the platform, Query\r
+  /// should return EFI_NOT_FOUND.\r
+  ///\r
+  EfiPlatformConfigurationActionUnsupportedGuid   = 5,\r
   EfiPlatformConfigurationActionMaximum\r
 } EFI_PLATFORM_CONFIGURATION_ACTION;\r
 \r