MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / DisplayProtocol.h

diff --git a/MdeModulePkg/Include/Protocol/DisplayProtocol.h b/MdeModulePkg/Include/Protocol/DisplayProtocol.h
index 664c227768b07df37cfb2f5f5627419f6bbef1a2..748ceed177edd4e67752a1d8c2065a382741a0f2 100644 (file)
--- a/MdeModulePkg/Include/Protocol/DisplayProtocol.h
+++ b/MdeModulePkg/Include/Protocol/DisplayProtocol.h
@@ -1,14 +1,8 @@
 /** @file\r
   FormDiplay protocol to show Form\r
 \r
-Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
-The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.                                            \r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -20,7 +14,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID  \\r
   { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }\r
 \r
-// \r
+//\r
 // Do nothing.\r
 //\r
 #define BROWSER_ACTION_NONE         BIT16\r
@@ -29,15 +23,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 #define BROWSER_ACTION_FORM_EXIT    BIT17\r
 \r
-#define BROWSER_SUCCESS             0x0\r
-#define BROWSER_ERROR               BIT31\r
-#define BROWSER_SUBMIT_FAIL         BROWSER_ERROR | 0x01\r
-#define BROWSER_NO_SUBMIT_IF        BROWSER_ERROR | 0x02\r
-#define BROWSER_FORM_NOT_FOUND      BROWSER_ERROR | 0x03\r
-#define BROWSER_FORM_SUPPRESS       BROWSER_ERROR | 0x04\r
-#define BROWSER_PROTOCOL_NOT_FOUND  BROWSER_ERROR | 0x05\r
-#define BROWSER_INCONSISTENT_IF     BROWSER_ERROR | 0x06\r
-#define BROWSER_WARNING_IF          BROWSER_ERROR | 0x07\r
+#define BROWSER_SUCCESS                   0x0\r
+#define BROWSER_ERROR                     BIT31\r
+#define BROWSER_SUBMIT_FAIL               BROWSER_ERROR | 0x01\r
+#define BROWSER_NO_SUBMIT_IF              BROWSER_ERROR | 0x02\r
+#define BROWSER_FORM_NOT_FOUND            BROWSER_ERROR | 0x03\r
+#define BROWSER_FORM_SUPPRESS             BROWSER_ERROR | 0x04\r
+#define BROWSER_PROTOCOL_NOT_FOUND        BROWSER_ERROR | 0x05\r
+#define BROWSER_INCONSISTENT_IF           BROWSER_ERROR | 0x06\r
+#define BROWSER_WARNING_IF                BROWSER_ERROR | 0x07\r
+#define BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF  BROWSER_ERROR | 0x08\r
+#define BROWSER_RECONNECT_REQUIRED        BROWSER_ERROR | 0x09\r
+#define BROWSER_RECONNECT_FAIL            BROWSER_ERROR | 0x0A\r
+#define BROWSER_RECONNECT_SAVE_CHANGES    BROWSER_ERROR | 0x0B\r
 \r
 #define FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1  0x10000\r
 #define FORM_DISPLAY_ENGINE_VERSION_1            0x10000\r
@@ -97,11 +95,11 @@ typedef struct {
 \r
 /**\r
   Perform value check for a question.\r
-  \r
+\r
   @param  Form       Form where Statement is in.\r
   @param  Statement  Value will check for it.\r
   @param  Value      New value will be checked.\r
-  \r
+\r
   @retval Status     Value Status\r
 \r
 **/\r
@@ -110,20 +108,20 @@ UINT32
 (EFIAPI *VALIDATE_QUESTION) (\r
   IN FORM_DISPLAY_ENGINE_FORM      *Form,\r
   IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,\r
-  IN EFI_HII_VALUE                 *Value, \r
+  IN EFI_HII_VALUE                 *Value,\r
   OUT STATEMENT_ERROR_INFO         *ErrorInfo\r
   );\r
 \r
 /**\r
-  Perform Password check. \r
+  Perform Password check.\r
   Passwork may be encrypted by driver that requires the specific check.\r
-  \r
+\r
   @param  Form             Form where Password Statement is in.\r
   @param  Statement        Password statement\r
   @param  PasswordString   Password string to be checked. It may be NULL.\r
                            NULL means to restore password.\r
                            "" string can be used to checked whether old password does exist.\r
-  \r
+\r
   @return Status     Status of Password check.\r
 **/\r
 typedef\r
