MdeModulePkg: Fix SNP.Initialize() spec conformance issue

v2:
*Refine the coding style according edk2 community's feedback.

Current SNP UNDI Initialize command does not follow the UEFI Spec
to update the SNP MediaPresent field. The result for the Initialize
command execution check should be:
StatFlags: (1) Monitor the upper two bits (14 & 15) in the field to know
whether the command has been executed by the UNDI (Not started, Queued,
Error, Complete). (2) Check the other field to see if there is an active
connection to this network device (used to update MediaPresent).
StatCode: After command execution completes, either successfully or not,
this field contains the result of the command execution (success or failure).
This patch is used to fix it.

NOTE: If any UNDI driver does not follow the UEFI Spec for the media status
update, it may meet failure with this more conditions check (StatFlags).

Cc: Ye Ting <ting.ye@intel.com>
Cc: Fu Siyuan <siyuan.fu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu <jiaxin.wu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>

diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c b/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c
index 21513752de05645b874fae98211abe2c78987c81..63bdf92f5593a008d292755b2045a63bb130bf00 100644 (file)
--- a/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c
+++ b/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c
@@ -1,7 +1,7 @@
 /** @file\r
                Implementation of initializing a network adapter.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed \r
 and made available under the terms and conditions of the BSD License which \r
 accompanies this distribution. The full text of the license may be found at \r
@@ -37,6 +37,8 @@ PxeInit (
   VOID                *Addr;\r
   EFI_STATUS          Status;\r
 \r
+  Status = EFI_SUCCESS;\r
+\r
   Cpb = Snp->Cpb;\r
   if (Snp->TxRxBufferSize != 0) {\r
     Status = Snp->PciIo->AllocateBuffer (\r
@@ -99,10 +101,30 @@ PxeInit (
 \r
   (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);\r
 \r
-  if (Snp->Cdb.StatCode == PXE_STATCODE_SUCCESS) {\r
-    Snp->Mode.State = EfiSimpleNetworkInitialized;\r
-\r
-    Status          = EFI_SUCCESS;\r
+  //\r
+  // There are two fields need to be checked here:\r
+  // First is the upper two bits (14 & 15) in the CDB.StatFlags field. Until these bits change to report \r
+  // PXE_STATFLAGS_COMMAND_COMPLETE or PXE_STATFLAGS_COMMAND_FAILED, the command has not been executed by the UNDI.\r
+  // Second is the CDB.StatCode field. After command execution completes, either successfully or not, \r
+  // the CDB.StatCode field contains the result of the command execution.\r
+  //\r
+  if ((((Snp->Cdb.StatFlags) & PXE_STATFLAGS_STATUS_MASK) == PXE_STATFLAGS_COMMAND_COMPLETE) &&\r
+      (Snp->Cdb.StatCode == PXE_STATCODE_SUCCESS)) {\r
+    //\r
+    // If cable detect feature is enabled in CDB.OpFlags, check the CDB.StatFlags to see if there is an \r
+    // active connection to this network device. If the no media StatFlag is set, the UNDI and network \r
+    // device are still initialized.    \r
+    //\r
+    if (CableDetectFlag == PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) {\r
+      if(((Snp->Cdb.StatFlags) & PXE_STATFLAGS_INITIALIZED_NO_MEDIA) != PXE_STATFLAGS_INITIALIZED_NO_MEDIA) {\r
+        Snp->Mode.MediaPresent = TRUE;\r
+      } else {\r
+        Snp->Mode.MediaPresent = FALSE;\r
+      }\r
+    }\r
+    \r
+    Snp->Mode.State   = EfiSimpleNetworkInitialized;\r
+    Status            = EFI_SUCCESS;\r
   } else {\r
     DEBUG (\r
       (EFI_D_WARN,\r
@@ -234,7 +256,6 @@ SnpUndi32Initialize (
   //\r
   if (Snp->CableDetectSupported) {\r
     if (PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) == EFI_SUCCESS) {\r
-      Snp->Mode.MediaPresent = TRUE;\r
       goto ON_EXIT;\r
     }\r
   }\r