Update for NetworkPkg.

Per UEFI spec, on CallBack action EFI_BROWSER_ACTION_CHANGING, the return value of ActionRequest will be ignored, but on CallBack action EFI_BROWSER_ACTION_CHANGED, the return value of ActionRequest will be used. 
But, EDKII browser still processes the got ActionRequest. And, all HII drivers in EDKII project also returns their expected ActionRequest value on action EFI_BROWSER_ACTION_CHANGING. 
Now update the browser to follow the spec, and update all core Hii drivers to keep old working modal.

Signed-off-by: ydong10
Reviewed-by: lgao4

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12867 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 138 insertions, 129 deletions

diff --git a/NetworkPkg/IScsiDxe/IScsiConfig.c b/NetworkPkg/IScsiDxe/IScsiConfig.c
index d347d8dc70..eea73a8ff1 100644
--- a/NetworkPkg/IScsiDxe/IScsiConfig.c
+++ b/NetworkPkg/IScsiDxe/IScsiConfig.c
@@ -1606,14 +1606,6 @@ IScsiConfigProcessDefault (
   UINTN                       Index;

 

   //

-  // Free any attempt that is previously created but not saved to system.

-  //

-  if (mPrivate->NewAttempt != NULL) {

-    FreePool (mPrivate->NewAttempt);

-    mPrivate->NewAttempt = NULL;

-  }

-

-  //

   // Is User creating a new attempt?

   //

   NewAttempt = FALSE;

@@ -1637,6 +1629,14 @@ IScsiConfigProcessDefault (
     //

     return EFI_SUCCESS;

   }

+  

+  //

+  // Free any attempt that is previously created but not saved to system.

+  //

+  if (mPrivate->NewAttempt != NULL) {

+    FreePool (mPrivate->NewAttempt);

+    mPrivate->NewAttempt = NULL;

+  }

 

   if (NewAttempt) {

     //

@@ -2103,37 +2103,75 @@ IScsiFormCallback (
     return EFI_SUCCESS;

   }

 

-  if (Action == EFI_BROWSER_ACTION_CHANGING) {

-    if (This == NULL || Value == NULL || ActionRequest == NULL) {

-      return EFI_INVALID_PARAMETER;

-    }

-

-    Private = ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This);

-

+  if ((Action != EFI_BROWSER_ACTION_CHANGING) && (Action != EFI_BROWSER_ACTION_CHANGED)) {

     //

-    // Retrieve uncommitted data from Browser

+    // All other type return unsupported.

     //

+    return EFI_UNSUPPORTED;

+  }

 

-    BufferSize = sizeof (ISCSI_CONFIG_IFR_NVDATA);

-    IfrNvData = AllocateZeroPool (BufferSize);

-    if (IfrNvData == NULL) {

-      return EFI_OUT_OF_RESOURCES;

-    }

-

-    IScsiName = (CHAR8 *) AllocateZeroPool (ISCSI_NAME_MAX_SIZE);

-    if (IScsiName == NULL) {

-      FreePool (IfrNvData);

-      return EFI_OUT_OF_RESOURCES;

-    }

-

-    Status = EFI_SUCCESS;

+  if ((Value == NULL) || (ActionRequest == NULL)) {

+    return EFI_INVALID_PARAMETER;

+  }

 

-    ZeroMem (&OldIfrNvData, BufferSize);

+  Private = ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This);

+  

+  //

+  // Retrieve uncommitted data from Browser

+  //

+  

+  BufferSize = sizeof (ISCSI_CONFIG_IFR_NVDATA);

+  IfrNvData = AllocateZeroPool (BufferSize);

+  if (IfrNvData == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+  

+  IScsiName = (CHAR8 *) AllocateZeroPool (ISCSI_NAME_MAX_SIZE);

+  if (IScsiName == NULL) {

+    FreePool (IfrNvData);

+    return EFI_OUT_OF_RESOURCES;

+  }

+  

+  Status = EFI_SUCCESS;

+  

+  ZeroMem (&OldIfrNvData, BufferSize);

+  

+  HiiGetBrowserData (NULL, NULL, BufferSize, (UINT8 *) IfrNvData);

+  

+  CopyMem (&OldIfrNvData, IfrNvData, BufferSize);

 

-    HiiGetBrowserData (NULL, NULL, BufferSize, (UINT8 *) IfrNvData);

+  if (Action == EFI_BROWSER_ACTION_CHANGING) {

+    switch (QuestionId) {

+    case KEY_ADD_ATTEMPT:

+      Status = IScsiConfigAddAttempt ();

+      break;

 

-    CopyMem (&OldIfrNvData, IfrNvData, BufferSize);

+    case KEY_DELETE_ATTEMPT:

+      CopyMem (

+        OldIfrNvData.DeleteAttemptList,

+        IfrNvData->DeleteAttemptList,

+        sizeof (IfrNvData->DeleteAttemptList)

+        );

+      Status = IScsiConfigDisplayDeleteAttempts (IfrNvData);

+      break;

 

+    case KEY_ORDER_ATTEMPT_CONFIG:

+      //

+      // Order the attempt according to user input.

+      //

+      CopyMem (

+        OldIfrNvData.DynamicOrderedList,

+        IfrNvData->DynamicOrderedList,

+        sizeof (IfrNvData->DynamicOrderedList)

+        );

+      IScsiConfigDisplayOrderAttempts ();

+      break;

+    

+    default:

+      Status = IScsiConfigProcessDefault (QuestionId, IfrNvData);

+      break;

+    }

+  } else if (Action == EFI_BROWSER_ACTION_CHANGED) {  

     switch (QuestionId) {

     case KEY_INITIATOR_NAME:

       UnicodeStrToAsciiStr (IfrNvData->InitiatorName, IScsiName);

@@ -2151,54 +2189,34 @@ IScsiFormCallback (
 

       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;

       break;

+    case KEY_ATTEMPT_NAME:

+      if (StrLen (IfrNvData->AttemptName) > ATTEMPT_NAME_SIZE) {

+        CopyMem (AttemptName, IfrNvData->AttemptName, ATTEMPT_NAME_SIZE * sizeof (CHAR16));

+        CopyMem (&AttemptName[ATTEMPT_NAME_SIZE], L"...", 4 * sizeof (CHAR16));

+      } else {

+        CopyMem (

+          AttemptName,

+          IfrNvData->AttemptName,

+          (StrLen (IfrNvData->AttemptName) + 1) * sizeof (CHAR16)

+          );

+      }

 

-    case KEY_ADD_ATTEMPT:

-      Status = IScsiConfigAddAttempt ();

-      break;

+      UnicodeStrToAsciiStr (IfrNvData->AttemptName, Private->Current->AttemptName);

 

-    case KEY_DELETE_ATTEMPT:

-      CopyMem (

-        OldIfrNvData.DeleteAttemptList,

-        IfrNvData->DeleteAttemptList,

-        sizeof (IfrNvData->DeleteAttemptList)

-        );

-      Status = IScsiConfigDisplayDeleteAttempts (IfrNvData);

-      break;

+      IScsiConfigUpdateAttempt ();

 

-    case KEY_SAVE_DELETE_ATTEMPT:

-      //

-      // Delete the Attempt Order from NVR

-      //

-      Status = IScsiConfigDeleteAttempts (IfrNvData);

+      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;

+      break;

+      

+    case KEY_SAVE_ATTEMPT_CONFIG:

+      Status = IScsiConvertIfrNvDataToAttemptConfigData (IfrNvData, Private->Current);

       if (EFI_ERROR (Status)) {

         break;

       }

 

-      IScsiConfigUpdateAttempt ();

       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;

       break;

 

-    case KEY_IGNORE_DELETE_ATTEMPT:

-      CopyMem (

-        IfrNvData->DeleteAttemptList,

-        OldIfrNvData.DeleteAttemptList,

-        sizeof (IfrNvData->DeleteAttemptList)

-        );

-      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD;

-      break;

-

-    case KEY_ORDER_ATTEMPT_CONFIG:

-      //

-      // Order the attempt according to user input.

-      //

-      CopyMem (

-        OldIfrNvData.DynamicOrderedList,

-        IfrNvData->DynamicOrderedList,

-        sizeof (IfrNvData->DynamicOrderedList)

-        );

-      IScsiConfigDisplayOrderAttempts ();

-      break;

-

     case KEY_SAVE_ORDER_CHANGES:

       //

       // Sync the Attempt Order to NVR.

@@ -2209,7 +2227,7 @@ IScsiFormCallback (
       }

 

       IScsiConfigUpdateAttempt ();

-      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;

+      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;

       break;

 

     case KEY_IGNORE_ORDER_CHANGES:

@@ -2218,26 +2236,29 @@ IScsiFormCallback (
         OldIfrNvData.DynamicOrderedList,

         sizeof (IfrNvData->DynamicOrderedList)

         );

-      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD;

+      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;

       break;

 

-    case KEY_ATTEMPT_NAME:

-      if (StrLen (IfrNvData->AttemptName) > ATTEMPT_NAME_SIZE) {

-        CopyMem (AttemptName, IfrNvData->AttemptName, ATTEMPT_NAME_SIZE * sizeof (CHAR16));

-        CopyMem (&AttemptName[ATTEMPT_NAME_SIZE], L"...", 4 * sizeof (CHAR16));

-      } else {

-        CopyMem (

-          AttemptName,

-          IfrNvData->AttemptName,

-          (StrLen (IfrNvData->AttemptName) + 1) * sizeof (CHAR16)

-          );

+    case KEY_SAVE_DELETE_ATTEMPT:

+      //

+      // Delete the Attempt Order from NVR

+      //

+      Status = IScsiConfigDeleteAttempts (IfrNvData);

+      if (EFI_ERROR (Status)) {

+        break;

       }

 

-      UnicodeStrToAsciiStr (IfrNvData->AttemptName, Private->Current->AttemptName);

-

       IScsiConfigUpdateAttempt ();

+      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;

+      break;

 

-      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;

+    case KEY_IGNORE_DELETE_ATTEMPT:

+      CopyMem (

+        IfrNvData->DeleteAttemptList,

+        OldIfrNvData.DeleteAttemptList,

+        sizeof (IfrNvData->DeleteAttemptList)

+        );

+      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;

       break;

 

     case KEY_IP_MODE:

@@ -2409,38 +2430,23 @@ IScsiFormCallback (
 

       break;

 

-    case KEY_SAVE_ATTEMPT_CONFIG:

-      Status = IScsiConvertIfrNvDataToAttemptConfigData (IfrNvData, Private->Current);

-      if (EFI_ERROR (Status)) {

-        break;

-      }

-

-      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;

-      break;

-

     default:

-      Status = IScsiConfigProcessDefault (QuestionId, IfrNvData);

       break;

     }

+  }

 

-    if (!EFI_ERROR (Status)) {

-      //

-      // Pass changed uncommitted data back to Form Browser.

-      //

-      BufferSize = sizeof (ISCSI_CONFIG_IFR_NVDATA);

-      HiiSetBrowserData (NULL, NULL, BufferSize, (UINT8 *) IfrNvData, NULL);

-    }

-

-    FreePool (IfrNvData);

-    FreePool (IScsiName);

-

-    return Status;

+  if (!EFI_ERROR (Status)) {

+    //

+    // Pass changed uncommitted data back to Form Browser.

+    //

+    BufferSize = sizeof (ISCSI_CONFIG_IFR_NVDATA);

+    HiiSetBrowserData (NULL, NULL, BufferSize, (UINT8 *) IfrNvData, NULL);

   }

 

-  //

-  // All other action return unsupported.

-  //

-  return EFI_UNSUPPORTED;

+  FreePool (IfrNvData);

+  FreePool (IScsiName);

+

+  return Status;

 }

 

 

diff --git a/NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr b/NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr
index 0cf4ffeed9..4a322cfd69 100644
--- a/NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr
+++ b/NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr
@@ -85,18 +85,19 @@ formset
     label ORDER_ENTRY_LABEL;

     label LABEL_END;

 

-    goto FORMID_MAIN_FORM,

-      prompt = STRING_TOKEN (STR_SAVE_AND_EXIT),

+    text

       help   = STRING_TOKEN (STR_SAVE_AND_EXIT),

+      text   = STRING_TOKEN (STR_SAVE_AND_EXIT),

+        text   = STRING_TOKEN (STR_SAVE_AND_EXIT),

       flags  = INTERACTIVE,

       key    = KEY_SAVE_ORDER_CHANGES;

-      

-    goto FORMID_MAIN_FORM,

-      prompt = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

+

+    text

       help   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

+      text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

+        text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

       flags  = INTERACTIVE,

       key    = KEY_IGNORE_ORDER_CHANGES;

-

   endform;

 

   form formid = FORMID_DELETE_FORM,

@@ -105,18 +106,19 @@ formset
     label DELETE_ENTRY_LABEL;

     label LABEL_END;

 

-    goto FORMID_MAIN_FORM,

-      prompt = STRING_TOKEN (STR_SAVE_AND_EXIT),

+    text

       help   = STRING_TOKEN (STR_SAVE_AND_EXIT),

+      text   = STRING_TOKEN (STR_SAVE_AND_EXIT),

+        text   = STRING_TOKEN (STR_SAVE_AND_EXIT),

       flags  = INTERACTIVE,

       key    = KEY_SAVE_DELETE_ATTEMPT;

-      

-    goto FORMID_MAIN_FORM,

-      prompt = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

+

+    text

       help   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

+      text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

+        text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),

       flags  = INTERACTIVE,

       key    = KEY_IGNORE_DELETE_ATTEMPT;

-      

   endform;    

 

   form formid = FORMID_ATTEMPT_FORM,

@@ -348,12 +350,13 @@ formset
 

     subtitle text = STRING_TOKEN(STR_NULL);

 

-    goto FORMID_ATTEMPT_FORM,

-    prompt = STRING_TOKEN (STR_SAVE_CHANGES),

-    help   = STRING_TOKEN (STR_SAVE_CHANGES_HELP),

-    flags  = INTERACTIVE,

-    key    = KEY_SAVE_ATTEMPT_CONFIG;

-

+    text

+      help   = STRING_TOKEN (STR_SAVE_CHANGES_HELP),

+      text   = STRING_TOKEN (STR_SAVE_CHANGES),

+        text   = STRING_TOKEN (STR_SAVE_CHANGES),

+      flags  = INTERACTIVE,

+      key    = KEY_SAVE_ATTEMPT_CONFIG;

+      

     goto FORMID_MAIN_FORM,

     prompt = STRING_TOKEN (STR_RETURN_MAIN_FORM),

     help   = STRING_TOKEN (STR_RETURN_MAIN_FORM),