@@ -167,7 +165,7 @@ struct _FORM_DISPLAY_ENGINE_STATEMENT{
   EFI_HII_VALUE         CurrentValue;\r
   //\r
   // Flag to describe whether setting is changed or not.\r
-  // Displayer may depend on it to show it with the different color. \r
+  // Displayer may depend on it to show it with the different color.\r
   //\r
   BOOLEAN               SettingChangedFlag;\r
   //\r
@@ -188,7 +186,7 @@ struct _FORM_DISPLAY_ENGINE_STATEMENT{
   // It may be NULL if any value is valid.\r
   //\r
   VALIDATE_QUESTION     ValidateQuestion;\r
-  \r
+\r
   //\r
   // Password additional check. It may be NULL when the additional check is not required.\r
   //\r
@@ -208,7 +206,7 @@ struct _FORM_DISPLAY_ENGINE_STATEMENT{
 typedef struct {\r
   UINTN                 Signature;\r
   LIST_ENTRY            Link;\r
-  \r
+\r
   EFI_INPUT_KEY         *KeyData;\r
   //\r
   // Action is Discard, Default, Submit, Reset and Exit.\r
@@ -236,7 +234,7 @@ struct _FORM_DISPLAY_ENGINE_FORM {
   //\r
   LIST_ENTRY            StatementListHead;\r
   //\r
-  // Statement List outside of Form  \r
+  // Statement List outside of Form\r
   //\r
   LIST_ENTRY            StatementListOSF;\r
   //\r
@@ -251,7 +249,7 @@ struct _FORM_DISPLAY_ENGINE_FORM {
   // HiiHandle can be used to get String, Image or Animation\r
   //\r
   EFI_HII_HANDLE       HiiHandle;\r
-  \r
+\r
   //\r
   // Form ID and Title.\r
   //\r
@@ -285,13 +283,13 @@ struct _FORM_DISPLAY_ENGINE_FORM {
   //\r
   EFI_IMAGE_ID         ImageId;\r
   EFI_ANIMATION_ID     AnimationId;\r
-  \r
+\r
   //\r
-  // If Status is error, display needs to handle it.  \r
+  // If Status is error, display needs to handle it.\r
   //\r
   UINT32               BrowserStatus;\r
   //\r
-  // String for error status. It may be NULL. \r
+  // String for error status. It may be NULL.\r
   //\r
   EFI_STRING           ErrorString;\r
 };\r
@@ -300,9 +298,9 @@ struct _FORM_DISPLAY_ENGINE_FORM {
 \r
 typedef struct {\r
   FORM_DISPLAY_ENGINE_STATEMENT  *SelectedStatement; // Selected Statement and InputValue\r
-  \r
+\r
   EFI_HII_VALUE                  InputValue;\r
-  \r
+\r
   UINT32                         Action;             // If SelectedStatement is NULL, Action will be used.\r
                                                      // Trig Action (Discard, Default, Submit, Reset and Exit)\r
   UINT16                         DefaultId;\r
@@ -310,10 +308,10 @@ typedef struct {
 \r
 /**\r
   Display one form, and return user input.\r
-  \r
+\r
   @param FormData                Form Data to be shown.\r
   @param UserInputData           User input data.\r
-  \r
+\r
   @retval EFI_SUCCESS            Form Data is shown, and user input is got.\r
 **/\r
 typedef\r
@@ -334,8 +332,8 @@ VOID
 );\r
 \r
 /**\r
-  Confirm how to handle the changed data. \r
-  \r
+  Confirm how to handle the changed data.\r
+\r
   @return Action of Submit, Discard and None\r
 **/\r
 typedef\r