+/**\r
+ Detect media status for specified network device.\r
+\r
+ If MediaPresent is NULL, then ASSERT().\r
+\r
+ The underlying UNDI driver may or may not support reporting media status from\r
+ GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine\r
+ will try to invoke Snp->GetStatus() to get the media status: if media already\r
+ present, it return directly; if media not present, it will stop SNP and then\r
+ restart SNP to get the latest media status, this give chance to get the correct\r
+ media status for old UNDI driver which doesn't support reporting media status\r
+ from GET_STATUS command.\r
+ Note: there will be two limitations for current algorithm:\r
+ 1) for UNDI with this capability, in case of cable is not attached, there will\r
+ be an redundant Stop/Start() process;\r
+ 2) for UNDI without this capability, in case that network cable is attached when\r
+ Snp->Initialize() is invoked while network cable is unattached later,\r
+ NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer\r
+ apps to wait for timeout time.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] MediaPresent The pointer to store the media status.\r
+\r
+ @retval EFI_SUCCESS Media detection success.\r
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not valid network device handle.\r
+ @retval EFI_UNSUPPORTED Network device does not support media detection.\r
+ @retval EFI_DEVICE_ERROR SNP is in unknown state.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDetectMedia (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT BOOLEAN *MediaPresent\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE SnpHandle;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
+ UINT32 InterruptStatus;\r
+ UINT32 OldState;\r
+ EFI_MAC_ADDRESS *MCastFilter;\r
+ UINT32 MCastFilterCount;\r
+ UINT32 EnableFilterBits;\r
+ UINT32 DisableFilterBits;\r
+ BOOLEAN ResetMCastFilters;\r
+\r
+ ASSERT (MediaPresent != NULL);\r
+\r
+ //\r
+ // Get SNP handle\r
+ //\r
+ Snp = NULL;\r
+ SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp);\r
+ if (SnpHandle == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Check whether SNP support media detection\r
+ //\r
+ if (!Snp->Mode->MediaPresentSupported) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Invoke Snp->GetStatus() to refresh MediaPresent field in SNP mode data\r
+ //\r
+ Status = Snp->GetStatus (Snp, &InterruptStatus, NULL);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if (Snp->Mode->MediaPresent) {\r
+ //\r
+ // Media is present, return directly\r
+ //\r
+ *MediaPresent = TRUE;\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Till now, GetStatus() report no media; while, in case UNDI not support\r
+ // reporting media status from GetStatus(), this media status may be incorrect.\r
+ // So, we will stop SNP and then restart it to get the correct media status.\r
+ //\r
+ OldState = Snp->Mode->State;\r
+ if (OldState >= EfiSimpleNetworkMaxState) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ MCastFilter = NULL;\r
+\r
+ if (OldState == EfiSimpleNetworkInitialized) {\r
+ //\r
+ // SNP is already in use, need Shutdown/Stop and then Start/Initialize\r
+ //\r
+\r
+ //\r
+ // Backup current SNP receive filter settings\r
+ //\r
+ EnableFilterBits = Snp->Mode->ReceiveFilterSetting;\r
+ DisableFilterBits = Snp->Mode->ReceiveFilterMask ^ EnableFilterBits;\r
+\r
+ ResetMCastFilters = TRUE;\r
+ MCastFilterCount = Snp->Mode->MCastFilterCount;\r
+ if (MCastFilterCount != 0) {\r
+ MCastFilter = AllocateCopyPool (\r
+ MCastFilterCount * sizeof (EFI_MAC_ADDRESS),\r
+ Snp->Mode->MCastFilter\r
+ );\r
+ ASSERT (MCastFilter != NULL);\r
+ if (MCastFilter == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto Exit;\r
+ }\r
+\r
+ ResetMCastFilters = FALSE;\r
+ }\r
+\r
+ //\r
+ // Shutdown/Stop the simple network\r
+ //\r
+ Status = Snp->Shutdown (Snp);\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = Snp->Stop (Snp);\r
+ }\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // Start/Initialize the simple network\r
+ //\r
+ Status = Snp->Start (Snp);\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = Snp->Initialize (Snp, 0, 0);\r
+ }\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // Here we get the correct media status\r
+ //\r
+ *MediaPresent = Snp->Mode->MediaPresent;\r
+\r
+ //\r
+ // Restore SNP receive filter settings\r
+ //\r
+ Status = Snp->ReceiveFilters (\r
+ Snp,\r
+ EnableFilterBits,\r
+ DisableFilterBits,\r
+ ResetMCastFilters,\r
+ MCastFilterCount,\r
+ MCastFilter\r
+ );\r
+\r
+ if (MCastFilter != NULL) {\r
+ FreePool (MCastFilter);\r
+ }\r
+\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // SNP is not in use, it's in state of EfiSimpleNetworkStopped or EfiSimpleNetworkStarted\r
+ //\r
+ if (OldState == EfiSimpleNetworkStopped) {\r
+ //\r
+ // SNP not start yet, start it\r
+ //\r
+ Status = Snp->Start (Snp);\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Initialize the simple network\r
+ //\r
+ Status = Snp->Initialize (Snp, 0, 0);\r
+ if (EFI_ERROR (Status)) {\r
+ Status = EFI_DEVICE_ERROR;\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // Here we get the correct media status\r
+ //\r
+ *MediaPresent = Snp->Mode->MediaPresent;\r
+\r
+ //\r
+ // Shut down the simple network\r
+ //\r
+ Snp->Shutdown (Snp);\r
+\r
+Exit:\r
+ if (OldState == EfiSimpleNetworkStopped) {\r
+ //\r
+ // Original SNP sate is Stopped, restore to original state\r
+ //\r
+ Snp->Stop (Snp);\r
+ }\r
+\r
+ if (MCastFilter != NULL) {\r
+ FreePool (MCastFilter);\r
+ }\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+\r
+ Detect media state for a network device. This routine will wait for a period of time at\r
+ a specified checking interval when a certain network is under connecting until connection\r
+ process finishs or timeout. If Aip protocol is supported by low layer drivers, three kinds\r
+ of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents\r
+ connected state, connecting state and no media state respectively. When function detects\r
+ the current state is EFI_NOT_READY, it will loop to wait for next time's check until state\r
+ turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will\r
+ call NetLibDetectMedia() and return state directly.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[in] Timeout The maximum number of 100ns units to wait when network\r
+ is connecting. Zero value means detect once and return\r
+ immediately.\r
+ @param[out] MediaState The pointer to the detected media state.\r
+\r
+ @retval EFI_SUCCESS Media detection success.\r
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or\r
+ MediaState pointer is NULL.\r
+ @retval EFI_DEVICE_ERROR A device error occurred.\r
+ @retval EFI_TIMEOUT Network is connecting but timeout.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDetectMediaWaitTimeout (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ IN UINT64 Timeout,\r
+ OUT EFI_STATUS *MediaState\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE SnpHandle;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
+ EFI_ADAPTER_INFORMATION_PROTOCOL *Aip;\r
+ EFI_ADAPTER_INFO_MEDIA_STATE *MediaInfo;\r
+ BOOLEAN MediaPresent;\r
+ UINTN DataSize;\r
+ EFI_STATUS TimerStatus;\r
+ EFI_EVENT Timer;\r
+ UINT64 TimeRemained;\r
+\r
+ if (MediaState == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ *MediaState = EFI_SUCCESS;\r
+ MediaInfo = NULL;\r
+\r
+ //\r
+ // Get SNP handle\r
+ //\r
+ Snp = NULL;\r
+ SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp);\r
+ if (SnpHandle == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Status = gBS->HandleProtocol (\r
+ SnpHandle,\r
+ &gEfiAdapterInformationProtocolGuid,\r
+ (VOID *) &Aip\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+\r
+ MediaPresent = TRUE;\r
+ Status = NetLibDetectMedia (ServiceHandle, &MediaPresent);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (MediaPresent) {\r
+ *MediaState = EFI_SUCCESS;\r
+ } else {\r
+ *MediaState = EFI_NO_MEDIA;\r
+ }\r
+ }\r
+\r
+ //\r
+ // NetLibDetectMedia doesn't support EFI_NOT_READY status, return now!\r
+ //\r
+ return Status;\r
+ }\r
+\r
+ Status = Aip->GetInformation (\r
+ Aip,\r
+ &gEfiAdapterInfoMediaStateGuid,\r
+ (VOID **) &MediaInfo,\r
+ &DataSize\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+\r
+ *MediaState = MediaInfo->MediaState;\r
+ FreePool (MediaInfo);\r
+ if (*MediaState != EFI_NOT_READY || Timeout < MEDIA_STATE_DETECT_TIME_INTERVAL) {\r
+\r
+ return EFI_SUCCESS;\r
+ }\r
+ } else {\r
+\r
+ if (MediaInfo != NULL) {\r
+ FreePool (MediaInfo);\r
+ }\r
+\r
+ if (Status == EFI_UNSUPPORTED) {\r
+\r
+ //\r
+ // If gEfiAdapterInfoMediaStateGuid is not supported, call NetLibDetectMedia to get media state!\r
+ //\r
+ MediaPresent = TRUE;\r
+ Status = NetLibDetectMedia (ServiceHandle, &MediaPresent);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (MediaPresent) {\r
+ *MediaState = EFI_SUCCESS;\r
+ } else {\r
+ *MediaState = EFI_NO_MEDIA;\r
+ }\r
+ }\r
+ return Status;\r
+ }\r
+\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Loop to check media state\r
+ //\r
+\r
+ Timer = NULL;\r
+ TimeRemained = Timeout;\r
+ Status = gBS->CreateEvent (EVT_TIMER, TPL_CALLBACK, NULL, NULL, &Timer);\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ do {\r
+ Status = gBS->SetTimer (\r
+ Timer,\r
+ TimerRelative,\r
+ MEDIA_STATE_DETECT_TIME_INTERVAL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->CloseEvent(Timer);\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ do {\r
+ TimerStatus = gBS->CheckEvent (Timer);\r
+ if (!EFI_ERROR (TimerStatus)) {\r
+\r
+ TimeRemained -= MEDIA_STATE_DETECT_TIME_INTERVAL;\r
+ Status = Aip->GetInformation (\r
+ Aip,\r
+ &gEfiAdapterInfoMediaStateGuid,\r
+ (VOID **) &MediaInfo,\r
+ &DataSize\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+\r
+ *MediaState = MediaInfo->MediaState;\r
+ FreePool (MediaInfo);\r
+ } else {\r
+\r
+ if (MediaInfo != NULL) {\r
+ FreePool (MediaInfo);\r
+ }\r
+ gBS->CloseEvent(Timer);\r
+ return Status;\r
+ }\r
+ }\r
+ } while (TimerStatus == EFI_NOT_READY);\r
+ } while (*MediaState == EFI_NOT_READY && TimeRemained >= MEDIA_STATE_DETECT_TIME_INTERVAL);\r
+\r
+ gBS->CloseEvent(Timer);\r
+ if (*MediaState == EFI_NOT_READY && TimeRemained < MEDIA_STATE_DETECT_TIME_INTERVAL) {\r
+ return EFI_TIMEOUT;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r