/** @file\r
Network library.\r
\r
-Copyright (c) 2005 - 2009, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2010, 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
http://opensource.org/licenses/bsd-license.php\r
"Dec"\r
};\r
\r
+//\r
+// VLAN device path node template\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate = {\r
+ {\r
+ MESSAGING_DEVICE_PATH,\r
+ MSG_VLAN_DP,\r
+ {\r
+ (UINT8) (sizeof (VLAN_DEVICE_PATH)),\r
+ (UINT8) ((sizeof (VLAN_DEVICE_PATH)) >> 8)\r
+ }\r
+ },\r
+ 0\r
+};\r
+\r
/**\r
Locate the handles that support SNP, then open one of them\r
to send the syslog packets. The caller isn't required to close\r
//\r
Pri = ((NET_SYSLOG_FACILITY & 31) << 3) | (Level & 7);\r
gRT->GetTime (&Time, NULL);\r
+ ASSERT ((Time.Month <= 12) && (Time.Month >= 1));\r
\r
//\r
// Use %a to format the ASCII strings, %s to format UNICODE strings\r
\r
**/\r
CHAR8 *\r
+EFIAPI\r
NetDebugASPrint (\r
IN CHAR8 *Format,\r
...\r
than the mNetDebugLevelMax. Or, it has been sent out.\r
**/\r
EFI_STATUS\r
+EFIAPI\r
NetDebugOutput (\r
IN UINT32 Level,\r
IN UINT8 *Module,\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsValidUnicast (\r
IN EFI_IPv6_ADDRESS *Ip6\r
)\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsUnspecifiedAddr (\r
IN EFI_IPv6_ADDRESS *Ip6\r
)\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsLinkLocalAddr (\r
IN EFI_IPv6_ADDRESS *Ip6\r
)\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsNetEqual (\r
EFI_IPv6_ADDRESS *Ip1,\r
EFI_IPv6_ADDRESS *Ip2,\r
UINT8 Bit;\r
UINT8 Mask;\r
\r
- ASSERT (Ip1 != NULL && Ip2 != NULL);\r
+ ASSERT ((Ip1 != NULL) && (Ip2 != NULL) && (PrefixLength < IP6_PREFIX_NUM));\r
\r
if (PrefixLength == 0) {\r
return TRUE;\r
if (Bit > 0) {\r
Mask = (UINT8) (0xFF << (8 - Bit));\r
\r
+ ASSERT (Byte < 16);\r
if ((Ip1->Addr[Byte] & Mask) != (Ip2->Addr[Byte] & Mask)) {\r
return FALSE;\r
}\r
\r
**/\r
EFI_IPv6_ADDRESS *\r
+EFIAPI\r
Ip6Swap128 (\r
EFI_IPv6_ADDRESS *Ip6\r
)\r
byte stream.\r
\r
@param[in, out] Buf The buffer to put the UINT32.\r
- @param[in] Data The data to put.\r
+ @param[in] Data The data to be converted and put into the byte stream.\r
\r
**/\r
VOID\r
NetMapIterate (\r
IN NET_MAP *Map,\r
IN NET_MAP_CALLBACK CallBack,\r
- IN VOID *Arg\r
+ IN VOID *Arg OPTIONAL\r
)\r
{\r
\r
return Status;\r
}\r
\r
+/**\r
+ Get handle with Simple Network Protocol installed on it.\r
+\r
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
+ If Simple Network Protocol is already installed on the ServiceHandle, the\r
+ ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,\r
+ try to find its parent handle with SNP installed.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] Snp The pointer to store the address of the SNP instance.\r
+ This is an optional parameter that may be NULL.\r
+\r
+ @return The SNP handle, or NULL if not found.\r
+\r
+**/\r
+EFI_HANDLE\r
+EFIAPI\r
+NetLibGetSnpHandle (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *SnpInstance;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_HANDLE SnpHandle;\r
+\r
+ //\r
+ // Try to open SNP from ServiceHandle\r
+ //\r
+ SnpInstance = NULL;\r
+ Status = gBS->HandleProtocol (ServiceHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (Snp != NULL) {\r
+ *Snp = SnpInstance;\r
+ }\r
+ return ServiceHandle;\r
+ }\r
+\r
+ //\r
+ // Failed to open SNP, try to get SNP handle by LocateDevicePath()\r
+ //\r
+ DevicePath = DevicePathFromHandle (ServiceHandle);\r
+ if (DevicePath == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ SnpHandle = NULL;\r
+ Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &DevicePath, &SnpHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Failed to find SNP handle\r
+ //\r
+ return NULL;\r
+ }\r
+\r
+ Status = gBS->HandleProtocol (SnpHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (Snp != NULL) {\r
+ *Snp = SnpInstance;\r
+ }\r
+ return SnpHandle;\r
+ }\r
+\r
+ return NULL;\r
+}\r
\r
/**\r
- Convert the mac address of the simple network protocol installed on\r
- SnpHandle to a unicode string. Callers are responsible for freeing the\r
- string storage.\r
+ Retrieve VLAN ID of a VLAN device handle.\r
+\r
+ Search VLAN device path node in Device Path of specified ServiceHandle and\r
+ return its VLAN ID. If no VLAN device path node found, then this ServiceHandle\r
+ is not a VLAN device handle, and 0 will be returned.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+\r
+ @return VLAN ID of the device handle, or 0 if not a VLAN device.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+NetLibGetVlanId (\r
+ IN EFI_HANDLE ServiceHandle\r
+ )\r
+{\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *Node;\r
+\r
+ DevicePath = DevicePathFromHandle (ServiceHandle);\r
+ if (DevicePath == NULL) {\r
+ return 0;\r
+ }\r
+\r
+ Node = DevicePath;\r
+ while (!IsDevicePathEnd (Node)) {\r
+ if (Node->Type == MESSAGING_DEVICE_PATH && Node->SubType == MSG_VLAN_DP) {\r
+ return ((VLAN_DEVICE_PATH *) Node)->VlanId;\r
+ }\r
+ Node = NextDevicePathNode (Node);\r
+ }\r
+\r
+ return 0;\r
+}\r
+\r
+/**\r
+ Find VLAN device handle with specified VLAN ID.\r
+\r
+ The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.\r
+ This function will append VLAN device path node to the parent device path,\r
+ and then use LocateDevicePath() to find the correct VLAN device handle.\r
+\r
+ @param[in] ControllerHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[in] VlanId The configured VLAN ID for the VLAN device.\r
+\r
+ @return The VLAN device handle, or NULL if not found.\r
+\r
+**/\r
+EFI_HANDLE\r
+EFIAPI\r
+NetLibGetVlanHandle (\r
+ IN EFI_HANDLE ControllerHandle,\r
+ IN UINT16 VlanId\r
+ )\r
+{\r
+ EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *VlanDevicePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ VLAN_DEVICE_PATH VlanNode;\r
+ EFI_HANDLE Handle;\r
+\r
+ ParentDevicePath = DevicePathFromHandle (ControllerHandle);\r
+ if (ParentDevicePath == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ //\r
+ // Construct VLAN device path\r
+ //\r
+ CopyMem (&VlanNode, &mNetVlanDevicePathTemplate, sizeof (VLAN_DEVICE_PATH));\r
+ VlanNode.VlanId = VlanId;\r
+ VlanDevicePath = AppendDevicePathNode (\r
+ ParentDevicePath,\r
+ (EFI_DEVICE_PATH_PROTOCOL *) &VlanNode\r
+ );\r
+ if (VlanDevicePath == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ //\r
+ // Find VLAN device handle\r
+ //\r
+ Handle = NULL;\r
+ DevicePath = VlanDevicePath;\r
+ gBS->LocateDevicePath (\r
+ &gEfiDevicePathProtocolGuid,\r
+ &DevicePath,\r
+ &Handle\r
+ );\r
+ if (!IsDevicePathEnd (DevicePath)) {\r
+ //\r
+ // Device path is not exactly match\r
+ //\r
+ Handle = NULL;\r
+ }\r
+\r
+ FreePool (VlanDevicePath);\r
+ return Handle;\r
+}\r
+\r
+/**\r
+ Get MAC address associated with the network service handle.\r
+\r
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
+ If SNP is installed on the ServiceHandle or its parent handle, MAC address will\r
+ be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] MacAddress The pointer to store the returned MAC address.\r
+ @param[out] AddressSize The length of returned MAC address.\r
+\r
+ @retval EFI_SUCCESS MAC address is returned successfully.\r
+ @retval Others Failed to get SNP mode data.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibGetMacAddress (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT EFI_MAC_ADDRESS *MacAddress,\r
+ OUT UINTN *AddressSize\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
+ EFI_SIMPLE_NETWORK_MODE *SnpMode;\r
+ EFI_SIMPLE_NETWORK_MODE SnpModeData;\r
+ EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
+ EFI_SERVICE_BINDING_PROTOCOL *MnpSb;\r
+ EFI_HANDLE *SnpHandle;\r
+ EFI_HANDLE MnpChildHandle;\r
+\r
+ ASSERT (MacAddress != NULL);\r
+ ASSERT (AddressSize != NULL);\r
+\r
+ //\r
+ // Try to get SNP handle\r
+ //\r
+ Snp = NULL;\r
+ SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp);\r
+ if (SnpHandle != NULL) {\r
+ //\r
+ // SNP found, use it directly\r
+ //\r
+ SnpMode = Snp->Mode;\r
+ } else {\r
+ //\r
+ // Failed to get SNP handle, try to get MAC address from MNP\r
+ //\r
+ MnpChildHandle = NULL;\r
+ Status = gBS->HandleProtocol (\r
+ ServiceHandle,\r
+ &gEfiManagedNetworkServiceBindingProtocolGuid,\r
+ (VOID **) &MnpSb\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Create a MNP child\r
+ //\r
+ Status = MnpSb->CreateChild (MnpSb, &MnpChildHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Open MNP protocol\r
+ //\r
+ Status = gBS->HandleProtocol (\r
+ MnpChildHandle,\r
+ &gEfiManagedNetworkProtocolGuid,\r
+ (VOID **) &Mnp\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Try to get SNP mode from MNP\r
+ //\r
+ Status = Mnp->GetModeData (Mnp, NULL, &SnpModeData);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ SnpMode = &SnpModeData;\r
+\r
+ //\r
+ // Destroy the MNP child\r
+ //\r
+ MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
+ }\r
\r
- Get the mac address of the Simple Network protocol from the SnpHandle. Then convert\r
- the mac address into a unicode string. It takes 2 unicode characters to represent \r
- a 1 byte binary buffer. Plus one unicode character for the null-terminator.\r
+ *AddressSize = SnpMode->HwAddressSize;\r
+ CopyMem (MacAddress->Addr, SnpMode->CurrentAddress.Addr, SnpMode->HwAddressSize);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Convert MAC address of the NIC associated with specified Service Binding Handle\r
+ to a unicode string. Callers are responsible for freeing the string storage.\r
\r
+ Locate simple network protocol associated with the Service Binding Handle and\r
+ get the mac address from SNP. Then convert the mac address into a unicode\r
+ string. It takes 2 unicode characters to represent a 1 byte binary buffer.\r
+ Plus one unicode character for the null-terminator.\r
\r
- @param[in] SnpHandle The handle where the simple network protocol is\r
+ @param[in] ServiceHandle The handle where network service binding protocol is\r
installed on.\r
@param[in] ImageHandle The image handle used to act as the agent handle to\r
get the simple network protocol.\r
EFI_STATUS\r
EFIAPI\r
NetLibGetMacString (\r
- IN EFI_HANDLE SnpHandle,\r
+ IN EFI_HANDLE ServiceHandle,\r
IN EFI_HANDLE ImageHandle,\r
OUT CHAR16 **MacString\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
- EFI_SIMPLE_NETWORK_MODE *Mode;\r
- CHAR16 *MacAddress;\r
+ EFI_MAC_ADDRESS MacAddress;\r
UINT8 *HwAddress;\r
+ UINTN HwAddressSize;\r
+ UINT16 VlanId;\r
+ CHAR16 *String;\r
UINTN Index;\r
\r
- *MacString = NULL;\r
+ ASSERT (MacString != NULL);\r
\r
//\r
- // Get the Simple Network protocol from the SnpHandle.\r
+ // Get MAC address of the network device\r
//\r
- Status = gBS->OpenProtocol (\r
- SnpHandle,\r
- &gEfiSimpleNetworkProtocolGuid,\r
- (VOID **) &Snp,\r
- ImageHandle,\r
- SnpHandle,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
+ Status = NetLibGetMacAddress (ServiceHandle, &MacAddress, &HwAddressSize);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
- Mode = Snp->Mode;\r
-\r
//\r
// It takes 2 unicode characters to represent a 1 byte binary buffer.\r
+ // If VLAN is configured, it will need extra 5 characters like "\0005".\r
// Plus one unicode character for the null-terminator.\r
//\r
- MacAddress = AllocatePool ((2 * Mode->HwAddressSize + 1) * sizeof (CHAR16));\r
- if (MacAddress == NULL) {\r
+ String = AllocateZeroPool ((2 * HwAddressSize + 5 + 1) * sizeof (CHAR16));\r
+ if (String == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
- *MacString = MacAddress;\r
+ *MacString = String;\r
\r
//\r
- // Convert the mac address into a unicode string.\r
+ // Convert the MAC address into a unicode string.\r
//\r
- HwAddress = Mode->CurrentAddress.Addr;\r
- for (Index = 0; Index < Mode->HwAddressSize; Index++) {\r
- MacAddress += UnicodeValueToString (MacAddress, PREFIX_ZERO | RADIX_HEX, *(HwAddress++), 2);\r
+ HwAddress = &MacAddress.Addr[0];\r
+ for (Index = 0; Index < HwAddressSize; Index++) {\r
+ String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(HwAddress++), 2);\r
}\r
\r
- MacAddress[Mode->HwAddressSize * 2] = L'\0';\r
+ //\r
+ // Append VLAN ID if any\r
+ //\r
+ VlanId = NetLibGetVlanId (ServiceHandle);\r
+ if (VlanId != 0) {\r
+ *String++ = L'\\';\r
+ String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, VlanId, 4);\r
+ }\r
\r
+ //\r
+ // Null terminate the Unicode string\r
+ //\r
+ *String = L'\0';\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Detect media status for specified network device.\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
+\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
Check the default address used by the IPv4 driver is static or dynamic (acquired\r
from DHCP).\r
IsStatic = TRUE;\r
\r
Status = gBS->LocateProtocol (\r
- &gEfiHiiConfigRoutingProtocolGuid,\r
- NULL,\r
- (VOID **) &HiiConfigRouting\r
- );\r
+ &gEfiHiiConfigRoutingProtocolGuid,\r
+ NULL,\r
+ (VOID **) &HiiConfigRouting\r
+ );\r
if (EFI_ERROR (Status)) {\r
return TRUE;\r
}\r
Handle = NULL;\r
\r
for (Index = 0; Index < OpenCount; Index++) {\r
- if (OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
+ if ((OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
Handle = OpenBuffer[Index].ControllerHandle;\r
break;\r
}\r
gBS->FreePool (OpenBuffer);\r
return Handle;\r
}\r
+\r
+/**\r
+ Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip4Address The pointer to the converted IPv4 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv4 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibAsciiStrToIp4 (\r
+ IN CONST CHAR8 *String,\r
+ OUT EFI_IPv4_ADDRESS *Ip4Address\r
+ )\r
+{\r
+ UINT8 Index;\r
+ CHAR8 *Ip4Str;\r
+ CHAR8 *TempStr;\r
+ UINTN NodeVal;\r
+\r
+ if ((String == NULL) || (Ip4Address == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip4Str = (CHAR8 *) String;\r
+\r
+ for (Index = 0; Index < 4; Index++) {\r
+ TempStr = Ip4Str;\r
+\r
+ while ((*Ip4Str != '\0') && (*Ip4Str != '.')) {\r
+ Ip4Str++;\r
+ }\r
+\r
+ //\r
+ // The IPv4 address is X.X.X.X\r
+ //\r
+ if (*Ip4Str == '.') {\r
+ if (Index == 3) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ } else {\r
+ if (Index != 3) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Convert the string to IPv4 address. AsciiStrDecimalToUintn stops at the\r
+ // first character that is not a valid decimal character, '.' or '\0' here.\r
+ //\r
+ NodeVal = AsciiStrDecimalToUintn (TempStr);\r
+ if (NodeVal > 0xFF) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip4Address->Addr[Index] = (UINT8) NodeVal;\r
+\r
+ Ip4Str++;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the\r
+ string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibAsciiStrToIp6 (\r
+ IN CONST CHAR8 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address\r
+ )\r
+{\r
+ UINT8 Index;\r
+ CHAR8 *Ip6Str;\r
+ CHAR8 *TempStr;\r
+ CHAR8 *TempStr2;\r
+ UINT8 NodeCnt;\r
+ UINT8 TailNodeCnt;\r
+ UINT8 AllowedCnt;\r
+ UINTN NodeVal;\r
+ BOOLEAN Short;\r
+ BOOLEAN Update;\r
+\r
+ if ((String == NULL) || (Ip6Address == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip6Str = (CHAR8 *) String;\r
+ AllowedCnt = 6;\r
+\r
+ //\r
+ // An IPv6 address leading with : looks strange.\r
+ //\r
+ if (*Ip6Str == ':') {\r
+ if (*(Ip6Str + 1) != ':') {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ AllowedCnt = 7;\r
+ }\r
+ }\r
+\r
+ ZeroMem (Ip6Address, sizeof (EFI_IPv6_ADDRESS));\r
+\r
+ NodeCnt = 0;\r
+ TailNodeCnt = 0;\r
+ Short = FALSE;\r
+ Update = FALSE;\r
+\r
+ for (Index = 0; Index < 15; Index = (UINT8) (Index + 2)) {\r
+ TempStr = Ip6Str;\r
+\r
+ while ((*Ip6Str != '\0') && (*Ip6Str != ':')) {\r
+ Ip6Str++;\r
+ }\r
+\r
+ if ((*Ip6Str == '\0') && (Index != 14)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if (*Ip6Str == ':') {\r
+ if (*(Ip6Str + 1) == ':') {\r
+ if ((*(Ip6Str + 2) == '0') || (NodeCnt > 6)) {\r
+ //\r
+ // ::0 looks strange. report error to user.\r
+ //\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Skip the abbreviation part of IPv6 address.\r
+ //\r
+ TempStr2 = Ip6Str + 2;\r
+ while ((*TempStr2 != '\0')) {\r
+ if (*TempStr2 == ':') {\r
+ if (*(TempStr2 + 1) == ':') {\r
+ //\r
+ // :: can only appear once in IPv6 address.\r
+ //\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ TailNodeCnt++;\r
+ if (TailNodeCnt >= (AllowedCnt - NodeCnt)) {\r
+ //\r
+ // :: indicates one or more groups of 16 bits of zeros.\r
+ //\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+\r
+ TempStr2++;\r
+ }\r
+\r
+ Short = TRUE;\r
+ Update = TRUE;\r
+\r
+ Ip6Str = Ip6Str + 2;\r
+ } else {\r
+ Ip6Str++;\r
+ NodeCnt++;\r
+ if ((Short && (NodeCnt > 6)) || (!Short && (NodeCnt > 7))) {\r
+ //\r
+ // There are more than 8 groups of 16 bits of zeros.\r
+ //\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Convert the string to IPv6 address. AsciiStrHexToUintn stops at the first\r
+ // character that is not a valid hexadecimal character, ':' or '\0' here.\r
+ //\r
+ NodeVal = AsciiStrHexToUintn (TempStr);\r
+ if ((NodeVal > 0xFFFF) || (Index > 14)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip6Address->Addr[Index] = (UINT8) (NodeVal >> 8);\r
+ Ip6Address->Addr[Index + 1] = (UINT8) (NodeVal & 0xFF);\r
+\r
+ //\r
+ // Skip the groups of zeros by ::\r
+ //\r
+ if (Short && Update) {\r
+ Index = (UINT8) (16 - (TailNodeCnt + 2) * 2);\r
+ Update = FALSE;\r
+ }\r
+ }\r
+\r
+ if ((!Short && Index != 16) || (*Ip6Str != '\0')) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip4Address The pointer to the converted IPv4 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv4 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp4 (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv4_ADDRESS *Ip4Address\r
+ )\r
+{\r
+ CHAR8 *Ip4Str;\r
+ EFI_STATUS Status;\r
+\r
+ if ((String == NULL) || (Ip4Address == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip4Str = (CHAR8 *) AllocatePool ((StrLen (String) + 1) * sizeof (CHAR8));\r
+ if (Ip4Str == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ UnicodeStrToAsciiStr (String, Ip4Str);\r
+\r
+ Status = NetLibAsciiStrToIp4 (Ip4Str, Ip4Address);\r
+\r
+ FreePool (Ip4Str);\r
+\r
+ return Status;\r
+}\r
+\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of\r
+ the string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp6 (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address\r
+ )\r
+{\r
+ CHAR8 *Ip6Str;\r
+ EFI_STATUS Status;\r
+\r
+ if ((String == NULL) || (Ip6Address == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip6Str = (CHAR8 *) AllocatePool ((StrLen (String) + 1) * sizeof (CHAR8));\r
+ if (Ip6Str == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ UnicodeStrToAsciiStr (String, Ip6Str);\r
+\r
+ Status = NetLibAsciiStrToIp6 (Ip6Str, Ip6Address);\r
+\r
+ FreePool (Ip6Str);\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.\r
+ The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses\r
+ Prefixes: ipv6-address/prefix-length.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+ @param[out] PrefixLength The pointer to the converted prefix length.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp6andPrefix (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address,\r
+ OUT UINT8 *PrefixLength\r
+ )\r
+{\r
+ CHAR8 *Ip6Str;\r
+ CHAR8 *PrefixStr;\r
+ CHAR8 *TempStr;\r
+ EFI_STATUS Status;\r
+ UINT8 Length;\r
+\r
+ if ((String == NULL) || (Ip6Address == NULL) || (PrefixLength == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Ip6Str = (CHAR8 *) AllocatePool ((StrLen (String) + 1) * sizeof (CHAR8));\r
+ if (Ip6Str == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ UnicodeStrToAsciiStr (String, Ip6Str);\r
+\r
+ //\r
+ // Get the sub string describing prefix length.\r
+ //\r
+ TempStr = Ip6Str;\r
+ while (*TempStr != '\0' && (*TempStr != '/')) {\r
+ TempStr++;\r
+ }\r
+\r
+ if (*TempStr == '/') {\r
+ PrefixStr = TempStr + 1;\r
+ } else {\r
+ PrefixStr = NULL;\r
+ }\r
+\r
+ //\r
+ // Get the sub string describing IPv6 address and convert it.\r
+ //\r
+ *TempStr = '\0';\r
+\r
+ Status = NetLibAsciiStrToIp6 (Ip6Str, Ip6Address);\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // If input string doesn't indicate the prefix length, return 0xff.\r
+ //\r
+ Length = 0xFF;\r
+ \r
+ //\r
+ // Convert the string to prefix length\r
+ //\r
+ if (PrefixStr != NULL) {\r
+\r
+ Status = EFI_INVALID_PARAMETER;\r
+ Length = 0;\r
+ while (*PrefixStr != '\0') {\r
+ if (NET_IS_DIGIT (*PrefixStr)) {\r
+ Length = (UINT8) (Length * 10 + (*PrefixStr - '0'));\r
+ if (Length >= IP6_PREFIX_NUM) {\r
+ goto Exit;\r
+ }\r
+ } else {\r
+ goto Exit;\r
+ }\r
+\r
+ PrefixStr++;\r
+ }\r
+ }\r
+\r
+ *PrefixLength = Length;\r
+ Status = EFI_SUCCESS;\r
+\r
+Exit:\r
+\r
+ FreePool (Ip6Str);\r
+ return Status;\r
+}\r
+\r
projects / mirror_edk2.git / blobdiff